Partilhar via

Namespaces - List Keys

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

Obtém o ConnectionStrings primário e secundário 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 do URI

Name Em Necessá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 um UUID.
api-version
 query True

string

minLength: 1

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

Respostas

Name Tipo Description
200 OK

ResourceListKeys

Sucesso
Other Status Codes

ErrorResponse

Código de erro com razão.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

Namespaces_ListKeys

Pedido de amostra

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 da amostra

Código de estado:
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

Name Description
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
ResourceListKeys

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

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
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

Object

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

ResourceListKeys

Object

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

Name Tipo Description
keyName

string

Obtém ou define keyName da AuthorizationRule criada
primaryConnectionString

string

Obtém ou define primaryConnectionString da AuthorizationRule.
primaryKey

string

Obtém ou define primaryKey da AuthorizationRule criada.
secondaryConnectionString

string

Obtém ou define secondaryConnectionString da AuthorizationRule criada
secondaryKey

string

Obtém ou define secondaryKey da AuthorizationRule criada