swagger: '2.0' info: title: Microsoft Azure NotificationHubs RP Client description: Microsoft Notification Hubs Resource Provider REST API. version: 2023-10-01-preview host: management.azure.com schemes: - https paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/checkNotificationHubAvailability : post: tags: - Hubs summary: 'Microsoft Azure Checks The Availability Of The Given Notificationhub In A Namespace' operationId: microsoftAzureNotificationhubsChecknotificationhubavailability consumes: - application/json produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: Request content. required: true schema: $ref: '#/definitions/CheckAvailabilityParameters' responses: '200': description: Success schema: $ref: '#/definitions/CheckAvailabilityResult' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: NotificationHubs_CheckNotificationHubAvailability: $ref: ./examples/NotificationHubs/CheckAvailability.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName} : get: tags: - Hubs summary: 'Microsoft Azure Gets The Notification Hub' operationId: microsoftAzureNotificationhubsGet produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: '#/parameters/HubName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/NotificationHubResource' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: NotificationHubs_Get: $ref: ./examples/NotificationHubs/Get.json description: Needs a more full description created. put: tags: - Hubs summary: 'Microsoft Azure Creates Update A Notificationhub In A Namespace' operationId: microsoftAzureNotificationhubsCreateorupdate consumes: - application/json produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: '#/parameters/HubName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: Request content. required: true schema: $ref: '#/definitions/NotificationHubResource' responses: '200': description: Updated schema: $ref: '#/definitions/NotificationHubResource' '201': description: Created schema: $ref: '#/definitions/NotificationHubResource' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: NotificationHubs_CreateOrUpdate: $ref: ./examples/NotificationHubs/CreateOrUpdate.json description: Needs a more full description created. patch: tags: - Hubs summary: 'Microsoft Azure Patch A Notificationhub In A Namespace' operationId: microsoftAzureNotificationhubsUpdate consumes: - application/json produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: '#/parameters/HubName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: Request content. required: true schema: $ref: '#/definitions/NotificationHubPatchParameters' responses: '200': description: Success schema: $ref: '#/definitions/NotificationHubResource' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: NotificationHubs_Update: $ref: ./examples/NotificationHubs/Update.json description: Needs a more full description created. delete: tags: - Hubs summary: 'Microsoft Azure Deletes A Notification Hub Associated With A Namespace' operationId: microsoftAzureNotificationhubsDelete produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: '#/parameters/HubName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success '204': description: No Content default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: NotificationHubs_Delete: $ref: ./examples/NotificationHubs/Delete.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs : get: tags: - Hubs summary: 'Microsoft Azure Lists The Notification Hubs Associated With A Namespace' operationId: microsoftAzureNotificationhubsList produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - in: query name: $skipToken description: Continuation token. type: string - in: query name: $top description: Page size. type: integer format: int32 default: 100 - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/NotificationHubListResult' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: itemName: value nextLinkName: nextLink x-ms-examples: NotificationHubs_List: $ref: ./examples/NotificationHubs/List.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/debugsend : post: tags: - Hubs summary: 'Microsoft Azure Test Send A Push Notification' operationId: microsoftAzureNotificationhubsDebugsend produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: '#/parameters/HubName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/DebugSendResponse' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: NotificationHubs_DebugSend: $ref: ./examples/NotificationHubs/DebugSend.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName} : put: tags: - Hubs summary: Microsoft Azure Creates Updates An Authorization Rule For A Notificationhub operationId: microsoftAzureNotificationhubsCreateorupdateauthorizationrule consumes: - application/json produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: '#/parameters/HubName' - $ref: '#/parameters/AuthorizationRuleName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: Request content. required: true schema: $ref: '#/definitions/SharedAccessAuthorizationRuleResource' responses: '200': description: Updated schema: $ref: '#/definitions/SharedAccessAuthorizationRuleResource' '201': description: Created schema: $ref: '#/definitions/SharedAccessAuthorizationRuleResource' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: NotificationHubs_CreateOrUpdateAuthorizationRule: $ref: ./examples/NotificationHubs/AuthorizationRuleCreateOrUpdate.json description: Needs a more full description created. delete: tags: - Hubs summary: Microsoft Azure Deletes A Notificationhub Authorization Rule operationId: microsoftAzureNotificationhubsDeleteauthorizationrule produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: '#/parameters/HubName' - $ref: '#/parameters/AuthorizationRuleName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success '204': description: No Content default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: NotificationHubs_DeleteAuthorizationRule: $ref: ./examples/NotificationHubs/AuthorizationRuleDelete.json description: Needs a more full description created. get: tags: - Hubs summary: 'Microsoft Azure Gets An Authorization Rule For A Notificationhub By Name' operationId: microsoftAzureNotificationhubsGetauthorizationrule produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: '#/parameters/HubName' - $ref: '#/parameters/AuthorizationRuleName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/SharedAccessAuthorizationRuleResource' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: NotificationHubs_GetAuthorizationRule: $ref: ./examples/NotificationHubs/AuthorizationRuleGet.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules : get: tags: - Hubs summary: 'Microsoft Azure Gets The Authorization Rules For A Notificationhub' operationId: microsoftAzureNotificationhubsListauthorizationrules produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: '#/parameters/HubName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/SharedAccessAuthorizationRuleListResult' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: itemName: value nextLinkName: nextLink x-ms-examples: NotificationHubs_ListAuthorizationRules: $ref: ./examples/NotificationHubs/AuthorizationRuleList.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}/listKeys : post: tags: - Hubs summary: Microsoft Azure Gets The Primary And Secondary Connectionstrings To The Notificationhub operationId: microsoftAzureNotificationhubsListkeys produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: '#/parameters/HubName' - $ref: '#/parameters/AuthorizationRuleName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/ResourceListKeys' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: NotificationHubs_ListKeys: $ref: ./examples/NotificationHubs/AuthorizationRuleListKeys.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}/regenerateKeys : post: tags: - Hubs summary: >- Microsoft Azure Regenerates The Primary Secondary Keys To The Notificationhub Authorization Rule operationId: microsoftAzureNotificationhubsRegeneratekeys consumes: - application/json produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: '#/parameters/HubName' - $ref: '#/parameters/AuthorizationRuleName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: Request content. required: true schema: $ref: '#/definitions/PolicyKeyResource' responses: '200': description: Success schema: $ref: '#/definitions/ResourceListKeys' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: NotificationHubs_RegenerateKeys: $ref: ./examples/NotificationHubs/AuthorizationRuleRegenerateKey.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/pnsCredentials : post: tags: - Hubs summary: 'Microsoft Azure Lists The Pns Credentials Associated With A Notification Hub' operationId: microsoftAzureNotificationhubsGetpnscredentials produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: '#/parameters/HubName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/PnsCredentialsResource' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: NotificationHubs_GetPnsCredentials: $ref: ./examples/NotificationHubs/PnsCredentialsGet.json description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/checkNamespaceAvailability: post: tags: - Namespaces summary: >- Microsoft Azure 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 operationId: microsoftAzureNamespacesCheckavailability consumes: - application/json produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: Request content. required: true schema: $ref: '#/definitions/CheckAvailabilityParameters' responses: '200': description: Success schema: $ref: '#/definitions/CheckAvailabilityResult' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Namespaces_CheckAvailability: $ref: ./examples/Namespaces/CheckAvailability.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName} : get: tags: - Namespaces summary: 'Microsoft Azure Returns The Given Namespace' operationId: microsoftAzureNamespacesGet produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/NamespaceResource' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Namespaces_Get: $ref: ./examples/Namespaces/Get.json description: Needs a more full description created. put: tags: - Namespaces summary: >- Microsoft Azure Creates Updates A Notification Hub Namespace This Operation Is Idempotent operationId: microsoftAzureNamespacesCreateorupdate consumes: - application/json produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: Request content. required: true schema: $ref: '#/definitions/NamespaceResource' responses: '200': description: Updated schema: $ref: '#/definitions/NamespaceResource' '201': description: Created schema: $ref: '#/definitions/NamespaceResource' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Namespaces_CreateOrUpdate: $ref: ./examples/Namespaces/CreateOrUpdate.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation description: Needs a more full description created. patch: tags: - Namespaces summary: 'Microsoft Azure Patches The Existing Namespace' operationId: microsoftAzureNamespacesUpdate consumes: - application/json produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: Request content. required: true schema: $ref: '#/definitions/NamespacePatchParameters' responses: '200': description: Success schema: $ref: '#/definitions/NamespaceResource' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Namespaces_Update: $ref: ./examples/Namespaces/Update.json description: Needs a more full description created. delete: tags: - Namespaces summary: >- Microsoft Azure Deletes An Existing Namespace This Operation Also Removes All Associated Notificationhubs Under The Namespace operationId: microsoftAzureNamespacesDelete produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success '204': description: No Content default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Namespaces_Delete: $ref: ./examples/Namespaces/Delete.json description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/namespaces: get: tags: - Namespaces summary: 'Microsoft Azure Lists All The Available Namespaces Within The Subscription' operationId: microsoftAzureNamespacesListall produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - in: query name: $skipToken description: Skip token for subsequent requests. type: string - in: query name: $top description: Maximum number of results to return. type: integer format: int32 default: 100 - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/NamespaceListResult' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: itemName: value nextLinkName: nextLink x-ms-examples: Namespaces_ListAll: $ref: ./examples/Namespaces/ListBySubscription.json description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces: get: tags: - Namespaces summary: 'Microsoft Azure Lists The Available Namespaces Within A Resource Group' operationId: microsoftAzureNamespacesList produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - in: query name: $skipToken description: Skip token for subsequent requests. type: string - in: query name: $top description: Maximum number of results to return. type: integer format: int32 default: 100 - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/NamespaceListResult' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: itemName: value nextLinkName: nextLink x-ms-examples: Namespaces_List: $ref: ./examples/Namespaces/ListByResourceGroup.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName} : put: tags: - Namespaces summary: Microsoft Azure Creates An Authorization Rule For A Namespace operationId: microsoftAzureNamespacesCreateorupdateauthorizationrule consumes: - application/json produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: '#/parameters/AuthorizationRuleName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: Request content. required: true schema: $ref: '#/definitions/SharedAccessAuthorizationRuleResource' responses: '200': description: Updated schema: $ref: '#/definitions/SharedAccessAuthorizationRuleResource' '201': description: Created schema: $ref: '#/definitions/SharedAccessAuthorizationRuleResource' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Namespaces_CreateOrUpdateAuthorizationRule: $ref: ./examples/Namespaces/AuthorizationRuleCreateOrUpdate.json description: Needs a more full description created. delete: tags: - Namespaces summary: Microsoft Azure Deletes A Namespace Authorization Rule operationId: microsoftAzureNamespacesDeleteauthorizationrule produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: '#/parameters/AuthorizationRuleName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success '204': description: No Content default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Namespaces_DeleteAuthorizationRule: $ref: ./examples/Namespaces/AuthorizationRuleDelete.json description: Needs a more full description created. get: tags: - Namespaces summary: 'Microsoft Azure Gets An Authorization Rule For A Namespace By Name' operationId: microsoftAzureNamespacesGetauthorizationrule produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: '#/parameters/AuthorizationRuleName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/SharedAccessAuthorizationRuleResource' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Namespaces_GetAuthorizationRule: $ref: ./examples/Namespaces/AuthorizationRuleGet.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules : get: tags: - Namespaces summary: 'Microsoft Azure Gets The Authorization Rules For A Namespace' operationId: microsoftAzureNamespacesListauthorizationrules produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/SharedAccessAuthorizationRuleListResult' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: itemName: value nextLinkName: nextLink x-ms-examples: Namespaces_ListAuthorizationRules: $ref: ./examples/Namespaces/AuthorizationRuleList.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/listKeys : post: tags: - Namespaces summary: 'Microsoft Azure Gets The Primary And Secondary Connectionstrings To The Namespace' operationId: microsoftAzureNamespacesListkeys produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: '#/parameters/AuthorizationRuleName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/ResourceListKeys' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Namespaces_ListKeys: $ref: ./examples/Namespaces/AuthorizationRuleListKeys.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/regenerateKeys : post: tags: - Namespaces summary: >- Microsoft Azure Regenerates The Primary Secondary Keys To The Namespace Authorization Rule operationId: microsoftAzureNamespacesRegeneratekeys consumes: - application/json produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: '#/parameters/AuthorizationRuleName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: Request content. required: true schema: $ref: '#/definitions/PolicyKeyResource' responses: '200': description: Success schema: $ref: '#/definitions/ResourceListKeys' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Namespaces_RegenerateKeys: $ref: ./examples/Namespaces/AuthorizationRuleRegenerateKey.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/pnsCredentials : post: tags: - Namespaces summary: 'Microsoft Azure Lists The Pns Credentials Associated With A Namespace' operationId: microsoftAzureNamespacesGetpnscredentials produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/PnsCredentialsResource' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Namespaces_GetPnsCredentials: $ref: ./examples/Namespaces/PnsCredentialsGet.json description: Needs a more full description created. /providers/Microsoft.NotificationHubs/operations: get: tags: - Operations summary: 'Microsoft Azure Lists All Available Notification Hubs Operations' operationId: microsoftAzureOperationsList produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/OperationListResult' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: itemName: value nextLinkName: nextLink x-ms-examples: Operations_List: $ref: ./examples/NHOperationsList.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName} : put: tags: - PrivateLink summary: "Microsoft Azure Approves Or Rejects Private Endpoint Connection \r\nthis Is A Public Api That Can Be Called Directly By Notification Hubs Users" operationId: microsoftAzurePrivateendpointconnectionsUpdate consumes: - application/json produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: '#/parameters/PrivateEndpointConnectionName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - in: body name: parameters description: Description of the Private Endpoint Connection resource. required: true schema: $ref: '#/definitions/PrivateEndpointConnectionResource' responses: '200': description: Updated schema: $ref: '#/definitions/PrivateEndpointConnectionResource' '201': description: Created schema: $ref: '#/definitions/PrivateEndpointConnectionResource' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: PrivateEndpointConnections_Update: $ref: ./examples/Namespaces/PrivateEndpointConnectionUpdate.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation description: Needs a more full description created. delete: tags: - PrivateLink summary: "Microsoft Azure Deletes The Private Endpoint Connection \r\nthis Is A Public Api That Can Be Called Directly By Notification Hubs Users" operationId: microsoftAzurePrivateendpointconnectionsDelete produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: '#/parameters/PrivateEndpointConnectionName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '202': description: Accepted headers: Location: type: string '204': description: No Content default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: PrivateEndpointConnections_Delete: $ref: ./examples/Namespaces/PrivateEndpointConnectionDelete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location description: Needs a more full description created. get: tags: - PrivateLink summary: "Microsoft Azure Returns A Private Endpoint Connection With A Given Name \r\nthis Is A Public Api That Can Be Called Directly By Notification Hubs Users" operationId: microsoftAzurePrivateendpointconnectionsGet produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: '#/parameters/PrivateEndpointConnectionName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/PrivateEndpointConnectionResource' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: PrivateEndpointConnections_Get: $ref: ./examples/Namespaces/PrivateEndpointConnectionGet.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateEndpointConnections : get: tags: - PrivateLink summary: "Microsoft Azure Returns All Private Endpoint Connections That Belong To The Given Notification Hubs Namespace \r\nthis Is A Public Api That Can Be Called Directly By Notification Hubs Users" operationId: microsoftAzurePrivateendpointconnectionsList produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/PrivateEndpointConnectionResourceListResult' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: itemName: value nextLinkName: x-ms-examples: PrivateEndpointConnections_List: $ref: ./examples/Namespaces/PrivateEndpointConnectionList.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateLinkResources/{subResourceName} : get: tags: - PrivateLink summary: "Microsoft Azure Returns Group Id Response \r\nthis Is A Public Api Required By The Networking Rp Contract It Can Be Used Directly By Notification Hubs Users" 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. operationId: microsoftAzurePrivateendpointconnectionsGetgroupid produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - in: path name: subResourceName description: >- Name of the Private Link sub-resource. The only supported sub-resource is "namespace" required: true type: string pattern: ^namespace$ - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/PrivateLinkResource' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: PrivateEndpointConnections_GetGroupId: $ref: ./examples/Namespaces/PrivateLinkResourceGet.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateLinkResources : get: tags: - PrivateLink summary: "Microsoft Azure Returns All Group Ids Supported By The Notification Hubs Rp \r\nthis Is A Public Api Required By The Networking Rp Contract It Can Be Used Directly By Notification Hubs Users" 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. operationId: microsoftAzurePrivateendpointconnectionsListgroupids produces: - application/json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/NamespaceName' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/PrivateLinkResourceListResult' default: description: Error code with reason. schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: itemName: value nextLinkName: x-ms-examples: PrivateEndpointConnections_ListGroupIds: $ref: ./examples/Namespaces/PrivateLinkResourceList.json definitions: AccessRights: description: Defines values for AccessRights. enum: - Manage - Send - Listen type: string x-ms-enum: name: AccessRights modelAsString: true AdmCredential: description: Description of a NotificationHub AdmCredential. required: - properties type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/AdmCredentialProperties' x-ms-secret: true AdmCredentialProperties: description: Description of a NotificationHub AdmCredential. required: - authTokenUrl - clientId - clientSecret type: object properties: clientId: description: Gets or sets the client identifier. minLength: 1 type: string x-ms-secret: true clientSecret: description: Gets or sets the credential secret access key. minLength: 1 type: string x-ms-secret: true authTokenUrl: description: Gets or sets the URL of the authorization token. minLength: 1 type: string x-ms-secret: true ApnsCredential: description: Description of a NotificationHub ApnsCredential. required: - properties type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/ApnsCredentialProperties' x-ms-secret: true ApnsCredentialProperties: description: Description of a NotificationHub ApnsCredential. required: - endpoint type: object properties: apnsCertificate: description: Gets or sets the APNS certificate. type: string x-ms-secret: true certificateKey: description: Gets or sets the certificate key. type: string x-ms-secret: true endpoint: description: Gets or sets the endpoint of this credential. minLength: 1 type: string x-ms-secret: true thumbprint: description: Gets or sets the APNS certificate Thumbprint type: string x-ms-secret: true keyId: description: "Gets or sets a 10-character key identifier (kid) key, obtained from\r\nyour developer account" type: string x-ms-secret: true appName: description: Gets or sets the name of the application type: string x-ms-secret: true appId: description: "Gets or sets the issuer (iss) registered claim key, whose value is\r\nyour 10-character Team ID, obtained from your developer account" type: string x-ms-secret: true token: description: "Gets or sets provider Authentication Token, obtained through your\r\ndeveloper account" type: string x-ms-secret: true Availability: description: Represents metric availability (part of RP operation descriptions). type: object properties: timeGrain: description: Time grain of the availability. type: string readOnly: true blobDuration: description: Duration of the availability blob. type: string readOnly: true BaiduCredential: description: Description of a NotificationHub BaiduCredential. required: - properties type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/BaiduCredentialProperties' x-ms-secret: true BaiduCredentialProperties: description: Description of a NotificationHub BaiduCredential. required: - baiduApiKey - baiduEndPoint - baiduSecretKey type: object properties: baiduApiKey: description: Gets or sets baidu Api Key. minLength: 1 type: string x-ms-secret: true baiduEndPoint: description: Gets or sets baidu Endpoint. minLength: 1 type: string x-ms-secret: true baiduSecretKey: description: Gets or sets baidu Secret Key minLength: 1 type: string x-ms-secret: true BrowserCredential: description: Description of a NotificationHub BrowserCredential. required: - properties type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/BrowserCredentialProperties' x-ms-secret: true BrowserCredentialProperties: description: Description of a NotificationHub BrowserCredential. required: - subject - vapidPrivateKey - vapidPublicKey type: object properties: subject: description: Gets or sets web push subject. minLength: 1 type: string x-ms-secret: true vapidPrivateKey: description: Gets or sets VAPID private key. minLength: 1 type: string x-ms-secret: true vapidPublicKey: description: Gets or sets VAPID public key. minLength: 1 type: string x-ms-secret: true CheckAvailabilityParameters: description: "Parameters supplied to the Check Name Availability for Namespace and\r\nNotificationHubs." required: - name type: object properties: id: description: Gets resource Id type: string readOnly: true name: description: Gets or sets resource name minLength: 1 type: string type: description: Gets resource type type: string readOnly: true location: description: Gets or sets resource location type: string tags: description: Gets or sets resource tags type: object additionalProperties: type: string isAvailiable: description: Not used and deprecated since API version 2023-01-01-preview type: boolean sku: $ref: '#/definitions/Sku' CheckAvailabilityResult: description: Description of a CheckAvailability resource. type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: isAvailiable: description: "Gets or sets true if the name is available and can be used to\r\ncreate new Namespace/NotificationHub. Otherwise false." type: boolean location: description: Deprecated - only for compatibility. type: string x-ms-mutability: - create - read tags: description: Deprecated - only for compatibility. type: object additionalProperties: type: string sku: $ref: '#/definitions/Sku' ConnectionDetails: description: "Part of Private Endpoint description that stores information about a connection between Private Endpoint and Notification Hubs namespace.\r\nThis is internal class, not visible to customers, and we use it only to discover the link identifier." type: object properties: id: description: "A unique ID of the connection. This is not the ARM id, but rather an internal identifier set by the Networking RP. Notification Hubs code\r\ndoes not analyze it." type: string readOnly: true privateIpAddress: description: >- IP address of the Private Endpoint. This is not used by Notification Hubs. type: string readOnly: true linkIdentifier: description: "Link identifier. This is a string representation of an integer that is also encoded in every IPv6 frame received by Front Door,\r\nand we use it to create implicit authorization rule that allows connection from the associated Private Endpoint." type: string readOnly: true groupId: description: Group name. Always "namespace" for Notification Hubs. type: string readOnly: true memberName: description: Member name. Always "namespace" for Notification Hubs. type: string readOnly: true DebugSendResponse: description: Description of a NotificationHub Resource. type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: x-ms-client-flatten: true $ref: '#/definitions/DebugSendResult' location: description: Deprecated - only for compatibility. type: string x-ms-mutability: - create - read tags: description: Deprecated - only for compatibility. type: object additionalProperties: type: string DebugSendResult: description: Result of DebugSend operations. type: object properties: success: format: int64 description: Gets or sets successful send type: integer readOnly: true failure: format: int64 description: Gets or sets send failure type: integer readOnly: true results: description: Gets or sets actual failure description type: array items: $ref: '#/definitions/RegistrationResult' readOnly: true x-ms-identifiers: [] FcmV1Credential: description: Description of a NotificationHub FcmV1Credential. required: - properties type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/FcmV1CredentialProperties' x-ms-secret: true FcmV1CredentialProperties: description: Description of a NotificationHub FcmV1Credential. required: - clientEmail - privateKey - projectId type: object properties: clientEmail: description: Gets or sets client email. minLength: 1 type: string x-ms-secret: true privateKey: description: Gets or sets private key. minLength: 1 type: string x-ms-secret: true projectId: description: Gets or sets project id. minLength: 1 type: string x-ms-secret: true GcmCredential: description: Description of a NotificationHub GcmCredential. required: - properties type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/GcmCredentialProperties' x-ms-secret: true GcmCredentialProperties: description: Description of a NotificationHub GcmCredential. required: - googleApiKey type: object properties: gcmEndpoint: description: Gets or sets the GCM endpoint. type: string x-ms-secret: true googleApiKey: description: Gets or sets the Google API key. minLength: 1 type: string x-ms-secret: true GroupConnectivityInformation: description: "Represents a connectivity information to Notification Hubs namespace. This is part of PrivateLinkService proxy that tell\r\nthe Networking RP how to connect to the Notification Hubs namespace." type: object properties: groupId: description: Group id. Always set to "namespace". type: string readOnly: true memberName: description: Member name. Always set to "namespace". type: string readOnly: true customerVisibleFqdns: description: >- List of customer-visible domain names that point to a Notification Hubs namespace. type: array items: type: string readOnly: true internalFqdn: description: "One of the domain name from the customer-visible names; this is used internally by Private Link service to make connection to Notification Hubs\r\nnamespace." type: string readOnly: true redirectMapId: description: Not used by Notification Hubs. type: string readOnly: true privateLinkServiceArmRegion: description: >- ARM region for Private Link Service. We use the region that contains the connected Notification Hubs namespace. type: string readOnly: true IpRule: description: A network authorization rule that filters traffic based on IP address. required: - ipMask - rights type: object properties: ipMask: description: IP mask. minLength: 1 type: string rights: description: List of access rights. type: array items: $ref: '#/definitions/AccessRights' LogSpecification: description: A single log category specification. type: object properties: name: description: Name of the log category. type: string readOnly: true displayName: description: Display name of the log category. type: string readOnly: true blobDuration: description: Duration of data written to a single blob. type: string readOnly: true categoryGroups: description: Category group for the log specification. type: array items: type: string MetricSpecification: description: A metric specification. type: object properties: name: description: Metric name / id. type: string readOnly: true displayName: description: User-visible metric name. type: string readOnly: true displayDescription: description: Description of the metric. type: string readOnly: true unit: description: Metric unit. type: string readOnly: true aggregationType: description: Type of the aggregation (Average, Minimum, Maximum, Total or Count). type: string readOnly: true availabilities: description: List of availabilities. type: array items: $ref: '#/definitions/Availability' readOnly: true x-ms-identifiers: [] supportedTimeGrainTypes: description: List of supported time grain types. type: array items: type: string readOnly: true x-ms-identifiers: [] metricFilterPattern: description: >- The matching regex pattern to be applied to the field pointed by the "metricsFilterPathSelector" flag in the ARM manifest. type: string readOnly: true fillGapWithZero: description: >- Optional property. If set to true, then zero will be returned for time duration where no metric is emitted / published. type: boolean readOnly: true MpnsCredential: description: Description of a NotificationHub MpnsCredential. required: - properties type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/MpnsCredentialProperties' x-ms-secret: true MpnsCredentialProperties: description: Description of a NotificationHub MpnsCredential. required: - certificateKey - mpnsCertificate - thumbprint type: object properties: mpnsCertificate: description: Gets or sets the MPNS certificate. minLength: 1 type: string x-ms-secret: true certificateKey: description: Gets or sets the certificate key for this credential. minLength: 1 type: string x-ms-secret: true thumbprint: description: Gets or sets the MPNS certificate Thumbprint minLength: 1 type: string x-ms-secret: true NamespaceListResult: description: The response of the List Namespace operation. type: object properties: value: description: Gets or sets result of the List AuthorizationRules operation. type: array items: $ref: '#/definitions/NamespaceResource' readOnly: true nextLink: description: Gets or sets link to the next set of results. type: string readOnly: true NamespacePatchParameters: description: Patch parameter for NamespaceResource. type: object properties: sku: $ref: '#/definitions/Sku' properties: $ref: '#/definitions/NamespaceProperties' tags: type: object additionalProperties: type: string NamespaceProperties: description: Represents namespace properties. type: object properties: name: description: "Name of the Notification Hubs namespace. This is immutable property, set automatically \r\nby the service when the namespace is created." type: string readOnly: true provisioningState: $ref: '#/definitions/OperationProvisioningState' status: $ref: '#/definitions/NamespaceStatus' enabled: description: Gets or sets whether or not the namespace is currently enabled. type: boolean readOnly: true critical: description: Gets or sets whether or not the namespace is set as Critical. type: boolean readOnly: true subscriptionId: description: Namespace subscription id. type: string readOnly: true region: description: "Region. The value is always set to the same value as Namespace.Location, so we are deprecating\r\nthis property." type: string readOnly: true metricId: description: Azure Insights Metrics id. type: string readOnly: true createdAt: format: date-time description: Time when the namespace was created. type: string readOnly: true updatedAt: format: date-time description: Time when the namespace was updated. type: string readOnly: true namespaceType: $ref: '#/definitions/NamespaceType' replicationRegion: $ref: '#/definitions/ReplicationRegion' zoneRedundancy: $ref: '#/definitions/ZoneRedundancyPreference' networkAcls: $ref: '#/definitions/NetworkAcls' pnsCredentials: $ref: '#/definitions/PnsCredentials' serviceBusEndpoint: description: "Gets or sets endpoint you can use to perform NotificationHub\r\noperations." type: string readOnly: true privateEndpointConnections: description: Private Endpoint Connections for namespace type: array items: $ref: '#/definitions/PrivateEndpointConnectionResource' readOnly: true scaleUnit: description: Gets or sets scaleUnit where the namespace gets created type: string x-ms-mutability: - create - read dataCenter: description: Deprecated. type: string publicNetworkAccess: $ref: '#/definitions/PublicNetworkAccess' NamespaceResource: description: Notification Hubs Namespace Resource. required: - location - sku type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource properties: sku: $ref: '#/definitions/Sku' properties: x-ms-client-flatten: true $ref: '#/definitions/NamespaceProperties' NamespaceStatus: description: Namespace status. enum: - Created - Creating - Suspended - Deleting type: string x-ms-enum: name: NamespaceStatus modelAsString: true NamespaceType: description: Defines values for NamespaceType. enum: - Messaging - NotificationHub type: string x-ms-enum: name: NamespaceType modelAsString: true NetworkAcls: description: A collection of network authorization rules. type: object properties: ipRules: description: List of IP rules. type: array items: $ref: '#/definitions/IpRule' x-ms-identifiers: [] publicNetworkRule: $ref: '#/definitions/PublicInternetAuthorizationRule' NotificationHubListResult: description: The response of the List NotificationHub operation. type: object properties: value: description: Gets or sets result of the List AuthorizationRules operation. type: array items: $ref: '#/definitions/NotificationHubResource' readOnly: true nextLink: description: Gets or sets link to the next set of results. type: string readOnly: true NotificationHubPatchParameters: description: Patch parameter for NamespaceResource. type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/NotificationHubProperties' sku: $ref: '#/definitions/Sku' tags: type: object additionalProperties: type: string NotificationHubProperties: description: NotificationHub properties. type: object properties: name: description: Gets or sets the NotificationHub name. type: string x-ms-mutability: - create - read registrationTtl: description: Gets or sets the RegistrationTtl of the created NotificationHub type: string authorizationRules: description: Gets or sets the AuthorizationRules of the created NotificationHub type: array items: $ref: '#/definitions/SharedAccessAuthorizationRuleProperties' readOnly: true x-ms-secret: true x-ms-identifiers: - keyName apnsCredential: $ref: '#/definitions/ApnsCredential' wnsCredential: $ref: '#/definitions/WnsCredential' gcmCredential: $ref: '#/definitions/GcmCredential' mpnsCredential: $ref: '#/definitions/MpnsCredential' admCredential: $ref: '#/definitions/AdmCredential' baiduCredential: $ref: '#/definitions/BaiduCredential' browserCredential: $ref: '#/definitions/BrowserCredential' xiaomiCredential: $ref: '#/definitions/XiaomiCredential' fcmV1Credential: $ref: '#/definitions/FcmV1Credential' dailyMaxActiveDevices: format: int64 type: integer readOnly: true NotificationHubResource: description: Notification Hub Resource. required: - location type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource properties: properties: x-ms-client-flatten: true $ref: '#/definitions/NotificationHubProperties' sku: $ref: '#/definitions/Sku' Operation: description: A NotificationHubs REST API operation type: object properties: name: description: 'Gets operation name: {provider}/{resource}/{operation}' type: string readOnly: true display: $ref: '#/definitions/OperationDisplay' properties: $ref: '#/definitions/OperationProperties' isDataAction: description: >- Gets or sets IsDataAction property. It is used to differentiate management and data plane operations. type: boolean readOnly: true OperationDisplay: description: The object that represents the operation. type: object properties: provider: description: 'Gets service provider: Microsoft.NotificationHubs' type: string readOnly: true resource: description: 'Gets resource on which the operation is performed: Invoice, etc.' type: string readOnly: true operation: description: 'Gets operation type: Read, write, delete, etc.' type: string readOnly: true description: description: Human-friendly operation description. type: string readOnly: true OperationListResult: description: "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." type: object properties: value: description: "Gets list of NotificationHubs operations supported by the\r\nMicrosoft.NotificationHubs resource provider." type: array items: $ref: '#/definitions/Operation' readOnly: true x-ms-identifiers: - name nextLink: description: "Gets URL to get the next set of operation list results if there are\r\nany." type: string readOnly: true OperationProperties: description: Optional operation properties. type: object properties: serviceSpecification: $ref: '#/definitions/ServiceSpecification' OperationProvisioningState: description: Defines values for OperationProvisioningState. enum: - Unknown - InProgress - Succeeded - Failed - Canceled - Pending - Disabled type: string x-ms-enum: name: OperationProvisioningState modelAsString: true PnsCredentials: description: >- Collection of Notification Hub or Notification Hub Namespace PNS credentials. type: object properties: admCredential: $ref: '#/definitions/AdmCredential' apnsCredential: $ref: '#/definitions/ApnsCredential' baiduCredential: $ref: '#/definitions/BaiduCredential' browserCredential: $ref: '#/definitions/BrowserCredential' gcmCredential: $ref: '#/definitions/GcmCredential' mpnsCredential: $ref: '#/definitions/MpnsCredential' wnsCredential: $ref: '#/definitions/WnsCredential' xiaomiCredential: $ref: '#/definitions/XiaomiCredential' fcmV1Credential: $ref: '#/definitions/FcmV1Credential' x-ms-secret: true PnsCredentialsResource: description: "Description of a NotificationHub PNS Credentials. This is a response of the POST requests that return namespace or hubs\r\nPNS credentials." type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: x-ms-client-flatten: true $ref: '#/definitions/PnsCredentials' location: description: Deprecated - only for compatibility. type: string x-ms-mutability: - create - read tags: description: Deprecated - only for compatibility. type: object additionalProperties: type: string PolicyKeyResource: description: Namespace / NotificationHub Regenerate Keys request. required: - policyKey type: object properties: policyKey: $ref: '#/definitions/PolicyKeyType' PolicyKeyType: description: Type of Shared Access Policy Key (primary or secondary). enum: - PrimaryKey - SecondaryKey type: string x-ms-enum: name: PolicyKeyType modelAsString: true PrivateEndpointConnectionProperties: description: Private Endpoint Connection properties. type: object properties: provisioningState: $ref: '#/definitions/PrivateEndpointConnectionProvisioningState' privateEndpoint: $ref: '#/definitions/RemotePrivateEndpointConnection' groupIds: description: >- List of group ids. For Notification Hubs, it always contains a single "namespace" element. type: array items: type: string readOnly: true privateLinkServiceConnectionState: $ref: '#/definitions/RemotePrivateLinkServiceConnectionState' PrivateEndpointConnectionProvisioningState: description: State of Private Endpoint Connection. enum: - Unknown - Succeeded - Creating - Updating - UpdatingByProxy - Deleting - DeletingByProxy - Deleted type: string x-ms-enum: name: PrivateEndpointConnectionProvisioningState modelAsString: true PrivateEndpointConnectionResource: description: >- Represents a Private Endpoint Connection ARM resource - a sub-resource of Notification Hubs namespace. type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/PrivateEndpointConnectionProperties' PrivateEndpointConnectionResourceListResult: description: The response of the List Private Endpoint Connections operation. type: object properties: value: description: Gets or sets result of the List AuthorizationRules operation. type: array items: $ref: '#/definitions/PrivateEndpointConnectionResource' readOnly: true nextLink: description: Gets or sets link to the next set of results. type: string readOnly: true PrivateLinkConnectionStatus: description: State of Private Link Connection. enum: - Disconnected - Pending - Approved - Rejected type: string x-ms-enum: name: PrivateLinkConnectionStatus modelAsString: true PrivateLinkResource: description: A Private Link Arm Resource. type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/PrivateLinkResourceProperties' PrivateLinkResourceListResult: description: The response of the List Private Link Resources operation. type: object properties: value: description: Gets or sets result of the List AuthorizationRules operation. type: array items: $ref: '#/definitions/PrivateLinkResource' readOnly: true nextLink: description: Gets or sets link to the next set of results. type: string readOnly: true PrivateLinkResourceProperties: description: Represents properties of Private Link Resource. type: object properties: groupId: description: >- A Group Id for Private Link. For Notification Hubs, it is always set to "namespace". type: string readOnly: true requiredMembers: description: >- Required members. For Notification Hubs, it's always a collection with a single "namespace" item. type: array items: type: string readOnly: true requiredZoneNames: description: >- Required DNS zone names. For Notification Hubs, it contains two CNames for Service Bus and Notification Hubs zones. type: array items: type: string readOnly: true PrivateLinkServiceConnection: description: >- A customer-visible sub-resource of Private Endpoint, which describe the connection between Private Endpoint and Notification Hubs namespace. type: object properties: name: description: Name of the Private Link Service connection. type: string groupIds: description: >- List of group ids. Always contains a single element - "namespace" - for Notification Hub Namespace. type: array items: type: string requestMessage: description: >- Request message provided by the user that created the connection. This is usually used when the connection requires manual approval. type: string PublicInternetAuthorizationRule: description: >- A default (public Internet) network authorization rule, which contains rights if no other network rule matches. required: - rights type: object properties: rights: description: List of access rights. type: array items: $ref: '#/definitions/AccessRights' PublicNetworkAccess: description: Type of public network access. default: Enabled enum: - Enabled - Disabled type: string x-ms-enum: name: PublicNetworkAccess modelAsString: true RegistrationResult: description: Notification result for a single registration. type: object properties: applicationPlatform: description: PNS type. type: string readOnly: true pnsHandle: description: PNS handle. type: string readOnly: true registrationId: description: Registration id. type: string readOnly: true outcome: description: Notification outcome. type: string readOnly: true RemotePrivateEndpointConnection: description: >- Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. type: object properties: id: description: >- ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. type: string readOnly: true RemotePrivateLinkServiceConnectionState: description: State of the Private Link Service connection. type: object properties: status: $ref: '#/definitions/PrivateLinkConnectionStatus' description: description: Human-friendly description. type: string readOnly: true actionsRequired: description: Human-friendly description of required actions. type: string readOnly: true ReplicationRegion: description: Allowed replication region enum: - Default - WestUs2 - NorthEurope - AustraliaEast - BrazilSouth - SouthEastAsia - SouthAfricaNorth - None type: string x-ms-enum: name: ReplicationRegion modelAsString: true ResourceListKeys: description: >- Response for the POST request that returns Namespace or NotificationHub access keys (connection strings). type: object properties: primaryConnectionString: description: Gets or sets primaryConnectionString of the AuthorizationRule. type: string readOnly: true x-ms-secret: true secondaryConnectionString: description: "Gets or sets secondaryConnectionString of the created\r\nAuthorizationRule" type: string readOnly: true x-ms-secret: true primaryKey: description: Gets or sets primaryKey of the created AuthorizationRule. type: string readOnly: true x-ms-secret: true secondaryKey: description: Gets or sets secondaryKey of the created AuthorizationRule type: string readOnly: true x-ms-secret: true keyName: description: Gets or sets keyName of the created AuthorizationRule type: string readOnly: true ServiceSpecification: description: Optional service specification used in Operations API. type: object properties: logSpecifications: description: Log specifications. type: array items: $ref: '#/definitions/LogSpecification' readOnly: true x-ms-identifiers: - name metricSpecifications: description: Metric specification. type: array items: $ref: '#/definitions/MetricSpecification' readOnly: true x-ms-identifiers: - name - unit SharedAccessAuthorizationRuleListResult: description: The response of the List Namespace operation. type: object properties: value: description: Gets or sets result of the List AuthorizationRules operation. type: array items: $ref: '#/definitions/SharedAccessAuthorizationRuleResource' readOnly: true nextLink: description: Gets or sets link to the next set of results. type: string readOnly: true SharedAccessAuthorizationRuleProperties: description: SharedAccessAuthorizationRule properties. required: - rights type: object properties: rights: description: Gets or sets the rights associated with the rule. type: array items: $ref: '#/definitions/AccessRights' primaryKey: description: "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token." type: string x-ms-secret: true secondaryKey: description: "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token." type: string x-ms-secret: true keyName: description: Gets a string that describes the authorization rule. type: string readOnly: true modifiedTime: format: date-time description: Gets the last modified time for this rule type: string readOnly: true createdTime: format: date-time description: Gets the created time for this rule type: string readOnly: true claimType: description: Gets a string that describes the claim type type: string readOnly: true claimValue: description: Gets a string that describes the claim value type: string readOnly: true revision: format: int32 description: Gets the revision number for the rule type: integer readOnly: true SharedAccessAuthorizationRuleResource: description: >- Response for POST requests that return single SharedAccessAuthorizationRule. type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: x-ms-client-flatten: true $ref: '#/definitions/SharedAccessAuthorizationRuleProperties' location: description: Deprecated - only for compatibility. type: string x-ms-mutability: - create - read tags: description: Deprecated - only for compatibility. type: object additionalProperties: type: string Sku: description: The Sku description for a namespace required: - name type: object properties: name: $ref: '#/definitions/SkuName' tier: description: Gets or sets the tier of particular sku type: string size: description: Gets or sets the Sku size type: string family: description: Gets or sets the Sku Family type: string capacity: format: int32 description: Gets or sets the capacity of the resource type: integer SkuName: description: Namespace SKU name. enum: - Free - Basic - Standard type: string x-ms-enum: name: SkuName modelAsString: true WnsCredential: description: Description of a NotificationHub WnsCredential. required: - properties type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/WnsCredentialProperties' x-ms-secret: true WnsCredentialProperties: description: Description of a NotificationHub WnsCredential. type: object properties: packageSid: description: Gets or sets the package ID for this credential. type: string x-ms-secret: true secretKey: description: Gets or sets the secret key. type: string x-ms-secret: true windowsLiveEndpoint: description: Gets or sets the Windows Live endpoint. type: string x-ms-secret: true certificateKey: description: Ges or sets the WNS Certificate Key. type: string x-ms-secret: true wnsCertificate: description: Gets or sets the WNS Certificate. type: string x-ms-secret: true XiaomiCredential: description: Description of a NotificationHub XiaomiCredential. required: - properties type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/XiaomiCredentialProperties' x-ms-secret: true XiaomiCredentialProperties: description: Description of a NotificationHub XiaomiCredentialProperties. type: object properties: appSecret: description: Gets or sets app secret. type: string x-ms-secret: true endpoint: description: Gets or sets xiaomi service endpoint. type: string x-ms-secret: true ZoneRedundancyPreference: description: Namespace SKU name. default: Disabled enum: - Disabled - Enabled type: string x-ms-enum: name: ZoneRedundancyPreference modelAsString: true x-ms-mutability: - create - read parameters: NamespaceName: in: path name: namespaceName description: Namespace name required: true maxLength: 50 minLength: 1 pattern: ^[a-zA-Z][a-zA-Z0-9-]*$ type: string x-ms-parameter-location: method HubName: in: path name: notificationHubName description: Notification Hub name required: true maxLength: 265 minLength: 1 pattern: ^[a-zA-Z][a-zA-Z0-9-./_]*$ type: string x-ms-parameter-location: method AuthorizationRuleName: in: path name: authorizationRuleName description: Authorization Rule Name required: true maxLength: 256 minLength: 1 pattern: ^[a-zA-Z0-9!()*-._]+$ type: string x-ms-parameter-location: method PrivateEndpointConnectionName: in: path name: privateEndpointConnectionName description: Private Endpoint Connection Name required: true maxLength: 87 minLength: 1 pattern: ^[a-zA-Z][a-zA-Z0-9-]*\.[a-fA-F0-9\-]+$ type: string x-ms-parameter-location: method securityDefinitions: azure_auth: type: oauth2 flow: implicit authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize scopes: user_impersonation: impersonate your user account description: Azure Active Directory OAuth2 Flow security: - azure_auth: - user_impersonation tags: - name: Hubs - name: Namespaces - name: Operations - name: PrivateLink