Microsoft.NotificationHubs (stable:2023-09-01)

2025/09/05 • 35 new, 35 deleted methods

NotificationHubs_CheckNotificationHubAvailability (new)
Description :  Checks the availability of the given notificationHub in a namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/checkNotificationHubAvailability
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request content. ,
Required: True ,
}
{
id:
{
Description: Gets resource Id ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets resource name ,
Required: True ,
}
string ,
type:
{
Description: Gets resource type ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets resource location ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets resource tags ,
Required: False ,
}
object ,
isAvailiable:
{
Description: Not used and deprecated since API version 2023-09-01 ,
Required: False ,
}
boolean ,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
isAvailiable:
{
Description: Gets or sets true if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false. ,
Required: False ,
}
boolean ,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_Get (new)
Description :  Gets the notification hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: NotificationHub properties. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: Gets or sets the RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: Gets or sets the AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
dailyMaxActiveDevices:
{
Format: int64 ,
Required: False ,
}
integer ,
}
,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_CreateOrUpdate (new)
Description :  Creates/Update a NotificationHub in a namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request content. ,
Required: True ,
}
{
properties:
{
Description: NotificationHub properties. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: Gets or sets the RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: Gets or sets the AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
dailyMaxActiveDevices:
{
Format: int64 ,
Required: False ,
}
integer ,
}
,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: NotificationHub properties. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: Gets or sets the RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: Gets or sets the AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
dailyMaxActiveDevices:
{
Format: int64 ,
Required: False ,
}
integer ,
}
,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: NotificationHub properties. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: Gets or sets the RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: Gets or sets the AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
dailyMaxActiveDevices:
{
Format: int64 ,
Required: False ,
}
integer ,
}
,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_Update (new)
Description :  Patch a NotificationHub in a namespace.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request content. ,
Required: True ,
}
{
properties:
{
Description: NotificationHub properties. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: Gets or sets the RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: Gets or sets the AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
dailyMaxActiveDevices:
{
Format: int64 ,
Required: False ,
}
integer ,
}
,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: NotificationHub properties. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: Gets or sets the RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: Gets or sets the AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
dailyMaxActiveDevices:
{
Format: int64 ,
Required: False ,
}
integer ,
}
,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_Delete (new)
Description :  Deletes a notification hub associated with a namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_List (new)
Description :  Lists the notification hubs associated with a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token. ,
Required: False ,
}
string ,
$top:
{
Description: Page size. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets result of the List AuthorizationRules operation. ,
Required: False ,
}
[
{
properties:
{
Description: NotificationHub properties. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: Gets or sets the RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: Gets or sets the AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
dailyMaxActiveDevices:
{
Format: int64 ,
Required: False ,
}
integer ,
}
,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_DebugSend (new)
Description :  Test send a push notification.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/debugsend
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Result of DebugSend operations. ,
Required: False ,
}
{
success:
{
Description: Gets or sets successful send ,
Format: int64 ,
Required: False ,
}
integer ,
failure:
{
Description: Gets or sets send failure ,
Format: int64 ,
Required: False ,
}
integer ,
results:
{
Description: Gets or sets actual failure description ,
Required: False ,
}
[
{
applicationPlatform:
{
Description: PNS type. ,
Required: False ,
}
string ,
pnsHandle:
{
Description: PNS handle. ,
Required: False ,
}
string ,
registrationId:
{
Description: Registration id. ,
Required: False ,
}
string ,
outcome:
{
Description: Notification outcome. ,
Required: False ,
}
string ,
}
,
]
,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_CreateOrUpdateAuthorizationRule (new)
Description :  Creates/Updates an authorization rule for a NotificationHub
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request content. ,
Required: True ,
}
{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_DeleteAuthorizationRule (new)
Description :  Deletes a notificationHub authorization rule
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_GetAuthorizationRule (new)
Description :  Gets an authorization rule for a NotificationHub by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_ListAuthorizationRules (new)
Description :  Gets the authorization rules for a NotificationHub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets result of the List AuthorizationRules operation. ,
Required: False ,
}
[
{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Gets or sets link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_ListKeys (new)
Description :  Gets the Primary and Secondary ConnectionStrings to the NotificationHub
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}/listKeys
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Gets or sets primaryConnectionString of the AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Gets or sets secondaryConnectionString of the created AuthorizationRule ,
Required: False ,
}
string ,
primaryKey:
{
Description: Gets or sets primaryKey of the created AuthorizationRule. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets or sets secondaryKey of the created AuthorizationRule ,
Required: False ,
}
string ,
keyName:
{
Description: Gets or sets keyName of the created AuthorizationRule ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_RegenerateKeys (new)
Description :  Regenerates the Primary/Secondary Keys to the NotificationHub Authorization Rule
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request content. ,
Required: True ,
}
{
policyKey:
{
Description: Type of Shared Access Policy Key (primary or secondary). ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Gets or sets primaryConnectionString of the AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Gets or sets secondaryConnectionString of the created AuthorizationRule ,
Required: False ,
}
string ,
primaryKey:
{
Description: Gets or sets primaryKey of the created AuthorizationRule. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets or sets secondaryKey of the created AuthorizationRule ,
Required: False ,
}
string ,
keyName:
{
Description: Gets or sets keyName of the created AuthorizationRule ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_GetPnsCredentials (new)
Description :  Lists the PNS Credentials associated with a notification hub.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/pnsCredentials
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Collection of Notification Hub or Notification Hub Namespace PNS credentials. ,
Required: False ,
}
{
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CheckAvailability (new)
Description :  Checks the availability of the given service namespace across all Azure subscriptions. This is useful because the domain name is created based on the service namespace name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/checkNamespaceAvailability
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request content. ,
Required: True ,
}
{
id:
{
Description: Gets resource Id ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets resource name ,
Required: True ,
}
string ,
type:
{
Description: Gets resource type ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets resource location ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets resource tags ,
Required: False ,
}
object ,
isAvailiable:
{
Description: Not used and deprecated since API version 2023-09-01 ,
Required: False ,
}
boolean ,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
isAvailiable:
{
Description: Gets or sets true if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false. ,
Required: False ,
}
boolean ,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Get (new)
Description :  Returns the given namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The Sku description for a namespace ,
Required: True ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Represents namespace properties. ,
Required: False ,
}
{
name:
{
Description: Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Defines values for OperationProvisioningState. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Namespace status. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
Suspended: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Gets or sets whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Gets or sets whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Namespace subscription id. ,
Required: False ,
}
string ,
region:
{
Description: Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property. ,
Required: False ,
}
string ,
metricId:
{
Description: Azure Insights Metrics id. ,
Required: False ,
}
string ,
createdAt:
{
Description: Time when the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Time when the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
namespaceType:
{
Description: Defines values for NamespaceType. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
replicationRegion:
{
Description: Allowed replication region ,
Enum:
{
Default: No description available. ,
WestUs2: No description available. ,
NorthEurope: No description available. ,
AustraliaEast: No description available. ,
BrazilSouth: No description available. ,
SouthEastAsia: No description available. ,
SouthAfricaNorth: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: Namespace SKU name. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkAcls:
{
Description: A collection of network authorization rules. ,
Required: False ,
}
{
ipRules:
{
Description: List of IP rules. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP mask. ,
Required: True ,
}
string ,
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
Description: A default (public Internet) network authorization rule, which contains rights if no other network rule matches. ,
Required: False ,
}
{
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
Description: Collection of Notification Hub or Notification Hub Namespace PNS credentials. ,
Required: False ,
}
{
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceBusEndpoint:
{
Description: Gets or sets endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private Endpoint Connections for namespace ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
scaleUnit:
{
Description: Gets or sets scaleUnit where the namespace gets created ,
Required: False ,
}
string ,
dataCenter:
{
Description: Deprecated. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Type of public network access. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdate (new)
Description :  Creates / Updates a Notification Hub namespace. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request content. ,
Required: True ,
}
{
sku:
{
Description: The Sku description for a namespace ,
Required: True ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Represents namespace properties. ,
Required: False ,
}
{
name:
{
Description: Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Defines values for OperationProvisioningState. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Namespace status. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
Suspended: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Gets or sets whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Gets or sets whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Namespace subscription id. ,
Required: False ,
}
string ,
region:
{
Description: Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property. ,
Required: False ,
}
string ,
metricId:
{
Description: Azure Insights Metrics id. ,
Required: False ,
}
string ,
createdAt:
{
Description: Time when the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Time when the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
namespaceType:
{
Description: Defines values for NamespaceType. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
replicationRegion:
{
Description: Allowed replication region ,
Enum:
{
Default: No description available. ,
WestUs2: No description available. ,
NorthEurope: No description available. ,
AustraliaEast: No description available. ,
BrazilSouth: No description available. ,
SouthEastAsia: No description available. ,
SouthAfricaNorth: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: Namespace SKU name. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkAcls:
{
Description: A collection of network authorization rules. ,
Required: False ,
}
{
ipRules:
{
Description: List of IP rules. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP mask. ,
Required: True ,
}
string ,
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
Description: A default (public Internet) network authorization rule, which contains rights if no other network rule matches. ,
Required: False ,
}
{
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
Description: Collection of Notification Hub or Notification Hub Namespace PNS credentials. ,
Required: False ,
}
{
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceBusEndpoint:
{
Description: Gets or sets endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private Endpoint Connections for namespace ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
scaleUnit:
{
Description: Gets or sets scaleUnit where the namespace gets created ,
Required: False ,
}
string ,
dataCenter:
{
Description: Deprecated. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Type of public network access. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
Description: The Sku description for a namespace ,
Required: True ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Represents namespace properties. ,
Required: False ,
}
{
name:
{
Description: Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Defines values for OperationProvisioningState. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Namespace status. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
Suspended: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Gets or sets whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Gets or sets whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Namespace subscription id. ,
Required: False ,
}
string ,
region:
{
Description: Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property. ,
Required: False ,
}
string ,
metricId:
{
Description: Azure Insights Metrics id. ,
Required: False ,
}
string ,
createdAt:
{
Description: Time when the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Time when the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
namespaceType:
{
Description: Defines values for NamespaceType. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
replicationRegion:
{
Description: Allowed replication region ,
Enum:
{
Default: No description available. ,
WestUs2: No description available. ,
NorthEurope: No description available. ,
AustraliaEast: No description available. ,
BrazilSouth: No description available. ,
SouthEastAsia: No description available. ,
SouthAfricaNorth: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: Namespace SKU name. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkAcls:
{
Description: A collection of network authorization rules. ,
Required: False ,
}
{
ipRules:
{
Description: List of IP rules. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP mask. ,
Required: True ,
}
string ,
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
Description: A default (public Internet) network authorization rule, which contains rights if no other network rule matches. ,
Required: False ,
}
{
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
Description: Collection of Notification Hub or Notification Hub Namespace PNS credentials. ,
Required: False ,
}
{
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceBusEndpoint:
{
Description: Gets or sets endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private Endpoint Connections for namespace ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
scaleUnit:
{
Description: Gets or sets scaleUnit where the namespace gets created ,
Required: False ,
}
string ,
dataCenter:
{
Description: Deprecated. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Type of public network access. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The Sku description for a namespace ,
Required: True ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Represents namespace properties. ,
Required: False ,
}
{
name:
{
Description: Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Defines values for OperationProvisioningState. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Namespace status. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
Suspended: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Gets or sets whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Gets or sets whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Namespace subscription id. ,
Required: False ,
}
string ,
region:
{
Description: Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property. ,
Required: False ,
}
string ,
metricId:
{
Description: Azure Insights Metrics id. ,
Required: False ,
}
string ,
createdAt:
{
Description: Time when the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Time when the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
namespaceType:
{
Description: Defines values for NamespaceType. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
replicationRegion:
{
Description: Allowed replication region ,
Enum:
{
Default: No description available. ,
WestUs2: No description available. ,
NorthEurope: No description available. ,
AustraliaEast: No description available. ,
BrazilSouth: No description available. ,
SouthEastAsia: No description available. ,
SouthAfricaNorth: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: Namespace SKU name. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkAcls:
{
Description: A collection of network authorization rules. ,
Required: False ,
}
{
ipRules:
{
Description: List of IP rules. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP mask. ,
Required: True ,
}
string ,
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
Description: A default (public Internet) network authorization rule, which contains rights if no other network rule matches. ,
Required: False ,
}
{
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
Description: Collection of Notification Hub or Notification Hub Namespace PNS credentials. ,
Required: False ,
}
{
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceBusEndpoint:
{
Description: Gets or sets endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private Endpoint Connections for namespace ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
scaleUnit:
{
Description: Gets or sets scaleUnit where the namespace gets created ,
Required: False ,
}
string ,
dataCenter:
{
Description: Deprecated. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Type of public network access. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Update (new)
Description :  Patches the existing namespace.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request content. ,
Required: True ,
}
{
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Represents namespace properties. ,
Required: False ,
}
{
name:
{
Description: Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Defines values for OperationProvisioningState. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Namespace status. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
Suspended: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Gets or sets whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Gets or sets whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Namespace subscription id. ,
Required: False ,
}
string ,
region:
{
Description: Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property. ,
Required: False ,
}
string ,
metricId:
{
Description: Azure Insights Metrics id. ,
Required: False ,
}
string ,
createdAt:
{
Description: Time when the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Time when the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
namespaceType:
{
Description: Defines values for NamespaceType. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
replicationRegion:
{
Description: Allowed replication region ,
Enum:
{
Default: No description available. ,
WestUs2: No description available. ,
NorthEurope: No description available. ,
AustraliaEast: No description available. ,
BrazilSouth: No description available. ,
SouthEastAsia: No description available. ,
SouthAfricaNorth: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: Namespace SKU name. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkAcls:
{
Description: A collection of network authorization rules. ,
Required: False ,
}
{
ipRules:
{
Description: List of IP rules. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP mask. ,
Required: True ,
}
string ,
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
Description: A default (public Internet) network authorization rule, which contains rights if no other network rule matches. ,
Required: False ,
}
{
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
Description: Collection of Notification Hub or Notification Hub Namespace PNS credentials. ,
Required: False ,
}
{
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceBusEndpoint:
{
Description: Gets or sets endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private Endpoint Connections for namespace ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
scaleUnit:
{
Description: Gets or sets scaleUnit where the namespace gets created ,
Required: False ,
}
string ,
dataCenter:
{
Description: Deprecated. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Type of public network access. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
sku:
{
Description: The Sku description for a namespace ,
Required: True ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Represents namespace properties. ,
Required: False ,
}
{
name:
{
Description: Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Defines values for OperationProvisioningState. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Namespace status. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
Suspended: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Gets or sets whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Gets or sets whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Namespace subscription id. ,
Required: False ,
}
string ,
region:
{
Description: Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property. ,
Required: False ,
}
string ,
metricId:
{
Description: Azure Insights Metrics id. ,
Required: False ,
}
string ,
createdAt:
{
Description: Time when the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Time when the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
namespaceType:
{
Description: Defines values for NamespaceType. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
replicationRegion:
{
Description: Allowed replication region ,
Enum:
{
Default: No description available. ,
WestUs2: No description available. ,
NorthEurope: No description available. ,
AustraliaEast: No description available. ,
BrazilSouth: No description available. ,
SouthEastAsia: No description available. ,
SouthAfricaNorth: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: Namespace SKU name. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkAcls:
{
Description: A collection of network authorization rules. ,
Required: False ,
}
{
ipRules:
{
Description: List of IP rules. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP mask. ,
Required: True ,
}
string ,
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
Description: A default (public Internet) network authorization rule, which contains rights if no other network rule matches. ,
Required: False ,
}
{
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
Description: Collection of Notification Hub or Notification Hub Namespace PNS credentials. ,
Required: False ,
}
{
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceBusEndpoint:
{
Description: Gets or sets endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private Endpoint Connections for namespace ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
scaleUnit:
{
Description: Gets or sets scaleUnit where the namespace gets created ,
Required: False ,
}
string ,
dataCenter:
{
Description: Deprecated. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Type of public network access. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Delete (new)
Description :  Deletes an existing namespace. This operation also removes all associated notificationHubs under the namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListAll (new)
Description :  Lists all the available namespaces within the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/namespaces
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$skipToken:
{
Description: Skip token for subsequent requests. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of results to return. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets result of the List AuthorizationRules operation. ,
Required: False ,
}
[
{
sku:
{
Description: The Sku description for a namespace ,
Required: True ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Represents namespace properties. ,
Required: False ,
}
{
name:
{
Description: Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Defines values for OperationProvisioningState. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Namespace status. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
Suspended: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Gets or sets whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Gets or sets whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Namespace subscription id. ,
Required: False ,
}
string ,
region:
{
Description: Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property. ,
Required: False ,
}
string ,
metricId:
{
Description: Azure Insights Metrics id. ,
Required: False ,
}
string ,
createdAt:
{
Description: Time when the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Time when the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
namespaceType:
{
Description: Defines values for NamespaceType. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
replicationRegion:
{
Description: Allowed replication region ,
Enum:
{
Default: No description available. ,
WestUs2: No description available. ,
NorthEurope: No description available. ,
AustraliaEast: No description available. ,
BrazilSouth: No description available. ,
SouthEastAsia: No description available. ,
SouthAfricaNorth: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: Namespace SKU name. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkAcls:
{
Description: A collection of network authorization rules. ,
Required: False ,
}
{
ipRules:
{
Description: List of IP rules. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP mask. ,
Required: True ,
}
string ,
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
Description: A default (public Internet) network authorization rule, which contains rights if no other network rule matches. ,
Required: False ,
}
{
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
Description: Collection of Notification Hub or Notification Hub Namespace PNS credentials. ,
Required: False ,
}
{
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceBusEndpoint:
{
Description: Gets or sets endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private Endpoint Connections for namespace ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
scaleUnit:
{
Description: Gets or sets scaleUnit where the namespace gets created ,
Required: False ,
}
string ,
dataCenter:
{
Description: Deprecated. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Type of public network access. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_List (new)
Description :  Lists the available namespaces within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Skip token for subsequent requests. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of results to return. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets result of the List AuthorizationRules operation. ,
Required: False ,
}
[
{
sku:
{
Description: The Sku description for a namespace ,
Required: True ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Represents namespace properties. ,
Required: False ,
}
{
name:
{
Description: Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Defines values for OperationProvisioningState. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Namespace status. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
Suspended: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Gets or sets whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Gets or sets whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Namespace subscription id. ,
Required: False ,
}
string ,
region:
{
Description: Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property. ,
Required: False ,
}
string ,
metricId:
{
Description: Azure Insights Metrics id. ,
Required: False ,
}
string ,
createdAt:
{
Description: Time when the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Time when the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
namespaceType:
{
Description: Defines values for NamespaceType. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
replicationRegion:
{
Description: Allowed replication region ,
Enum:
{
Default: No description available. ,
WestUs2: No description available. ,
NorthEurope: No description available. ,
AustraliaEast: No description available. ,
BrazilSouth: No description available. ,
SouthEastAsia: No description available. ,
SouthAfricaNorth: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: Namespace SKU name. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkAcls:
{
Description: A collection of network authorization rules. ,
Required: False ,
}
{
ipRules:
{
Description: List of IP rules. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP mask. ,
Required: True ,
}
string ,
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
Description: A default (public Internet) network authorization rule, which contains rights if no other network rule matches. ,
Required: False ,
}
{
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
Description: Collection of Notification Hub or Notification Hub Namespace PNS credentials. ,
Required: False ,
}
{
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceBusEndpoint:
{
Description: Gets or sets endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private Endpoint Connections for namespace ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
scaleUnit:
{
Description: Gets or sets scaleUnit where the namespace gets created ,
Required: False ,
}
string ,
dataCenter:
{
Description: Deprecated. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Type of public network access. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdateAuthorizationRule (new)
Description :  Creates an authorization rule for a namespace
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request content. ,
Required: True ,
}
{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_DeleteAuthorizationRule (new)
Description :  Deletes a namespace authorization rule
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_GetAuthorizationRule (new)
Description :  Gets an authorization rule for a namespace by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListAuthorizationRules (new)
Description :  Gets the authorization rules for a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets result of the List AuthorizationRules operation. ,
Required: False ,
}
[
{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Gets or sets link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListKeys (new)
Description :  Gets the Primary and Secondary ConnectionStrings to the namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/listKeys
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Gets or sets primaryConnectionString of the AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Gets or sets secondaryConnectionString of the created AuthorizationRule ,
Required: False ,
}
string ,
primaryKey:
{
Description: Gets or sets primaryKey of the created AuthorizationRule. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets or sets secondaryKey of the created AuthorizationRule ,
Required: False ,
}
string ,
keyName:
{
Description: Gets or sets keyName of the created AuthorizationRule ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_RegenerateKeys (new)
Description :  Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request content. ,
Required: True ,
}
{
policyKey:
{
Description: Type of Shared Access Policy Key (primary or secondary). ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Gets or sets primaryConnectionString of the AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Gets or sets secondaryConnectionString of the created AuthorizationRule ,
Required: False ,
}
string ,
primaryKey:
{
Description: Gets or sets primaryKey of the created AuthorizationRule. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets or sets secondaryKey of the created AuthorizationRule ,
Required: False ,
}
string ,
keyName:
{
Description: Gets or sets keyName of the created AuthorizationRule ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_GetPnsCredentials (new)
Description :  Lists the PNS credentials associated with a namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/pnsCredentials
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Collection of Notification Hub or Notification Hub Namespace PNS credentials. ,
Required: False ,
}
{
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists all available Notification Hubs operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.NotificationHubs/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets list of NotificationHubs operations supported by the Microsoft.NotificationHubs resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Gets operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Gets service provider: Microsoft.NotificationHubs ,
Required: False ,
}
string ,
resource:
{
Description: Gets resource on which the operation is performed: Invoice, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Gets operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Human-friendly operation description. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Optional operation properties. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Optional service specification used in Operations API. ,
Required: False ,
}
{
logSpecifications:
{
Description: Log specifications. ,
Required: False ,
}
[
{
name:
{
Description: Name of the log category. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the log category. ,
Required: False ,
}
string ,
blobDuration:
{
Description: Duration of data written to a single blob. ,
Required: False ,
}
string ,
}
,
]
,
metricSpecifications:
{
Description: Metric specification. ,
Required: False ,
}
[
{
name:
{
Description: Metric name / id. ,
Required: False ,
}
string ,
displayName:
{
Description: User-visible metric name. ,
Required: False ,
}
string ,
displayDescription:
{
Description: Description of the metric. ,
Required: False ,
}
string ,
unit:
{
Description: Metric unit. ,
Required: False ,
}
string ,
aggregationType:
{
Description: Type of the aggregation (Average, Minimum, Maximum, Total or Count). ,
Required: False ,
}
string ,
availabilities:
{
Description: List of availabilities. ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain of the availability. ,
Required: False ,
}
string ,
blobDuration:
{
Description: Duration of the availability blob. ,
Required: False ,
}
string ,
}
,
]
,
metricFilterPattern:
{
Description: The matching regex pattern to be applied to the field pointed by the "metricsFilterPathSelector" flag in the ARM manifest. ,
Required: False ,
}
string ,
fillGapWithZero:
{
Description: Optional property. If set to true, then zero will be returned for time duration where no metric is emitted / published. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
isDataAction:
{
Description: Gets or sets IsDataAction property. It is used to differentiate management and data plane operations. ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: Gets URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Update (new)
Description :  Approves or rejects Private Endpoint Connection. This is a public API that can be called directly by Notification Hubs users.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Private Endpoint Connection Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Description of the Private Endpoint Connection resource. ,
Required: True ,
}
{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (new)
Description :  Deletes the Private Endpoint Connection. This is a public API that can be called directly by Notification Hubs users.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Private Endpoint Connection Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Returns a Private Endpoint Connection with a given name. This is a public API that can be called directly by Notification Hubs users.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Private Endpoint Connection Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_List (new)
Description :  Returns all Private Endpoint Connections that belong to the given Notification Hubs namespace. This is a public API that can be called directly by Notification Hubs users.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateEndpointConnections
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets result of the List AuthorizationRules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_GetGroupId (new)
Description :  Even though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it's called. That's why we don't send it to the sibling RP, but process it directly in the scale unit that received the request.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateLinkResources/{subResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
subResourceName:
{
Description: Name of the Private Link sub-resource. The only supported sub-resource is "namespace" ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Represents properties of Private Link Resource. ,
Required: False ,
}
{
groupId:
{
Description: A Group Id for Private Link. For Notification Hubs, it is always set to "namespace". ,
Required: False ,
}
string ,
requiredMembers:
{
Description: Required members. For Notification Hubs, it's always a collection with a single "namespace" item. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: Required DNS zone names. For Notification Hubs, it contains two CNames for Service Bus and Notification Hubs zones. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_ListGroupIds (new)
Description :  Even though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it's called. That's why we don't send it to the sibling RP, but process it directly in the scale unit that received the request.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateLinkResources
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets result of the List AuthorizationRules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Represents properties of Private Link Resource. ,
Required: False ,
}
{
groupId:
{
Description: A Group Id for Private Link. For Notification Hubs, it is always set to "namespace". ,
Required: False ,
}
string ,
requiredMembers:
{
Description: Required members. For Notification Hubs, it's always a collection with a single "namespace" item. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: Required DNS zone names. For Notification Hubs, it contains two CNames for Service Bus and Notification Hubs zones. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_CheckNotificationHubAvailability (removed)
Description :  Checks the availability of the given notificationHub in a namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/checkNotificationHubAvailability
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request content. ,
Required: True ,
}
{
id:
{
Description: Gets resource Id ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets resource name ,
Required: True ,
}
string ,
type:
{
Description: Gets resource type ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets resource location ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets resource tags ,
Required: False ,
}
object ,
isAvailiable:
{
Description: Not used and deprecated since API version 2023-09-01 ,
Required: False ,
}
boolean ,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
isAvailiable:
{
Description: Gets or sets true if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false. ,
Required: False ,
}
boolean ,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_Get (removed)
Description :  Gets the notification hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: NotificationHub properties. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: Gets or sets the RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: Gets or sets the AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
dailyMaxActiveDevices:
{
Format: int64 ,
Required: False ,
}
integer ,
}
,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_CreateOrUpdate (removed)
Description :  Creates/Update a NotificationHub in a namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request content. ,
Required: True ,
}
{
properties:
{
Description: NotificationHub properties. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: Gets or sets the RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: Gets or sets the AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
dailyMaxActiveDevices:
{
Format: int64 ,
Required: False ,
}
integer ,
}
,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: NotificationHub properties. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: Gets or sets the RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: Gets or sets the AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
dailyMaxActiveDevices:
{
Format: int64 ,
Required: False ,
}
integer ,
}
,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: NotificationHub properties. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: Gets or sets the RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: Gets or sets the AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
dailyMaxActiveDevices:
{
Format: int64 ,
Required: False ,
}
integer ,
}
,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_Update (removed)
Description :  Patch a NotificationHub in a namespace.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request content. ,
Required: True ,
}
{
properties:
{
Description: NotificationHub properties. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: Gets or sets the RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: Gets or sets the AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
dailyMaxActiveDevices:
{
Format: int64 ,
Required: False ,
}
integer ,
}
,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: NotificationHub properties. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: Gets or sets the RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: Gets or sets the AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
dailyMaxActiveDevices:
{
Format: int64 ,
Required: False ,
}
integer ,
}
,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_Delete (removed)
Description :  Deletes a notification hub associated with a namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_List (removed)
Description :  Lists the notification hubs associated with a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token. ,
Required: False ,
}
string ,
$top:
{
Description: Page size. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets result of the List AuthorizationRules operation. ,
Required: False ,
}
[
{
properties:
{
Description: NotificationHub properties. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: Gets or sets the RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: Gets or sets the AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
dailyMaxActiveDevices:
{
Format: int64 ,
Required: False ,
}
integer ,
}
,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_DebugSend (removed)
Description :  Test send a push notification.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/debugsend
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Result of DebugSend operations. ,
Required: False ,
}
{
success:
{
Description: Gets or sets successful send ,
Format: int64 ,
Required: False ,
}
integer ,
failure:
{
Description: Gets or sets send failure ,
Format: int64 ,
Required: False ,
}
integer ,
results:
{
Description: Gets or sets actual failure description ,
Required: False ,
}
[
{
applicationPlatform:
{
Description: PNS type. ,
Required: False ,
}
string ,
pnsHandle:
{
Description: PNS handle. ,
Required: False ,
}
string ,
registrationId:
{
Description: Registration id. ,
Required: False ,
}
string ,
outcome:
{
Description: Notification outcome. ,
Required: False ,
}
string ,
}
,
]
,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_CreateOrUpdateAuthorizationRule (removed)
Description :  Creates/Updates an authorization rule for a NotificationHub
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request content. ,
Required: True ,
}
{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_DeleteAuthorizationRule (removed)
Description :  Deletes a notificationHub authorization rule
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_GetAuthorizationRule (removed)
Description :  Gets an authorization rule for a NotificationHub by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_ListAuthorizationRules (removed)
Description :  Gets the authorization rules for a NotificationHub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets result of the List AuthorizationRules operation. ,
Required: False ,
}
[
{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Gets or sets link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_ListKeys (removed)
Description :  Gets the Primary and Secondary ConnectionStrings to the NotificationHub
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}/listKeys
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Gets or sets primaryConnectionString of the AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Gets or sets secondaryConnectionString of the created AuthorizationRule ,
Required: False ,
}
string ,
primaryKey:
{
Description: Gets or sets primaryKey of the created AuthorizationRule. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets or sets secondaryKey of the created AuthorizationRule ,
Required: False ,
}
string ,
keyName:
{
Description: Gets or sets keyName of the created AuthorizationRule ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_RegenerateKeys (removed)
Description :  Regenerates the Primary/Secondary Keys to the NotificationHub Authorization Rule
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request content. ,
Required: True ,
}
{
policyKey:
{
Description: Type of Shared Access Policy Key (primary or secondary). ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Gets or sets primaryConnectionString of the AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Gets or sets secondaryConnectionString of the created AuthorizationRule ,
Required: False ,
}
string ,
primaryKey:
{
Description: Gets or sets primaryKey of the created AuthorizationRule. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets or sets secondaryKey of the created AuthorizationRule ,
Required: False ,
}
string ,
keyName:
{
Description: Gets or sets keyName of the created AuthorizationRule ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationHubs_GetPnsCredentials (removed)
Description :  Lists the PNS Credentials associated with a notification hub.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/pnsCredentials
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: Notification Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Collection of Notification Hub or Notification Hub Namespace PNS credentials. ,
Required: False ,
}
{
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CheckAvailability (removed)
Description :  Checks the availability of the given service namespace across all Azure subscriptions. This is useful because the domain name is created based on the service namespace name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/checkNamespaceAvailability
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request content. ,
Required: True ,
}
{
id:
{
Description: Gets resource Id ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets resource name ,
Required: True ,
}
string ,
type:
{
Description: Gets resource type ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets resource location ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets resource tags ,
Required: False ,
}
object ,
isAvailiable:
{
Description: Not used and deprecated since API version 2023-09-01 ,
Required: False ,
}
boolean ,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
isAvailiable:
{
Description: Gets or sets true if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false. ,
Required: False ,
}
boolean ,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Get (removed)
Description :  Returns the given namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The Sku description for a namespace ,
Required: True ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Represents namespace properties. ,
Required: False ,
}
{
name:
{
Description: Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Defines values for OperationProvisioningState. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Namespace status. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
Suspended: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Gets or sets whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Gets or sets whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Namespace subscription id. ,
Required: False ,
}
string ,
region:
{
Description: Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property. ,
Required: False ,
}
string ,
metricId:
{
Description: Azure Insights Metrics id. ,
Required: False ,
}
string ,
createdAt:
{
Description: Time when the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Time when the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
namespaceType:
{
Description: Defines values for NamespaceType. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
replicationRegion:
{
Description: Allowed replication region ,
Enum:
{
Default: No description available. ,
WestUs2: No description available. ,
NorthEurope: No description available. ,
AustraliaEast: No description available. ,
BrazilSouth: No description available. ,
SouthEastAsia: No description available. ,
SouthAfricaNorth: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: Namespace SKU name. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkAcls:
{
Description: A collection of network authorization rules. ,
Required: False ,
}
{
ipRules:
{
Description: List of IP rules. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP mask. ,
Required: True ,
}
string ,
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
Description: A default (public Internet) network authorization rule, which contains rights if no other network rule matches. ,
Required: False ,
}
{
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
Description: Collection of Notification Hub or Notification Hub Namespace PNS credentials. ,
Required: False ,
}
{
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceBusEndpoint:
{
Description: Gets or sets endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private Endpoint Connections for namespace ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
scaleUnit:
{
Description: Gets or sets scaleUnit where the namespace gets created ,
Required: False ,
}
string ,
dataCenter:
{
Description: Deprecated. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Type of public network access. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdate (removed)
Description :  Creates / Updates a Notification Hub namespace. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request content. ,
Required: True ,
}
{
sku:
{
Description: The Sku description for a namespace ,
Required: True ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Represents namespace properties. ,
Required: False ,
}
{
name:
{
Description: Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Defines values for OperationProvisioningState. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Namespace status. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
Suspended: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Gets or sets whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Gets or sets whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Namespace subscription id. ,
Required: False ,
}
string ,
region:
{
Description: Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property. ,
Required: False ,
}
string ,
metricId:
{
Description: Azure Insights Metrics id. ,
Required: False ,
}
string ,
createdAt:
{
Description: Time when the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Time when the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
namespaceType:
{
Description: Defines values for NamespaceType. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
replicationRegion:
{
Description: Allowed replication region ,
Enum:
{
Default: No description available. ,
WestUs2: No description available. ,
NorthEurope: No description available. ,
AustraliaEast: No description available. ,
BrazilSouth: No description available. ,
SouthEastAsia: No description available. ,
SouthAfricaNorth: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: Namespace SKU name. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkAcls:
{
Description: A collection of network authorization rules. ,
Required: False ,
}
{
ipRules:
{
Description: List of IP rules. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP mask. ,
Required: True ,
}
string ,
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
Description: A default (public Internet) network authorization rule, which contains rights if no other network rule matches. ,
Required: False ,
}
{
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
Description: Collection of Notification Hub or Notification Hub Namespace PNS credentials. ,
Required: False ,
}
{
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceBusEndpoint:
{
Description: Gets or sets endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private Endpoint Connections for namespace ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
scaleUnit:
{
Description: Gets or sets scaleUnit where the namespace gets created ,
Required: False ,
}
string ,
dataCenter:
{
Description: Deprecated. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Type of public network access. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
Description: The Sku description for a namespace ,
Required: True ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Represents namespace properties. ,
Required: False ,
}
{
name:
{
Description: Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Defines values for OperationProvisioningState. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Namespace status. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
Suspended: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Gets or sets whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Gets or sets whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Namespace subscription id. ,
Required: False ,
}
string ,
region:
{
Description: Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property. ,
Required: False ,
}
string ,
metricId:
{
Description: Azure Insights Metrics id. ,
Required: False ,
}
string ,
createdAt:
{
Description: Time when the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Time when the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
namespaceType:
{
Description: Defines values for NamespaceType. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
replicationRegion:
{
Description: Allowed replication region ,
Enum:
{
Default: No description available. ,
WestUs2: No description available. ,
NorthEurope: No description available. ,
AustraliaEast: No description available. ,
BrazilSouth: No description available. ,
SouthEastAsia: No description available. ,
SouthAfricaNorth: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: Namespace SKU name. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkAcls:
{
Description: A collection of network authorization rules. ,
Required: False ,
}
{
ipRules:
{
Description: List of IP rules. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP mask. ,
Required: True ,
}
string ,
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
Description: A default (public Internet) network authorization rule, which contains rights if no other network rule matches. ,
Required: False ,
}
{
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
Description: Collection of Notification Hub or Notification Hub Namespace PNS credentials. ,
Required: False ,
}
{
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceBusEndpoint:
{
Description: Gets or sets endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private Endpoint Connections for namespace ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
scaleUnit:
{
Description: Gets or sets scaleUnit where the namespace gets created ,
Required: False ,
}
string ,
dataCenter:
{
Description: Deprecated. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Type of public network access. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The Sku description for a namespace ,
Required: True ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Represents namespace properties. ,
Required: False ,
}
{
name:
{
Description: Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Defines values for OperationProvisioningState. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Namespace status. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
Suspended: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Gets or sets whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Gets or sets whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Namespace subscription id. ,
Required: False ,
}
string ,
region:
{
Description: Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property. ,
Required: False ,
}
string ,
metricId:
{
Description: Azure Insights Metrics id. ,
Required: False ,
}
string ,
createdAt:
{
Description: Time when the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Time when the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
namespaceType:
{
Description: Defines values for NamespaceType. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
replicationRegion:
{
Description: Allowed replication region ,
Enum:
{
Default: No description available. ,
WestUs2: No description available. ,
NorthEurope: No description available. ,
AustraliaEast: No description available. ,
BrazilSouth: No description available. ,
SouthEastAsia: No description available. ,
SouthAfricaNorth: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: Namespace SKU name. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkAcls:
{
Description: A collection of network authorization rules. ,
Required: False ,
}
{
ipRules:
{
Description: List of IP rules. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP mask. ,
Required: True ,
}
string ,
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
Description: A default (public Internet) network authorization rule, which contains rights if no other network rule matches. ,
Required: False ,
}
{
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
Description: Collection of Notification Hub or Notification Hub Namespace PNS credentials. ,
Required: False ,
}
{
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceBusEndpoint:
{
Description: Gets or sets endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private Endpoint Connections for namespace ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
scaleUnit:
{
Description: Gets or sets scaleUnit where the namespace gets created ,
Required: False ,
}
string ,
dataCenter:
{
Description: Deprecated. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Type of public network access. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Update (removed)
Description :  Patches the existing namespace.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request content. ,
Required: True ,
}
{
sku:
{
Description: The Sku description for a namespace ,
Required: False ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Represents namespace properties. ,
Required: False ,
}
{
name:
{
Description: Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Defines values for OperationProvisioningState. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Namespace status. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
Suspended: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Gets or sets whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Gets or sets whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Namespace subscription id. ,
Required: False ,
}
string ,
region:
{
Description: Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property. ,
Required: False ,
}
string ,
metricId:
{
Description: Azure Insights Metrics id. ,
Required: False ,
}
string ,
createdAt:
{
Description: Time when the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Time when the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
namespaceType:
{
Description: Defines values for NamespaceType. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
replicationRegion:
{
Description: Allowed replication region ,
Enum:
{
Default: No description available. ,
WestUs2: No description available. ,
NorthEurope: No description available. ,
AustraliaEast: No description available. ,
BrazilSouth: No description available. ,
SouthEastAsia: No description available. ,
SouthAfricaNorth: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: Namespace SKU name. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkAcls:
{
Description: A collection of network authorization rules. ,
Required: False ,
}
{
ipRules:
{
Description: List of IP rules. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP mask. ,
Required: True ,
}
string ,
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
Description: A default (public Internet) network authorization rule, which contains rights if no other network rule matches. ,
Required: False ,
}
{
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
Description: Collection of Notification Hub or Notification Hub Namespace PNS credentials. ,
Required: False ,
}
{
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceBusEndpoint:
{
Description: Gets or sets endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private Endpoint Connections for namespace ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
scaleUnit:
{
Description: Gets or sets scaleUnit where the namespace gets created ,
Required: False ,
}
string ,
dataCenter:
{
Description: Deprecated. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Type of public network access. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
sku:
{
Description: The Sku description for a namespace ,
Required: True ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Represents namespace properties. ,
Required: False ,
}
{
name:
{
Description: Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Defines values for OperationProvisioningState. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Namespace status. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
Suspended: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Gets or sets whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Gets or sets whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Namespace subscription id. ,
Required: False ,
}
string ,
region:
{
Description: Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property. ,
Required: False ,
}
string ,
metricId:
{
Description: Azure Insights Metrics id. ,
Required: False ,
}
string ,
createdAt:
{
Description: Time when the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Time when the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
namespaceType:
{
Description: Defines values for NamespaceType. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
replicationRegion:
{
Description: Allowed replication region ,
Enum:
{
Default: No description available. ,
WestUs2: No description available. ,
NorthEurope: No description available. ,
AustraliaEast: No description available. ,
BrazilSouth: No description available. ,
SouthEastAsia: No description available. ,
SouthAfricaNorth: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: Namespace SKU name. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkAcls:
{
Description: A collection of network authorization rules. ,
Required: False ,
}
{
ipRules:
{
Description: List of IP rules. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP mask. ,
Required: True ,
}
string ,
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
Description: A default (public Internet) network authorization rule, which contains rights if no other network rule matches. ,
Required: False ,
}
{
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
Description: Collection of Notification Hub or Notification Hub Namespace PNS credentials. ,
Required: False ,
}
{
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceBusEndpoint:
{
Description: Gets or sets endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private Endpoint Connections for namespace ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
scaleUnit:
{
Description: Gets or sets scaleUnit where the namespace gets created ,
Required: False ,
}
string ,
dataCenter:
{
Description: Deprecated. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Type of public network access. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Delete (removed)
Description :  Deletes an existing namespace. This operation also removes all associated notificationHubs under the namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListAll (removed)
Description :  Lists all the available namespaces within the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/namespaces
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$skipToken:
{
Description: Skip token for subsequent requests. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of results to return. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets result of the List AuthorizationRules operation. ,
Required: False ,
}
[
{
sku:
{
Description: The Sku description for a namespace ,
Required: True ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Represents namespace properties. ,
Required: False ,
}
{
name:
{
Description: Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Defines values for OperationProvisioningState. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Namespace status. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
Suspended: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Gets or sets whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Gets or sets whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Namespace subscription id. ,
Required: False ,
}
string ,
region:
{
Description: Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property. ,
Required: False ,
}
string ,
metricId:
{
Description: Azure Insights Metrics id. ,
Required: False ,
}
string ,
createdAt:
{
Description: Time when the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Time when the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
namespaceType:
{
Description: Defines values for NamespaceType. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
replicationRegion:
{
Description: Allowed replication region ,
Enum:
{
Default: No description available. ,
WestUs2: No description available. ,
NorthEurope: No description available. ,
AustraliaEast: No description available. ,
BrazilSouth: No description available. ,
SouthEastAsia: No description available. ,
SouthAfricaNorth: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: Namespace SKU name. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkAcls:
{
Description: A collection of network authorization rules. ,
Required: False ,
}
{
ipRules:
{
Description: List of IP rules. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP mask. ,
Required: True ,
}
string ,
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
Description: A default (public Internet) network authorization rule, which contains rights if no other network rule matches. ,
Required: False ,
}
{
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
Description: Collection of Notification Hub or Notification Hub Namespace PNS credentials. ,
Required: False ,
}
{
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceBusEndpoint:
{
Description: Gets or sets endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private Endpoint Connections for namespace ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
scaleUnit:
{
Description: Gets or sets scaleUnit where the namespace gets created ,
Required: False ,
}
string ,
dataCenter:
{
Description: Deprecated. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Type of public network access. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_List (removed)
Description :  Lists the available namespaces within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Skip token for subsequent requests. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of results to return. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets result of the List AuthorizationRules operation. ,
Required: False ,
}
[
{
sku:
{
Description: The Sku description for a namespace ,
Required: True ,
}
{
name:
{
Description: Namespace SKU name. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: Gets or sets the tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: Gets or sets the Sku size ,
Required: False ,
}
string ,
family:
{
Description: Gets or sets the Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the capacity of the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Represents namespace properties. ,
Required: False ,
}
{
name:
{
Description: Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Defines values for OperationProvisioningState. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Namespace status. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
Suspended: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Gets or sets whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Gets or sets whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Namespace subscription id. ,
Required: False ,
}
string ,
region:
{
Description: Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property. ,
Required: False ,
}
string ,
metricId:
{
Description: Azure Insights Metrics id. ,
Required: False ,
}
string ,
createdAt:
{
Description: Time when the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Time when the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
namespaceType:
{
Description: Defines values for NamespaceType. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
replicationRegion:
{
Description: Allowed replication region ,
Enum:
{
Default: No description available. ,
WestUs2: No description available. ,
NorthEurope: No description available. ,
AustraliaEast: No description available. ,
BrazilSouth: No description available. ,
SouthEastAsia: No description available. ,
SouthAfricaNorth: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundancy:
{
Description: Namespace SKU name. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkAcls:
{
Description: A collection of network authorization rules. ,
Required: False ,
}
{
ipRules:
{
Description: List of IP rules. ,
Required: False ,
}
[
{
ipMask:
{
Description: IP mask. ,
Required: True ,
}
string ,
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
Description: A default (public Internet) network authorization rule, which contains rights if no other network rule matches. ,
Required: False ,
}
{
rights:
{
Description: List of access rights. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
Description: Collection of Notification Hub or Notification Hub Namespace PNS credentials. ,
Required: False ,
}
{
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
serviceBusEndpoint:
{
Description: Gets or sets endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Private Endpoint Connections for namespace ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
scaleUnit:
{
Description: Gets or sets scaleUnit where the namespace gets created ,
Required: False ,
}
string ,
dataCenter:
{
Description: Deprecated. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Type of public network access. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdateAuthorizationRule (removed)
Description :  Creates an authorization rule for a namespace
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request content. ,
Required: True ,
}
{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_DeleteAuthorizationRule (removed)
Description :  Deletes a namespace authorization rule
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_GetAuthorizationRule (removed)
Description :  Gets an authorization rule for a namespace by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListAuthorizationRules (removed)
Description :  Gets the authorization rules for a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets result of the List AuthorizationRules operation. ,
Required: False ,
}
[
{
properties:
{
Description: SharedAccessAuthorizationRule properties. ,
Required: False ,
}
{
rights:
{
Description: Gets or sets the rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
primaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets a base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: Gets a string that describes the authorization rule. ,
Required: False ,
}
string ,
modifiedTime:
{
Description: Gets the last modified time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
createdTime:
{
Description: Gets the created time for this rule ,
Format: date-time ,
Required: False ,
}
string ,
claimType:
{
Description: Gets a string that describes the claim type ,
Required: False ,
}
string ,
claimValue:
{
Description: Gets a string that describes the claim value ,
Required: False ,
}
string ,
revision:
{
Description: Gets the revision number for the rule ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Gets or sets link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListKeys (removed)
Description :  Gets the Primary and Secondary ConnectionStrings to the namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/listKeys
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Gets or sets primaryConnectionString of the AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Gets or sets secondaryConnectionString of the created AuthorizationRule ,
Required: False ,
}
string ,
primaryKey:
{
Description: Gets or sets primaryKey of the created AuthorizationRule. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets or sets secondaryKey of the created AuthorizationRule ,
Required: False ,
}
string ,
keyName:
{
Description: Gets or sets keyName of the created AuthorizationRule ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_RegenerateKeys (removed)
Description :  Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Request content. ,
Required: True ,
}
{
policyKey:
{
Description: Type of Shared Access Policy Key (primary or secondary). ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Gets or sets primaryConnectionString of the AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Gets or sets secondaryConnectionString of the created AuthorizationRule ,
Required: False ,
}
string ,
primaryKey:
{
Description: Gets or sets primaryKey of the created AuthorizationRule. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Gets or sets secondaryKey of the created AuthorizationRule ,
Required: False ,
}
string ,
keyName:
{
Description: Gets or sets keyName of the created AuthorizationRule ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_GetPnsCredentials (removed)
Description :  Lists the PNS credentials associated with a namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/pnsCredentials
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Collection of Notification Hub or Notification Hub Namespace PNS credentials. ,
Required: False ,
}
{
admCredential:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub AdmCredential. ,
Required: True ,
}
{
clientId:
{
Description: Gets or sets the client identifier. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Gets or sets the credential secret access key. ,
Required: True ,
}
string ,
authTokenUrl:
{
Description: Gets or sets the URL of the authorization token. ,
Required: True ,
}
string ,
}
,
}
,
apnsCredential:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub ApnsCredential. ,
Required: True ,
}
{
apnsCertificate:
{
Description: Gets or sets the APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the endpoint of this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the APNS certificate Thumbprint ,
Required: False ,
}
string ,
keyId:
{
Description: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account ,
Required: False ,
}
string ,
appName:
{
Description: Gets or sets the name of the application ,
Required: False ,
}
string ,
appId:
{
Description: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account ,
Required: False ,
}
string ,
token:
{
Description: Gets or sets provider Authentication Token, obtained through your developer account ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BaiduCredential. ,
Required: True ,
}
{
baiduApiKey:
{
Description: Gets or sets baidu Api Key. ,
Required: True ,
}
string ,
baiduEndPoint:
{
Description: Gets or sets baidu Endpoint. ,
Required: True ,
}
string ,
baiduSecretKey:
{
Description: Gets or sets baidu Secret Key ,
Required: True ,
}
string ,
}
,
}
,
browserCredential:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub BrowserCredential. ,
Required: True ,
}
{
subject:
{
Description: Gets or sets web push subject. ,
Required: True ,
}
string ,
vapidPrivateKey:
{
Description: Gets or sets VAPID private key. ,
Required: True ,
}
string ,
vapidPublicKey:
{
Description: Gets or sets VAPID public key. ,
Required: True ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub GcmCredential. ,
Required: True ,
}
{
gcmEndpoint:
{
Description: Gets or sets the GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: Gets or sets the Google API key. ,
Required: True ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub MpnsCredential. ,
Required: True ,
}
{
mpnsCertificate:
{
Description: Gets or sets the MPNS certificate. ,
Required: True ,
}
string ,
certificateKey:
{
Description: Gets or sets the certificate key for this credential. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Gets or sets the MPNS certificate Thumbprint ,
Required: True ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub WnsCredential. ,
Required: True ,
}
{
packageSid:
{
Description: Gets or sets the package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: Gets or sets the secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: Gets or sets the Windows Live endpoint. ,
Required: False ,
}
string ,
certificateKey:
{
Description: Ges or sets the WNS Certificate Key. ,
Required: False ,
}
string ,
wnsCertificate:
{
Description: Gets or sets the WNS Certificate. ,
Required: False ,
}
string ,
}
,
}
,
xiaomiCredential:
{
Description: Description of a NotificationHub XiaomiCredential. ,
Required: False ,
}
{
properties:
{
Description: Description of a NotificationHub XiaomiCredentialProperties. ,
Required: True ,
}
{
appSecret:
{
Description: Gets or sets app secret. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets xiaomi service endpoint. ,
Required: False ,
}
string ,
}
,
}
,
}
,
location:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
string ,
tags:
{
Description: Deprecated - only for compatibility. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Lists all available Notification Hubs operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.NotificationHubs/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets list of NotificationHubs operations supported by the Microsoft.NotificationHubs resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Gets operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Gets service provider: Microsoft.NotificationHubs ,
Required: False ,
}
string ,
resource:
{
Description: Gets resource on which the operation is performed: Invoice, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Gets operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Human-friendly operation description. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Optional operation properties. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Optional service specification used in Operations API. ,
Required: False ,
}
{
logSpecifications:
{
Description: Log specifications. ,
Required: False ,
}
[
{
name:
{
Description: Name of the log category. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the log category. ,
Required: False ,
}
string ,
blobDuration:
{
Description: Duration of data written to a single blob. ,
Required: False ,
}
string ,
}
,
]
,
metricSpecifications:
{
Description: Metric specification. ,
Required: False ,
}
[
{
name:
{
Description: Metric name / id. ,
Required: False ,
}
string ,
displayName:
{
Description: User-visible metric name. ,
Required: False ,
}
string ,
displayDescription:
{
Description: Description of the metric. ,
Required: False ,
}
string ,
unit:
{
Description: Metric unit. ,
Required: False ,
}
string ,
aggregationType:
{
Description: Type of the aggregation (Average, Minimum, Maximum, Total or Count). ,
Required: False ,
}
string ,
availabilities:
{
Description: List of availabilities. ,
Required: False ,
}
[
{
timeGrain:
{
Description: Time grain of the availability. ,
Required: False ,
}
string ,
blobDuration:
{
Description: Duration of the availability blob. ,
Required: False ,
}
string ,
}
,
]
,
metricFilterPattern:
{
Description: The matching regex pattern to be applied to the field pointed by the "metricsFilterPathSelector" flag in the ARM manifest. ,
Required: False ,
}
string ,
fillGapWithZero:
{
Description: Optional property. If set to true, then zero will be returned for time duration where no metric is emitted / published. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
isDataAction:
{
Description: Gets or sets IsDataAction property. It is used to differentiate management and data plane operations. ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: Gets URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Update (removed)
Description :  Approves or rejects Private Endpoint Connection. This is a public API that can be called directly by Notification Hubs users.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Private Endpoint Connection Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Description of the Private Endpoint Connection resource. ,
Required: True ,
}
{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (removed)
Description :  Deletes the Private Endpoint Connection. This is a public API that can be called directly by Notification Hubs users.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Private Endpoint Connection Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (removed)
Description :  Returns a Private Endpoint Connection with a given name. This is a public API that can be called directly by Notification Hubs users.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Private Endpoint Connection Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_List (removed)
Description :  Returns all Private Endpoint Connections that belong to the given Notification Hubs namespace. This is a public API that can be called directly by Notification Hubs users.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateEndpointConnections
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets result of the List AuthorizationRules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Private Endpoint Connection properties. ,
Required: False ,
}
{
provisioningState:
{
Description: State of Private Endpoint Connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. ,
Required: False ,
}
{
id:
{
Description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: List of group ids. For Notification Hubs, it always contains a single "namespace" element. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: State of the Private Link Service connection. ,
Required: False ,
}
{
status:
{
Description: State of Private Link Connection. ,
Enum:
{
Disconnected: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Human-friendly description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Human-friendly description of required actions. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_GetGroupId (removed)
Description :  Even though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it's called. That's why we don't send it to the sibling RP, but process it directly in the scale unit that received the request.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateLinkResources/{subResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
subResourceName:
{
Description: Name of the Private Link sub-resource. The only supported sub-resource is "namespace" ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Represents properties of Private Link Resource. ,
Required: False ,
}
{
groupId:
{
Description: A Group Id for Private Link. For Notification Hubs, it is always set to "namespace". ,
Required: False ,
}
string ,
requiredMembers:
{
Description: Required members. For Notification Hubs, it's always a collection with a single "namespace" item. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: Required DNS zone names. For Notification Hubs, it contains two CNames for Service Bus and Notification Hubs zones. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_ListGroupIds (removed)
Description :  Even though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it's called. That's why we don't send it to the sibling RP, but process it directly in the scale unit that received the request.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateLinkResources
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets result of the List AuthorizationRules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Represents properties of Private Link Resource. ,
Required: False ,
}
{
groupId:
{
Description: A Group Id for Private Link. For Notification Hubs, it is always set to "namespace". ,
Required: False ,
}
string ,
requiredMembers:
{
Description: Required members. For Notification Hubs, it's always a collection with a single "namespace" item. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: Required DNS zone names. For Notification Hubs, it contains two CNames for Service Bus and Notification Hubs zones. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}