Custom Domains - Enable Custom Https

Riferimento

Servizio:: CDN

Versione API:: 2024-02-01

Abilitare il recapito https del dominio personalizzato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
customDomainName	path	True	string	Nome del dominio personalizzato all'interno di un endpoint.
endpointName	path	True	string	Nome dell'endpoint nel profilo univoco a livello globale.
profileName	path	True	string	Nome del profilo della rete CDN univoco all'interno del gruppo di risorse.
resourceGroupName	path	True	string	Nome del gruppo di risorse all'interno della sottoscrizione di Azure. Criterio di espressione regolare: `^[-\w\._]+$`
subscriptionId	path	True	string	ID sottoscrizione di Azure.
api-version	query	True	string	Versione dell'API da usare con la richiesta client. La versione corrente è 2024-02-01.

Corpo della richiesta

Il corpo della richiesta può essere uno dei seguenti:

Nome	Descrizione
CdnManagedHttpsParameters	Definisce i parametri di origine del certificato usando il certificato gestito della rete CDN per abilitare SSL.
UserManagedHttpsParameters	Definisce i parametri di origine del certificato usando il certificato dell'insieme di credenziali delle chiavi dell'utente per abilitare SSL.

CdnManagedHttpsParameters

Definisce i parametri di origine del certificato usando il certificato gestito della rete CDN per abilitare SSL.

Nome	Necessario	Tipo	Descrizione
certificateSource	True	string: Cdn	Definisce l'origine del certificato SSL.
certificateSourceParameters	True	CdnCertificateSourceParameters	Definisce i parametri di origine del certificato usando il certificato gestito della rete CDN per abilitare SSL.
protocolType	True	ProtocolType	Definisce il protocollo di estensione TLS usato per il recapito sicuro.
minimumTlsVersion		MinimumTlsVersion	Versione del protocollo TLS che verrà usata per Https

UserManagedHttpsParameters

Definisce i parametri di origine del certificato usando il certificato dell'insieme di credenziali delle chiavi dell'utente per abilitare SSL.

Nome	Necessario	Tipo	Descrizione
certificateSource	True	string: AzureKeyVault	Definisce l'origine del certificato SSL.
certificateSourceParameters	True	KeyVaultCertificateSourceParameters	Definisce i parametri di origine del certificato usando il certificato dell'insieme di credenziali delle chiavi dell'utente per abilitare SSL.
protocolType	True	ProtocolType	Definisce il protocollo di estensione TLS usato per il recapito sicuro.
minimumTlsVersion		MinimumTlsVersion	Versione del protocollo TLS che verrà usata per Https

Risposte

Nome	Tipo	Descrizione
200 OK	CustomDomain	OK. La richiesta ha avuto esito positivo.
202 Accepted	CustomDomain	Accettato e l'operazione verrà completata in modo asincrono. Intestazioni location: string
Other Status Codes	ErrorResponse	Risposta di errore della rete CDN che descrive il motivo per cui l'operazione non è riuscita.

Nome

Tipo

Descrizione

200 OK

CustomDomain

OK. La richiesta ha avuto esito positivo.

202 Accepted

CustomDomain

Accettato e l'operazione verrà completata in modo asincrono.

Intestazioni

location: string

Other Status Codes

ErrorResponse

Risposta di errore della rete CDN che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

CustomDomains_EnableCustomHttpsUsingYourOwnCertificate

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
  }
}

Codice di stato:: 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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
  }
}

Codice di stato:: 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"
  }
}

Definizioni

Nome	Descrizione
CdnCertificateSourceParameters	Definisce i parametri per l'uso del certificato gestito della rete CDN per la protezione di un dominio personalizzato.
CdnManagedHttpsParameters	Definisce i parametri di origine del certificato usando il certificato gestito della rete CDN per abilitare SSL.
CertificateType	Tipo di certificato usato
CustomDomain	Mapping dei nomi di dominio descrittivi al nome host dell'endpoint fornito dal cliente a scopo di personalizzazione, ad esempio www.contoso.com.
CustomDomainResourceState	Stato della risorsa del dominio personalizzato.
CustomHttpsProvisioningState	Stato del provisioning del dominio personalizzato.
CustomHttpsProvisioningSubstate	Lo stato secondario di provisioning mostra lo stato di avanzamento dell'abilitazione/disabilitazione del processo HTTPS personalizzato passo dopo passo.
DeleteRule	Descrive l'azione che deve essere eseguita quando il certificato viene rimosso da Key Vault.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
IdentityType	Tipo di identità che crea/modifica le risorse
KeyVaultCertificateSourceParameters	Descrive i parametri per l'uso del certificato KeyVault di un utente per la protezione di un dominio personalizzato.
MinimumTlsVersion	Versione del protocollo TLS che verrà usata per Https
ProtocolType	Definisce il protocollo di estensione TLS usato per il recapito sicuro.
SystemData	Sola lettura dei dati di sistema
UpdateRule	Descrive l'azione che deve essere eseguita quando il certificato viene aggiornato in Key Vault.
UserManagedHttpsParameters	Definisce i parametri di origine del certificato usando il certificato dell'insieme di credenziali delle chiavi dell'utente per abilitare SSL.

CdnCertificateSourceParameters

Definisce i parametri per l'uso del certificato gestito della rete CDN per la protezione di un dominio personalizzato.

Nome	Tipo	Descrizione
certificateType	CertificateType	Tipo di certificato usato
typeName	string: CdnCertificateSourceParameters

CdnManagedHttpsParameters

Definisce i parametri di origine del certificato usando il certificato gestito della rete CDN per abilitare SSL.

Nome	Tipo	Descrizione
certificateSource	string: Cdn	Definisce l'origine del certificato SSL.
certificateSourceParameters	CdnCertificateSourceParameters	Definisce i parametri di origine del certificato usando il certificato gestito della rete CDN per abilitare SSL.
minimumTlsVersion	MinimumTlsVersion	Versione del protocollo TLS che verrà usata per Https
protocolType	ProtocolType	Definisce il protocollo di estensione TLS usato per il recapito sicuro.

CertificateType

Tipo di certificato usato

Nome	Tipo	Descrizione
Dedicated	string
Shared	string

CustomDomain

Mapping dei nomi di dominio descrittivi al nome host dell'endpoint fornito dal cliente a scopo di personalizzazione, ad esempio www.contoso.com.

Nome	Tipo	Descrizione
id	string	ID risorsa.
name	string	Nome risorsa.
properties.customHttpsParameters	CustomDomainHttpsParameters: CdnManagedHttpsParameters UserManagedHttpsParameters	Parametri del certificato per la protezione di HTTPS personalizzati
properties.customHttpsProvisioningState	CustomHttpsProvisioningState	Stato del provisioning del dominio personalizzato.
properties.customHttpsProvisioningSubstate	CustomHttpsProvisioningSubstate	Lo stato secondario di provisioning mostra lo stato di avanzamento dell'abilitazione/disabilitazione del processo HTTPS personalizzato passo dopo passo.
properties.hostName	string	Nome host del dominio personalizzato. Deve essere un nome di dominio.
properties.provisioningState	CustomHttpsProvisioningState	Stato del provisioning di Https personalizzato del dominio personalizzato.
properties.resourceState	CustomDomainResourceState	Stato della risorsa del dominio personalizzato.
properties.validationData	string	La convalida o i dati speciali possono essere necessari quando si distribuisce la rete CDN in alcune aree a causa di motivi di conformità locali. Ad esempio, il numero di licenza ICP di un dominio personalizzato è necessario per distribuire contenuto in Cina.
systemData	SystemData	Sola lettura dei dati di sistema
type	string	Tipo di risorsa.

CustomDomainResourceState

Stato della risorsa del dominio personalizzato.

Nome	Tipo	Descrizione
Active	string
Creating	string
Deleting	string

CustomHttpsProvisioningState

Stato del provisioning del dominio personalizzato.

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

CustomHttpsProvisioningSubstate

Lo stato secondario di provisioning mostra lo stato di avanzamento dell'abilitazione/disabilitazione del processo HTTPS personalizzato passo dopo passo.

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

DeleteRule

Descrive l'azione che deve essere eseguita quando il certificato viene rimosso da Key Vault.

Nome	Tipo	Descrizione
NoAction	string

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

IdentityType

Tipo di identità che crea/modifica le risorse

Nome	Tipo	Descrizione
application	string
key	string
managedIdentity	string
user	string

KeyVaultCertificateSourceParameters

Descrive i parametri per l'uso del certificato KeyVault di un utente per la protezione di un dominio personalizzato.

Nome	Tipo	Descrizione
deleteRule	DeleteRule	Descrive l'azione che deve essere eseguita quando il certificato viene rimosso da Key Vault.
resourceGroupName	string	Gruppo di risorse del Key Vault dell'utente contenente il certificato SSL
secretName	string	Nome di Key Vault Segreto (che rappresenta il certificato PFX completo) in Key Vault.
secretVersion	string	Versione (GUID) di Key Vault Segreto in Key Vault.
subscriptionId	string	ID sottoscrizione del Key Vault dell'utente contenente il certificato SSL
typeName	string: KeyVaultCertificateSourceParameters
updateRule	UpdateRule	Descrive l'azione che deve essere eseguita quando il certificato viene aggiornato in Key Vault.
vaultName	string	Nome del Key Vault dell'utente contenente il certificato SSL

MinimumTlsVersion

Versione del protocollo TLS che verrà usata per Https

Nome	Tipo	Descrizione
None	string
TLS10	string
TLS12	string

ProtocolType

Definisce il protocollo di estensione TLS usato per il recapito sicuro.

Nome	Tipo	Descrizione
IPBased	string
ServerNameIndication	string

SystemData

Sola lettura dei dati di sistema

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC)
createdBy	string	Identificatore per l'identità che ha creato la risorsa
createdByType	IdentityType	Tipo di identità che ha creato la risorsa
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identificatore per l'identità che ha modificato l'ultima risorsa
lastModifiedByType	IdentityType	Tipo di identità che ha modificato per l'ultima volta la risorsa

UpdateRule

Descrive l'azione che deve essere eseguita quando il certificato viene aggiornato in Key Vault.

Nome	Tipo	Descrizione
NoAction	string

UserManagedHttpsParameters

Definisce i parametri di origine del certificato usando il certificato dell'insieme di credenziali delle chiavi dell'utente per abilitare SSL.

Nome	Tipo	Descrizione
certificateSource	string: AzureKeyVault	Definisce l'origine del certificato SSL.
certificateSourceParameters	KeyVaultCertificateSourceParameters	Definisce i parametri di origine del certificato usando il certificato dell'insieme di credenziali delle chiavi dell'utente per abilitare SSL.
minimumTlsVersion	MinimumTlsVersion	Versione del protocollo TLS che verrà usata per Https
protocolType	ProtocolType	Definisce il protocollo di estensione TLS usato per il recapito sicuro.

Condividi tramite

Custom Domains - Enable Custom Https

Parametri dell'URI

Corpo della richiesta

CdnManagedHttpsParameters

UserManagedHttpsParameters

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

Esempio di richiesta

Risposta di esempio

CustomDomains_EnableCustomHttpsUsingYourOwnCertificate

Esempio di richiesta

Risposta di esempio

Definizioni

CdnCertificateSourceParameters

CdnManagedHttpsParameters

CertificateType

CustomDomain

CustomDomainResourceState

CustomHttpsProvisioningState

CustomHttpsProvisioningSubstate

DeleteRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdentityType

KeyVaultCertificateSourceParameters

MinimumTlsVersion

ProtocolType

SystemData

UpdateRule

UserManagedHttpsParameters

Risorse aggiuntive