Custom Domains - Enable Custom Https

Référence

Service:: CDN

Version d'API:: 2024-02-01

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=2024-02-01

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 unique au sein du groupe de ressources.
resourceGroupName	path	True	string	Nom du groupe de ressources dans l’abonnement Azure. Modèle d’expression régulière: `^[-\w\._]+$`
subscriptionId	path	True	string	ID d’abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser avec la demande du client. La version actuelle est 2024-02-01.

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 d’un certificat managé CDN pour l’activation de 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 d’un certificat managé CDN pour l’activation de 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 d’un certificat managé CDN pour l’activation de 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	OK. La demande a réussi.
202 Accepted	CustomDomain	Accepté et l’opération se termine de manière asynchrone. En-têtes location: string
Other Status Codes	ErrorResponse	Réponse d’erreur CDN décrivant la raison de l’échec de l’opération.

Nom

Type

Description

200 OK

CustomDomain

OK. La demande a réussi.

202 Accepted

CustomDomain

Accepté et l’opération se termine de manière asynchrone.

En-têtes

location: string

Other Status Codes

ErrorResponse

Réponse d’erreur CDN décrivant la raison de l’échec de l’opération.

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

Exemple de requête

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


/**
 * Samples for CustomDomains EnableCustomHttps.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/
     * CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json
     */
    /**
     * Sample code: CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        customDomainsEnableCustomHttpsUsingCDNManagedCertificate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getCustomDomains().enableCustomHttps("RG", "profile1",
            "endpoint1", "www-someDomain-net", null, com.azure.core.util.Context.NONE);
    }
}

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

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://video2.skills-academy.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=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

Exemple de requête

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


/**
 * Samples for CustomDomains EnableCustomHttps.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/
     * CustomDomains_EnableCustomHttpsUsingBYOC.json
     */
    /**
     * Sample code: CustomDomains_EnableCustomHttpsUsingYourOwnCertificate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        customDomainsEnableCustomHttpsUsingYourOwnCertificate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getCustomDomains().enableCustomHttps("RG", "profile1",
            "endpoint1", "www-someDomain-net", null, com.azure.core.util.Context.NONE);
    }
}

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

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://video2.skills-academy.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=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"
  }
}

Définitions

Nom	Description
CdnCertificateSourceParameters	Définit les paramètres d’utilisation d’un certificat managé CDN pour sécuriser un domaine personnalisé.
CdnManagedHttpsParameters	Définit les paramètres de source de certificat à l’aide d’un certificat managé CDN pour l’activation de SSL.
CertificateType	Type de certificat utilisé
CustomDomain	Mappage de nom de domaine convivial au nom d’hôte de point de terminaison fourni par le client à des fins de personnalisation, par exemple www.contoso.com.
CustomDomainResourceState	Ressource status du domaine personnalisé.
CustomHttpsProvisioningState	Approvisionnement status du domaine personnalisé.
CustomHttpsProvisioningSubstate	Le sous-état d’approvisionnement montre 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
IdentityType	Type d’identité qui crée/modifie des ressources
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	Lecture seule des données système
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

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

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

CdnManagedHttpsParameters

Définit les paramètres de source de certificat à l’aide d’un certificat managé CDN pour l’activation de 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 d’un certificat managé CDN pour l’activation de 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

Type de certificat utilisé

Nom	Type	Description
Dedicated	string
Shared	string

CustomDomain

Mappage de nom de domaine convivial au nom d’hôte de point de terminaison fourni par le client à des fins de personnalisation, par exemple www.contoso.com.

Nom	Type	Description
id	string	ID de la ressource
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	Approvisionnement status du domaine personnalisé.
properties.customHttpsProvisioningSubstate	CustomHttpsProvisioningSubstate	Le sous-état d’approvisionnement montre 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	Approvisionnement status de Https personnalisé du domaine personnalisé.
properties.resourceState	CustomDomainResourceState	Ressource status du domaine personnalisé.
properties.validationData	string	Une validation ou des données spéciales peuvent être requises lors de la remise du CDN à certaines régions pour des raisons de conformité locale. Par exemple, le numéro de licence ICP d’un domaine personnalisé est requis pour fournir du contenu en Chine.
systemData	SystemData	Lecture seule des données système
type	string	Type de ressource.

CustomDomainResourceState

Ressource status du domaine personnalisé.

Nom	Type	Description
Active	string
Creating	string
Deleting	string

CustomHttpsProvisioningState

Approvisionnement status du domaine personnalisé.

Nom	Type	Description
Disabled	string
Disabling	string
Enabled	string
Enabling	string
Failed	string

CustomHttpsProvisioningSubstate

Le sous-état d’approvisionnement montre la progression du processus d’activation/désactivation HTTPS personnalisé étape par étape.

Nom	Type	Description
CertificateDeleted	string
CertificateDeployed	string
DeletingCertificate	string
DeployingCertificate	string
DomainControlValidationRequestApproved	string
DomainControlValidationRequestRejected	string
DomainControlValidationRequestTimedOut	string
IssuingCertificate	string
PendingDomainControlValidationREquestApproval	string
SubmittingDomainControlValidationRequest	string

DeleteRule

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

Nom	Type	Description
NoAction	string

ErrorAdditionalInfo

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

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

ErrorDetail

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

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet error.

IdentityType

Type d’identité qui crée/modifie des ressources

Nom	Type	Description
application	string
key	string
managedIdentity	string
user	string

KeyVaultCertificateSourceParameters

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 Key Vault de l’utilisateur contenant le certificat SSL
secretName	string	Nom de Key Vault Secret (représentant le certificat complet PFX) dans Key Vault.
secretVersion	string	Version (GUID) de Key Vault Secret dans Key Vault.
subscriptionId	string	ID d’abonnement du Key Vault 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 Key Vault de l’utilisateur contenant le certificat SSL

MinimumTlsVersion

Version du protocole TLS qui sera utilisée pour Https

Nom	Type	Description
None	string
TLS10	string
TLS12	string

ProtocolType

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

Nom	Type	Description
IPBased	string
ServerNameIndication	string

SystemData

Lecture seule des données système

Nom	Type	Description
createdAt	string	Horodatage de la création de ressource (UTC)
createdBy	string	Identificateur de l’identité qui a créé la ressource
createdByType	IdentityType	Type d’identité qui a créé la ressource
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identificateur de l’identité qui a modifié la ressource pour la dernière fois
lastModifiedByType	IdentityType	Type d’identité qui a modifié la ressource pour la dernière fois

UpdateRule

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

Nom	Type	Description
NoAction	string

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

CustomDomain

CustomDomainResourceState

CustomHttpsProvisioningState

CustomHttpsProvisioningSubstate

DeleteRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdentityType

KeyVaultCertificateSourceParameters

MinimumTlsVersion

ProtocolType

SystemData

UpdateRule

UserManagedHttpsParameters

Ressources supplémentaires