Custom Domains - Enable Custom Https

Service:

CDN

API Version:

2024-02-01

Habilite la entrega https del dominio 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 identificador URI

Nombre	En	Requerido	Tipo	Description
customDomainName	path	True	string	Nombre del dominio personalizado dentro de un punto de conexión.
endpointName	path	True	string	Nombre del punto de conexión en el perfil que es único globalmente.
profileName	path	True	string	Nombre del perfil de cdn que es único dentro del grupo de recursos.
resourceGroupName	path	True	string	Nombre del grupo de recursos dentro de la suscripción de Azure. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Identificador de suscripción de Azure
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente. La versión actual es 2024-02-01.

Cuerpo de la solicitud

El cuerpo de la solicitud puede ser uno de los siguientes:

Nombre	Description
CdnManagedHttpsParameters	Define los parámetros de origen del certificado mediante el certificado administrado por CDN para habilitar SSL.
UserManagedHttpsParameters	Define los parámetros de origen del certificado mediante el certificado de almacén de claves del usuario para habilitar SSL.

CdnManagedHttpsParameters

Define los parámetros de origen del certificado mediante el certificado administrado por CDN para habilitar SSL.

Nombre	Requerido	Tipo	Description
certificateSource	True	string: Cdn	Define el origen del certificado SSL.
certificateSourceParameters	True	CdnCertificateSourceParameters	Define los parámetros de origen del certificado mediante el certificado administrado por CDN para habilitar SSL.
protocolType	True	ProtocolType	Define el protocolo de extensión TLS que se usa para la entrega segura.
minimumTlsVersion		MinimumTlsVersion	Versión del protocolo TLS que se usará para Https

UserManagedHttpsParameters

Define los parámetros de origen del certificado mediante el certificado de almacén de claves del usuario para habilitar SSL.

Nombre	Requerido	Tipo	Description
certificateSource	True	string: AzureKeyVault	Define el origen del certificado SSL.
certificateSourceParameters	True	KeyVaultCertificateSourceParameters	Define los parámetros de origen del certificado mediante el certificado de almacén de claves del usuario para habilitar SSL.
protocolType	True	ProtocolType	Define el protocolo de extensión TLS que se usa para la entrega segura.
minimumTlsVersion		MinimumTlsVersion	Versión del protocolo TLS que se usará para Https

Respuestas

Nombre	Tipo	Description
200 OK	CustomDomain	Aceptar. La solicitud se ha realizado correctamente.
202 Accepted	CustomDomain	Aceptado y la operación se completará de forma asincrónica. Headers location: string
Other Status Codes	ErrorResponse	Respuesta de error de la red CDN que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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

Definiciones

Nombre	Description
CdnCertificateSourceParameters	Define los parámetros para usar el certificado administrado de CDN para proteger el dominio personalizado.
CdnManagedHttpsParameters	Define los parámetros de origen del certificado mediante el certificado administrado por CDN para habilitar SSL.
CertificateType	Tipo de certificado usado
CustomDomain	Asignación de nombres de dominio descriptivos al nombre de host del punto de conexión que el cliente proporciona con fines de personalización de marca, por ejemplo , www.contoso.com.
CustomDomainResourceState	Estado del recurso del dominio personalizado.
CustomHttpsProvisioningState	Estado de aprovisionamiento del dominio personalizado.
CustomHttpsProvisioningSubstate	El substate de aprovisionamiento muestra el progreso de la habilitación o deshabilitación del proceso personalizado https paso a paso.
DeleteRule	Describe la acción que se realizará cuando se quite el certificado de Key Vault.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
IdentityType	Tipo de identidad que crea o modifica recursos.
KeyVaultCertificateSourceParameters	Describe los parámetros para usar el certificado KeyVault de un usuario para proteger el dominio personalizado.
MinimumTlsVersion	Versión del protocolo TLS que se usará para Https
ProtocolType	Define el protocolo de extensión TLS que se usa para la entrega segura.
SystemData	Datos del sistema de solo lectura
UpdateRule	Describe la acción que se realizará cuando se actualice el certificado en Key Vault.
UserManagedHttpsParameters	Define los parámetros de origen del certificado mediante el certificado de almacén de claves del usuario para habilitar SSL.

CdnCertificateSourceParameters

Define los parámetros para usar el certificado administrado de CDN para proteger el dominio personalizado.

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

CdnManagedHttpsParameters

Define los parámetros de origen del certificado mediante el certificado administrado por CDN para habilitar SSL.

Nombre	Tipo	Description
certificateSource	string: Cdn	Define el origen del certificado SSL.
certificateSourceParameters	CdnCertificateSourceParameters	Define los parámetros de origen del certificado mediante el certificado administrado por CDN para habilitar SSL.
minimumTlsVersion	MinimumTlsVersion	Versión del protocolo TLS que se usará para Https
protocolType	ProtocolType	Define el protocolo de extensión TLS que se usa para la entrega segura.

CertificateType

Tipo de certificado usado

Nombre	Tipo	Description
Dedicated	string
Shared	string

CustomDomain

Asignación de nombres de dominio descriptivos al nombre de host del punto de conexión que el cliente proporciona con fines de personalización de marca, por ejemplo , www.contoso.com.

Nombre	Tipo	Description
id	string	Identificador del recurso.
name	string	Nombre del recurso.
properties.customHttpsParameters	CustomDomainHttpsParameters: CdnManagedHttpsParameters UserManagedHttpsParameters	Parámetros de certificado para proteger HTTPS personalizado
properties.customHttpsProvisioningState	CustomHttpsProvisioningState	Estado de aprovisionamiento del dominio personalizado.
properties.customHttpsProvisioningSubstate	CustomHttpsProvisioningSubstate	El substate de aprovisionamiento muestra el progreso de la habilitación o deshabilitación del proceso personalizado https paso a paso.
properties.hostName	string	Nombre de host del dominio personalizado. Debe ser un nombre de dominio.
properties.provisioningState	CustomHttpsProvisioningState	Estado de aprovisionamiento de Https personalizado del dominio personalizado.
properties.resourceState	CustomDomainResourceState	Estado del recurso del dominio personalizado.
properties.validationData	string	Es posible que se necesiten datos o validación especiales al entregar la red CDN a algunas regiones debido a motivos de cumplimiento local. Por ejemplo, el número de licencia de ICP de un dominio personalizado es necesario para entregar contenido en China.
systemData	SystemData	Datos del sistema de solo lectura
type	string	Tipo de recurso.

CustomDomainResourceState

Estado del recurso del dominio personalizado.

Nombre	Tipo	Description
Active	string
Creating	string
Deleting	string

CustomHttpsProvisioningState

Estado de aprovisionamiento del dominio personalizado.

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

CustomHttpsProvisioningSubstate

El substate de aprovisionamiento muestra el progreso de la habilitación o deshabilitación del proceso personalizado https paso a paso.

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

DeleteRule

Describe la acción que se realizará cuando se quite el certificado de Key Vault.

Nombre	Tipo	Description
NoAction	string

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

IdentityType

Tipo de identidad que crea o modifica recursos.

Nombre	Tipo	Description
application	string
key	string
managedIdentity	string
user	string

KeyVaultCertificateSourceParameters

Describe los parámetros para usar el certificado KeyVault de un usuario para proteger el dominio personalizado.

Nombre	Tipo	Description
deleteRule	DeleteRule	Describe la acción que se realizará cuando se quite el certificado de Key Vault.
resourceGroupName	string	Grupo de recursos del Key Vault del usuario que contiene el certificado SSL
secretName	string	Nombre de Key Vault Secreto (que representa el certificado completo PFX) en Key Vault.
secretVersion	string	La versión (GUID) de Key Vault Secreto en Key Vault.
subscriptionId	string	Identificador de suscripción del Key Vault del usuario que contiene el certificado SSL
typeName	enum: KeyVaultCertificateSourceParameters
updateRule	UpdateRule	Describe la acción que se realizará cuando se actualice el certificado en Key Vault.
vaultName	string	Nombre del Key Vault del usuario que contiene el certificado SSL.

MinimumTlsVersion

Versión del protocolo TLS que se usará para Https

Nombre	Tipo	Description
None	string
TLS10	string
TLS12	string

ProtocolType

Define el protocolo de extensión TLS que se usa para la entrega segura.

Nombre	Tipo	Description
IPBased	string
ServerNameIndication	string

SystemData

Datos del sistema de solo lectura

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC)
createdBy	string	Identificador de la identidad que creó el recurso.
createdByType	IdentityType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identificador de la identidad que modificó el recurso por última vez.
lastModifiedByType	IdentityType	Tipo de identidad que modificó por última vez el recurso.

UpdateRule

Describe la acción que se realizará cuando se actualice el certificado en Key Vault.

Nombre	Tipo	Description
NoAction	string

UserManagedHttpsParameters

Define los parámetros de origen del certificado mediante el certificado de almacén de claves del usuario para habilitar SSL.

Nombre	Tipo	Description
certificateSource	string: AzureKeyVault	Define el origen del certificado SSL.
certificateSourceParameters	KeyVaultCertificateSourceParameters	Define los parámetros de origen del certificado mediante el certificado de almacén de claves del usuario para habilitar SSL.
minimumTlsVersion	MinimumTlsVersion	Versión del protocolo TLS que se usará para Https
protocolType	ProtocolType	Define el protocolo de extensión TLS que se usa para la entrega segura.