다음을 통해 공유


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 매개 변수

Name In(다음 안에) 필수 형식 Description
gatewayId
path True

string

게이트웨이 엔터티 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 'managed' 값이 없어야 합니다.

hcId
path True

string

게이트웨이 호스트 이름 구성 식별자입니다. 부모 게이트웨이 엔터티의 scope 고유해야 합니다.

resourceGroupName
path True

string

리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.

serviceName
path True

string

API Management 서비스의 이름입니다.

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

subscriptionId
path True

string

대상 구독의 ID입니다.

api-version
query True

string

이 작업에 사용할 API 버전입니다.

요청 헤더

Name 필수 형식 Description
If-Match

string

엔터티의 ETag입니다. 엔터티를 만들 때는 필요하지 않지만 엔터티를 업데이트할 때 필요합니다.

요청 본문

Name 형식 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이 지원되는지 지정합니다.

응답

Name 형식 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

범위

Name Description
user_impersonation 사용자 계정 가장

예제

ApiManagementCreateGatewayHostnameConfiguration

샘플 요청

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

샘플 응답

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

정의

Name Description
ErrorFieldContract

오류 필드 계약입니다.

ErrorResponse

오류 응답.

GatewayHostnameConfigurationContract

게이트웨이 호스트 이름 구성 세부 정보입니다.

ErrorFieldContract

오류 필드 계약입니다.

Name 형식 Description
code

string

속성 수준 오류 코드입니다.

message

string

사람이 읽을 수 있는 속성 수준 오류 표현입니다.

target

string

속성 이름입니다.

ErrorResponse

오류 응답.

Name 형식 Description
error.code

string

서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다.

error.details

ErrorFieldContract[]

유효성 검사 오류가 발생할 경우 잘못된 필드 목록이 요청에 전송됩니다.

error.message

string

사람이 읽을 수 있는 오류 표현입니다.

GatewayHostnameConfigurationContract

게이트웨이 호스트 이름 구성 세부 정보입니다.

Name 형식 Description
id

string

리소스에 대한 정규화된 리소스 ID입니다. 예 - /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"