Udostępnij przez

Namespaces - List Keys

Usługa:
Relay
Wersja interfejsu API:
2024-01-01

Podstawowe i pomocnicze parametry połączenia z przestrzenią nazw.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
authorizationRuleName
 path True

string

minLength: 1

Nazwa reguły autoryzacji.
namespaceName
 path True

string

minLength: 6
maxLength: 50

Nazwa przestrzeni nazw
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId
 path True

string

minLength: 1

Identyfikator subskrypcji docelowej.
api-version
 query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

AccessKeys

Operacja platformy Azure została zakończona pomyślnie.
Other Status Codes

ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

RelayNameSpaceAuthorizationRuleListKey

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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": "############################################"
}

Definicje

Nazwa Opis
AccessKeys

Przestrzeń nazw/parametry połączenia przekaźnika
ErrorAdditionalInfo

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

Szczegóły błędu.
ErrorResponse

Odpowiedź na błąd

AccessKeys

Objekt

Przestrzeń nazw/parametry połączenia przekaźnika

Nazwa Typ Opis
keyName

string

Ciąg opisujący regułę autoryzacji.
primaryConnectionString

string

Podstawowe parametry połączenia utworzonej reguły autoryzacji przestrzeni nazw.
primaryKey

string

Zakodowany w formacie base64 256-bitowy klucz podstawowy do podpisywania i weryfikowania tokenu SAS.
secondaryConnectionString

string

Pomocnicze parametry połączenia utworzonej reguły autoryzacji przestrzeni nazw.
secondaryKey

string

256-bitowy klucz pomocniczy zakodowany w formacie base64 na potrzeby podpisywania i weryfikowania tokenu SAS.

ErrorAdditionalInfo

Objekt

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

Nazwa Typ Opis
info

object

Dodatkowe informacje.
type

string

Dodatkowy typ informacji.

ErrorDetail

Objekt

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

Objekt

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.