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

Name	In(다음 안에)	필수	형식	Description
gatewayId	path	True	string minLength: 1 maxLength: 80	게이트웨이 엔터티 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. '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 Management 서비스의 이름입니다.
subscriptionId	path	True	string (uuid)	대상 구독의 ID입니다. 값은 UUID여야 합니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 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

샘플 요청

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

정의

Name	Description
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
GatewayHostnameConfigurationContract	게이트웨이 호스트 이름 구성 세부 정보입니다.

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

GatewayHostnameConfigurationContract

Object

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

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"