swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Namespaces API schemes: - https tags: - name: Namespaces paths: /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. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName} : put: tags: - Namespaces x-ms-examples: NameSpaceAuthorizationRuleCreate: $ref: ./examples/Namespaces/NHNameSpaceAuthorizationRuleCreate.json operationId: microsoftAzureNamespacesCreateorupdateauthorizationrule description: Creates an authorization rule for a namespace parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: namespaceName in: path required: true type: string description: The namespace name. - name: authorizationRuleName in: path required: true type: string description: Authorization Rule Name. - name: parameters in: body required: true schema: $ref: '#/definitions/SharedAccessAuthorizationRuleCreateOrUpdateParameters' description: The shared access authorization rule. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: Namespace Authorization Rule is Created/Updated schema: $ref: '#/definitions/SharedAccessAuthorizationRuleResource_2' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Authorizationrules Authorizationrulename delete: tags: - Namespaces x-ms-examples: NameSpaceAuthorizationRuleDelete: $ref: ./examples/Namespaces/NHNameSpaceAuthorizationRuleDelete.json operationId: microsoftAzureNamespacesDeleteauthorizationrule description: Deletes a namespace authorization rule parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: namespaceName in: path required: true type: string description: The namespace name. - name: authorizationRuleName in: path required: true type: string description: Authorization Rule Name. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: Namespace AuthorizationRule is deleted '204': description: Namespace AuthorizationRule is already deleted summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Authorizationrules Authorizationrulename get: tags: - Namespaces x-ms-examples: NameSpaceAuthorizationRuleGet: $ref: ./examples/Namespaces/NHNameSpaceAuthorizationRuleGet.json operationId: microsoftAzureNamespacesGetauthorizationrule description: Gets an authorization rule for a namespace by name. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: namespaceName in: path required: true type: string description: The namespace name - name: authorizationRuleName in: path required: true type: string description: Authorization rule name. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: Get the Namespace AuthorizationRule schema: $ref: '#/definitions/SharedAccessAuthorizationRuleResource_2' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Authorizationrules Authorizationrulename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules : get: tags: - Namespaces x-ms-examples: NameSpaceAuthorizationRuleListAll: $ref: ./examples/Namespaces/NHNameSpaceAuthorizationRuleListAll.json operationId: microsoftAzureNamespacesListauthorizationrules description: Gets the authorization rules for a namespace. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: namespaceName in: path required: true type: string description: The namespace name - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: Get the List of AuthorizationRules of a Namespace schema: $ref: '#/definitions/SharedAccessAuthorizationRuleListResult_2' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Authorizationrules ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/listKeys : post: tags: - Namespaces x-ms-examples: NameSpaceAuthorizationRuleListKey: $ref: ./examples/Namespaces/NHNameSpaceAuthorizationRuleListKey.json operationId: microsoftAzureNamespacesListkeys description: 'Gets the Primary and Secondary ConnectionStrings to the namespace ' parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: namespaceName in: path required: true type: string description: The namespace name. - name: authorizationRuleName in: path required: true type: string description: The connection string of the namespace for the specified authorizationRule. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: Gets the Namespace AuthorizationRule's Primary keys and Secondary keys along with the ConnectionStrings schema: $ref: '#/definitions/ResourceListKeys_2' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Authorizationrules Authorizationrulename Listkeys ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys : post: tags: - Namespaces x-ms-examples: NameSpaceAuthorizationRuleRegenerateKey: $ref: ./examples/Namespaces/NHNameSpaceAuthorizationRuleRegenrateKey.json operationId: microsoftAzureNamespacesRegeneratekeys description: Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: namespaceName in: path required: true type: string description: The namespace name. - name: authorizationRuleName in: path required: true type: string description: The connection string of the namespace for the specified authorizationRule. - name: parameters in: body required: true schema: $ref: '#/definitions/PolicykeyResource' description: Parameters supplied to regenerate the Namespace Authorization Rule Key. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: Regenerate the Primary/Secondary Key and returns the Keys and the connection string schema: $ref: '#/definitions/ResourceListKeys_2' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Authorizationrules Authorizationrulename Regeneratekeys definitions: 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 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 NamespaceStatus: description: Namespace status. enum: - Created - Creating - Suspended - Deleting type: string x-ms-enum: name: NamespaceStatus modelAsString: true PrivateLinkConnectionStatus: description: State of Private Link Connection. enum: - Disconnected - Pending - Approved - Rejected type: string x-ms-enum: name: PrivateLinkConnectionStatus modelAsString: true NamespaceType: description: Defines values for NamespaceType. enum: - Messaging - NotificationHub type: string x-ms-enum: name: NamespaceType 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 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 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 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 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 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 SkuName: description: Namespace SKU name. enum: - Free - Basic - Standard type: string x-ms-enum: name: SkuName modelAsString: true ReplicationRegion: description: Allowed replication region enum: - Default - WestUs2 - NorthEurope - AustraliaEast - BrazilSouth - SouthEastAsia - SouthAfricaNorth - None type: string x-ms-enum: name: ReplicationRegion modelAsString: true SharedAccessAuthorizationRuleResource_2: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/SharedAccessAuthorizationRuleProperties_2' description: Properties of the Namespace AuthorizationRule. allOf: - $ref: '#/definitions/Resource' description: Description of a Namespace AuthorizationRules. 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 OperationProvisioningState: description: Defines values for OperationProvisioningState. enum: - Unknown - InProgress - Succeeded - Failed - Canceled - Pending - Disabled type: string x-ms-enum: name: OperationProvisioningState modelAsString: 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 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' NamespacePatchParameters: description: Patch parameter for NamespaceResource. type: object properties: sku: $ref: '#/definitions/Sku' properties: $ref: '#/definitions/NamespaceProperties' tags: type: object additionalProperties: type: string 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 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 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 Resource: properties: id: readOnly: true type: string description: Resource Id name: readOnly: true type: string description: Resource name type: readOnly: true type: string description: Resource type location: type: string description: Resource location tags: type: object additionalProperties: type: string description: Resource tags sku: $ref: '#/definitions/Sku_2' description: The sku of the created namespace x-ms-azure-resource: 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' ZoneRedundancyPreference: description: Namespace SKU name. default: Disabled enum: - Disabled - Enabled type: string x-ms-enum: name: ZoneRedundancyPreference modelAsString: true x-ms-mutability: - create - read PolicyKeyResource: description: Namespace / NotificationHub Regenerate Keys request. required: - policyKey type: object properties: policyKey: $ref: '#/definitions/PolicyKeyType' 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' SharedAccessAuthorizationRuleCreateOrUpdateParameters: properties: properties: $ref: '#/definitions/SharedAccessAuthorizationRuleProperties_2' description: Properties of the Namespace AuthorizationRules. required: - properties description: Parameters supplied to the CreateOrUpdate Namespace AuthorizationRules. 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 PublicNetworkAccess: description: Type of public network access. default: Enabled enum: - Enabled - Disabled type: string x-ms-enum: name: PublicNetworkAccess modelAsString: true Sku_2: properties: name: type: string description: Name of the notification hub sku enum: - Free - Basic - Standard x-ms-enum: name: SkuName modelAsString: true tier: type: string description: The tier of particular sku size: type: string description: The Sku size family: type: string description: The Sku Family capacity: type: integer description: The capacity of the resource required: - name description: The Sku description for a namespace 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 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 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 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 SharedAccessAuthorizationRuleProperties_2: properties: rights: type: array items: type: string enum: - Manage - Send - Listen x-ms-enum: name: AccessRights modelAsString: false description: The rights associated with the rule. primaryKey: readOnly: true type: string description: A base64-encoded 256-bit primary key for signing and validating the SAS token. secondaryKey: readOnly: true type: string description: A base64-encoded 256-bit primary key for signing and validating the SAS token. keyName: readOnly: true type: string description: A string that describes the authorization rule. claimType: readOnly: true type: string description: A string that describes the claim type claimValue: readOnly: true type: string description: A string that describes the claim value modifiedTime: readOnly: true type: string description: The last modified time for this rule createdTime: readOnly: true type: string description: The created time for this rule revision: readOnly: true type: integer description: The revision number for the rule description: SharedAccessAuthorizationRule properties. 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 PolicykeyResource: properties: policyKey: type: string description: Name of the key that has to be regenerated for the Namespace/Notification Hub Authorization Rule. The value can be Primary Key/Secondary Key. description: Namespace/NotificationHub Regenerate Keys 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 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' AccessRights: description: Defines values for AccessRights. enum: - Manage - Send - Listen type: string x-ms-enum: name: AccessRights modelAsString: 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 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 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' 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 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 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 ResourceListKeys_2: properties: primaryConnectionString: type: string description: PrimaryConnectionString of the AuthorizationRule. secondaryConnectionString: type: string description: SecondaryConnectionString of the created AuthorizationRule primaryKey: type: string description: PrimaryKey of the created AuthorizationRule. secondaryKey: type: string description: SecondaryKey of the created AuthorizationRule keyName: type: string description: KeyName of the created AuthorizationRule description: Namespace/NotificationHub Connection String 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 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' PolicyKeyType: description: Type of Shared Access Policy Key (primary or secondary). enum: - PrimaryKey - SecondaryKey type: string x-ms-enum: name: PolicyKeyType modelAsString: 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 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 SharedAccessAuthorizationRuleListResult_2: properties: value: type: array items: $ref: '#/definitions/SharedAccessAuthorizationRuleResource_2' description: Result of the List AuthorizationRules operation. nextLink: type: string description: Link to the next set of results. Not empty if Value contains incomplete list of AuthorizationRules description: The response of the List Namespace operation. 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 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' 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' 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' parameters: ApiVersionParameter: name: api-version in: query required: true type: string description: Client Api Version. 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 SubscriptionIdParameter: name: subscriptionId in: path required: true type: string description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. 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 x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'