Gateway - List Debug Credentials

Servicio:

API Management

Versión de la API:

2024-05-01

Cree nuevas credenciales de depuración para la puerta de enlace.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
gatewayId	path	True	string minLength: 1 maxLength: 80	Identificador de entidad de puerta de enlace. Debe ser único en la instancia actual del servicio API Management. No debe tener el valor "administrado".
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nombre del servicio API Management.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
apiId	True	string (arm-id)	Identificador de recurso completo de una API.
purposes	True	GatewayListDebugCredentialsContractPurpose[]	Propósitos de la credencial de depuración.
credentialsExpireAfter		string (duration)	Expiración de credenciales en formato ISO8601. La duración máxima de las credenciales es PT1H. Cuando no se especifica la propiedad, se usa el valor PT1H.

Respuestas

Nombre	Tipo	Description
200 OK	GatewayDebugCredentialsContract	El cuerpo de la respuesta contiene credenciales de depuración que se van a usar en la puerta de enlace.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ApiManagementGatewayListDebugCredentials

Solicitud de ejemplo

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

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
GatewayDebugCredentialsContract	Credenciales de depuración de puerta de enlace.
GatewayListDebugCredentialsContract	Enumerar las propiedades de las credenciales de depuración.
GatewayListDebugCredentialsContractPurpose	Propósitos de la credencial de depuración.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

GatewayDebugCredentialsContract

Object

Credenciales de depuración de puerta de enlace.

Nombre	Tipo	Description
token	string	Token de depuración de puerta de enlace.

GatewayListDebugCredentialsContract

Object

Enumerar las propiedades de las credenciales de depuración.

Nombre	Tipo	Description
apiId	string (arm-id)	Identificador de recurso completo de una API.
credentialsExpireAfter	string (duration)	Expiración de credenciales en formato ISO8601. La duración máxima de las credenciales es PT1H. Cuando no se especifica la propiedad, se usa el valor PT1H.
purposes	GatewayListDebugCredentialsContractPurpose[]	Propósitos de la credencial de depuración.

GatewayListDebugCredentialsContractPurpose

Enumeración

Propósitos de la credencial de depuración.

Valor	Description
tracing	Propósito de seguimiento.