swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Hubs API schemes: - https tags: - name: Hubs paths: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}: put: tags: - Hubs operationId: microsoftAzureHubsCreateorupdate x-ms-examples: Hubs_CreateOrUpdate: $ref: ./examples/HubsCreateOrUpdate.json description: Creates a hub, or updates an existing hub. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: hubName in: path required: true type: string description: The name of the Hub. pattern: ^[a-zA-Z][a-zA-Z0-9]+$ minLength: 1 maxLength: 64 - name: parameters in: body required: true schema: $ref: '#/definitions/Hub' description: Parameters supplied to the CreateOrUpdate Hub operation. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. An existing hub is updated. schema: $ref: '#/definitions/Hub' '201': description: Created. A new hub is created. schema: $ref: '#/definitions/Hub' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname patch: tags: - Hubs operationId: microsoftAzureHubsUpdate x-ms-examples: Hubs_Update: $ref: ./examples/HubsUpdate.json description: Updates a Hub. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: hubName in: path required: true type: string description: The name of the Hub. - name: parameters in: body required: true schema: $ref: '#/definitions/Hub' description: Parameters supplied to the Update Hub operation. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. The hub is updated. schema: $ref: '#/definitions/Hub' summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname delete: tags: - Hubs operationId: microsoftAzureHubsDelete x-ms-examples: Hubs_Delete: $ref: ./examples/HubsDelete.json description: Deletes the specified hub. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: hubName in: path required: true type: string description: The name of the hub. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. The hub is deleted. '202': description: Accepted. The delete operation is accepted. '204': description: NoContent. Successfully requested delete operation, but the response is intentionally empty. x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname get: tags: - Hubs operationId: microsoftAzureHubsGet x-ms-examples: Hubs_Get: $ref: ./examples/HubsGet.json description: Gets information about the specified hub. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: hubName in: path required: true type: string description: The name of the hub. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. Successfully get the hub. schema: $ref: '#/definitions/Hub' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs: get: tags: - Hubs operationId: microsoftAzureHubsListbyresourcegroup x-ms-examples: Hubs_ListByResourceGroup: $ref: ./examples/HubsListByResourceGroup.json description: Gets all the hubs in a resource group. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. Successfully get all the hubs in the resource group. schema: $ref: '#/definitions/HubListResult' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs /subscriptions/{subscriptionId}/providers/Microsoft.CustomerInsights/hubs: get: tags: - Hubs operationId: microsoftAzureHubsList x-ms-examples: Hubs_List: $ref: ./examples/HubsList.json description: Gets all hubs in the specified subscription. parameters: - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. Successfully get all the hubs in the subscription. schema: $ref: '#/definitions/HubListResult' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Customerinsights Hubs ? /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. 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 Hub: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/HubPropertiesFormat' allOf: - $ref: '#/definitions/Resource' description: Hub resource. HubBillingInfoFormat: properties: skuName: type: string description: The sku name. minUnits: type: integer minimum: 1 maximum: 10 description: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. maxUnits: type: integer minimum: 1 maximum: 10 description: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. description: Hub billing info. 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 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 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 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 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 SkuName: description: Namespace SKU name. enum: - Free - Basic - Standard type: string x-ms-enum: name: SkuName modelAsString: 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 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' 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 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 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. x-ms-azure-resource: true description: Common properties of Azure resource. PolicyKeyResource: description: Namespace / NotificationHub Regenerate Keys request. required: - policyKey type: object properties: policyKey: $ref: '#/definitions/PolicyKeyType' 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 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 HubPropertiesFormat: properties: apiEndpoint: type: string readOnly: true description: API endpoint URL of the hub. webEndpoint: type: string readOnly: true description: Web endpoint URL of the hub. provisioningState: type: string readOnly: true description: Provisioning state of the hub. tenantFeatures: type: integer description: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. hubBillingInfo: $ref: '#/definitions/HubBillingInfoFormat' description: Billing settings of the hub. description: Properties of hub. 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 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 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' 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 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 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 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: [] PolicyKeyType: description: Type of Shared Access Policy Key (primary or secondary). enum: - PrimaryKey - SecondaryKey type: string x-ms-enum: name: PolicyKeyType modelAsString: 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 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 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 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 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 HubListResult: properties: value: type: array items: $ref: '#/definitions/Hub' description: Results of the list operation. nextLink: type: string description: Link for next set of results. description: Response of list hub operation. 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' 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. 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 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'