Gateway - Generate Token
Возвращает маркер авторизации общего доступа для шлюза.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/generateToken?api-version=2022-08-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
gateway
|
path | True |
string |
Идентификатор сущности шлюза. Должен быть уникальным в текущем экземпляре службы Управление API. Не должно иметь значение managed |
resource
|
path | True |
string |
Имя группы ресурсов. Регистр букв в имени не учитывается. |
service
|
path | True |
string |
Имя службы Управление API. Regex pattern: |
subscription
|
path | True |
string |
Идентификатор целевой подписки. |
api-version
|
query | True |
string |
Версия API, используемая для данной операции. |
Текст запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
expiry | True |
string |
Время окончания срока действия маркера. Максимальный срок действия маркера — 30 дней. Дата соответствует следующему формату: |
keyType | True |
Ключ, используемый для создания маркера шлюза. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Текст ответа содержит маркер авторизации для шлюза. |
|
Other Status Codes |
Ответ об ошибке, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
ApiManagementGatewayGenerateToken
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/generateToken?api-version=2022-08-01
{
"keyType": "primary",
"expiry": "2020-04-21T00:44:24.2845269Z"
}
Sample Response
{
"value": "gw1&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="
}
Определения
Имя | Описание |
---|---|
Error |
Контракт поля ошибки. |
Error |
Ответ об ошибке. |
Gateway |
Маркер доступа шлюза. |
Gateway |
Свойства контракта запроса маркера шлюза. |
Key |
Повторно создаваемый ключ. |
ErrorFieldContract
Контракт поля ошибки.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки уровня свойства. |
message |
string |
Удобочитаемое представление ошибки на уровне свойств. |
target |
string |
Имя свойства. |
ErrorResponse
Ответ об ошибке.
Имя | Тип | Описание |
---|---|---|
error.code |
string |
Код ошибки, определяемый службой. Это код служит в качестве подсостояния для кода ошибки HTTP, указанного в ответе. |
error.details |
Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки. |
|
error.message |
string |
Читаемое представление ошибки. |
GatewayTokenContract
Маркер доступа шлюза.
Имя | Тип | Описание |
---|---|---|
value |
string |
Значение маркера проверки подлинности общего доступа для шлюза. |
GatewayTokenRequestContract
Свойства контракта запроса маркера шлюза.
Имя | Тип | Значение по умолчанию | Описание |
---|---|---|---|
expiry |
string |
Время окончания срока действия маркера. Максимальный срок действия маркера — 30 дней. Дата соответствует следующему формату: |
|
keyType | primary |
Ключ, используемый для создания маркера шлюза. |
KeyType
Повторно создаваемый ключ.
Имя | Тип | Описание |
---|---|---|
primary |
string |
|
secondary |
string |