Gateway - List Debug Credentials

Dienst:

API Management

API-Version:

2024-05-01

Erstellen Sie neue Debuganmeldeinformationen für das Gateway.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
gatewayId	path	True	string minLength: 1 maxLength: 80	Gatewayentitätsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Darf keinen Wert 'verwaltet' haben
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
apiId	True	string (arm-id)	Vollständige Ressourcen-ID einer API.
purposes	True	GatewayListDebugCredentialsContractPurpose[]	Zweck des Debuggens von Anmeldeinformationen.
credentialsExpireAfter		string (duration)	Ablauf der Anmeldeinformationen im ISO8601 Format. Die maximale Dauer der Anmeldeinformationen ist PT1H. Wenn keine Eigenschaft angegeben wird, wird der Wert PT1H verwendet.

Antworten

Name	Typ	Beschreibung
200 OK	GatewayDebugCredentialsContract	Der Antworttext enthält Debuganmeldeinformationen, die im Gateway verwendet werden sollen.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementGatewayListDebugCredentials

Beispielanforderung

HTTP

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

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

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
GatewayDebugCredentialsContract	Gateway debug credentials.
GatewayListDebugCredentialsContract	Eigenschaften von Debuganmeldeinformationen auflisten.
GatewayListDebugCredentialsContractPurpose	Zweck des Debuggens von Anmeldeinformationen.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

GatewayDebugCredentialsContract

Objekt

Gateway debug credentials.

Name	Typ	Beschreibung
token	string	Gatewaydebugtoken.

GatewayListDebugCredentialsContract

Objekt

Eigenschaften von Debuganmeldeinformationen auflisten.

Name	Typ	Beschreibung
apiId	string (arm-id)	Vollständige Ressourcen-ID einer API.
credentialsExpireAfter	string (duration)	Ablauf der Anmeldeinformationen im ISO8601 Format. Die maximale Dauer der Anmeldeinformationen ist PT1H. Wenn keine Eigenschaft angegeben wird, wird der Wert PT1H verwendet.
purposes	GatewayListDebugCredentialsContractPurpose[]	Zweck des Debuggens von Anmeldeinformationen.

GatewayListDebugCredentialsContractPurpose

Enumeration

Zweck des Debuggens von Anmeldeinformationen.

Wert	Beschreibung
tracing	Der Ablaufverfolgungszweck.