Bagikan melalui


Gateway Hostname Configuration - Get

Mendapatkan detail konfigurasi nama host

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
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. Nama tidak peka huruf besar/kecil.

serviceName
path True

string

Nama layanan API Management.

Pola regex: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ID langganan target.

api-version
query True

string

Versi API yang digunakan untuk operasi ini.

Respons

Nama Jenis Deskripsi
200 OK

GatewayHostnameConfigurationContract

Isi respons berisi entitas Gateway yang ditentukan.

Header

ETag: string

Other Status Codes

ErrorResponse

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

ApiManagementGetGatewayHostnameConfiguration

Permintaan sampel

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

Respon sampel

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

Definisi

Nama Deskripsi
ErrorFieldContract

Kontrak Bidang Kesalahan.

ErrorResponse

Respons Kesalahan.

GatewayHostnameConfigurationContract

Detail konfigurasi nama host gateway.

ErrorFieldContract

Kontrak Bidang Kesalahan.

Nama Jenis Deskripsi
code

string

Kode kesalahan tingkat properti.

message

string

Representasi kesalahan tingkat properti yang dapat dibaca manusia.

target

string

Nama properti.

ErrorResponse

Respons Kesalahan.

Nama Jenis Deskripsi
error.code

string

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

error.details

ErrorFieldContract[]

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.

Nama Jenis Deskripsi
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"