Udostępnij przez

Subscription - List Secrets

Usługa:
API Management
Wersja interfejsu API:
2024-05-01

Pobiera określone klucze subskrypcji.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/listSecrets?api-version=2024-05-01

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

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

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Nazwa usługi API Management.
sid
 path True

string

maxLength: 256
pattern: ^[^*#&+:<>?]+$

Identyfikator jednostki subskrypcji. Jednostka reprezentuje skojarzenie między użytkownikiem a produktem w usłudze API Management.
subscriptionId
 path True

string (uuid)

Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version
 query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

SubscriptionKeysContract

Treść odpowiedzi zawiera klucze subskrypcji.

Nagłówki

ETag: string
Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

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

ApiManagementSubscriptionListSecrets

Przykładowe żądanie

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8/listSecrets?api-version=2024-05-01

Przykładowa odpowiedź

Kod stanu:
200 
{
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>"
}

Definicje

Nazwa Opis
ErrorAdditionalInfo

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

Szczegóły błędu.
ErrorResponse

Odpowiedź na błąd
SubscriptionKeysContract

Klucze subskrypcji.

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.

SubscriptionKeysContract

Objekt

Klucze subskrypcji.

Nazwa Typ Opis
primaryKey

string

minLength: 1
maxLength: 256

Klucz podstawowy subskrypcji.
secondaryKey

string

minLength: 1
maxLength: 256

Klucz pomocniczy subskrypcji.