Gateway - List Debug Credentials

Riferimento

Service:: API Management

API Version:: 2023-05-01-preview

Creare nuove credenziali di debug per il gateway.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listDebugCredentials?api-version=2023-05-01-preview

Parametri dell'URI

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

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
apiId	True	string	ID risorsa completo di un'API.
purposes	True	GatewayListDebugCredentialsContractPurpose[]	Scopi della credenziale di debug.
credentialsExpireAfter		string	Scadenza delle credenziali nel formato ISO8601. La durata massima delle credenziali è PT1H. Quando la proprietà non viene specificata, viene usato il valore PT1H.

Risposte

Nome	Tipo	Descrizione
200 OK	GatewayDebugCredentialsContract	Il corpo della risposta contiene le credenziali di debug da usare nel 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.

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementGatewayListDebugCredentials

Sample Request

HTTP

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

{
  "credentialsExpireAfter": "PT1H",
  "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1",
  "purposes": [
    "tracing"
  ]
}

Sample Response

Status code:: 200

{
  "token": "p=tracing&aid=a1&ex=20230504000000&sn=ZdfxSJoCsOJE0/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/8LchGl7gu/Q=="
}

Definizioni

Nome	Descrizione
ErrorFieldContract	Contratto campo di errore.
ErrorResponse	Risposta errore.
GatewayDebugCredentialsContract	Credenziali di debug del gateway.
GatewayListDebugCredentialsContract	Elencare le proprietà delle credenziali di debug.
GatewayListDebugCredentialsContractPurpose	Scopi della credenziale di debug.

ErrorFieldContract

Contratto campo di 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	ErrorFieldContract[]	Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.
error.message	string	Rappresentazione leggibile dell'errore.

GatewayDebugCredentialsContract

Credenziali di debug del gateway.

Nome	Tipo	Descrizione
token	string	Token di debug del gateway.

GatewayListDebugCredentialsContract

Elencare le proprietà delle credenziali di debug.

Nome	Tipo	Descrizione
apiId	string	ID risorsa completo di un'API.
credentialsExpireAfter	string	Scadenza delle credenziali nel formato ISO8601. La durata massima delle credenziali è PT1H. Quando la proprietà non viene specificata, viene usato il valore PT1H.
purposes	GatewayListDebugCredentialsContractPurpose[]	Scopi della credenziale di debug.

GatewayListDebugCredentialsContractPurpose

Scopi della credenziale di debug.

Nome	Tipo	Descrizione
tracing	string	Scopo della traccia.

Condividi tramite