azure.mgmt.notificationhubs.models module

exception azure.mgmt.notificationhubs.models.ErrorResponseException(deserialize, response, *args)[source]

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘ErrorResponse’.

Parameters

  • deserialize – A deserializer

  • response – Server response to be deserialized.

class azure.mgmt.notificationhubs.models.OperationDisplay(**kwargs)[source]

Bases: msrest.serialization.Model

The object that represents the operation.

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

Variables

  • provider (str) – Service provider: Microsoft.NotificationHubs

  • resource (str) – Resource on which the operation is performed: Invoice, etc.

  • operation (str) – Operation type: Read, write, delete, etc.

class azure.mgmt.notificationhubs.models.Operation(*, display=None, **kwargs)[source]

Bases: msrest.serialization.Model

A NotificationHubs REST API operation.

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

Variables

name (str) – Operation name: {provider}/{resource}/{operation}

Parameters

display (OperationDisplay) – The object that represents the operation.

class azure.mgmt.notificationhubs.models.ErrorResponse(*, code: str = None, message: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Error response indicates NotificationHubs service is not able to process the incoming request. The reason is provided in the error message.

Parameters

  • code (str) – Error code.

  • message (str) – Error message indicating why the operation failed.

class azure.mgmt.notificationhubs.models.Sku(*, name, tier: str = None, size: str = None, family: str = None, capacity: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

The Sku description for a namespace.

All required parameters must be populated in order to send to Azure.

Parameters

  • name (str or SkuName) – Required. 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.CheckAvailabilityParameters(*, name: str, location: str = None, tags=None, sku=None, is_availiable: bool = None, **kwargs)[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.

All required parameters must be populated in order to send to Azure.

Variables
Parameters

  • name (str) – Required. Resource name

  • location (str) – Resource location

  • tags (dict[str, str]) – 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.CheckAvailabilityResult(*, location: str = None, tags=None, sku=None, is_availiable: bool = None, **kwargs)[source]

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

Description of a CheckAvailability resource.

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

Variables

  • id (str) – Resource Id

  • name (str) – Resource name

  • type (str) – Resource type

Parameters

  • location (str) – Resource location

  • tags (dict[str, str]) – 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: str = None, tags=None, sku=None, namespace_create_or_update_parameters_name: str = None, provisioning_state: str = None, region: str = None, status: str = None, created_at=None, updated_at=None, service_bus_endpoint: str = None, subscription_id: str = None, scale_unit: str = None, enabled: bool = None, critical: bool = None, data_center: str = None, namespace_type=None, **kwargs)[source]

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

Parameters supplied to the CreateOrUpdate Namespace operation.

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

Variables

  • id (str) – Resource Id

  • name (str) – Resource name

  • type (str) – Resource type

  • metric_id (str) – Identifier for Azure Insights metrics

Parameters

  • location (str) – Resource location

  • tags (dict[str, str]) – 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.

  • updated_at (datetime) – The time the namespace was updated.

  • 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.

  • data_center (str) – Data center for the namespace

  • namespace_type (str or NamespaceType) – The namespace type. Possible values include: ‘Messaging’, ‘NotificationHub’

class azure.mgmt.notificationhubs.models.NamespacePatchParameters(*, tags=None, sku=None, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters supplied to the Patch Namespace operation.

Parameters

  • tags (dict[str, str]) – Resource tags

  • sku (Sku) – The sku of the created namespace

class azure.mgmt.notificationhubs.models.NamespaceResource(*, location: str = None, tags=None, sku=None, namespace_resource_name: str = None, provisioning_state: str = None, region: str = None, status: str = None, created_at=None, updated_at=None, service_bus_endpoint: str = None, subscription_id: str = None, scale_unit: str = None, enabled: bool = None, critical: bool = None, data_center: str = None, namespace_type=None, **kwargs)[source]

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

Description of a Namespace resource.

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

Variables

  • id (str) – Resource Id

  • name (str) – Resource name

  • type (str) – Resource type

  • metric_id (str) – Identifier for Azure Insights metrics

Parameters

  • location (str) – Resource location

  • tags (dict[str, str]) – 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.

  • updated_at (datetime) – The time the namespace was updated.

  • 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.

  • data_center (str) – Data center for the namespace

  • namespace_type (str or NamespaceType) – The namespace type. Possible values include: ‘Messaging’, ‘NotificationHub’

class azure.mgmt.notificationhubs.models.SharedAccessAuthorizationRuleProperties(*, rights=None, **kwargs)[source]

Bases: msrest.serialization.Model

SharedAccessAuthorizationRule properties.

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

Parameters

rights (list[str or AccessRights]) – The rights associated with the rule.

Variables

  • primary_key (str) – A base64-encoded 256-bit primary key for signing and validating the SAS token.

  • secondary_key (str) – A base64-encoded 256-bit primary key for signing and validating the SAS token.

  • key_name (str) – A string that describes the authorization rule.

  • claim_type (str) – A string that describes the claim type

  • claim_value (str) – A string that describes the claim value

  • modified_time (str) – The last modified time for this rule

  • created_time (str) – The created time for this rule

  • revision (int) – The revision number for the rule

class azure.mgmt.notificationhubs.models.SharedAccessAuthorizationRuleCreateOrUpdateParameters(*, properties, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters supplied to the CreateOrUpdate Namespace AuthorizationRules.

All required parameters must be populated in order to send to Azure.

Parameters

properties (SharedAccessAuthorizationRuleProperties) – Required. Properties of the Namespace AuthorizationRules.

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

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

Description of a Namespace AuthorizationRules.

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

Variables

  • id (str) – Resource Id

  • name (str) – Resource name

  • type (str) – Resource type

  • primary_key (str) – A base64-encoded 256-bit primary key for signing and validating the SAS token.

  • secondary_key (str) – A base64-encoded 256-bit primary key for signing and validating the SAS token.

  • key_name (str) – A string that describes the authorization rule.

  • claim_type (str) – A string that describes the claim type

  • claim_value (str) – A string that describes the claim value

  • modified_time (str) – The last modified time for this rule

  • created_time (str) – The created time for this rule

  • revision (int) – The revision number for the rule

Parameters

  • location (str) – Resource location

  • tags (dict[str, str]) – Resource tags

  • sku (Sku) – The sku of the created namespace

  • rights (list[str or AccessRights]) – The rights associated with the rule.

class azure.mgmt.notificationhubs.models.SharedAccessAuthorizationRuleListResult(*, value=None, next_link: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The response of the List Namespace operation.

Parameters

  • value (list[SharedAccessAuthorizationRuleResource]) – Result of the List AuthorizationRules operation.

  • next_link (str) – Link to the next set of results. Not empty if Value contains incomplete list of AuthorizationRules

class azure.mgmt.notificationhubs.models.ResourceListKeys(*, primary_connection_string: str = None, secondary_connection_string: str = None, primary_key: str = None, secondary_key: str = None, key_name: str = None, **kwargs)[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: str = None, **kwargs)[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: str = None, certificate_key: str = None, endpoint: str = None, thumbprint: str = None, key_id: str = None, app_name: str = None, app_id: str = None, token: str = None, **kwargs)[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

  • key_id (str) – A 10-character key identifier (kid) key, obtained from your developer account

  • app_name (str) – The name of the application

  • app_id (str) – The issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account

  • token (str) – Provider Authentication Token, obtained through your developer account

class azure.mgmt.notificationhubs.models.WnsCredential(*, package_sid: str = None, secret_key: str = None, windows_live_endpoint: str = None, **kwargs)[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: str = None, google_api_key: str = None, **kwargs)[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: str = None, certificate_key: str = None, thumbprint: str = None, **kwargs)[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: str = None, client_secret: str = None, auth_token_url: str = None, **kwargs)[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: str = None, baidu_end_point: str = None, baidu_secret_key: str = None, **kwargs)[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: str = None, tags=None, sku=None, notification_hub_create_or_update_parameters_name: str = None, registration_ttl: str = None, authorization_rules=None, apns_credential=None, wns_credential=None, gcm_credential=None, mpns_credential=None, adm_credential=None, baidu_credential=None, **kwargs)[source]

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

Parameters supplied to the CreateOrUpdate NotificationHub operation.

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

Variables

  • id (str) – Resource Id

  • name (str) – Resource name

  • type (str) – Resource type

Parameters

  • location (str) – Resource location

  • tags (dict[str, str]) – 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[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.NotificationHubPatchParameters(*, location: str = None, tags=None, sku=None, notification_hub_patch_parameters_name: str = None, registration_ttl: str = None, authorization_rules=None, apns_credential=None, wns_credential=None, gcm_credential=None, mpns_credential=None, adm_credential=None, baidu_credential=None, **kwargs)[source]

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

Parameters supplied to the patch NotificationHub operation.

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

Variables

  • id (str) – Resource Id

  • name (str) – Resource name

  • type (str) – Resource type

Parameters

  • location (str) – Resource location

  • tags (dict[str, str]) – Resource tags

  • sku (Sku) – The sku of the created namespace

  • notification_hub_patch_parameters_name (str) – The NotificationHub name.

  • registration_ttl (str) – The RegistrationTtl of the created NotificationHub

  • authorization_rules (list[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: str = None, tags=None, sku=None, notification_hub_resource_name: str = None, registration_ttl: str = None, authorization_rules=None, apns_credential=None, wns_credential=None, gcm_credential=None, mpns_credential=None, adm_credential=None, baidu_credential=None, **kwargs)[source]

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

Description of a NotificationHub Resource.

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

Variables

  • id (str) – Resource Id

  • name (str) – Resource name

  • type (str) – Resource type

Parameters

  • location (str) – Resource location

  • tags (dict[str, str]) – 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[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.DebugSendResponse(*, location: str = None, tags=None, sku=None, success: float = None, failure: float = None, results=None, **kwargs)[source]

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

Description of a NotificationHub Resource.

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

Variables

  • id (str) – Resource Id

  • name (str) – Resource name

  • type (str) – Resource type

Parameters

  • location (str) – Resource location

  • tags (dict[str, str]) – Resource tags

  • sku (Sku) – The sku of the created namespace

  • success (float) – successful send

  • failure (float) – send failure

  • results (object) – actual failure description

class azure.mgmt.notificationhubs.models.PnsCredentialsResource(*, location: str = None, tags=None, sku=None, apns_credential=None, wns_credential=None, gcm_credential=None, mpns_credential=None, adm_credential=None, baidu_credential=None, **kwargs)[source]

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

Description of a NotificationHub PNS Credentials.

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

Variables

  • id (str) – Resource Id

  • name (str) – Resource name

  • type (str) – Resource type

Parameters

  • location (str) – Resource location

  • tags (dict[str, str]) – 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: str = None, tags=None, sku=None, **kwargs)[source]

Bases: msrest.serialization.Model

Resource.

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

Variables

  • id (str) – Resource Id

  • name (str) – Resource name

  • type (str) – Resource type

Parameters

  • location (str) – Resource location

  • tags (dict[str, str]) – Resource tags

  • sku (Sku) – The sku of the created namespace

class azure.mgmt.notificationhubs.models.SubResource(*, id: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

SubResource.

Parameters

id (str) – Resource Id

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of NamespaceResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of SharedAccessAuthorizationRuleResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of NotificationHubResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

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

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

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