# coding=utf-8
# pylint: disable=too-many-lines
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
import datetime
from typing import Any, Dict, List, Optional, TYPE_CHECKING, Union
from .. import _serialization
if TYPE_CHECKING:
# pylint: disable=unused-import,ungrouped-imports
from .. import models as _models
[docs]class AdmCredential(_serialization.Model):
"""Description of a NotificationHub AdmCredential.
All required parameters must be populated in order to send to server.
:ivar client_id: Gets or sets the client identifier. Required.
:vartype client_id: str
:ivar client_secret: Gets or sets the credential secret access key. Required.
:vartype client_secret: str
:ivar auth_token_url: Gets or sets the URL of the authorization token. Required.
:vartype auth_token_url: str
"""
_validation = {
"client_id": {"required": True, "min_length": 1},
"client_secret": {"required": True, "min_length": 1},
"auth_token_url": {"required": True, "min_length": 1},
}
_attribute_map = {
"client_id": {"key": "properties.clientId", "type": "str"},
"client_secret": {"key": "properties.clientSecret", "type": "str"},
"auth_token_url": {"key": "properties.authTokenUrl", "type": "str"},
}
def __init__(self, *, client_id: str, client_secret: str, auth_token_url: str, **kwargs: Any) -> None:
"""
:keyword client_id: Gets or sets the client identifier. Required.
:paramtype client_id: str
:keyword client_secret: Gets or sets the credential secret access key. Required.
:paramtype client_secret: str
:keyword auth_token_url: Gets or sets the URL of the authorization token. Required.
:paramtype auth_token_url: str
"""
super().__init__(**kwargs)
self.client_id = client_id
self.client_secret = client_secret
self.auth_token_url = auth_token_url
[docs]class ApnsCredential(_serialization.Model):
"""Description of a NotificationHub ApnsCredential.
All required parameters must be populated in order to send to server.
:ivar apns_certificate: Gets or sets the APNS certificate.
:vartype apns_certificate: str
:ivar certificate_key: Gets or sets the certificate key.
:vartype certificate_key: str
:ivar endpoint: Gets or sets the endpoint of this credential. Required.
:vartype endpoint: str
:ivar thumbprint: Gets or sets the APNS certificate Thumbprint.
:vartype thumbprint: str
:ivar key_id: Gets or sets a 10-character key identifier (kid) key, obtained from
your developer account.
:vartype key_id: str
:ivar app_name: Gets or sets the name of the application.
:vartype app_name: str
:ivar app_id: Gets or sets the issuer (iss) registered claim key, whose value is
your 10-character Team ID, obtained from your developer account.
:vartype app_id: str
:ivar token: Gets or sets provider Authentication Token, obtained through your
developer account.
:vartype token: str
"""
_validation = {
"endpoint": {"required": True, "min_length": 1},
}
_attribute_map = {
"apns_certificate": {"key": "properties.apnsCertificate", "type": "str"},
"certificate_key": {"key": "properties.certificateKey", "type": "str"},
"endpoint": {"key": "properties.endpoint", "type": "str"},
"thumbprint": {"key": "properties.thumbprint", "type": "str"},
"key_id": {"key": "properties.keyId", "type": "str"},
"app_name": {"key": "properties.appName", "type": "str"},
"app_id": {"key": "properties.appId", "type": "str"},
"token": {"key": "properties.token", "type": "str"},
}
def __init__(
self,
*,
endpoint: str,
apns_certificate: Optional[str] = None,
certificate_key: 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: Any
) -> None:
"""
:keyword apns_certificate: Gets or sets the APNS certificate.
:paramtype apns_certificate: str
:keyword certificate_key: Gets or sets the certificate key.
:paramtype certificate_key: str
:keyword endpoint: Gets or sets the endpoint of this credential. Required.
:paramtype endpoint: str
:keyword thumbprint: Gets or sets the APNS certificate Thumbprint.
:paramtype thumbprint: str
:keyword key_id: Gets or sets a 10-character key identifier (kid) key, obtained from
your developer account.
:paramtype key_id: str
:keyword app_name: Gets or sets the name of the application.
:paramtype app_name: str
:keyword app_id: Gets or sets the issuer (iss) registered claim key, whose value is
your 10-character Team ID, obtained from your developer account.
:paramtype app_id: str
:keyword token: Gets or sets provider Authentication Token, obtained through your
developer account.
:paramtype token: str
"""
super().__init__(**kwargs)
self.apns_certificate = apns_certificate
self.certificate_key = certificate_key
self.endpoint = endpoint
self.thumbprint = thumbprint
self.key_id = key_id
self.app_name = app_name
self.app_id = app_id
self.token = token
[docs]class Availability(_serialization.Model):
"""Represents metric availability (part of RP operation descriptions).
Variables are only populated by the server, and will be ignored when sending a request.
:ivar time_grain: Time grain of the availability.
:vartype time_grain: str
:ivar blob_duration: Duration of the availability blob.
:vartype blob_duration: str
"""
_validation = {
"time_grain": {"readonly": True},
"blob_duration": {"readonly": True},
}
_attribute_map = {
"time_grain": {"key": "timeGrain", "type": "str"},
"blob_duration": {"key": "blobDuration", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.time_grain = None
self.blob_duration = None
[docs]class BaiduCredential(_serialization.Model):
"""Description of a NotificationHub BaiduCredential.
All required parameters must be populated in order to send to server.
:ivar baidu_api_key: Gets or sets baidu Api Key. Required.
:vartype baidu_api_key: str
:ivar baidu_end_point: Gets or sets baidu Endpoint. Required.
:vartype baidu_end_point: str
:ivar baidu_secret_key: Gets or sets baidu Secret Key. Required.
:vartype baidu_secret_key: str
"""
_validation = {
"baidu_api_key": {"required": True, "min_length": 1},
"baidu_end_point": {"required": True, "min_length": 1},
"baidu_secret_key": {"required": True, "min_length": 1},
}
_attribute_map = {
"baidu_api_key": {"key": "properties.baiduApiKey", "type": "str"},
"baidu_end_point": {"key": "properties.baiduEndPoint", "type": "str"},
"baidu_secret_key": {"key": "properties.baiduSecretKey", "type": "str"},
}
def __init__(self, *, baidu_api_key: str, baidu_end_point: str, baidu_secret_key: str, **kwargs: Any) -> None:
"""
:keyword baidu_api_key: Gets or sets baidu Api Key. Required.
:paramtype baidu_api_key: str
:keyword baidu_end_point: Gets or sets baidu Endpoint. Required.
:paramtype baidu_end_point: str
:keyword baidu_secret_key: Gets or sets baidu Secret Key. Required.
:paramtype baidu_secret_key: str
"""
super().__init__(**kwargs)
self.baidu_api_key = baidu_api_key
self.baidu_end_point = baidu_end_point
self.baidu_secret_key = baidu_secret_key
[docs]class BrowserCredential(_serialization.Model):
"""Description of a NotificationHub BrowserCredential.
All required parameters must be populated in order to send to server.
:ivar subject: Gets or sets web push subject. Required.
:vartype subject: str
:ivar vapid_private_key: Gets or sets VAPID private key. Required.
:vartype vapid_private_key: str
:ivar vapid_public_key: Gets or sets VAPID public key. Required.
:vartype vapid_public_key: str
"""
_validation = {
"subject": {"required": True, "min_length": 1},
"vapid_private_key": {"required": True, "min_length": 1},
"vapid_public_key": {"required": True, "min_length": 1},
}
_attribute_map = {
"subject": {"key": "properties.subject", "type": "str"},
"vapid_private_key": {"key": "properties.vapidPrivateKey", "type": "str"},
"vapid_public_key": {"key": "properties.vapidPublicKey", "type": "str"},
}
def __init__(self, *, subject: str, vapid_private_key: str, vapid_public_key: str, **kwargs: Any) -> None:
"""
:keyword subject: Gets or sets web push subject. Required.
:paramtype subject: str
:keyword vapid_private_key: Gets or sets VAPID private key. Required.
:paramtype vapid_private_key: str
:keyword vapid_public_key: Gets or sets VAPID public key. Required.
:paramtype vapid_public_key: str
"""
super().__init__(**kwargs)
self.subject = subject
self.vapid_private_key = vapid_private_key
self.vapid_public_key = vapid_public_key
[docs]class CheckAvailabilityParameters(_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 server.
:ivar id: Gets resource Id.
:vartype id: str
:ivar name: Gets or sets resource name. Required.
:vartype name: str
:ivar type: Gets resource type.
:vartype type: str
:ivar location: Gets or sets resource location.
:vartype location: str
:ivar tags: Gets or sets resource tags.
:vartype tags: dict[str, str]
:ivar is_availiable: Not used and deprecated since API version 2023-01-01-preview.
:vartype is_availiable: bool
:ivar sku: The Sku description for a namespace.
:vartype sku: ~azure.mgmt.notificationhubs.models.Sku
"""
_validation = {
"id": {"readonly": True},
"name": {"required": True, "min_length": 1},
"type": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"is_availiable": {"key": "isAvailiable", "type": "bool"},
"sku": {"key": "sku", "type": "Sku"},
}
def __init__(
self,
*,
name: str,
location: Optional[str] = None,
tags: Optional[Dict[str, str]] = None,
is_availiable: Optional[bool] = None,
sku: Optional["_models.Sku"] = None,
**kwargs: Any
) -> None:
"""
:keyword name: Gets or sets resource name. Required.
:paramtype name: str
:keyword location: Gets or sets resource location.
:paramtype location: str
:keyword tags: Gets or sets resource tags.
:paramtype tags: dict[str, str]
:keyword is_availiable: Not used and deprecated since API version 2023-01-01-preview.
:paramtype is_availiable: bool
:keyword sku: The Sku description for a namespace.
:paramtype sku: ~azure.mgmt.notificationhubs.models.Sku
"""
super().__init__(**kwargs)
self.id = None
self.name = name
self.type = None
self.location = location
self.tags = tags
self.is_availiable = is_availiable
self.sku = sku
[docs]class Resource(_serialization.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.
:ivar id: Fully qualified resource ID for the resource. E.g.
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy
information.
:vartype system_data: ~azure.mgmt.notificationhubs.models.SystemData
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"system_data": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.id = None
self.name = None
self.type = None
self.system_data = None
[docs]class ProxyResource(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.
:ivar id: Fully qualified resource ID for the resource. E.g.
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy
information.
:vartype system_data: ~azure.mgmt.notificationhubs.models.SystemData
"""
[docs]class CheckAvailabilityResult(ProxyResource):
"""Description of a CheckAvailability resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Fully qualified resource ID for the resource. E.g.
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy
information.
:vartype system_data: ~azure.mgmt.notificationhubs.models.SystemData
:ivar is_availiable: Gets or sets true if the name is available and can be used to
create new Namespace/NotificationHub. Otherwise false.
:vartype is_availiable: bool
:ivar location: Deprecated - only for compatibility.
:vartype location: str
:ivar tags: Deprecated - only for compatibility.
:vartype tags: dict[str, str]
:ivar sku: The Sku description for a namespace.
:vartype sku: ~azure.mgmt.notificationhubs.models.Sku
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"system_data": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
"is_availiable": {"key": "isAvailiable", "type": "bool"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"sku": {"key": "sku", "type": "Sku"},
}
def __init__(
self,
*,
is_availiable: Optional[bool] = None,
location: Optional[str] = None,
tags: Optional[Dict[str, str]] = None,
sku: Optional["_models.Sku"] = None,
**kwargs: Any
) -> None:
"""
:keyword is_availiable: Gets or sets true if the name is available and can be used to
create new Namespace/NotificationHub. Otherwise false.
:paramtype is_availiable: bool
:keyword location: Deprecated - only for compatibility.
:paramtype location: str
:keyword tags: Deprecated - only for compatibility.
:paramtype tags: dict[str, str]
:keyword sku: The Sku description for a namespace.
:paramtype sku: ~azure.mgmt.notificationhubs.models.Sku
"""
super().__init__(**kwargs)
self.is_availiable = is_availiable
self.location = location
self.tags = tags
self.sku = sku
[docs]class ConnectionDetails(_serialization.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.
:ivar id: 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.
:vartype id: str
:ivar private_ip_address: IP address of the Private Endpoint. This is not used by Notification
Hubs.
:vartype private_ip_address: str
:ivar link_identifier: 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.
:vartype link_identifier: str
:ivar group_id: Group name. Always "namespace" for Notification Hubs.
:vartype group_id: str
:ivar member_name: Member name. Always "namespace" for Notification Hubs.
:vartype member_name: str
"""
_validation = {
"id": {"readonly": True},
"private_ip_address": {"readonly": True},
"link_identifier": {"readonly": True},
"group_id": {"readonly": True},
"member_name": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"private_ip_address": {"key": "privateIpAddress", "type": "str"},
"link_identifier": {"key": "linkIdentifier", "type": "str"},
"group_id": {"key": "groupId", "type": "str"},
"member_name": {"key": "memberName", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.id = None
self.private_ip_address = None
self.link_identifier = None
self.group_id = None
self.member_name = None
[docs]class DebugSendResponse(ProxyResource):
"""Description of a NotificationHub Resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Fully qualified resource ID for the resource. E.g.
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy
information.
:vartype system_data: ~azure.mgmt.notificationhubs.models.SystemData
:ivar location: Deprecated - only for compatibility.
:vartype location: str
:ivar tags: Deprecated - only for compatibility.
:vartype tags: dict[str, str]
:ivar success: Gets or sets successful send.
:vartype success: int
:ivar failure: Gets or sets send failure.
:vartype failure: int
:ivar results: Gets or sets actual failure description.
:vartype results: list[~azure.mgmt.notificationhubs.models.RegistrationResult]
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"system_data": {"readonly": True},
"success": {"readonly": True},
"failure": {"readonly": True},
"results": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"success": {"key": "properties.success", "type": "int"},
"failure": {"key": "properties.failure", "type": "int"},
"results": {"key": "properties.results", "type": "[RegistrationResult]"},
}
def __init__(self, *, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs: Any) -> None:
"""
:keyword location: Deprecated - only for compatibility.
:paramtype location: str
:keyword tags: Deprecated - only for compatibility.
:paramtype tags: dict[str, str]
"""
super().__init__(**kwargs)
self.location = location
self.tags = tags
self.success = None
self.failure = None
self.results = None
[docs]class ErrorAdditionalInfo(_serialization.Model):
"""The resource management error additional info.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar type: The additional info type.
:vartype type: str
:ivar info: The additional info.
:vartype info: JSON
"""
_validation = {
"type": {"readonly": True},
"info": {"readonly": True},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"info": {"key": "info", "type": "object"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.type = None
self.info = None
[docs]class ErrorDetail(_serialization.Model):
"""The error detail.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar code: The error code.
:vartype code: str
:ivar message: The error message.
:vartype message: str
:ivar target: The error target.
:vartype target: str
:ivar details: The error details.
:vartype details: list[~azure.mgmt.notificationhubs.models.ErrorDetail]
:ivar additional_info: The error additional info.
:vartype additional_info: list[~azure.mgmt.notificationhubs.models.ErrorAdditionalInfo]
"""
_validation = {
"code": {"readonly": True},
"message": {"readonly": True},
"target": {"readonly": True},
"details": {"readonly": True},
"additional_info": {"readonly": True},
}
_attribute_map = {
"code": {"key": "code", "type": "str"},
"message": {"key": "message", "type": "str"},
"target": {"key": "target", "type": "str"},
"details": {"key": "details", "type": "[ErrorDetail]"},
"additional_info": {"key": "additionalInfo", "type": "[ErrorAdditionalInfo]"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.code = None
self.message = None
self.target = None
self.details = None
self.additional_info = None
[docs]class ErrorResponse(_serialization.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.).
:ivar error: The error object.
:vartype error: ~azure.mgmt.notificationhubs.models.ErrorDetail
"""
_attribute_map = {
"error": {"key": "error", "type": "ErrorDetail"},
}
def __init__(self, *, error: Optional["_models.ErrorDetail"] = None, **kwargs: Any) -> None:
"""
:keyword error: The error object.
:paramtype error: ~azure.mgmt.notificationhubs.models.ErrorDetail
"""
super().__init__(**kwargs)
self.error = error
[docs]class FcmV1Credential(_serialization.Model):
"""Description of a NotificationHub FcmV1Credential.
All required parameters must be populated in order to send to server.
:ivar client_email: Gets or sets client email. Required.
:vartype client_email: str
:ivar private_key: Gets or sets private key. Required.
:vartype private_key: str
:ivar project_id: Gets or sets project id. Required.
:vartype project_id: str
"""
_validation = {
"client_email": {"required": True, "min_length": 1},
"private_key": {"required": True, "min_length": 1},
"project_id": {"required": True, "min_length": 1},
}
_attribute_map = {
"client_email": {"key": "properties.clientEmail", "type": "str"},
"private_key": {"key": "properties.privateKey", "type": "str"},
"project_id": {"key": "properties.projectId", "type": "str"},
}
def __init__(self, *, client_email: str, private_key: str, project_id: str, **kwargs: Any) -> None:
"""
:keyword client_email: Gets or sets client email. Required.
:paramtype client_email: str
:keyword private_key: Gets or sets private key. Required.
:paramtype private_key: str
:keyword project_id: Gets or sets project id. Required.
:paramtype project_id: str
"""
super().__init__(**kwargs)
self.client_email = client_email
self.private_key = private_key
self.project_id = project_id
[docs]class GcmCredential(_serialization.Model):
"""Description of a NotificationHub GcmCredential.
All required parameters must be populated in order to send to server.
:ivar gcm_endpoint: Gets or sets the GCM endpoint.
:vartype gcm_endpoint: str
:ivar google_api_key: Gets or sets the Google API key. Required.
:vartype google_api_key: str
"""
_validation = {
"google_api_key": {"required": True, "min_length": 1},
}
_attribute_map = {
"gcm_endpoint": {"key": "properties.gcmEndpoint", "type": "str"},
"google_api_key": {"key": "properties.googleApiKey", "type": "str"},
}
def __init__(self, *, google_api_key: str, gcm_endpoint: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword gcm_endpoint: Gets or sets the GCM endpoint.
:paramtype gcm_endpoint: str
:keyword google_api_key: Gets or sets the Google API key. Required.
:paramtype google_api_key: str
"""
super().__init__(**kwargs)
self.gcm_endpoint = gcm_endpoint
self.google_api_key = google_api_key
[docs]class IpRule(_serialization.Model):
"""A network authorization rule that filters traffic based on IP address.
All required parameters must be populated in order to send to server.
:ivar ip_mask: IP mask. Required.
:vartype ip_mask: str
:ivar rights: List of access rights. Required.
:vartype rights: list[str or ~azure.mgmt.notificationhubs.models.AccessRights]
"""
_validation = {
"ip_mask": {"required": True, "min_length": 1},
"rights": {"required": True},
}
_attribute_map = {
"ip_mask": {"key": "ipMask", "type": "str"},
"rights": {"key": "rights", "type": "[str]"},
}
def __init__(self, *, ip_mask: str, rights: List[Union[str, "_models.AccessRights"]], **kwargs: Any) -> None:
"""
:keyword ip_mask: IP mask. Required.
:paramtype ip_mask: str
:keyword rights: List of access rights. Required.
:paramtype rights: list[str or ~azure.mgmt.notificationhubs.models.AccessRights]
"""
super().__init__(**kwargs)
self.ip_mask = ip_mask
self.rights = rights
[docs]class LogSpecification(_serialization.Model):
"""A single log category specification.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar name: Name of the log category.
:vartype name: str
:ivar display_name: Display name of the log category.
:vartype display_name: str
:ivar blob_duration: Duration of data written to a single blob.
:vartype blob_duration: str
:ivar category_groups: Category group for the log specification.
:vartype category_groups: list[str]
"""
_validation = {
"name": {"readonly": True},
"display_name": {"readonly": True},
"blob_duration": {"readonly": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"display_name": {"key": "displayName", "type": "str"},
"blob_duration": {"key": "blobDuration", "type": "str"},
"category_groups": {"key": "categoryGroups", "type": "[str]"},
}
def __init__(self, *, category_groups: Optional[List[str]] = None, **kwargs: Any) -> None:
"""
:keyword category_groups: Category group for the log specification.
:paramtype category_groups: list[str]
"""
super().__init__(**kwargs)
self.name = None
self.display_name = None
self.blob_duration = None
self.category_groups = category_groups
[docs]class MetricSpecification(_serialization.Model):
"""A metric specification.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar name: Metric name / id.
:vartype name: str
:ivar display_name: User-visible metric name.
:vartype display_name: str
:ivar display_description: Description of the metric.
:vartype display_description: str
:ivar unit: Metric unit.
:vartype unit: str
:ivar aggregation_type: Type of the aggregation (Average, Minimum, Maximum, Total or Count).
:vartype aggregation_type: str
:ivar availabilities: List of availabilities.
:vartype availabilities: list[~azure.mgmt.notificationhubs.models.Availability]
:ivar supported_time_grain_types: List of supported time grain types.
:vartype supported_time_grain_types: list[str]
:ivar metric_filter_pattern: The matching regex pattern to be applied to the field pointed by
the "metricsFilterPathSelector" flag in the ARM manifest.
:vartype metric_filter_pattern: str
:ivar fill_gap_with_zero: Optional property. If set to true, then zero will be returned for
time duration where no metric is emitted / published.
:vartype fill_gap_with_zero: bool
"""
_validation = {
"name": {"readonly": True},
"display_name": {"readonly": True},
"display_description": {"readonly": True},
"unit": {"readonly": True},
"aggregation_type": {"readonly": True},
"availabilities": {"readonly": True},
"supported_time_grain_types": {"readonly": True},
"metric_filter_pattern": {"readonly": True},
"fill_gap_with_zero": {"readonly": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"display_name": {"key": "displayName", "type": "str"},
"display_description": {"key": "displayDescription", "type": "str"},
"unit": {"key": "unit", "type": "str"},
"aggregation_type": {"key": "aggregationType", "type": "str"},
"availabilities": {"key": "availabilities", "type": "[Availability]"},
"supported_time_grain_types": {"key": "supportedTimeGrainTypes", "type": "[str]"},
"metric_filter_pattern": {"key": "metricFilterPattern", "type": "str"},
"fill_gap_with_zero": {"key": "fillGapWithZero", "type": "bool"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.name = None
self.display_name = None
self.display_description = None
self.unit = None
self.aggregation_type = None
self.availabilities = None
self.supported_time_grain_types = None
self.metric_filter_pattern = None
self.fill_gap_with_zero = None
[docs]class MpnsCredential(_serialization.Model):
"""Description of a NotificationHub MpnsCredential.
All required parameters must be populated in order to send to server.
:ivar mpns_certificate: Gets or sets the MPNS certificate. Required.
:vartype mpns_certificate: str
:ivar certificate_key: Gets or sets the certificate key for this credential. Required.
:vartype certificate_key: str
:ivar thumbprint: Gets or sets the MPNS certificate Thumbprint. Required.
:vartype thumbprint: str
"""
_validation = {
"mpns_certificate": {"required": True, "min_length": 1},
"certificate_key": {"required": True, "min_length": 1},
"thumbprint": {"required": True, "min_length": 1},
}
_attribute_map = {
"mpns_certificate": {"key": "properties.mpnsCertificate", "type": "str"},
"certificate_key": {"key": "properties.certificateKey", "type": "str"},
"thumbprint": {"key": "properties.thumbprint", "type": "str"},
}
def __init__(self, *, mpns_certificate: str, certificate_key: str, thumbprint: str, **kwargs: Any) -> None:
"""
:keyword mpns_certificate: Gets or sets the MPNS certificate. Required.
:paramtype mpns_certificate: str
:keyword certificate_key: Gets or sets the certificate key for this credential. Required.
:paramtype certificate_key: str
:keyword thumbprint: Gets or sets the MPNS certificate Thumbprint. Required.
:paramtype thumbprint: str
"""
super().__init__(**kwargs)
self.mpns_certificate = mpns_certificate
self.certificate_key = certificate_key
self.thumbprint = thumbprint
[docs]class NamespaceListResult(_serialization.Model):
"""The response of the List Namespace operation.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar value: Gets or sets result of the List AuthorizationRules operation.
:vartype value: list[~azure.mgmt.notificationhubs.models.NamespaceResource]
:ivar next_link: Gets or sets link to the next set of results.
:vartype next_link: str
"""
_validation = {
"value": {"readonly": True},
"next_link": {"readonly": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[NamespaceResource]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.value = None
self.next_link = None
[docs]class NamespacePatchParameters(_serialization.Model):
"""Patch parameter for NamespaceResource.
:ivar sku: The Sku description for a namespace.
:vartype sku: ~azure.mgmt.notificationhubs.models.Sku
:ivar properties: Represents namespace properties.
:vartype properties: ~azure.mgmt.notificationhubs.models.NamespaceProperties
:ivar tags: Dictionary of :code:`<string>`.
:vartype tags: dict[str, str]
"""
_attribute_map = {
"sku": {"key": "sku", "type": "Sku"},
"properties": {"key": "properties", "type": "NamespaceProperties"},
"tags": {"key": "tags", "type": "{str}"},
}
def __init__(
self,
*,
sku: Optional["_models.Sku"] = None,
properties: Optional["_models.NamespaceProperties"] = None,
tags: Optional[Dict[str, str]] = None,
**kwargs: Any
) -> None:
"""
:keyword sku: The Sku description for a namespace.
:paramtype sku: ~azure.mgmt.notificationhubs.models.Sku
:keyword properties: Represents namespace properties.
:paramtype properties: ~azure.mgmt.notificationhubs.models.NamespaceProperties
:keyword tags: Dictionary of :code:`<string>`.
:paramtype tags: dict[str, str]
"""
super().__init__(**kwargs)
self.sku = sku
self.properties = properties
self.tags = tags
[docs]class NamespaceProperties(_serialization.Model): # pylint: disable=too-many-instance-attributes
"""Represents namespace properties.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar name: Name of the Notification Hubs namespace. This is immutable property, set
automatically
by the service when the namespace is created.
:vartype name: str
:ivar provisioning_state: Defines values for OperationProvisioningState. Known values are:
"Unknown", "InProgress", "Succeeded", "Failed", "Canceled", "Pending", and "Disabled".
:vartype provisioning_state: str or
~azure.mgmt.notificationhubs.models.OperationProvisioningState
:ivar status: Namespace status. Known values are: "Created", "Creating", "Suspended", and
"Deleting".
:vartype status: str or ~azure.mgmt.notificationhubs.models.NamespaceStatus
:ivar enabled: Gets or sets whether or not the namespace is currently enabled.
:vartype enabled: bool
:ivar critical: Gets or sets whether or not the namespace is set as Critical.
:vartype critical: bool
:ivar subscription_id: Namespace subscription id.
:vartype subscription_id: str
:ivar region: Region. The value is always set to the same value as Namespace.Location, so we
are deprecating
this property.
:vartype region: str
:ivar metric_id: Azure Insights Metrics id.
:vartype metric_id: str
:ivar created_at: Time when the namespace was created.
:vartype created_at: ~datetime.datetime
:ivar updated_at: Time when the namespace was updated.
:vartype updated_at: ~datetime.datetime
:ivar namespace_type: Defines values for NamespaceType. Known values are: "Messaging" and
"NotificationHub".
:vartype namespace_type: str or ~azure.mgmt.notificationhubs.models.NamespaceType
:ivar replication_region: Allowed replication region. Known values are: "Default", "WestUs2",
"NorthEurope", "AustraliaEast", "BrazilSouth", "SouthEastAsia", "SouthAfricaNorth", and "None".
:vartype replication_region: str or ~azure.mgmt.notificationhubs.models.ReplicationRegion
:ivar zone_redundancy: Namespace SKU name. Known values are: "Disabled" and "Enabled".
:vartype zone_redundancy: str or ~azure.mgmt.notificationhubs.models.ZoneRedundancyPreference
:ivar network_acls: A collection of network authorization rules.
:vartype network_acls: ~azure.mgmt.notificationhubs.models.NetworkAcls
:ivar pns_credentials: Collection of Notification Hub or Notification Hub Namespace PNS
credentials.
:vartype pns_credentials: ~azure.mgmt.notificationhubs.models.PnsCredentials
:ivar service_bus_endpoint: Gets or sets endpoint you can use to perform NotificationHub
operations.
:vartype service_bus_endpoint: str
:ivar private_endpoint_connections: Private Endpoint Connections for namespace.
:vartype private_endpoint_connections:
list[~azure.mgmt.notificationhubs.models.PrivateEndpointConnectionResource]
:ivar scale_unit: Gets or sets scaleUnit where the namespace gets created.
:vartype scale_unit: str
:ivar data_center: Deprecated.
:vartype data_center: str
:ivar public_network_access: Type of public network access. Known values are: "Enabled" and
"Disabled".
:vartype public_network_access: str or ~azure.mgmt.notificationhubs.models.PublicNetworkAccess
"""
_validation = {
"name": {"readonly": True},
"enabled": {"readonly": True},
"critical": {"readonly": True},
"subscription_id": {"readonly": True},
"region": {"readonly": True},
"metric_id": {"readonly": True},
"created_at": {"readonly": True},
"updated_at": {"readonly": True},
"service_bus_endpoint": {"readonly": True},
"private_endpoint_connections": {"readonly": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"provisioning_state": {"key": "provisioningState", "type": "str"},
"status": {"key": "status", "type": "str"},
"enabled": {"key": "enabled", "type": "bool"},
"critical": {"key": "critical", "type": "bool"},
"subscription_id": {"key": "subscriptionId", "type": "str"},
"region": {"key": "region", "type": "str"},
"metric_id": {"key": "metricId", "type": "str"},
"created_at": {"key": "createdAt", "type": "iso-8601"},
"updated_at": {"key": "updatedAt", "type": "iso-8601"},
"namespace_type": {"key": "namespaceType", "type": "str"},
"replication_region": {"key": "replicationRegion", "type": "str"},
"zone_redundancy": {"key": "zoneRedundancy", "type": "str"},
"network_acls": {"key": "networkAcls", "type": "NetworkAcls"},
"pns_credentials": {"key": "pnsCredentials", "type": "PnsCredentials"},
"service_bus_endpoint": {"key": "serviceBusEndpoint", "type": "str"},
"private_endpoint_connections": {
"key": "privateEndpointConnections",
"type": "[PrivateEndpointConnectionResource]",
},
"scale_unit": {"key": "scaleUnit", "type": "str"},
"data_center": {"key": "dataCenter", "type": "str"},
"public_network_access": {"key": "publicNetworkAccess", "type": "str"},
}
def __init__(
self,
*,
provisioning_state: Optional[Union[str, "_models.OperationProvisioningState"]] = None,
status: Optional[Union[str, "_models.NamespaceStatus"]] = None,
namespace_type: Optional[Union[str, "_models.NamespaceType"]] = None,
replication_region: Optional[Union[str, "_models.ReplicationRegion"]] = None,
zone_redundancy: Union[str, "_models.ZoneRedundancyPreference"] = "Disabled",
network_acls: Optional["_models.NetworkAcls"] = None,
pns_credentials: Optional["_models.PnsCredentials"] = None,
scale_unit: Optional[str] = None,
data_center: Optional[str] = None,
public_network_access: Union[str, "_models.PublicNetworkAccess"] = "Enabled",
**kwargs: Any
) -> None:
"""
:keyword provisioning_state: Defines values for OperationProvisioningState. Known values are:
"Unknown", "InProgress", "Succeeded", "Failed", "Canceled", "Pending", and "Disabled".
:paramtype provisioning_state: str or
~azure.mgmt.notificationhubs.models.OperationProvisioningState
:keyword status: Namespace status. Known values are: "Created", "Creating", "Suspended", and
"Deleting".
:paramtype status: str or ~azure.mgmt.notificationhubs.models.NamespaceStatus
:keyword namespace_type: Defines values for NamespaceType. Known values are: "Messaging" and
"NotificationHub".
:paramtype namespace_type: str or ~azure.mgmt.notificationhubs.models.NamespaceType
:keyword replication_region: Allowed replication region. Known values are: "Default",
"WestUs2", "NorthEurope", "AustraliaEast", "BrazilSouth", "SouthEastAsia", "SouthAfricaNorth",
and "None".
:paramtype replication_region: str or ~azure.mgmt.notificationhubs.models.ReplicationRegion
:keyword zone_redundancy: Namespace SKU name. Known values are: "Disabled" and "Enabled".
:paramtype zone_redundancy: str or ~azure.mgmt.notificationhubs.models.ZoneRedundancyPreference
:keyword network_acls: A collection of network authorization rules.
:paramtype network_acls: ~azure.mgmt.notificationhubs.models.NetworkAcls
:keyword pns_credentials: Collection of Notification Hub or Notification Hub Namespace PNS
credentials.
:paramtype pns_credentials: ~azure.mgmt.notificationhubs.models.PnsCredentials
:keyword scale_unit: Gets or sets scaleUnit where the namespace gets created.
:paramtype scale_unit: str
:keyword data_center: Deprecated.
:paramtype data_center: str
:keyword public_network_access: Type of public network access. Known values are: "Enabled" and
"Disabled".
:paramtype public_network_access: str or
~azure.mgmt.notificationhubs.models.PublicNetworkAccess
"""
super().__init__(**kwargs)
self.name = None
self.provisioning_state = provisioning_state
self.status = status
self.enabled = None
self.critical = None
self.subscription_id = None
self.region = None
self.metric_id = None
self.created_at = None
self.updated_at = None
self.namespace_type = namespace_type
self.replication_region = replication_region
self.zone_redundancy = zone_redundancy
self.network_acls = network_acls
self.pns_credentials = pns_credentials
self.service_bus_endpoint = None
self.private_endpoint_connections = None
self.scale_unit = scale_unit
self.data_center = data_center
self.public_network_access = public_network_access
[docs]class TrackedResource(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.
:ivar id: Fully qualified resource ID for the resource. E.g.
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy
information.
:vartype system_data: ~azure.mgmt.notificationhubs.models.SystemData
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar location: The geo-location where the resource lives. Required.
:vartype location: str
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"system_data": {"readonly": True},
"location": {"required": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
"tags": {"key": "tags", "type": "{str}"},
"location": {"key": "location", "type": "str"},
}
def __init__(self, *, location: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) -> None:
"""
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword location: The geo-location where the resource lives. Required.
:paramtype location: str
"""
super().__init__(**kwargs)
self.tags = tags
self.location = location
[docs]class NamespaceResource(TrackedResource): # pylint: disable=too-many-instance-attributes
"""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.
:ivar id: Fully qualified resource ID for the resource. E.g.
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy
information.
:vartype system_data: ~azure.mgmt.notificationhubs.models.SystemData
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar location: The geo-location where the resource lives. Required.
:vartype location: str
:ivar sku: The Sku description for a namespace. Required.
:vartype sku: ~azure.mgmt.notificationhubs.models.Sku
:ivar name_properties_name: Name of the Notification Hubs namespace. This is immutable
property, set automatically
by the service when the namespace is created.
:vartype name_properties_name: str
:ivar provisioning_state: Defines values for OperationProvisioningState. Known values are:
"Unknown", "InProgress", "Succeeded", "Failed", "Canceled", "Pending", and "Disabled".
:vartype provisioning_state: str or
~azure.mgmt.notificationhubs.models.OperationProvisioningState
:ivar status: Namespace status. Known values are: "Created", "Creating", "Suspended", and
"Deleting".
:vartype status: str or ~azure.mgmt.notificationhubs.models.NamespaceStatus
:ivar enabled: Gets or sets whether or not the namespace is currently enabled.
:vartype enabled: bool
:ivar critical: Gets or sets whether or not the namespace is set as Critical.
:vartype critical: bool
:ivar subscription_id: Namespace subscription id.
:vartype subscription_id: str
:ivar region: Region. The value is always set to the same value as Namespace.Location, so we
are deprecating
this property.
:vartype region: str
:ivar metric_id: Azure Insights Metrics id.
:vartype metric_id: str
:ivar created_at: Time when the namespace was created.
:vartype created_at: ~datetime.datetime
:ivar updated_at: Time when the namespace was updated.
:vartype updated_at: ~datetime.datetime
:ivar namespace_type: Defines values for NamespaceType. Known values are: "Messaging" and
"NotificationHub".
:vartype namespace_type: str or ~azure.mgmt.notificationhubs.models.NamespaceType
:ivar replication_region: Allowed replication region. Known values are: "Default", "WestUs2",
"NorthEurope", "AustraliaEast", "BrazilSouth", "SouthEastAsia", "SouthAfricaNorth", and "None".
:vartype replication_region: str or ~azure.mgmt.notificationhubs.models.ReplicationRegion
:ivar zone_redundancy: Namespace SKU name. Known values are: "Disabled" and "Enabled".
:vartype zone_redundancy: str or ~azure.mgmt.notificationhubs.models.ZoneRedundancyPreference
:ivar network_acls: A collection of network authorization rules.
:vartype network_acls: ~azure.mgmt.notificationhubs.models.NetworkAcls
:ivar pns_credentials: Collection of Notification Hub or Notification Hub Namespace PNS
credentials.
:vartype pns_credentials: ~azure.mgmt.notificationhubs.models.PnsCredentials
:ivar service_bus_endpoint: Gets or sets endpoint you can use to perform NotificationHub
operations.
:vartype service_bus_endpoint: str
:ivar private_endpoint_connections: Private Endpoint Connections for namespace.
:vartype private_endpoint_connections:
list[~azure.mgmt.notificationhubs.models.PrivateEndpointConnectionResource]
:ivar scale_unit: Gets or sets scaleUnit where the namespace gets created.
:vartype scale_unit: str
:ivar data_center: Deprecated.
:vartype data_center: str
:ivar public_network_access: Type of public network access. Known values are: "Enabled" and
"Disabled".
:vartype public_network_access: str or ~azure.mgmt.notificationhubs.models.PublicNetworkAccess
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"system_data": {"readonly": True},
"location": {"required": True},
"sku": {"required": True},
"name_properties_name": {"readonly": True},
"enabled": {"readonly": True},
"critical": {"readonly": True},
"subscription_id": {"readonly": True},
"region": {"readonly": True},
"metric_id": {"readonly": True},
"created_at": {"readonly": True},
"updated_at": {"readonly": True},
"service_bus_endpoint": {"readonly": True},
"private_endpoint_connections": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
"tags": {"key": "tags", "type": "{str}"},
"location": {"key": "location", "type": "str"},
"sku": {"key": "sku", "type": "Sku"},
"name_properties_name": {"key": "properties.name", "type": "str"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"status": {"key": "properties.status", "type": "str"},
"enabled": {"key": "properties.enabled", "type": "bool"},
"critical": {"key": "properties.critical", "type": "bool"},
"subscription_id": {"key": "properties.subscriptionId", "type": "str"},
"region": {"key": "properties.region", "type": "str"},
"metric_id": {"key": "properties.metricId", "type": "str"},
"created_at": {"key": "properties.createdAt", "type": "iso-8601"},
"updated_at": {"key": "properties.updatedAt", "type": "iso-8601"},
"namespace_type": {"key": "properties.namespaceType", "type": "str"},
"replication_region": {"key": "properties.replicationRegion", "type": "str"},
"zone_redundancy": {"key": "properties.zoneRedundancy", "type": "str"},
"network_acls": {"key": "properties.networkAcls", "type": "NetworkAcls"},
"pns_credentials": {"key": "properties.pnsCredentials", "type": "PnsCredentials"},
"service_bus_endpoint": {"key": "properties.serviceBusEndpoint", "type": "str"},
"private_endpoint_connections": {
"key": "properties.privateEndpointConnections",
"type": "[PrivateEndpointConnectionResource]",
},
"scale_unit": {"key": "properties.scaleUnit", "type": "str"},
"data_center": {"key": "properties.dataCenter", "type": "str"},
"public_network_access": {"key": "properties.publicNetworkAccess", "type": "str"},
}
def __init__( # pylint: disable=too-many-locals
self,
*,
location: str,
sku: "_models.Sku",
tags: Optional[Dict[str, str]] = None,
provisioning_state: Optional[Union[str, "_models.OperationProvisioningState"]] = None,
status: Optional[Union[str, "_models.NamespaceStatus"]] = None,
namespace_type: Optional[Union[str, "_models.NamespaceType"]] = None,
replication_region: Optional[Union[str, "_models.ReplicationRegion"]] = None,
zone_redundancy: Union[str, "_models.ZoneRedundancyPreference"] = "Disabled",
network_acls: Optional["_models.NetworkAcls"] = None,
pns_credentials: Optional["_models.PnsCredentials"] = None,
scale_unit: Optional[str] = None,
data_center: Optional[str] = None,
public_network_access: Union[str, "_models.PublicNetworkAccess"] = "Enabled",
**kwargs: Any
) -> None:
"""
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword location: The geo-location where the resource lives. Required.
:paramtype location: str
:keyword sku: The Sku description for a namespace. Required.
:paramtype sku: ~azure.mgmt.notificationhubs.models.Sku
:keyword provisioning_state: Defines values for OperationProvisioningState. Known values are:
"Unknown", "InProgress", "Succeeded", "Failed", "Canceled", "Pending", and "Disabled".
:paramtype provisioning_state: str or
~azure.mgmt.notificationhubs.models.OperationProvisioningState
:keyword status: Namespace status. Known values are: "Created", "Creating", "Suspended", and
"Deleting".
:paramtype status: str or ~azure.mgmt.notificationhubs.models.NamespaceStatus
:keyword namespace_type: Defines values for NamespaceType. Known values are: "Messaging" and
"NotificationHub".
:paramtype namespace_type: str or ~azure.mgmt.notificationhubs.models.NamespaceType
:keyword replication_region: Allowed replication region. Known values are: "Default",
"WestUs2", "NorthEurope", "AustraliaEast", "BrazilSouth", "SouthEastAsia", "SouthAfricaNorth",
and "None".
:paramtype replication_region: str or ~azure.mgmt.notificationhubs.models.ReplicationRegion
:keyword zone_redundancy: Namespace SKU name. Known values are: "Disabled" and "Enabled".
:paramtype zone_redundancy: str or ~azure.mgmt.notificationhubs.models.ZoneRedundancyPreference
:keyword network_acls: A collection of network authorization rules.
:paramtype network_acls: ~azure.mgmt.notificationhubs.models.NetworkAcls
:keyword pns_credentials: Collection of Notification Hub or Notification Hub Namespace PNS
credentials.
:paramtype pns_credentials: ~azure.mgmt.notificationhubs.models.PnsCredentials
:keyword scale_unit: Gets or sets scaleUnit where the namespace gets created.
:paramtype scale_unit: str
:keyword data_center: Deprecated.
:paramtype data_center: str
:keyword public_network_access: Type of public network access. Known values are: "Enabled" and
"Disabled".
:paramtype public_network_access: str or
~azure.mgmt.notificationhubs.models.PublicNetworkAccess
"""
super().__init__(tags=tags, location=location, **kwargs)
self.sku = sku
self.name_properties_name = None
self.provisioning_state = provisioning_state
self.status = status
self.enabled = None
self.critical = None
self.subscription_id = None
self.region = None
self.metric_id = None
self.created_at = None
self.updated_at = None
self.namespace_type = namespace_type
self.replication_region = replication_region
self.zone_redundancy = zone_redundancy
self.network_acls = network_acls
self.pns_credentials = pns_credentials
self.service_bus_endpoint = None
self.private_endpoint_connections = None
self.scale_unit = scale_unit
self.data_center = data_center
self.public_network_access = public_network_access
[docs]class NetworkAcls(_serialization.Model):
"""A collection of network authorization rules.
:ivar ip_rules: List of IP rules.
:vartype ip_rules: list[~azure.mgmt.notificationhubs.models.IpRule]
:ivar public_network_rule: A default (public Internet) network authorization rule, which
contains rights if no other network rule matches.
:vartype public_network_rule:
~azure.mgmt.notificationhubs.models.PublicInternetAuthorizationRule
"""
_attribute_map = {
"ip_rules": {"key": "ipRules", "type": "[IpRule]"},
"public_network_rule": {"key": "publicNetworkRule", "type": "PublicInternetAuthorizationRule"},
}
def __init__(
self,
*,
ip_rules: Optional[List["_models.IpRule"]] = None,
public_network_rule: Optional["_models.PublicInternetAuthorizationRule"] = None,
**kwargs: Any
) -> None:
"""
:keyword ip_rules: List of IP rules.
:paramtype ip_rules: list[~azure.mgmt.notificationhubs.models.IpRule]
:keyword public_network_rule: A default (public Internet) network authorization rule, which
contains rights if no other network rule matches.
:paramtype public_network_rule:
~azure.mgmt.notificationhubs.models.PublicInternetAuthorizationRule
"""
super().__init__(**kwargs)
self.ip_rules = ip_rules
self.public_network_rule = public_network_rule
[docs]class NotificationHubListResult(_serialization.Model):
"""The response of the List NotificationHub operation.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar value: Gets or sets result of the List AuthorizationRules operation.
:vartype value: list[~azure.mgmt.notificationhubs.models.NotificationHubResource]
:ivar next_link: Gets or sets link to the next set of results.
:vartype next_link: str
"""
_validation = {
"value": {"readonly": True},
"next_link": {"readonly": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[NotificationHubResource]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.value = None
self.next_link = None
[docs]class NotificationHubPatchParameters(_serialization.Model): # pylint: disable=too-many-instance-attributes
"""Patch parameter for NamespaceResource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar sku: The Sku description for a namespace.
:vartype sku: ~azure.mgmt.notificationhubs.models.Sku
:ivar tags: Dictionary of :code:`<string>`.
:vartype tags: dict[str, str]
:ivar name: Gets or sets the NotificationHub name.
:vartype name: str
:ivar registration_ttl: Gets or sets the RegistrationTtl of the created NotificationHub.
:vartype registration_ttl: str
:ivar authorization_rules: Gets or sets the AuthorizationRules of the created NotificationHub.
:vartype authorization_rules:
list[~azure.mgmt.notificationhubs.models.SharedAccessAuthorizationRuleProperties]
:ivar apns_credential: Description of a NotificationHub ApnsCredential.
:vartype apns_credential: ~azure.mgmt.notificationhubs.models.ApnsCredential
:ivar wns_credential: Description of a NotificationHub WnsCredential.
:vartype wns_credential: ~azure.mgmt.notificationhubs.models.WnsCredential
:ivar gcm_credential: Description of a NotificationHub GcmCredential.
:vartype gcm_credential: ~azure.mgmt.notificationhubs.models.GcmCredential
:ivar mpns_credential: Description of a NotificationHub MpnsCredential.
:vartype mpns_credential: ~azure.mgmt.notificationhubs.models.MpnsCredential
:ivar adm_credential: Description of a NotificationHub AdmCredential.
:vartype adm_credential: ~azure.mgmt.notificationhubs.models.AdmCredential
:ivar baidu_credential: Description of a NotificationHub BaiduCredential.
:vartype baidu_credential: ~azure.mgmt.notificationhubs.models.BaiduCredential
:ivar browser_credential: Description of a NotificationHub BrowserCredential.
:vartype browser_credential: ~azure.mgmt.notificationhubs.models.BrowserCredential
:ivar xiaomi_credential: Description of a NotificationHub XiaomiCredential.
:vartype xiaomi_credential: ~azure.mgmt.notificationhubs.models.XiaomiCredential
:ivar fcm_v1_credential: Description of a NotificationHub FcmV1Credential.
:vartype fcm_v1_credential: ~azure.mgmt.notificationhubs.models.FcmV1Credential
:ivar daily_max_active_devices:
:vartype daily_max_active_devices: int
"""
_validation = {
"authorization_rules": {"readonly": True},
"daily_max_active_devices": {"readonly": True},
}
_attribute_map = {
"sku": {"key": "sku", "type": "Sku"},
"tags": {"key": "tags", "type": "{str}"},
"name": {"key": "properties.name", "type": "str"},
"registration_ttl": {"key": "properties.registrationTtl", "type": "str"},
"authorization_rules": {
"key": "properties.authorizationRules",
"type": "[SharedAccessAuthorizationRuleProperties]",
},
"apns_credential": {"key": "properties.apnsCredential", "type": "ApnsCredential"},
"wns_credential": {"key": "properties.wnsCredential", "type": "WnsCredential"},
"gcm_credential": {"key": "properties.gcmCredential", "type": "GcmCredential"},
"mpns_credential": {"key": "properties.mpnsCredential", "type": "MpnsCredential"},
"adm_credential": {"key": "properties.admCredential", "type": "AdmCredential"},
"baidu_credential": {"key": "properties.baiduCredential", "type": "BaiduCredential"},
"browser_credential": {"key": "properties.browserCredential", "type": "BrowserCredential"},
"xiaomi_credential": {"key": "properties.xiaomiCredential", "type": "XiaomiCredential"},
"fcm_v1_credential": {"key": "properties.fcmV1Credential", "type": "FcmV1Credential"},
"daily_max_active_devices": {"key": "properties.dailyMaxActiveDevices", "type": "int"},
}
def __init__(
self,
*,
sku: Optional["_models.Sku"] = None,
tags: Optional[Dict[str, str]] = None,
name: Optional[str] = None,
registration_ttl: Optional[str] = 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,
browser_credential: Optional["_models.BrowserCredential"] = None,
xiaomi_credential: Optional["_models.XiaomiCredential"] = None,
fcm_v1_credential: Optional["_models.FcmV1Credential"] = None,
**kwargs: Any
) -> None:
"""
:keyword sku: The Sku description for a namespace.
:paramtype sku: ~azure.mgmt.notificationhubs.models.Sku
:keyword tags: Dictionary of :code:`<string>`.
:paramtype tags: dict[str, str]
:keyword name: Gets or sets the NotificationHub name.
:paramtype name: str
:keyword registration_ttl: Gets or sets the RegistrationTtl of the created NotificationHub.
:paramtype registration_ttl: str
:keyword apns_credential: Description of a NotificationHub ApnsCredential.
:paramtype apns_credential: ~azure.mgmt.notificationhubs.models.ApnsCredential
:keyword wns_credential: Description of a NotificationHub WnsCredential.
:paramtype wns_credential: ~azure.mgmt.notificationhubs.models.WnsCredential
:keyword gcm_credential: Description of a NotificationHub GcmCredential.
:paramtype gcm_credential: ~azure.mgmt.notificationhubs.models.GcmCredential
:keyword mpns_credential: Description of a NotificationHub MpnsCredential.
:paramtype mpns_credential: ~azure.mgmt.notificationhubs.models.MpnsCredential
:keyword adm_credential: Description of a NotificationHub AdmCredential.
:paramtype adm_credential: ~azure.mgmt.notificationhubs.models.AdmCredential
:keyword baidu_credential: Description of a NotificationHub BaiduCredential.
:paramtype baidu_credential: ~azure.mgmt.notificationhubs.models.BaiduCredential
:keyword browser_credential: Description of a NotificationHub BrowserCredential.
:paramtype browser_credential: ~azure.mgmt.notificationhubs.models.BrowserCredential
:keyword xiaomi_credential: Description of a NotificationHub XiaomiCredential.
:paramtype xiaomi_credential: ~azure.mgmt.notificationhubs.models.XiaomiCredential
:keyword fcm_v1_credential: Description of a NotificationHub FcmV1Credential.
:paramtype fcm_v1_credential: ~azure.mgmt.notificationhubs.models.FcmV1Credential
"""
super().__init__(**kwargs)
self.sku = sku
self.tags = tags
self.name = name
self.registration_ttl = registration_ttl
self.authorization_rules = None
self.apns_credential = apns_credential
self.wns_credential = wns_credential
self.gcm_credential = gcm_credential
self.mpns_credential = mpns_credential
self.adm_credential = adm_credential
self.baidu_credential = baidu_credential
self.browser_credential = browser_credential
self.xiaomi_credential = xiaomi_credential
self.fcm_v1_credential = fcm_v1_credential
self.daily_max_active_devices = None
[docs]class NotificationHubResource(TrackedResource): # pylint: disable=too-many-instance-attributes
"""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.
:ivar id: Fully qualified resource ID for the resource. E.g.
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy
information.
:vartype system_data: ~azure.mgmt.notificationhubs.models.SystemData
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar location: The geo-location where the resource lives. Required.
:vartype location: str
:ivar sku: The Sku description for a namespace.
:vartype sku: ~azure.mgmt.notificationhubs.models.Sku
:ivar name_properties_name: Gets or sets the NotificationHub name.
:vartype name_properties_name: str
:ivar registration_ttl: Gets or sets the RegistrationTtl of the created NotificationHub.
:vartype registration_ttl: str
:ivar authorization_rules: Gets or sets the AuthorizationRules of the created NotificationHub.
:vartype authorization_rules:
list[~azure.mgmt.notificationhubs.models.SharedAccessAuthorizationRuleProperties]
:ivar apns_credential: Description of a NotificationHub ApnsCredential.
:vartype apns_credential: ~azure.mgmt.notificationhubs.models.ApnsCredential
:ivar wns_credential: Description of a NotificationHub WnsCredential.
:vartype wns_credential: ~azure.mgmt.notificationhubs.models.WnsCredential
:ivar gcm_credential: Description of a NotificationHub GcmCredential.
:vartype gcm_credential: ~azure.mgmt.notificationhubs.models.GcmCredential
:ivar mpns_credential: Description of a NotificationHub MpnsCredential.
:vartype mpns_credential: ~azure.mgmt.notificationhubs.models.MpnsCredential
:ivar adm_credential: Description of a NotificationHub AdmCredential.
:vartype adm_credential: ~azure.mgmt.notificationhubs.models.AdmCredential
:ivar baidu_credential: Description of a NotificationHub BaiduCredential.
:vartype baidu_credential: ~azure.mgmt.notificationhubs.models.BaiduCredential
:ivar browser_credential: Description of a NotificationHub BrowserCredential.
:vartype browser_credential: ~azure.mgmt.notificationhubs.models.BrowserCredential
:ivar xiaomi_credential: Description of a NotificationHub XiaomiCredential.
:vartype xiaomi_credential: ~azure.mgmt.notificationhubs.models.XiaomiCredential
:ivar fcm_v1_credential: Description of a NotificationHub FcmV1Credential.
:vartype fcm_v1_credential: ~azure.mgmt.notificationhubs.models.FcmV1Credential
:ivar daily_max_active_devices:
:vartype daily_max_active_devices: int
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"system_data": {"readonly": True},
"location": {"required": True},
"authorization_rules": {"readonly": True},
"daily_max_active_devices": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
"tags": {"key": "tags", "type": "{str}"},
"location": {"key": "location", "type": "str"},
"sku": {"key": "sku", "type": "Sku"},
"name_properties_name": {"key": "properties.name", "type": "str"},
"registration_ttl": {"key": "properties.registrationTtl", "type": "str"},
"authorization_rules": {
"key": "properties.authorizationRules",
"type": "[SharedAccessAuthorizationRuleProperties]",
},
"apns_credential": {"key": "properties.apnsCredential", "type": "ApnsCredential"},
"wns_credential": {"key": "properties.wnsCredential", "type": "WnsCredential"},
"gcm_credential": {"key": "properties.gcmCredential", "type": "GcmCredential"},
"mpns_credential": {"key": "properties.mpnsCredential", "type": "MpnsCredential"},
"adm_credential": {"key": "properties.admCredential", "type": "AdmCredential"},
"baidu_credential": {"key": "properties.baiduCredential", "type": "BaiduCredential"},
"browser_credential": {"key": "properties.browserCredential", "type": "BrowserCredential"},
"xiaomi_credential": {"key": "properties.xiaomiCredential", "type": "XiaomiCredential"},
"fcm_v1_credential": {"key": "properties.fcmV1Credential", "type": "FcmV1Credential"},
"daily_max_active_devices": {"key": "properties.dailyMaxActiveDevices", "type": "int"},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
sku: Optional["_models.Sku"] = None,
name_properties_name: Optional[str] = None,
registration_ttl: Optional[str] = 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,
browser_credential: Optional["_models.BrowserCredential"] = None,
xiaomi_credential: Optional["_models.XiaomiCredential"] = None,
fcm_v1_credential: Optional["_models.FcmV1Credential"] = None,
**kwargs: Any
) -> None:
"""
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword location: The geo-location where the resource lives. Required.
:paramtype location: str
:keyword sku: The Sku description for a namespace.
:paramtype sku: ~azure.mgmt.notificationhubs.models.Sku
:keyword name_properties_name: Gets or sets the NotificationHub name.
:paramtype name_properties_name: str
:keyword registration_ttl: Gets or sets the RegistrationTtl of the created NotificationHub.
:paramtype registration_ttl: str
:keyword apns_credential: Description of a NotificationHub ApnsCredential.
:paramtype apns_credential: ~azure.mgmt.notificationhubs.models.ApnsCredential
:keyword wns_credential: Description of a NotificationHub WnsCredential.
:paramtype wns_credential: ~azure.mgmt.notificationhubs.models.WnsCredential
:keyword gcm_credential: Description of a NotificationHub GcmCredential.
:paramtype gcm_credential: ~azure.mgmt.notificationhubs.models.GcmCredential
:keyword mpns_credential: Description of a NotificationHub MpnsCredential.
:paramtype mpns_credential: ~azure.mgmt.notificationhubs.models.MpnsCredential
:keyword adm_credential: Description of a NotificationHub AdmCredential.
:paramtype adm_credential: ~azure.mgmt.notificationhubs.models.AdmCredential
:keyword baidu_credential: Description of a NotificationHub BaiduCredential.
:paramtype baidu_credential: ~azure.mgmt.notificationhubs.models.BaiduCredential
:keyword browser_credential: Description of a NotificationHub BrowserCredential.
:paramtype browser_credential: ~azure.mgmt.notificationhubs.models.BrowserCredential
:keyword xiaomi_credential: Description of a NotificationHub XiaomiCredential.
:paramtype xiaomi_credential: ~azure.mgmt.notificationhubs.models.XiaomiCredential
:keyword fcm_v1_credential: Description of a NotificationHub FcmV1Credential.
:paramtype fcm_v1_credential: ~azure.mgmt.notificationhubs.models.FcmV1Credential
"""
super().__init__(tags=tags, location=location, **kwargs)
self.sku = sku
self.name_properties_name = name_properties_name
self.registration_ttl = registration_ttl
self.authorization_rules = None
self.apns_credential = apns_credential
self.wns_credential = wns_credential
self.gcm_credential = gcm_credential
self.mpns_credential = mpns_credential
self.adm_credential = adm_credential
self.baidu_credential = baidu_credential
self.browser_credential = browser_credential
self.xiaomi_credential = xiaomi_credential
self.fcm_v1_credential = fcm_v1_credential
self.daily_max_active_devices = None
[docs]class Operation(_serialization.Model):
"""A NotificationHubs REST API operation.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar name: Gets operation name: {provider}/{resource}/{operation}.
:vartype name: str
:ivar display: The object that represents the operation.
:vartype display: ~azure.mgmt.notificationhubs.models.OperationDisplay
:ivar properties: Optional operation properties.
:vartype properties: ~azure.mgmt.notificationhubs.models.OperationProperties
:ivar is_data_action: Gets or sets IsDataAction property. It is used to differentiate
management and data plane operations.
:vartype is_data_action: bool
"""
_validation = {
"name": {"readonly": True},
"is_data_action": {"readonly": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"display": {"key": "display", "type": "OperationDisplay"},
"properties": {"key": "properties", "type": "OperationProperties"},
"is_data_action": {"key": "isDataAction", "type": "bool"},
}
def __init__(
self,
*,
display: Optional["_models.OperationDisplay"] = None,
properties: Optional["_models.OperationProperties"] = None,
**kwargs: Any
) -> None:
"""
:keyword display: The object that represents the operation.
:paramtype display: ~azure.mgmt.notificationhubs.models.OperationDisplay
:keyword properties: Optional operation properties.
:paramtype properties: ~azure.mgmt.notificationhubs.models.OperationProperties
"""
super().__init__(**kwargs)
self.name = None
self.display = display
self.properties = properties
self.is_data_action = None
[docs]class OperationDisplay(_serialization.Model):
"""The object that represents the operation.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar provider: Gets service provider: Microsoft.NotificationHubs.
:vartype provider: str
:ivar resource: Gets resource on which the operation is performed: Invoice, etc.
:vartype resource: str
:ivar operation: Gets operation type: Read, write, delete, etc.
:vartype operation: str
:ivar description: Human-friendly operation description.
:vartype description: str
"""
_validation = {
"provider": {"readonly": True},
"resource": {"readonly": True},
"operation": {"readonly": True},
"description": {"readonly": True},
}
_attribute_map = {
"provider": {"key": "provider", "type": "str"},
"resource": {"key": "resource", "type": "str"},
"operation": {"key": "operation", "type": "str"},
"description": {"key": "description", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.provider = None
self.resource = None
self.operation = None
self.description = None
[docs]class OperationListResult(_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.
:ivar value: Gets list of NotificationHubs operations supported by the
Microsoft.NotificationHubs resource provider.
:vartype value: list[~azure.mgmt.notificationhubs.models.Operation]
:ivar next_link: Gets URL to get the next set of operation list results if there are
any.
:vartype next_link: str
"""
_validation = {
"value": {"readonly": True},
"next_link": {"readonly": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[Operation]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.value = None
self.next_link = None
[docs]class OperationProperties(_serialization.Model):
"""Optional operation properties.
:ivar service_specification: Optional service specification used in Operations API.
:vartype service_specification: ~azure.mgmt.notificationhubs.models.ServiceSpecification
"""
_attribute_map = {
"service_specification": {"key": "serviceSpecification", "type": "ServiceSpecification"},
}
def __init__(
self, *, service_specification: Optional["_models.ServiceSpecification"] = None, **kwargs: Any
) -> None:
"""
:keyword service_specification: Optional service specification used in Operations API.
:paramtype service_specification: ~azure.mgmt.notificationhubs.models.ServiceSpecification
"""
super().__init__(**kwargs)
self.service_specification = service_specification
[docs]class PnsCredentials(_serialization.Model):
"""Collection of Notification Hub or Notification Hub Namespace PNS credentials.
:ivar adm_credential: Description of a NotificationHub AdmCredential.
:vartype adm_credential: ~azure.mgmt.notificationhubs.models.AdmCredential
:ivar apns_credential: Description of a NotificationHub ApnsCredential.
:vartype apns_credential: ~azure.mgmt.notificationhubs.models.ApnsCredential
:ivar baidu_credential: Description of a NotificationHub BaiduCredential.
:vartype baidu_credential: ~azure.mgmt.notificationhubs.models.BaiduCredential
:ivar browser_credential: Description of a NotificationHub BrowserCredential.
:vartype browser_credential: ~azure.mgmt.notificationhubs.models.BrowserCredential
:ivar gcm_credential: Description of a NotificationHub GcmCredential.
:vartype gcm_credential: ~azure.mgmt.notificationhubs.models.GcmCredential
:ivar mpns_credential: Description of a NotificationHub MpnsCredential.
:vartype mpns_credential: ~azure.mgmt.notificationhubs.models.MpnsCredential
:ivar wns_credential: Description of a NotificationHub WnsCredential.
:vartype wns_credential: ~azure.mgmt.notificationhubs.models.WnsCredential
:ivar xiaomi_credential: Description of a NotificationHub XiaomiCredential.
:vartype xiaomi_credential: ~azure.mgmt.notificationhubs.models.XiaomiCredential
:ivar fcm_v1_credential: Description of a NotificationHub FcmV1Credential.
:vartype fcm_v1_credential: ~azure.mgmt.notificationhubs.models.FcmV1Credential
"""
_attribute_map = {
"adm_credential": {"key": "admCredential", "type": "AdmCredential"},
"apns_credential": {"key": "apnsCredential", "type": "ApnsCredential"},
"baidu_credential": {"key": "baiduCredential", "type": "BaiduCredential"},
"browser_credential": {"key": "browserCredential", "type": "BrowserCredential"},
"gcm_credential": {"key": "gcmCredential", "type": "GcmCredential"},
"mpns_credential": {"key": "mpnsCredential", "type": "MpnsCredential"},
"wns_credential": {"key": "wnsCredential", "type": "WnsCredential"},
"xiaomi_credential": {"key": "xiaomiCredential", "type": "XiaomiCredential"},
"fcm_v1_credential": {"key": "fcmV1Credential", "type": "FcmV1Credential"},
}
def __init__(
self,
*,
adm_credential: Optional["_models.AdmCredential"] = None,
apns_credential: Optional["_models.ApnsCredential"] = None,
baidu_credential: Optional["_models.BaiduCredential"] = None,
browser_credential: Optional["_models.BrowserCredential"] = None,
gcm_credential: Optional["_models.GcmCredential"] = None,
mpns_credential: Optional["_models.MpnsCredential"] = None,
wns_credential: Optional["_models.WnsCredential"] = None,
xiaomi_credential: Optional["_models.XiaomiCredential"] = None,
fcm_v1_credential: Optional["_models.FcmV1Credential"] = None,
**kwargs: Any
) -> None:
"""
:keyword adm_credential: Description of a NotificationHub AdmCredential.
:paramtype adm_credential: ~azure.mgmt.notificationhubs.models.AdmCredential
:keyword apns_credential: Description of a NotificationHub ApnsCredential.
:paramtype apns_credential: ~azure.mgmt.notificationhubs.models.ApnsCredential
:keyword baidu_credential: Description of a NotificationHub BaiduCredential.
:paramtype baidu_credential: ~azure.mgmt.notificationhubs.models.BaiduCredential
:keyword browser_credential: Description of a NotificationHub BrowserCredential.
:paramtype browser_credential: ~azure.mgmt.notificationhubs.models.BrowserCredential
:keyword gcm_credential: Description of a NotificationHub GcmCredential.
:paramtype gcm_credential: ~azure.mgmt.notificationhubs.models.GcmCredential
:keyword mpns_credential: Description of a NotificationHub MpnsCredential.
:paramtype mpns_credential: ~azure.mgmt.notificationhubs.models.MpnsCredential
:keyword wns_credential: Description of a NotificationHub WnsCredential.
:paramtype wns_credential: ~azure.mgmt.notificationhubs.models.WnsCredential
:keyword xiaomi_credential: Description of a NotificationHub XiaomiCredential.
:paramtype xiaomi_credential: ~azure.mgmt.notificationhubs.models.XiaomiCredential
:keyword fcm_v1_credential: Description of a NotificationHub FcmV1Credential.
:paramtype fcm_v1_credential: ~azure.mgmt.notificationhubs.models.FcmV1Credential
"""
super().__init__(**kwargs)
self.adm_credential = adm_credential
self.apns_credential = apns_credential
self.baidu_credential = baidu_credential
self.browser_credential = browser_credential
self.gcm_credential = gcm_credential
self.mpns_credential = mpns_credential
self.wns_credential = wns_credential
self.xiaomi_credential = xiaomi_credential
self.fcm_v1_credential = fcm_v1_credential
[docs]class PnsCredentialsResource(ProxyResource): # pylint: disable=too-many-instance-attributes
"""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.
:ivar id: Fully qualified resource ID for the resource. E.g.
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy
information.
:vartype system_data: ~azure.mgmt.notificationhubs.models.SystemData
:ivar location: Deprecated - only for compatibility.
:vartype location: str
:ivar tags: Deprecated - only for compatibility.
:vartype tags: dict[str, str]
:ivar adm_credential: Description of a NotificationHub AdmCredential.
:vartype adm_credential: ~azure.mgmt.notificationhubs.models.AdmCredential
:ivar apns_credential: Description of a NotificationHub ApnsCredential.
:vartype apns_credential: ~azure.mgmt.notificationhubs.models.ApnsCredential
:ivar baidu_credential: Description of a NotificationHub BaiduCredential.
:vartype baidu_credential: ~azure.mgmt.notificationhubs.models.BaiduCredential
:ivar browser_credential: Description of a NotificationHub BrowserCredential.
:vartype browser_credential: ~azure.mgmt.notificationhubs.models.BrowserCredential
:ivar gcm_credential: Description of a NotificationHub GcmCredential.
:vartype gcm_credential: ~azure.mgmt.notificationhubs.models.GcmCredential
:ivar mpns_credential: Description of a NotificationHub MpnsCredential.
:vartype mpns_credential: ~azure.mgmt.notificationhubs.models.MpnsCredential
:ivar wns_credential: Description of a NotificationHub WnsCredential.
:vartype wns_credential: ~azure.mgmt.notificationhubs.models.WnsCredential
:ivar xiaomi_credential: Description of a NotificationHub XiaomiCredential.
:vartype xiaomi_credential: ~azure.mgmt.notificationhubs.models.XiaomiCredential
:ivar fcm_v1_credential: Description of a NotificationHub FcmV1Credential.
:vartype fcm_v1_credential: ~azure.mgmt.notificationhubs.models.FcmV1Credential
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"system_data": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"adm_credential": {"key": "properties.admCredential", "type": "AdmCredential"},
"apns_credential": {"key": "properties.apnsCredential", "type": "ApnsCredential"},
"baidu_credential": {"key": "properties.baiduCredential", "type": "BaiduCredential"},
"browser_credential": {"key": "properties.browserCredential", "type": "BrowserCredential"},
"gcm_credential": {"key": "properties.gcmCredential", "type": "GcmCredential"},
"mpns_credential": {"key": "properties.mpnsCredential", "type": "MpnsCredential"},
"wns_credential": {"key": "properties.wnsCredential", "type": "WnsCredential"},
"xiaomi_credential": {"key": "properties.xiaomiCredential", "type": "XiaomiCredential"},
"fcm_v1_credential": {"key": "properties.fcmV1Credential", "type": "FcmV1Credential"},
}
def __init__(
self,
*,
location: Optional[str] = None,
tags: Optional[Dict[str, str]] = None,
adm_credential: Optional["_models.AdmCredential"] = None,
apns_credential: Optional["_models.ApnsCredential"] = None,
baidu_credential: Optional["_models.BaiduCredential"] = None,
browser_credential: Optional["_models.BrowserCredential"] = None,
gcm_credential: Optional["_models.GcmCredential"] = None,
mpns_credential: Optional["_models.MpnsCredential"] = None,
wns_credential: Optional["_models.WnsCredential"] = None,
xiaomi_credential: Optional["_models.XiaomiCredential"] = None,
fcm_v1_credential: Optional["_models.FcmV1Credential"] = None,
**kwargs: Any
) -> None:
"""
:keyword location: Deprecated - only for compatibility.
:paramtype location: str
:keyword tags: Deprecated - only for compatibility.
:paramtype tags: dict[str, str]
:keyword adm_credential: Description of a NotificationHub AdmCredential.
:paramtype adm_credential: ~azure.mgmt.notificationhubs.models.AdmCredential
:keyword apns_credential: Description of a NotificationHub ApnsCredential.
:paramtype apns_credential: ~azure.mgmt.notificationhubs.models.ApnsCredential
:keyword baidu_credential: Description of a NotificationHub BaiduCredential.
:paramtype baidu_credential: ~azure.mgmt.notificationhubs.models.BaiduCredential
:keyword browser_credential: Description of a NotificationHub BrowserCredential.
:paramtype browser_credential: ~azure.mgmt.notificationhubs.models.BrowserCredential
:keyword gcm_credential: Description of a NotificationHub GcmCredential.
:paramtype gcm_credential: ~azure.mgmt.notificationhubs.models.GcmCredential
:keyword mpns_credential: Description of a NotificationHub MpnsCredential.
:paramtype mpns_credential: ~azure.mgmt.notificationhubs.models.MpnsCredential
:keyword wns_credential: Description of a NotificationHub WnsCredential.
:paramtype wns_credential: ~azure.mgmt.notificationhubs.models.WnsCredential
:keyword xiaomi_credential: Description of a NotificationHub XiaomiCredential.
:paramtype xiaomi_credential: ~azure.mgmt.notificationhubs.models.XiaomiCredential
:keyword fcm_v1_credential: Description of a NotificationHub FcmV1Credential.
:paramtype fcm_v1_credential: ~azure.mgmt.notificationhubs.models.FcmV1Credential
"""
super().__init__(**kwargs)
self.location = location
self.tags = tags
self.adm_credential = adm_credential
self.apns_credential = apns_credential
self.baidu_credential = baidu_credential
self.browser_credential = browser_credential
self.gcm_credential = gcm_credential
self.mpns_credential = mpns_credential
self.wns_credential = wns_credential
self.xiaomi_credential = xiaomi_credential
self.fcm_v1_credential = fcm_v1_credential
[docs]class PolicyKeyResource(_serialization.Model):
"""Namespace / NotificationHub Regenerate Keys request.
All required parameters must be populated in order to send to server.
:ivar policy_key: Type of Shared Access Policy Key (primary or secondary). Required. Known
values are: "PrimaryKey" and "SecondaryKey".
:vartype policy_key: str or ~azure.mgmt.notificationhubs.models.PolicyKeyType
"""
_validation = {
"policy_key": {"required": True},
}
_attribute_map = {
"policy_key": {"key": "policyKey", "type": "str"},
}
def __init__(self, *, policy_key: Union[str, "_models.PolicyKeyType"], **kwargs: Any) -> None:
"""
:keyword policy_key: Type of Shared Access Policy Key (primary or secondary). Required. Known
values are: "PrimaryKey" and "SecondaryKey".
:paramtype policy_key: str or ~azure.mgmt.notificationhubs.models.PolicyKeyType
"""
super().__init__(**kwargs)
self.policy_key = policy_key
[docs]class PrivateEndpointConnectionProperties(_serialization.Model):
"""Private Endpoint Connection properties.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar provisioning_state: State of Private Endpoint Connection. Known values are: "Unknown",
"Succeeded", "Creating", "Updating", "UpdatingByProxy", "Deleting", "DeletingByProxy", and
"Deleted".
:vartype provisioning_state: str or
~azure.mgmt.notificationhubs.models.PrivateEndpointConnectionProvisioningState
:ivar private_endpoint: Represents a Private Endpoint that is connected to Notification Hubs
namespace using Private Endpoint Connection.
:vartype private_endpoint: ~azure.mgmt.notificationhubs.models.RemotePrivateEndpointConnection
:ivar group_ids: List of group ids. For Notification Hubs, it always contains a single
"namespace" element.
:vartype group_ids: list[str]
:ivar private_link_service_connection_state: State of the Private Link Service connection.
:vartype private_link_service_connection_state:
~azure.mgmt.notificationhubs.models.RemotePrivateLinkServiceConnectionState
"""
_validation = {
"group_ids": {"readonly": True},
}
_attribute_map = {
"provisioning_state": {"key": "provisioningState", "type": "str"},
"private_endpoint": {"key": "privateEndpoint", "type": "RemotePrivateEndpointConnection"},
"group_ids": {"key": "groupIds", "type": "[str]"},
"private_link_service_connection_state": {
"key": "privateLinkServiceConnectionState",
"type": "RemotePrivateLinkServiceConnectionState",
},
}
def __init__(
self,
*,
provisioning_state: Optional[Union[str, "_models.PrivateEndpointConnectionProvisioningState"]] = None,
private_endpoint: Optional["_models.RemotePrivateEndpointConnection"] = None,
private_link_service_connection_state: Optional["_models.RemotePrivateLinkServiceConnectionState"] = None,
**kwargs: Any
) -> None:
"""
:keyword provisioning_state: State of Private Endpoint Connection. Known values are: "Unknown",
"Succeeded", "Creating", "Updating", "UpdatingByProxy", "Deleting", "DeletingByProxy", and
"Deleted".
:paramtype provisioning_state: str or
~azure.mgmt.notificationhubs.models.PrivateEndpointConnectionProvisioningState
:keyword private_endpoint: Represents a Private Endpoint that is connected to Notification Hubs
namespace using Private Endpoint Connection.
:paramtype private_endpoint:
~azure.mgmt.notificationhubs.models.RemotePrivateEndpointConnection
:keyword private_link_service_connection_state: State of the Private Link Service connection.
:paramtype private_link_service_connection_state:
~azure.mgmt.notificationhubs.models.RemotePrivateLinkServiceConnectionState
"""
super().__init__(**kwargs)
self.provisioning_state = provisioning_state
self.private_endpoint = private_endpoint
self.group_ids = None
self.private_link_service_connection_state = private_link_service_connection_state
[docs]class PrivateEndpointConnectionResource(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.
:ivar id: Fully qualified resource ID for the resource. E.g.
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy
information.
:vartype system_data: ~azure.mgmt.notificationhubs.models.SystemData
:ivar properties: Private Endpoint Connection properties.
:vartype properties: ~azure.mgmt.notificationhubs.models.PrivateEndpointConnectionProperties
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"system_data": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
"properties": {"key": "properties", "type": "PrivateEndpointConnectionProperties"},
}
def __init__(
self, *, properties: Optional["_models.PrivateEndpointConnectionProperties"] = None, **kwargs: Any
) -> None:
"""
:keyword properties: Private Endpoint Connection properties.
:paramtype properties: ~azure.mgmt.notificationhubs.models.PrivateEndpointConnectionProperties
"""
super().__init__(**kwargs)
self.properties = properties
[docs]class PrivateEndpointConnectionResourceListResult(_serialization.Model): # pylint: disable=name-too-long
"""The response of the List Private Endpoint Connections operation.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar value: Gets or sets result of the List AuthorizationRules operation.
:vartype value: list[~azure.mgmt.notificationhubs.models.PrivateEndpointConnectionResource]
:ivar next_link: Gets or sets link to the next set of results.
:vartype next_link: str
"""
_validation = {
"value": {"readonly": True},
"next_link": {"readonly": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[PrivateEndpointConnectionResource]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.value = None
self.next_link = None
[docs]class PrivateLinkResource(ProxyResource):
"""A Private Link Arm Resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Fully qualified resource ID for the resource. E.g.
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy
information.
:vartype system_data: ~azure.mgmt.notificationhubs.models.SystemData
:ivar properties: Represents properties of Private Link Resource.
:vartype properties: ~azure.mgmt.notificationhubs.models.PrivateLinkResourceProperties
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"system_data": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
"properties": {"key": "properties", "type": "PrivateLinkResourceProperties"},
}
def __init__(self, *, properties: Optional["_models.PrivateLinkResourceProperties"] = None, **kwargs: Any) -> None:
"""
:keyword properties: Represents properties of Private Link Resource.
:paramtype properties: ~azure.mgmt.notificationhubs.models.PrivateLinkResourceProperties
"""
super().__init__(**kwargs)
self.properties = properties
[docs]class PrivateLinkResourceListResult(_serialization.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.
:ivar value: Gets or sets result of the List AuthorizationRules operation.
:vartype value: list[~azure.mgmt.notificationhubs.models.PrivateLinkResource]
:ivar next_link: Gets or sets link to the next set of results.
:vartype next_link: str
"""
_validation = {
"value": {"readonly": True},
"next_link": {"readonly": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[PrivateLinkResource]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.value = None
self.next_link = None
[docs]class PrivateLinkResourceProperties(_serialization.Model):
"""Represents properties of Private Link Resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar group_id: A Group Id for Private Link. For Notification Hubs, it is always set to
"namespace".
:vartype group_id: str
:ivar required_members: Required members. For Notification Hubs, it's always a collection with
a single "namespace" item.
:vartype required_members: list[str]
:ivar required_zone_names: Required DNS zone names. For Notification Hubs, it contains two
CNames for Service Bus and Notification Hubs zones.
:vartype required_zone_names: list[str]
"""
_validation = {
"group_id": {"readonly": True},
"required_members": {"readonly": True},
"required_zone_names": {"readonly": True},
}
_attribute_map = {
"group_id": {"key": "groupId", "type": "str"},
"required_members": {"key": "requiredMembers", "type": "[str]"},
"required_zone_names": {"key": "requiredZoneNames", "type": "[str]"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.group_id = None
self.required_members = None
self.required_zone_names = None
[docs]class PrivateLinkServiceConnection(_serialization.Model):
"""A customer-visible sub-resource of Private Endpoint, which describe the connection between
Private Endpoint and Notification Hubs namespace.
:ivar name: Name of the Private Link Service connection.
:vartype name: str
:ivar group_ids: List of group ids. Always contains a single element - "namespace" - for
Notification Hub Namespace.
:vartype group_ids: list[str]
:ivar request_message: Request message provided by the user that created the connection. This
is usually used when the connection requires manual approval.
:vartype request_message: str
"""
_attribute_map = {
"name": {"key": "name", "type": "str"},
"group_ids": {"key": "groupIds", "type": "[str]"},
"request_message": {"key": "requestMessage", "type": "str"},
}
def __init__(
self,
*,
name: Optional[str] = None,
group_ids: Optional[List[str]] = None,
request_message: Optional[str] = None,
**kwargs: Any
) -> None:
"""
:keyword name: Name of the Private Link Service connection.
:paramtype name: str
:keyword group_ids: List of group ids. Always contains a single element - "namespace" - for
Notification Hub Namespace.
:paramtype group_ids: list[str]
:keyword request_message: Request message provided by the user that created the connection.
This is usually used when the connection requires manual approval.
:paramtype request_message: str
"""
super().__init__(**kwargs)
self.name = name
self.group_ids = group_ids
self.request_message = request_message
[docs]class PublicInternetAuthorizationRule(_serialization.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.
:ivar rights: List of access rights. Required.
:vartype rights: list[str or ~azure.mgmt.notificationhubs.models.AccessRights]
"""
_validation = {
"rights": {"required": True},
}
_attribute_map = {
"rights": {"key": "rights", "type": "[str]"},
}
def __init__(self, *, rights: List[Union[str, "_models.AccessRights"]], **kwargs: Any) -> None:
"""
:keyword rights: List of access rights. Required.
:paramtype rights: list[str or ~azure.mgmt.notificationhubs.models.AccessRights]
"""
super().__init__(**kwargs)
self.rights = rights
[docs]class RegistrationResult(_serialization.Model):
"""Notification result for a single registration.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar application_platform: PNS type.
:vartype application_platform: str
:ivar pns_handle: PNS handle.
:vartype pns_handle: str
:ivar registration_id: Registration id.
:vartype registration_id: str
:ivar outcome: Notification outcome.
:vartype outcome: str
"""
_validation = {
"application_platform": {"readonly": True},
"pns_handle": {"readonly": True},
"registration_id": {"readonly": True},
"outcome": {"readonly": True},
}
_attribute_map = {
"application_platform": {"key": "applicationPlatform", "type": "str"},
"pns_handle": {"key": "pnsHandle", "type": "str"},
"registration_id": {"key": "registrationId", "type": "str"},
"outcome": {"key": "outcome", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.application_platform = None
self.pns_handle = None
self.registration_id = None
self.outcome = None
[docs]class RemotePrivateEndpointConnection(_serialization.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.
:ivar id: ARM resource ID of the Private Endpoint. This may belong to different subscription
and resource group than a Notification Hubs namespace.
:vartype id: str
"""
_validation = {
"id": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.id = None
[docs]class RemotePrivateLinkServiceConnectionState(_serialization.Model):
"""State of the Private Link Service connection.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar status: State of Private Link Connection. Known values are: "Disconnected", "Pending",
"Approved", and "Rejected".
:vartype status: str or ~azure.mgmt.notificationhubs.models.PrivateLinkConnectionStatus
:ivar description: Human-friendly description.
:vartype description: str
:ivar actions_required: Human-friendly description of required actions.
:vartype actions_required: str
"""
_validation = {
"description": {"readonly": True},
"actions_required": {"readonly": True},
}
_attribute_map = {
"status": {"key": "status", "type": "str"},
"description": {"key": "description", "type": "str"},
"actions_required": {"key": "actionsRequired", "type": "str"},
}
def __init__(
self, *, status: Optional[Union[str, "_models.PrivateLinkConnectionStatus"]] = None, **kwargs: Any
) -> None:
"""
:keyword status: State of Private Link Connection. Known values are: "Disconnected", "Pending",
"Approved", and "Rejected".
:paramtype status: str or ~azure.mgmt.notificationhubs.models.PrivateLinkConnectionStatus
"""
super().__init__(**kwargs)
self.status = status
self.description = None
self.actions_required = None
[docs]class ResourceListKeys(_serialization.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.
:ivar primary_connection_string: Gets or sets primaryConnectionString of the AuthorizationRule.
:vartype primary_connection_string: str
:ivar secondary_connection_string: Gets or sets secondaryConnectionString of the created
AuthorizationRule.
:vartype secondary_connection_string: str
:ivar primary_key: Gets or sets primaryKey of the created AuthorizationRule.
:vartype primary_key: str
:ivar secondary_key: Gets or sets secondaryKey of the created AuthorizationRule.
:vartype secondary_key: str
:ivar key_name: Gets or sets keyName of the created AuthorizationRule.
:vartype key_name: str
"""
_validation = {
"primary_connection_string": {"readonly": True},
"secondary_connection_string": {"readonly": True},
"primary_key": {"readonly": True},
"secondary_key": {"readonly": True},
"key_name": {"readonly": True},
}
_attribute_map = {
"primary_connection_string": {"key": "primaryConnectionString", "type": "str"},
"secondary_connection_string": {"key": "secondaryConnectionString", "type": "str"},
"primary_key": {"key": "primaryKey", "type": "str"},
"secondary_key": {"key": "secondaryKey", "type": "str"},
"key_name": {"key": "keyName", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.primary_connection_string = None
self.secondary_connection_string = None
self.primary_key = None
self.secondary_key = None
self.key_name = None
[docs]class ServiceSpecification(_serialization.Model):
"""Optional service specification used in Operations API.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar log_specifications: Log specifications.
:vartype log_specifications: list[~azure.mgmt.notificationhubs.models.LogSpecification]
:ivar metric_specifications: Metric specification.
:vartype metric_specifications: list[~azure.mgmt.notificationhubs.models.MetricSpecification]
"""
_validation = {
"log_specifications": {"readonly": True},
"metric_specifications": {"readonly": True},
}
_attribute_map = {
"log_specifications": {"key": "logSpecifications", "type": "[LogSpecification]"},
"metric_specifications": {"key": "metricSpecifications", "type": "[MetricSpecification]"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.log_specifications = None
self.metric_specifications = None
[docs]class SharedAccessAuthorizationRuleListResult(_serialization.Model):
"""The response of the List Namespace operation.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar value: Gets or sets result of the List AuthorizationRules operation.
:vartype value: list[~azure.mgmt.notificationhubs.models.SharedAccessAuthorizationRuleResource]
:ivar next_link: Gets or sets link to the next set of results.
:vartype next_link: str
"""
_validation = {
"value": {"readonly": True},
"next_link": {"readonly": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[SharedAccessAuthorizationRuleResource]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.value = None
self.next_link = None
[docs]class SharedAccessAuthorizationRuleProperties(_serialization.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.
:ivar rights: Gets or sets the rights associated with the rule. Required.
:vartype rights: list[str or ~azure.mgmt.notificationhubs.models.AccessRights]
:ivar primary_key: Gets a base64-encoded 256-bit primary key for signing and
validating the SAS token.
:vartype primary_key: str
:ivar secondary_key: Gets a base64-encoded 256-bit primary key for signing and
validating the SAS token.
:vartype secondary_key: str
:ivar key_name: Gets a string that describes the authorization rule.
:vartype key_name: str
:ivar modified_time: Gets the last modified time for this rule.
:vartype modified_time: ~datetime.datetime
:ivar created_time: Gets the created time for this rule.
:vartype created_time: ~datetime.datetime
:ivar claim_type: Gets a string that describes the claim type.
:vartype claim_type: str
:ivar claim_value: Gets a string that describes the claim value.
:vartype claim_value: str
:ivar revision: Gets the revision number for the rule.
:vartype revision: int
"""
_validation = {
"rights": {"required": True},
"key_name": {"readonly": True},
"modified_time": {"readonly": True},
"created_time": {"readonly": True},
"claim_type": {"readonly": True},
"claim_value": {"readonly": True},
"revision": {"readonly": True},
}
_attribute_map = {
"rights": {"key": "rights", "type": "[str]"},
"primary_key": {"key": "primaryKey", "type": "str"},
"secondary_key": {"key": "secondaryKey", "type": "str"},
"key_name": {"key": "keyName", "type": "str"},
"modified_time": {"key": "modifiedTime", "type": "iso-8601"},
"created_time": {"key": "createdTime", "type": "iso-8601"},
"claim_type": {"key": "claimType", "type": "str"},
"claim_value": {"key": "claimValue", "type": "str"},
"revision": {"key": "revision", "type": "int"},
}
def __init__(
self,
*,
rights: List[Union[str, "_models.AccessRights"]],
primary_key: Optional[str] = None,
secondary_key: Optional[str] = None,
**kwargs: Any
) -> None:
"""
:keyword rights: Gets or sets the rights associated with the rule. Required.
:paramtype rights: list[str or ~azure.mgmt.notificationhubs.models.AccessRights]
:keyword primary_key: Gets a base64-encoded 256-bit primary key for signing and
validating the SAS token.
:paramtype primary_key: str
:keyword secondary_key: Gets a base64-encoded 256-bit primary key for signing and
validating the SAS token.
:paramtype secondary_key: str
"""
super().__init__(**kwargs)
self.rights = rights
self.primary_key = primary_key
self.secondary_key = secondary_key
self.key_name = None
self.modified_time = None
self.created_time = None
self.claim_type = None
self.claim_value = None
self.revision = None
[docs]class SharedAccessAuthorizationRuleResource(ProxyResource): # pylint: disable=too-many-instance-attributes
"""Response for POST requests that return single SharedAccessAuthorizationRule.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Fully qualified resource ID for the resource. E.g.
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy
information.
:vartype system_data: ~azure.mgmt.notificationhubs.models.SystemData
:ivar location: Deprecated - only for compatibility.
:vartype location: str
:ivar tags: Deprecated - only for compatibility.
:vartype tags: dict[str, str]
:ivar rights: Gets or sets the rights associated with the rule.
:vartype rights: list[str or ~azure.mgmt.notificationhubs.models.AccessRights]
:ivar primary_key: Gets a base64-encoded 256-bit primary key for signing and
validating the SAS token.
:vartype primary_key: str
:ivar secondary_key: Gets a base64-encoded 256-bit primary key for signing and
validating the SAS token.
:vartype secondary_key: str
:ivar key_name: Gets a string that describes the authorization rule.
:vartype key_name: str
:ivar modified_time: Gets the last modified time for this rule.
:vartype modified_time: ~datetime.datetime
:ivar created_time: Gets the created time for this rule.
:vartype created_time: ~datetime.datetime
:ivar claim_type: Gets a string that describes the claim type.
:vartype claim_type: str
:ivar claim_value: Gets a string that describes the claim value.
:vartype claim_value: str
:ivar revision: Gets the revision number for the rule.
:vartype revision: int
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"system_data": {"readonly": True},
"key_name": {"readonly": True},
"modified_time": {"readonly": True},
"created_time": {"readonly": True},
"claim_type": {"readonly": True},
"claim_value": {"readonly": True},
"revision": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"rights": {"key": "properties.rights", "type": "[str]"},
"primary_key": {"key": "properties.primaryKey", "type": "str"},
"secondary_key": {"key": "properties.secondaryKey", "type": "str"},
"key_name": {"key": "properties.keyName", "type": "str"},
"modified_time": {"key": "properties.modifiedTime", "type": "iso-8601"},
"created_time": {"key": "properties.createdTime", "type": "iso-8601"},
"claim_type": {"key": "properties.claimType", "type": "str"},
"claim_value": {"key": "properties.claimValue", "type": "str"},
"revision": {"key": "properties.revision", "type": "int"},
}
def __init__(
self,
*,
location: Optional[str] = None,
tags: Optional[Dict[str, str]] = None,
rights: Optional[List[Union[str, "_models.AccessRights"]]] = None,
primary_key: Optional[str] = None,
secondary_key: Optional[str] = None,
**kwargs: Any
) -> None:
"""
:keyword location: Deprecated - only for compatibility.
:paramtype location: str
:keyword tags: Deprecated - only for compatibility.
:paramtype tags: dict[str, str]
:keyword rights: Gets or sets the rights associated with the rule.
:paramtype rights: list[str or ~azure.mgmt.notificationhubs.models.AccessRights]
:keyword primary_key: Gets a base64-encoded 256-bit primary key for signing and
validating the SAS token.
:paramtype primary_key: str
:keyword secondary_key: Gets a base64-encoded 256-bit primary key for signing and
validating the SAS token.
:paramtype secondary_key: str
"""
super().__init__(**kwargs)
self.location = location
self.tags = tags
self.rights = rights
self.primary_key = primary_key
self.secondary_key = secondary_key
self.key_name = None
self.modified_time = None
self.created_time = None
self.claim_type = None
self.claim_value = None
self.revision = None
[docs]class Sku(_serialization.Model):
"""The Sku description for a namespace.
All required parameters must be populated in order to send to server.
:ivar name: Namespace SKU name. Required. Known values are: "Free", "Basic", and "Standard".
:vartype name: str or ~azure.mgmt.notificationhubs.models.SkuName
:ivar tier: Gets or sets the tier of particular sku.
:vartype tier: str
:ivar size: Gets or sets the Sku size.
:vartype size: str
:ivar family: Gets or sets the Sku Family.
:vartype family: str
:ivar capacity: Gets or sets the capacity of the resource.
:vartype capacity: int
"""
_validation = {
"name": {"required": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"tier": {"key": "tier", "type": "str"},
"size": {"key": "size", "type": "str"},
"family": {"key": "family", "type": "str"},
"capacity": {"key": "capacity", "type": "int"},
}
def __init__(
self,
*,
name: Union[str, "_models.SkuName"],
tier: Optional[str] = None,
size: Optional[str] = None,
family: Optional[str] = None,
capacity: Optional[int] = None,
**kwargs: Any
) -> None:
"""
:keyword name: Namespace SKU name. Required. Known values are: "Free", "Basic", and "Standard".
:paramtype name: str or ~azure.mgmt.notificationhubs.models.SkuName
:keyword tier: Gets or sets the tier of particular sku.
:paramtype tier: str
:keyword size: Gets or sets the Sku size.
:paramtype size: str
:keyword family: Gets or sets the Sku Family.
:paramtype family: str
:keyword capacity: Gets or sets the capacity of the resource.
:paramtype capacity: int
"""
super().__init__(**kwargs)
self.name = name
self.tier = tier
self.size = size
self.family = family
self.capacity = capacity
[docs]class SystemData(_serialization.Model):
"""Metadata pertaining to creation and last modification of the resource.
:ivar created_by: The identity that created the resource.
:vartype created_by: str
:ivar created_by_type: The type of identity that created the resource. Known values are:
"User", "Application", "ManagedIdentity", and "Key".
:vartype created_by_type: str or ~azure.mgmt.notificationhubs.models.CreatedByType
:ivar created_at: The timestamp of resource creation (UTC).
:vartype created_at: ~datetime.datetime
:ivar last_modified_by: The identity that last modified the resource.
:vartype last_modified_by: str
:ivar last_modified_by_type: The type of identity that last modified the resource. Known values
are: "User", "Application", "ManagedIdentity", and "Key".
:vartype last_modified_by_type: str or ~azure.mgmt.notificationhubs.models.CreatedByType
:ivar last_modified_at: The timestamp of resource last modification (UTC).
:vartype last_modified_at: ~datetime.datetime
"""
_attribute_map = {
"created_by": {"key": "createdBy", "type": "str"},
"created_by_type": {"key": "createdByType", "type": "str"},
"created_at": {"key": "createdAt", "type": "iso-8601"},
"last_modified_by": {"key": "lastModifiedBy", "type": "str"},
"last_modified_by_type": {"key": "lastModifiedByType", "type": "str"},
"last_modified_at": {"key": "lastModifiedAt", "type": "iso-8601"},
}
def __init__(
self,
*,
created_by: Optional[str] = None,
created_by_type: Optional[Union[str, "_models.CreatedByType"]] = None,
created_at: Optional[datetime.datetime] = None,
last_modified_by: Optional[str] = None,
last_modified_by_type: Optional[Union[str, "_models.CreatedByType"]] = None,
last_modified_at: Optional[datetime.datetime] = None,
**kwargs: Any
) -> None:
"""
:keyword created_by: The identity that created the resource.
:paramtype created_by: str
:keyword created_by_type: The type of identity that created the resource. Known values are:
"User", "Application", "ManagedIdentity", and "Key".
:paramtype created_by_type: str or ~azure.mgmt.notificationhubs.models.CreatedByType
:keyword created_at: The timestamp of resource creation (UTC).
:paramtype created_at: ~datetime.datetime
:keyword last_modified_by: The identity that last modified the resource.
:paramtype last_modified_by: str
:keyword last_modified_by_type: The type of identity that last modified the resource. Known
values are: "User", "Application", "ManagedIdentity", and "Key".
:paramtype last_modified_by_type: str or ~azure.mgmt.notificationhubs.models.CreatedByType
:keyword last_modified_at: The timestamp of resource last modification (UTC).
:paramtype last_modified_at: ~datetime.datetime
"""
super().__init__(**kwargs)
self.created_by = created_by
self.created_by_type = created_by_type
self.created_at = created_at
self.last_modified_by = last_modified_by
self.last_modified_by_type = last_modified_by_type
self.last_modified_at = last_modified_at
[docs]class WnsCredential(_serialization.Model):
"""Description of a NotificationHub WnsCredential.
:ivar package_sid: Gets or sets the package ID for this credential.
:vartype package_sid: str
:ivar secret_key: Gets or sets the secret key.
:vartype secret_key: str
:ivar windows_live_endpoint: Gets or sets the Windows Live endpoint.
:vartype windows_live_endpoint: str
:ivar certificate_key: Ges or sets the WNS Certificate Key.
:vartype certificate_key: str
:ivar wns_certificate: Gets or sets the WNS Certificate.
:vartype wns_certificate: str
"""
_attribute_map = {
"package_sid": {"key": "properties.packageSid", "type": "str"},
"secret_key": {"key": "properties.secretKey", "type": "str"},
"windows_live_endpoint": {"key": "properties.windowsLiveEndpoint", "type": "str"},
"certificate_key": {"key": "properties.certificateKey", "type": "str"},
"wns_certificate": {"key": "properties.wnsCertificate", "type": "str"},
}
def __init__(
self,
*,
package_sid: Optional[str] = None,
secret_key: Optional[str] = None,
windows_live_endpoint: Optional[str] = None,
certificate_key: Optional[str] = None,
wns_certificate: Optional[str] = None,
**kwargs: Any
) -> None:
"""
:keyword package_sid: Gets or sets the package ID for this credential.
:paramtype package_sid: str
:keyword secret_key: Gets or sets the secret key.
:paramtype secret_key: str
:keyword windows_live_endpoint: Gets or sets the Windows Live endpoint.
:paramtype windows_live_endpoint: str
:keyword certificate_key: Ges or sets the WNS Certificate Key.
:paramtype certificate_key: str
:keyword wns_certificate: Gets or sets the WNS Certificate.
:paramtype wns_certificate: str
"""
super().__init__(**kwargs)
self.package_sid = package_sid
self.secret_key = secret_key
self.windows_live_endpoint = windows_live_endpoint
self.certificate_key = certificate_key
self.wns_certificate = wns_certificate
[docs]class XiaomiCredential(_serialization.Model):
"""Description of a NotificationHub XiaomiCredential.
:ivar app_secret: Gets or sets app secret.
:vartype app_secret: str
:ivar endpoint: Gets or sets xiaomi service endpoint.
:vartype endpoint: str
"""
_attribute_map = {
"app_secret": {"key": "properties.appSecret", "type": "str"},
"endpoint": {"key": "properties.endpoint", "type": "str"},
}
def __init__(self, *, app_secret: Optional[str] = None, endpoint: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword app_secret: Gets or sets app secret.
:paramtype app_secret: str
:keyword endpoint: Gets or sets xiaomi service endpoint.
:paramtype endpoint: str
"""
super().__init__(**kwargs)
self.app_secret = app_secret
self.endpoint = endpoint