Notification Hubs - Create Or Update Authorization Rule

Referência

Serviço:: Notification Hubs

Versão da API:: 2023-09-01

Cria/Atualizações uma regra de autorização para um NotificationHub

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
authorizationRuleName	path	True	string	Nome da regra de autorização Padrão Regex: `^[a-zA-Z0-9!()*-._]+$`
namespaceName	path	True	string	Nome do Namespace Padrão Regex: `^[a-zA-Z][a-zA-Z0-9-]*$`
notificationHubName	path	True	string	Nome do hub de notificação Padrão Regex: `^[a-zA-Z][a-zA-Z0-9-./_]*$`
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string uuid	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
location	string	Preterido – somente para compatibilidade.
properties	SharedAccessAuthorizationRuleProperties	Propriedades SharedAccessAuthorizationRule.
tags	object	Preterido – somente para compatibilidade.

Respostas

Nome	Tipo	Description
200 OK	SharedAccessAuthorizationRuleResource	Atualizado
201 Created	SharedAccessAuthorizationRuleResource	Criado
Other Status Codes	ErrorResponse	Código de erro com motivo.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

NotificationHubs_CreateOrUpdateAuthorizationRule

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
}

Código de status:: 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"
}

Definições

Nome	Description
AccessRights	Define valores para AccessRights.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
SharedAccessAuthorizationRuleProperties	Propriedades SharedAccessAuthorizationRule.
SharedAccessAuthorizationRuleResource	Resposta para solicitações POST que retornam SharedAccessAuthorizationRule único.
systemData	Metadados relativos à criação e à última modificação do recurso.

AccessRights

Define valores para AccessRights.

Nome	Tipo	Description
Listen	string
Manage	string
Send	string

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

SharedAccessAuthorizationRuleProperties

Propriedades SharedAccessAuthorizationRule.

Nome	Tipo	Description
claimType	string	Obtém uma cadeia de caracteres que descreve o tipo de declaração
claimValue	string	Obtém uma cadeia de caracteres que descreve o valor da declaração
createdTime	string	Obtém o tempo criado para essa regra
keyName	string	Obtém uma cadeia de caracteres que descreve a regra de autorização.
modifiedTime	string	Obtém a hora da última modificação para essa regra
primaryKey	string	Obtém uma chave primária de 256 bits codificada em base64 para assinar e validar o token SAS.
revision	integer	Obtém o número de revisão da regra
rights	AccessRights[]	Obtém ou define os direitos associados à regra.
secondaryKey	string	Obtém uma chave primária de 256 bits codificada em base64 para assinar e validar o token SAS.

SharedAccessAuthorizationRuleResource

Resposta para solicitações POST que retornam SharedAccessAuthorizationRule único.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Preterido – somente para compatibilidade.
name	string	O nome do recurso
properties	SharedAccessAuthorizationRuleProperties	Propriedades SharedAccessAuthorizationRule.
systemData	systemData	Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.
tags	object	Preterido – somente para compatibilidade.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

systemData

Metadados relativos à criação e à última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Compartilhar via