The Microsoft Azure Notification Hubs Management Client is a tool designed to manage and control the Notification Hubs service within the Azure platform. This client allows users to easily create, manage, and send notifications to their mobile applications or devices across multiple platforms, including iOS, Android, and Windows.
swagger: '2.0'
info:
title: Microsoft Azure NotificationHubsManagementClient
description: Azure NotificationHub client
version: '2017-04-01'
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- azure_auth:
- user_impersonation
securityDefinitions:
azure_auth:
type: oauth2
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
flow: implicit
description: Azure Active Directory OAuth2 Flow
scopes:
user_impersonation: impersonate your user account
paths:
/providers/Microsoft.NotificationHubs/operations:
get:
tags:
- Operations
operationId: microsoftAzureOperationsList
x-ms-examples:
OperationsList:
$ref: ./examples/NHOperationsList.json
description: Lists all of the available NotificationHubs REST API operations.
parameters:
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: OK. The request has succeeded.
schema:
$ref: '#/definitions/OperationListResult'
default:
description: NotificationHubs error response describing why the operation failed.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
summary: Microsoft Azure Get Providers Microsoft Notificationhubs Operations
/subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/checkNamespaceAvailability:
post:
tags:
- Namespaces
x-ms-examples:
NameSpaceCheckNameAvailability:
$ref: ./examples/Namespaces/NHNameSpaceCheckNameAvailability.json
operationId: microsoftAzureNamespacesCheckavailability
description: >-
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.
parameters:
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/CheckAvailabilityParameters'
description: The namespace name.
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: Checks if the Namespace name is a valid available name
schema:
$ref: '#/definitions/CheckAvailabilityResult'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Notificationhubs Checknamespaceavailability
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}
: put:
tags:
- Namespaces
x-ms-examples:
NameSpaceCreate:
$ref: ./examples/Namespaces/NHNameSpaceCreate.json
operationId: microsoftAzureNamespacesCreateorupdate
description: >-
Creates/Updates a service namespace. Once created, this namespace's
resource manifest is immutable. This operation is idempotent.
externalDocs:
url: http://msdn.microsoft.com/en-us/library/windowsazure/jj856303.aspx
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/NamespaceCreateOrUpdateParameters'
description: Parameters supplied to create a Namespace Resource.
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: Namespace is Create/Update
schema:
$ref: '#/definitions/NamespaceResource'
'201':
description: Namespace is Create/Update
schema:
$ref: '#/definitions/NamespaceResource'
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename
patch:
tags:
- Namespaces
x-ms-examples:
NameSpaceUpdate:
$ref: ./examples/Namespaces/NHNameSpaceUpdate.json
operationId: microsoftAzureNamespacesPatch
description: Patches the existing 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/NamespacePatchParameters'
description: Parameters supplied to patch a Namespace Resource.
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: Namespace is Updated
schema:
$ref: '#/definitions/NamespaceResource'
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename
delete:
tags:
- Namespaces
x-ms-examples:
NameSpaceDelete:
$ref: ./examples/Namespaces/NHNameSpaceDelete.json
operationId: microsoftAzureNamespacesDelete
description: >-
Deletes an existing namespace. This operation also removes all
associated notificationHubs under the namespace.
externalDocs:
url: http://msdn.microsoft.com/en-us/library/windowsazure/jj856296.aspx
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: Namespace is deleted
'202':
description: Namespace delete request has been accepted
'204':
description: Namespace is already Deleted
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename
get:
tags:
- Namespaces
x-ms-examples:
NameSpaceGet:
$ref: ./examples/Namespaces/NHNameSpaceGet.json
operationId: microsoftAzureNamespacesGet
description: Returns the description for the specified 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 Namespace
schema:
$ref: '#/definitions/NamespaceResource'
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}
: put:
tags:
- Namespaces
x-ms-examples:
NameSpaceAuthorizationRuleCreate:
$ref: ./examples/Namespaces/NHNameSpaceAuthorizationRuleCreate.json
operationId: microsoftAzureNamespacesCreateorupdateauthorizationrule
description: Creates an authorization rule for a namespace
parameters:
- name: resourceGroupName
in: path
required: true
type: string
description: The name of the resource group.
- name: namespaceName
in: path
required: true
type: string
description: The namespace name.
- name: authorizationRuleName
in: path
required: true
type: string
description: Authorization Rule Name.
- name: parameters
in: body
required: true
schema:
$ref: >-
#/definitions/SharedAccessAuthorizationRuleCreateOrUpdateParameters
description: The shared access authorization rule.
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: Namespace Authorization Rule is Created/Updated
schema:
$ref: '#/definitions/SharedAccessAuthorizationRuleResource'
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Authorizationrules Authorizationrulename
delete:
tags:
- Namespaces
x-ms-examples:
NameSpaceAuthorizationRuleDelete:
$ref: ./examples/Namespaces/NHNameSpaceAuthorizationRuleDelete.json
operationId: microsoftAzureNamespacesDeleteauthorizationrule
description: Deletes a namespace authorization rule
parameters:
- name: resourceGroupName
in: path
required: true
type: string
description: The name of the resource group.
- name: namespaceName
in: path
required: true
type: string
description: The namespace name.
- name: authorizationRuleName
in: path
required: true
type: string
description: Authorization Rule Name.
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: Namespace AuthorizationRule is deleted
'204':
description: Namespace AuthorizationRule is already deleted
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Authorizationrules Authorizationrulename
get:
tags:
- Namespaces
x-ms-examples:
NameSpaceAuthorizationRuleGet:
$ref: ./examples/Namespaces/NHNameSpaceAuthorizationRuleGet.json
operationId: microsoftAzureNamespacesGetauthorizationrule
description: Gets an authorization rule for a namespace by name.
parameters:
- name: resourceGroupName
in: path
required: true
type: string
description: The name of the resource group.
- name: namespaceName
in: path
required: true
type: string
description: The namespace name
- name: authorizationRuleName
in: path
required: true
type: string
description: Authorization rule name.
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: Get the Namespace AuthorizationRule
schema:
$ref: '#/definitions/SharedAccessAuthorizationRuleResource'
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Authorizationrules Authorizationrulename
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces:
get:
tags:
- Namespaces
x-ms-examples:
NameSpaceListByResourceGroup:
$ref: ./examples/Namespaces/NHNameSpaceListByResourceGroup.json
operationId: microsoftAzureNamespacesList
description: Lists the available namespaces within a resourceGroup.
parameters:
- name: resourceGroupName
in: path
required: true
type: string
description: >-
The name of the resource group. If resourceGroupName value is null
the method lists all the namespaces within subscription
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: Lists all Namespaces with the ResourceGroup
schema:
$ref: '#/definitions/NamespaceListResult'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces
/subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/namespaces:
get:
tags:
- Namespaces
x-ms-examples:
NameSpaceList:
$ref: ./examples/Namespaces/NHNameSpaceList.json
operationId: microsoftAzureNamespacesListall
description: >-
Lists all the available namespaces within the subscription irrespective
of the resourceGroups.
parameters:
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: >-
Gets all the Namespaces within the subscription irrespective of the
ResourceGroup
schema:
$ref: '#/definitions/NamespaceListResult'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Notificationhubs Namespaces
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules
: get:
tags:
- Namespaces
x-ms-examples:
NameSpaceAuthorizationRuleListAll:
$ref: ./examples/Namespaces/NHNameSpaceAuthorizationRuleListAll.json
operationId: microsoftAzureNamespacesListauthorizationrules
description: Gets the authorization rules for a namespace.
parameters:
- name: resourceGroupName
in: path
required: true
type: string
description: The name of the resource group.
- name: namespaceName
in: path
required: true
type: string
description: The namespace name
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: Get the List of AuthorizationRules of a Namespace
schema:
$ref: '#/definitions/SharedAccessAuthorizationRuleListResult'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Authorizationrules
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/listKeys
: post:
tags:
- Namespaces
x-ms-examples:
NameSpaceAuthorizationRuleListKey:
$ref: ./examples/Namespaces/NHNameSpaceAuthorizationRuleListKey.json
operationId: microsoftAzureNamespacesListkeys
description: 'Gets the Primary and Secondary ConnectionStrings to the namespace '
parameters:
- name: resourceGroupName
in: path
required: true
type: string
description: The name of the resource group.
- name: namespaceName
in: path
required: true
type: string
description: The namespace name.
- name: authorizationRuleName
in: path
required: true
type: string
description: >-
The connection string of the namespace for the specified
authorizationRule.
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: >-
Gets the Namespace AuthorizationRule's Primary keys and Secondary
keys along with the ConnectionStrings
schema:
$ref: '#/definitions/ResourceListKeys'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Authorizationrules Authorizationrulename Listkeys
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys
: post:
tags:
- Namespaces
x-ms-examples:
NameSpaceAuthorizationRuleRegenerateKey:
$ref: ./examples/Namespaces/NHNameSpaceAuthorizationRuleRegenrateKey.json
operationId: microsoftAzureNamespacesRegeneratekeys
description: >-
Regenerates the Primary/Secondary Keys to the Namespace Authorization
Rule
parameters:
- name: resourceGroupName
in: path
required: true
type: string
description: The name of the resource group.
- name: namespaceName
in: path
required: true
type: string
description: The namespace name.
- name: authorizationRuleName
in: path
required: true
type: string
description: >-
The connection string of the namespace for the specified
authorizationRule.
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/PolicykeyResource'
description: >-
Parameters supplied to regenerate the Namespace Authorization Rule
Key.
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: >-
Regenerate the Primary/Secondary Key and returns the Keys and the
connection string
schema:
$ref: '#/definitions/ResourceListKeys'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Notificationhubs Namespaces Namespacename Authorizationrules Authorizationrulename Regeneratekeys
? /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:
# --- truncated at 32 KB (63 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/notificationhubsmanagementclient-openapi-original.yml