Sdílet prostřednictvím


Gateway - List Debug Credentials

Create new debug credentials for gateway.

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

URI Parameters

Name In Required Type Description
gatewayId
path True

string

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

serviceName
path True

string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

uuid

The ID of the target subscription. The value must be an UUID.

api-version
query True

string

The API version to use for this operation.

Request Body

Name Required Type Description
apiId True

string

Full resource Id of an API.

purposes True

GatewayListDebugCredentialsContractPurpose[]

Purposes of debug credential.

credentialsExpireAfter

string

Credentials expiration in ISO8601 format. Maximum duration of the credentials is PT1H. When property is not specified, them value PT1H is used.

Responses

Name Type Description
200 OK

GatewayDebugCredentialsContract

The response body contains debug credentials to use in gateway.

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ApiManagementGatewayListDebugCredentials

Sample request

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

Sample response

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

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

GatewayDebugCredentialsContract

Gateway debug credentials.

GatewayListDebugCredentialsContract

List debug credentials properties.

GatewayListDebugCredentialsContractPurpose

Purposes of debug credential.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

GatewayDebugCredentialsContract

Gateway debug credentials.

Name Type Description
token

string

Gateway debug token.

GatewayListDebugCredentialsContract

List debug credentials properties.

Name Type Description
apiId

string

Full resource Id of an API.

credentialsExpireAfter

string

Credentials expiration in ISO8601 format. Maximum duration of the credentials is PT1H. When property is not specified, them value PT1H is used.

purposes

GatewayListDebugCredentialsContractPurpose[]

Purposes of debug credential.

GatewayListDebugCredentialsContractPurpose

Purposes of debug credential.

Name Type Description
tracing

string

The tracing purpose.