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=2021-12-01-preview

URI 매개 변수

Name In Required Type Description
gatewayId
path True
  • string

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

hcId
path True
  • string

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

resourceGroupName
path True
  • string

리소스 그룹의 이름.

serviceName
path True
  • string

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

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

subscriptionId
path True
  • string

Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.

api-version
query True
  • string

클라이언트 요청과 함께 사용할 API의 버전입니다.

요청 헤더

Name Required Type Description
If-Match
  • string

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

요청 본문

Name Type 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 Type Description
200 OK

게이트웨이 호스트 이름 구성 세부 정보가 업데이트되었습니다.

Headers

  • ETag: string
201 Created

새 게이트웨이 호스트 이름 구성이 성공적으로 만들어졌습니다.

Headers

  • ETag: string
Other Status Codes

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

OAuth2 Flow Azure Active Directory.

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

Scopes

Name Description
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=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
  }
}

정의

ErrorFieldContract

오류 필드 계약입니다.

ErrorResponse

오류 응답입니다.

GatewayHostnameConfigurationContract

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

ErrorFieldContract

오류 필드 계약입니다.

Name Type Description
code
  • string

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

message
  • string

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

target
  • string

속성 이름입니다.

ErrorResponse

오류 응답입니다.

Name Type Description
error.code
  • string

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

error.details

유효성 검사 오류가 발생한 경우 요청에 잘못된 필드가 전송되는 목록입니다.

error.message
  • string

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

GatewayHostnameConfigurationContract

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

Name Type 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"