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 |
---|---|---|---|---|
gateway
|
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 |
resource
|
path | True |
string |
Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket. |
service
|
path | True |
string |
A API Management szolgáltatás neve. Reguláris kifejezési minta: |
subscription
|
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 |
keyType | True |
Az átjárótoken létrehozásához használandó kulcs. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A válasz törzse tartalmazza az átjáró engedélyezési jogkivonatát. |
|
Other Status Codes |
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
Mintaválasz
{
"value": "gw1&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="
}
Definíciók
Name | Description |
---|---|
Error |
Hibamező-szerződés. |
Error |
Hibaválasz. |
Gateway |
Átjáró hozzáférési jogkivonata. |
Gateway |
Átjáró jogkivonat-kérésének szerződéstulajdonságai. |
Key |
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 |
É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 |
|
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 |