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

Имя	В	Обязательно	Тип	Описание
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.
api-version	query	True	string	Версия API для использования с клиентским запросом. Текущая версия — 01.02.2024.

Текст запроса

Текст запроса может быть таким:

Имя	Описание
CdnManagedHttpsParameters	Определяет параметры источника сертификата с помощью управляемого сертификата CDN для включения SSL.
UserManagedHttpsParameters	Определяет параметры источника сертификата, используя сертификат хранилища ключей пользователя для включения SSL.

CdnManagedHttpsParameters

Определяет параметры источника сертификата с помощью управляемого сертификата CDN для включения SSL.

Имя	Обязательно	Тип	Описание
certificateSource	True	string: Cdn	Определяет источник SSL-сертификата.
certificateSourceParameters	True	CdnCertificateSourceParameters	Определяет параметры источника сертификата с помощью управляемого сертификата CDN для включения SSL.
protocolType	True	ProtocolType	Определяет протокол расширения TLS, используемый для безопасной доставки.
minimumTlsVersion		MinimumTlsVersion	Версия протокола TLS, которая будет использоваться для https

UserManagedHttpsParameters

Определяет параметры источника сертификата, используя сертификат хранилища ключей пользователя для включения SSL.

Имя	Обязательно	Тип	Описание
certificateSource	True	string: AzureKeyVault	Определяет источник SSL-сертификата.
certificateSourceParameters	True	KeyVaultCertificateSourceParameters	Определяет параметры источника сертификата, используя сертификат хранилища ключей пользователя для включения SSL.
protocolType	True	ProtocolType	Определяет протокол расширения TLS, используемый для безопасной доставки.
minimumTlsVersion		MinimumTlsVersion	Версия протокола TLS, которая будет использоваться для https

Ответы

Имя	Тип	Описание
200 OK	CustomDomain	Все в порядке. Запрос выполнен успешно.
202 Accepted	CustomDomain	Принято, и операция завершится асинхронно. Headers location: string
Other Status Codes	ErrorResponse	Ответ об ошибке CDN, описывающий причину сбоя операции.

Имя

Тип

Описание

200 OK

CustomDomain

Все в порядке. Запрос выполнен успешно.

202 Accepted

CustomDomain

Принято, и операция завершится асинхронно.

Headers

location: string

Other Status Codes

ErrorResponse

Ответ об ошибке CDN, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

CustomDomains_EnableCustomHttpsUsingYourOwnCertificate

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

Sample Request

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

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

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

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

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

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

Определения

Имя	Описание
CdnCertificateSourceParameters	Определяет параметры использования управляемого сертификата CDN для защиты личного домена.
CdnManagedHttpsParameters	Определяет параметры источника сертификата с помощью управляемого сертификата CDN для включения SSL.
CertificateType	Тип используемого сертификата
CustomDomain	Понятное сопоставление доменного имени с именем узла конечной точки, которое клиент предоставляет для целей фирменной символики, например www.contoso.com.
CustomDomainResourceState	Состояние ресурса личного домена.
CustomHttpsProvisioningState	Состояние подготовки личного домена.
CustomHttpsProvisioningSubstate	В подсостояние подготовки показано пошаговое выполнение пользовательского процесса включения и отключения HTTPS.
DeleteRule	Описывает действия, которые необходимо выполнить при удалении сертификата из Key Vault.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
IdentityType	Тип удостоверения, создающего или изменяющего ресурсы
KeyVaultCertificateSourceParameters	Описываются параметры использования сертификата KeyVault пользователя для защиты личного домена.
MinimumTlsVersion	Версия протокола TLS, которая будет использоваться для https
ProtocolType	Определяет протокол расширения TLS, используемый для безопасной доставки.
SystemData	Чтение только системных данных
UpdateRule	Описывает действия, которые необходимо предпринять при обновлении сертификата в Key Vault.
UserManagedHttpsParameters	Определяет параметры источника сертификата, используя сертификат хранилища ключей пользователя для включения SSL.

CdnCertificateSourceParameters

Определяет параметры использования управляемого сертификата CDN для защиты личного домена.

Имя	Тип	Описание
certificateType	CertificateType	Тип используемого сертификата
typeName	enum: CdnCertificateSourceParameters

CdnManagedHttpsParameters

Определяет параметры источника сертификата с помощью управляемого сертификата CDN для включения SSL.

Имя	Тип	Описание
certificateSource	string: Cdn	Определяет источник SSL-сертификата.
certificateSourceParameters	CdnCertificateSourceParameters	Определяет параметры источника сертификата с помощью управляемого сертификата CDN для включения SSL.
minimumTlsVersion	MinimumTlsVersion	Версия протокола TLS, которая будет использоваться для https
protocolType	ProtocolType	Определяет протокол расширения TLS, используемый для безопасной доставки.

CertificateType

Тип используемого сертификата

Имя	Тип	Описание
Dedicated	string
Shared	string

CustomDomain

Понятное сопоставление доменного имени с именем узла конечной точки, которое клиент предоставляет для целей фирменной символики, например www.contoso.com.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
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

Тип удостоверения, создающего или изменяющего ресурсы

Имя	Тип	Описание
application	string
key	string
managedIdentity	string
user	string

KeyVaultCertificateSourceParameters

Описываются параметры использования сертификата KeyVault пользователя для защиты личного домена.

Имя	Тип	Описание
deleteRule	DeleteRule	Описывает действия, которые необходимо выполнить при удалении сертификата из Key Vault.
resourceGroupName	string	Группа ресурсов Key Vault пользователя, содержащая SSL-сертификат
secretName	string	Имя секрета Key Vault (представляющего полный PFX-файл сертификата) в Key Vault.
secretVersion	string	Версия (GUID) секрета Key Vault в Key Vault.
subscriptionId	string	Идентификатор подписки Key Vault пользователя, содержащего SSL-сертификат
typeName	enum: KeyVaultCertificateSourceParameters
updateRule	UpdateRule	Описывает действия, которые необходимо предпринять при обновлении сертификата в Key Vault.
vaultName	string	Имя Key Vault пользователя, содержащего SSL-сертификат.

MinimumTlsVersion

Версия протокола TLS, которая будет использоваться для https

Имя	Тип	Описание
None	string
TLS10	string
TLS12	string

ProtocolType

Определяет протокол расширения TLS, используемый для безопасной доставки.

Имя	Тип	Описание
IPBased	string
ServerNameIndication	string

SystemData

Чтение только системных данных

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC)
createdBy	string	Идентификатор удостоверения, создавшего ресурс.
createdByType	IdentityType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор удостоверения, изменившего ресурс в последний раз.
lastModifiedByType	IdentityType	Тип удостоверения, которое в последний раз изменял ресурс.

UpdateRule

Описывает действия, которые необходимо предпринять при обновлении сертификата в Key Vault.

Имя	Тип	Описание
NoAction	string

UserManagedHttpsParameters

Имя	Тип	Описание
certificateSource	string: AzureKeyVault	Определяет источник SSL-сертификата.
certificateSourceParameters	KeyVaultCertificateSourceParameters	Определяет параметры источника сертификата, используя сертификат хранилища ключей пользователя для включения SSL.
minimumTlsVersion	MinimumTlsVersion	Версия протокола TLS, которая будет использоваться для https
protocolType	ProtocolType	Определяет протокол расширения TLS, используемый для безопасной доставки.

Поделиться через

Custom Domains - Enable Custom Https

Параметры URI

Текст запроса

CdnManagedHttpsParameters

UserManagedHttpsParameters

Ответы

Безопасность

azure_auth

Scopes

Примеры

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

Sample Request

Sample Response

CustomDomains_EnableCustomHttpsUsingYourOwnCertificate

Sample Request

Sample Response

Определения

CdnCertificateSourceParameters

CdnManagedHttpsParameters

CertificateType

CustomDomain

CustomDomainResourceState

CustomHttpsProvisioningState

CustomHttpsProvisioningSubstate

DeleteRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdentityType

KeyVaultCertificateSourceParameters

MinimumTlsVersion

ProtocolType

SystemData

UpdateRule

UserManagedHttpsParameters

Дополнительные ресурсы