Custom Domains - Enable Custom Https

Service:

CDN

API Version:

2024-02-01

사용자 지정 도메인의 https 배달을 사용하도록 설정합니다.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps?api-version=2024-02-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
customDomainName	path	True	string	엔드포인트 내의 사용자 지정 도메인 이름입니다.
endpointName	path	True	string	전역적으로 고유한 프로필 아래의 엔드포인트 이름입니다.
profileName	path	True	string	리소스 그룹 내에서 고유한 CDN 프로필의 이름입니다.
resourceGroupName	path	True	string	Azure 구독 내의 리소스 그룹 이름입니다. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Azure 구독 ID입니다.
api-version	query	True	string	클라이언트 요청과 함께 사용할 API의 버전입니다. 현재 버전은 2024-02-01입니다.

요청 본문

요청 본문은 다음 중 하나가 될 수 있습니다.

Name	Description
CdnManagedHttpsParameters	SSL을 사용하도록 설정하기 위해 CDN 관리 인증서를 사용하여 인증서 원본 매개 변수를 정의합니다.
UserManagedHttpsParameters	SSL을 사용하도록 설정하기 위해 사용자의 keyvault 인증서를 사용하여 인증서 원본 매개 변수를 정의합니다.

CdnManagedHttpsParameters

SSL을 사용하도록 설정하기 위해 CDN 관리 인증서를 사용하여 인증서 원본 매개 변수를 정의합니다.

Name	필수	형식	Description
certificateSource	True	string: Cdn	SSL 인증서의 원본을 정의합니다.
certificateSourceParameters	True	CdnCertificateSourceParameters	SSL을 사용하도록 설정하기 위해 CDN 관리 인증서를 사용하여 인증서 원본 매개 변수를 정의합니다.
protocolType	True	ProtocolType	보안 전달에 사용되는 TLS 확장 프로토콜을 정의합니다.
minimumTlsVersion		MinimumTlsVersion	Https에 사용할 TLS 프로토콜 버전

UserManagedHttpsParameters

SSL을 사용하도록 설정하기 위해 사용자의 keyvault 인증서를 사용하여 인증서 원본 매개 변수를 정의합니다.

Name	필수	형식	Description
certificateSource	True	string: AzureKeyVault	SSL 인증서의 원본을 정의합니다.
certificateSourceParameters	True	KeyVaultCertificateSourceParameters	SSL을 사용하도록 설정하기 위해 사용자의 keyvault 인증서를 사용하여 인증서 원본 매개 변수를 정의합니다.
protocolType	True	ProtocolType	보안 전달에 사용되는 TLS 확장 프로토콜을 정의합니다.
minimumTlsVersion		MinimumTlsVersion	Https에 사용할 TLS 프로토콜 버전

응답

Name	형식	Description
200 OK	CustomDomain	OK. 요청이 성공했습니다.
202 Accepted	CustomDomain	수락되고 작업이 비동기적으로 완료됩니다. Headers location: string
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 CDN 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	사용자 계정 가장

예제

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

CustomDomains_EnableCustomHttpsUsingYourOwnCertificate

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customDomains/www-someDomain-net/enableCustomHttps?api-version=2024-02-01

Go

package armcdn_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cdn/armcdn/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json
func ExampleCustomDomainsClient_BeginEnableCustomHTTPS_customDomainsEnableCustomHttpsUsingCdnManagedCertificate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcdn.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewCustomDomainsClient().BeginEnableCustomHTTPS(ctx, "RG", "profile1", "endpoint1", "www-someDomain-net", &armcdn.CustomDomainsClientBeginEnableCustomHTTPSOptions{CustomDomainHTTPSParameters: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CustomDomain = armcdn.CustomDomain{
	// 	Name: to.Ptr("www-someDomain-net"),
	// 	Type: to.Ptr("Microsoft.Cdn/profiles/endpoints/customdomains"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net"),
	// 	Properties: &armcdn.CustomDomainProperties{
	// 		CustomHTTPSProvisioningState: to.Ptr(armcdn.CustomHTTPSProvisioningStateEnabled),
	// 		CustomHTTPSProvisioningSubstate: to.Ptr(armcdn.CustomHTTPSProvisioningSubstateCertificateDeployed),
	// 		HostName: to.Ptr("www.someDomain.net"),
	// 		ProvisioningState: to.Ptr(armcdn.CustomHTTPSProvisioningState("Succeeded")),
	// 		ResourceState: to.Ptr(armcdn.CustomDomainResourceStateActive),
	// 		ValidationData: to.Ptr("validationdata"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { CdnManagementClient } = require("@azure/arm-cdn");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Enable https delivery of the custom domain.
 *
 * @summary Enable https delivery of the custom domain.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json
 */
async function customDomainsEnableCustomHttpsUsingCdnManagedCertificate() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const endpointName = "endpoint1";
  const customDomainName = "www-someDomain-net";
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.customDomains.beginEnableCustomHttpsAndWait(
    resourceGroupName,
    profileName,
    endpointName,
    customDomainName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "name": "www-someDomain-net",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net",
  "type": "Microsoft.Cdn/profiles/endpoints/customdomains",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceState": "Active",
    "hostName": "www.someDomain.net",
    "customHttpsProvisioningState": "Enabled",
    "customHttpsProvisioningSubstate": "CertificateDeployed",
    "validationData": "validationdata"
  }
}

Status code:

202

azure-asyncoperation: https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-02-01

Response Body

{
  "name": "www-someDomain-net",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net",
  "type": "Microsoft.Cdn/profiles/endpoints/customdomains",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceState": "Active",
    "hostName": "www.someDomain.net",
    "customHttpsProvisioningState": "Enabling",
    "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval",
    "validationData": "validationdata"
  }
}

CustomDomains_EnableCustomHttpsUsingYourOwnCertificate

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customDomains/www-someDomain-net/enableCustomHttps?api-version=2024-02-01

Go

package armcdn_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cdn/armcdn/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json
func ExampleCustomDomainsClient_BeginEnableCustomHTTPS_customDomainsEnableCustomHttpsUsingYourOwnCertificate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcdn.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewCustomDomainsClient().BeginEnableCustomHTTPS(ctx, "RG", "profile1", "endpoint1", "www-someDomain-net", &armcdn.CustomDomainsClientBeginEnableCustomHTTPSOptions{CustomDomainHTTPSParameters: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CustomDomain = armcdn.CustomDomain{
	// 	Name: to.Ptr("www-someDomain-net"),
	// 	Type: to.Ptr("Microsoft.Cdn/profiles/endpoints/customdomains"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net"),
	// 	Properties: &armcdn.CustomDomainProperties{
	// 		CustomHTTPSProvisioningState: to.Ptr(armcdn.CustomHTTPSProvisioningStateEnabled),
	// 		CustomHTTPSProvisioningSubstate: to.Ptr(armcdn.CustomHTTPSProvisioningSubstateCertificateDeployed),
	// 		HostName: to.Ptr("www.someDomain.net"),
	// 		ProvisioningState: to.Ptr(armcdn.CustomHTTPSProvisioningState("Succeeded")),
	// 		ResourceState: to.Ptr(armcdn.CustomDomainResourceStateActive),
	// 		ValidationData: to.Ptr("validationdata"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { CdnManagementClient } = require("@azure/arm-cdn");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Enable https delivery of the custom domain.
 *
 * @summary Enable https delivery of the custom domain.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json
 */
async function customDomainsEnableCustomHttpsUsingYourOwnCertificate() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const endpointName = "endpoint1";
  const customDomainName = "www-someDomain-net";
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.customDomains.beginEnableCustomHttpsAndWait(
    resourceGroupName,
    profileName,
    endpointName,
    customDomainName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "name": "www-someDomain-net",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net",
  "type": "Microsoft.Cdn/profiles/endpoints/customdomains",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceState": "Active",
    "hostName": "www.someDomain.net",
    "customHttpsProvisioningState": "Enabled",
    "customHttpsProvisioningSubstate": "CertificateDeployed",
    "validationData": "validationdata"
  }
}

Status code:

202

azure-asyncoperation: https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-02-01

Response Body

{
  "name": "www-someDomain-net",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net",
  "type": "Microsoft.Cdn/profiles/endpoints/customdomains",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceState": "Active",
    "hostName": "www.someDomain.net",
    "customHttpsProvisioningState": "Enabling",
    "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval",
    "validationData": "validationdata"
  }
}

정의

Name	Description
CdnCertificateSourceParameters	사용자 지정 도메인을 보호하기 위해 CDN 관리 인증서를 사용하기 위한 매개 변수를 정의합니다.
CdnManagedHttpsParameters	SSL을 사용하도록 설정하기 위해 CDN 관리 인증서를 사용하여 인증서 원본 매개 변수를 정의합니다.
CertificateType	사용된 인증서 유형
CustomDomain	고객이 브랜딩 목적으로 제공하는 엔드포인트 호스트 이름에 대한 친숙한 도메인 이름 매핑(예: www.contoso.com).
CustomDomainResourceState	사용자 지정 도메인의 리소스 상태.
CustomHttpsProvisioningState	사용자 지정 도메인의 프로비전 상태.
CustomHttpsProvisioningSubstate	프로비전 하위 상태는 사용자 지정 HTTPS 사용/비활성화 프로세스의 진행률을 단계별로 보여 줍니다.
DeleteRule	인증서가 Key Vault 제거될 때 수행해야 하는 작업에 대해 설명합니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
IdentityType	리소스를 만들/수정하는 ID 유형
KeyVaultCertificateSourceParameters	사용자 지정 도메인을 보호하기 위해 사용자의 KeyVault 인증서를 사용하기 위한 매개 변수에 대해 설명합니다.
MinimumTlsVersion	Https에 사용할 TLS 프로토콜 버전
ProtocolType	보안 전달에 사용되는 TLS 확장 프로토콜을 정의합니다.
SystemData	시스템 데이터만 읽기
UpdateRule	인증서가 Key Vault 업데이트될 때 수행해야 하는 작업에 대해 설명합니다.
UserManagedHttpsParameters	SSL을 사용하도록 설정하기 위해 사용자의 keyvault 인증서를 사용하여 인증서 원본 매개 변수를 정의합니다.

CdnCertificateSourceParameters

사용자 지정 도메인을 보호하기 위해 CDN 관리 인증서를 사용하기 위한 매개 변수를 정의합니다.

Name	형식	Description
certificateType	CertificateType	사용된 인증서 유형
typeName	enum: CdnCertificateSourceParameters

CdnManagedHttpsParameters

SSL을 사용하도록 설정하기 위해 CDN 관리 인증서를 사용하여 인증서 원본 매개 변수를 정의합니다.

Name	형식	Description
certificateSource	string: Cdn	SSL 인증서의 원본을 정의합니다.
certificateSourceParameters	CdnCertificateSourceParameters	SSL을 사용하도록 설정하기 위해 CDN 관리 인증서를 사용하여 인증서 원본 매개 변수를 정의합니다.
minimumTlsVersion	MinimumTlsVersion	Https에 사용할 TLS 프로토콜 버전
protocolType	ProtocolType	보안 전달에 사용되는 TLS 확장 프로토콜을 정의합니다.

CertificateType

사용된 인증서 유형

Name	형식	Description
Dedicated	string
Shared	string

CustomDomain

고객이 브랜딩 목적으로 제공하는 엔드포인트 호스트 이름에 대한 친숙한 도메인 이름 매핑(예: www.contoso.com).

Name	형식	Description
id	string	리소스 ID입니다.
name	string	리소스 이름입니다.
properties.customHttpsParameters	CustomDomainHttpsParameters: CdnManagedHttpsParameters UserManagedHttpsParameters	사용자 지정 HTTPS 보안을 위한 인증서 매개 변수
properties.customHttpsProvisioningState	CustomHttpsProvisioningState	사용자 지정 도메인의 프로비전 상태.
properties.customHttpsProvisioningSubstate	CustomHttpsProvisioningSubstate	프로비전 하위 상태는 사용자 지정 HTTPS 사용/비활성화 프로세스의 진행률을 단계별로 보여 줍니다.
properties.hostName	string	사용자 지정 도메인의 호스트 이름입니다. 도메인 이름이어야 합니다.
properties.provisioningState	CustomHttpsProvisioningState	사용자 지정 도메인의 사용자 지정 Https의 프로비전 상태.
properties.resourceState	CustomDomainResourceState	사용자 지정 도메인의 리소스 상태.
properties.validationData	string	로컬 규정 준수 이유로 인해 일부 지역에 CDN을 제공할 때 특별한 유효성 검사 또는 데이터가 필요할 수 있습니다. 예를 들어 중국에서 콘텐츠를 배달하려면 사용자 지정 도메인의 ICP 라이선스 번호가 필요합니다.
systemData	SystemData	시스템 데이터만 읽기
type	string	리소스 종류.

CustomDomainResourceState

사용자 지정 도메인의 리소스 상태.

Name	형식	Description
Active	string
Creating	string
Deleting	string

CustomHttpsProvisioningState

사용자 지정 도메인의 프로비전 상태.

Name	형식	Description
Disabled	string
Disabling	string
Enabled	string
Enabling	string
Failed	string

CustomHttpsProvisioningSubstate

프로비전 하위 상태는 사용자 지정 HTTPS 사용/비활성화 프로세스의 진행률을 단계별로 보여 줍니다.

Name	형식	Description
CertificateDeleted	string
CertificateDeployed	string
DeletingCertificate	string
DeployingCertificate	string
DomainControlValidationRequestApproved	string
DomainControlValidationRequestRejected	string
DomainControlValidationRequestTimedOut	string
IssuingCertificate	string
PendingDomainControlValidationREquestApproval	string
SubmittingDomainControlValidationRequest	string

DeleteRule

인증서가 Key Vault 제거될 때 수행해야 하는 작업에 대해 설명합니다.

Name	형식	Description
NoAction	string

ErrorAdditionalInfo

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

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

ErrorDetail

오류 세부 정보입니다.

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

ErrorResponse

오류 응답

Name	형식	Description
error	ErrorDetail	Error 개체.

IdentityType

리소스를 만들/수정하는 ID 유형

Name	형식	Description
application	string
key	string
managedIdentity	string
user	string

KeyVaultCertificateSourceParameters

사용자 지정 도메인을 보호하기 위해 사용자의 KeyVault 인증서를 사용하기 위한 매개 변수에 대해 설명합니다.

Name	형식	Description
deleteRule	DeleteRule	인증서가 Key Vault 제거될 때 수행해야 하는 작업에 대해 설명합니다.
resourceGroupName	string	SSL 인증서를 포함하는 사용자 Key Vault 리소스 그룹
secretName	string	Key Vault 전체 인증서 PFX를 나타내는 Key Vault 비밀의 이름입니다.
secretVersion	string	Key Vault Key Vault Secret 버전(GUID)입니다.
subscriptionId	string	SSL 인증서를 포함하는 사용자 Key Vault 구독 ID
typeName	enum: KeyVaultCertificateSourceParameters
updateRule	UpdateRule	인증서가 Key Vault 업데이트될 때 수행해야 하는 작업에 대해 설명합니다.
vaultName	string	SSL 인증서를 포함하는 사용자 Key Vault 이름

MinimumTlsVersion

Https에 사용할 TLS 프로토콜 버전

Name	형식	Description
None	string
TLS10	string
TLS12	string

ProtocolType

보안 전달에 사용되는 TLS 확장 프로토콜을 정의합니다.

Name	형식	Description
IPBased	string
ServerNameIndication	string

SystemData

시스템 데이터만 읽기

Name	형식	Description
createdAt	string	리소스 만들기 타임스탬프(UTC)
createdBy	string	리소스를 만든 ID의 식별자
createdByType	IdentityType	리소스를 만든 ID 유형
lastModifiedAt	string	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID의 식별자
lastModifiedByType	IdentityType	리소스를 마지막으로 수정한 ID 유형

UpdateRule

인증서가 Key Vault 업데이트될 때 수행해야 하는 작업에 대해 설명합니다.

Name	형식	Description
NoAction	string

UserManagedHttpsParameters

SSL을 사용하도록 설정하기 위해 사용자의 keyvault 인증서를 사용하여 인증서 원본 매개 변수를 정의합니다.

Name	형식	Description
certificateSource	string: AzureKeyVault	SSL 인증서의 원본을 정의합니다.
certificateSourceParameters	KeyVaultCertificateSourceParameters	SSL을 사용하도록 설정하기 위해 사용자의 keyvault 인증서를 사용하여 인증서 원본 매개 변수를 정의합니다.
minimumTlsVersion	MinimumTlsVersion	Https에 사용할 TLS 프로토콜 버전
protocolType	ProtocolType	보안 전달에 사용되는 TLS 확장 프로토콜을 정의합니다.