Custom Domains - Enable Custom Https

Service:

CDN

API Version:

2024-02-01

Habilite a entrega https do domínio personalizado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
customDomainName	path	True	string	Nome do domínio personalizado em um ponto de extremidade.
endpointName	path	True	string	Nome do ponto de extremidade no perfil que é exclusivo globalmente.
profileName	path	True	string	Nome do perfil cdn que é exclusivo dentro do grupo de recursos.
resourceGroupName	path	True	string	Nome do grupo de recursos na assinatura do Azure. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	ID de assinatura do Azure.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente. A versão atual é 2024-02-01.

Corpo da solicitação

O corpo da solicitação pode ser um dos seguintes:

Nome	Description
CdnManagedHttpsParameters	Define os parâmetros de origem do certificado usando o certificado gerenciado por CDN para habilitar o SSL.
UserManagedHttpsParameters	Define os parâmetros de origem do certificado usando o certificado keyvault do usuário para habilitar o SSL.

CdnManagedHttpsParameters

Define os parâmetros de origem do certificado usando o certificado gerenciado por CDN para habilitar o SSL.

Nome	Obrigatório	Tipo	Description
certificateSource	True	string: Cdn	Define a origem do certificado SSL.
certificateSourceParameters	True	CdnCertificateSourceParameters	Define os parâmetros de origem do certificado usando o certificado gerenciado por CDN para habilitar o SSL.
protocolType	True	ProtocolType	Define o protocolo de extensão TLS usado para entrega segura.
minimumTlsVersion		MinimumTlsVersion	Versão do protocolo TLS que será usada para Https

UserManagedHttpsParameters

Define os parâmetros de origem do certificado usando o certificado keyvault do usuário para habilitar o SSL.

Nome	Obrigatório	Tipo	Description
certificateSource	True	string: AzureKeyVault	Define a origem do certificado SSL.
certificateSourceParameters	True	KeyVaultCertificateSourceParameters	Define os parâmetros de origem do certificado usando o certificado keyvault do usuário para habilitar o SSL.
protocolType	True	ProtocolType	Define o protocolo de extensão TLS usado para entrega segura.
minimumTlsVersion		MinimumTlsVersion	Versão do protocolo TLS que será usada para Https

Respostas

Nome	Tipo	Description
200 OK	CustomDomain	OK. A solicitação foi bem-sucedida.
202 Accepted	CustomDomain	Aceito e a operação será concluída de forma assíncrona. Headers location: string
Other Status Codes	ErrorResponse	Resposta de erro da CDN que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Definições

Nome	Description
CdnCertificateSourceParameters	Define os parâmetros para usar o certificado gerenciado da CDN para proteger o domínio personalizado.
CdnManagedHttpsParameters	Define os parâmetros de origem do certificado usando o certificado gerenciado por CDN para habilitar o SSL.
CertificateType	Tipo de certificado usado
CustomDomain	Mapeamento amigável de nome de domínio para o nome de host do ponto de extremidade que o cliente fornece para fins de identidade visual, por exemplo , www.contoso.com.
CustomDomainResourceState	Status de recursos do domínio personalizado.
CustomHttpsProvisioningState	Provisionamento status do domínio personalizado.
CustomHttpsProvisioningSubstate	O subestado de provisionamento mostra o progresso da habilitação/desabilitação de HTTPS personalizada passo a passo.
DeleteRule	Descreve a ação que deverá ser tomada quando o certificado for removido do Key Vault.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	Os detalhes do erro.
ErrorResponse	Resposta de erro
IdentityType	O tipo de identidade que cria/modifica recursos
KeyVaultCertificateSourceParameters	Descreve os parâmetros para usar o certificado KeyVault de um usuário para proteger o domínio personalizado.
MinimumTlsVersion	Versão do protocolo TLS que será usada para Https
ProtocolType	Define o protocolo de extensão TLS usado para entrega segura.
SystemData	Ler somente dados do sistema
UpdateRule	Descreve a ação que deverá ser executada quando o certificado for atualizado no Key Vault.
UserManagedHttpsParameters	Define os parâmetros de origem do certificado usando o certificado keyvault do usuário para habilitar o SSL.

CdnCertificateSourceParameters

Define os parâmetros para usar o certificado gerenciado da CDN para proteger o domínio personalizado.

Nome	Tipo	Description
certificateType	CertificateType	Tipo de certificado usado
typeName	enum: CdnCertificateSourceParameters

CdnManagedHttpsParameters

Define os parâmetros de origem do certificado usando o certificado gerenciado por CDN para habilitar o SSL.

Nome	Tipo	Description
certificateSource	string: Cdn	Define a origem do certificado SSL.
certificateSourceParameters	CdnCertificateSourceParameters	Define os parâmetros de origem do certificado usando o certificado gerenciado por CDN para habilitar o SSL.
minimumTlsVersion	MinimumTlsVersion	Versão do protocolo TLS que será usada para Https
protocolType	ProtocolType	Define o protocolo de extensão TLS usado para entrega segura.

CertificateType

Tipo de certificado usado

Nome	Tipo	Description
Dedicated	string
Shared	string

CustomDomain

Mapeamento amigável de nome de domínio para o nome de host do ponto de extremidade que o cliente fornece para fins de identidade visual, por exemplo , www.contoso.com.

Nome	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.customHttpsParameters	CustomDomainHttpsParameters: CdnManagedHttpsParameters UserManagedHttpsParameters	Parâmetros de certificado para proteger HTTPS personalizado
properties.customHttpsProvisioningState	CustomHttpsProvisioningState	Provisionamento status do domínio personalizado.
properties.customHttpsProvisioningSubstate	CustomHttpsProvisioningSubstate	O subestado de provisionamento mostra o progresso da habilitação/desabilitação de HTTPS personalizada passo a passo.
properties.hostName	string	O nome do host do domínio personalizado. Precisa ser um nome de domínio.
properties.provisioningState	CustomHttpsProvisioningState	Provisionamento status de Https Personalizados do domínio personalizado.
properties.resourceState	CustomDomainResourceState	Status de recursos do domínio personalizado.
properties.validationData	string	A validação ou os dados especiais podem ser necessários ao entregar a CDN para algumas regiões devido a motivos de conformidade local. Por exemplo, o número de licença ICP de um domínio personalizado é necessário para fornecer conteúdo na China.
systemData	SystemData	Ler somente dados do sistema
type	string	Tipo de recurso.

CustomDomainResourceState

Status de recursos do domínio personalizado.

Nome	Tipo	Description
Active	string
Creating	string
Deleting	string

CustomHttpsProvisioningState

Provisionamento status do domínio personalizado.

Nome	Tipo	Description
Disabled	string
Disabling	string
Enabled	string
Enabling	string
Failed	string

CustomHttpsProvisioningSubstate

O subestado de provisionamento mostra o progresso da habilitação/desabilitação de HTTPS personalizada passo a passo.

Nome	Tipo	Description
CertificateDeleted	string
CertificateDeployed	string
DeletingCertificate	string
DeployingCertificate	string
DomainControlValidationRequestApproved	string
DomainControlValidationRequestRejected	string
DomainControlValidationRequestTimedOut	string
IssuingCertificate	string
PendingDomainControlValidationREquestApproval	string
SubmittingDomainControlValidationRequest	string

DeleteRule

Descreve a ação que deverá ser tomada quando o certificado for removido do Key Vault.

Nome	Tipo	Description
NoAction	string

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Os detalhes do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

IdentityType

O tipo de identidade que cria/modifica recursos

Nome	Tipo	Description
application	string
key	string
managedIdentity	string
user	string

KeyVaultCertificateSourceParameters

Descreve os parâmetros para usar o certificado KeyVault de um usuário para proteger o domínio personalizado.

Nome	Tipo	Description
deleteRule	DeleteRule	Descreve a ação que deverá ser tomada quando o certificado for removido do Key Vault.
resourceGroupName	string	Grupo de recursos do Key Vault do usuário que contém o certificado SSL
secretName	string	O nome do segredo Key Vault (que representa o PFX do certificado completo) no Key Vault.
secretVersion	string	A versão (GUID) do segredo Key Vault no Key Vault.
subscriptionId	string	ID da assinatura do Key Vault do usuário que contém o certificado SSL
typeName	enum: KeyVaultCertificateSourceParameters
updateRule	UpdateRule	Descreve a ação que deverá ser executada quando o certificado for atualizado no Key Vault.
vaultName	string	O nome do Key Vault do usuário que contém o certificado SSL

MinimumTlsVersion

Versão do protocolo TLS que será usada para Https

Nome	Tipo	Description
None	string
TLS10	string
TLS12	string

ProtocolType

Define o protocolo de extensão TLS usado para entrega segura.

Nome	Tipo	Description
IPBased	string
ServerNameIndication	string

SystemData

Ler somente dados do sistema

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC)
createdBy	string	Um identificador para a identidade que criou o recurso
createdByType	IdentityType	O tipo de identidade que criou o recurso
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	Um identificador para a identidade que modificou o recurso pela última vez
lastModifiedByType	IdentityType	O tipo de identidade que modificou o recurso pela última vez

UpdateRule

Descreve a ação que deverá ser executada quando o certificado for atualizado no Key Vault.

Nome	Tipo	Description
NoAction	string

UserManagedHttpsParameters

Define os parâmetros de origem do certificado usando o certificado keyvault do usuário para habilitar o SSL.

Nome	Tipo	Description
certificateSource	string: AzureKeyVault	Define a origem do certificado SSL.
certificateSourceParameters	KeyVaultCertificateSourceParameters	Define os parâmetros de origem do certificado usando o certificado keyvault do usuário para habilitar o SSL.
minimumTlsVersion	MinimumTlsVersion	Versão do protocolo TLS que será usada para Https
protocolType	ProtocolType	Define o protocolo de extensão TLS usado para entrega segura.