Notification Hubs - List Keys

Service:

Notification Hubs

API Version:

2023-09-01

Pobiera podstawowe i pomocnicze ciągi ConnectionStrings do usługi 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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
authorizationRuleName	path	True	string	Nazwa reguły autoryzacji Regex pattern: ^[a-zA-Z0-9!()*-._]+$
namespaceName	path	True	string	Nazwa przestrzeni nazw Regex pattern: ^[a-zA-Z][a-zA-Z0-9-]*$
notificationHubName	path	True	string	Nazwa centrum powiadomień Regex pattern: ^[a-zA-Z][a-zA-Z0-9-./_]*$
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
subscriptionId	path	True	string uuid	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ResourceListKeys	Powodzenie
Other Status Codes	ErrorResponse	Kod błędu z przyczyną.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
ResourceListKeys	Odpowiedź dla żądania POST zwracającego przestrzeń nazw lub klucze dostępu usługi NotificationHub (parametry połączenia).

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt error.

ResourceListKeys

Odpowiedź dla żądania POST zwracającego przestrzeń nazw lub klucze dostępu usługi NotificationHub (parametry połączenia).

Nazwa	Typ	Opis
keyName	string	Pobiera lub ustawia keyName utworzonej reguły autoryzacji
primaryConnectionString	string	Pobiera lub ustawia parametr primaryConnectionString reguły autoryzacji.
primaryKey	string	Pobiera lub ustawia wartość primaryKey utworzonej reguły autoryzacji.
secondaryConnectionString	string	Pobiera lub ustawia secondaryConnectionString utworzonego reguły autoryzacji
secondaryKey	string	Pobiera lub ustawia wartość secondaryKey utworzonej reguły autoryzacji