The Microsoft Azure Notification Hubs RP Client is a software development kit that enables developers to easily integrate push notifications into their mobile or web applications. With this client, developers can create and manage notification hubs to send personalized and targeted messages to their users across various platforms, including iOS, Android, and Windows.
swagger: '2.0'
info:
title: Microsoft Azure NotificationHubs RP Client
description: Microsoft Notification Hubs Resource Provider REST API.
version: 2023-10-01-preview
host: management.azure.com
schemes:
- https
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/checkNotificationHubAvailability
: post:
tags:
- Hubs
summary: 'Microsoft Azure Checks The Availability Of The Given Notificationhub In A Namespace'
operationId: microsoftAzureNotificationhubsChecknotificationhubavailability
consumes:
- application/json
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- in: body
name: parameters
description: Request content.
required: true
schema:
$ref: '#/definitions/CheckAvailabilityParameters'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/CheckAvailabilityResult'
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
NotificationHubs_CheckNotificationHubAvailability:
$ref: ./examples/NotificationHubs/CheckAvailability.json
description: Needs a more full description created.
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}
: get:
tags:
- Hubs
summary: 'Microsoft Azure Gets The Notification Hub'
operationId: microsoftAzureNotificationhubsGet
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: '#/parameters/HubName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
schema:
$ref: '#/definitions/NotificationHubResource'
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
NotificationHubs_Get:
$ref: ./examples/NotificationHubs/Get.json
description: Needs a more full description created.
put:
tags:
- Hubs
summary: 'Microsoft Azure Creates Update A Notificationhub In A Namespace'
operationId: microsoftAzureNotificationhubsCreateorupdate
consumes:
- application/json
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: '#/parameters/HubName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- in: body
name: parameters
description: Request content.
required: true
schema:
$ref: '#/definitions/NotificationHubResource'
responses:
'200':
description: Updated
schema:
$ref: '#/definitions/NotificationHubResource'
'201':
description: Created
schema:
$ref: '#/definitions/NotificationHubResource'
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
NotificationHubs_CreateOrUpdate:
$ref: ./examples/NotificationHubs/CreateOrUpdate.json
description: Needs a more full description created.
patch:
tags:
- Hubs
summary: 'Microsoft Azure Patch A Notificationhub In A Namespace'
operationId: microsoftAzureNotificationhubsUpdate
consumes:
- application/json
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: '#/parameters/HubName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- in: body
name: parameters
description: Request content.
required: true
schema:
$ref: '#/definitions/NotificationHubPatchParameters'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/NotificationHubResource'
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
NotificationHubs_Update:
$ref: ./examples/NotificationHubs/Update.json
description: Needs a more full description created.
delete:
tags:
- Hubs
summary: 'Microsoft Azure Deletes A Notification Hub Associated With A Namespace'
operationId: microsoftAzureNotificationhubsDelete
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: '#/parameters/HubName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
'204':
description: No Content
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
NotificationHubs_Delete:
$ref: ./examples/NotificationHubs/Delete.json
description: Needs a more full description created.
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs
: get:
tags:
- Hubs
summary: 'Microsoft Azure Lists The Notification Hubs Associated With A Namespace'
operationId: microsoftAzureNotificationhubsList
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- in: query
name: $skipToken
description: Continuation token.
type: string
- in: query
name: $top
description: Page size.
type: integer
format: int32
default: 100
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
schema:
$ref: '#/definitions/NotificationHubListResult'
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-pageable:
itemName: value
nextLinkName: nextLink
x-ms-examples:
NotificationHubs_List:
$ref: ./examples/NotificationHubs/List.json
description: Needs a more full description created.
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/debugsend
: post:
tags:
- Hubs
summary: 'Microsoft Azure Test Send A Push Notification'
operationId: microsoftAzureNotificationhubsDebugsend
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: '#/parameters/HubName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
schema:
$ref: '#/definitions/DebugSendResponse'
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
NotificationHubs_DebugSend:
$ref: ./examples/NotificationHubs/DebugSend.json
description: Needs a more full description created.
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}
: put:
tags:
- Hubs
summary: Microsoft Azure Creates Updates An Authorization Rule For A Notificationhub
operationId: microsoftAzureNotificationhubsCreateorupdateauthorizationrule
consumes:
- application/json
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: '#/parameters/HubName'
- $ref: '#/parameters/AuthorizationRuleName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- in: body
name: parameters
description: Request content.
required: true
schema:
$ref: '#/definitions/SharedAccessAuthorizationRuleResource'
responses:
'200':
description: Updated
schema:
$ref: '#/definitions/SharedAccessAuthorizationRuleResource'
'201':
description: Created
schema:
$ref: '#/definitions/SharedAccessAuthorizationRuleResource'
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
NotificationHubs_CreateOrUpdateAuthorizationRule:
$ref: ./examples/NotificationHubs/AuthorizationRuleCreateOrUpdate.json
description: Needs a more full description created.
delete:
tags:
- Hubs
summary: Microsoft Azure Deletes A Notificationhub Authorization Rule
operationId: microsoftAzureNotificationhubsDeleteauthorizationrule
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: '#/parameters/HubName'
- $ref: '#/parameters/AuthorizationRuleName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
'204':
description: No Content
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
NotificationHubs_DeleteAuthorizationRule:
$ref: ./examples/NotificationHubs/AuthorizationRuleDelete.json
description: Needs a more full description created.
get:
tags:
- Hubs
summary: 'Microsoft Azure Gets An Authorization Rule For A Notificationhub By Name'
operationId: microsoftAzureNotificationhubsGetauthorizationrule
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: '#/parameters/HubName'
- $ref: '#/parameters/AuthorizationRuleName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
schema:
$ref: '#/definitions/SharedAccessAuthorizationRuleResource'
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
NotificationHubs_GetAuthorizationRule:
$ref: ./examples/NotificationHubs/AuthorizationRuleGet.json
description: Needs a more full description created.
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules
: get:
tags:
- Hubs
summary: 'Microsoft Azure Gets The Authorization Rules For A Notificationhub'
operationId: microsoftAzureNotificationhubsListauthorizationrules
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: '#/parameters/HubName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
schema:
$ref: '#/definitions/SharedAccessAuthorizationRuleListResult'
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-pageable:
itemName: value
nextLinkName: nextLink
x-ms-examples:
NotificationHubs_ListAuthorizationRules:
$ref: ./examples/NotificationHubs/AuthorizationRuleList.json
description: Needs a more full description created.
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}/listKeys
: post:
tags:
- Hubs
summary: Microsoft Azure Gets The Primary And Secondary Connectionstrings To The Notificationhub
operationId: microsoftAzureNotificationhubsListkeys
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: '#/parameters/HubName'
- $ref: '#/parameters/AuthorizationRuleName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
schema:
$ref: '#/definitions/ResourceListKeys'
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
NotificationHubs_ListKeys:
$ref: ./examples/NotificationHubs/AuthorizationRuleListKeys.json
description: Needs a more full description created.
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}/regenerateKeys
: post:
tags:
- Hubs
summary: >-
Microsoft Azure Regenerates The Primary Secondary Keys To The Notificationhub Authorization Rule
operationId: microsoftAzureNotificationhubsRegeneratekeys
consumes:
- application/json
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: '#/parameters/HubName'
- $ref: '#/parameters/AuthorizationRuleName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- in: body
name: parameters
description: Request content.
required: true
schema:
$ref: '#/definitions/PolicyKeyResource'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/ResourceListKeys'
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
NotificationHubs_RegenerateKeys:
$ref: ./examples/NotificationHubs/AuthorizationRuleRegenerateKey.json
description: Needs a more full description created.
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/pnsCredentials
: post:
tags:
- Hubs
summary: 'Microsoft Azure Lists The Pns Credentials Associated With A Notification Hub'
operationId: microsoftAzureNotificationhubsGetpnscredentials
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: '#/parameters/HubName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
schema:
$ref: '#/definitions/PnsCredentialsResource'
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
NotificationHubs_GetPnsCredentials:
$ref: ./examples/NotificationHubs/PnsCredentialsGet.json
description: Needs a more full description created.
/subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/checkNamespaceAvailability:
post:
tags:
- Namespaces
summary: >-
Microsoft Azure Checks The Availability Of The Given Service Namespace Across All Azure Subscriptions This Is Useful Because The Domain Name Is Created Based On The Service Namespace Name
operationId: microsoftAzureNamespacesCheckavailability
consumes:
- application/json
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- in: body
name: parameters
description: Request content.
required: true
schema:
$ref: '#/definitions/CheckAvailabilityParameters'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/CheckAvailabilityResult'
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Namespaces_CheckAvailability:
$ref: ./examples/Namespaces/CheckAvailability.json
description: Needs a more full description created.
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}
: get:
tags:
- Namespaces
summary: 'Microsoft Azure Returns The Given Namespace'
operationId: microsoftAzureNamespacesGet
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
schema:
$ref: '#/definitions/NamespaceResource'
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Namespaces_Get:
$ref: ./examples/Namespaces/Get.json
description: Needs a more full description created.
put:
tags:
- Namespaces
summary: >-
Microsoft Azure Creates Updates A Notification Hub Namespace This Operation Is Idempotent
operationId: microsoftAzureNamespacesCreateorupdate
consumes:
- application/json
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- in: body
name: parameters
description: Request content.
required: true
schema:
$ref: '#/definitions/NamespaceResource'
responses:
'200':
description: Updated
schema:
$ref: '#/definitions/NamespaceResource'
'201':
description: Created
schema:
$ref: '#/definitions/NamespaceResource'
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Namespaces_CreateOrUpdate:
$ref: ./examples/Namespaces/CreateOrUpdate.json
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
description: Needs a more full description created.
patch:
tags:
- Namespaces
summary: 'Microsoft Azure Patches The Existing Namespace'
operationId: microsoftAzureNamespacesUpdate
consumes:
- application/json
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- in: body
name: parameters
description: Request content.
required: true
schema:
$ref: '#/definitions/NamespacePatchParameters'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/NamespaceResource'
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Namespaces_Update:
$ref: ./examples/Namespaces/Update.json
description: Needs a more full description created.
delete:
tags:
- Namespaces
summary: >-
Microsoft Azure Deletes An Existing Namespace This Operation Also Removes All Associated Notificationhubs Under The Namespace
operationId: microsoftAzureNamespacesDelete
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
'204':
description: No Content
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Namespaces_Delete:
$ref: ./examples/Namespaces/Delete.json
description: Needs a more full description created.
/subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/namespaces:
get:
tags:
- Namespaces
summary: 'Microsoft Azure Lists All The Available Namespaces Within The Subscription'
operationId: microsoftAzureNamespacesListall
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- in: query
name: $skipToken
description: Skip token for subsequent requests.
type: string
- in: query
name: $top
description: Maximum number of results to return.
type: integer
format: int32
default: 100
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
schema:
$ref: '#/definitions/NamespaceListResult'
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-pageable:
itemName: value
nextLinkName: nextLink
x-ms-examples:
Namespaces_ListAll:
$ref: ./examples/Namespaces/ListBySubscription.json
description: Needs a more full description created.
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces:
get:
tags:
- Namespaces
summary: 'Microsoft Azure Lists The Available Namespaces Within A Resource Group'
operationId: microsoftAzureNamespacesList
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- in: query
name: $skipToken
description: Skip token for subsequent requests.
type: string
- in: query
name: $top
description: Maximum number of results to return.
type: integer
format: int32
default: 100
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
schema:
$ref: '#/definitions/NamespaceListResult'
default:
description: Error code with reason.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-pageable:
itemName: value
nextLinkName: nextLink
x-ms-examples:
Namespaces_List:
$ref: ./examples/Namespaces/ListByResourceGroup.json
description: Needs a more full description created.
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
: put:
tags:
- Namespaces
summary: Microsoft Azure Creates An Authorization Rule For A Namespace
operationId: microsoftAzureNamespacesCreateorupdateauthorizationrule
consumes:
- application/json
produces:
- application/json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: '#/parameters/AuthorizationRuleName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- in: body
name: parameters
description: Request content.
required: true
schema:
$ref: '#/definitions/SharedAccessAuthorizationRuleReso
# --- truncated at 32 KB (93 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/notificationhubs-rp-client-openapi-original.yml