Megosztás a következőn keresztül:


Gateway - Generate Token

Lekéri az átjáró megosztott hozzáférés-engedélyezési jogkivonatát.

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

URI-paraméterek

Name In Kötelező Típus Description
gatewayId
path True

string

Átjáró entitásazonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. Nem lehet "felügyelt" érték

resourceGroupName
path True

string

Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.

serviceName
path True

string

A API Management szolgáltatás neve.

Reguláris kifejezési minta: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

A cél-előfizetés azonosítója.

api-version
query True

string

A művelethez használandó API-verzió.

Kérelem törzse

Name Kötelező Típus Description
expiry True

string

A jogkivonat lejárati ideje. A jogkivonatok lejárati ideje legfeljebb 30 nap lehet. A dátum az ISO 8601 szabvány által meghatározott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.

keyType True

KeyType

Az átjárótoken létrehozásához használandó kulcs.

Válaszok

Name Típus Description
200 OK

GatewayTokenContract

A válasz törzse tartalmazza az átjáró engedélyezési jogkivonatát.

Other Status Codes

ErrorResponse

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation felhasználói fiók megszemélyesítése

Példák

ApiManagementGatewayGenerateToken

Mintakérelem

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

{
  "keyType": "primary",
  "expiry": "2020-04-21T00:44:24.2845269Z"
}

Mintaválasz

{
  "value": "gw1&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="
}

Definíciók

Name Description
ErrorFieldContract

Hibamező-szerződés.

ErrorResponse

Hibaválasz.

GatewayTokenContract

Átjáró hozzáférési jogkivonata.

GatewayTokenRequestContract

Átjáró jogkivonat-kérésének szerződéstulajdonságai.

KeyType

A kulcs újragenerálva.

ErrorFieldContract

Hibamező-szerződés.

Name Típus Description
code

string

Tulajdonságszintű hibakód.

message

string

A tulajdonságszintű hiba emberi olvasásra alkalmas ábrázolása.

target

string

Tulajdonság neve.

ErrorResponse

Hibaválasz.

Name Típus Description
error.code

string

Szolgáltatás által definiált hibakód. Ez a kód a válaszban megadott HTTP-hibakód alállapotaként szolgál.

error.details

ErrorFieldContract[]

Érvényesítési hiba esetén a kérelemben küldött érvénytelen mezők listája.

error.message

string

A hiba emberi olvasásra alkalmas ábrázolása.

GatewayTokenContract

Átjáró hozzáférési jogkivonata.

Name Típus Description
value

string

Közös hozzáférésű hitelesítési jogkivonat értéke az átjáróhoz.

GatewayTokenRequestContract

Átjáró jogkivonat-kérésének szerződéstulajdonságai.

Name Típus Alapértelmezett érték Description
expiry

string

A jogkivonat lejárati ideje. A jogkivonatok lejárati ideje legfeljebb 30 nap lehet. A dátum az ISO 8601 szabvány által meghatározott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.

keyType

KeyType

primary

Az átjárótoken létrehozásához használandó kulcs.

KeyType

A kulcs újragenerálva.

Name Típus Description
primary

string

secondary

string