Custom Domains - Enable Custom Https

リファレンス

サービス:: CDN

API バージョン:: 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 パラメーター

名前	/	必須	型	説明
customDomainName	path	True	string	エンドポイント内のカスタムドメインの名前。
endpointName	path	True	string	グローバルに一意であるプロファイルの下のエンドポイントの名前。
profileName	path	True	string	リソースグループ内で一意の CDN プロファイルの名前。
resourceGroupName	path	True	string	Azure サブスクリプション内のリソースグループの名前。正規表現パターン: `^[-\w\._]+$`
subscriptionId	path	True	string	Azure サブスクリプション ID。
api-version	query	True	string	クライアント要求で使用される API のバージョン。現在のバージョンは 2024-02-01 です。

要求本文

要求本文は、次のいずれかの可能性があります。

名前	説明
CdnManagedHttpsParameters	SSL を有効にするために CDN マネージド証明書を使用して証明書ソースパラメーターを定義します。
UserManagedHttpsParameters	SSL を有効にするために、ユーザーの keyvault 証明書を使用して証明書ソースパラメーターを定義します。

CdnManagedHttpsParameters

SSL を有効にするために CDN マネージド証明書を使用して証明書ソースパラメーターを定義します。

名前	必須	型	説明
certificateSource	True	string: Cdn	SSL 証明書のソースを定義します。
certificateSourceParameters	True	CdnCertificateSourceParameters	SSL を有効にするために CDN マネージド証明書を使用して証明書ソースパラメーターを定義します。
protocolType	True	ProtocolType	セキュリティで保護された配信に使用される TLS 拡張プロトコルを定義します。
minimumTlsVersion		MinimumTlsVersion	Https に使用される TLS プロトコルのバージョン

UserManagedHttpsParameters

SSL を有効にするために、ユーザーの keyvault 証明書を使用して証明書ソースパラメーターを定義します。

名前	必須	型	説明
certificateSource	True	string: AzureKeyVault	SSL 証明書のソースを定義します。
certificateSourceParameters	True	KeyVaultCertificateSourceParameters	SSL を有効にするために、ユーザーの keyvault 証明書を使用して証明書ソースパラメーターを定義します。
protocolType	True	ProtocolType	セキュリティで保護された配信に使用される TLS 拡張プロトコルを定義します。
minimumTlsVersion		MinimumTlsVersion	Https に使用される TLS プロトコルのバージョン

応答

名前	型	説明
200 OK	CustomDomain	OK です。要求は成功しました。
202 Accepted	CustomDomain	受け入れられ、操作は非同期的に完了します。ヘッダー location: string
Other Status Codes	ErrorResponse	操作が失敗した理由を説明する CDN エラー応答。

名前

型

説明

200 OK

CustomDomain

OK です。要求は成功しました。

202 Accepted

CustomDomain

受け入れられ、操作は非同期的に完了します。

ヘッダー

location: string

Other Status Codes

ErrorResponse

操作が失敗した理由を説明する CDN エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントの借用

例

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

CustomDomains_EnableCustomHttpsUsingYourOwnCertificate

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

要求のサンプル

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.cdn import CdnManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cdn
# USAGE
    python custom_domains_enable_custom_https_using_cdn_managed_certificate.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CdnManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.custom_domains.begin_enable_custom_https(
        resource_group_name="RG",
        profile_name="profile1",
        endpoint_name="endpoint1",
        custom_domain_name="www-someDomain-net",
    ).result()
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json
if __name__ == "__main__":
    main()

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

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

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Cdn.Models;
using Azure.ResourceManager.Cdn;

// Generated from example definition: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json
// this example is just showing the usage of "CdnCustomDomains_EnableCustomHttps" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this CdnCustomDomainResource created on azure
// for more information of creating CdnCustomDomainResource, please refer to the document of CdnCustomDomainResource
string subscriptionId = "subid";
string resourceGroupName = "RG";
string profileName = "profile1";
string endpointName = "endpoint1";
string customDomainName = "www-someDomain-net";
ResourceIdentifier cdnCustomDomainResourceId = CdnCustomDomainResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName, endpointName, customDomainName);
CdnCustomDomainResource cdnCustomDomain = client.GetCdnCustomDomainResource(cdnCustomDomainResourceId);

// invoke the operation
ArmOperation<CdnCustomDomainResource> lro = await cdnCustomDomain.EnableCustomHttpsAsync(WaitUntil.Completed);
CdnCustomDomainResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
CdnCustomDomainData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

応答のサンプル

状態コード:: 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"
  }
}

状態コード:: 202

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

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

要求のサンプル

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.cdn import CdnManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cdn
# USAGE
    python custom_domains_enable_custom_https_using_byoc.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CdnManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.custom_domains.begin_enable_custom_https(
        resource_group_name="RG",
        profile_name="profile1",
        endpoint_name="endpoint1",
        custom_domain_name="www-someDomain-net",
    ).result()
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json
if __name__ == "__main__":
    main()

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

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

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Cdn.Models;
using Azure.ResourceManager.Cdn;

// Generated from example definition: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json
// this example is just showing the usage of "CdnCustomDomains_EnableCustomHttps" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this CdnCustomDomainResource created on azure
// for more information of creating CdnCustomDomainResource, please refer to the document of CdnCustomDomainResource
string subscriptionId = "subid";
string resourceGroupName = "RG";
string profileName = "profile1";
string endpointName = "endpoint1";
string customDomainName = "www-someDomain-net";
ResourceIdentifier cdnCustomDomainResourceId = CdnCustomDomainResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName, endpointName, customDomainName);
CdnCustomDomainResource cdnCustomDomain = client.GetCdnCustomDomainResource(cdnCustomDomainResourceId);

// invoke the operation
ArmOperation<CdnCustomDomainResource> lro = await cdnCustomDomain.EnableCustomHttpsAsync(WaitUntil.Completed);
CdnCustomDomainResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
CdnCustomDomainData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

応答のサンプル

状態コード:: 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"
  }
}

状態コード:: 202

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

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

定義

名前	説明
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 マネージド証明書を使用するためのパラメーターを定義します。

名前	型	説明
certificateType	CertificateType	使用される証明書の種類
typeName	enum: CdnCertificateSourceParameters

CdnManagedHttpsParameters

SSL を有効にするために CDN マネージド証明書を使用して証明書ソースパラメーターを定義します。

名前	型	説明
certificateSource	string: Cdn	SSL 証明書のソースを定義します。
certificateSourceParameters	CdnCertificateSourceParameters	SSL を有効にするために CDN マネージド証明書を使用して証明書ソースパラメーターを定義します。
minimumTlsVersion	MinimumTlsVersion	Https に使用される TLS プロトコルのバージョン
protocolType	ProtocolType	セキュリティで保護された配信に使用される TLS 拡張プロトコルを定義します。

CertificateType

使用される証明書の種類

名前	型	説明
Dedicated	string
Shared	string

CustomDomain

顧客がブランド化のために提供するエンドポイントホスト名へのフレンドリドメイン名マッピング ( 例: www.contoso.com)。

名前	型	説明
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

カスタムドメインのリソースの状態。

名前	型	説明
Active	string
Creating	string
Deleting	string

CustomHttpsProvisioningState

カスタムドメインのプロビジョニング状態。

名前	型	説明
Disabled	string
Disabling	string
Enabled	string
Enabling	string
Failed	string

CustomHttpsProvisioningSubstate

プロビジョニングサブ状態は、カスタム HTTPS の有効化/無効化プロセスの進行状況を段階的に示します。

名前	型	説明
CertificateDeleted	string
CertificateDeployed	string
DeletingCertificate	string
DeployingCertificate	string
DomainControlValidationRequestApproved	string
DomainControlValidationRequestRejected	string
DomainControlValidationRequestTimedOut	string
IssuingCertificate	string
PendingDomainControlValidationREquestApproval	string
SubmittingDomainControlValidationRequest	string

DeleteRule

証明書がKey Vaultから削除されたときに実行されるアクションについて説明します。

名前	型	説明
NoAction	string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

IdentityType

リソースを作成または変更する ID の種類

名前	型	説明
application	string
key	string
managedIdentity	string
user	string

KeyVaultCertificateSourceParameters

カスタムドメインをセキュリティで保護するためにユーザーの KeyVault 証明書を使用するためのパラメーターについて説明します。

名前	型	説明
deleteRule	DeleteRule	証明書がKey Vaultから削除されたときに実行されるアクションについて説明します。
resourceGroupName	string	SSL 証明書を含むユーザーのKey Vaultのリソースグループ
secretName	string	Key Vault内の Key Vault シークレット (完全な証明書 PFX を表す) の名前。
secretVersion	string	Key VaultのKey Vault シークレットのバージョン (GUID)。
subscriptionId	string	SSL 証明書を含むユーザーのKey Vaultのサブスクリプション ID
typeName	enum: KeyVaultCertificateSourceParameters
updateRule	UpdateRule	Key Vaultで証明書が更新されたときに実行されるアクションについて説明します。
vaultName	string	SSL 証明書を含むユーザーのKey Vaultの名前

MinimumTlsVersion

Https に使用される TLS プロトコルのバージョン

名前	型	説明
None	string
TLS10	string
TLS12	string

ProtocolType

セキュリティで保護された配信に使用される TLS 拡張プロトコルを定義します。

名前	型	説明
IPBased	string
ServerNameIndication	string

SystemData

システムデータの読み取り専用

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)
createdBy	string	リソースを作成した ID の識別子
createdByType	IdentityType	リソースを作成した ID の種類
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID の識別子
lastModifiedByType	IdentityType	リソースを最後に変更した ID の種類

UpdateRule

Key Vaultで証明書が更新されたときに実行されるアクションについて説明します。

名前	型	説明
NoAction	string

UserManagedHttpsParameters

SSL を有効にするために、ユーザーの keyvault 証明書を使用して証明書ソースパラメーターを定義します。

名前	型	説明
certificateSource	string: AzureKeyVault	SSL 証明書のソースを定義します。
certificateSourceParameters	KeyVaultCertificateSourceParameters	SSL を有効にするために、ユーザーの keyvault 証明書を使用して証明書ソースパラメーターを定義します。
minimumTlsVersion	MinimumTlsVersion	Https に使用される TLS プロトコルのバージョン
protocolType	ProtocolType	セキュリティで保護された配信に使用される TLS 拡張プロトコルを定義します。

次の方法で共有

Custom Domains - Enable Custom Https

URI パラメーター

要求本文

CdnManagedHttpsParameters

UserManagedHttpsParameters

応答

セキュリティ

azure_auth

スコープ

例

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

要求のサンプル

応答のサンプル

CustomDomains_EnableCustomHttpsUsingYourOwnCertificate

要求のサンプル

応答のサンプル

定義

CdnCertificateSourceParameters

CdnManagedHttpsParameters

CertificateType

CustomDomain

CustomDomainResourceState

CustomHttpsProvisioningState

CustomHttpsProvisioningSubstate

DeleteRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdentityType

KeyVaultCertificateSourceParameters

MinimumTlsVersion

ProtocolType

SystemData

UpdateRule

UserManagedHttpsParameters

その他のリソース