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

Gateway Hostname Configuration - Get

获取主机名配置的详细信息

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations/{hcId}?api-version=2022-08-01

URI 参数

名称 必需 类型 说明
gatewayId
path True

string

网关实体标识符。 在当前API 管理服务实例中必须是唯一的。 不得具有值“managed”

hcId
path True

string

网关主机名配置标识符。 在父网关实体的范围内必须是唯一的。

resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

serviceName
path True

string

API 管理服务的名称。

正则表达式模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

GatewayHostnameConfigurationContract

响应正文包含指定的网关实体。

标头

ETag: string

Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementGetGatewayHostnameConfiguration

示例请求

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

示例响应

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

定义

名称 说明
ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

GatewayHostnameConfigurationContract

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

ErrorFieldContract

错误字段协定。

名称 类型 说明
code

string

属性级错误代码。

message

string

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

target

string

属性名称。

ErrorResponse

错误响应。

名称 类型 说明
error.code

string

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

error.details

ErrorFieldContract[]

在发生验证错误时,请求中发送的无效字段列表。

error.message

string

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

GatewayHostnameConfigurationContract

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

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

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

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”