Gateway - Generate Token

Servizio:

API Management

Versione API:

2024-05-01

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=2024-05-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
gatewayId	path	True	string minLength: 1 maxLength: 80	Identificatore di entità del gateway. Deve essere univoco nell'istanza corrente del servizio Gestione API. Non deve avere il valore 'managed'
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nome del servizio Gestione API.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
expiry	True	string (date-time)	Ora di scadenza del token. Il tempo massimo di scadenza del token è impostato su 30 giorni. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601.
keyType	True	KeyType	Chiave da usare per generare il token del gateway.

Risposte

Nome	Tipo	Descrizione
200 OK	GatewayTokenContract	Il corpo della risposta contiene il token di autorizzazione per il gateway.
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementGatewayGenerateToken

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:

200

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

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
GatewayTokenContract	Token di accesso del gateway.
GatewayTokenRequestContract	Proprietà del contratto di richiesta del token del gateway.
KeyType	Chiave rigenerata.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

GatewayTokenContract

Object

Token di accesso del gateway.

Nome	Tipo	Descrizione
value	string	Valore del token di autenticazione di accesso condiviso per il gateway.

GatewayTokenRequestContract

Object

Proprietà del contratto di richiesta del token del gateway.

Nome	Tipo	Valore predefinito	Descrizione
expiry	string (date-time)		Ora di scadenza del token. Il tempo massimo di scadenza del token è impostato su 30 giorni. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601.
keyType	KeyType	primary	Chiave da usare per generare il token del gateway.

KeyType

Enumerazione

Chiave rigenerata.

Valore	Descrizione
primary
secondary