azure.mgmt.notificationhubs.models module

class azure.mgmt.notificationhubs.models.CheckAvailabilityParameters(name, location, tags=None, sku=None, is_availiable=None)[source]

Bases: msrest.serialization.Model

Parameters supplied to the Check Name Availability for Namespace and NotificationHubs.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:
  • name (str) – Resource name
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • sku (Sku) – The sku of the created namespace
  • is_availiable (bool) – True if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false.
class azure.mgmt.notificationhubs.models.Sku(name, tier=None, size=None, family=None, capacity=None)[source]

Bases: msrest.serialization.Model

The Sku description for a namespace.

Parameters:
  • name (str or SkuName) – Name of the notification hub sku. Possible values include: ‘Free’, ‘Basic’, ‘Standard’
  • tier (str) – The tier of particular sku
  • size (str) – The Sku size
  • family (str) – The Sku Family
  • capacity (int) – The capacity of the resource
class azure.mgmt.notificationhubs.models.CheckAvailabilityResult(location, tags=None, sku=None, is_availiable=None)[source]

Bases: azure.mgmt.notificationhubs.models.resource.Resource

Description of a CheckAvailibility resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • sku (Sku) – The sku of the created namespace
  • is_availiable (bool) – True if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false.
class azure.mgmt.notificationhubs.models.NamespaceCreateOrUpdateParameters(location, tags=None, sku=None, namespace_create_or_update_parameters_name=None, provisioning_state=None, region=None, status=None, created_at=None, service_bus_endpoint=None, subscription_id=None, scale_unit=None, enabled=None, critical=None, namespace_type=None)[source]

Bases: azure.mgmt.notificationhubs.models.resource.Resource

Parameters supplied to the CreateOrUpdate Namespace operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • sku (Sku) – The sku of the created namespace
  • namespace_create_or_update_parameters_name (str) – The name of the namespace.
  • provisioning_state (str) – Provisioning state of the Namespace.
  • region (str) – Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia EastAustralia SoutheastCentral USEast USEast US 2West USNorth Central USSouth Central USEast AsiaSoutheast AsiaBrazil SouthJapan EastJapan WestNorth EuropeWest Europe
  • status (str) – Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting
  • created_at (datetime) – The time the namespace was created.
  • service_bus_endpoint (str) – Endpoint you can use to perform NotificationHub operations.
  • subscription_id (str) – The Id of the Azure subscription associated with the namespace.
  • scale_unit (str) – ScaleUnit where the namespace gets created
  • enabled (bool) – Whether or not the namespace is currently enabled.
  • critical (bool) – Whether or not the namespace is set as Critical.
  • namespace_type (str or NamespaceType) – The namespace type. Possible values include: ‘Messaging’, ‘NotificationHub’
class azure.mgmt.notificationhubs.models.NamespacePatchParameters(tags=None, sku=None)[source]

Bases: msrest.serialization.Model

Parameters supplied to the Patch Namespace operation.

Parameters:
  • tags (dict) – Resource tags
  • sku (Sku) – The sku of the created namespace
class azure.mgmt.notificationhubs.models.NamespaceResource(location, tags=None, sku=None, namespace_resource_name=None, provisioning_state=None, region=None, status=None, created_at=None, service_bus_endpoint=None, subscription_id=None, scale_unit=None, enabled=None, critical=None, namespace_type=None)[source]

Bases: azure.mgmt.notificationhubs.models.resource.Resource

Description of a Namespace resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • sku (Sku) – The sku of the created namespace
  • namespace_resource_name (str) – The name of the namespace.
  • provisioning_state (str) – Provisioning state of the Namespace.
  • region (str) – Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia EastAustralia SoutheastCentral USEast USEast US 2West USNorth Central USSouth Central USEast AsiaSoutheast AsiaBrazil SouthJapan EastJapan WestNorth EuropeWest Europe
  • status (str) – Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting
  • created_at (datetime) – The time the namespace was created.
  • service_bus_endpoint (str) – Endpoint you can use to perform NotificationHub operations.
  • subscription_id (str) – The Id of the Azure subscription associated with the namespace.
  • scale_unit (str) – ScaleUnit where the namespace gets created
  • enabled (bool) – Whether or not the namespace is currently enabled.
  • critical (bool) – Whether or not the namespace is set as Critical.
  • namespace_type (str or NamespaceType) – The namespace type. Possible values include: ‘Messaging’, ‘NotificationHub’
class azure.mgmt.notificationhubs.models.SharedAccessAuthorizationRuleProperties(rights=None)[source]

Bases: msrest.serialization.Model

SharedAccessAuthorizationRule properties.

Parameters:rights (list of str or AccessRights) – The rights associated with the rule.
class azure.mgmt.notificationhubs.models.SharedAccessAuthorizationRuleCreateOrUpdateParameters(location, properties, tags=None, sku=None)[source]

Bases: azure.mgmt.notificationhubs.models.resource.Resource

Parameters supplied to the CreateOrUpdate Namespace AuthorizationRules.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:
class azure.mgmt.notificationhubs.models.SharedAccessAuthorizationRuleResource(location, tags=None, sku=None, rights=None)[source]

Bases: azure.mgmt.notificationhubs.models.resource.Resource

Description of a Namespace AuthorizationRules.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • sku (Sku) – The sku of the created namespace
  • rights (list of str or AccessRights) – The rights associated with the rule.
class azure.mgmt.notificationhubs.models.ResourceListKeys(primary_connection_string=None, secondary_connection_string=None, primary_key=None, secondary_key=None, key_name=None)[source]

Bases: msrest.serialization.Model

Namespace/NotificationHub Connection String.

Parameters:
  • primary_connection_string (str) – PrimaryConnectionString of the AuthorizationRule.
  • secondary_connection_string (str) – SecondaryConnectionString of the created AuthorizationRule
  • primary_key (str) – PrimaryKey of the created AuthorizationRule.
  • secondary_key (str) – SecondaryKey of the created AuthorizationRule
  • key_name (str) – KeyName of the created AuthorizationRule
class azure.mgmt.notificationhubs.models.PolicykeyResource(policy_key=None)[source]

Bases: msrest.serialization.Model

Namespace/NotificationHub Regenerate Keys.

Parameters:policy_key (str) – Name of the key that has to be regenerated for the Namespace/Notification Hub Authorization Rule. The value can be Primary Key/Secondary Key.
class azure.mgmt.notificationhubs.models.ApnsCredential(apns_certificate=None, certificate_key=None, endpoint=None, thumbprint=None)[source]

Bases: msrest.serialization.Model

Description of a NotificationHub ApnsCredential.

Parameters:
  • apns_certificate (str) – The APNS certificate.
  • certificate_key (str) – The certificate key.
  • endpoint (str) – The endpoint of this credential.
  • thumbprint (str) – The Apns certificate Thumbprint
class azure.mgmt.notificationhubs.models.WnsCredential(package_sid=None, secret_key=None, windows_live_endpoint=None)[source]

Bases: msrest.serialization.Model

Description of a NotificationHub WnsCredential.

Parameters:
  • package_sid (str) – The package ID for this credential.
  • secret_key (str) – The secret key.
  • windows_live_endpoint (str) – The Windows Live endpoint.
class azure.mgmt.notificationhubs.models.GcmCredential(gcm_endpoint=None, google_api_key=None)[source]

Bases: msrest.serialization.Model

Description of a NotificationHub GcmCredential.

Parameters:
  • gcm_endpoint (str) – The GCM endpoint.
  • google_api_key (str) – The Google API key.
class azure.mgmt.notificationhubs.models.MpnsCredential(mpns_certificate=None, certificate_key=None, thumbprint=None)[source]

Bases: msrest.serialization.Model

Description of a NotificationHub MpnsCredential.

Parameters:
  • mpns_certificate (str) – The MPNS certificate.
  • certificate_key (str) – The certificate key for this credential.
  • thumbprint (str) – The Mpns certificate Thumbprint
class azure.mgmt.notificationhubs.models.AdmCredential(client_id=None, client_secret=None, auth_token_url=None)[source]

Bases: msrest.serialization.Model

Description of a NotificationHub AdmCredential.

Parameters:
  • client_id (str) – The client identifier.
  • client_secret (str) – The credential secret access key.
  • auth_token_url (str) – The URL of the authorization token.
class azure.mgmt.notificationhubs.models.BaiduCredential(baidu_api_key=None, baidu_end_point=None, baidu_secret_key=None)[source]

Bases: msrest.serialization.Model

Description of a NotificationHub BaiduCredential.

Parameters:
  • baidu_api_key (str) – Baidu Api Key.
  • baidu_end_point (str) – Baidu Endpoint.
  • baidu_secret_key (str) – Baidu Secret Key
class azure.mgmt.notificationhubs.models.NotificationHubCreateOrUpdateParameters(location, tags=None, sku=None, notification_hub_create_or_update_parameters_name=None, registration_ttl=None, authorization_rules=None, apns_credential=None, wns_credential=None, gcm_credential=None, mpns_credential=None, adm_credential=None, baidu_credential=None)[source]

Bases: azure.mgmt.notificationhubs.models.resource.Resource

Parameters supplied to the CreateOrUpdate NotificationHub operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • sku (Sku) – The sku of the created namespace
  • notification_hub_create_or_update_parameters_name (str) – The NotificationHub name.
  • registration_ttl (str) – The RegistrationTtl of the created NotificationHub
  • authorization_rules (list of SharedAccessAuthorizationRuleProperties) – The AuthorizationRules of the created NotificationHub
  • apns_credential (ApnsCredential) – The ApnsCredential of the created NotificationHub
  • wns_credential (WnsCredential) – The WnsCredential of the created NotificationHub
  • gcm_credential (GcmCredential) – The GcmCredential of the created NotificationHub
  • mpns_credential (MpnsCredential) – The MpnsCredential of the created NotificationHub
  • adm_credential (AdmCredential) – The AdmCredential of the created NotificationHub
  • baidu_credential (BaiduCredential) – The BaiduCredential of the created NotificationHub
class azure.mgmt.notificationhubs.models.NotificationHubResource(location, tags=None, sku=None, notification_hub_resource_name=None, registration_ttl=None, authorization_rules=None, apns_credential=None, wns_credential=None, gcm_credential=None, mpns_credential=None, adm_credential=None, baidu_credential=None)[source]

Bases: azure.mgmt.notificationhubs.models.resource.Resource

Description of a NotificationHub Resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • sku (Sku) – The sku of the created namespace
  • notification_hub_resource_name (str) – The NotificationHub name.
  • registration_ttl (str) – The RegistrationTtl of the created NotificationHub
  • authorization_rules (list of SharedAccessAuthorizationRuleProperties) – The AuthorizationRules of the created NotificationHub
  • apns_credential (ApnsCredential) – The ApnsCredential of the created NotificationHub
  • wns_credential (WnsCredential) – The WnsCredential of the created NotificationHub
  • gcm_credential (GcmCredential) – The GcmCredential of the created NotificationHub
  • mpns_credential (MpnsCredential) – The MpnsCredential of the created NotificationHub
  • adm_credential (AdmCredential) – The AdmCredential of the created NotificationHub
  • baidu_credential (BaiduCredential) – The BaiduCredential of the created NotificationHub
class azure.mgmt.notificationhubs.models.PnsCredentialsResource(location, tags=None, sku=None, apns_credential=None, wns_credential=None, gcm_credential=None, mpns_credential=None, adm_credential=None, baidu_credential=None)[source]

Bases: azure.mgmt.notificationhubs.models.resource.Resource

Description of a NotificationHub PNS Credentials.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • sku (Sku) – The sku of the created namespace
  • apns_credential (ApnsCredential) – The ApnsCredential of the created NotificationHub
  • wns_credential (WnsCredential) – The WnsCredential of the created NotificationHub
  • gcm_credential (GcmCredential) – The GcmCredential of the created NotificationHub
  • mpns_credential (MpnsCredential) – The MpnsCredential of the created NotificationHub
  • adm_credential (AdmCredential) – The AdmCredential of the created NotificationHub
  • baidu_credential (BaiduCredential) – The BaiduCredential of the created NotificationHub
class azure.mgmt.notificationhubs.models.Resource(location, tags=None, sku=None)[source]

Bases: msrest.serialization.Model

Resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • sku (Sku) – The sku of the created namespace
class azure.mgmt.notificationhubs.models.SubResource(id=None)[source]

Bases: msrest.serialization.Model

SubResource.

Parameters:id (str) – Resource Id
class azure.mgmt.notificationhubs.models.NamespaceResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of NamespaceResource object

class azure.mgmt.notificationhubs.models.SharedAccessAuthorizationRuleResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of SharedAccessAuthorizationRuleResource object

class azure.mgmt.notificationhubs.models.NotificationHubResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of NotificationHubResource object

class azure.mgmt.notificationhubs.models.SkuName[source]

Bases: enum.Enum

basic = 'Basic'
free = 'Free'
standard = 'Standard'
class azure.mgmt.notificationhubs.models.NamespaceType[source]

Bases: enum.Enum

messaging = 'Messaging'
notification_hub = 'NotificationHub'
class azure.mgmt.notificationhubs.models.AccessRights[source]

Bases: enum.Enum

listen = 'Listen'
manage = 'Manage'
send = 'Send'