Microsoft Azure NotificationHubs API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector NotificationHubs API
schemes:
- https
tags:
- name: NotificationHubs
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/checkNotificationHubAvailability
  : post:
      tags:
      - NotificationHubs
      x-ms-examples:
        notificationHubCheckNameAvailability:
          $ref: ./examples/NotificationHubs/NotificationHubCheckNameAvailability.json
      operationId: microsoftAzureNotificationhubsChecknotificationhubavailability
      description: Checks the availability of the given notificationHub in 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: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/CheckAvailabilityParameters'
        description: The notificationHub name.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Checks if the NotificationHub name is a valid available name
          schema:
            $ref: '#/definitions/CheckAvailabilityResult'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Checknotificationhubavailability
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}
  : put:
      tags:
      - NotificationHubs
      x-ms-examples:
        NotificationHubCreate:
          $ref: ./examples/NotificationHubs/NotificationHubCreate.json
      operationId: microsoftAzureNotificationhubsCreateorupdate
      description: Creates/Update a NotificationHub in 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: notificationHubName
        in: path
        required: true
        type: string
        description: The notification hub name.
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/NotificationHubCreateOrUpdateParameters'
        description: Parameters supplied to the create/update a NotificationHub Resource.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: NotificationHub is Created/Updated
          schema:
            $ref: '#/definitions/NotificationHubResource'
        '201':
          description: NotificationHub is Created/Updated
          schema:
            $ref: '#/definitions/NotificationHubResource'
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Notificationhubs Notificationhubname
    patch:
      tags:
      - NotificationHubs
      x-ms-examples:
        NotificationHubPatch:
          $ref: ./examples/NotificationHubs/NotificationHubPatch.json
      operationId: microsoftAzureNotificationhubsPatch
      description: Patch a NotificationHub in 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: notificationHubName
        in: path
        required: true
        type: string
        description: The notification hub name.
      - name: parameters
        in: body
        required: false
        schema:
          $ref: '#/definitions/NotificationHubPatchParameters'
        description: Parameters supplied to patch a NotificationHub Resource.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: NotificationHub is patched
          schema:
            $ref: '#/definitions/NotificationHubResource'
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Notificationhubs Notificationhubname
    delete:
      tags:
      - NotificationHubs
      x-ms-examples:
        NotificationHubDelete:
          $ref: ./examples/NotificationHubs/NotificationHubDelete.json
      operationId: microsoftAzureNotificationhubsDelete
      description: Deletes a notification hub associated with 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: notificationHubName
        in: path
        required: true
        type: string
        description: The notification hub name.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Namespace is deleted
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Notificationhubs Notificationhubname
    get:
      tags:
      - NotificationHubs
      x-ms-examples:
        NotificationHubGet:
          $ref: ./examples/NotificationHubs/NotificationHubGet.json
      operationId: microsoftAzureNotificationhubsGet
      description: Lists the notification hubs associated with 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: notificationHubName
        in: path
        required: true
        type: string
        description: The notification hub name.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Get the NotificationHub
          schema:
            $ref: '#/definitions/NotificationHubResource'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Notificationhubs Notificationhubname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/debugsend
  : post:
      tags:
      - NotificationHubs
      x-ms-examples:
        debugsend:
          $ref: ./examples/NotificationHubs/NotificationHubDebugSend.json
      operationId: microsoftAzureNotificationhubsDebugsend
      description: test send a push notification
      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: notificationHubName
        in: path
        required: true
        type: string
        description: The notification hub name.
      - name: parameters
        in: body
        required: false
        schema:
          $ref: '#/definitions/DebugSendParameters'
        description: Debug send parameters
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '201':
          description: push send status
          schema:
            $ref: '#/definitions/DebugSendResponse'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Notificationhubs Notificationhubname Debugsend
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules/{authorizationRuleName}
  : put:
      tags:
      - NotificationHubs
      x-ms-examples:
        NotificationHubAuthorizationRuleCreate:
          $ref: ./examples/NotificationHubs/NotificationHubAuthorizationRuleCreate.json
      operationId: microsoftAzureNotificationhubsCreateorupdateauthorizationrule
      description: Creates/Updates an authorization rule for a NotificationHub
      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: notificationHubName
        in: path
        required: true
        type: string
        description: The notification hub 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: NotificationHub AuthorizationRule is Created/Updated
          schema:
            $ref: '#/definitions/SharedAccessAuthorizationRuleResource'
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Notificationhubs Notificationhubname Authorizationrules Authorizationrulename
    delete:
      tags:
      - NotificationHubs
      x-ms-examples:
        NotificationHubAuthorizationRuleDelete:
          $ref: ./examples/NotificationHubs/NotificationHubAuthorizationRuleDelete.json
      operationId: microsoftAzureNotificationhubsDeleteauthorizationrule
      description: Deletes a notificationHub 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: notificationHubName
        in: path
        required: true
        type: string
        description: The notification hub name.
      - name: authorizationRuleName
        in: path
        required: true
        type: string
        description: Authorization Rule Name.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: NotificationHub AuthorizationRule is deleted
        '204':
          description: NotificationHub AuthorizationRule is already deleted
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Notificationhubs Notificationhubname Authorizationrules Authorizationrulename
    get:
      tags:
      - NotificationHubs
      x-ms-examples:
        NotificationHubAuthorizationRuleGet:
          $ref: ./examples/NotificationHubs/NotificationHubAuthorizationRuleGet.json
      operationId: microsoftAzureNotificationhubsGetauthorizationrule
      description: Gets an authorization rule for a NotificationHub 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: notificationHubName
        in: path
        required: true
        type: string
        description: The notification hub name.
      - name: authorizationRuleName
        in: path
        required: true
        type: string
        description: authorization rule name.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Get NotificationHub AuthorizationRule
          schema:
            $ref: '#/definitions/SharedAccessAuthorizationRuleResource'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Notificationhubs Notificationhubname Authorizationrules Authorizationrulename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs
  : get:
      tags:
      - NotificationHubs
      x-ms-examples:
        NotificationHubListByNameSpace:
          $ref: ./examples/NotificationHubs/NotificationHubListByNameSpace.json
      operationId: microsoftAzureNotificationhubsList
      description: Lists the notification hubs associated with 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 all NotificationHubs within a Namespace
          schema:
            $ref: '#/definitions/NotificationHubListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Notificationhubs
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules
  : get:
      tags:
      - NotificationHubs
      x-ms-examples:
        NotificationHubAuthorizationRuleListAll:
          $ref: ./examples/NotificationHubs/NotificationHubAuthorizationRuleListAll.json
      operationId: microsoftAzureNotificationhubsListauthorizationrules
      description: Gets the authorization rules for a NotificationHub.
      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: notificationHubName
        in: path
        required: true
        type: string
        description: The notification hub name.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Get all NotificationHub AuthorizationRules
          schema:
            $ref: '#/definitions/SharedAccessAuthorizationRuleListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Notificationhubs Notificationhubname Authorizationrules
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules/{authorizationRuleName}/listKeys
  : post:
      tags:
      - NotificationHubs
      x-ms-examples:
        NotificationHubAuthorizationRuleListKey:
          $ref: ./examples/NotificationHubs/NotificationHubAuthorizationRuleListKey.json
      operationId: microsoftAzureNotificationhubsListkeys
      description: 'Gets the Primary and Secondary ConnectionStrings to the NotificationHub '
      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: notificationHubName
        in: path
        required: true
        type: string
        description: The notification hub name.
      - name: authorizationRuleName
        in: path
        required: true
        type: string
        description: The connection string of the NotificationHub 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'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Notificationhubs Notificationhubname Authorizationrules Authorizationrulename Listkeys
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys
  : post:
      tags:
      - NotificationHubs
      x-ms-examples:
        NotificationHubAuthorizationRuleRegenrateKey:
          $ref: ./examples/NotificationHubs/NotificationHubAuthorizationRuleRegenrateKey.json
      operationId: microsoftAzureNotificationhubsRegeneratekeys
      description: Regenerates the Primary/Secondary Keys to the NotificationHub 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: notificationHubName
        in: path
        required: true
        type: string
        description: The notification hub name.
      - name: authorizationRuleName
        in: path
        required: true
        type: string
        description: The connection string of the NotificationHub for the specified authorizationRule.
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/PolicykeyResource'
        description: Parameters supplied to regenerate the NotificationHub 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'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Notificationhubs Notificationhubname Authorizationrules Authorizationrulename Regeneratekeys
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/pnsCredentials
  : post:
      tags:
      - NotificationHubs
      x-ms-examples:
        notificationHubPnsCredentials:
          $ref: ./examples/NotificationHubs/NotificationHubPnsCredentials.json
      operationId: microsoftAzureNotificationhubsGetpnscredentials
      description: Lists the PNS Credentials associated with a notification hub .
      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: notificationHubName
        in: path
        required: true
        type: string
        description: The notification hub name.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Gets all the NotificationHub PNS credentials
          schema:
            $ref: '#/definitions/PnsCredentialsResource'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Notificationhubs Notificationhubname Pnscredentials
definitions:
  ApnsCredential:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ApnsCredentialProperties'
        description: Properties of NotificationHub ApnsCredential.
    description: Description of a NotificationHub ApnsCredential.
  ResourceListKeys:
    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
  PnsCredentialsProperties:
    properties:
      apnsCredential:
        $ref: '#/definitions/ApnsCredential'
        description: The ApnsCredential of the created NotificationHub
      wnsCredential:
        $ref: '#/definitions/WnsCredential'
        description: The WnsCredential of the created NotificationHub
      gcmCredential:
        $ref: '#/definitions/GcmCredential'
        description: The GcmCredential of the created NotificationHub
      mpnsCredential:
        $ref: '#/definitions/MpnsCredential'
        description: The MpnsCredential of the created NotificationHub
      admCredential:
        $ref: '#/definitions/AdmCredential'
        description: The AdmCredential of the created NotificationHub
      baiduCredential:
        $ref: '#/definitions/BaiduCredential'
        description: The BaiduCredential of the created NotificationHub
    description: Description of a NotificationHub PNS Credentials.
  Sku:
    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
  BaiduCredential:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/BaiduCredentialProperties'
        description: Properties of NotificationHub BaiduCredential.
    description: Description of a NotificationHub BaiduCredential.
  NotificationHubListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/NotificationHubResource'
        description: Result of the List NotificationHub operation.
      nextLink:
        type: string
        description: Link to the next set of results. Not empty if Value contains incomplete list of NotificationHub
    description: The response of the List NotificationHub operation.
  SharedAccessAuthorizationRuleResource:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/SharedAccessAuthorizationRuleProperties'
        description: Properties of the Namespace AuthorizationRule.
    allOf:
    - $ref: '#/definitions/Resource'
    description: Description of a Namespace AuthorizationRules.
  CheckAvailabilityResult:
    properties:
      isAvailiable:
        type: boolean
        description: True if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false.
    allOf:
    - $ref: '#/definitions/Resource'
    description: Description of a CheckAvailability resource.
  DebugSendParameters:
    description: Debug Send payload
    type: object
  BaiduCredentialProperties:
    properties:
      baiduApiKey:
        type: string
        description: Baidu Api Key.
      baiduEndPoint:
        type: string
        description: Baidu Endpoint.
      baiduSecretKey:
        type: string
        description: Baidu Secret Key
    description: Description of a NotificationHub BaiduCredential.
  DebugSendResponse:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/DebugSendResult'
        description: Properties of the NotificationHub.
    allOf:
    - $ref: '#/definitions/Resource'
    description: Description of a NotificationHub Resource.
  WnsCredentialProperties:
    properties:
      packageSid:
        type: string
        description: The package ID for this credential.
      secretKey:
        type: string
        description: The secret key.
      windowsLiveEndpoint:
        type: string
        description: The Windows Live endpoint.
    description: Description of a NotificationHub WnsCredential.
  AdmCredentialProperties:
    properties:
      clientId:
        type: string
        description: The client identifier.
      clientSecret:
        type: string
        description: The credential secret access key.
      authTokenUrl:
        type: string
        description: The URL of the authorization token.
    description: Description of a NotificationHub AdmCredential.
  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'
        description: The sku of the created namespace
    x-ms-azure-resource: true
  SharedAccessAuthorizationRuleCreateOrUpdateParameters:
    properties:
      properties:
        $ref: '#/definitions/SharedAccessAuthorizationRuleProperties'
        description: Properties of the Namespace AuthorizationRules.
    required:
    - properties
    description: Parameters supplied to the CreateOrUpdate Namespace AuthorizationRules.
  PnsCredentialsResource:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/PnsCredentialsProperties'
        description: NotificationHub PNS Credentials.
    allOf:
    - $ref: '#/definitions/Resource'
    description: Description of a NotificationHub PNS Credentials.
  GcmCredential:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/GcmCredentialProperties'
        description: Properties of NotificationHub GcmCredential.
    description: Description of a NotificationHub GcmCredential.
  ApnsCredentialProperties:
    properties:
      apnsCertificate:
        type: string
        description: The APNS certificate. Specify if using Certificate Authentication Mode.
      certificateKey:
        type: string
        description: The APNS certificate password if it exists.
      endpoint:
        type: string
        description: The APNS endpoint of this credential. If using Certificate Authentication Mode and Sandbox specify 'gateway.sandbox.push.apple.com'. If using Certificate Authentication Mode and Production specify 'gateway.push.apple.com'. If using Token Authentication Mode and Sandbox specify 'https://api.development.push.apple.com:443/3/device'. If using Token Authentication Mode and Production specify 'https://api.push.apple.com:443/3/device'.
      thumbprint:
        type: string
        description: The APNS certificate thumbprint. Specify if using Certificate Authentication Mode.
      keyId:
        type: string
        description: A 10-character key identifier (kid) key, obtained from your developer account. Specify if using Token Authentication Mode.
      appName:
        type: string
        description: The name of the application or BundleId. Specify if using Token Authentication Mode.
      appId:
        type: string
        description: The issuer (iss) registered claim key. The value is a 10-character TeamId, obtained from your developer account. Specify if using Token Authentication Mode.
      token:
        type: string
        description: Provider Authentication Token, obtained through your developer account. Specify if using Token Authentication Mode.
    description: Description of a NotificationHub ApnsCredential. Note that there is no explicit switch between Certificate and Token Authentication Modes. The mode is determined based on the properties passed in.
  MpnsCredential:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/MpnsCredentialProperties'
        description: Properties of NotificationHub MpnsCredential.
    description: Description of a NotificationHub MpnsCredential.
  MpnsCredentialProperties:
    properties:
      mpnsCertificate:
        type: string
        description: The MPNS certificate.
      certificateKey:
        type: string
        description: The certificate key for this credential.
      thumbprint:
        type: string
        description: The MPNS certificate Thumbprint
    description: Description of a NotificationHub MpnsCredential.
  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
  NotificationHubResource:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/NotificationHubProperties'
        description: Properties of the NotificationHub.
    allOf:
    - $ref: '#/definitions/Resource'
    description: Description of a NotificationHub Resource.
  WnsCredential:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/WnsCredentialProperties'
        description: Properties of NotificationHub WnsCredential.
    description: Description of a NotificationHub WnsCredential.
  SharedAccessAuthorizationRuleListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/SharedAccessAuthorizationRuleResource'
        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.
  NotificationHubProperties:
    properties:
      name:
        type: string
        description: The NotificationHub name.
      registrationTtl:
        type: string
        description: The RegistrationTtl of the created NotificationHub
      authorizationRules:
        type: array
        items:
          $ref: '#/definitions/SharedAccessAuthoriza

# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-notificationhubs-api-openapi.yml