Notification Hubs - Create Or Update Authorization Rule

Reference

Service:: Notification Hubs

API Version:: 2023-09-01

Creates/Updates an authorization rule for a NotificationHub

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}?api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
authorizationRuleName	path	True	string	Authorization Rule Name Regex pattern: `^[a-zA-Z0-9!()*-._]+$`
namespaceName	path	True	string	Namespace name Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]*$`
notificationHubName	path	True	string	Notification Hub name Regex pattern: `^[a-zA-Z][a-zA-Z0-9-./_]*$`
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Type	Description
location	string	Deprecated - only for compatibility.
properties	SharedAccessAuthorizationRuleProperties	SharedAccessAuthorizationRule properties.
tags	object	Deprecated - only for compatibility.

Responses

Name	Type	Description
200 OK	SharedAccessAuthorizationRuleResource	Updated
201 Created	SharedAccessAuthorizationRuleResource	Created
Other Status Codes	ErrorResponse	Error code with reason.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

NotificationHubs_CreateOrUpdateAuthorizationRule

Sample request

HTTP

PUT https://management.azure.com/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/nh-sdk-hub/authorizationRules/MyManageSharedAccessKey?api-version=2023-09-01

{
  "properties": {
    "rights": [
      "Listen",
      "Send"
    ]
  }
}

Sample response

Status code:: 200

{
  "properties": {
    "rights": [
      "Listen",
      "Send"
    ],
    "modifiedTime": "2023-04-26T12:24:40.5863818+00:00",
    "createdTime": "2023-04-26T12:24:40.5863818+00:00"
  },
  "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test/authorizationRules/MyManageSharedAccessKey",
  "name": "MyManageSharedAccessKey",
  "type": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules"
}

Status code:: 201

{
  "properties": {
    "rights": [
      "Listen",
      "Send"
    ],
    "modifiedTime": "2023-04-26T12:24:40.5863818+00:00",
    "createdTime": "2023-04-26T12:24:40.5863818+00:00"
  },
  "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test/authorizationRules/MyManageSharedAccessKey",
  "name": "MyManageSharedAccessKey",
  "type": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules"
}

Definitions

Name	Description
AccessRights	Defines values for AccessRights.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
SharedAccessAuthorizationRuleProperties	SharedAccessAuthorizationRule properties.
SharedAccessAuthorizationRuleResource	Response for POST requests that return single SharedAccessAuthorizationRule.
systemData	Metadata pertaining to creation and last modification of the resource.

AccessRights

Defines values for AccessRights.

Name	Type	Description
Listen	string
Manage	string
Send	string

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

SharedAccessAuthorizationRuleProperties

SharedAccessAuthorizationRule properties.

Name	Type	Description
claimType	string	Gets a string that describes the claim type
claimValue	string	Gets a string that describes the claim value
createdTime	string	Gets the created time for this rule
keyName	string	Gets a string that describes the authorization rule.
modifiedTime	string	Gets the last modified time for this rule
primaryKey	string	Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
revision	integer	Gets the revision number for the rule
rights	AccessRights[]	Gets or sets the rights associated with the rule.
secondaryKey	string	Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.

SharedAccessAuthorizationRuleResource

Response for POST requests that return single SharedAccessAuthorizationRule.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Deprecated - only for compatibility.
name	string	The name of the resource
properties	SharedAccessAuthorizationRuleProperties	SharedAccessAuthorizationRule properties.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Deprecated - only for compatibility.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via