Gateway Hostname Configuration - Create Or Update

服務:

API Management

API 版本:

2024-05-01

建立閘道的更新主機名組態。

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

URI 參數

名稱	位於	必要	類型	Description
gatewayId	path	True	string minLength: 1 maxLength: 80	閘道實體標識碼。 目前 API 管理服務實例中必須是唯一的。 不得有值 'managed'
hcId	path	True	string minLength: 1 maxLength: 80	閘道主機名組態標識碼。 父閘道實體的範圍中必須是唯一的。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API 管理服務的名稱。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

要求標頭

名稱	必要	類型	Description
If-Match		string	實體的 ETag。 建立實體時不需要，但在更新實體時則為必要專案。

要求本文

名稱	類型	Description
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

回應

名稱	類型	Description
200 OK	GatewayHostnameConfigurationContract	已成功更新閘道主機名組態詳細數據。 標題 ETag: string
201 Created	GatewayHostnameConfigurationContract	已成功建立新的閘道主機名組態。 標題 ETag: string
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

ApiManagementCreateGatewayHostnameConfiguration

範例要求

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default?api-version=2024-05-01

{
  "properties": {
    "hostname": "*",
    "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
    "negotiateClientCertificate": false,
    "tls10Enabled": false,
    "tls11Enabled": false,
    "http2Enabled": true
  }
}

範例回覆

狀態碼:

201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default",
  "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations",
  "name": "default",
  "properties": {
    "hostname": "*",
    "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
    "negotiateClientCertificate": false,
    "tls10Enabled": false,
    "tls11Enabled": false,
    "http2Enabled": true
  }
}

狀態碼:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default",
  "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations",
  "name": "default",
  "properties": {
    "hostname": "*",
    "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
    "negotiateClientCertificate": false,
    "tls10Enabled": false,
    "tls11Enabled": false,
    "http2Enabled": true
  }
}

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
GatewayHostnameConfigurationContract	閘道主機名組態詳細數據。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

GatewayHostnameConfigurationContract

Object

閘道主機名組態詳細數據。

名稱	類型	Description
id	string	資源的完整資源標識碼。 例如 - /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”