Custom Domains - Enable Custom Https

Referenz

Dienst:: CDN

API-Version:: 2024-02-01

Aktivieren Sie die HTTPS-Übermittlung der benutzerdefinierten Domäne.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
customDomainName	path	True	string	Name der benutzerdefinierten Domäne innerhalb eines Endpunkts.
endpointName	path	True	string	Name des Endpunkts unter dem Profil, der global eindeutig ist.
profileName	path	True	string	Name des CDN-Profils, das innerhalb der Ressourcengruppe eindeutig ist.
resourceGroupName	path	True	string	Name der Ressourcengruppe innerhalb des Azure-Abonnements. RegEx-Muster: `^[-\w\._]+$`
subscriptionId	path	True	string	Die Azure-Abonnement-ID.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll. Aktuelle Version ist 2024-02-01.

Anforderungstext

Beim Anforderungstext kann es sich um eines der folgenden Elemente handeln:

Name	Beschreibung
CdnManagedHttpsParameters	Definiert die Zertifikatquellparameter mithilfe des verwalteten CDN-Zertifikats zum Aktivieren von SSL.
UserManagedHttpsParameters	Definiert die Zertifikatquellparameter mithilfe des Keyvaultzertifikats des Benutzers zum Aktivieren von SSL.

CdnManagedHttpsParameters

Definiert die Zertifikatquellparameter mithilfe des verwalteten CDN-Zertifikats zum Aktivieren von SSL.

Name	Erforderlich	Typ	Beschreibung
certificateSource	True	string: Cdn	Definiert die Quelle des SSL-Zertifikats.
certificateSourceParameters	True	CdnCertificateSourceParameters	Definiert die Zertifikatquellparameter mithilfe des verwalteten CDN-Zertifikats zum Aktivieren von SSL.
protocolType	True	ProtocolType	Definiert das TLS-Erweiterungsprotokoll, das für die sichere Übermittlung verwendet wird.
minimumTlsVersion		MinimumTlsVersion	TLS-Protokollversion, die für Https verwendet wird

UserManagedHttpsParameters

Definiert die Zertifikatquellparameter mithilfe des Keyvaultzertifikats des Benutzers zum Aktivieren von SSL.

Name	Erforderlich	Typ	Beschreibung
certificateSource	True	string: AzureKeyVault	Definiert die Quelle des SSL-Zertifikats.
certificateSourceParameters	True	KeyVaultCertificateSourceParameters	Definiert die Zertifikatquellparameter mithilfe des Keyvaultzertifikats des Benutzers zum Aktivieren von SSL.
protocolType	True	ProtocolType	Definiert das TLS-Erweiterungsprotokoll, das für die sichere Übermittlung verwendet wird.
minimumTlsVersion		MinimumTlsVersion	TLS-Protokollversion, die für Https verwendet wird

Antworten

Name	Typ	Beschreibung
200 OK	CustomDomain	OK. Die Anforderung war erfolgreich.
202 Accepted	CustomDomain	Akzeptiert, und der Vorgang wird asynchron abgeschlossen. Header location: string
Other Status Codes	ErrorResponse	CDN-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Name

Typ

Beschreibung

200 OK

CustomDomain

OK. Die Anforderung war erfolgreich.

202 Accepted

CustomDomain

Akzeptiert, und der Vorgang wird asynchron abgeschlossen.

Header

location: string

Other Status Codes

ErrorResponse

CDN-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

CustomDomains_EnableCustomHttpsUsingYourOwnCertificate

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

Beispielanforderung

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

Beispiel für eine Antwort

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

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

Beispielanforderung

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

Beispiel für eine Antwort

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

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

Definitionen

Name	Beschreibung
CdnCertificateSourceParameters	Definiert die Parameter für die Verwendung des verwalteten CDN-Zertifikats zum Schützen einer benutzerdefinierten Domäne.
CdnManagedHttpsParameters	Definiert die Zertifikatquellparameter mithilfe des verwalteten CDN-Zertifikats zum Aktivieren von SSL.
CertificateType	Typ des verwendeten Zertifikats
CustomDomain	Zuordnung des Anzeigedomänennamens zum Endpunkthostnamen, den der Kunde für Brandingzwecke bereitstellt, z. B. www.contoso.com.
CustomDomainResourceState	Ressourcen status der benutzerdefinierten Domäne.
CustomHttpsProvisioningState	Bereitstellung status der benutzerdefinierten Domäne.
CustomHttpsProvisioningSubstate	Der Bereitstellungsunterzustand zeigt den Fortschritt des benutzerdefinierten HTTPS-Aktivierungs-/Deaktivierungsprozesses Schritt für Schritt an.
DeleteRule	Beschreibt die Aktion, die ausgeführt werden muss, wenn das Zertifikat aus Key Vault entfernt wird.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
IdentityType	Der Identitätstyp, der Ressourcen erstellt/ändert
KeyVaultCertificateSourceParameters	Beschreibt die Parameter für die Verwendung des KeyVault-Zertifikats eines Benutzers zum Schützen einer benutzerdefinierten Domäne.
MinimumTlsVersion	TLS-Protokollversion, die für Https verwendet wird
ProtocolType	Definiert das TLS-Erweiterungsprotokoll, das für die sichere Übermittlung verwendet wird.
SystemData	Schreibgeschützte Systemdaten
UpdateRule	Beschreibt, welche Maßnahmen ergriffen werden müssen, wenn das Zertifikat in Key Vault aktualisiert wird.
UserManagedHttpsParameters	Definiert die Zertifikatquellparameter mithilfe des Keyvaultzertifikats des Benutzers zum Aktivieren von SSL.

CdnCertificateSourceParameters

Definiert die Parameter für die Verwendung des verwalteten CDN-Zertifikats zum Schützen einer benutzerdefinierten Domäne.

Name	Typ	Beschreibung
certificateType	CertificateType	Typ des verwendeten Zertifikats
typeName	string: CdnCertificateSourceParameters

CdnManagedHttpsParameters

Definiert die Zertifikatquellparameter mithilfe des verwalteten CDN-Zertifikats zum Aktivieren von SSL.

Name	Typ	Beschreibung
certificateSource	string: Cdn	Definiert die Quelle des SSL-Zertifikats.
certificateSourceParameters	CdnCertificateSourceParameters	Definiert die Zertifikatquellparameter mithilfe des verwalteten CDN-Zertifikats zum Aktivieren von SSL.
minimumTlsVersion	MinimumTlsVersion	TLS-Protokollversion, die für Https verwendet wird
protocolType	ProtocolType	Definiert das TLS-Erweiterungsprotokoll, das für die sichere Übermittlung verwendet wird.

CertificateType

Typ des verwendeten Zertifikats

Name	Typ	Beschreibung
Dedicated	string
Shared	string

CustomDomain

Zuordnung des Anzeigedomänennamens zum Endpunkthostnamen, den der Kunde für Brandingzwecke bereitstellt, z. B. www.contoso.com.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
name	string	Name der Ressource.
properties.customHttpsParameters	CustomDomainHttpsParameters: CdnManagedHttpsParameters UserManagedHttpsParameters	Zertifikatparameter zum Schützen von benutzerdefiniertem HTTPS
properties.customHttpsProvisioningState	CustomHttpsProvisioningState	Bereitstellung status der benutzerdefinierten Domäne.
properties.customHttpsProvisioningSubstate	CustomHttpsProvisioningSubstate	Der Bereitstellungsunterzustand zeigt den Fortschritt des benutzerdefinierten HTTPS-Aktivierungs-/Deaktivierungsprozesses Schritt für Schritt an.
properties.hostName	string	Der Hostname der benutzerdefinierten Domäne. Dies muss ein Domänenname sein.
properties.provisioningState	CustomHttpsProvisioningState	Bereitstellung status von benutzerdefiniertem HTTPS der benutzerdefinierten Domäne.
properties.resourceState	CustomDomainResourceState	Ressourcen status der benutzerdefinierten Domäne.
properties.validationData	string	Bei der Bereitstellung von CDN in einigen Regionen können aufgrund lokaler Compliance-Gründe eine besondere Validierung oder Daten erforderlich sein. Beispielsweise ist die ICP-Lizenznummer einer benutzerdefinierten Domäne erforderlich, um Inhalte in China bereitzustellen.
systemData	SystemData	Schreibgeschützte Systemdaten
type	string	Der Ressourcentyp.

CustomDomainResourceState

Ressourcen status der benutzerdefinierten Domäne.

Name	Typ	Beschreibung
Active	string
Creating	string
Deleting	string

CustomHttpsProvisioningState

Bereitstellung status der benutzerdefinierten Domäne.

Name	Typ	Beschreibung
Disabled	string
Disabling	string
Enabled	string
Enabling	string
Failed	string

CustomHttpsProvisioningSubstate

Der Bereitstellungsunterzustand zeigt den Fortschritt des benutzerdefinierten HTTPS-Aktivierungs-/Deaktivierungsprozesses Schritt für Schritt an.

Name	Typ	Beschreibung
CertificateDeleted	string
CertificateDeployed	string
DeletingCertificate	string
DeployingCertificate	string
DomainControlValidationRequestApproved	string
DomainControlValidationRequestRejected	string
DomainControlValidationRequestTimedOut	string
IssuingCertificate	string
PendingDomainControlValidationREquestApproval	string
SubmittingDomainControlValidationRequest	string

DeleteRule

Beschreibt die Aktion, die ausgeführt werden muss, wenn das Zertifikat aus Key Vault entfernt wird.

Name	Typ	Beschreibung
NoAction	string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

IdentityType

Der Identitätstyp, der Ressourcen erstellt/ändert

Name	Typ	Beschreibung
application	string
key	string
managedIdentity	string
user	string

KeyVaultCertificateSourceParameters

Beschreibt die Parameter für die Verwendung des KeyVault-Zertifikats eines Benutzers zum Schützen einer benutzerdefinierten Domäne.

Name	Typ	Beschreibung
deleteRule	DeleteRule	Beschreibt die Aktion, die ausgeführt werden muss, wenn das Zertifikat aus Key Vault entfernt wird.
resourceGroupName	string	Ressourcengruppe der Key Vault des Benutzers, die das SSL-Zertifikat enthält
secretName	string	Der Name von Key Vault Geheimnis (für das vollständige PfX-Zertifikat) in Key Vault.
secretVersion	string	Die Version (GUID) von Key Vault Geheimnis in Key Vault.
subscriptionId	string	Abonnement-ID der Key Vault des Benutzers, die das SSL-Zertifikat enthält
typeName	string: KeyVaultCertificateSourceParameters
updateRule	UpdateRule	Beschreibt, welche Maßnahmen ergriffen werden müssen, wenn das Zertifikat in Key Vault aktualisiert wird.
vaultName	string	Der Name der Key Vault des Benutzers, die das SSL-Zertifikat enthält.

MinimumTlsVersion

TLS-Protokollversion, die für Https verwendet wird

Name	Typ	Beschreibung
None	string
TLS10	string
TLS12	string

ProtocolType

Definiert das TLS-Erweiterungsprotokoll, das für die sichere Übermittlung verwendet wird.

Name	Typ	Beschreibung
IPBased	string
ServerNameIndication	string

SystemData

Schreibgeschützte Systemdaten

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC)
createdBy	string	Ein Bezeichner für die Identität, die die Ressource erstellt hat.
createdByType	IdentityType	Der Identitätstyp, der die Ressource erstellt hat
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Ein Bezeichner für die Identität, die die Ressource zuletzt geändert hat
lastModifiedByType	IdentityType	Der Identitätstyp, der die Ressource zuletzt geändert hat

UpdateRule

Beschreibt, welche Maßnahmen ergriffen werden müssen, wenn das Zertifikat in Key Vault aktualisiert wird.

Name	Typ	Beschreibung
NoAction	string

UserManagedHttpsParameters

Definiert die Zertifikatquellparameter mithilfe des Keyvaultzertifikats des Benutzers zum Aktivieren von SSL.

Name	Typ	Beschreibung
certificateSource	string: AzureKeyVault	Definiert die Quelle des SSL-Zertifikats.
certificateSourceParameters	KeyVaultCertificateSourceParameters	Definiert die Zertifikatquellparameter mithilfe des Keyvaultzertifikats des Benutzers zum Aktivieren von SSL.
minimumTlsVersion	MinimumTlsVersion	TLS-Protokollversion, die für Https verwendet wird
protocolType	ProtocolType	Definiert das TLS-Erweiterungsprotokoll, das für die sichere Übermittlung verwendet wird.

Freigeben über

Custom Domains - Enable Custom Https

URI-Parameter

Anforderungstext

CdnManagedHttpsParameters

UserManagedHttpsParameters

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

Beispielanforderung

Beispiel für eine Antwort

CustomDomains_EnableCustomHttpsUsingYourOwnCertificate

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CdnCertificateSourceParameters

CdnManagedHttpsParameters

CertificateType

CustomDomain

CustomDomainResourceState

CustomHttpsProvisioningState

CustomHttpsProvisioningSubstate

DeleteRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdentityType

KeyVaultCertificateSourceParameters

MinimumTlsVersion

ProtocolType

SystemData

UpdateRule

UserManagedHttpsParameters

Zusätzliche Ressourcen