Gateway - List Debug Credentials

Ссылка

Service:: API Management

API Version:: 2023-05-01-preview

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
gatewayId	path	True	string	Идентификатор сущности шлюза. Должен быть уникальным в текущем экземпляре службы Управление API. Не должно иметь значение managed
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
serviceName	path	True	string	Имя службы Управление API. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string uuid	Идентификатор целевой подписки. Значение должно быть UUID.
api-version	query	True	string	Версия API, используемая для данной операции.

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

Имя	Обязательно	Тип	Описание
apiId	True	string	Полный идентификатор ресурса API.
purposes	True	GatewayListDebugCredentialsContractPurpose[]	Цели учетных данных отладки.
credentialsExpireAfter		string	Срок действия учетных данных в формате ISO8601. Максимальная длительность учетных данных — PT1H. Если свойство не указано, используется значение PT1H.

Ответы

Имя	Тип	Описание
200 OK	GatewayDebugCredentialsContract	Текст ответа содержит учетные данные отладки для использования в шлюзе.
Other Status Codes	ErrorResponse	Ответ об ошибке, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Scopes

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

Примеры

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

Определения

Имя	Описание
ErrorFieldContract	Контракт поля ошибки.
ErrorResponse	Ответ об ошибке.
GatewayDebugCredentialsContract	Учетные данные отладки шлюза.
GatewayListDebugCredentialsContract	Вывод списка свойств учетных данных отладки.
GatewayListDebugCredentialsContractPurpose	Цели учетных данных отладки.

ErrorFieldContract

Контракт поля ошибки.

Имя	Тип	Описание
code	string	Код ошибки уровня свойства.
message	string	Удобочитаемое представление ошибки на уровне свойств.
target	string	Имя свойства.

ErrorResponse

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

Имя	Тип	Описание
error.code	string	Код ошибки, определяемый службой. Это код служит в качестве подсостояния для кода ошибки HTTP, указанного в ответе.
error.details	ErrorFieldContract[]	Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки.
error.message	string	Читаемое представление ошибки.

GatewayDebugCredentialsContract

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

Имя	Тип	Описание
token	string	Маркер отладки шлюза.

GatewayListDebugCredentialsContract

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

Имя	Тип	Описание
apiId	string	Полный идентификатор ресурса API.
credentialsExpireAfter	string	Срок действия учетных данных в формате ISO8601. Максимальная длительность учетных данных — PT1H. Если свойство не указано, используется значение PT1H.
purposes	GatewayListDebugCredentialsContractPurpose[]	Цели учетных данных отладки.

GatewayListDebugCredentialsContractPurpose

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

Имя	Тип	Описание
tracing	string	Цель трассировки.

Share via