Namespaces - List Keys

Referenz

Dienst:: Notification Hubs

API-Version:: 2023-09-01

Ruft die primäre und sekundäre ConnectionStrings in den Namespace ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
authorizationRuleName	path	True	string	Name der Autorisierungsregel RegEx-Muster: `^[a-zA-Z0-9!()*-._]+$`
namespaceName	path	True	string	Namespacename RegEx-Muster: `^[a-zA-Z][a-zA-Z0-9-]*$`
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string uuid	Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	ResourceListKeys	Erfolg
Other Status Codes	ErrorResponse	Fehlercode mit Grund.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Namespaces_ListKeys

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
ResourceListKeys	Antwort für die POST-Anforderung, die Namespace- oder NotificationHub-Zugriffsschlüssel (Verbindungszeichenfolgen) zurückgibt.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ResourceListKeys

Antwort für die POST-Anforderung, die Namespace- oder NotificationHub-Zugriffsschlüssel (Verbindungszeichenfolgen) zurückgibt.

Name	Typ	Beschreibung
keyName	string	Ruft keyName der erstellten AuthorizationRule ab oder legt diese fest.
primaryConnectionString	string	Ruft primaryConnectionString der AuthorizationRule ab oder legt diese fest.
primaryKey	string	Ruft primaryKey der erstellten AuthorizationRule ab oder legt diese fest.
secondaryConnectionString	string	Ruft secondaryConnectionString der erstellten AuthorizationRule ab oder legt diese fest.
secondaryKey	string	Ruft secondaryKey der erstellten AuthorizationRule ab oder legt diese fest.

Freigeben über