Compartilhar via

Namespaces - List Keys

Serviço:
Notification Hubs
Versão da API:
2023-09-01

Obtém as ConnectionStrings Primárias e Secundárias para o namespace.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
authorizationRuleName
 path True

string

minLength: 1
maxLength: 256
pattern: ^[a-zA-Z0-9!()*-._]+$

Nome da regra de autorização
namespaceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z][a-zA-Z0-9-]*$

Nome do Namespace
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId
 path True

string (uuid)

A ID da assinatura de destino. O valor deve ser uma UUID.
api-version
 query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

ResourceListKeys

Êxito
Other Status Codes

ErrorResponse

Código de erro com motivo.

Segurança

azure_auth

Fluxo 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

Namespaces_ListKeys

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
200 
{
  "primaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################",
  "secondaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################",
  "primaryKey": "############################################",
  "secondaryKey": "############################################",
  "keyName": "RootManageSharedAccessKey"
}

Definições

Nome Description
ErrorAdditionalInfo

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

O detalhe do erro.
ErrorResponse

Resposta de erro
ResourceListKeys

Resposta para a solicitação POST que retorna chaves de acesso do Namespace ou notificationHub (cadeias de conexão).

ErrorAdditionalInfo

Objeto

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

Objeto

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

Objeto

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

ResourceListKeys

Objeto

Resposta para a solicitação POST que retorna chaves de acesso do Namespace ou notificationHub (cadeias de conexão).

Nome Tipo Description
keyName

string

Obtém ou define keyName do AuthorizationRule criado
primaryConnectionString

string

Obtém ou define primaryConnectionString do AuthorizationRule.
primaryKey

string

Obtém ou define primaryKey do AuthorizationRule criado.
secondaryConnectionString

string

Obtém ou define secondaryConnectionString do AuthorizationRule criado
secondaryKey

string

Obtém ou define secondaryKey do AuthorizationRule criado