Notification Hubs - List Keys

Service:

Notification Hubs

API Version:

2023-09-01

Obtém as ConnectionStrings Principais e Secundárias para o NotificationHub

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
authorizationRuleName	path	True	string	Nome da Regra de Autorização Regex pattern: ^[a-zA-Z0-9!()*-._]+$
namespaceName	path	True	string	Nome do espaço de nomes Regex pattern: ^[a-zA-Z][a-zA-Z0-9-]*$
notificationHubName	path	True	string	Nome do Hub de Notificações Regex pattern: ^[a-zA-Z][a-zA-Z0-9-./_]*$
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId	path	True	string uuid	O ID da subscrição de destino. O valor tem de ser um UUID.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	ResourceListKeys	Com êxito
Other Status Codes	ErrorResponse	Código de erro com motivo.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

NotificationHubs_ListKeys

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "primaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-notificationHubs-2317",
  "secondaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-notificationHubs-2317",
  "primaryKey": "############################################",
  "secondaryKey": "############################################",
  "keyName": "sdk-AuthRules-5800"
}

Definições

Name	Description
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
ResourceListKeys	Resposta para o pedido POST que devolve o Espaço de Nomes ou as chaves de acesso do NotificationHub (cadeias de ligação).

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name	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 a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ResourceListKeys

Resposta para o pedido POST que devolve o Espaço de Nomes ou as chaves de acesso do NotificationHub (cadeias de ligaçã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 do AuthorizationRule criado
secondaryKey	string	Obtém ou define secondaryKey da AuthorizationRule criada