Microsoft.NotificationHubs (preview:2023-10-01)

2025/07/04 • 28 updated methods

Operations_List (updated)
Description :  List the operations for the provider
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "$responses": {
    "200": {
      "Description": {
        "new": "Paged collection of Operation items",
        "old": "Result of the request to list NotificationHubs operations. It contains\r\na list of operations and a URL link to get the next set of results."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Operation items on this page",
            "old": "Gets list of NotificationHubs operations supported by the\r\nMicrosoft.NotificationHubs resource provider."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "Description": {
              "new": "Result of the request to list SQL operations.",
              "old": "A NotificationHubs REST API operation"
            },
            "$properties": [
              {
                "#name": "name",
                "Description": {
                  "new": "The name of the operation being performed on this particular object.\"",
                  "old": "Gets operation name: {provider}/{resource}/{operation}"
                }
              },
              {
                "#name": "display",
                "Description": {
                  "new": "he localized display information for this particular operation / action.",
                  "old": "The object that represents the operation."
                },
                "$properties": [
                  {
                    "#name": "provider",
                    "Description": {
                      "new": "The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\".",
                      "old": "Gets service provider: Microsoft.NotificationHubs"
                    }
                  },
                  {
                    "#name": "resource",
                    "Description": {
                      "new": "The localized friendly name of the resource type related to this operation. E.g. \"Virtual Machines\" or \"Job Schedule Collections\".",
                      "old": "Gets resource on which the operation is performed: Invoice, etc."
                    }
                  },
                  {
                    "#name": "operation",
                    "Description": {
                      "new": "The concise, localized friendly name for the operation; suitable for dropdowns. E.g. \"Create or Update Virtual Machine\", \"Restart Virtual Machine\".",
                      "old": "Gets operation type: Read, write, delete, etc."
                    }
                  },
                  {
                    "#name": "description",
                    "Description": {
                      "new": "The short, localized friendly description of the operation; suitable for tool tips and detailed views.",
                      "old": "Human-friendly operation description."
                    }
                  }
                ]
              },
              {
                "#name": "isDataAction",
                "Description": {
                  "new": "The intended executor of the operation.\"",
                  "old": "Gets or sets IsDataAction property. It is used to differentiate management and data plane operations."
                }
              },
              {
                "#name": "properties",
                "Description": {
                  "new": "Additional descriptions for the operation.",
                  "old": "Optional operation properties."
                }
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Gets URL to get the next set of operation list results if there are\r\nany."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.NotificationHubs/operations
{
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
name: string ,
display:
{
provider: string ,
resource: string ,
operation: string ,
description: string ,
}
,
isDataAction: boolean ,
properties:
{
serviceSpecification:
{
logSpecifications:
[
{
name: string ,
displayName: string ,
blobDuration: string ,
categoryGroups:
[
string ,
]
,
}
,
]
,
metricSpecifications:
[
{
name: string ,
displayName: string ,
displayDescription: string ,
unit: string ,
aggregationType: string ,
availabilities:
[
{
timeGrain: string ,
blobDuration: string ,
}
,
]
,
supportedTimeGrainTypes:
[
string ,
]
,
metricFilterPattern: string ,
fillGapWithZero: boolean ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Namespaces_CheckAvailability (updated)
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 ¶

⚶ Changes

{
  "#id": "Namespaces_CheckAvailability",
  "$parameters": [
    {
      "#name": "parameters",
      "Description": {
        "new": "The request body",
        "old": "Request content."
      },
      "$schema": {
        "Description": {
          "new": "Parameters supplied to the Check Name Availability for Namespace and\nNotificationHubs.",
          "old": "Parameters supplied to the Check Name Availability for Namespace and\r\nNotificationHubs."
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "isAvailiable",
          "Description": {
            "new": "Gets or sets true if the name is available and can be used to\ncreate new Namespace/NotificationHub. Otherwise false.",
            "old": "Gets or sets true if the name is available and can be used to\r\ncreate new Namespace/NotificationHub. Otherwise false."
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/checkNamespaceAvailability
{
api-version: string ,
subscriptionId: string ,
parameters:
{
id: string ,
name: string ,
type: string ,
location: string ,
tags: object ,
isAvailiable: boolean ,
sku:
{
name: enum ,
tier: string ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
}

⚐ Response (200)

{
isAvailiable: boolean ,
location: string ,
tags: object ,
sku:
{
name: enum ,
tier: string ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Namespaces_ListAll",
  "$responses": {
    "200": {
      "Description": {
        "new": "Paged collection of NamespaceResource items",
        "old": "The response of the List Namespace operation."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The NamespaceResource items on this page",
            "old": "Gets or sets result of the List AuthorizationRules operation."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "name",
                  "Description": {
                    "new": "Name of the Notification Hubs namespace. This is immutable property, set automatically\nby the service when the namespace is created.",
                    "old": "Name of the Notification Hubs namespace. This is immutable property, set automatically \r\nby the service when the namespace is created."
                  }
                },
                {
                  "#name": "region",
                  "Description": {
                    "new": "Region. The value is always set to the same value as Namespace.Location, so we are deprecating\nthis property.",
                    "old": "Region. The value is always set to the same value as Namespace.Location, so we are deprecating\r\nthis property."
                  }
                },
                {
                  "pnsCredentials": [
                    {
                      "apnsCredential": [
                        {
                          "properties": [
                            {
                              "#name": "keyId",
                              "Description": {
                                "new": "Gets or sets a 10-character key identifier (kid) key, obtained from\nyour developer account",
                                "old": "Gets or sets a 10-character key identifier (kid) key, obtained from\r\nyour developer account"
                              }
                            },
                            {
                              "#name": "appId",
                              "Description": {
                                "new": "Gets or sets the issuer (iss) registered claim key, whose value is\nyour 10-character Team ID, obtained from your developer account",
                                "old": "Gets or sets the issuer (iss) registered claim key, whose value is\r\nyour 10-character Team ID, obtained from your developer account"
                              }
                            },
                            {
                              "#name": "token",
                              "Description": {
                                "new": "Gets or sets provider Authentication Token, obtained through your\ndeveloper account",
                                "old": "Gets or sets provider Authentication Token, obtained through your\r\ndeveloper account"
                              }
                            }
                          ]
                        }
                      ]
                    }
                  ]
                },
                {
                  "#name": "serviceBusEndpoint",
                  "Description": {
                    "new": "Gets or sets endpoint you can use to perform NotificationHub\noperations.",
                    "old": "Gets or sets endpoint you can use to perform NotificationHub\r\noperations."
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Gets or sets link to the next set of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/namespaces
{
api-version: string ,
subscriptionId: string ,
$skipToken: string ,
$top: integer ,
}

⚐ Response (200)

{
value:
[
{
sku:
{
name: enum ,
tier: string ,
size: string ,
family: string ,
capacity: integer ,
}
,
properties:
{
name: string ,
provisioningState: enum ,
status: enum ,
enabled: boolean ,
critical: boolean ,
subscriptionId: string ,
region: string ,
metricId: string ,
createdAt: string ,
updatedAt: string ,
namespaceType: enum ,
replicationRegion: enum ,
zoneRedundancy: enum ,
networkAcls:
{
ipRules:
[
{
ipMask: string ,
rights:
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
rights:
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
admCredential:
{
properties:
{
clientId: string ,
clientSecret: string ,
authTokenUrl: string ,
}
,
}
,
apnsCredential:
{
properties:
{
apnsCertificate: string ,
certificateKey: string ,
endpoint: string ,
thumbprint: string ,
keyId: string ,
appName: string ,
appId: string ,
token: string ,
}
,
}
,
baiduCredential:
{
properties:
{
baiduApiKey: string ,
baiduEndPoint: string ,
baiduSecretKey: string ,
}
,
}
,
browserCredential:
{
properties:
{
subject: string ,
vapidPrivateKey: string ,
vapidPublicKey: string ,
}
,
}
,
gcmCredential:
{
properties:
{
gcmEndpoint: string ,
googleApiKey: string ,
}
,
}
,
mpnsCredential:
{
properties:
{
mpnsCertificate: string ,
certificateKey: string ,
thumbprint: string ,
}
,
}
,
wnsCredential:
{
properties:
{
packageSid: string ,
secretKey: string ,
windowsLiveEndpoint: string ,
certificateKey: string ,
wnsCertificate: string ,
}
,
}
,
xiaomiCredential:
{
properties:
{
appSecret: string ,
endpoint: string ,
}
,
}
,
fcmV1Credential:
{
properties:
{
clientEmail: string ,
privateKey: string ,
projectId: string ,
}
,
}
,
}
,
serviceBusEndpoint: string ,
privateEndpointConnections:
[
{
properties:
{
provisioningState: enum ,
privateEndpoint:
{
id: string ,
}
,
groupIds:
[
string ,
]
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
}
,
}
,
]
,
scaleUnit: string ,
dataCenter: string ,
publicNetworkAccess: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Namespaces_List",
  "$responses": {
    "200": {
      "Description": {
        "new": "Paged collection of NamespaceResource items",
        "old": "The response of the List Namespace operation."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The NamespaceResource items on this page",
            "old": "Gets or sets result of the List AuthorizationRules operation."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "name",
                  "Description": {
                    "new": "Name of the Notification Hubs namespace. This is immutable property, set automatically\nby the service when the namespace is created.",
                    "old": "Name of the Notification Hubs namespace. This is immutable property, set automatically \r\nby the service when the namespace is created."
                  }
                },
                {
                  "#name": "region",
                  "Description": {
                    "new": "Region. The value is always set to the same value as Namespace.Location, so we are deprecating\nthis property.",
                    "old": "Region. The value is always set to the same value as Namespace.Location, so we are deprecating\r\nthis property."
                  }
                },
                {
                  "pnsCredentials": [
                    {
                      "apnsCredential": [
                        {
                          "properties": [
                            {
                              "#name": "keyId",
                              "Description": {
                                "new": "Gets or sets a 10-character key identifier (kid) key, obtained from\nyour developer account",
                                "old": "Gets or sets a 10-character key identifier (kid) key, obtained from\r\nyour developer account"
                              }
                            },
                            {
                              "#name": "appId",
                              "Description": {
                                "new": "Gets or sets the issuer (iss) registered claim key, whose value is\nyour 10-character Team ID, obtained from your developer account",
                                "old": "Gets or sets the issuer (iss) registered claim key, whose value is\r\nyour 10-character Team ID, obtained from your developer account"
                              }
                            },
                            {
                              "#name": "token",
                              "Description": {
                                "new": "Gets or sets provider Authentication Token, obtained through your\ndeveloper account",
                                "old": "Gets or sets provider Authentication Token, obtained through your\r\ndeveloper account"
                              }
                            }
                          ]
                        }
                      ]
                    }
                  ]
                },
                {
                  "#name": "serviceBusEndpoint",
                  "Description": {
                    "new": "Gets or sets endpoint you can use to perform NotificationHub\noperations.",
                    "old": "Gets or sets endpoint you can use to perform NotificationHub\r\noperations."
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Gets or sets link to the next set of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
$skipToken: string ,
$top: integer ,
}

⚐ Response (200)

{
value:
[
{
sku:
{
name: enum ,
tier: string ,
size: string ,
family: string ,
capacity: integer ,
}
,
properties:
{
name: string ,
provisioningState: enum ,
status: enum ,
enabled: boolean ,
critical: boolean ,
subscriptionId: string ,
region: string ,
metricId: string ,
createdAt: string ,
updatedAt: string ,
namespaceType: enum ,
replicationRegion: enum ,
zoneRedundancy: enum ,
networkAcls:
{
ipRules:
[
{
ipMask: string ,
rights:
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
rights:
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
admCredential:
{
properties:
{
clientId: string ,
clientSecret: string ,
authTokenUrl: string ,
}
,
}
,
apnsCredential:
{
properties:
{
apnsCertificate: string ,
certificateKey: string ,
endpoint: string ,
thumbprint: string ,
keyId: string ,
appName: string ,
appId: string ,
token: string ,
}
,
}
,
baiduCredential:
{
properties:
{
baiduApiKey: string ,
baiduEndPoint: string ,
baiduSecretKey: string ,
}
,
}
,
browserCredential:
{
properties:
{
subject: string ,
vapidPrivateKey: string ,
vapidPublicKey: string ,
}
,
}
,
gcmCredential:
{
properties:
{
gcmEndpoint: string ,
googleApiKey: string ,
}
,
}
,
mpnsCredential:
{
properties:
{
mpnsCertificate: string ,
certificateKey: string ,
thumbprint: string ,
}
,
}
,
wnsCredential:
{
properties:
{
packageSid: string ,
secretKey: string ,
windowsLiveEndpoint: string ,
certificateKey: string ,
wnsCertificate: string ,
}
,
}
,
xiaomiCredential:
{
properties:
{
appSecret: string ,
endpoint: string ,
}
,
}
,
fcmV1Credential:
{
properties:
{
clientEmail: string ,
privateKey: string ,
projectId: string ,
}
,
}
,
}
,
serviceBusEndpoint: string ,
privateEndpointConnections:
[
{
properties:
{
provisioningState: enum ,
privateEndpoint:
{
id: string ,
}
,
groupIds:
[
string ,
]
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
}
,
}
,
]
,
scaleUnit: string ,
dataCenter: string ,
publicNetworkAccess: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Namespaces_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "name",
            "Description": {
              "new": "Name of the Notification Hubs namespace. This is immutable property, set automatically\nby the service when the namespace is created.",
              "old": "Name of the Notification Hubs namespace. This is immutable property, set automatically \r\nby the service when the namespace is created."
            }
          },
          {
            "#name": "region",
            "Description": {
              "new": "Region. The value is always set to the same value as Namespace.Location, so we are deprecating\nthis property.",
              "old": "Region. The value is always set to the same value as Namespace.Location, so we are deprecating\r\nthis property."
            }
          },
          {
            "pnsCredentials": [
              {
                "apnsCredential": [
                  {
                    "properties": [
                      {
                        "#name": "keyId",
                        "Description": {
                          "new": "Gets or sets a 10-character key identifier (kid) key, obtained from\nyour developer account",
                          "old": "Gets or sets a 10-character key identifier (kid) key, obtained from\r\nyour developer account"
                        }
                      },
                      {
                        "#name": "appId",
                        "Description": {
                          "new": "Gets or sets the issuer (iss) registered claim key, whose value is\nyour 10-character Team ID, obtained from your developer account",
                          "old": "Gets or sets the issuer (iss) registered claim key, whose value is\r\nyour 10-character Team ID, obtained from your developer account"
                        }
                      },
                      {
                        "#name": "token",
                        "Description": {
                          "new": "Gets or sets provider Authentication Token, obtained through your\ndeveloper account",
                          "old": "Gets or sets provider Authentication Token, obtained through your\r\ndeveloper account"
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "#name": "serviceBusEndpoint",
            "Description": {
              "new": "Gets or sets endpoint you can use to perform NotificationHub\noperations.",
              "old": "Gets or sets endpoint you can use to perform NotificationHub\r\noperations."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
}

⚐ Response (200)

{
sku:
{
name: enum ,
tier: string ,
size: string ,
family: string ,
capacity: integer ,
}
,
properties:
{
name: string ,
provisioningState: enum ,
status: enum ,
enabled: boolean ,
critical: boolean ,
subscriptionId: string ,
region: string ,
metricId: string ,
createdAt: string ,
updatedAt: string ,
namespaceType: enum ,
replicationRegion: enum ,
zoneRedundancy: enum ,
networkAcls:
{
ipRules:
[
{
ipMask: string ,
rights:
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
rights:
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
admCredential:
{
properties:
{
clientId: string ,
clientSecret: string ,
authTokenUrl: string ,
}
,
}
,
apnsCredential:
{
properties:
{
apnsCertificate: string ,
certificateKey: string ,
endpoint: string ,
thumbprint: string ,
keyId: string ,
appName: string ,
appId: string ,
token: string ,
}
,
}
,
baiduCredential:
{
properties:
{
baiduApiKey: string ,
baiduEndPoint: string ,
baiduSecretKey: string ,
}
,
}
,
browserCredential:
{
properties:
{
subject: string ,
vapidPrivateKey: string ,
vapidPublicKey: string ,
}
,
}
,
gcmCredential:
{
properties:
{
gcmEndpoint: string ,
googleApiKey: string ,
}
,
}
,
mpnsCredential:
{
properties:
{
mpnsCertificate: string ,
certificateKey: string ,
thumbprint: string ,
}
,
}
,
wnsCredential:
{
properties:
{
packageSid: string ,
secretKey: string ,
windowsLiveEndpoint: string ,
certificateKey: string ,
wnsCertificate: string ,
}
,
}
,
xiaomiCredential:
{
properties:
{
appSecret: string ,
endpoint: string ,
}
,
}
,
fcmV1Credential:
{
properties:
{
clientEmail: string ,
privateKey: string ,
projectId: string ,
}
,
}
,
}
,
serviceBusEndpoint: string ,
privateEndpointConnections:
[
{
properties:
{
provisioningState: enum ,
privateEndpoint:
{
id: string ,
}
,
groupIds:
[
string ,
]
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
}
,
}
,
]
,
scaleUnit: string ,
dataCenter: string ,
publicNetworkAccess: enum ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Namespaces_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "name",
            "Description": {
              "new": "Name of the Notification Hubs namespace. This is immutable property, set automatically\nby the service when the namespace is created.",
              "old": "Name of the Notification Hubs namespace. This is immutable property, set automatically \r\nby the service when the namespace is created."
            }
          },
          {
            "#name": "region",
            "Description": {
              "new": "Region. The value is always set to the same value as Namespace.Location, so we are deprecating\nthis property.",
              "old": "Region. The value is always set to the same value as Namespace.Location, so we are deprecating\r\nthis property."
            }
          },
          {
            "pnsCredentials": [
              {
                "apnsCredential": [
                  {
                    "properties": [
                      {
                        "#name": "keyId",
                        "Description": {
                          "new": "Gets or sets a 10-character key identifier (kid) key, obtained from\nyour developer account",
                          "old": "Gets or sets a 10-character key identifier (kid) key, obtained from\r\nyour developer account"
                        }
                      },
                      {
                        "#name": "appId",
                        "Description": {
                          "new": "Gets or sets the issuer (iss) registered claim key, whose value is\nyour 10-character Team ID, obtained from your developer account",
                          "old": "Gets or sets the issuer (iss) registered claim key, whose value is\r\nyour 10-character Team ID, obtained from your developer account"
                        }
                      },
                      {
                        "#name": "token",
                        "Description": {
                          "new": "Gets or sets provider Authentication Token, obtained through your\ndeveloper account",
                          "old": "Gets or sets provider Authentication Token, obtained through your\r\ndeveloper account"
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "#name": "serviceBusEndpoint",
            "Description": {
              "new": "Gets or sets endpoint you can use to perform NotificationHub\noperations.",
              "old": "Gets or sets endpoint you can use to perform NotificationHub\r\noperations."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "name",
            "Description": {
              "new": "Name of the Notification Hubs namespace. This is immutable property, set automatically\nby the service when the namespace is created.",
              "old": "Name of the Notification Hubs namespace. This is immutable property, set automatically \r\nby the service when the namespace is created."
            }
          },
          {
            "#name": "region",
            "Description": {
              "new": "Region. The value is always set to the same value as Namespace.Location, so we are deprecating\nthis property.",
              "old": "Region. The value is always set to the same value as Namespace.Location, so we are deprecating\r\nthis property."
            }
          },
          {
            "pnsCredentials": [
              {
                "apnsCredential": [
                  {
                    "properties": [
                      {
                        "#name": "keyId",
                        "Description": {
                          "new": "Gets or sets a 10-character key identifier (kid) key, obtained from\nyour developer account",
                          "old": "Gets or sets a 10-character key identifier (kid) key, obtained from\r\nyour developer account"
                        }
                      },
                      {
                        "#name": "appId",
                        "Description": {
                          "new": "Gets or sets the issuer (iss) registered claim key, whose value is\nyour 10-character Team ID, obtained from your developer account",
                          "old": "Gets or sets the issuer (iss) registered claim key, whose value is\r\nyour 10-character Team ID, obtained from your developer account"
                        }
                      },
                      {
                        "#name": "token",
                        "Description": {
                          "new": "Gets or sets provider Authentication Token, obtained through your\ndeveloper account",
                          "old": "Gets or sets provider Authentication Token, obtained through your\r\ndeveloper account"
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "#name": "serviceBusEndpoint",
            "Description": {
              "new": "Gets or sets endpoint you can use to perform NotificationHub\noperations.",
              "old": "Gets or sets endpoint you can use to perform NotificationHub\r\noperations."
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "name",
            "Description": {
              "new": "Name of the Notification Hubs namespace. This is immutable property, set automatically\nby the service when the namespace is created.",
              "old": "Name of the Notification Hubs namespace. This is immutable property, set automatically \r\nby the service when the namespace is created."
            }
          },
          {
            "#name": "region",
            "Description": {
              "new": "Region. The value is always set to the same value as Namespace.Location, so we are deprecating\nthis property.",
              "old": "Region. The value is always set to the same value as Namespace.Location, so we are deprecating\r\nthis property."
            }
          },
          {
            "pnsCredentials": [
              {
                "apnsCredential": [
                  {
                    "properties": [
                      {
                        "#name": "keyId",
                        "Description": {
                          "new": "Gets or sets a 10-character key identifier (kid) key, obtained from\nyour developer account",
                          "old": "Gets or sets a 10-character key identifier (kid) key, obtained from\r\nyour developer account"
                        }
                      },
                      {
                        "#name": "appId",
                        "Description": {
                          "new": "Gets or sets the issuer (iss) registered claim key, whose value is\nyour 10-character Team ID, obtained from your developer account",
                          "old": "Gets or sets the issuer (iss) registered claim key, whose value is\r\nyour 10-character Team ID, obtained from your developer account"
                        }
                      },
                      {
                        "#name": "token",
                        "Description": {
                          "new": "Gets or sets provider Authentication Token, obtained through your\ndeveloper account",
                          "old": "Gets or sets provider Authentication Token, obtained through your\r\ndeveloper account"
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "#name": "serviceBusEndpoint",
            "Description": {
              "new": "Gets or sets endpoint you can use to perform NotificationHub\noperations.",
              "old": "Gets or sets endpoint you can use to perform NotificationHub\r\noperations."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
parameters:
{
sku:
{
name: enum ,
tier: string ,
size: string ,
family: string ,
capacity: integer ,
}
,
properties:
{
name: string ,
provisioningState: enum ,
status: enum ,
enabled: boolean ,
critical: boolean ,
subscriptionId: string ,
region: string ,
metricId: string ,
createdAt: string ,
updatedAt: string ,
namespaceType: enum ,
replicationRegion: enum ,
zoneRedundancy: enum ,
networkAcls:
{
ipRules:
[
{
ipMask: string ,
rights:
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
rights:
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
admCredential:
{
properties:
{
clientId: string ,
clientSecret: string ,
authTokenUrl: string ,
}
,
}
,
apnsCredential:
{
properties:
{
apnsCertificate: string ,
certificateKey: string ,
endpoint: string ,
thumbprint: string ,
keyId: string ,
appName: string ,
appId: string ,
token: string ,
}
,
}
,
baiduCredential:
{
properties:
{
baiduApiKey: string ,
baiduEndPoint: string ,
baiduSecretKey: string ,
}
,
}
,
browserCredential:
{
properties:
{
subject: string ,
vapidPrivateKey: string ,
vapidPublicKey: string ,
}
,
}
,
gcmCredential:
{
properties:
{
gcmEndpoint: string ,
googleApiKey: string ,
}
,
}
,
mpnsCredential:
{
properties:
{
mpnsCertificate: string ,
certificateKey: string ,
thumbprint: string ,
}
,
}
,
wnsCredential:
{
properties:
{
packageSid: string ,
secretKey: string ,
windowsLiveEndpoint: string ,
certificateKey: string ,
wnsCertificate: string ,
}
,
}
,
xiaomiCredential:
{
properties:
{
appSecret: string ,
endpoint: string ,
}
,
}
,
fcmV1Credential:
{
properties:
{
clientEmail: string ,
privateKey: string ,
projectId: string ,
}
,
}
,
}
,
serviceBusEndpoint: string ,
privateEndpointConnections:
[
{
properties:
{
provisioningState: enum ,
privateEndpoint:
{
id: string ,
}
,
groupIds:
[
string ,
]
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
}
,
}
,
]
,
scaleUnit: string ,
dataCenter: string ,
publicNetworkAccess: enum ,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
name: enum ,
tier: string ,
size: string ,
family: string ,
capacity: integer ,
}
,
properties:
{
name: string ,
provisioningState: enum ,
status: enum ,
enabled: boolean ,
critical: boolean ,
subscriptionId: string ,
region: string ,
metricId: string ,
createdAt: string ,
updatedAt: string ,
namespaceType: enum ,
replicationRegion: enum ,
zoneRedundancy: enum ,
networkAcls:
{
ipRules:
[
{
ipMask: string ,
rights:
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
rights:
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
admCredential:
{
properties:
{
clientId: string ,
clientSecret: string ,
authTokenUrl: string ,
}
,
}
,
apnsCredential:
{
properties:
{
apnsCertificate: string ,
certificateKey: string ,
endpoint: string ,
thumbprint: string ,
keyId: string ,
appName: string ,
appId: string ,
token: string ,
}
,
}
,
baiduCredential:
{
properties:
{
baiduApiKey: string ,
baiduEndPoint: string ,
baiduSecretKey: string ,
}
,
}
,
browserCredential:
{
properties:
{
subject: string ,
vapidPrivateKey: string ,
vapidPublicKey: string ,
}
,
}
,
gcmCredential:
{
properties:
{
gcmEndpoint: string ,
googleApiKey: string ,
}
,
}
,
mpnsCredential:
{
properties:
{
mpnsCertificate: string ,
certificateKey: string ,
thumbprint: string ,
}
,
}
,
wnsCredential:
{
properties:
{
packageSid: string ,
secretKey: string ,
windowsLiveEndpoint: string ,
certificateKey: string ,
wnsCertificate: string ,
}
,
}
,
xiaomiCredential:
{
properties:
{
appSecret: string ,
endpoint: string ,
}
,
}
,
fcmV1Credential:
{
properties:
{
clientEmail: string ,
privateKey: string ,
projectId: string ,
}
,
}
,
}
,
serviceBusEndpoint: string ,
privateEndpointConnections:
[
{
properties:
{
provisioningState: enum ,
privateEndpoint:
{
id: string ,
}
,
groupIds:
[
string ,
]
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
}
,
}
,
]
,
scaleUnit: string ,
dataCenter: string ,
publicNetworkAccess: enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation: string ,
retry-after: integer ,
}
,
$schema:
{
sku:
{
name: enum ,
tier: string ,
size: string ,
family: string ,
capacity: integer ,
}
,
properties:
{
name: string ,
provisioningState: enum ,
status: enum ,
enabled: boolean ,
critical: boolean ,
subscriptionId: string ,
region: string ,
metricId: string ,
createdAt: string ,
updatedAt: string ,
namespaceType: enum ,
replicationRegion: enum ,
zoneRedundancy: enum ,
networkAcls:
{
ipRules:
[
{
ipMask: string ,
rights:
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
rights:
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
admCredential:
{
properties:
{
clientId: string ,
clientSecret: string ,
authTokenUrl: string ,
}
,
}
,
apnsCredential:
{
properties:
{
apnsCertificate: string ,
certificateKey: string ,
endpoint: string ,
thumbprint: string ,
keyId: string ,
appName: string ,
appId: string ,
token: string ,
}
,
}
,
baiduCredential:
{
properties:
{
baiduApiKey: string ,
baiduEndPoint: string ,
baiduSecretKey: string ,
}
,
}
,
browserCredential:
{
properties:
{
subject: string ,
vapidPrivateKey: string ,
vapidPublicKey: string ,
}
,
}
,
gcmCredential:
{
properties:
{
gcmEndpoint: string ,
googleApiKey: string ,
}
,
}
,
mpnsCredential:
{
properties:
{
mpnsCertificate: string ,
certificateKey: string ,
thumbprint: string ,
}
,
}
,
wnsCredential:
{
properties:
{
packageSid: string ,
secretKey: string ,
windowsLiveEndpoint: string ,
certificateKey: string ,
wnsCertificate: string ,
}
,
}
,
xiaomiCredential:
{
properties:
{
appSecret: string ,
endpoint: string ,
}
,
}
,
fcmV1Credential:
{
properties:
{
clientEmail: string ,
privateKey: string ,
projectId: string ,
}
,
}
,
}
,
serviceBusEndpoint: string ,
privateEndpointConnections:
[
{
properties:
{
provisioningState: enum ,
privateEndpoint:
{
id: string ,
}
,
groupIds:
[
string ,
]
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
}
,
}
,
]
,
scaleUnit: string ,
dataCenter: string ,
publicNetworkAccess: enum ,
}
,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Namespaces_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "name",
            "Description": {
              "new": "Name of the Notification Hubs namespace. This is immutable property, set automatically\nby the service when the namespace is created.",
              "old": "Name of the Notification Hubs namespace. This is immutable property, set automatically \r\nby the service when the namespace is created."
            }
          },
          {
            "#name": "region",
            "Description": {
              "new": "Region. The value is always set to the same value as Namespace.Location, so we are deprecating\nthis property.",
              "old": "Region. The value is always set to the same value as Namespace.Location, so we are deprecating\r\nthis property."
            }
          },
          {
            "pnsCredentials": [
              {
                "apnsCredential": [
                  {
                    "properties": [
                      {
                        "#name": "keyId",
                        "Description": {
                          "new": "Gets or sets a 10-character key identifier (kid) key, obtained from\nyour developer account",
                          "old": "Gets or sets a 10-character key identifier (kid) key, obtained from\r\nyour developer account"
                        }
                      },
                      {
                        "#name": "appId",
                        "Description": {
                          "new": "Gets or sets the issuer (iss) registered claim key, whose value is\nyour 10-character Team ID, obtained from your developer account",
                          "old": "Gets or sets the issuer (iss) registered claim key, whose value is\r\nyour 10-character Team ID, obtained from your developer account"
                        }
                      },
                      {
                        "#name": "token",
                        "Description": {
                          "new": "Gets or sets provider Authentication Token, obtained through your\ndeveloper account",
                          "old": "Gets or sets provider Authentication Token, obtained through your\r\ndeveloper account"
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "#name": "serviceBusEndpoint",
            "Description": {
              "new": "Gets or sets endpoint you can use to perform NotificationHub\noperations.",
              "old": "Gets or sets endpoint you can use to perform NotificationHub\r\noperations."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "name",
            "Description": {
              "new": "Name of the Notification Hubs namespace. This is immutable property, set automatically\nby the service when the namespace is created.",
              "old": "Name of the Notification Hubs namespace. This is immutable property, set automatically \r\nby the service when the namespace is created."
            }
          },
          {
            "#name": "region",
            "Description": {
              "new": "Region. The value is always set to the same value as Namespace.Location, so we are deprecating\nthis property.",
              "old": "Region. The value is always set to the same value as Namespace.Location, so we are deprecating\r\nthis property."
            }
          },
          {
            "pnsCredentials": [
              {
                "apnsCredential": [
                  {
                    "properties": [
                      {
                        "#name": "keyId",
                        "Description": {
                          "new": "Gets or sets a 10-character key identifier (kid) key, obtained from\nyour developer account",
                          "old": "Gets or sets a 10-character key identifier (kid) key, obtained from\r\nyour developer account"
                        }
                      },
                      {
                        "#name": "appId",
                        "Description": {
                          "new": "Gets or sets the issuer (iss) registered claim key, whose value is\nyour 10-character Team ID, obtained from your developer account",
                          "old": "Gets or sets the issuer (iss) registered claim key, whose value is\r\nyour 10-character Team ID, obtained from your developer account"
                        }
                      },
                      {
                        "#name": "token",
                        "Description": {
                          "new": "Gets or sets provider Authentication Token, obtained through your\ndeveloper account",
                          "old": "Gets or sets provider Authentication Token, obtained through your\r\ndeveloper account"
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "#name": "serviceBusEndpoint",
            "Description": {
              "new": "Gets or sets endpoint you can use to perform NotificationHub\noperations.",
              "old": "Gets or sets endpoint you can use to perform NotificationHub\r\noperations."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
parameters:
{
sku:
{
name: enum ,
tier: string ,
size: string ,
family: string ,
capacity: integer ,
}
,
properties:
{
name: string ,
provisioningState: enum ,
status: enum ,
enabled: boolean ,
critical: boolean ,
subscriptionId: string ,
region: string ,
metricId: string ,
createdAt: string ,
updatedAt: string ,
namespaceType: enum ,
replicationRegion: enum ,
zoneRedundancy: enum ,
networkAcls:
{
ipRules:
[
{
ipMask: string ,
rights:
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
rights:
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
admCredential:
{
properties:
{
clientId: string ,
clientSecret: string ,
authTokenUrl: string ,
}
,
}
,
apnsCredential:
{
properties:
{
apnsCertificate: string ,
certificateKey: string ,
endpoint: string ,
thumbprint: string ,
keyId: string ,
appName: string ,
appId: string ,
token: string ,
}
,
}
,
baiduCredential:
{
properties:
{
baiduApiKey: string ,
baiduEndPoint: string ,
baiduSecretKey: string ,
}
,
}
,
browserCredential:
{
properties:
{
subject: string ,
vapidPrivateKey: string ,
vapidPublicKey: string ,
}
,
}
,
gcmCredential:
{
properties:
{
gcmEndpoint: string ,
googleApiKey: string ,
}
,
}
,
mpnsCredential:
{
properties:
{
mpnsCertificate: string ,
certificateKey: string ,
thumbprint: string ,
}
,
}
,
wnsCredential:
{
properties:
{
packageSid: string ,
secretKey: string ,
windowsLiveEndpoint: string ,
certificateKey: string ,
wnsCertificate: string ,
}
,
}
,
xiaomiCredential:
{
properties:
{
appSecret: string ,
endpoint: string ,
}
,
}
,
fcmV1Credential:
{
properties:
{
clientEmail: string ,
privateKey: string ,
projectId: string ,
}
,
}
,
}
,
serviceBusEndpoint: string ,
privateEndpointConnections:
[
{
properties:
{
provisioningState: enum ,
privateEndpoint:
{
id: string ,
}
,
groupIds:
[
string ,
]
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
}
,
}
,
]
,
scaleUnit: string ,
dataCenter: string ,
publicNetworkAccess: enum ,
}
,
tags: object ,
}
,
}

⚐ Response (200)

{
sku:
{
name: enum ,
tier: string ,
size: string ,
family: string ,
capacity: integer ,
}
,
properties:
{
name: string ,
provisioningState: enum ,
status: enum ,
enabled: boolean ,
critical: boolean ,
subscriptionId: string ,
region: string ,
metricId: string ,
createdAt: string ,
updatedAt: string ,
namespaceType: enum ,
replicationRegion: enum ,
zoneRedundancy: enum ,
networkAcls:
{
ipRules:
[
{
ipMask: string ,
rights:
[
string ,
]
,
}
,
]
,
publicNetworkRule:
{
rights:
[
string ,
]
,
}
,
}
,
pnsCredentials:
{
admCredential:
{
properties:
{
clientId: string ,
clientSecret: string ,
authTokenUrl: string ,
}
,
}
,
apnsCredential:
{
properties:
{
apnsCertificate: string ,
certificateKey: string ,
endpoint: string ,
thumbprint: string ,
keyId: string ,
appName: string ,
appId: string ,
token: string ,
}
,
}
,
baiduCredential:
{
properties:
{
baiduApiKey: string ,
baiduEndPoint: string ,
baiduSecretKey: string ,
}
,
}
,
browserCredential:
{
properties:
{
subject: string ,
vapidPrivateKey: string ,
vapidPublicKey: string ,
}
,
}
,
gcmCredential:
{
properties:
{
gcmEndpoint: string ,
googleApiKey: string ,
}
,
}
,
mpnsCredential:
{
properties:
{
mpnsCertificate: string ,
certificateKey: string ,
thumbprint: string ,
}
,
}
,
wnsCredential:
{
properties:
{
packageSid: string ,
secretKey: string ,
windowsLiveEndpoint: string ,
certificateKey: string ,
wnsCertificate: string ,
}
,
}
,
xiaomiCredential:
{
properties:
{
appSecret: string ,
endpoint: string ,
}
,
}
,
fcmV1Credential:
{
properties:
{
clientEmail: string ,
privateKey: string ,
projectId: string ,
}
,
}
,
}
,
serviceBusEndpoint: string ,
privateEndpointConnections:
[
{
properties:
{
provisioningState: enum ,
privateEndpoint:
{
id: string ,
}
,
groupIds:
[
string ,
]
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
}
,
}
,
]
,
scaleUnit: string ,
dataCenter: string ,
publicNetworkAccess: enum ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Namespaces_ListAuthorizationRules",
  "$responses": {
    "200": {
      "Description": {
        "new": "Paged collection of SharedAccessAuthorizationRuleResource items",
        "old": "The response of the List Namespace operation."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The SharedAccessAuthorizationRuleResource items on this page",
            "old": "Gets or sets result of the List AuthorizationRules operation."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "primaryKey",
                  "Description": {
                    "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
                    "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
                  }
                },
                {
                  "#name": "secondaryKey",
                  "Description": {
                    "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
                    "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Gets or sets link to the next set of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
rights:
[
string ,
]
,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
modifiedTime: string ,
createdTime: string ,
claimType: string ,
claimValue: string ,
revision: integer ,
}
,
location: string ,
tags: object ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Namespaces_GetAuthorizationRule",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "primaryKey",
            "Description": {
              "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
              "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
            }
          },
          {
            "#name": "secondaryKey",
            "Description": {
              "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
              "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
authorizationRuleName: string ,
}

⚐ Response (200)

{
properties:
{
rights:
[
string ,
]
,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
modifiedTime: string ,
createdTime: string ,
claimType: string ,
claimValue: string ,
revision: integer ,
}
,
location: string ,
tags: object ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Namespaces_CreateOrUpdateAuthorizationRule",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "primaryKey",
            "Description": {
              "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
              "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
            }
          },
          {
            "#name": "secondaryKey",
            "Description": {
              "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
              "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "primaryKey",
            "Description": {
              "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
              "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
            }
          },
          {
            "#name": "secondaryKey",
            "Description": {
              "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
              "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "primaryKey",
            "Description": {
              "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
              "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
            }
          },
          {
            "#name": "secondaryKey",
            "Description": {
              "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
              "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
authorizationRuleName: string ,
parameters:
{
properties:
{
rights:
[
string ,
]
,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
modifiedTime: string ,
createdTime: string ,
claimType: string ,
claimValue: string ,
revision: integer ,
}
,
location: string ,
tags: object ,
}
,
}

⚐ Response (200)

{
properties:
{
rights:
[
string ,
]
,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
modifiedTime: string ,
createdTime: string ,
claimType: string ,
claimValue: string ,
revision: integer ,
}
,
location: string ,
tags: object ,
}

⚐ Response (201)

{
properties:
{
rights:
[
string ,
]
,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
modifiedTime: string ,
createdTime: string ,
claimType: string ,
claimValue: string ,
revision: integer ,
}
,
location: string ,
tags: object ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Namespaces_ListKeys",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "secondaryConnectionString",
          "Description": {
            "new": "Gets or sets secondaryConnectionString of the created\nAuthorizationRule",
            "old": "Gets or sets secondaryConnectionString of the created\r\nAuthorizationRule"
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/listKeys
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
authorizationRuleName: string ,
}

⚐ Response (200)

{
primaryConnectionString: string ,
secondaryConnectionString: string ,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Namespaces_RegenerateKeys",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "secondaryConnectionString",
          "Description": {
            "new": "Gets or sets secondaryConnectionString of the created\nAuthorizationRule",
            "old": "Gets or sets secondaryConnectionString of the created\r\nAuthorizationRule"
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
authorizationRuleName: string ,
parameters:
{
policyKey: enum ,
}
,
}

⚐ Response (200)

{
primaryConnectionString: string ,
secondaryConnectionString: string ,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "NotificationHubs_CheckNotificationHubAvailability",
  "$parameters": {
    "parameters": {
      "Description": {
        "new": "Parameters supplied to the Check Name Availability for Namespace and\nNotificationHubs.",
        "old": "Parameters supplied to the Check Name Availability for Namespace and\r\nNotificationHubs."
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "isAvailiable",
          "Description": {
            "new": "Gets or sets true if the name is available and can be used to\ncreate new Namespace/NotificationHub. Otherwise false.",
            "old": "Gets or sets true if the name is available and can be used to\r\ncreate new Namespace/NotificationHub. Otherwise false."
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/checkNotificationHubAvailability
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
parameters:
{
id: string ,
name: string ,
type: string ,
location: string ,
tags: object ,
isAvailiable: boolean ,
sku:
{
name: enum ,
tier: string ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
}

⚐ Response (200)

{
isAvailiable: boolean ,
location: string ,
tags: object ,
sku:
{
name: enum ,
tier: string ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "NotificationHubs_List",
  "$responses": {
    "200": {
      "Description": {
        "new": "Paged collection of NotificationHubResource items",
        "old": "The response of the List NotificationHub operation."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The NotificationHubResource items on this page",
            "old": "Gets or sets result of the List AuthorizationRules operation."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "authorizationRules": {
                    "$properties": [
                      {
                        "#name": "primaryKey",
                        "Description": {
                          "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
                          "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
                        }
                      },
                      {
                        "#name": "secondaryKey",
                        "Description": {
                          "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
                          "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
                        }
                      }
                    ]
                  }
                },
                {
                  "apnsCredential": [
                    {
                      "properties": [
                        {
                          "#name": "keyId",
                          "Description": {
                            "new": "Gets or sets a 10-character key identifier (kid) key, obtained from\nyour developer account",
                            "old": "Gets or sets a 10-character key identifier (kid) key, obtained from\r\nyour developer account"
                          }
                        },
                        {
                          "#name": "appId",
                          "Description": {
                            "new": "Gets or sets the issuer (iss) registered claim key, whose value is\nyour 10-character Team ID, obtained from your developer account",
                            "old": "Gets or sets the issuer (iss) registered claim key, whose value is\r\nyour 10-character Team ID, obtained from your developer account"
                          }
                        },
                        {
                          "#name": "token",
                          "Description": {
                            "new": "Gets or sets provider Authentication Token, obtained through your\ndeveloper account",
                            "old": "Gets or sets provider Authentication Token, obtained through your\r\ndeveloper account"
                          }
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Gets or sets link to the next set of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
$skipToken: string ,
$top: integer ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
name: string ,
registrationTtl: string ,
authorizationRules:
[
{
rights:
[
string ,
]
,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
modifiedTime: string ,
createdTime: string ,
claimType: string ,
claimValue: string ,
revision: integer ,
}
,
]
,
apnsCredential:
{
properties:
{
apnsCertificate: string ,
certificateKey: string ,
endpoint: string ,
thumbprint: string ,
keyId: string ,
appName: string ,
appId: string ,
token: string ,
}
,
}
,
wnsCredential:
{
properties:
{
packageSid: string ,
secretKey: string ,
windowsLiveEndpoint: string ,
certificateKey: string ,
wnsCertificate: string ,
}
,
}
,
gcmCredential:
{
properties:
{
gcmEndpoint: string ,
googleApiKey: string ,
}
,
}
,
mpnsCredential:
{
properties:
{
mpnsCertificate: string ,
certificateKey: string ,
thumbprint: string ,
}
,
}
,
admCredential:
{
properties:
{
clientId: string ,
clientSecret: string ,
authTokenUrl: string ,
}
,
}
,
baiduCredential:
{
properties:
{
baiduApiKey: string ,
baiduEndPoint: string ,
baiduSecretKey: string ,
}
,
}
,
browserCredential:
{
properties:
{
subject: string ,
vapidPrivateKey: string ,
vapidPublicKey: string ,
}
,
}
,
xiaomiCredential:
{
properties:
{
appSecret: string ,
endpoint: string ,
}
,
}
,
fcmV1Credential:
{
properties:
{
clientEmail: string ,
privateKey: string ,
projectId: string ,
}
,
}
,
dailyMaxActiveDevices: integer ,
}
,
sku:
{
name: enum ,
tier: string ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "NotificationHubs_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "authorizationRules": {
              "$properties": [
                {
                  "#name": "primaryKey",
                  "Description": {
                    "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
                    "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
                  }
                },
                {
                  "#name": "secondaryKey",
                  "Description": {
                    "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
                    "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
                  }
                }
              ]
            }
          },
          {
            "apnsCredential": [
              {
                "properties": [
                  {
                    "#name": "keyId",
                    "Description": {
                      "new": "Gets or sets a 10-character key identifier (kid) key, obtained from\nyour developer account",
                      "old": "Gets or sets a 10-character key identifier (kid) key, obtained from\r\nyour developer account"
                    }
                  },
                  {
                    "#name": "appId",
                    "Description": {
                      "new": "Gets or sets the issuer (iss) registered claim key, whose value is\nyour 10-character Team ID, obtained from your developer account",
                      "old": "Gets or sets the issuer (iss) registered claim key, whose value is\r\nyour 10-character Team ID, obtained from your developer account"
                    }
                  },
                  {
                    "#name": "token",
                    "Description": {
                      "new": "Gets or sets provider Authentication Token, obtained through your\ndeveloper account",
                      "old": "Gets or sets provider Authentication Token, obtained through your\r\ndeveloper account"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
notificationHubName: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
registrationTtl: string ,
authorizationRules:
[
{
rights:
[
string ,
]
,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
modifiedTime: string ,
createdTime: string ,
claimType: string ,
claimValue: string ,
revision: integer ,
}
,
]
,
apnsCredential:
{
properties:
{
apnsCertificate: string ,
certificateKey: string ,
endpoint: string ,
thumbprint: string ,
keyId: string ,
appName: string ,
appId: string ,
token: string ,
}
,
}
,
wnsCredential:
{
properties:
{
packageSid: string ,
secretKey: string ,
windowsLiveEndpoint: string ,
certificateKey: string ,
wnsCertificate: string ,
}
,
}
,
gcmCredential:
{
properties:
{
gcmEndpoint: string ,
googleApiKey: string ,
}
,
}
,
mpnsCredential:
{
properties:
{
mpnsCertificate: string ,
certificateKey: string ,
thumbprint: string ,
}
,
}
,
admCredential:
{
properties:
{
clientId: string ,
clientSecret: string ,
authTokenUrl: string ,
}
,
}
,
baiduCredential:
{
properties:
{
baiduApiKey: string ,
baiduEndPoint: string ,
baiduSecretKey: string ,
}
,
}
,
browserCredential:
{
properties:
{
subject: string ,
vapidPrivateKey: string ,
vapidPublicKey: string ,
}
,
}
,
xiaomiCredential:
{
properties:
{
appSecret: string ,
endpoint: string ,
}
,
}
,
fcmV1Credential:
{
properties:
{
clientEmail: string ,
privateKey: string ,
projectId: string ,
}
,
}
,
dailyMaxActiveDevices: integer ,
}
,
sku:
{
name: enum ,
tier: string ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "NotificationHubs_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "authorizationRules": {
              "$properties": [
                {
                  "#name": "primaryKey",
                  "Description": {
                    "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
                    "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
                  }
                },
                {
                  "#name": "secondaryKey",
                  "Description": {
                    "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
                    "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
                  }
                }
              ]
            }
          },
          {
            "apnsCredential": [
              {
                "properties": [
                  {
                    "#name": "keyId",
                    "Description": {
                      "new": "Gets or sets a 10-character key identifier (kid) key, obtained from\nyour developer account",
                      "old": "Gets or sets a 10-character key identifier (kid) key, obtained from\r\nyour developer account"
                    }
                  },
                  {
                    "#name": "appId",
                    "Description": {
                      "new": "Gets or sets the issuer (iss) registered claim key, whose value is\nyour 10-character Team ID, obtained from your developer account",
                      "old": "Gets or sets the issuer (iss) registered claim key, whose value is\r\nyour 10-character Team ID, obtained from your developer account"
                    }
                  },
                  {
                    "#name": "token",
                    "Description": {
                      "new": "Gets or sets provider Authentication Token, obtained through your\ndeveloper account",
                      "old": "Gets or sets provider Authentication Token, obtained through your\r\ndeveloper account"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "authorizationRules": {
              "$properties": [
                {
                  "#name": "primaryKey",
                  "Description": {
                    "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
                    "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
                  }
                },
                {
                  "#name": "secondaryKey",
                  "Description": {
                    "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
                    "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
                  }
                }
              ]
            }
          },
          {
            "apnsCredential": [
              {
                "properties": [
                  {
                    "#name": "keyId",
                    "Description": {
                      "new": "Gets or sets a 10-character key identifier (kid) key, obtained from\nyour developer account",
                      "old": "Gets or sets a 10-character key identifier (kid) key, obtained from\r\nyour developer account"
                    }
                  },
                  {
                    "#name": "appId",
                    "Description": {
                      "new": "Gets or sets the issuer (iss) registered claim key, whose value is\nyour 10-character Team ID, obtained from your developer account",
                      "old": "Gets or sets the issuer (iss) registered claim key, whose value is\r\nyour 10-character Team ID, obtained from your developer account"
                    }
                  },
                  {
                    "#name": "token",
                    "Description": {
                      "new": "Gets or sets provider Authentication Token, obtained through your\ndeveloper account",
                      "old": "Gets or sets provider Authentication Token, obtained through your\r\ndeveloper account"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "authorizationRules": {
              "$properties": [
                {
                  "#name": "primaryKey",
                  "Description": {
                    "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
                    "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
                  }
                },
                {
                  "#name": "secondaryKey",
                  "Description": {
                    "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
                    "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
                  }
                }
              ]
            }
          },
          {
            "apnsCredential": [
              {
                "properties": [
                  {
                    "#name": "keyId",
                    "Description": {
                      "new": "Gets or sets a 10-character key identifier (kid) key, obtained from\nyour developer account",
                      "old": "Gets or sets a 10-character key identifier (kid) key, obtained from\r\nyour developer account"
                    }
                  },
                  {
                    "#name": "appId",
                    "Description": {
                      "new": "Gets or sets the issuer (iss) registered claim key, whose value is\nyour 10-character Team ID, obtained from your developer account",
                      "old": "Gets or sets the issuer (iss) registered claim key, whose value is\r\nyour 10-character Team ID, obtained from your developer account"
                    }
                  },
                  {
                    "#name": "token",
                    "Description": {
                      "new": "Gets or sets provider Authentication Token, obtained through your\ndeveloper account",
                      "old": "Gets or sets provider Authentication Token, obtained through your\r\ndeveloper account"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
notificationHubName: string ,
parameters:
{
properties:
{
name: string ,
registrationTtl: string ,
authorizationRules:
[
{
rights:
[
string ,
]
,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
modifiedTime: string ,
createdTime: string ,
claimType: string ,
claimValue: string ,
revision: integer ,
}
,
]
,
apnsCredential:
{
properties:
{
apnsCertificate: string ,
certificateKey: string ,
endpoint: string ,
thumbprint: string ,
keyId: string ,
appName: string ,
appId: string ,
token: string ,
}
,
}
,
wnsCredential:
{
properties:
{
packageSid: string ,
secretKey: string ,
windowsLiveEndpoint: string ,
certificateKey: string ,
wnsCertificate: string ,
}
,
}
,
gcmCredential:
{
properties:
{
gcmEndpoint: string ,
googleApiKey: string ,
}
,
}
,
mpnsCredential:
{
properties:
{
mpnsCertificate: string ,
certificateKey: string ,
thumbprint: string ,
}
,
}
,
admCredential:
{
properties:
{
clientId: string ,
clientSecret: string ,
authTokenUrl: string ,
}
,
}
,
baiduCredential:
{
properties:
{
baiduApiKey: string ,
baiduEndPoint: string ,
baiduSecretKey: string ,
}
,
}
,
browserCredential:
{
properties:
{
subject: string ,
vapidPrivateKey: string ,
vapidPublicKey: string ,
}
,
}
,
xiaomiCredential:
{
properties:
{
appSecret: string ,
endpoint: string ,
}
,
}
,
fcmV1Credential:
{
properties:
{
clientEmail: string ,
privateKey: string ,
projectId: string ,
}
,
}
,
dailyMaxActiveDevices: integer ,
}
,
sku:
{
name: enum ,
tier: string ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
name: string ,
registrationTtl: string ,
authorizationRules:
[
{
rights:
[
string ,
]
,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
modifiedTime: string ,
createdTime: string ,
claimType: string ,
claimValue: string ,
revision: integer ,
}
,
]
,
apnsCredential:
{
properties:
{
apnsCertificate: string ,
certificateKey: string ,
endpoint: string ,
thumbprint: string ,
keyId: string ,
appName: string ,
appId: string ,
token: string ,
}
,
}
,
wnsCredential:
{
properties:
{
packageSid: string ,
secretKey: string ,
windowsLiveEndpoint: string ,
certificateKey: string ,
wnsCertificate: string ,
}
,
}
,
gcmCredential:
{
properties:
{
gcmEndpoint: string ,
googleApiKey: string ,
}
,
}
,
mpnsCredential:
{
properties:
{
mpnsCertificate: string ,
certificateKey: string ,
thumbprint: string ,
}
,
}
,
admCredential:
{
properties:
{
clientId: string ,
clientSecret: string ,
authTokenUrl: string ,
}
,
}
,
baiduCredential:
{
properties:
{
baiduApiKey: string ,
baiduEndPoint: string ,
baiduSecretKey: string ,
}
,
}
,
browserCredential:
{
properties:
{
subject: string ,
vapidPrivateKey: string ,
vapidPublicKey: string ,
}
,
}
,
xiaomiCredential:
{
properties:
{
appSecret: string ,
endpoint: string ,
}
,
}
,
fcmV1Credential:
{
properties:
{
clientEmail: string ,
privateKey: string ,
projectId: string ,
}
,
}
,
dailyMaxActiveDevices: integer ,
}
,
sku:
{
name: enum ,
tier: string ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (201)

{
properties:
{
name: string ,
registrationTtl: string ,
authorizationRules:
[
{
rights:
[
string ,
]
,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
modifiedTime: string ,
createdTime: string ,
claimType: string ,
claimValue: string ,
revision: integer ,
}
,
]
,
apnsCredential:
{
properties:
{
apnsCertificate: string ,
certificateKey: string ,
endpoint: string ,
thumbprint: string ,
keyId: string ,
appName: string ,
appId: string ,
token: string ,
}
,
}
,
wnsCredential:
{
properties:
{
packageSid: string ,
secretKey: string ,
windowsLiveEndpoint: string ,
certificateKey: string ,
wnsCertificate: string ,
}
,
}
,
gcmCredential:
{
properties:
{
gcmEndpoint: string ,
googleApiKey: string ,
}
,
}
,
mpnsCredential:
{
properties:
{
mpnsCertificate: string ,
certificateKey: string ,
thumbprint: string ,
}
,
}
,
admCredential:
{
properties:
{
clientId: string ,
clientSecret: string ,
authTokenUrl: string ,
}
,
}
,
baiduCredential:
{
properties:
{
baiduApiKey: string ,
baiduEndPoint: string ,
baiduSecretKey: string ,
}
,
}
,
browserCredential:
{
properties:
{
subject: string ,
vapidPrivateKey: string ,
vapidPublicKey: string ,
}
,
}
,
xiaomiCredential:
{
properties:
{
appSecret: string ,
endpoint: string ,
}
,
}
,
fcmV1Credential:
{
properties:
{
clientEmail: string ,
privateKey: string ,
projectId: string ,
}
,
}
,
dailyMaxActiveDevices: integer ,
}
,
sku:
{
name: enum ,
tier: string ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "NotificationHubs_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "authorizationRules": {
              "$properties": [
                {
                  "#name": "primaryKey",
                  "Description": {
                    "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
                    "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
                  }
                },
                {
                  "#name": "secondaryKey",
                  "Description": {
                    "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
                    "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
                  }
                }
              ]
            }
          },
          {
            "apnsCredential": [
              {
                "properties": [
                  {
                    "#name": "keyId",
                    "Description": {
                      "new": "Gets or sets a 10-character key identifier (kid) key, obtained from\nyour developer account",
                      "old": "Gets or sets a 10-character key identifier (kid) key, obtained from\r\nyour developer account"
                    }
                  },
                  {
                    "#name": "appId",
                    "Description": {
                      "new": "Gets or sets the issuer (iss) registered claim key, whose value is\nyour 10-character Team ID, obtained from your developer account",
                      "old": "Gets or sets the issuer (iss) registered claim key, whose value is\r\nyour 10-character Team ID, obtained from your developer account"
                    }
                  },
                  {
                    "#name": "token",
                    "Description": {
                      "new": "Gets or sets provider Authentication Token, obtained through your\ndeveloper account",
                      "old": "Gets or sets provider Authentication Token, obtained through your\r\ndeveloper account"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "authorizationRules": {
              "$properties": [
                {
                  "#name": "primaryKey",
                  "Description": {
                    "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
                    "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
                  }
                },
                {
                  "#name": "secondaryKey",
                  "Description": {
                    "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
                    "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
                  }
                }
              ]
            }
          },
          {
            "apnsCredential": [
              {
                "properties": [
                  {
                    "#name": "keyId",
                    "Description": {
                      "new": "Gets or sets a 10-character key identifier (kid) key, obtained from\nyour developer account",
                      "old": "Gets or sets a 10-character key identifier (kid) key, obtained from\r\nyour developer account"
                    }
                  },
                  {
                    "#name": "appId",
                    "Description": {
                      "new": "Gets or sets the issuer (iss) registered claim key, whose value is\nyour 10-character Team ID, obtained from your developer account",
                      "old": "Gets or sets the issuer (iss) registered claim key, whose value is\r\nyour 10-character Team ID, obtained from your developer account"
                    }
                  },
                  {
                    "#name": "token",
                    "Description": {
                      "new": "Gets or sets provider Authentication Token, obtained through your\ndeveloper account",
                      "old": "Gets or sets provider Authentication Token, obtained through your\r\ndeveloper account"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
notificationHubName: string ,
parameters:
{
properties:
{
name: string ,
registrationTtl: string ,
authorizationRules:
[
{
rights:
[
string ,
]
,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
modifiedTime: string ,
createdTime: string ,
claimType: string ,
claimValue: string ,
revision: integer ,
}
,
]
,
apnsCredential:
{
properties:
{
apnsCertificate: string ,
certificateKey: string ,
endpoint: string ,
thumbprint: string ,
keyId: string ,
appName: string ,
appId: string ,
token: string ,
}
,
}
,
wnsCredential:
{
properties:
{
packageSid: string ,
secretKey: string ,
windowsLiveEndpoint: string ,
certificateKey: string ,
wnsCertificate: string ,
}
,
}
,
gcmCredential:
{
properties:
{
gcmEndpoint: string ,
googleApiKey: string ,
}
,
}
,
mpnsCredential:
{
properties:
{
mpnsCertificate: string ,
certificateKey: string ,
thumbprint: string ,
}
,
}
,
admCredential:
{
properties:
{
clientId: string ,
clientSecret: string ,
authTokenUrl: string ,
}
,
}
,
baiduCredential:
{
properties:
{
baiduApiKey: string ,
baiduEndPoint: string ,
baiduSecretKey: string ,
}
,
}
,
browserCredential:
{
properties:
{
subject: string ,
vapidPrivateKey: string ,
vapidPublicKey: string ,
}
,
}
,
xiaomiCredential:
{
properties:
{
appSecret: string ,
endpoint: string ,
}
,
}
,
fcmV1Credential:
{
properties:
{
clientEmail: string ,
privateKey: string ,
projectId: string ,
}
,
}
,
dailyMaxActiveDevices: integer ,
}
,
sku:
{
name: enum ,
tier: string ,
size: string ,
family: string ,
capacity: integer ,
}
,
tags: object ,
}
,
}

⚐ Response (200)

{
properties:
{
name: string ,
registrationTtl: string ,
authorizationRules:
[
{
rights:
[
string ,
]
,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
modifiedTime: string ,
createdTime: string ,
claimType: string ,
claimValue: string ,
revision: integer ,
}
,
]
,
apnsCredential:
{
properties:
{
apnsCertificate: string ,
certificateKey: string ,
endpoint: string ,
thumbprint: string ,
keyId: string ,
appName: string ,
appId: string ,
token: string ,
}
,
}
,
wnsCredential:
{
properties:
{
packageSid: string ,
secretKey: string ,
windowsLiveEndpoint: string ,
certificateKey: string ,
wnsCertificate: string ,
}
,
}
,
gcmCredential:
{
properties:
{
gcmEndpoint: string ,
googleApiKey: string ,
}
,
}
,
mpnsCredential:
{
properties:
{
mpnsCertificate: string ,
certificateKey: string ,
thumbprint: string ,
}
,
}
,
admCredential:
{
properties:
{
clientId: string ,
clientSecret: string ,
authTokenUrl: string ,
}
,
}
,
baiduCredential:
{
properties:
{
baiduApiKey: string ,
baiduEndPoint: string ,
baiduSecretKey: string ,
}
,
}
,
browserCredential:
{
properties:
{
subject: string ,
vapidPrivateKey: string ,
vapidPublicKey: string ,
}
,
}
,
xiaomiCredential:
{
properties:
{
appSecret: string ,
endpoint: string ,
}
,
}
,
fcmV1Credential:
{
properties:
{
clientEmail: string ,
privateKey: string ,
projectId: string ,
}
,
}
,
dailyMaxActiveDevices: integer ,
}
,
sku:
{
name: enum ,
tier: string ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "NotificationHubs_ListAuthorizationRules",
  "$responses": {
    "200": {
      "Description": {
        "new": "Paged collection of SharedAccessAuthorizationRuleResource items",
        "old": "The response of the List Namespace operation."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The SharedAccessAuthorizationRuleResource items on this page",
            "old": "Gets or sets result of the List AuthorizationRules operation."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "primaryKey",
                  "Description": {
                    "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
                    "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
                  }
                },
                {
                  "#name": "secondaryKey",
                  "Description": {
                    "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
                    "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Gets or sets link to the next set of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
notificationHubName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
rights:
[
string ,
]
,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
modifiedTime: string ,
createdTime: string ,
claimType: string ,
claimValue: string ,
revision: integer ,
}
,
location: string ,
tags: object ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "NotificationHubs_GetAuthorizationRule",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "primaryKey",
            "Description": {
              "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
              "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
            }
          },
          {
            "#name": "secondaryKey",
            "Description": {
              "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
              "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
notificationHubName: string ,
authorizationRuleName: string ,
}

⚐ Response (200)

{
properties:
{
rights:
[
string ,
]
,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
modifiedTime: string ,
createdTime: string ,
claimType: string ,
claimValue: string ,
revision: integer ,
}
,
location: string ,
tags: object ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "NotificationHubs_CreateOrUpdateAuthorizationRule",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "primaryKey",
            "Description": {
              "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
              "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
            }
          },
          {
            "#name": "secondaryKey",
            "Description": {
              "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
              "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "primaryKey",
            "Description": {
              "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
              "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
            }
          },
          {
            "#name": "secondaryKey",
            "Description": {
              "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
              "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "primaryKey",
            "Description": {
              "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
              "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
            }
          },
          {
            "#name": "secondaryKey",
            "Description": {
              "new": "Gets a base64-encoded 256-bit primary key for signing and\nvalidating the SAS token.",
              "old": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
notificationHubName: string ,
authorizationRuleName: string ,
parameters:
{
properties:
{
rights:
[
string ,
]
,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
modifiedTime: string ,
createdTime: string ,
claimType: string ,
claimValue: string ,
revision: integer ,
}
,
location: string ,
tags: object ,
}
,
}

⚐ Response (200)

{
properties:
{
rights:
[
string ,
]
,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
modifiedTime: string ,
createdTime: string ,
claimType: string ,
claimValue: string ,
revision: integer ,
}
,
location: string ,
tags: object ,
}

⚐ Response (201)

{
properties:
{
rights:
[
string ,
]
,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
modifiedTime: string ,
createdTime: string ,
claimType: string ,
claimValue: string ,
revision: integer ,
}
,
location: string ,
tags: object ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "NotificationHubs_ListKeys",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "secondaryConnectionString",
          "Description": {
            "new": "Gets or sets secondaryConnectionString of the created\nAuthorizationRule",
            "old": "Gets or sets secondaryConnectionString of the created\r\nAuthorizationRule"
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}/listKeys
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
notificationHubName: string ,
authorizationRuleName: string ,
}

⚐ Response (200)

{
primaryConnectionString: string ,
secondaryConnectionString: string ,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "NotificationHubs_RegenerateKeys",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "secondaryConnectionString",
          "Description": {
            "new": "Gets or sets secondaryConnectionString of the created\nAuthorizationRule",
            "old": "Gets or sets secondaryConnectionString of the created\r\nAuthorizationRule"
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
notificationHubName: string ,
authorizationRuleName: string ,
parameters:
{
policyKey: enum ,
}
,
}

⚐ Response (200)

{
primaryConnectionString: string ,
secondaryConnectionString: string ,
primaryKey: string ,
secondaryKey: string ,
keyName: string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "NotificationHubs_GetPnsCredentials",
  "$responses": {
    "200": {
      "Description": {
        "new": "Description of a NotificationHub PNS Credentials. This is a response of the POST requests that return namespace or hubs\nPNS credentials.",
        "old": "Description of a NotificationHub PNS Credentials. This is a response of the POST requests that return namespace or hubs\r\nPNS credentials."
      },
      "$properties": {
        "properties": [
          {
            "apnsCredential": [
              {
                "properties": [
                  {
                    "#name": "keyId",
                    "Description": {
                      "new": "Gets or sets a 10-character key identifier (kid) key, obtained from\nyour developer account",
                      "old": "Gets or sets a 10-character key identifier (kid) key, obtained from\r\nyour developer account"
                    }
                  },
                  {
                    "#name": "appId",
                    "Description": {
                      "new": "Gets or sets the issuer (iss) registered claim key, whose value is\nyour 10-character Team ID, obtained from your developer account",
                      "old": "Gets or sets the issuer (iss) registered claim key, whose value is\r\nyour 10-character Team ID, obtained from your developer account"
                    }
                  },
                  {
                    "#name": "token",
                    "Description": {
                      "new": "Gets or sets provider Authentication Token, obtained through your\ndeveloper account",
                      "old": "Gets or sets provider Authentication Token, obtained through your\r\ndeveloper account"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/pnsCredentials
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
notificationHubName: string ,
}

⚐ Response (200)

{
properties:
{
admCredential:
{
properties:
{
clientId: string ,
clientSecret: string ,
authTokenUrl: string ,
}
,
}
,
apnsCredential:
{
properties:
{
apnsCertificate: string ,
certificateKey: string ,
endpoint: string ,
thumbprint: string ,
keyId: string ,
appName: string ,
appId: string ,
token: string ,
}
,
}
,
baiduCredential:
{
properties:
{
baiduApiKey: string ,
baiduEndPoint: string ,
baiduSecretKey: string ,
}
,
}
,
browserCredential:
{
properties:
{
subject: string ,
vapidPrivateKey: string ,
vapidPublicKey: string ,
}
,
}
,
gcmCredential:
{
properties:
{
gcmEndpoint: string ,
googleApiKey: string ,
}
,
}
,
mpnsCredential:
{
properties:
{
mpnsCertificate: string ,
certificateKey: string ,
thumbprint: string ,
}
,
}
,
wnsCredential:
{
properties:
{
packageSid: string ,
secretKey: string ,
windowsLiveEndpoint: string ,
certificateKey: string ,
wnsCertificate: string ,
}
,
}
,
xiaomiCredential:
{
properties:
{
appSecret: string ,
endpoint: string ,
}
,
}
,
fcmV1Credential:
{
properties:
{
clientEmail: string ,
privateKey: string ,
projectId: string ,
}
,
}
,
}
,
location: string ,
tags: object ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Namespaces_GetPnsCredentials",
  "$responses": {
    "200": {
      "Description": {
        "new": "Description of a NotificationHub PNS Credentials. This is a response of the POST requests that return namespace or hubs\nPNS credentials.",
        "old": "Description of a NotificationHub PNS Credentials. This is a response of the POST requests that return namespace or hubs\r\nPNS credentials."
      },
      "$properties": {
        "properties": [
          {
            "apnsCredential": [
              {
                "properties": [
                  {
                    "#name": "keyId",
                    "Description": {
                      "new": "Gets or sets a 10-character key identifier (kid) key, obtained from\nyour developer account",
                      "old": "Gets or sets a 10-character key identifier (kid) key, obtained from\r\nyour developer account"
                    }
                  },
                  {
                    "#name": "appId",
                    "Description": {
                      "new": "Gets or sets the issuer (iss) registered claim key, whose value is\nyour 10-character Team ID, obtained from your developer account",
                      "old": "Gets or sets the issuer (iss) registered claim key, whose value is\r\nyour 10-character Team ID, obtained from your developer account"
                    }
                  },
                  {
                    "#name": "token",
                    "Description": {
                      "new": "Gets or sets provider Authentication Token, obtained through your\ndeveloper account",
                      "old": "Gets or sets provider Authentication Token, obtained through your\r\ndeveloper account"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/pnsCredentials
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
}

⚐ Response (200)

{
properties:
{
admCredential:
{
properties:
{
clientId: string ,
clientSecret: string ,
authTokenUrl: string ,
}
,
}
,
apnsCredential:
{
properties:
{
apnsCertificate: string ,
certificateKey: string ,
endpoint: string ,
thumbprint: string ,
keyId: string ,
appName: string ,
appId: string ,
token: string ,
}
,
}
,
baiduCredential:
{
properties:
{
baiduApiKey: string ,
baiduEndPoint: string ,
baiduSecretKey: string ,
}
,
}
,
browserCredential:
{
properties:
{
subject: string ,
vapidPrivateKey: string ,
vapidPublicKey: string ,
}
,
}
,
gcmCredential:
{
properties:
{
gcmEndpoint: string ,
googleApiKey: string ,
}
,
}
,
mpnsCredential:
{
properties:
{
mpnsCertificate: string ,
certificateKey: string ,
thumbprint: string ,
}
,
}
,
wnsCredential:
{
properties:
{
packageSid: string ,
secretKey: string ,
windowsLiveEndpoint: string ,
certificateKey: string ,
wnsCertificate: string ,
}
,
}
,
xiaomiCredential:
{
properties:
{
appSecret: string ,
endpoint: string ,
}
,
}
,
fcmV1Credential:
{
properties:
{
clientEmail: string ,
privateKey: string ,
projectId: string ,
}
,
}
,
}
,
location: string ,
tags: object ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "PrivateEndpointConnections_List",
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a PrivateEndpointConnectionResource list operation.",
        "old": "The response of the List Private Endpoint Connections operation."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PrivateEndpointConnectionResource items on this page",
            "old": "Gets or sets result of the List AuthorizationRules operation."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Gets or sets link to the next set of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateEndpointConnections
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
privateEndpoint:
{
id: string ,
}
,
groupIds:
[
string ,
]
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "PrivateEndpointConnections_Delete",
  "$responses": {
    "202": [
      {
        "@added_e2ae6bfa8eae45709815543d53d89b13": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
privateEndpointConnectionName: string ,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "PrivateEndpointConnections_ListGroupIds",
  "Description": {
    "new": "Even though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it's called.\nThat's why we don't send it to the sibling RP, but process it directly in the scale unit that received the request.",
    "old": "Even though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it's called.\r\nThat's why we don't send it to the sibling RP, but process it directly in the scale unit that received the request."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a PrivateLinkResource list operation.",
        "old": "The response of the List Private Link Resources operation."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PrivateLinkResource items on this page",
            "old": "Gets or sets result of the List AuthorizationRules operation."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Gets or sets link to the next set of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateLinkResources
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
groupId: string ,
requiredMembers:
[
string ,
]
,
requiredZoneNames:
[
string ,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "PrivateEndpointConnections_GetGroupId",
  "Description": {
    "new": "Even though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it's called.\nThat's why we don't send it to the sibling RP, but process it directly in the scale unit that received the request.",
    "old": "Even though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it's called.\r\nThat's why we don't send it to the sibling RP, but process it directly in the scale unit that received the request."
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateLinkResources/{subResourceName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
namespaceName: string ,
subResourceName: string ,
}

⚐ Response (200)

{
properties:
{
groupId: string ,
requiredMembers:
[
string ,
]
,
requiredZoneNames:
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}