Gateway - List Debug Credentials

Serviço:

API Management

Versão da API:

2024-05-01

Crie novas credenciais de depuração para o gateway.

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 URI

Nome	Em	Obrigatório	Tipo	Description
gatewayId	path	True	string minLength: 1 maxLength: 80	Identificador de entidade de gateway. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Não deve ter o valor 'gerenciado'
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome do serviço de Gerenciamento de API.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
apiId	True	string (arm-id)	ID de recurso completa de uma API.
purposes	True	GatewayListDebugCredentialsContractPurpose[]	Finalidades da credencial de depuração.
credentialsExpireAfter		string (duration)	Expiração de credenciais no formato ISO8601. A duração máxima das credenciais é PT1H. Quando a propriedade não é especificada, o valor PT1H é usado.

Respostas

Nome	Tipo	Description
200 OK	GatewayDebugCredentialsContract	O corpo da resposta contém credenciais de depuração a serem usadas no gateway.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ApiManagementGatewayListDebugCredentials

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

200

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

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GatewayDebugCredentialsContract	Credenciais de depuração do gateway.
GatewayListDebugCredentialsContract	Listar propriedades de credenciais de depuração.
GatewayListDebugCredentialsContractPurpose	Finalidades da credencial de depuração.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

GatewayDebugCredentialsContract

Objeto

Credenciais de depuração do gateway.

Nome	Tipo	Description
token	string	Token de depuração de gateway.

GatewayListDebugCredentialsContract

Objeto

Listar propriedades de credenciais de depuração.

Nome	Tipo	Description
apiId	string (arm-id)	ID de recurso completa de uma API.
credentialsExpireAfter	string (duration)	Expiração de credenciais no formato ISO8601. A duração máxima das credenciais é PT1H. Quando a propriedade não é especificada, o valor PT1H é usado.
purposes	GatewayListDebugCredentialsContractPurpose[]	Finalidades da credencial de depuração.

GatewayListDebugCredentialsContractPurpose

Enumeração

Finalidades da credencial de depuração.

Valor	Description
tracing	A finalidade de rastreamento.