Freigeben über

Namespaces - List Keys

Dienst:
Relay
API-Version:
2024-01-01

Primäre und sekundäre Verbindungszeichenfolgen mit dem Namespace.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
authorizationRuleName
 path True

string

minLength: 1

Der Name der Autorisierungsregel.
namespaceName
 path True

string

minLength: 6
maxLength: 50

Der Namespacename
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId
 path True

string

minLength: 1

Hierbei handelt es sich um die ID des Zielabonnements.
api-version
 query True

string

minLength: 1

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name Typ Beschreibung
200 OK

AccessKeys

Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

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

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

RelayNameSpaceAuthorizationRuleListKey

Beispielanforderung

POST https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/authorizationRules/example-RelayAuthRules-01/listKeys?api-version=2024-01-01

Beispiel für eine Antwort

Statuscode:
200 
{
  "keyName": "example-RelayAuthRules-01",
  "primaryConnectionString": "Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################",
  "primaryKey": "############################################",
  "secondaryConnectionString": "Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################",
  "secondaryKey": "############################################"
}

Definitionen

Name Beschreibung
AccessKeys

Namespace/Relay-Verbindungszeichenfolge
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail

Das Fehlerdetails.
ErrorResponse

Fehlerantwort

AccessKeys

Objekt

Namespace/Relay-Verbindungszeichenfolge

Name Typ Beschreibung
keyName

string

Eine Zeichenfolge, die die Autorisierungsregel beschreibt.
primaryConnectionString

string

Primäre Verbindungszeichenfolge der erstellten Namespaceautorisierungsregel.
primaryKey

string

Ein base64-codierter 256-Bit-Primärschlüssel zum Signieren und Validieren des SAS-Tokens.
secondaryConnectionString

string

Sekundäre Verbindungszeichenfolge der erstellten Namespaceautorisierungsregel.
secondaryKey

string

Ein base64-codierter sekundärer 256-Bit-Schlüssel zum Signieren und Validieren des SAS-Tokens.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.
type

string

Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.
code

string

Der Fehlercode.
details

ErrorDetail[]

Die Fehlerdetails.
message

string

Die Fehlermeldung.
target

string

Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.