你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
GatewayHostnameConfiguration interface
表示 GatewayHostnameConfiguration 的接口。
方法
方法详细信息
createOrUpdate(string, string, string, string, GatewayHostnameConfigurationContract, GatewayHostnameConfigurationCreateOrUpdateOptionalParams)
创建网关的更新主机名配置。
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, hcId: string, parameters: GatewayHostnameConfigurationContract, options?: GatewayHostnameConfigurationCreateOrUpdateOptionalParams): Promise<GatewayHostnameConfigurationCreateOrUpdateResponse>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- gatewayId
-
string
网关实体标识符。 在当前API 管理服务实例中必须是唯一的。 不得具有值“managed”
- hcId
-
string
网关主机名配置标识符。 在父网关实体的范围内必须是唯一的。
- parameters
- GatewayHostnameConfigurationContract
网关主机名配置详细信息。
选项参数。
返回
delete(string, string, string, string, string, GatewayHostnameConfigurationDeleteOptionalParams)
从指定的网关中删除指定的主机名配置。
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, hcId: string, ifMatch: string, options?: GatewayHostnameConfigurationDeleteOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- gatewayId
-
string
网关实体标识符。 在当前API 管理服务实例中必须是唯一的。 不得具有值“managed”
- hcId
-
string
网关主机名配置标识符。 在父网关实体的范围内必须是唯一的。
- ifMatch
-
string
实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者对于无条件更新，ETag 应为 * 。
选项参数。
返回
Promise<void>
get(string, string, string, string, GatewayHostnameConfigurationGetOptionalParams)
获取主机名配置的详细信息
function get(resourceGroupName: string, serviceName: string, gatewayId: string, hcId: string, options?: GatewayHostnameConfigurationGetOptionalParams): Promise<GatewayHostnameConfigurationGetResponse>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- gatewayId
-
string
网关实体标识符。 在当前API 管理服务实例中必须是唯一的。 不得具有值“managed”
- hcId
-
string
网关主机名配置标识符。 在父网关实体的范围内必须是唯一的。
选项参数。
返回
getEntityTag(string, string, string, string, GatewayHostnameConfigurationGetEntityTagOptionalParams)
检查指定的网关实体是否存在由标识符指定的主机名配置实体。
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, hcId: string, options?: GatewayHostnameConfigurationGetEntityTagOptionalParams): Promise<GatewayHostnameConfigurationGetEntityTagHeaders>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- gatewayId
-
string
网关实体标识符。 在当前API 管理服务实例中必须是唯一的。 不得具有值“managed”
- hcId
-
string
网关主机名配置标识符。 在父网关实体的范围内必须是唯一的。
选项参数。
返回
listByService(string, string, string, GatewayHostnameConfigurationListByServiceOptionalParams)
列出指定网关的主机名配置集合。
function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayHostnameConfigurationListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayHostnameConfigurationContract, GatewayHostnameConfigurationContract[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- gatewayId
-
string
网关实体标识符。 在当前API 管理服务实例中必须是唯一的。 不得具有值“managed”
选项参数。