Custom Domains - Enable Custom Https

Service:: CDN

Version d'API:: 2025-04-15

Activez la remise https du domaine personnalisé.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
customDomainName	path	True	string	Nom du domaine personnalisé dans un point de terminaison.
endpointName	path	True	string	Nom du point de terminaison sous le profil qui est unique globalement.
profileName	path	True	string	Nom du profil CDN qui est unique dans le groupe de ressources.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Le corps de la requête peut être l’un des suivants :

Nom	Description
CdnManagedHttpsParameters	Définit les paramètres de source de certificat à l’aide du certificat managé CDN pour activer SSL.
UserManagedHttpsParameters	Définit les paramètres de source de certificat à l’aide du certificat de coffre de clés de l’utilisateur pour activer SSL.

CdnManagedHttpsParameters

Définit les paramètres de source de certificat à l’aide du certificat managé CDN pour activer SSL.

Nom	Obligatoire	Type	Description
certificateSource	True	string: Cdn	Définit la source du certificat SSL.
certificateSourceParameters	True	CdnCertificateSourceParameters	Définit les paramètres de source de certificat à l’aide du certificat managé CDN pour activer SSL.
protocolType	True	ProtocolType	Définit le protocole d’extension TLS utilisé pour la remise sécurisée.
minimumTlsVersion		MinimumTlsVersion	Version du protocole TLS qui sera utilisée pour Https

UserManagedHttpsParameters

Définit les paramètres de source de certificat à l’aide du certificat de coffre de clés de l’utilisateur pour activer SSL.

Nom	Obligatoire	Type	Description
certificateSource	True	string: AzureKeyVault	Définit la source du certificat SSL.
certificateSourceParameters	True	KeyVaultCertificateSourceParameters	Définit les paramètres de source de certificat à l’aide du certificat de coffre de clés de l’utilisateur pour activer SSL.
protocolType	True	ProtocolType	Définit le protocole d’extension TLS utilisé pour la remise sécurisée.
minimumTlsVersion		MinimumTlsVersion	Version du protocole TLS qui sera utilisée pour Https

Réponses

Nom	Type	Description
200 OK	CustomDomain	D’ACCORD. La demande a réussi.
202 Accepted	CustomDomain	Accepté et l’opération se termine de façon asynchrone. En-têtes location: string
Other Status Codes	ErrorResponse	Réponse d’erreur CDN décrivant pourquoi l’opération a échoué.

Nom

Type

Description

200 OK

CustomDomain

D’ACCORD. La demande a réussi.

202 Accepted

CustomDomain

Accepté et l’opération se termine de façon asynchrone.

En-têtes

location: string

Other Status Codes

ErrorResponse

Réponse d’erreur CDN décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

CustomDomains_EnableCustomHttpsUsingYourOwnCertificate

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customDomains/www-someDomain-net/enableCustomHttps?api-version=2025-04-15

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/2025-04-15/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

Exemple de réponse

Code d’état:: 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"
  }
}

Code d’état:: 202

azure-asyncoperation: https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-04-15

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

Exemple de requête

HTTP
dotnet

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customDomains/www-someDomain-net/enableCustomHttps?api-version=2025-04-15

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/2025-04-15/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

Exemple de réponse

Code d’état:: 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"
  }
}

Code d’état:: 202

azure-asyncoperation: https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-04-15

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

Définitions

Nom	Description
CdnCertificateSourceParameters	Définit les paramètres d’utilisation du certificat managé CDN pour sécuriser un domaine personnalisé.
CdnManagedHttpsParameters	Définit les paramètres de source de certificat à l’aide du certificat managé CDN pour activer SSL.
CertificateType	Type de certificat utilisé
createdByType	Type d’identité qui a créé la ressource.
CustomDomain	Mappage convivial du nom de domaine vers le nom d’hôte du point de terminaison que le client fournit à des fins de marque, par exemple `www.contoso.com`.
CustomDomainResourceState	État des ressources du domaine personnalisé.
CustomHttpsProvisioningState	État d’approvisionnement du domaine personnalisé.
CustomHttpsProvisioningSubstate	L’état de sous-état d’approvisionnement indique la progression du processus d’activation/désactivation HTTPS personnalisé étape par étape.
DeleteRule	Décrit l’action qui doit être effectuée lorsque le certificat est supprimé de Key Vault.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
KeyVaultCertificateSourceParameters	Décrit les paramètres d’utilisation du certificat KeyVault d’un utilisateur pour sécuriser un domaine personnalisé.
MinimumTlsVersion	Version du protocole TLS qui sera utilisée pour Https
ProtocolType	Définit le protocole d’extension TLS utilisé pour la remise sécurisée.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
UpdateRule	Décrit l’action qui doit être effectuée lorsque le certificat est mis à jour dans Key Vault.
UserManagedHttpsParameters	Définit les paramètres de source de certificat à l’aide du certificat de coffre de clés de l’utilisateur pour activer SSL.

CdnCertificateSourceParameters

Object

Définit les paramètres d’utilisation du certificat managé CDN pour sécuriser un domaine personnalisé.

Nom	Type	Description
certificateType	CertificateType	Type de certificat utilisé
typeName	string: CdnCertificateSourceParameters

CdnManagedHttpsParameters

Object

Définit les paramètres de source de certificat à l’aide du certificat managé CDN pour activer SSL.

Nom	Type	Description
certificateSource	string: Cdn	Définit la source du certificat SSL.
certificateSourceParameters	CdnCertificateSourceParameters	Définit les paramètres de source de certificat à l’aide du certificat managé CDN pour activer SSL.
minimumTlsVersion	MinimumTlsVersion	Version du protocole TLS qui sera utilisée pour Https
protocolType	ProtocolType	Définit le protocole d’extension TLS utilisé pour la remise sécurisée.

CertificateType

Énumération

Type de certificat utilisé

Valeur	Description
Dedicated
Shared

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
Application
Key
ManagedIdentity
User

CustomDomain

Object

Mappage convivial du nom de domaine vers le nom d’hôte du point de terminaison que le client fournit à des fins de marque, par exemple www.contoso.com.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties.customHttpsParameters	CustomDomainHttpsParameters: CdnManagedHttpsParameters UserManagedHttpsParameters	Paramètres de certificat pour la sécurisation du protocole HTTPS personnalisé
properties.customHttpsProvisioningState	CustomHttpsProvisioningState	État d’approvisionnement du domaine personnalisé.
properties.customHttpsProvisioningSubstate	CustomHttpsProvisioningSubstate	L’état de sous-état d’approvisionnement indique la progression du processus d’activation/désactivation HTTPS personnalisé étape par étape.
properties.hostName	string	Nom d’hôte du domaine personnalisé. Doit être un nom de domaine.
properties.provisioningState	CustomHttpsProvisioningState	État d’approvisionnement de Https personnalisé du domaine personnalisé.
properties.resourceState	CustomDomainResourceState	État des ressources du domaine personnalisé.
properties.validationData	string	Une validation spéciale ou des données peuvent être requises lors de la remise du CDN dans certaines régions en raison de raisons de conformité locale. Par exemple, le numéro de licence PCI d’un domaine personnalisé est requis pour fournir du contenu en Chine.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

CustomDomainResourceState

Énumération

État des ressources du domaine personnalisé.

Valeur	Description
Active
Creating
Deleting

CustomHttpsProvisioningState

Énumération

État d’approvisionnement du domaine personnalisé.

Valeur	Description
Disabled
Disabling
Enabled
Enabling
Failed

CustomHttpsProvisioningSubstate

Énumération

L’état de sous-état d’approvisionnement indique la progression du processus d’activation/désactivation HTTPS personnalisé étape par étape.

Valeur	Description
CertificateDeleted
CertificateDeployed
DeletingCertificate
DeployingCertificate
DomainControlValidationRequestApproved
DomainControlValidationRequestRejected
DomainControlValidationRequestTimedOut
IssuingCertificate
PendingDomainControlValidationREquestApproval
SubmittingDomainControlValidationRequest

DeleteRule

Énumération

Décrit l’action qui doit être effectuée lorsque le certificat est supprimé de Key Vault.

Valeur	Description
NoAction

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

KeyVaultCertificateSourceParameters

Object

Décrit les paramètres d’utilisation du certificat KeyVault d’un utilisateur pour sécuriser un domaine personnalisé.

Nom	Type	Description
deleteRule	DeleteRule	Décrit l’action qui doit être effectuée lorsque le certificat est supprimé de Key Vault.
resourceGroupName	string	Groupe de ressources du coffre de clés de l’utilisateur contenant le certificat SSL
secretName	string	Nom du secret Key Vault (représentant le certificat PFX complet) dans Key Vault.
secretVersion	string	Version(GUID) du secret Key Vault dans Key Vault.
subscriptionId	string	ID d’abonnement du coffre de clés de l’utilisateur contenant le certificat SSL
typeName	string: KeyVaultCertificateSourceParameters
updateRule	UpdateRule	Décrit l’action qui doit être effectuée lorsque le certificat est mis à jour dans Key Vault.
vaultName	string	Nom du coffre de clés de l’utilisateur contenant le certificat SSL

MinimumTlsVersion

Énumération

Version du protocole TLS qui sera utilisée pour Https

Valeur	Description
None
TLS10
TLS12

ProtocolType

Énumération

Définit le protocole d’extension TLS utilisé pour la remise sécurisée.

Valeur	Description
IPBased
ServerNameIndication

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

UpdateRule

Énumération

Décrit l’action qui doit être effectuée lorsque le certificat est mis à jour dans Key Vault.

Valeur	Description
NoAction

UserManagedHttpsParameters

Object

Définit les paramètres de source de certificat à l’aide du certificat de coffre de clés de l’utilisateur pour activer SSL.

Nom	Type	Description
certificateSource	string: AzureKeyVault	Définit la source du certificat SSL.
certificateSourceParameters	KeyVaultCertificateSourceParameters	Définit les paramètres de source de certificat à l’aide du certificat de coffre de clés de l’utilisateur pour activer SSL.
minimumTlsVersion	MinimumTlsVersion	Version du protocole TLS qui sera utilisée pour Https
protocolType	ProtocolType	Définit le protocole d’extension TLS utilisé pour la remise sécurisée.

Partager via

Custom Domains - Enable Custom Https

Paramètres URI

Corps de la demande

CdnManagedHttpsParameters

UserManagedHttpsParameters

Réponses

Sécurité

azure_auth

Étendues

Exemples

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

Exemple de requête

Exemple de réponse

CustomDomains_EnableCustomHttpsUsingYourOwnCertificate

Exemple de requête

Exemple de réponse

Définitions

CdnCertificateSourceParameters

CdnManagedHttpsParameters

CertificateType

createdByType

CustomDomain

CustomDomainResourceState

CustomHttpsProvisioningState

CustomHttpsProvisioningSubstate

DeleteRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KeyVaultCertificateSourceParameters

MinimumTlsVersion

ProtocolType

systemData

UpdateRule

UserManagedHttpsParameters