你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Gateway Hostname Configuration - List By Service

列出指定网关的主机名配置集合。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations?api-version=2020-12-01
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=2020-12-01

URI 参数

Name In Required Type Description
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

唯一标识Microsoft Azure订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

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

要返回的记录数。

响应

Name Type Description
200 OK

主机名配置实体的集合。

Other Status Codes

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

ApiManagementListGatewayHostnameConfigurations

Sample Request

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

Sample Response

{
  "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

错误字段协定。

Name Type Description
code
  • string

属性级错误代码。

message
  • string

可读属性级错误的可读表示形式。

target
  • string

属性名称。

ErrorResponse

错误响应。

Name Type Description
error.code
  • string

服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。

error.details

请求中发送的无效字段列表(如果出现验证错误)。

error.message
  • string

错误的用户可读表示形式。

GatewayHostnameConfigurationCollection

分页网关主机名配置列表表示形式。

Name Type Description
nextLink
  • string

下一页链接(如果有)。

value

页面值。

GatewayHostnameConfigurationContract

网关主机名配置详细信息。

Name Type Description
id
  • string

资源 ID。

name
  • string

资源名称。

properties.certificateId
  • string

用于建立 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

API 管理资源的资源类型。