Gateway - List Debug Credentials

Служба:
API Management
Версия API:
2024-05-01

Создайте новые учетные данные отладки для шлюза.

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

Параметры URI

Имя В Обязательно Тип Описание
gatewayId
 path True

string

minLength: 1
maxLength: 80

Идентификатор сущности шлюза. Должен быть уникальным в текущем экземпляре службы управления API. Не должно иметь значения "managed"
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Имя группы ресурсов. Имя не учитывает регистр.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Имя службы управления API.
subscriptionId
 path True

string (uuid)

Идентификатор целевой подписки. Значение должно быть UUID.
api-version
 query True

string

minLength: 1

Версия API, используемая для этой операции.

Текст запроса

Имя Обязательно Тип Описание
apiId True

string (arm-id)

Полный идентификатор ресурса API.
purposes True

GatewayListDebugCredentialsContractPurpose[]

Цели отладки учетных данных.
credentialsExpireAfter

string (duration)

Срок действия учетных данных в ISO8601 формате. Максимальная длительность учетных данных — PT1H. Если свойство не указано, используется значение PT1H.

Ответы

Имя Тип Описание
200 OK

GatewayDebugCredentialsContract

Текст ответа содержит учетные данные отладки для использования в шлюзе.
Other Status Codes

ErrorResponse

Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

ApiManagementGatewayListDebugCredentials

Образец запроса

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

Пример ответа

Код состояния:
200 
{
  "token": "p=tracing&aid=a1&ex=20230504000000&sn=ZdfxSJoCsOJE0/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/8LchGl7gu/Q=="
}

Определения

Имя Описание
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

Ответ на ошибку
GatewayDebugCredentialsContract

Учетные данные отладки шлюза.
GatewayListDebugCredentialsContract

Вывод списка свойств учетных данных отладки.
GatewayListDebugCredentialsContractPurpose

Цели отладки учетных данных.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

GatewayDebugCredentialsContract

Object

Учетные данные отладки шлюза.

Имя Тип Описание
token

string

Маркер отладки шлюза.

GatewayListDebugCredentialsContract

Object

Вывод списка свойств учетных данных отладки.

Имя Тип Описание
apiId

string (arm-id)

Полный идентификатор ресурса API.
credentialsExpireAfter

string (duration)

Срок действия учетных данных в ISO8601 формате. Максимальная длительность учетных данных — PT1H. Если свойство не указано, используется значение PT1H.
purposes

GatewayListDebugCredentialsContractPurpose[]

Цели отладки учетных данных.

GatewayListDebugCredentialsContractPurpose

Перечисление

Цели отладки учетных данных.

Значение Описание
tracing

Цель трассировки.