Поделиться через


Gateway - List Keys

Получает ключи шлюза.

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

Параметры URI

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

string

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

resourceGroupName
path True

string

Имя группы ресурсов.

serviceName
path True

string

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

Шаблон регулярного выражения: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.

api-version
query True

string

Версия API для использования с клиентским запросом.

Ответы

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

GatewayKeysContract

Текст ответа содержит указанные ключи шлюза.

Заголовки

ETag: string

Other Status Codes

ErrorResponse

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

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Области

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

Примеры

ApiManagementGatewayListKeys

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

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/listKeys?api-version=2021-08-01

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

{
  "primary": "primary_key_value",
  "secondary": "secondary_key_value"
}

Определения

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

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

ErrorResponse

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

GatewayKeysContract

Ключи проверки подлинности шлюза.

ErrorFieldContract

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

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

string

Код ошибки уровня свойства.

message

string

Удобочитаемое представление ошибки на уровне свойств.

target

string

Имя свойства.

ErrorResponse

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

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

string

Код ошибки, определяемый службой. Это код служит в качестве подсостояния для кода ошибки HTTP, указанного в ответе.

error.details

ErrorFieldContract[]

Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки.

error.message

string

Читаемое представление ошибки.

GatewayKeysContract

Ключи проверки подлинности шлюза.

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

string

Первичный ключ шлюза.

secondary

string

Ключ вторичного шлюза.