Gateway - List Debug Credentials

Référence

Service:: API Management

API Version:: 2023-05-01-preview

Créez des informations d’identification de débogage pour la passerelle.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
gatewayId	path	True	string	Identificateur d’entité de passerelle. Doit être unique dans le instance de service Gestion des API actuel. Ne doit pas avoir la valeur 'managed'
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serviceName	path	True	string	Nom du service Gestion des API. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string uuid	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
apiId	True	string	ID de ressource complet d’une API.
purposes	True	GatewayListDebugCredentialsContractPurpose[]	Objectifs des informations d’identification de débogage.
credentialsExpireAfter		string	Expiration des informations d’identification au format ISO8601. La durée maximale des informations d’identification est PT1H. Lorsque la propriété n’est pas spécifiée, la valeur PT1H est utilisée.

Réponses

Nom	Type	Description
200 OK	GatewayDebugCredentialsContract	Le corps de la réponse contient des informations d’identification de débogage à utiliser dans la passerelle.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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=="
}

Définitions

Nom	Description
ErrorFieldContract	Contrat de champ d’erreur.
ErrorResponse	Réponse d’erreur.
GatewayDebugCredentialsContract	Déboguer les informations d’identification de la passerelle.
GatewayListDebugCredentialsContract	Répertorie les propriétés des informations d’identification de débogage.
GatewayListDebugCredentialsContractPurpose	Objectifs des informations d’identification de débogage.

ErrorFieldContract

Contrat de champ d’erreur.

Nom	Type	Description
code	string	Code d'erreur de niveau propriété.
message	string	Représentation lisible par l’homme de l’erreur au niveau des propriétés.
target	string	Nom de propriété.

ErrorResponse

Réponse d’erreur.

Nom	Type	Description
error.code	string	Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse.
error.details	ErrorFieldContract[]	Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation.
error.message	string	Représentation contrôlable de visu de l’erreur.

GatewayDebugCredentialsContract

Déboguer les informations d’identification de la passerelle.

Nom	Type	Description
token	string	Jeton de débogage de passerelle.

GatewayListDebugCredentialsContract

Répertorie les propriétés des informations d’identification de débogage.

Nom	Type	Description
apiId	string	ID de ressource complet d’une API.
credentialsExpireAfter	string	Expiration des informations d’identification au format ISO8601. La durée maximale des informations d’identification est PT1H. Lorsque la propriété n’est pas spécifiée, la valeur PT1H est utilisée.
purposes	GatewayListDebugCredentialsContractPurpose[]	Objectifs des informations d’identification de débogage.

GatewayListDebugCredentialsContractPurpose

Objectifs des informations d’identification de débogage.

Nom	Type	Description
tracing	string	Objectif de suivi.

Share via