Gateway Hostname Configuration - Create Or Update

Membuat pembaruan konfigurasi nama host untuk Gateway.

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

Parameter URI

Name In Required Type Description
gatewayId
path True
  • string

Pengidentifikasi entitas gateway. Harus unik dalam instans layanan API Management saat ini. Tidak boleh memiliki nilai 'terkelola'

hcId
path True
  • string

Pengidentifikasi konfigurasi nama host gateway. Harus unik dalam cakupan entitas Gateway induk.

resourceGroupName
path True
  • string

Nama grup sumber daya.

serviceName
path True
  • string

Nama layanan API Management.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.

api-version
query True
  • string

Versi API yang akan digunakan dengan permintaan klien.

Header Permintaan

Name Required Type Description
If-Match
  • string

ETag Entitas. Tidak diperlukan saat membuat entitas, tetapi diperlukan saat memperbarui entitas.

Isi Permintaan

Name Type Description
properties.certificateId
  • string

Pengidentifikasi entitas Sertifikat yang akan digunakan untuk pembentukan koneksi TLS

properties.hostname
  • string

Nilai nama host. Mendukung nama domain yang valid, kartubebas parsial atau penuh

properties.http2Enabled
  • boolean

Menentukan apakah HTTP/2.0 didukung

properties.negotiateClientCertificate
  • boolean

Menentukan apakah gateway meminta sertifikat klien

properties.tls10Enabled
  • boolean

Menentukan apakah TLS 1.0 didukung

properties.tls11Enabled
  • boolean

Menentukan apakah TLS 1.1 didukung

Respons

Name Type Description
200 OK

Detail konfigurasi nama host Gateway berhasil diperbarui.

Headers

  • ETag: string
201 Created

Konfigurasi nama host Gateway baru berhasil dibuat.

Headers

  • ETag: string
Other Status Codes

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name Description
user_impersonation meniru akun pengguna Anda

Contoh

ApiManagementCreateGatewayHostnameConfiguration

Sample Request

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

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

Definisi

ErrorFieldContract

Kontrak Bidang Kesalahan.

ErrorResponse

Respons Kesalahan.

GatewayHostnameConfigurationContract

Detail konfigurasi nama host gateway.

ErrorFieldContract

Kontrak Bidang Kesalahan.

Name Type Description
code
  • string

Kode kesalahan tingkat properti.

message
  • string

Representasi kesalahan tingkat properti yang dapat dibaca manusia.

target
  • string

Nama properti.

ErrorResponse

Respons Kesalahan.

Name Type Description
error.code
  • string

Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons.

error.details

Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi.

error.message
  • string

Representasi kesalahan yang dapat dibaca manusia.

GatewayHostnameConfigurationContract

Detail konfigurasi nama host gateway.

Name Type Description
id
  • string

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Nama sumber daya.

properties.certificateId
  • string

Pengidentifikasi entitas Sertifikat yang akan digunakan untuk pembentukan koneksi TLS

properties.hostname
  • string

Nilai nama host. Mendukung nama domain yang valid, kartubebas parsial atau penuh

properties.http2Enabled
  • boolean

Menentukan apakah HTTP/2.0 didukung

properties.negotiateClientCertificate
  • boolean

Menentukan apakah gateway meminta sertifikat klien

properties.tls10Enabled
  • boolean

Menentukan apakah TLS 1.0 didukung

properties.tls11Enabled
  • boolean

Menentukan apakah TLS 1.1 didukung

type
  • string

Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft. Storage/storageAccounts"