Gateway Hostname Configuration - Create Or Update
Создает конфигурацию имени узла обновления для шлюза.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations/{hcId}?api-version=2022-08-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
gateway
|
path | True |
string |
Идентификатор сущности шлюза. Должен быть уникальным в текущем экземпляре службы Управление API. Не должно иметь значение managed |
hc
|
path | True |
string |
Идентификатор конфигурации имени узла шлюза. Должен быть уникальным в область родительской сущности шлюза. |
resource
|
path | True |
string |
Имя группы ресурсов. Регистр букв в имени не учитывается. |
service
|
path | True |
string |
Имя службы Управление API. Шаблон регулярного выражения: |
subscription
|
path | True |
string |
Идентификатор целевой подписки. |
api-version
|
query | True |
string |
Версия API, используемая для данной операции. |
Заголовок запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
If-Match |
string |
ETag сущности. Не требуется при создании сущности, но требуется при обновлении сущности. |
Текст запроса
Имя | Тип | Описание |
---|---|---|
properties.certificateId |
string |
Идентификатор сущности certificate, которая будет использоваться для установки TLS-подключения |
properties.hostname |
string |
Значение имени узла. Поддерживает допустимое доменное имя, частичное или полное подстановочное имя |
properties.http2Enabled |
boolean |
Указывает, поддерживается ли HTTP/2.0. |
properties.negotiateClientCertificate |
boolean |
Определяет, запрашивает ли шлюз сертификат клиента. |
properties.tls10Enabled |
boolean |
Указывает, поддерживается ли TLS 1.0. |
properties.tls11Enabled |
boolean |
Указывает, поддерживается ли TLS 1.1. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Сведения о конфигурации имени узла шлюза успешно обновлены. Заголовки ETag: string |
|
201 Created |
Новая конфигурация имени узла шлюза успешно создана. Заголовки ETag: string |
|
Other Status Codes |
Ответ об ошибке, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
ApiManagementCreateGatewayHostnameConfiguration
Образец запроса
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default?api-version=2022-08-01
{
"properties": {
"hostname": "*",
"certificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
"negotiateClientCertificate": false,
"tls10Enabled": false,
"tls11Enabled": false,
"http2Enabled": true
}
}
Пример ответа
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default",
"type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations",
"name": "default",
"properties": {
"hostname": "*",
"certificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
"negotiateClientCertificate": false,
"tls10Enabled": false,
"tls11Enabled": false,
"http2Enabled": true
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default",
"type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations",
"name": "default",
"properties": {
"hostname": "*",
"certificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
"negotiateClientCertificate": false,
"tls10Enabled": false,
"tls11Enabled": false,
"http2Enabled": true
}
}
Определения
Имя | Описание |
---|---|
Error |
Контракт поля ошибки. |
Error |
Ответ об ошибке. |
Gateway |
Сведения о конфигурации имени узла шлюза. |
ErrorFieldContract
Контракт поля ошибки.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки уровня свойства. |
message |
string |
Удобочитаемое представление ошибки на уровне свойств. |
target |
string |
Имя свойства. |
ErrorResponse
Ответ об ошибке.
Имя | Тип | Описание |
---|---|---|
error.code |
string |
Код ошибки, определяемый службой. Это код служит в качестве подсостояния для кода ошибки HTTP, указанного в ответе. |
error.details |
Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки. |
|
error.message |
string |
Читаемое представление ошибки. |
GatewayHostnameConfigurationContract
Сведения о конфигурации имени узла шлюза.
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса. Например: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Имя ресурса. |
properties.certificateId |
string |
Идентификатор сущности certificate, которая будет использоваться для установки TLS-подключения |
properties.hostname |
string |
Значение имени узла. Поддерживает допустимое доменное имя, частичное или полное подстановочное имя |
properties.http2Enabled |
boolean |
Указывает, поддерживается ли HTTP/2.0. |
properties.negotiateClientCertificate |
boolean |
Определяет, запрашивает ли шлюз сертификат клиента. |
properties.tls10Enabled |
boolean |
Указывает, поддерживается ли TLS 1.0. |
properties.tls11Enabled |
boolean |
Указывает, поддерживается ли TLS 1.1. |
type |
string |
Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts. |