Subscription - List Secrets

Získá zadané klíče předplatného.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
resourceGroupName
path True

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName
path True

string

Název služby API Management.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

sid
path True

string

Identifikátor entity předplatného. Entita představuje přidružení mezi uživatelem a produktem v API Management.

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

subscriptionId
path True

string

ID cílového předplatného.

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name Typ Description
200 OK

SubscriptionKeysContract

Tělo odpovědi obsahuje klíče předplatného.

Headers

ETag: string

Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

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

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

ApiManagementSubscriptionListSecrets

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8/listSecrets?api-version=2022-08-01

Sample Response

{
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>"
}

Definice

Name Description
ErrorFieldContract

Chybový kontrakt pole.

ErrorResponse

Odpověď na chybu.

SubscriptionKeysContract

Klíče předplatného.

ErrorFieldContract

Chybový kontrakt pole.

Name Typ Description
code

string

Kód chyby na úrovni vlastnosti.

message

string

Pro člověka čitelná reprezentace chyby na úrovni vlastností.

target

string

Název vlastnosti.

ErrorResponse

Odpověď na chybu.

Name Typ Description
error.code

string

Kód chyby definovaný službou. Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.

error.details

ErrorFieldContract[]

Seznam neplatných polí se odešle v požadavku v případě chyby ověření.

error.message

string

Pro člověka čitelná reprezentace chyby.

SubscriptionKeysContract

Klíče předplatného.

Name Typ Description
primaryKey

string

Primární klíč předplatného.

secondaryKey

string

Sekundární klíč předplatného.