Gateway - Generate Token
Ottiene il token di autorizzazione di accesso condiviso per il gateway.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/generateToken?api-version=2022-08-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
gateway
|
path | True |
string |
Identificatore di entità gateway. Deve essere univoco nell'istanza corrente del servizio Gestione API. Non deve avere valore 'managed' |
resource
|
path | True |
string |
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole. |
service
|
path | True |
string |
Nome del servizio Gestione API. Regex pattern: |
subscription
|
path | True |
string |
ID della sottoscrizione di destinazione. |
api-version
|
query | True |
string |
Versione dell'API da usare per questa operazione. |
Corpo della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
expiry | True |
string |
Ora di scadenza del token. Il tempo massimo di scadenza del token è impostato su 30 giorni. La data è conforme al formato seguente: |
keyType | True |
Chiave da usare per generare il token del gateway. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Il corpo della risposta contiene il token di autorizzazione per il gateway. |
|
Other Status Codes |
Risposta di errore che descrive perché l'operazione non è riuscita. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
ApiManagementGatewayGenerateToken
Sample Request
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"
}
Sample Response
{
"value": "gw1&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="
}
Definizioni
Nome | Descrizione |
---|---|
Error |
Contratto campo errore. |
Error |
Risposta errore. |
Gateway |
Token di accesso al gateway. |
Gateway |
Proprietà del contratto del contratto di richiesta del token del gateway. |
Key |
Chiave rigenerata. |
ErrorFieldContract
Contratto campo errore.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore a livello di proprietà. |
message |
string |
Rappresentazione leggibile dell'errore a livello di proprietà. |
target |
string |
Nome della proprietà. |
ErrorResponse
Risposta errore.
Nome | Tipo | Descrizione |
---|---|---|
error.code |
string |
Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta. |
error.details |
Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida. |
|
error.message |
string |
Rappresentazione leggibile dell'errore. |
GatewayTokenContract
Token di accesso al gateway.
Nome | Tipo | Descrizione |
---|---|---|
value |
string |
Valore del token di autenticazione di accesso condiviso per il gateway. |
GatewayTokenRequestContract
Proprietà del contratto del contratto di richiesta del token del gateway.
Nome | Tipo | Valore predefinito | Descrizione |
---|---|---|---|
expiry |
string |
Ora di scadenza del token. Il tempo massimo di scadenza del token è impostato su 30 giorni. La data è conforme al formato seguente: |
|
keyType | primary |
Chiave da usare per generare il token del gateway. |
KeyType
Chiave rigenerata.
Nome | Tipo | Descrizione |
---|---|---|
primary |
string |
|
secondary |
string |