{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-notificationhubs","description":"NotificationHubsManagementClient","version":"2017-04-01","base_url":"https://management.azure.com","endpoints":28,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api NotificationHubsManagementClient\n@base https://management.azure.com\n@version 2017-04-01\n@auth OAuth2\n@common_fields {api-version: any # Client Api Version., subscriptionId: any # Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.}\n@endpoints 28\n@hint download_for_search\n@toc providers(1), subscriptions(27)\n\n@group providers\n@endpoint GET /providers/Microsoft.NotificationHubs/operations\n@desc Lists all of the available NotificationHubs REST API operations.\n@returns(200) OK. The request has succeeded.\n\n@endgroup\n\n@group subscriptions\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/checkNamespaceAvailability\n@desc 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.\n@required {parameters: any # The namespace name.}\n@returns(200) Checks if the Namespace name is a valid available name\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}\n@desc Creates/Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name., parameters: any # Parameters supplied to create a Namespace Resource.}\n@returns(200) Namespace is Create/Update\n@returns(201) Namespace is Create/Update\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}\n@desc Patches the existing namespace\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name., parameters: any # Parameters supplied to patch a Namespace Resource.}\n@returns(200) Namespace is Updated\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}\n@desc Deletes an existing namespace. This operation also removes all associated notificationHubs under the namespace.\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name.}\n@returns(200) Namespace is deleted\n@returns(202) Namespace delete request has been accepted\n@returns(204) Namespace is already Deleted\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}\n@desc Returns the description for the specified namespace.\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name.}\n@returns(200) Get Namespace\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}\n@desc Creates an authorization rule for a namespace\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name., authorizationRuleName: any # Authorization Rule Name., parameters: any # The shared access authorization rule.}\n@returns(200) Namespace Authorization Rule is Created/Updated\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}\n@desc Deletes a namespace authorization rule\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name., authorizationRuleName: any # Authorization Rule Name.}\n@returns(200) Namespace AuthorizationRule is deleted\n@returns(204) Namespace AuthorizationRule is already deleted\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}\n@desc Gets an authorization rule for a namespace by name.\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name, authorizationRuleName: any # Authorization rule name.}\n@returns(200) Get the Namespace AuthorizationRule\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces\n@desc Lists the available namespaces within a resourceGroup.\n@required {resourceGroupName: any # The name of the resource group. If resourceGroupName value is null the method lists all the namespaces within subscription}\n@returns(200) Lists all Namespaces with the ResourceGroup\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/namespaces\n@desc Lists all the available namespaces within the subscription irrespective of the resourceGroups.\n@returns(200) Gets all the Namespaces within the subscription irrespective of the ResourceGroup\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules\n@desc Gets the authorization rules for a namespace.\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name}\n@returns(200) Get the List of AuthorizationRules of a Namespace\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/listKeys\n@desc Gets the Primary and Secondary ConnectionStrings to the namespace\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name., authorizationRuleName: any # The connection string of the namespace for the specified authorizationRule.}\n@returns(200) Gets the Namespace AuthorizationRule's Primary keys and Secondary keys along with the ConnectionStrings\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys\n@desc Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name., authorizationRuleName: any # The connection string of the namespace for the specified authorizationRule., parameters: any # Parameters supplied to regenerate the Namespace Authorization Rule Key.}\n@returns(200) Regenerate the Primary/Secondary Key and returns the Keys and the connection string\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/checkNotificationHubAvailability\n@desc Checks the availability of the given notificationHub in a namespace.\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name., parameters: any # The notificationHub name.}\n@returns(200) Checks if the NotificationHub name is a valid available name\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}\n@desc Creates/Update a NotificationHub in a namespace.\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name., notificationHubName: any # The notification hub name., parameters: any # Parameters supplied to the create/update a NotificationHub Resource.}\n@returns(200) NotificationHub is Created/Updated\n@returns(201) NotificationHub is Created/Updated\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}\n@desc Patch a NotificationHub in a namespace.\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name., notificationHubName: any # The notification hub name.}\n@optional {parameters: any # Parameters supplied to patch a NotificationHub Resource.}\n@returns(200) NotificationHub is patched\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}\n@desc Deletes a notification hub associated with a namespace.\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name., notificationHubName: any # The notification hub name.}\n@returns(200) Namespace is deleted\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}\n@desc Lists the notification hubs associated with a namespace.\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name., notificationHubName: any # The notification hub name.}\n@returns(200) Get the NotificationHub\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/debugsend\n@desc test send a push notification\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name., notificationHubName: any # The notification hub name.}\n@optional {parameters: map # Debug send parameters}\n@returns(201) push send status\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules/{authorizationRuleName}\n@desc Creates/Updates an authorization rule for a NotificationHub\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name., notificationHubName: any # The notification hub name., authorizationRuleName: any # Authorization Rule Name., parameters: any # The shared access authorization rule.}\n@returns(200) NotificationHub AuthorizationRule is Created/Updated\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules/{authorizationRuleName}\n@desc Deletes a notificationHub authorization rule\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name., notificationHubName: any # The notification hub name., authorizationRuleName: any # Authorization Rule Name.}\n@returns(200) NotificationHub AuthorizationRule is deleted\n@returns(204) NotificationHub AuthorizationRule is already deleted\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules/{authorizationRuleName}\n@desc Gets an authorization rule for a NotificationHub by name.\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name, notificationHubName: any # The notification hub name., authorizationRuleName: any # authorization rule name.}\n@returns(200) Get NotificationHub AuthorizationRule\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs\n@desc Lists the notification hubs associated with a namespace.\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name.}\n@returns(200) Get all NotificationHubs within a Namespace\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules\n@desc Gets the authorization rules for a NotificationHub.\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name, notificationHubName: any # The notification hub name.}\n@returns(200) Get all NotificationHub AuthorizationRules\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules/{authorizationRuleName}/listKeys\n@desc Gets the Primary and Secondary ConnectionStrings to the NotificationHub\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name., notificationHubName: any # The notification hub name., authorizationRuleName: any # The connection string of the NotificationHub for the specified authorizationRule.}\n@returns(200) Gets the Namespace AuthorizationRule's Primary keys and Secondary keys along with the ConnectionStrings\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys\n@desc Regenerates the Primary/Secondary Keys to the NotificationHub Authorization Rule\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name., notificationHubName: any # The notification hub name., authorizationRuleName: any # The connection string of the NotificationHub for the specified authorizationRule., parameters: any # Parameters supplied to regenerate the NotificationHub Authorization Rule Key.}\n@returns(200) Regenerate the Primary/Secondary Key and returns the Keys and the connection string\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/pnsCredentials\n@desc Lists the PNS Credentials associated with a notification hub .\n@required {resourceGroupName: any # The name of the resource group., namespaceName: any # The namespace name., notificationHubName: any # The notification hub name.}\n@returns(200) Gets all the NotificationHub PNS credentials\n\n@endgroup\n\n@end\n"}