Gateway Hostname Configuration - List By Service

  • Ссылка
Service:
API Management
API Version:
2022-08-01

Возвращает коллекцию конфигураций имен узлов для указанного шлюза.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations?api-version=2022-08-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

Параметры 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

Идентификатор целевой подписки.
api-version
 query True

string

Версия API, используемая для данной операции.
$filter
 query

string

| Поле | Использование | Поддерживаемые операторы | Поддерживаемые функции |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| hostname | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
$skip
 query

integer

int32

Количество записей, которые будут пропущены.
$top
 query

integer

int32

Количество возвращаемых записей.

Ответы

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

GatewayHostnameConfigurationCollection

Коллекция сущностей конфигурации имени узла.
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 олицетворения учетной записи пользователя

Примеры

ApiManagementListGatewayHostnameConfigurations

Sample Request

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

Sample Response

Status code:
200 
{
  "value": [
    {
      "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
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/hostname1",
      "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations",
      "name": "default",
      "properties": {
        "hostname": "foo.bar.com",
        "certificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert2",
        "negotiateClientCertificate": true
      }
    }
  ],
  "nextLink": ""
}

Определения

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

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

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

Представление списка конфигурации имени узла шлюза с постраничной рассылкой.
GatewayHostnameConfigurationContract

Сведения о конфигурации имени узла шлюза.

ErrorFieldContract

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

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

string

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

string

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

string

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

ErrorResponse

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

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

string

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

ErrorFieldContract[]

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

string

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

GatewayHostnameConfigurationCollection

Представление списка конфигурации имени узла шлюза с постраничной рассылкой.

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

string

Ссылка на следующую страницу, если она есть.
value

GatewayHostnameConfigurationContract[]

Значения страницы.

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.