Microsoft.NotificationHubs (stable:2016-03-01)

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

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
{
parameters:
{
Description: The namespace name. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: True ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the created namespace ,
Required: False ,
}
{
name:
{
Description: Name of the notification hub sku ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: The Sku size ,
Required: False ,
}
string ,
family:
{
Description: The Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the resource ,
Required: False ,
}
integer ,
}
,
isAvailiable:
{
Description: True if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false. ,
Required: False ,
}
boolean ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
isAvailiable:
{
Description: True if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false. ,
Required: False ,
}
boolean ,
}
Namespaces_CreateOrUpdate (new)
Description :  Creates/Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a Namespace Resource. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Namespace. ,
Required: False ,
}
{
name:
{
Description: The name of the namespace. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
region:
{
Description: Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Id of the Azure subscription associated with the namespace. ,
Required: False ,
}
string ,
scaleUnit:
{
Description: ScaleUnit where the namespace gets created ,
Required: False ,
}
string ,
enabled:
{
Description: Whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
namespaceType:
{
Description: The namespace type. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Namespace. ,
Required: False ,
}
{
name:
{
Description: The name of the namespace. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
region:
{
Description: Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Id of the Azure subscription associated with the namespace. ,
Required: False ,
}
string ,
scaleUnit:
{
Description: ScaleUnit where the namespace gets created ,
Required: False ,
}
string ,
enabled:
{
Description: Whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
namespaceType:
{
Description: The namespace type. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Namespace. ,
Required: False ,
}
{
name:
{
Description: The name of the namespace. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
region:
{
Description: Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Id of the Azure subscription associated with the namespace. ,
Required: False ,
}
string ,
scaleUnit:
{
Description: ScaleUnit where the namespace gets created ,
Required: False ,
}
string ,
enabled:
{
Description: Whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
namespaceType:
{
Description: The namespace type. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Namespaces_Patch (new)
Description :  Patches the existing namespace
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to patch a Namespace Resource. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the created namespace ,
Required: False ,
}
{
name:
{
Description: Name of the notification hub sku ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: The Sku size ,
Required: False ,
}
string ,
family:
{
Description: The Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the resource ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Namespace. ,
Required: False ,
}
{
name:
{
Description: The name of the namespace. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
region:
{
Description: Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Id of the Azure subscription associated with the namespace. ,
Required: False ,
}
string ,
scaleUnit:
{
Description: ScaleUnit where the namespace gets created ,
Required: False ,
}
string ,
enabled:
{
Description: Whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
namespaceType:
{
Description: The namespace type. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
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}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (202)

{}
Namespaces_Get (new)
Description :  Returns the description for the specified namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Namespace. ,
Required: False ,
}
{
name:
{
Description: The name of the namespace. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
region:
{
Description: Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Id of the Azure subscription associated with the namespace. ,
Required: False ,
}
string ,
scaleUnit:
{
Description: ScaleUnit where the namespace gets created ,
Required: False ,
}
string ,
enabled:
{
Description: Whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
namespaceType:
{
Description: The namespace type. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
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}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name. ,
Required: True ,
}
string ,
parameters:
{
Description: The shared access authorization rule. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Namespace AuthorizationRules. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Namespace AuthorizationRule. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Namespaces_DeleteAuthorizationRule (new)
Description :  Deletes a namespace authorization rule
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}
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}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Namespace AuthorizationRule. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Namespaces_List (new)
Description :  Lists the available namespaces within a resourceGroup.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces
{
resourceGroupName:
{
Description: The name of the resource group. If resourceGroupName value is null the method lists all the namespaces within subscription ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Namespace operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Namespace. ,
Required: False ,
}
{
name:
{
Description: The name of the namespace. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
region:
{
Description: Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Id of the Azure subscription associated with the namespace. ,
Required: False ,
}
string ,
scaleUnit:
{
Description: ScaleUnit where the namespace gets created ,
Required: False ,
}
string ,
enabled:
{
Description: Whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
namespaceType:
{
Description: The namespace type. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Namespaces ,
Required: False ,
}
string ,
}
Namespaces_ListAll (new)
Description :  Lists all the available namespaces within the subscription irrespective of the resourceGroups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/namespaces
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Namespace operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Namespace. ,
Required: False ,
}
{
name:
{
Description: The name of the namespace. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
region:
{
Description: Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Id of the Azure subscription associated with the namespace. ,
Required: False ,
}
string ,
scaleUnit:
{
Description: ScaleUnit where the namespace gets created ,
Required: False ,
}
string ,
enabled:
{
Description: Whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
namespaceType:
{
Description: The namespace type. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Namespaces ,
Required: False ,
}
string ,
}
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
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List AuthorizationRules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Namespace AuthorizationRule. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of AuthorizationRules ,
Required: False ,
}
string ,
}
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
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The connection string of the namespace for the specified authorizationRule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: PrimaryConnectionString of the AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: SecondaryConnectionString of the created AuthorizationRule ,
Required: False ,
}
string ,
primaryKey:
{
Description: PrimaryKey of the created AuthorizationRule. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: SecondaryKey of the created AuthorizationRule ,
Required: False ,
}
string ,
keyName:
{
Description: KeyName of the created AuthorizationRule ,
Required: False ,
}
string ,
}
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
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The connection string of the namespace for the specified authorizationRule. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate the Namespace Authorization Rule Key. ,
Required: True ,
}
{
policyKey:
{
Description: Name of the key that has to be regenerated for the Namespace/Notification Hub Authorization Rule. The value can be Primary Key/Secondary Key. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: PrimaryConnectionString of the AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: SecondaryConnectionString of the created AuthorizationRule ,
Required: False ,
}
string ,
primaryKey:
{
Description: PrimaryKey of the created AuthorizationRule. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: SecondaryKey of the created AuthorizationRule ,
Required: False ,
}
string ,
keyName:
{
Description: KeyName of the created AuthorizationRule ,
Required: False ,
}
string ,
}
NotificationHubs_CheckAvailability (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
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
parameters:
{
Description: The notificationHub name. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: True ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the created namespace ,
Required: False ,
}
{
name:
{
Description: Name of the notification hub sku ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: The Sku size ,
Required: False ,
}
string ,
family:
{
Description: The Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the resource ,
Required: False ,
}
integer ,
}
,
isAvailiable:
{
Description: True if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false. ,
Required: False ,
}
boolean ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
isAvailiable:
{
Description: True if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false. ,
Required: False ,
}
boolean ,
}
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}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
notificationHubName:
{
Description: The notification hub name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create/update a NotificationHub Resource. ,
Required: True ,
}
{
properties:
{
Description: Properties of the NotificationHub. ,
Required: True ,
}
{
name:
{
Description: The NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: The RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: The AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
apnsCredential:
{
Description: The ApnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub ApnsCredential. ,
Required: False ,
}
{
apnsCertificate:
{
Description: The APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint of this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The APNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: The WnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub WnsCredential. ,
Required: False ,
}
{
packageSid:
{
Description: The package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: The secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: The Windows Live endpoint. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: The GcmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub GcmCredential. ,
Required: False ,
}
{
gcmEndpoint:
{
Description: The GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: The Google API key. ,
Required: False ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: The MpnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub MpnsCredential. ,
Required: False ,
}
{
mpnsCertificate:
{
Description: The MPNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key for this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The MPNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
admCredential:
{
Description: The AdmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub AdmCredential. ,
Required: False ,
}
{
clientId:
{
Description: The client identifier. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The credential secret access key. ,
Required: False ,
}
string ,
authTokenUrl:
{
Description: The URL of the authorization token. ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: The BaiduCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub BaiduCredential. ,
Required: False ,
}
{
baiduApiKey:
{
Description: Baidu Api Key. ,
Required: False ,
}
string ,
baiduEndPoint:
{
Description: Baidu Endpoint. ,
Required: False ,
}
string ,
baiduSecretKey:
{
Description: Baidu Secret Key ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the NotificationHub. ,
Required: False ,
}
{
name:
{
Description: The NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: The RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: The AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
apnsCredential:
{
Description: The ApnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub ApnsCredential. ,
Required: False ,
}
{
apnsCertificate:
{
Description: The APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint of this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The APNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: The WnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub WnsCredential. ,
Required: False ,
}
{
packageSid:
{
Description: The package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: The secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: The Windows Live endpoint. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: The GcmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub GcmCredential. ,
Required: False ,
}
{
gcmEndpoint:
{
Description: The GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: The Google API key. ,
Required: False ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: The MpnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub MpnsCredential. ,
Required: False ,
}
{
mpnsCertificate:
{
Description: The MPNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key for this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The MPNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
admCredential:
{
Description: The AdmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub AdmCredential. ,
Required: False ,
}
{
clientId:
{
Description: The client identifier. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The credential secret access key. ,
Required: False ,
}
string ,
authTokenUrl:
{
Description: The URL of the authorization token. ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: The BaiduCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub BaiduCredential. ,
Required: False ,
}
{
baiduApiKey:
{
Description: Baidu Api Key. ,
Required: False ,
}
string ,
baiduEndPoint:
{
Description: Baidu Endpoint. ,
Required: False ,
}
string ,
baiduSecretKey:
{
Description: Baidu Secret Key ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the NotificationHub. ,
Required: False ,
}
{
name:
{
Description: The NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: The RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: The AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
apnsCredential:
{
Description: The ApnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub ApnsCredential. ,
Required: False ,
}
{
apnsCertificate:
{
Description: The APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint of this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The APNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: The WnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub WnsCredential. ,
Required: False ,
}
{
packageSid:
{
Description: The package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: The secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: The Windows Live endpoint. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: The GcmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub GcmCredential. ,
Required: False ,
}
{
gcmEndpoint:
{
Description: The GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: The Google API key. ,
Required: False ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: The MpnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub MpnsCredential. ,
Required: False ,
}
{
mpnsCertificate:
{
Description: The MPNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key for this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The MPNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
admCredential:
{
Description: The AdmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub AdmCredential. ,
Required: False ,
}
{
clientId:
{
Description: The client identifier. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The credential secret access key. ,
Required: False ,
}
string ,
authTokenUrl:
{
Description: The URL of the authorization token. ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: The BaiduCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub BaiduCredential. ,
Required: False ,
}
{
baiduApiKey:
{
Description: Baidu Api Key. ,
Required: False ,
}
string ,
baiduEndPoint:
{
Description: Baidu Endpoint. ,
Required: False ,
}
string ,
baiduSecretKey:
{
Description: Baidu Secret Key ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
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}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
notificationHubName:
{
Description: The notification hub name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
NotificationHubs_Get (new)
Description :  Lists the notification hubs associated with a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
notificationHubName:
{
Description: The notification hub name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the NotificationHub. ,
Required: False ,
}
{
name:
{
Description: The NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: The RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: The AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
apnsCredential:
{
Description: The ApnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub ApnsCredential. ,
Required: False ,
}
{
apnsCertificate:
{
Description: The APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint of this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The APNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: The WnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub WnsCredential. ,
Required: False ,
}
{
packageSid:
{
Description: The package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: The secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: The Windows Live endpoint. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: The GcmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub GcmCredential. ,
Required: False ,
}
{
gcmEndpoint:
{
Description: The GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: The Google API key. ,
Required: False ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: The MpnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub MpnsCredential. ,
Required: False ,
}
{
mpnsCertificate:
{
Description: The MPNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key for this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The MPNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
admCredential:
{
Description: The AdmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub AdmCredential. ,
Required: False ,
}
{
clientId:
{
Description: The client identifier. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The credential secret access key. ,
Required: False ,
}
string ,
authTokenUrl:
{
Description: The URL of the authorization token. ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: The BaiduCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub BaiduCredential. ,
Required: False ,
}
{
baiduApiKey:
{
Description: Baidu Api Key. ,
Required: False ,
}
string ,
baiduEndPoint:
{
Description: Baidu Endpoint. ,
Required: False ,
}
string ,
baiduSecretKey:
{
Description: Baidu Secret Key ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
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}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
notificationHubName:
{
Description: The notification hub name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name. ,
Required: True ,
}
string ,
parameters:
{
Description: The shared access authorization rule. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Namespace AuthorizationRules. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Namespace AuthorizationRule. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
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}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
notificationHubName:
{
Description: The notification hub name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}
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}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: The notification hub name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Namespace AuthorizationRule. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
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
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List NotificationHub operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the NotificationHub. ,
Required: False ,
}
{
name:
{
Description: The NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: The RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: The AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
apnsCredential:
{
Description: The ApnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub ApnsCredential. ,
Required: False ,
}
{
apnsCertificate:
{
Description: The APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint of this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The APNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: The WnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub WnsCredential. ,
Required: False ,
}
{
packageSid:
{
Description: The package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: The secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: The Windows Live endpoint. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: The GcmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub GcmCredential. ,
Required: False ,
}
{
gcmEndpoint:
{
Description: The GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: The Google API key. ,
Required: False ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: The MpnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub MpnsCredential. ,
Required: False ,
}
{
mpnsCertificate:
{
Description: The MPNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key for this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The MPNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
admCredential:
{
Description: The AdmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub AdmCredential. ,
Required: False ,
}
{
clientId:
{
Description: The client identifier. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The credential secret access key. ,
Required: False ,
}
string ,
authTokenUrl:
{
Description: The URL of the authorization token. ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: The BaiduCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub BaiduCredential. ,
Required: False ,
}
{
baiduApiKey:
{
Description: Baidu Api Key. ,
Required: False ,
}
string ,
baiduEndPoint:
{
Description: Baidu Endpoint. ,
Required: False ,
}
string ,
baiduSecretKey:
{
Description: Baidu Secret Key ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of NotificationHub ,
Required: False ,
}
string ,
}
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
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: The notification hub name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List AuthorizationRules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Namespace AuthorizationRule. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of AuthorizationRules ,
Required: False ,
}
string ,
}
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
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
notificationHubName:
{
Description: The notification hub name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The connection string of the NotificationHub for the specified authorizationRule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: PrimaryConnectionString of the AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: SecondaryConnectionString of the created AuthorizationRule ,
Required: False ,
}
string ,
primaryKey:
{
Description: PrimaryKey of the created AuthorizationRule. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: SecondaryKey of the created AuthorizationRule ,
Required: False ,
}
string ,
keyName:
{
Description: KeyName of the created AuthorizationRule ,
Required: False ,
}
string ,
}
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
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
notificationHubName:
{
Description: The notification hub name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The connection string of the NotificationHub for the specified authorizationRule. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate the NotificationHub Authorization Rule Key. ,
Required: True ,
}
{
policyKey:
{
Description: Name of the key that has to be regenerated for the Namespace/Notification Hub Authorization Rule. The value can be Primary Key/Secondary Key. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: PrimaryConnectionString of the AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: SecondaryConnectionString of the created AuthorizationRule ,
Required: False ,
}
string ,
primaryKey:
{
Description: PrimaryKey of the created AuthorizationRule. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: SecondaryKey of the created AuthorizationRule ,
Required: False ,
}
string ,
keyName:
{
Description: KeyName of the created AuthorizationRule ,
Required: False ,
}
string ,
}
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
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
notificationHubName:
{
Description: The notification hub name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: NotificationHub PNS Credentials. ,
Required: False ,
}
{
apnsCredential:
{
Description: The ApnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub ApnsCredential. ,
Required: False ,
}
{
apnsCertificate:
{
Description: The APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint of this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The APNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: The WnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub WnsCredential. ,
Required: False ,
}
{
packageSid:
{
Description: The package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: The secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: The Windows Live endpoint. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: The GcmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub GcmCredential. ,
Required: False ,
}
{
gcmEndpoint:
{
Description: The GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: The Google API key. ,
Required: False ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: The MpnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub MpnsCredential. ,
Required: False ,
}
{
mpnsCertificate:
{
Description: The MPNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key for this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The MPNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
admCredential:
{
Description: The AdmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub AdmCredential. ,
Required: False ,
}
{
clientId:
{
Description: The client identifier. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The credential secret access key. ,
Required: False ,
}
string ,
authTokenUrl:
{
Description: The URL of the authorization token. ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: The BaiduCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub BaiduCredential. ,
Required: False ,
}
{
baiduApiKey:
{
Description: Baidu Api Key. ,
Required: False ,
}
string ,
baiduEndPoint:
{
Description: Baidu Endpoint. ,
Required: False ,
}
string ,
baiduSecretKey:
{
Description: Baidu Secret Key ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
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
{
parameters:
{
Description: The namespace name. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: True ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the created namespace ,
Required: False ,
}
{
name:
{
Description: Name of the notification hub sku ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: The Sku size ,
Required: False ,
}
string ,
family:
{
Description: The Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the resource ,
Required: False ,
}
integer ,
}
,
isAvailiable:
{
Description: True if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false. ,
Required: False ,
}
boolean ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
isAvailiable:
{
Description: True if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false. ,
Required: False ,
}
boolean ,
}
Namespaces_CreateOrUpdate (removed)
Description :  Creates/Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a Namespace Resource. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Namespace. ,
Required: False ,
}
{
name:
{
Description: The name of the namespace. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
region:
{
Description: Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Id of the Azure subscription associated with the namespace. ,
Required: False ,
}
string ,
scaleUnit:
{
Description: ScaleUnit where the namespace gets created ,
Required: False ,
}
string ,
enabled:
{
Description: Whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
namespaceType:
{
Description: The namespace type. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Namespace. ,
Required: False ,
}
{
name:
{
Description: The name of the namespace. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
region:
{
Description: Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Id of the Azure subscription associated with the namespace. ,
Required: False ,
}
string ,
scaleUnit:
{
Description: ScaleUnit where the namespace gets created ,
Required: False ,
}
string ,
enabled:
{
Description: Whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
namespaceType:
{
Description: The namespace type. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Namespace. ,
Required: False ,
}
{
name:
{
Description: The name of the namespace. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
region:
{
Description: Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Id of the Azure subscription associated with the namespace. ,
Required: False ,
}
string ,
scaleUnit:
{
Description: ScaleUnit where the namespace gets created ,
Required: False ,
}
string ,
enabled:
{
Description: Whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
namespaceType:
{
Description: The namespace type. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Namespaces_Patch (removed)
Description :  Patches the existing namespace
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to patch a Namespace Resource. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the created namespace ,
Required: False ,
}
{
name:
{
Description: Name of the notification hub sku ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: The Sku size ,
Required: False ,
}
string ,
family:
{
Description: The Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the resource ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Namespace. ,
Required: False ,
}
{
name:
{
Description: The name of the namespace. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
region:
{
Description: Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Id of the Azure subscription associated with the namespace. ,
Required: False ,
}
string ,
scaleUnit:
{
Description: ScaleUnit where the namespace gets created ,
Required: False ,
}
string ,
enabled:
{
Description: Whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
namespaceType:
{
Description: The namespace type. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
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}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (202)

{}
Namespaces_Get (removed)
Description :  Returns the description for the specified namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Namespace. ,
Required: False ,
}
{
name:
{
Description: The name of the namespace. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
region:
{
Description: Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Id of the Azure subscription associated with the namespace. ,
Required: False ,
}
string ,
scaleUnit:
{
Description: ScaleUnit where the namespace gets created ,
Required: False ,
}
string ,
enabled:
{
Description: Whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
namespaceType:
{
Description: The namespace type. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
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}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name. ,
Required: True ,
}
string ,
parameters:
{
Description: The shared access authorization rule. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Namespace AuthorizationRules. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Namespace AuthorizationRule. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Namespaces_DeleteAuthorizationRule (removed)
Description :  Deletes a namespace authorization rule
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}
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}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Namespace AuthorizationRule. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Namespaces_List (removed)
Description :  Lists the available namespaces within a resourceGroup.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces
{
resourceGroupName:
{
Description: The name of the resource group. If resourceGroupName value is null the method lists all the namespaces within subscription ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Namespace operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Namespace. ,
Required: False ,
}
{
name:
{
Description: The name of the namespace. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
region:
{
Description: Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Id of the Azure subscription associated with the namespace. ,
Required: False ,
}
string ,
scaleUnit:
{
Description: ScaleUnit where the namespace gets created ,
Required: False ,
}
string ,
enabled:
{
Description: Whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
namespaceType:
{
Description: The namespace type. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Namespaces ,
Required: False ,
}
string ,
}
Namespaces_ListAll (removed)
Description :  Lists all the available namespaces within the subscription irrespective of the resourceGroups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/namespaces
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Namespace operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Namespace. ,
Required: False ,
}
{
name:
{
Description: The name of the namespace. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
region:
{
Description: Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe ,
Required: False ,
}
string ,
status:
{
Description: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform NotificationHub operations. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Id of the Azure subscription associated with the namespace. ,
Required: False ,
}
string ,
scaleUnit:
{
Description: ScaleUnit where the namespace gets created ,
Required: False ,
}
string ,
enabled:
{
Description: Whether or not the namespace is currently enabled. ,
Required: False ,
}
boolean ,
critical:
{
Description: Whether or not the namespace is set as Critical. ,
Required: False ,
}
boolean ,
namespaceType:
{
Description: The namespace type. ,
Enum:
{
Messaging: No description available. ,
NotificationHub: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Namespaces ,
Required: False ,
}
string ,
}
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
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List AuthorizationRules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Namespace AuthorizationRule. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of AuthorizationRules ,
Required: False ,
}
string ,
}
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
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The connection string of the namespace for the specified authorizationRule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: PrimaryConnectionString of the AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: SecondaryConnectionString of the created AuthorizationRule ,
Required: False ,
}
string ,
primaryKey:
{
Description: PrimaryKey of the created AuthorizationRule. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: SecondaryKey of the created AuthorizationRule ,
Required: False ,
}
string ,
keyName:
{
Description: KeyName of the created AuthorizationRule ,
Required: False ,
}
string ,
}
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
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The connection string of the namespace for the specified authorizationRule. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate the Namespace Authorization Rule Key. ,
Required: True ,
}
{
policyKey:
{
Description: Name of the key that has to be regenerated for the Namespace/Notification Hub Authorization Rule. The value can be Primary Key/Secondary Key. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: PrimaryConnectionString of the AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: SecondaryConnectionString of the created AuthorizationRule ,
Required: False ,
}
string ,
primaryKey:
{
Description: PrimaryKey of the created AuthorizationRule. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: SecondaryKey of the created AuthorizationRule ,
Required: False ,
}
string ,
keyName:
{
Description: KeyName of the created AuthorizationRule ,
Required: False ,
}
string ,
}
NotificationHubs_CheckAvailability (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
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
parameters:
{
Description: The notificationHub name. ,
Required: True ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: True ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
location:
{
Description: Resource location ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the created namespace ,
Required: False ,
}
{
name:
{
Description: Name of the notification hub sku ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of particular sku ,
Required: False ,
}
string ,
size:
{
Description: The Sku size ,
Required: False ,
}
string ,
family:
{
Description: The Sku Family ,
Required: False ,
}
string ,
capacity:
{
Description: The capacity of the resource ,
Required: False ,
}
integer ,
}
,
isAvailiable:
{
Description: True if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false. ,
Required: False ,
}
boolean ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
isAvailiable:
{
Description: True if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false. ,
Required: False ,
}
boolean ,
}
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}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
notificationHubName:
{
Description: The notification hub name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create/update a NotificationHub Resource. ,
Required: True ,
}
{
properties:
{
Description: Properties of the NotificationHub. ,
Required: True ,
}
{
name:
{
Description: The NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: The RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: The AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
apnsCredential:
{
Description: The ApnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub ApnsCredential. ,
Required: False ,
}
{
apnsCertificate:
{
Description: The APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint of this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The APNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: The WnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub WnsCredential. ,
Required: False ,
}
{
packageSid:
{
Description: The package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: The secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: The Windows Live endpoint. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: The GcmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub GcmCredential. ,
Required: False ,
}
{
gcmEndpoint:
{
Description: The GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: The Google API key. ,
Required: False ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: The MpnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub MpnsCredential. ,
Required: False ,
}
{
mpnsCertificate:
{
Description: The MPNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key for this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The MPNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
admCredential:
{
Description: The AdmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub AdmCredential. ,
Required: False ,
}
{
clientId:
{
Description: The client identifier. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The credential secret access key. ,
Required: False ,
}
string ,
authTokenUrl:
{
Description: The URL of the authorization token. ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: The BaiduCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub BaiduCredential. ,
Required: False ,
}
{
baiduApiKey:
{
Description: Baidu Api Key. ,
Required: False ,
}
string ,
baiduEndPoint:
{
Description: Baidu Endpoint. ,
Required: False ,
}
string ,
baiduSecretKey:
{
Description: Baidu Secret Key ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the NotificationHub. ,
Required: False ,
}
{
name:
{
Description: The NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: The RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: The AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
apnsCredential:
{
Description: The ApnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub ApnsCredential. ,
Required: False ,
}
{
apnsCertificate:
{
Description: The APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint of this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The APNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: The WnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub WnsCredential. ,
Required: False ,
}
{
packageSid:
{
Description: The package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: The secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: The Windows Live endpoint. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: The GcmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub GcmCredential. ,
Required: False ,
}
{
gcmEndpoint:
{
Description: The GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: The Google API key. ,
Required: False ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: The MpnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub MpnsCredential. ,
Required: False ,
}
{
mpnsCertificate:
{
Description: The MPNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key for this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The MPNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
admCredential:
{
Description: The AdmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub AdmCredential. ,
Required: False ,
}
{
clientId:
{
Description: The client identifier. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The credential secret access key. ,
Required: False ,
}
string ,
authTokenUrl:
{
Description: The URL of the authorization token. ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: The BaiduCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub BaiduCredential. ,
Required: False ,
}
{
baiduApiKey:
{
Description: Baidu Api Key. ,
Required: False ,
}
string ,
baiduEndPoint:
{
Description: Baidu Endpoint. ,
Required: False ,
}
string ,
baiduSecretKey:
{
Description: Baidu Secret Key ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the NotificationHub. ,
Required: False ,
}
{
name:
{
Description: The NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: The RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: The AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
apnsCredential:
{
Description: The ApnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub ApnsCredential. ,
Required: False ,
}
{
apnsCertificate:
{
Description: The APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint of this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The APNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: The WnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub WnsCredential. ,
Required: False ,
}
{
packageSid:
{
Description: The package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: The secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: The Windows Live endpoint. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: The GcmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub GcmCredential. ,
Required: False ,
}
{
gcmEndpoint:
{
Description: The GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: The Google API key. ,
Required: False ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: The MpnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub MpnsCredential. ,
Required: False ,
}
{
mpnsCertificate:
{
Description: The MPNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key for this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The MPNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
admCredential:
{
Description: The AdmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub AdmCredential. ,
Required: False ,
}
{
clientId:
{
Description: The client identifier. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The credential secret access key. ,
Required: False ,
}
string ,
authTokenUrl:
{
Description: The URL of the authorization token. ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: The BaiduCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub BaiduCredential. ,
Required: False ,
}
{
baiduApiKey:
{
Description: Baidu Api Key. ,
Required: False ,
}
string ,
baiduEndPoint:
{
Description: Baidu Endpoint. ,
Required: False ,
}
string ,
baiduSecretKey:
{
Description: Baidu Secret Key ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
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}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
notificationHubName:
{
Description: The notification hub name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
NotificationHubs_Get (removed)
Description :  Lists the notification hubs associated with a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
notificationHubName:
{
Description: The notification hub name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the NotificationHub. ,
Required: False ,
}
{
name:
{
Description: The NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: The RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: The AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
apnsCredential:
{
Description: The ApnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub ApnsCredential. ,
Required: False ,
}
{
apnsCertificate:
{
Description: The APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint of this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The APNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: The WnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub WnsCredential. ,
Required: False ,
}
{
packageSid:
{
Description: The package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: The secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: The Windows Live endpoint. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: The GcmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub GcmCredential. ,
Required: False ,
}
{
gcmEndpoint:
{
Description: The GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: The Google API key. ,
Required: False ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: The MpnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub MpnsCredential. ,
Required: False ,
}
{
mpnsCertificate:
{
Description: The MPNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key for this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The MPNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
admCredential:
{
Description: The AdmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub AdmCredential. ,
Required: False ,
}
{
clientId:
{
Description: The client identifier. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The credential secret access key. ,
Required: False ,
}
string ,
authTokenUrl:
{
Description: The URL of the authorization token. ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: The BaiduCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub BaiduCredential. ,
Required: False ,
}
{
baiduApiKey:
{
Description: Baidu Api Key. ,
Required: False ,
}
string ,
baiduEndPoint:
{
Description: Baidu Endpoint. ,
Required: False ,
}
string ,
baiduSecretKey:
{
Description: Baidu Secret Key ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
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}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
notificationHubName:
{
Description: The notification hub name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name. ,
Required: True ,
}
string ,
parameters:
{
Description: The shared access authorization rule. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Namespace AuthorizationRules. ,
Required: True ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Namespace AuthorizationRule. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
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}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
notificationHubName:
{
Description: The notification hub name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: Authorization Rule Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}
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}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: The notification hub name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Namespace AuthorizationRule. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
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
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List NotificationHub operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the NotificationHub. ,
Required: False ,
}
{
name:
{
Description: The NotificationHub name. ,
Required: False ,
}
string ,
registrationTtl:
{
Description: The RegistrationTtl of the created NotificationHub ,
Required: False ,
}
string ,
authorizationRules:
{
Description: The AuthorizationRules of the created NotificationHub ,
Required: False ,
}
[
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
apnsCredential:
{
Description: The ApnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub ApnsCredential. ,
Required: False ,
}
{
apnsCertificate:
{
Description: The APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint of this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The APNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: The WnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub WnsCredential. ,
Required: False ,
}
{
packageSid:
{
Description: The package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: The secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: The Windows Live endpoint. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: The GcmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub GcmCredential. ,
Required: False ,
}
{
gcmEndpoint:
{
Description: The GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: The Google API key. ,
Required: False ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: The MpnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub MpnsCredential. ,
Required: False ,
}
{
mpnsCertificate:
{
Description: The MPNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key for this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The MPNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
admCredential:
{
Description: The AdmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub AdmCredential. ,
Required: False ,
}
{
clientId:
{
Description: The client identifier. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The credential secret access key. ,
Required: False ,
}
string ,
authTokenUrl:
{
Description: The URL of the authorization token. ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: The BaiduCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub BaiduCredential. ,
Required: False ,
}
{
baiduApiKey:
{
Description: Baidu Api Key. ,
Required: False ,
}
string ,
baiduEndPoint:
{
Description: Baidu Endpoint. ,
Required: False ,
}
string ,
baiduSecretKey:
{
Description: Baidu Secret Key ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of NotificationHub ,
Required: False ,
}
string ,
}
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
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
notificationHubName:
{
Description: The notification hub name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List AuthorizationRules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Namespace AuthorizationRule. ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of AuthorizationRules ,
Required: False ,
}
string ,
}
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
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
notificationHubName:
{
Description: The notification hub name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The connection string of the NotificationHub for the specified authorizationRule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: PrimaryConnectionString of the AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: SecondaryConnectionString of the created AuthorizationRule ,
Required: False ,
}
string ,
primaryKey:
{
Description: PrimaryKey of the created AuthorizationRule. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: SecondaryKey of the created AuthorizationRule ,
Required: False ,
}
string ,
keyName:
{
Description: KeyName of the created AuthorizationRule ,
Required: False ,
}
string ,
}
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
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
notificationHubName:
{
Description: The notification hub name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The connection string of the NotificationHub for the specified authorizationRule. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate the NotificationHub Authorization Rule Key. ,
Required: True ,
}
{
policyKey:
{
Description: Name of the key that has to be regenerated for the Namespace/Notification Hub Authorization Rule. The value can be Primary Key/Secondary Key. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: PrimaryConnectionString of the AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: SecondaryConnectionString of the created AuthorizationRule ,
Required: False ,
}
string ,
primaryKey:
{
Description: PrimaryKey of the created AuthorizationRule. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: SecondaryKey of the created AuthorizationRule ,
Required: False ,
}
string ,
keyName:
{
Description: KeyName of the created AuthorizationRule ,
Required: False ,
}
string ,
}
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
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
notificationHubName:
{
Description: The notification hub name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: NotificationHub PNS Credentials. ,
Required: False ,
}
{
apnsCredential:
{
Description: The ApnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub ApnsCredential. ,
Required: False ,
}
{
apnsCertificate:
{
Description: The APNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key. ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint of this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The APNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
wnsCredential:
{
Description: The WnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub WnsCredential. ,
Required: False ,
}
{
packageSid:
{
Description: The package ID for this credential. ,
Required: False ,
}
string ,
secretKey:
{
Description: The secret key. ,
Required: False ,
}
string ,
windowsLiveEndpoint:
{
Description: The Windows Live endpoint. ,
Required: False ,
}
string ,
}
,
}
,
gcmCredential:
{
Description: The GcmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub GcmCredential. ,
Required: False ,
}
{
gcmEndpoint:
{
Description: The GCM endpoint. ,
Required: False ,
}
string ,
googleApiKey:
{
Description: The Google API key. ,
Required: False ,
}
string ,
}
,
}
,
mpnsCredential:
{
Description: The MpnsCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub MpnsCredential. ,
Required: False ,
}
{
mpnsCertificate:
{
Description: The MPNS certificate. ,
Required: False ,
}
string ,
certificateKey:
{
Description: The certificate key for this credential. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The MPNS certificate Thumbprint ,
Required: False ,
}
string ,
}
,
}
,
admCredential:
{
Description: The AdmCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub AdmCredential. ,
Required: False ,
}
{
clientId:
{
Description: The client identifier. ,
Required: False ,
}
string ,
clientSecret:
{
Description: The credential secret access key. ,
Required: False ,
}
string ,
authTokenUrl:
{
Description: The URL of the authorization token. ,
Required: False ,
}
string ,
}
,
}
,
baiduCredential:
{
Description: The BaiduCredential of the created NotificationHub ,
Required: False ,
}
{
properties:
{
Description: Properties of NotificationHub BaiduCredential. ,
Required: False ,
}
{
baiduApiKey:
{
Description: Baidu Api Key. ,
Required: False ,
}
string ,
baiduEndPoint:
{
Description: Baidu Endpoint. ,
Required: False ,
}
string ,
baiduSecretKey:
{
Description: Baidu Secret Key ,
Required: False ,
}
string ,
}
,
}
,
}
,
}