Gateway Hostname Configuration - Create Or Update
ゲートウェイの更新プログラムのホスト名構成を作成します。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations/{hcId}?api-version=2022-08-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
gateway
|
path | True |
string |
ゲートウェイ エンティティ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 値 'managed' を持つ必要があります |
hc
|
path | True |
string |
ゲートウェイ ホスト名構成識別子。 親 Gateway エンティティのスコープ内で一意である必要があります。 |
resource
|
path | True |
string |
リソース グループの名前。 名前の大文字と小文字は区別されます。 |
service
|
path | True |
string |
API Management サービスの名前。 Regex pattern: |
subscription
|
path | True |
string |
ターゲット サブスクリプションの ID。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
If-Match |
string |
エンティティの ETag。 エンティティを作成する場合は必須ではありませんが、エンティティを更新する場合は必須です。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
properties.certificateId |
string |
TLS 接続の確立に使用される証明書エンティティの識別子 |
properties.hostname |
string |
Hostname 値。 有効なドメイン名、部分的または完全なワイルドカードをサポートします |
properties.http2Enabled |
boolean |
HTTP/2.0 がサポートされているかどうかを指定します |
properties.negotiateClientCertificate |
boolean |
ゲートウェイがクライアント証明書を要求するかどうかを決定します |
properties.tls10Enabled |
boolean |
TLS 1.0 がサポートされているかどうかを指定します |
properties.tls11Enabled |
boolean |
TLS 1.1 がサポートされているかどうかを指定します |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
ゲートウェイ ホスト名の構成の詳細が正常に更新されました。 Headers ETag: string |
|
201 Created |
新しいゲートウェイ ホスト名の構成が正常に作成されました。 Headers ETag: string |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
ApiManagementCreateGatewayHostnameConfiguration
Sample Request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default?api-version=2022-08-01
{
"properties": {
"hostname": "*",
"certificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
"negotiateClientCertificate": false,
"tls10Enabled": false,
"tls11Enabled": false,
"http2Enabled": true
}
}
Sample Response
{
"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,
"tls10Enabled": false,
"tls11Enabled": false,
"http2Enabled": true
}
}
{
"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,
"tls10Enabled": false,
"tls11Enabled": false,
"http2Enabled": true
}
}
定義
名前 | 説明 |
---|---|
Error |
エラー フィールド コントラクト。 |
Error |
エラー応答。 |
Gateway |
ゲートウェイ ホスト名の構成の詳細。 |
ErrorFieldContract
エラー フィールド コントラクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
プロパティ レベルのエラー コード。 |
message |
string |
プロパティ レベルエラーの人間が判読できる表現。 |
target |
string |
プロパティ名。 |
ErrorResponse
エラー応答。
名前 | 型 | 説明 |
---|---|---|
error.code |
string |
サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。 |
error.details |
検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。 |
|
error.message |
string |
人が判読できるエラーの表現。 |
GatewayHostnameConfigurationContract
ゲートウェイ ホスト名の構成の詳細。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
リソースの名前 |
properties.certificateId |
string |
TLS 接続の確立に使用される証明書エンティティの識別子 |
properties.hostname |
string |
Hostname 値。 有効なドメイン名、部分的または完全なワイルドカードをサポートします |
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" |