azure.mgmt.notificationhubs.models module

class azure.mgmt.notificationhubs.models.AccessRights(value)[source]

Bases: str, enum.Enum

AccessRights.

LISTEN = 'Listen'
MANAGE = 'Manage'
SEND = 'Send'
class azure.mgmt.notificationhubs.models.AdmCredential(*, client_id: Optional[str] = None, client_secret: Optional[str] = None, auth_token_url: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs._serialization.Model

Description of a NotificationHub AdmCredential.

Variables

  • client_id (str) – The client identifier.

  • client_secret (str) – The credential secret access key.

  • auth_token_url (str) – The URL of the authorization token.

Keyword Arguments

  • 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.ApnsCredential(*, apns_certificate: Optional[str] = None, certificate_key: Optional[str] = None, endpoint: Optional[str] = None, thumbprint: Optional[str] = None, key_id: Optional[str] = None, app_name: Optional[str] = None, app_id: Optional[str] = None, token: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs._serialization.Model

Description of a NotificationHub ApnsCredential.

Variables

  • apns_certificate (str) – The APNS certificate. Specify if using Certificate Authentication Mode.

  • certificate_key (str) – The APNS certificate password if it exists.

  • endpoint (str) – The APNS endpoint of this credential. If using Certificate Authentication Mode and Sandbox specify ‘gateway.sandbox.push.apple.com’. If using Certificate Authentication Mode and Production specify ‘gateway.push.apple.com’. If using Token Authentication Mode and Sandbox specify ‘https://api.development.push.apple.com:443/3/device’. If using Token Authentication Mode and Production specify ‘https://api.push.apple.com:443/3/device’.

  • thumbprint (str) – The APNS certificate thumbprint. Specify if using Certificate Authentication Mode.

  • key_id (str) – A 10-character key identifier (kid) key, obtained from your developer account. Specify if using Token Authentication Mode.

  • app_name (str) – The name of the application or BundleId. Specify if using Token Authentication Mode.

  • app_id (str) – The issuer (iss) registered claim key. The value is a 10-character TeamId, obtained from your developer account. Specify if using Token Authentication Mode.

  • token (str) – Provider Authentication Token, obtained through your developer account. Specify if using Token Authentication Mode.

Keyword Arguments

  • apns_certificate (str) – The APNS certificate. Specify if using Certificate Authentication Mode.

  • certificate_key (str) – The APNS certificate password if it exists.

  • endpoint (str) – The APNS endpoint of this credential. If using Certificate Authentication Mode and Sandbox specify ‘gateway.sandbox.push.apple.com’. If using Certificate Authentication Mode and Production specify ‘gateway.push.apple.com’. If using Token Authentication Mode and Sandbox specify ‘https://api.development.push.apple.com:443/3/device’. If using Token Authentication Mode and Production specify ‘https://api.push.apple.com:443/3/device’.

  • thumbprint (str) – The APNS certificate thumbprint. Specify if using Certificate Authentication Mode.

  • key_id (str) – A 10-character key identifier (kid) key, obtained from your developer account. Specify if using Token Authentication Mode.

  • app_name (str) – The name of the application or BundleId. Specify if using Token Authentication Mode.

  • app_id (str) – The issuer (iss) registered claim key. The value is a 10-character TeamId, obtained from your developer account. Specify if using Token Authentication Mode.

  • token (str) – Provider Authentication Token, obtained through your developer account. Specify if using Token Authentication Mode.

class azure.mgmt.notificationhubs.models.BaiduCredential(*, baidu_api_key: Optional[str] = None, baidu_end_point: Optional[str] = None, baidu_secret_key: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs._serialization.Model

Description of a NotificationHub BaiduCredential.

Variables

  • baidu_api_key (str) – Baidu Api Key.

  • baidu_end_point (str) – Baidu Endpoint.

  • baidu_secret_key (str) – Baidu Secret Key.

Keyword Arguments

  • 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.CheckAvailabilityParameters(*, name: str, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[_models.Sku] = None, is_availiable: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs._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

  • id (str) – Resource Id.

  • name (str) – Resource name. Required.

  • type (str) – Resource type.

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

Keyword Arguments

  • name (str) – Resource name. Required.

  • 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: Optional[str] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[_models.Sku] = None, is_availiable: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs.models._models_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.

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

Keyword Arguments

  • 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.DebugSendResponse(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[_models.Sku] = None, success: Optional[float] = None, failure: Optional[float] = None, results: Optional[collections.abc.MutableMapping[str, Any]] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs.models._models_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.

  • 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 (JSON) – actual failure description.

Keyword Arguments

  • 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 (JSON) – actual failure description.

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

Bases: azure.mgmt.notificationhubs._serialization.Model

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

Variables

  • code (str) – Error code.

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

Keyword Arguments

  • code (str) – Error code.

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

class azure.mgmt.notificationhubs.models.GcmCredential(*, gcm_endpoint: Optional[str] = None, google_api_key: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs._serialization.Model

Description of a NotificationHub GcmCredential.

Variables
Keyword Arguments
class azure.mgmt.notificationhubs.models.MpnsCredential(*, mpns_certificate: Optional[str] = None, certificate_key: Optional[str] = None, thumbprint: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs._serialization.Model

Description of a NotificationHub MpnsCredential.

Variables

  • mpns_certificate (str) – The MPNS certificate.

  • certificate_key (str) – The certificate key for this credential.

  • thumbprint (str) – The MPNS certificate Thumbprint.

Keyword Arguments

  • 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.NamespaceCreateOrUpdateParameters(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[_models.Sku] = None, name_properties_name: Optional[str] = None, provisioning_state: Optional[str] = None, region: Optional[str] = None, status: Optional[str] = None, created_at: Optional[datetime.datetime] = None, updated_at: Optional[datetime.datetime] = None, service_bus_endpoint: Optional[str] = None, subscription_id: Optional[str] = None, scale_unit: Optional[str] = None, enabled: Optional[bool] = None, critical: Optional[bool] = None, data_center: Optional[str] = None, namespace_type: Optional[Union[str, _models.NamespaceType]] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs.models._models_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.

  • location (str) – Resource location.

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

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

  • name_properties_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 East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe.

  • metric_id (str) – Identifier for Azure Insights metrics.

  • 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. Known values are: “Messaging” and “NotificationHub”.

Keyword Arguments

  • location (str) – Resource location.

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

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

  • name_properties_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 East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West 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. Known values are: “Messaging” and “NotificationHub”.

class azure.mgmt.notificationhubs.models.NamespaceListResult(*, value: Optional[List[_models.NamespaceResource]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs._serialization.Model

The response of the List Namespace operation.

Variables

  • value (list[NamespaceResource]) – Result of the List Namespace operation.

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

Keyword Arguments

  • value (list[NamespaceResource]) – Result of the List Namespace operation.

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

class azure.mgmt.notificationhubs.models.NamespacePatchParameters(*, tags: Optional[Dict[str, str]] = None, sku: Optional[_models.Sku] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs._serialization.Model

Parameters supplied to the Patch Namespace operation.

Variables

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

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

Keyword Arguments

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

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

class azure.mgmt.notificationhubs.models.NamespaceResource(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[_models.Sku] = None, name_properties_name: Optional[str] = None, provisioning_state: Optional[str] = None, region: Optional[str] = None, status: Optional[str] = None, created_at: Optional[datetime.datetime] = None, updated_at: Optional[datetime.datetime] = None, service_bus_endpoint: Optional[str] = None, subscription_id: Optional[str] = None, scale_unit: Optional[str] = None, enabled: Optional[bool] = None, critical: Optional[bool] = None, data_center: Optional[str] = None, namespace_type: Optional[Union[str, _models.NamespaceType]] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs.models._models_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.

  • location (str) – Resource location.

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

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

  • name_properties_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 East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe.

  • metric_id (str) – Identifier for Azure Insights metrics.

  • 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. Known values are: “Messaging” and “NotificationHub”.

Keyword Arguments

  • location (str) – Resource location.

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

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

  • name_properties_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 East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West 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. Known values are: “Messaging” and “NotificationHub”.

class azure.mgmt.notificationhubs.models.NamespaceType(value)[source]

Bases: str, enum.Enum

The namespace type.

MESSAGING = 'Messaging'
NOTIFICATION_HUB = 'NotificationHub'
class azure.mgmt.notificationhubs.models.NotificationHubCreateOrUpdateParameters(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[_models.Sku] = None, name_properties_name: Optional[str] = None, registration_ttl: Optional[str] = None, authorization_rules: Optional[List[_models.SharedAccessAuthorizationRuleProperties]] = None, apns_credential: Optional[_models.ApnsCredential] = None, wns_credential: Optional[_models.WnsCredential] = None, gcm_credential: Optional[_models.GcmCredential] = None, mpns_credential: Optional[_models.MpnsCredential] = None, adm_credential: Optional[_models.AdmCredential] = None, baidu_credential: Optional[_models.BaiduCredential] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs.models._models_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.

  • location (str) – Resource location.

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

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

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

Keyword Arguments

  • location (str) – Resource location.

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

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

  • name_properties_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.NotificationHubListResult(*, value: Optional[List[_models.NotificationHubResource]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs._serialization.Model

The response of the List NotificationHub operation.

Variables

  • value (list[NotificationHubResource]) – Result of the List NotificationHub operation.

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

Keyword Arguments

  • value (list[NotificationHubResource]) – Result of the List NotificationHub operation.

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

class azure.mgmt.notificationhubs.models.NotificationHubPatchParameters(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[_models.Sku] = None, name_properties_name: Optional[str] = None, registration_ttl: Optional[str] = None, authorization_rules: Optional[List[_models.SharedAccessAuthorizationRuleProperties]] = None, apns_credential: Optional[_models.ApnsCredential] = None, wns_credential: Optional[_models.WnsCredential] = None, gcm_credential: Optional[_models.GcmCredential] = None, mpns_credential: Optional[_models.MpnsCredential] = None, adm_credential: Optional[_models.AdmCredential] = None, baidu_credential: Optional[_models.BaiduCredential] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs.models._models_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.

  • location (str) – Resource location.

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

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

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

Keyword Arguments

  • location (str) – Resource location.

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

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

  • name_properties_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: Optional[str] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[_models.Sku] = None, name_properties_name: Optional[str] = None, registration_ttl: Optional[str] = None, authorization_rules: Optional[List[_models.SharedAccessAuthorizationRuleProperties]] = None, apns_credential: Optional[_models.ApnsCredential] = None, wns_credential: Optional[_models.WnsCredential] = None, gcm_credential: Optional[_models.GcmCredential] = None, mpns_credential: Optional[_models.MpnsCredential] = None, adm_credential: Optional[_models.AdmCredential] = None, baidu_credential: Optional[_models.BaiduCredential] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs.models._models_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.

  • location (str) – Resource location.

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

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

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

Keyword Arguments

  • location (str) – Resource location.

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

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

  • name_properties_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.Operation(*, display: Optional[_models.OperationDisplay] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs._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}.

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

Keyword Arguments

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

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

Bases: azure.mgmt.notificationhubs._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.OperationListResult(**kwargs)[source]

Bases: azure.mgmt.notificationhubs._serialization.Model

Result of the request to list NotificationHubs operations. It contains a list of operations and a URL link to get the next set of results.

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

Variables

  • value (list[Operation]) – List of NotificationHubs operations supported by the Microsoft.NotificationHubs resource provider.

  • next_link (str) – URL to get the next set of operation list results if there are any.

class azure.mgmt.notificationhubs.models.PnsCredentialsResource(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[_models.Sku] = None, apns_credential: Optional[_models.ApnsCredential] = None, wns_credential: Optional[_models.WnsCredential] = None, gcm_credential: Optional[_models.GcmCredential] = None, mpns_credential: Optional[_models.MpnsCredential] = None, adm_credential: Optional[_models.AdmCredential] = None, baidu_credential: Optional[_models.BaiduCredential] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs.models._models_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.

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

Keyword Arguments

  • 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.PolicykeyResource(*, policy_key: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs._serialization.Model

Namespace/NotificationHub Regenerate Keys.

Variables

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.

Keyword Arguments

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.Resource(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[_models.Sku] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs._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.

  • location (str) – Resource location.

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

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

Keyword Arguments

  • location (str) – Resource location.

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

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

class azure.mgmt.notificationhubs.models.ResourceListKeys(*, primary_connection_string: Optional[str] = None, secondary_connection_string: Optional[str] = None, primary_key: Optional[str] = None, secondary_key: Optional[str] = None, key_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs._serialization.Model

Namespace/NotificationHub Connection String.

Variables

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

Keyword Arguments

  • 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.SharedAccessAuthorizationRuleCreateOrUpdateParameters(*, properties: _models.SharedAccessAuthorizationRuleProperties, **kwargs)[source]

Bases: azure.mgmt.notificationhubs._serialization.Model

Parameters supplied to the CreateOrUpdate Namespace AuthorizationRules.

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

Variables

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

Keyword Arguments

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

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

Bases: azure.mgmt.notificationhubs._serialization.Model

The response of the List Namespace operation.

Variables

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

Keyword Arguments

  • 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.SharedAccessAuthorizationRuleProperties(*, rights: Optional[List[Union[str, _models.AccessRights]]] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs._serialization.Model

SharedAccessAuthorizationRule properties.

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

Variables

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

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

Keyword Arguments

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

class azure.mgmt.notificationhubs.models.SharedAccessAuthorizationRuleResource(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[_models.Sku] = None, rights: Optional[List[Union[str, _models.AccessRights]]] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs.models._models_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.

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

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

Keyword Arguments

  • 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.Sku(*, name: Union[str, _models.SkuName], tier: Optional[str] = None, size: Optional[str] = None, family: Optional[str] = None, capacity: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs._serialization.Model

The Sku description for a namespace.

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

Variables

  • name (str or SkuName) – Name of the notification hub sku. Required. Known values are: “Free”, “Basic”, and “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.

Keyword Arguments

  • name (str or SkuName) – Name of the notification hub sku. Required. Known values are: “Free”, “Basic”, and “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.SkuName(value)[source]

Bases: str, enum.Enum

Name of the notification hub sku.

BASIC = 'Basic'
FREE = 'Free'
STANDARD = 'Standard'
class azure.mgmt.notificationhubs.models.SubResource(*, id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs._serialization.Model

SubResource.

Variables

id (str) – Resource Id.

Keyword Arguments

id (str) – Resource Id.

class azure.mgmt.notificationhubs.models.WnsCredential(*, package_sid: Optional[str] = None, secret_key: Optional[str] = None, windows_live_endpoint: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.notificationhubs._serialization.Model

Description of a NotificationHub WnsCredential.

Variables

  • package_sid (str) – The package ID for this credential.

  • secret_key (str) – The secret key.

  • windows_live_endpoint (str) – The Windows Live endpoint.

Keyword Arguments

  • package_sid (str) – The package ID for this credential.

  • secret_key (str) – The secret key.

  • windows_live_endpoint (str) – The Windows Live endpoint.