azure.mgmt.notificationhubs.models module¶

class azure.mgmt.notificationhubs.models.AccessRights(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Defines values for AccessRights.

LISTEN = 'Listen'¶

MANAGE = 'Manage'¶

SEND = 'Send'¶

class azure.mgmt.notificationhubs.models.AdmCredential(*, client_id: str, client_secret: str, auth_token_url: str, **kwargs: Any)[source]¶

Bases: Model

Description of a NotificationHub AdmCredential.

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

Variables:

client_id (str) – Gets or sets the client identifier. Required.
client_secret (str) – Gets or sets the credential secret access key. Required.
auth_token_url (str) – Gets or sets the URL of the authorization token. Required.

Keyword Arguments:

client_id (str) – Gets or sets the client identifier. Required.
client_secret (str) – Gets or sets the credential secret access key. Required.
auth_token_url (str) – Gets or sets the URL of the authorization token. Required.

Bases: Model

Description of a NotificationHub ApnsCredential.

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

Variables:

apns_certificate (str) – Gets or sets the APNS certificate.
certificate_key (str) – Gets or sets the certificate key.
endpoint (str) – Gets or sets the endpoint of this credential. Required.
thumbprint (str) – Gets or sets the APNS certificate Thumbprint.
key_id (str) – Gets or sets a 10-character key identifier (kid) key, obtained from your developer account.
app_name (str) – Gets or sets the name of the application.
app_id (str) – Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account.
token (str) – Gets or sets provider Authentication Token, obtained through your developer account.

Keyword Arguments:

apns_certificate (str) – Gets or sets the APNS certificate.
certificate_key (str) – Gets or sets the certificate key.
endpoint (str) – Gets or sets the endpoint of this credential. Required.
thumbprint (str) – Gets or sets the APNS certificate Thumbprint.
key_id (str) – Gets or sets a 10-character key identifier (kid) key, obtained from your developer account.
app_name (str) – Gets or sets the name of the application.
app_id (str) – Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account.
token (str) – Gets or sets provider Authentication Token, obtained through your developer account.

class azure.mgmt.notificationhubs.models.Availability(**kwargs: Any)[source]¶

Bases: Model

Represents metric availability (part of RP operation descriptions).

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

Variables:

time_grain (str) – Time grain of the availability.
blob_duration (str) – Duration of the availability blob.

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

Bases: Model

Description of a NotificationHub BaiduCredential.

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

Variables:

baidu_api_key (str) – Gets or sets baidu Api Key. Required.
baidu_end_point (str) – Gets or sets baidu Endpoint. Required.
baidu_secret_key (str) – Gets or sets baidu Secret Key. Required.

Keyword Arguments:

baidu_api_key (str) – Gets or sets baidu Api Key. Required.
baidu_end_point (str) – Gets or sets baidu Endpoint. Required.
baidu_secret_key (str) – Gets or sets baidu Secret Key. Required.

class azure.mgmt.notificationhubs.models.BrowserCredential(*, subject: str, vapid_private_key: str, vapid_public_key: str, **kwargs: Any)[source]¶

Bases: Model

Description of a NotificationHub BrowserCredential.

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

Variables:

subject (str) – Gets or sets web push subject. Required.
vapid_private_key (str) – Gets or sets VAPID private key. Required.
vapid_public_key (str) – Gets or sets VAPID public key. Required.

Keyword Arguments:

subject (str) – Gets or sets web push subject. Required.
vapid_private_key (str) – Gets or sets VAPID private key. Required.
vapid_public_key (str) – Gets or sets VAPID public key. Required.

class azure.mgmt.notificationhubs.models.CheckAvailabilityParameters(*, name: str, location: str | None = None, tags: Dict[str, str] | None = None, is_availiable: bool | None = None, sku: _models.Sku | None = None, **kwargs: Any)[source]¶

Bases: 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 server.

Variables:

id (str) – Gets resource Id.
name (str) – Gets or sets resource name. Required.
type (str) – Gets resource type.
location (str) – Gets or sets resource location.
tags (dict[str, str]) – Gets or sets resource tags.
is_availiable (bool) – Not used and deprecated since API version 2023-01-01-preview.
sku (Sku) – The Sku description for a namespace.

Keyword Arguments:

name (str) – Gets or sets resource name. Required.
location (str) – Gets or sets resource location.
tags (dict[str, str]) – Gets or sets resource tags.
is_availiable (bool) – Not used and deprecated since API version 2023-01-01-preview.
sku (Sku) – The Sku description for a namespace.

class azure.mgmt.notificationhubs.models.CheckAvailabilityResult(*, is_availiable: bool | None = None, location: str | None = None, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, **kwargs: Any)[source]¶

Bases: ProxyResource

Description of a CheckAvailability resource.

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

Variables:

id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
is_availiable (bool) – Gets or sets true if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false.
location (str) – Deprecated - only for compatibility.
tags (dict[str, str]) – Deprecated - only for compatibility.
sku (Sku) – The Sku description for a namespace.

Keyword Arguments:

is_availiable (bool) – Gets or sets true if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false.
location (str) – Deprecated - only for compatibility.
tags (dict[str, str]) – Deprecated - only for compatibility.
sku (Sku) – The Sku description for a namespace.

class azure.mgmt.notificationhubs.models.ConnectionDetails(**kwargs: Any)[source]¶

Bases: Model

Part of Private Endpoint description that stores information about a connection between Private Endpoint and Notification Hubs namespace. This is internal class, not visible to customers, and we use it only to discover the link identifier.

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

Variables:

id (str) – A unique ID of the connection. This is not the ARM id, but rather an internal identifier set by the Networking RP. Notification Hubs code does not analyze it.
private_ip_address (str) – IP address of the Private Endpoint. This is not used by Notification Hubs.
link_identifier (str) – Link identifier. This is a string representation of an integer that is also encoded in every IPv6 frame received by Front Door, and we use it to create implicit authorization rule that allows connection from the associated Private Endpoint.
group_id (str) – Group name. Always “namespace” for Notification Hubs.
member_name (str) – Member name. Always “namespace” for Notification Hubs.

class azure.mgmt.notificationhubs.models.CreatedByType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The type of identity that created the resource.

APPLICATION = 'Application'¶

KEY = 'Key'¶

MANAGED_IDENTITY = 'ManagedIdentity'¶

USER = 'User'¶

class azure.mgmt.notificationhubs.models.DebugSendResponse(*, location: str | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)[source]¶

Bases: ProxyResource

Description of a NotificationHub Resource.

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

Variables:

id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
location (str) – Deprecated - only for compatibility.
tags (dict[str, str]) – Deprecated - only for compatibility.
success (int) – Gets or sets successful send.
failure (int) – Gets or sets send failure.
results (list[RegistrationResult]) – Gets or sets actual failure description.

Keyword Arguments:

location (str) – Deprecated - only for compatibility.
tags (dict[str, str]) – Deprecated - only for compatibility.

class azure.mgmt.notificationhubs.models.ErrorAdditionalInfo(**kwargs: Any)[source]¶

Bases: Model

The resource management error additional info.

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

Variables:

type (str) – The additional info type.
info (JSON) – The additional info.

class azure.mgmt.notificationhubs.models.ErrorDetail(**kwargs: Any)[source]¶

Bases: Model

The error detail.

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

Variables:

code (str) – The error code.
message (str) – The error message.
target (str) – The error target.
details (list[ErrorDetail]) – The error details.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.

class azure.mgmt.notificationhubs.models.ErrorResponse(*, error: _models.ErrorDetail | None = None, **kwargs: Any)[source]¶

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables:: error (ErrorDetail) – The error object.
Keyword Arguments:: error (ErrorDetail) – The error object.

class azure.mgmt.notificationhubs.models.FcmV1Credential(*, client_email: str, private_key: str, project_id: str, **kwargs: Any)[source]¶

Bases: Model

Description of a NotificationHub FcmV1Credential.

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

Variables:

client_email (str) – Gets or sets client email. Required.
private_key (str) – Gets or sets private key. Required.
project_id (str) – Gets or sets project id. Required.

Keyword Arguments:

client_email (str) – Gets or sets client email. Required.
private_key (str) – Gets or sets private key. Required.
project_id (str) – Gets or sets project id. Required.

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

Bases: Model

Description of a NotificationHub GcmCredential.

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

Variables:

gcm_endpoint (str) – Gets or sets the GCM endpoint.
google_api_key (str) – Gets or sets the Google API key. Required.

Keyword Arguments:

gcm_endpoint (str) – Gets or sets the GCM endpoint.
google_api_key (str) – Gets or sets the Google API key. Required.

class azure.mgmt.notificationhubs.models.GroupConnectivityInformation(**kwargs: Any)[source]¶

Bases: Model

Represents a connectivity information to Notification Hubs namespace. This is part of PrivateLinkService proxy that tell the Networking RP how to connect to the Notification Hubs namespace.

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

Variables:

group_id (str) – Group id. Always set to “namespace”.
member_name (str) – Member name. Always set to “namespace”.
customer_visible_fqdns (list[str]) – List of customer-visible domain names that point to a Notification Hubs namespace.
internal_fqdn (str) – One of the domain name from the customer-visible names; this is used internally by Private Link service to make connection to Notification Hubs namespace.
redirect_map_id (str) – Not used by Notification Hubs.
private_link_service_arm_region (str) – ARM region for Private Link Service. We use the region that contains the connected Notification Hubs namespace.

class azure.mgmt.notificationhubs.models.IpRule(*, ip_mask: str, rights: List[str | _models.AccessRights], **kwargs: Any)[source]¶

Bases: Model

A network authorization rule that filters traffic based on IP address.

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

Variables:

ip_mask (str) – IP mask. Required.
rights (list[str or AccessRights]) – List of access rights. Required.

Keyword Arguments:

ip_mask (str) – IP mask. Required.
rights (list[str or AccessRights]) – List of access rights. Required.

class azure.mgmt.notificationhubs.models.LogSpecification(*, category_groups: List[str] | None = None, **kwargs: Any)[source]¶

Bases: Model

A single log category specification.

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

Variables:

name (str) – Name of the log category.
display_name (str) – Display name of the log category.
blob_duration (str) – Duration of data written to a single blob.
category_groups (list[str]) – Category group for the log specification.

Keyword Arguments:

category_groups (list[str]) – Category group for the log specification.

class azure.mgmt.notificationhubs.models.MetricSpecification(**kwargs: Any)[source]¶

Bases: Model

A metric specification.

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

Variables:

name (str) – Metric name / id.
display_name (str) – User-visible metric name.
display_description (str) – Description of the metric.
unit (str) – Metric unit.
aggregation_type (str) – Type of the aggregation (Average, Minimum, Maximum, Total or Count).
availabilities (list[Availability]) – List of availabilities.
supported_time_grain_types (list[str]) – List of supported time grain types.
metric_filter_pattern (str) – The matching regex pattern to be applied to the field pointed by the “metricsFilterPathSelector” flag in the ARM manifest.
fill_gap_with_zero (bool) – Optional property. If set to true, then zero will be returned for time duration where no metric is emitted / published.

class azure.mgmt.notificationhubs.models.MpnsCredential(*, mpns_certificate: str, certificate_key: str, thumbprint: str, **kwargs: Any)[source]¶

Bases: Model

Description of a NotificationHub MpnsCredential.

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

Variables:

mpns_certificate (str) – Gets or sets the MPNS certificate. Required.
certificate_key (str) – Gets or sets the certificate key for this credential. Required.
thumbprint (str) – Gets or sets the MPNS certificate Thumbprint. Required.

Keyword Arguments:

mpns_certificate (str) – Gets or sets the MPNS certificate. Required.
certificate_key (str) – Gets or sets the certificate key for this credential. Required.
thumbprint (str) – Gets or sets the MPNS certificate Thumbprint. Required.

class azure.mgmt.notificationhubs.models.NamespaceListResult(**kwargs: Any)[source]¶

Bases: Model

The response of the List Namespace operation.

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

Variables:

value (list[NamespaceResource]) – Gets or sets result of the List AuthorizationRules operation.
next_link (str) – Gets or sets link to the next set of results.

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

Bases: Model

Patch parameter for NamespaceResource.

Variables:

sku (Sku) – The Sku description for a namespace.
properties (NamespaceProperties) – Represents namespace properties.
tags (dict[str, str]) – Dictionary of <string>.

Keyword Arguments:

sku (Sku) – The Sku description for a namespace.
properties (NamespaceProperties) – Represents namespace properties.
tags (dict[str, str]) – Dictionary of <string>.

class azure.mgmt.notificationhubs.models.NamespaceProperties(*, provisioning_state: str | _models.OperationProvisioningState | None = None, status: str | _models.NamespaceStatus | None = None, namespace_type: str | _models.NamespaceType | None = None, replication_region: str | _models.ReplicationRegion | None = None, zone_redundancy: str | _models.ZoneRedundancyPreference = 'Disabled', network_acls: _models.NetworkAcls | None = None, pns_credentials: _models.PnsCredentials | None = None, scale_unit: str | None = None, data_center: str | None = None, public_network_access: str | _models.PublicNetworkAccess = 'Enabled', **kwargs: Any)[source]¶

Bases: Model

Represents namespace properties.

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

Variables:

name (str) – Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created.
provisioning_state (str or OperationProvisioningState) – Defines values for OperationProvisioningState. Known values are: “Unknown”, “InProgress”, “Succeeded”, “Failed”, “Canceled”, “Pending”, and “Disabled”.
status (str or NamespaceStatus) – Namespace status. Known values are: “Created”, “Creating”, “Suspended”, and “Deleting”.
enabled (bool) – Gets or sets whether or not the namespace is currently enabled.
critical (bool) – Gets or sets whether or not the namespace is set as Critical.
subscription_id (str) – Namespace subscription id.
region (str) – Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property.
metric_id (str) – Azure Insights Metrics id.
created_at (datetime) – Time when the namespace was created.
updated_at (datetime) – Time when the namespace was updated.
namespace_type (str or NamespaceType) – Defines values for NamespaceType. Known values are: “Messaging” and “NotificationHub”.
replication_region (str or ReplicationRegion) – Allowed replication region. Known values are: “Default”, “WestUs2”, “NorthEurope”, “AustraliaEast”, “BrazilSouth”, “SouthEastAsia”, “SouthAfricaNorth”, and “None”.
zone_redundancy (str or ZoneRedundancyPreference) – Namespace SKU name. Known values are: “Disabled” and “Enabled”.
network_acls (NetworkAcls) – A collection of network authorization rules.
pns_credentials (PnsCredentials) – Collection of Notification Hub or Notification Hub Namespace PNS credentials.
service_bus_endpoint (str) – Gets or sets endpoint you can use to perform NotificationHub operations.
private_endpoint_connections (list[PrivateEndpointConnectionResource]) – Private Endpoint Connections for namespace.
scale_unit (str) – Gets or sets scaleUnit where the namespace gets created.
data_center (str) – Deprecated.
public_network_access (str or PublicNetworkAccess) – Type of public network access. Known values are: “Enabled” and “Disabled”.

Keyword Arguments:

provisioning_state (str or OperationProvisioningState) – Defines values for OperationProvisioningState. Known values are: “Unknown”, “InProgress”, “Succeeded”, “Failed”, “Canceled”, “Pending”, and “Disabled”.
status (str or NamespaceStatus) – Namespace status. Known values are: “Created”, “Creating”, “Suspended”, and “Deleting”.
namespace_type (str or NamespaceType) – Defines values for NamespaceType. Known values are: “Messaging” and “NotificationHub”.
replication_region (str or ReplicationRegion) – Allowed replication region. Known values are: “Default”, “WestUs2”, “NorthEurope”, “AustraliaEast”, “BrazilSouth”, “SouthEastAsia”, “SouthAfricaNorth”, and “None”.
zone_redundancy (str or ZoneRedundancyPreference) – Namespace SKU name. Known values are: “Disabled” and “Enabled”.
network_acls (NetworkAcls) – A collection of network authorization rules.
pns_credentials (PnsCredentials) – Collection of Notification Hub or Notification Hub Namespace PNS credentials.
scale_unit (str) – Gets or sets scaleUnit where the namespace gets created.
data_center (str) – Deprecated.
public_network_access (str or PublicNetworkAccess) – Type of public network access. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.notificationhubs.models.NamespaceResource(*, location: str, sku: _models.Sku, tags: Dict[str, str] | None = None, provisioning_state: str | _models.OperationProvisioningState | None = None, status: str | _models.NamespaceStatus | None = None, namespace_type: str | _models.NamespaceType | None = None, replication_region: str | _models.ReplicationRegion | None = None, zone_redundancy: str | _models.ZoneRedundancyPreference = 'Disabled', network_acls: _models.NetworkAcls | None = None, pns_credentials: _models.PnsCredentials | None = None, scale_unit: str | None = None, data_center: str | None = None, public_network_access: str | _models.PublicNetworkAccess = 'Enabled', **kwargs: Any)[source]¶

Bases: TrackedResource

Notification Hubs Namespace Resource.

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

Variables:

id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives. Required.
sku (Sku) – The Sku description for a namespace. Required.
name_properties_name (str) – Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created.
provisioning_state (str or OperationProvisioningState) – Defines values for OperationProvisioningState. Known values are: “Unknown”, “InProgress”, “Succeeded”, “Failed”, “Canceled”, “Pending”, and “Disabled”.
status (str or NamespaceStatus) – Namespace status. Known values are: “Created”, “Creating”, “Suspended”, and “Deleting”.
enabled (bool) – Gets or sets whether or not the namespace is currently enabled.
critical (bool) – Gets or sets whether or not the namespace is set as Critical.
subscription_id (str) – Namespace subscription id.
region (str) – Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property.
metric_id (str) – Azure Insights Metrics id.
created_at (datetime) – Time when the namespace was created.
updated_at (datetime) – Time when the namespace was updated.
namespace_type (str or NamespaceType) – Defines values for NamespaceType. Known values are: “Messaging” and “NotificationHub”.
replication_region (str or ReplicationRegion) – Allowed replication region. Known values are: “Default”, “WestUs2”, “NorthEurope”, “AustraliaEast”, “BrazilSouth”, “SouthEastAsia”, “SouthAfricaNorth”, and “None”.
zone_redundancy (str or ZoneRedundancyPreference) – Namespace SKU name. Known values are: “Disabled” and “Enabled”.
network_acls (NetworkAcls) – A collection of network authorization rules.
pns_credentials (PnsCredentials) – Collection of Notification Hub or Notification Hub Namespace PNS credentials.
service_bus_endpoint (str) – Gets or sets endpoint you can use to perform NotificationHub operations.
private_endpoint_connections (list[PrivateEndpointConnectionResource]) – Private Endpoint Connections for namespace.
scale_unit (str) – Gets or sets scaleUnit where the namespace gets created.
data_center (str) – Deprecated.
public_network_access (str or PublicNetworkAccess) – Type of public network access. Known values are: “Enabled” and “Disabled”.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives. Required.
sku (Sku) – The Sku description for a namespace. Required.
provisioning_state (str or OperationProvisioningState) – Defines values for OperationProvisioningState. Known values are: “Unknown”, “InProgress”, “Succeeded”, “Failed”, “Canceled”, “Pending”, and “Disabled”.
status (str or NamespaceStatus) – Namespace status. Known values are: “Created”, “Creating”, “Suspended”, and “Deleting”.
namespace_type (str or NamespaceType) – Defines values for NamespaceType. Known values are: “Messaging” and “NotificationHub”.
replication_region (str or ReplicationRegion) – Allowed replication region. Known values are: “Default”, “WestUs2”, “NorthEurope”, “AustraliaEast”, “BrazilSouth”, “SouthEastAsia”, “SouthAfricaNorth”, and “None”.
zone_redundancy (str or ZoneRedundancyPreference) – Namespace SKU name. Known values are: “Disabled” and “Enabled”.
network_acls (NetworkAcls) – A collection of network authorization rules.
pns_credentials (PnsCredentials) – Collection of Notification Hub or Notification Hub Namespace PNS credentials.
scale_unit (str) – Gets or sets scaleUnit where the namespace gets created.
data_center (str) – Deprecated.
public_network_access (str or PublicNetworkAccess) – Type of public network access. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.notificationhubs.models.NamespaceStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Namespace status.

CREATED = 'Created'¶

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

SUSPENDED = 'Suspended'¶

class azure.mgmt.notificationhubs.models.NamespaceType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Defines values for NamespaceType.

MESSAGING = 'Messaging'¶

NOTIFICATION_HUB = 'NotificationHub'¶

class azure.mgmt.notificationhubs.models.NetworkAcls(*, ip_rules: List[_models.IpRule] | None = None, public_network_rule: _models.PublicInternetAuthorizationRule | None = None, **kwargs: Any)[source]¶

Bases: Model

A collection of network authorization rules.

Variables:

ip_rules (list[IpRule]) – List of IP rules.
public_network_rule (PublicInternetAuthorizationRule) – A default (public Internet) network authorization rule, which contains rights if no other network rule matches.

Keyword Arguments:

ip_rules (list[IpRule]) – List of IP rules.
public_network_rule (PublicInternetAuthorizationRule) – A default (public Internet) network authorization rule, which contains rights if no other network rule matches.

class azure.mgmt.notificationhubs.models.NotificationHubListResult(**kwargs: Any)[source]¶

Bases: Model

The response of the List NotificationHub operation.

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

Variables:

value (list[NotificationHubResource]) – Gets or sets result of the List AuthorizationRules operation.
next_link (str) – Gets or sets link to the next set of results.

class azure.mgmt.notificationhubs.models.NotificationHubPatchParameters(*, sku: _models.Sku | None = None, tags: Dict[str, str] | None = None, name: str | None = None, registration_ttl: str | None = None, apns_credential: _models.ApnsCredential | None = None, wns_credential: _models.WnsCredential | None = None, gcm_credential: _models.GcmCredential | None = None, mpns_credential: _models.MpnsCredential | None = None, adm_credential: _models.AdmCredential | None = None, baidu_credential: _models.BaiduCredential | None = None, browser_credential: _models.BrowserCredential | None = None, xiaomi_credential: _models.XiaomiCredential | None = None, fcm_v1_credential: _models.FcmV1Credential | None = None, **kwargs: Any)[source]¶

Bases: Model

Patch parameter for NamespaceResource.

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

Variables:

sku (Sku) – The Sku description for a namespace.
tags (dict[str, str]) – Dictionary of <string>.
name (str) – Gets or sets the NotificationHub name.
registration_ttl (str) – Gets or sets the RegistrationTtl of the created NotificationHub.
authorization_rules (list[SharedAccessAuthorizationRuleProperties]) – Gets or sets the AuthorizationRules of the created NotificationHub.
apns_credential (ApnsCredential) – Description of a NotificationHub ApnsCredential.
wns_credential (WnsCredential) – Description of a NotificationHub WnsCredential.
gcm_credential (GcmCredential) – Description of a NotificationHub GcmCredential.
mpns_credential (MpnsCredential) – Description of a NotificationHub MpnsCredential.
adm_credential (AdmCredential) – Description of a NotificationHub AdmCredential.
baidu_credential (BaiduCredential) – Description of a NotificationHub BaiduCredential.
browser_credential (BrowserCredential) – Description of a NotificationHub BrowserCredential.
xiaomi_credential (XiaomiCredential) – Description of a NotificationHub XiaomiCredential.
fcm_v1_credential (FcmV1Credential) – Description of a NotificationHub FcmV1Credential.
daily_max_active_devices (int) –

Keyword Arguments:

sku (Sku) – The Sku description for a namespace.
tags (dict[str, str]) – Dictionary of <string>.
name (str) – Gets or sets the NotificationHub name.
registration_ttl (str) – Gets or sets the RegistrationTtl of the created NotificationHub.
apns_credential (ApnsCredential) – Description of a NotificationHub ApnsCredential.
wns_credential (WnsCredential) – Description of a NotificationHub WnsCredential.
gcm_credential (GcmCredential) – Description of a NotificationHub GcmCredential.
mpns_credential (MpnsCredential) – Description of a NotificationHub MpnsCredential.
adm_credential (AdmCredential) – Description of a NotificationHub AdmCredential.
baidu_credential (BaiduCredential) – Description of a NotificationHub BaiduCredential.
browser_credential (BrowserCredential) – Description of a NotificationHub BrowserCredential.
xiaomi_credential (XiaomiCredential) – Description of a NotificationHub XiaomiCredential.
fcm_v1_credential (FcmV1Credential) – Description of a NotificationHub FcmV1Credential.

class azure.mgmt.notificationhubs.models.NotificationHubResource(*, location: str, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, name_properties_name: str | None = None, registration_ttl: str | None = None, apns_credential: _models.ApnsCredential | None = None, wns_credential: _models.WnsCredential | None = None, gcm_credential: _models.GcmCredential | None = None, mpns_credential: _models.MpnsCredential | None = None, adm_credential: _models.AdmCredential | None = None, baidu_credential: _models.BaiduCredential | None = None, browser_credential: _models.BrowserCredential | None = None, xiaomi_credential: _models.XiaomiCredential | None = None, fcm_v1_credential: _models.FcmV1Credential | None = None, **kwargs: Any)[source]¶

Bases: TrackedResource

Notification Hub Resource.

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

Variables:

id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives. Required.
sku (Sku) – The Sku description for a namespace.
name_properties_name (str) – Gets or sets the NotificationHub name.
registration_ttl (str) – Gets or sets the RegistrationTtl of the created NotificationHub.
authorization_rules (list[SharedAccessAuthorizationRuleProperties]) – Gets or sets the AuthorizationRules of the created NotificationHub.
apns_credential (ApnsCredential) – Description of a NotificationHub ApnsCredential.
wns_credential (WnsCredential) – Description of a NotificationHub WnsCredential.
gcm_credential (GcmCredential) – Description of a NotificationHub GcmCredential.
mpns_credential (MpnsCredential) – Description of a NotificationHub MpnsCredential.
adm_credential (AdmCredential) – Description of a NotificationHub AdmCredential.
baidu_credential (BaiduCredential) – Description of a NotificationHub BaiduCredential.
browser_credential (BrowserCredential) – Description of a NotificationHub BrowserCredential.
xiaomi_credential (XiaomiCredential) – Description of a NotificationHub XiaomiCredential.
fcm_v1_credential (FcmV1Credential) – Description of a NotificationHub FcmV1Credential.
daily_max_active_devices (int) –

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives. Required.
sku (Sku) – The Sku description for a namespace.
name_properties_name (str) – Gets or sets the NotificationHub name.
registration_ttl (str) – Gets or sets the RegistrationTtl of the created NotificationHub.
apns_credential (ApnsCredential) – Description of a NotificationHub ApnsCredential.
wns_credential (WnsCredential) – Description of a NotificationHub WnsCredential.
gcm_credential (GcmCredential) – Description of a NotificationHub GcmCredential.
mpns_credential (MpnsCredential) – Description of a NotificationHub MpnsCredential.
adm_credential (AdmCredential) – Description of a NotificationHub AdmCredential.
baidu_credential (BaiduCredential) – Description of a NotificationHub BaiduCredential.
browser_credential (BrowserCredential) – Description of a NotificationHub BrowserCredential.
xiaomi_credential (XiaomiCredential) – Description of a NotificationHub XiaomiCredential.
fcm_v1_credential (FcmV1Credential) – Description of a NotificationHub FcmV1Credential.

class azure.mgmt.notificationhubs.models.Operation(*, display: _models.OperationDisplay | None = None, properties: _models.OperationProperties | None = None, **kwargs: Any)[source]¶

Bases: Model

A NotificationHubs REST API operation.

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

Variables:

name (str) – Gets operation name: {provider}/{resource}/{operation}.
display (OperationDisplay) – The object that represents the operation.
properties (OperationProperties) – Optional operation properties.
is_data_action (bool) – Gets or sets IsDataAction property. It is used to differentiate management and data plane operations.

Keyword Arguments:

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

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

Bases: 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) – Gets service provider: Microsoft.NotificationHubs.
resource (str) – Gets resource on which the operation is performed: Invoice, etc.
operation (str) – Gets operation type: Read, write, delete, etc.
description (str) – Human-friendly operation description.

class azure.mgmt.notificationhubs.models.OperationListResult(**kwargs: Any)[source]¶

Bases: 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]) – Gets list of NotificationHubs operations supported by the Microsoft.NotificationHubs resource provider.
next_link (str) – Gets URL to get the next set of operation list results if there are any.

class azure.mgmt.notificationhubs.models.OperationProperties(*, service_specification: _models.ServiceSpecification | None = None, **kwargs: Any)[source]¶

Bases: Model

Optional operation properties.

Variables:: service_specification (ServiceSpecification) – Optional service specification used in Operations API.
Keyword Arguments:: service_specification (ServiceSpecification) – Optional service specification used in Operations API.

class azure.mgmt.notificationhubs.models.OperationProvisioningState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Defines values for OperationProvisioningState.

CANCELED = 'Canceled'¶

DISABLED = 'Disabled'¶

FAILED = 'Failed'¶

IN_PROGRESS = 'InProgress'¶

PENDING = 'Pending'¶

SUCCEEDED = 'Succeeded'¶

UNKNOWN = 'Unknown'¶

class azure.mgmt.notificationhubs.models.PnsCredentials(*, adm_credential: _models.AdmCredential | None = None, apns_credential: _models.ApnsCredential | None = None, baidu_credential: _models.BaiduCredential | None = None, browser_credential: _models.BrowserCredential | None = None, gcm_credential: _models.GcmCredential | None = None, mpns_credential: _models.MpnsCredential | None = None, wns_credential: _models.WnsCredential | None = None, xiaomi_credential: _models.XiaomiCredential | None = None, fcm_v1_credential: _models.FcmV1Credential | None = None, **kwargs: Any)[source]¶

Bases: Model

Collection of Notification Hub or Notification Hub Namespace PNS credentials.

Variables:

adm_credential (AdmCredential) – Description of a NotificationHub AdmCredential.
apns_credential (ApnsCredential) – Description of a NotificationHub ApnsCredential.
baidu_credential (BaiduCredential) – Description of a NotificationHub BaiduCredential.
browser_credential (BrowserCredential) – Description of a NotificationHub BrowserCredential.
gcm_credential (GcmCredential) – Description of a NotificationHub GcmCredential.
mpns_credential (MpnsCredential) – Description of a NotificationHub MpnsCredential.
wns_credential (WnsCredential) – Description of a NotificationHub WnsCredential.
xiaomi_credential (XiaomiCredential) – Description of a NotificationHub XiaomiCredential.
fcm_v1_credential (FcmV1Credential) – Description of a NotificationHub FcmV1Credential.

Keyword Arguments:

adm_credential (AdmCredential) – Description of a NotificationHub AdmCredential.
apns_credential (ApnsCredential) – Description of a NotificationHub ApnsCredential.
baidu_credential (BaiduCredential) – Description of a NotificationHub BaiduCredential.
browser_credential (BrowserCredential) – Description of a NotificationHub BrowserCredential.
gcm_credential (GcmCredential) – Description of a NotificationHub GcmCredential.
mpns_credential (MpnsCredential) – Description of a NotificationHub MpnsCredential.
wns_credential (WnsCredential) – Description of a NotificationHub WnsCredential.
xiaomi_credential (XiaomiCredential) – Description of a NotificationHub XiaomiCredential.
fcm_v1_credential (FcmV1Credential) – Description of a NotificationHub FcmV1Credential.

class azure.mgmt.notificationhubs.models.PnsCredentialsResource(*, location: str | None = None, tags: Dict[str, str] | None = None, adm_credential: _models.AdmCredential | None = None, apns_credential: _models.ApnsCredential | None = None, baidu_credential: _models.BaiduCredential | None = None, browser_credential: _models.BrowserCredential | None = None, gcm_credential: _models.GcmCredential | None = None, mpns_credential: _models.MpnsCredential | None = None, wns_credential: _models.WnsCredential | None = None, xiaomi_credential: _models.XiaomiCredential | None = None, fcm_v1_credential: _models.FcmV1Credential | None = None, **kwargs: Any)[source]¶

Bases: ProxyResource

Description of a NotificationHub PNS Credentials. This is a response of the POST requests that return namespace or hubs PNS credentials.

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

Variables:

id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
location (str) – Deprecated - only for compatibility.
tags (dict[str, str]) – Deprecated - only for compatibility.
adm_credential (AdmCredential) – Description of a NotificationHub AdmCredential.
apns_credential (ApnsCredential) – Description of a NotificationHub ApnsCredential.
baidu_credential (BaiduCredential) – Description of a NotificationHub BaiduCredential.
browser_credential (BrowserCredential) – Description of a NotificationHub BrowserCredential.
gcm_credential (GcmCredential) – Description of a NotificationHub GcmCredential.
mpns_credential (MpnsCredential) – Description of a NotificationHub MpnsCredential.
wns_credential (WnsCredential) – Description of a NotificationHub WnsCredential.
xiaomi_credential (XiaomiCredential) – Description of a NotificationHub XiaomiCredential.
fcm_v1_credential (FcmV1Credential) – Description of a NotificationHub FcmV1Credential.

Keyword Arguments:

location (str) – Deprecated - only for compatibility.
tags (dict[str, str]) – Deprecated - only for compatibility.
adm_credential (AdmCredential) – Description of a NotificationHub AdmCredential.
apns_credential (ApnsCredential) – Description of a NotificationHub ApnsCredential.
baidu_credential (BaiduCredential) – Description of a NotificationHub BaiduCredential.
browser_credential (BrowserCredential) – Description of a NotificationHub BrowserCredential.
gcm_credential (GcmCredential) – Description of a NotificationHub GcmCredential.
mpns_credential (MpnsCredential) – Description of a NotificationHub MpnsCredential.
wns_credential (WnsCredential) – Description of a NotificationHub WnsCredential.
xiaomi_credential (XiaomiCredential) – Description of a NotificationHub XiaomiCredential.
fcm_v1_credential (FcmV1Credential) – Description of a NotificationHub FcmV1Credential.

class azure.mgmt.notificationhubs.models.PolicyKeyResource(*, policy_key: str | _models.PolicyKeyType, **kwargs: Any)[source]¶

Bases: Model

Namespace / NotificationHub Regenerate Keys request.

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

Variables:: policy_key (str or PolicyKeyType) – Type of Shared Access Policy Key (primary or secondary). Required. Known values are: “PrimaryKey” and “SecondaryKey”.
Keyword Arguments:: policy_key (str or PolicyKeyType) – Type of Shared Access Policy Key (primary or secondary). Required. Known values are: “PrimaryKey” and “SecondaryKey”.

class azure.mgmt.notificationhubs.models.PolicyKeyType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Type of Shared Access Policy Key (primary or secondary).

PRIMARY_KEY = 'PrimaryKey'¶

SECONDARY_KEY = 'SecondaryKey'¶

class azure.mgmt.notificationhubs.models.PrivateEndpointConnectionProperties(*, provisioning_state: str | _models.PrivateEndpointConnectionProvisioningState | None = None, private_endpoint: _models.RemotePrivateEndpointConnection | None = None, private_link_service_connection_state: _models.RemotePrivateLinkServiceConnectionState | None = None, **kwargs: Any)[source]¶

Bases: Model

Private Endpoint Connection properties.

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

Variables:

provisioning_state (str or PrivateEndpointConnectionProvisioningState) – State of Private Endpoint Connection. Known values are: “Unknown”, “Succeeded”, “Creating”, “Updating”, “UpdatingByProxy”, “Deleting”, “DeletingByProxy”, and “Deleted”.
private_endpoint (RemotePrivateEndpointConnection) – Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection.
group_ids (list[str]) – List of group ids. For Notification Hubs, it always contains a single “namespace” element.
private_link_service_connection_state (RemotePrivateLinkServiceConnectionState) – State of the Private Link Service connection.

Keyword Arguments:

provisioning_state (str or PrivateEndpointConnectionProvisioningState) – State of Private Endpoint Connection. Known values are: “Unknown”, “Succeeded”, “Creating”, “Updating”, “UpdatingByProxy”, “Deleting”, “DeletingByProxy”, and “Deleted”.
private_endpoint (RemotePrivateEndpointConnection) – Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection.
private_link_service_connection_state (RemotePrivateLinkServiceConnectionState) – State of the Private Link Service connection.

class azure.mgmt.notificationhubs.models.PrivateEndpointConnectionProvisioningState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

State of Private Endpoint Connection.

CREATING = 'Creating'¶

DELETED = 'Deleted'¶

DELETING = 'Deleting'¶

DELETING_BY_PROXY = 'DeletingByProxy'¶

SUCCEEDED = 'Succeeded'¶

UNKNOWN = 'Unknown'¶

UPDATING = 'Updating'¶

UPDATING_BY_PROXY = 'UpdatingByProxy'¶

class azure.mgmt.notificationhubs.models.PrivateEndpointConnectionResource(*, properties: _models.PrivateEndpointConnectionProperties | None = None, **kwargs: Any)[source]¶

Bases: ProxyResource

Represents a Private Endpoint Connection ARM resource - a sub-resource of Notification Hubs namespace.

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

Variables:

id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
properties (PrivateEndpointConnectionProperties) – Private Endpoint Connection properties.

Keyword Arguments:

properties (PrivateEndpointConnectionProperties) – Private Endpoint Connection properties.

class azure.mgmt.notificationhubs.models.PrivateEndpointConnectionResourceListResult(**kwargs: Any)[source]¶

Bases: Model

The response of the List Private Endpoint Connections operation.

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

Variables:

value (list[PrivateEndpointConnectionResource]) – Gets or sets result of the List AuthorizationRules operation.
next_link (str) – Gets or sets link to the next set of results.

class azure.mgmt.notificationhubs.models.PrivateLinkConnectionStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

State of Private Link Connection.

APPROVED = 'Approved'¶

DISCONNECTED = 'Disconnected'¶

PENDING = 'Pending'¶

REJECTED = 'Rejected'¶

class azure.mgmt.notificationhubs.models.PrivateLinkResource(*, properties: _models.PrivateLinkResourceProperties | None = None, **kwargs: Any)[source]¶

Bases: ProxyResource

A Private Link Arm Resource.

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

Variables:

id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
properties (PrivateLinkResourceProperties) – Represents properties of Private Link Resource.

Keyword Arguments:

properties (PrivateLinkResourceProperties) – Represents properties of Private Link Resource.

class azure.mgmt.notificationhubs.models.PrivateLinkResourceListResult(**kwargs: Any)[source]¶

Bases: Model

The response of the List Private Link Resources operation.

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

Variables:

value (list[PrivateLinkResource]) – Gets or sets result of the List AuthorizationRules operation.
next_link (str) – Gets or sets link to the next set of results.

class azure.mgmt.notificationhubs.models.PrivateLinkResourceProperties(**kwargs: Any)[source]¶

Bases: Model

Represents properties of Private Link Resource.

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

Variables:

group_id (str) – A Group Id for Private Link. For Notification Hubs, it is always set to “namespace”.
required_members (list[str]) – Required members. For Notification Hubs, it’s always a collection with a single “namespace” item.
required_zone_names (list[str]) – Required DNS zone names. For Notification Hubs, it contains two CNames for Service Bus and Notification Hubs zones.

class azure.mgmt.notificationhubs.models.PrivateLinkServiceConnection(*, name: str | None = None, group_ids: List[str] | None = None, request_message: str | None = None, **kwargs: Any)[source]¶

Bases: Model

A customer-visible sub-resource of Private Endpoint, which describe the connection between Private Endpoint and Notification Hubs namespace.

Variables:

name (str) – Name of the Private Link Service connection.
group_ids (list[str]) – List of group ids. Always contains a single element - “namespace” - for Notification Hub Namespace.
request_message (str) – Request message provided by the user that created the connection. This is usually used when the connection requires manual approval.

Keyword Arguments:

name (str) – Name of the Private Link Service connection.
group_ids (list[str]) – List of group ids. Always contains a single element - “namespace” - for Notification Hub Namespace.
request_message (str) – Request message provided by the user that created the connection. This is usually used when the connection requires manual approval.

class azure.mgmt.notificationhubs.models.ProxyResource(**kwargs: Any)[source]¶

Bases: Resource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.

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

Variables:

id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.notificationhubs.models.PublicInternetAuthorizationRule(*, rights: List[str | _models.AccessRights], **kwargs: Any)[source]¶

Bases: Model

A default (public Internet) network authorization rule, which contains rights if no other network rule matches.

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

Variables:: rights (list[str or AccessRights]) – List of access rights. Required.
Keyword Arguments:: rights (list[str or AccessRights]) – List of access rights. Required.

class azure.mgmt.notificationhubs.models.PublicNetworkAccess(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Type of public network access.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.notificationhubs.models.RegistrationResult(**kwargs: Any)[source]¶

Bases: Model

Notification result for a single registration.

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

Variables:

application_platform (str) – PNS type.
pns_handle (str) – PNS handle.
registration_id (str) – Registration id.
outcome (str) – Notification outcome.

class azure.mgmt.notificationhubs.models.RemotePrivateEndpointConnection(**kwargs: Any)[source]¶

Bases: Model

Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection.

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

Variables:: id (str) – ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace.

class azure.mgmt.notificationhubs.models.RemotePrivateLinkServiceConnectionState(*, status: str | _models.PrivateLinkConnectionStatus | None = None, **kwargs: Any)[source]¶

Bases: Model

State of the Private Link Service connection.

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

Variables:

status (str or PrivateLinkConnectionStatus) – State of Private Link Connection. Known values are: “Disconnected”, “Pending”, “Approved”, and “Rejected”.
description (str) – Human-friendly description.
actions_required (str) – Human-friendly description of required actions.

Keyword Arguments:

status (str or PrivateLinkConnectionStatus) – State of Private Link Connection. Known values are: “Disconnected”, “Pending”, “Approved”, and “Rejected”.

class azure.mgmt.notificationhubs.models.ReplicationRegion(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Allowed replication region.

AUSTRALIA_EAST = 'AustraliaEast'¶

BRAZIL_SOUTH = 'BrazilSouth'¶

DEFAULT = 'Default'¶

NONE = 'None'¶

NORTH_EUROPE = 'NorthEurope'¶

SOUTH_AFRICA_NORTH = 'SouthAfricaNorth'¶

SOUTH_EAST_ASIA = 'SouthEastAsia'¶

WEST_US2 = 'WestUs2'¶

class azure.mgmt.notificationhubs.models.Resource(**kwargs: Any)[source]¶

Bases: Model

Common fields that are returned in the response for all Azure Resource Manager resources.

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

Variables:

id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.notificationhubs.models.ResourceListKeys(**kwargs: Any)[source]¶

Bases: Model

Response for the POST request that returns Namespace or NotificationHub access keys (connection strings).

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

Variables:

primary_connection_string (str) – Gets or sets primaryConnectionString of the AuthorizationRule.
secondary_connection_string (str) – Gets or sets secondaryConnectionString of the created AuthorizationRule.
primary_key (str) – Gets or sets primaryKey of the created AuthorizationRule.
secondary_key (str) – Gets or sets secondaryKey of the created AuthorizationRule.
key_name (str) – Gets or sets keyName of the created AuthorizationRule.

class azure.mgmt.notificationhubs.models.ServiceSpecification(**kwargs: Any)[source]¶

Bases: Model

Optional service specification used in Operations API.

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

Variables:

log_specifications (list[LogSpecification]) – Log specifications.
metric_specifications (list[MetricSpecification]) – Metric specification.

class azure.mgmt.notificationhubs.models.SharedAccessAuthorizationRuleListResult(**kwargs: Any)[source]¶

Bases: Model

The response of the List Namespace operation.

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

Variables:

value (list[SharedAccessAuthorizationRuleResource]) – Gets or sets result of the List AuthorizationRules operation.
next_link (str) – Gets or sets link to the next set of results.

class azure.mgmt.notificationhubs.models.SharedAccessAuthorizationRuleProperties(*, rights: List[str | _models.AccessRights], primary_key: str | None = None, secondary_key: str | None = None, **kwargs: Any)[source]¶

Bases: Model

SharedAccessAuthorizationRule properties.

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

Variables:

rights (list[str or AccessRights]) – Gets or sets the rights associated with the rule. Required.
primary_key (str) – Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
secondary_key (str) – Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
key_name (str) – Gets a string that describes the authorization rule.
modified_time (datetime) – Gets the last modified time for this rule.
created_time (datetime) – Gets the created time for this rule.
claim_type (str) – Gets a string that describes the claim type.
claim_value (str) – Gets a string that describes the claim value.
revision (int) – Gets the revision number for the rule.

Keyword Arguments:

rights (list[str or AccessRights]) – Gets or sets the rights associated with the rule. Required.
primary_key (str) – Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
secondary_key (str) – Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.

Bases: ProxyResource

Response for POST requests that return single SharedAccessAuthorizationRule.

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

Variables:

id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
location (str) – Deprecated - only for compatibility.
tags (dict[str, str]) – Deprecated - only for compatibility.
rights (list[str or AccessRights]) – Gets or sets the rights associated with the rule.
primary_key (str) – Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
secondary_key (str) – Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
key_name (str) – Gets a string that describes the authorization rule.
modified_time (datetime) – Gets the last modified time for this rule.
created_time (datetime) – Gets the created time for this rule.
claim_type (str) – Gets a string that describes the claim type.
claim_value (str) – Gets a string that describes the claim value.
revision (int) – Gets the revision number for the rule.

Keyword Arguments:

location (str) – Deprecated - only for compatibility.
tags (dict[str, str]) – Deprecated - only for compatibility.
rights (list[str or AccessRights]) – Gets or sets the rights associated with the rule.
primary_key (str) – Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
secondary_key (str) – Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.

Bases: Model

The Sku description for a namespace.

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

Variables:

name (str or SkuName) – Namespace SKU name. Required. Known values are: “Free”, “Basic”, and “Standard”.
tier (str) – Gets or sets the tier of particular sku.
size (str) – Gets or sets the Sku size.
family (str) – Gets or sets the Sku Family.
capacity (int) – Gets or sets the capacity of the resource.

Keyword Arguments:

name (str or SkuName) – Namespace SKU name. Required. Known values are: “Free”, “Basic”, and “Standard”.
tier (str) – Gets or sets the tier of particular sku.
size (str) – Gets or sets the Sku size.
family (str) – Gets or sets the Sku Family.
capacity (int) – Gets or sets the capacity of the resource.

class azure.mgmt.notificationhubs.models.SkuName(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Namespace SKU name.

BASIC = 'Basic'¶

FREE = 'Free'¶

STANDARD = 'Standard'¶

Bases: Model

Metadata pertaining to creation and last modification of the resource.

Variables:

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments:

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.notificationhubs.models.TrackedResource(*, location: str, tags: Dict[str, str] | None = None, **kwargs: Any)[source]¶

Bases: Resource

The resource model definition for an Azure Resource Manager tracked top level resource which has ‘tags’ and a ‘location’.

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

Variables:

id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives. Required.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives. Required.

class azure.mgmt.notificationhubs.models.WnsCredential(*, package_sid: str | None = None, secret_key: str | None = None, windows_live_endpoint: str | None = None, certificate_key: str | None = None, wns_certificate: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Description of a NotificationHub WnsCredential.

Variables:

package_sid (str) – Gets or sets the package ID for this credential.
secret_key (str) – Gets or sets the secret key.
windows_live_endpoint (str) – Gets or sets the Windows Live endpoint.
certificate_key (str) – Ges or sets the WNS Certificate Key.
wns_certificate (str) – Gets or sets the WNS Certificate.

Keyword Arguments:

package_sid (str) – Gets or sets the package ID for this credential.
secret_key (str) – Gets or sets the secret key.
windows_live_endpoint (str) – Gets or sets the Windows Live endpoint.
certificate_key (str) – Ges or sets the WNS Certificate Key.
wns_certificate (str) – Gets or sets the WNS Certificate.

class azure.mgmt.notificationhubs.models.XiaomiCredential(*, app_secret: str | None = None, endpoint: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Description of a NotificationHub XiaomiCredential.

Variables:

app_secret (str) – Gets or sets app secret.
endpoint (str) – Gets or sets xiaomi service endpoint.

Keyword Arguments:

app_secret (str) – Gets or sets app secret.
endpoint (str) – Gets or sets xiaomi service endpoint.

class azure.mgmt.notificationhubs.models.ZoneRedundancyPreference(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Namespace SKU name.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶