Notification Hubs - Create Or Update Authorization Rule

Ссылка

Service:: Notification Hubs

API Version:: 2023-09-01

Создает или Обновления правило авторизации для 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

Имя	В	Обязательно	Тип	Описание
authorizationRuleName	path	True	string	Имя правила авторизации Regex pattern: `^[a-zA-Z0-9!()*-._]+$`
namespaceName	path	True	string	Имя пространства имен Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]*$`
notificationHubName	path	True	string	Имя концентратора уведомлений Regex pattern: `^[a-zA-Z][a-zA-Z0-9-./_]*$`
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
subscriptionId	path	True	string uuid	Идентификатор целевой подписки. Значение должно быть UUID.
api-version	query	True	string	Версия API, используемая для данной операции.

Текст запроса

Имя	Тип	Описание
location	string	Не рекомендуется — только для обеспечения совместимости.
properties	SharedAccessAuthorizationRuleProperties	Свойства SharedAccessAuthorizationRule.
tags	object	Не рекомендуется — только для обеспечения совместимости.

Ответы

Имя	Тип	Описание
200 OK	SharedAccessAuthorizationRuleResource	Обновленные возможности
201 Created	SharedAccessAuthorizationRuleResource	Создание
Other Status Codes	ErrorResponse	Код ошибки с причиной.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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"
}

Определения

Имя	Описание
AccessRights	Определяет значения для AccessRights.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
SharedAccessAuthorizationRuleProperties	Свойства SharedAccessAuthorizationRule.
SharedAccessAuthorizationRuleResource	Ответ на запросы POST, возвращающие одно значение SharedAccessAuthorizationRule.
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.

AccessRights

Определяет значения для AccessRights.

Имя	Тип	Описание
Listen	string
Manage	string
Send	string

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

SharedAccessAuthorizationRuleProperties

Свойства SharedAccessAuthorizationRule.

Имя	Тип	Описание
claimType	string	Возвращает строку, описывающую тип утверждения.
claimValue	string	Возвращает строку, описывающую значение утверждения.
createdTime	string	Возвращает время создания для этого правила.
keyName	string	Возвращает строку, описывающую правило авторизации.
modifiedTime	string	Возвращает время последнего изменения для этого правила.
primaryKey	string	Возвращает 256-разрядный первичный ключ в кодировке Base64 для подписывания и проверки маркера SAS.
revision	integer	Возвращает номер редакции для правила.
rights	AccessRights[]	Возвращает или задает права, связанные с правилом.
secondaryKey	string	Возвращает 256-разрядный первичный ключ в кодировке Base64 для подписывания и проверки маркера SAS.

SharedAccessAuthorizationRuleResource

Ответ на запросы POST, возвращающие одно значение SharedAccessAuthorizationRule.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Не рекомендуется — только для обеспечения совместимости.
name	string	Имя ресурса.
properties	SharedAccessAuthorizationRuleProperties	Свойства SharedAccessAuthorizationRule.
systemData	systemData	Azure Resource Manager метаданные, содержащие сведения о createdBy и modifiedBy.
tags	object	Не рекомендуется — только для обеспечения совместимости.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Удостоверение, которое в последний раз изменял ресурс.
lastModifiedByType	createdByType	Тип удостоверения, изменяющего ресурс в последний раз.

Share via