Custom Domains - Enable Custom Https

Service:

CDN

API-versie:

2024-02-01

Https-levering van het aangepaste domein inschakelen.

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

Name	In	Vereist	Type	Description
customDomainName	path	True	string	Naam van het aangepaste domein in een eindpunt.
endpointName	path	True	string	Naam van het eindpunt onder het profiel dat wereldwijd uniek is.
profileName	path	True	string	Naam van het CDN-profiel dat uniek is binnen de resourcegroep.
resourceGroupName	path	True	string	Naam van de resourcegroep binnen het Azure-abonnement. Regex-patroon: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Azure-abonnements-id.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag. Huidige versie is 2024-02-01.

Aanvraagbody

De aanvraagtekst kan een van de volgende zijn:

Name	Description
CdnManagedHttpsParameters	Definieert de certificaatbronparameters met behulp van cdn beheerd certificaat voor het inschakelen van SSL.
UserManagedHttpsParameters	Definieert de certificaatbronparameters met behulp van het sleutelkluiscertificaat van de gebruiker voor het inschakelen van SSL.

CdnManagedHttpsParameters

Definieert de certificaatbronparameters met behulp van cdn beheerd certificaat voor het inschakelen van SSL.

Name	Vereist	Type	Description
certificateSource	True	string: Cdn	Definieert de bron van het SSL-certificaat.
certificateSourceParameters	True	CdnCertificateSourceParameters	Definieert de certificaatbronparameters met behulp van cdn beheerd certificaat voor het inschakelen van SSL.
protocolType	True	ProtocolType	Definieert het TLS-extensieprotocol dat wordt gebruikt voor veilige levering.
minimumTlsVersion		MinimumTlsVersion	TLS-protocolversie die wordt gebruikt voor Https

UserManagedHttpsParameters

Definieert de certificaatbronparameters met behulp van het sleutelkluiscertificaat van de gebruiker voor het inschakelen van SSL.

Name	Vereist	Type	Description
certificateSource	True	string: AzureKeyVault	Definieert de bron van het SSL-certificaat.
certificateSourceParameters	True	KeyVaultCertificateSourceParameters	Definieert de certificaatbronparameters met behulp van het sleutelkluiscertificaat van de gebruiker voor het inschakelen van SSL.
protocolType	True	ProtocolType	Definieert het TLS-extensieprotocol dat wordt gebruikt voor veilige levering.
minimumTlsVersion		MinimumTlsVersion	TLS-protocolversie die wordt gebruikt voor Https

Antwoorden

Name	Type	Description
200 OK	CustomDomain	OK. De aanvraag is geslaagd.
202 Accepted	CustomDomain	Geaccepteerd en de bewerking wordt asynchroon voltooid. Kopteksten location: string
Other Status Codes	ErrorResponse	CDN-foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

CustomDomains_EnableCustomHttpsUsingYourOwnCertificate

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

Voorbeeldaanvraag

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customDomains/www-someDomain-net/enableCustomHttps?api-version=2024-02-01

Java

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

Python

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

Go

package armcdn_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cdn/armcdn/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json
func ExampleCustomDomainsClient_BeginEnableCustomHTTPS_customDomainsEnableCustomHttpsUsingCdnManagedCertificate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcdn.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewCustomDomainsClient().BeginEnableCustomHTTPS(ctx, "RG", "profile1", "endpoint1", "www-someDomain-net", &armcdn.CustomDomainsClientBeginEnableCustomHTTPSOptions{CustomDomainHTTPSParameters: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CustomDomain = armcdn.CustomDomain{
	// 	Name: to.Ptr("www-someDomain-net"),
	// 	Type: to.Ptr("Microsoft.Cdn/profiles/endpoints/customdomains"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net"),
	// 	Properties: &armcdn.CustomDomainProperties{
	// 		CustomHTTPSProvisioningState: to.Ptr(armcdn.CustomHTTPSProvisioningStateEnabled),
	// 		CustomHTTPSProvisioningSubstate: to.Ptr(armcdn.CustomHTTPSProvisioningSubstateCertificateDeployed),
	// 		HostName: to.Ptr("www.someDomain.net"),
	// 		ProvisioningState: to.Ptr(armcdn.CustomHTTPSProvisioningState("Succeeded")),
	// 		ResourceState: to.Ptr(armcdn.CustomDomainResourceStateActive),
	// 		ValidationData: to.Ptr("validationdata"),
	// 	},
	// }
}

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

JavaScript

const { CdnManagementClient } = require("@azure/arm-cdn");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Enable https delivery of the custom domain.
 *
 * @summary Enable https delivery of the custom domain.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json
 */
async function customDomainsEnableCustomHttpsUsingCdnManagedCertificate() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const endpointName = "endpoint1";
  const customDomainName = "www-someDomain-net";
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.customDomains.beginEnableCustomHttpsAndWait(
    resourceGroupName,
    profileName,
    endpointName,
    customDomainName,
  );
  console.log(result);
}

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

dotnet

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

Voorbeeldrespons

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

Voorbeeldaanvraag

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customDomains/www-someDomain-net/enableCustomHttps?api-version=2024-02-01

Java

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

Python

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

Go

package armcdn_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cdn/armcdn/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json
func ExampleCustomDomainsClient_BeginEnableCustomHTTPS_customDomainsEnableCustomHttpsUsingYourOwnCertificate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcdn.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewCustomDomainsClient().BeginEnableCustomHTTPS(ctx, "RG", "profile1", "endpoint1", "www-someDomain-net", &armcdn.CustomDomainsClientBeginEnableCustomHTTPSOptions{CustomDomainHTTPSParameters: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CustomDomain = armcdn.CustomDomain{
	// 	Name: to.Ptr("www-someDomain-net"),
	// 	Type: to.Ptr("Microsoft.Cdn/profiles/endpoints/customdomains"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net"),
	// 	Properties: &armcdn.CustomDomainProperties{
	// 		CustomHTTPSProvisioningState: to.Ptr(armcdn.CustomHTTPSProvisioningStateEnabled),
	// 		CustomHTTPSProvisioningSubstate: to.Ptr(armcdn.CustomHTTPSProvisioningSubstateCertificateDeployed),
	// 		HostName: to.Ptr("www.someDomain.net"),
	// 		ProvisioningState: to.Ptr(armcdn.CustomHTTPSProvisioningState("Succeeded")),
	// 		ResourceState: to.Ptr(armcdn.CustomDomainResourceStateActive),
	// 		ValidationData: to.Ptr("validationdata"),
	// 	},
	// }
}

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

JavaScript

const { CdnManagementClient } = require("@azure/arm-cdn");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Enable https delivery of the custom domain.
 *
 * @summary Enable https delivery of the custom domain.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json
 */
async function customDomainsEnableCustomHttpsUsingYourOwnCertificate() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const endpointName = "endpoint1";
  const customDomainName = "www-someDomain-net";
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.customDomains.beginEnableCustomHttpsAndWait(
    resourceGroupName,
    profileName,
    endpointName,
    customDomainName,
  );
  console.log(result);
}

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

dotnet

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

Voorbeeldrespons

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

Definities

Name	Description
CdnCertificateSourceParameters	Definieert de parameters voor het gebruik van cdn beheerd certificaat voor het beveiligen van aangepaste domein.
CdnManagedHttpsParameters	Definieert de certificaatbronparameters met behulp van cdn beheerd certificaat voor het inschakelen van SSL.
CertificateType	Type certificaat dat wordt gebruikt
CustomDomain	Beschrijvende domeinnaamtoewijzing aan de hostnaam van het eindpunt die de klant aanbiedt voor huisstijldoeleinden, bijvoorbeeld www.contoso.com.
CustomDomainResourceState	Resourcestatus van het aangepaste domein.
CustomHttpsProvisioningState	Inrichtingsstatus van het aangepaste domein.
CustomHttpsProvisioningSubstate	De substatus inrichten toont stap voor stap de voortgang van het proces voor het inschakelen/uitschakelen van aangepaste HTTPS.
DeleteRule	Beschrijft de actie die moet worden uitgevoerd wanneer het certificaat uit Key Vault wordt verwijderd.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
IdentityType	Het type identiteit dat resources maakt/wijzigt
KeyVaultCertificateSourceParameters	Beschrijft de parameters voor het gebruik van het KeyVault-certificaat van een gebruiker voor het beveiligen van een aangepast domein.
MinimumTlsVersion	TLS-protocolversie die wordt gebruikt voor Https
ProtocolType	Definieert het TLS-extensieprotocol dat wordt gebruikt voor veilige levering.
SystemData	Alleen-lezensysteemgegevens
UpdateRule	Beschrijft de actie die moet worden uitgevoerd wanneer het certificaat wordt bijgewerkt in Key Vault.
UserManagedHttpsParameters	Definieert de certificaatbronparameters met behulp van het sleutelkluiscertificaat van de gebruiker voor het inschakelen van SSL.

CdnCertificateSourceParameters

Definieert de parameters voor het gebruik van cdn beheerd certificaat voor het beveiligen van aangepaste domein.

Name	Type	Description
certificateType	CertificateType	Type certificaat dat wordt gebruikt
typeName	string: CdnCertificateSourceParameters

CdnManagedHttpsParameters

Definieert de certificaatbronparameters met behulp van cdn beheerd certificaat voor het inschakelen van SSL.

Name	Type	Description
certificateSource	string: Cdn	Definieert de bron van het SSL-certificaat.
certificateSourceParameters	CdnCertificateSourceParameters	Definieert de certificaatbronparameters met behulp van cdn beheerd certificaat voor het inschakelen van SSL.
minimumTlsVersion	MinimumTlsVersion	TLS-protocolversie die wordt gebruikt voor Https
protocolType	ProtocolType	Definieert het TLS-extensieprotocol dat wordt gebruikt voor veilige levering.

CertificateType

Type certificaat dat wordt gebruikt

Name	Type	Description
Dedicated	string
Shared	string

CustomDomain

Beschrijvende domeinnaamtoewijzing aan de hostnaam van het eindpunt die de klant aanbiedt voor huisstijldoeleinden, bijvoorbeeld www.contoso.com.

Name	Type	Description
id	string	Resource-id.
name	string	Resourcenaam.
properties.customHttpsParameters	CustomDomainHttpsParameters: CdnManagedHttpsParameters UserManagedHttpsParameters	Certificaatparameters voor het beveiligen van aangepaste HTTPS
properties.customHttpsProvisioningState	CustomHttpsProvisioningState	Inrichtingsstatus van het aangepaste domein.
properties.customHttpsProvisioningSubstate	CustomHttpsProvisioningSubstate	De substatus inrichten toont stap voor stap de voortgang van het proces voor het inschakelen/uitschakelen van aangepaste HTTPS.
properties.hostName	string	De hostnaam van het aangepaste domein. Moet een domeinnaam zijn.
properties.provisioningState	CustomHttpsProvisioningState	Inrichtingsstatus van Aangepaste HTTPS van het aangepaste domein.
properties.resourceState	CustomDomainResourceState	Resourcestatus van het aangepaste domein.
properties.validationData	string	Speciale validatie of gegevens kunnen vereist zijn bij het leveren van CDN aan sommige regio's vanwege lokale nalevingsredenen. Bijvoorbeeld: het ICP-licentienummer van een aangepast domein is vereist voor het leveren van inhoud in China.
systemData	SystemData	Alleen-lezensysteemgegevens
type	string	Resourcetype.

CustomDomainResourceState

Resourcestatus van het aangepaste domein.

Name	Type	Description
Active	string
Creating	string
Deleting	string

CustomHttpsProvisioningState

Inrichtingsstatus van het aangepaste domein.

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

CustomHttpsProvisioningSubstate

De substatus inrichten toont stap voor stap de voortgang van het proces voor het inschakelen/uitschakelen van aangepaste HTTPS.

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

DeleteRule

Beschrijft de actie die moet worden uitgevoerd wanneer het certificaat uit Key Vault wordt verwijderd.

Name	Type	Description
NoAction	string

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

IdentityType

Het type identiteit dat resources maakt/wijzigt

Name	Type	Description
application	string
key	string
managedIdentity	string
user	string

KeyVaultCertificateSourceParameters

Beschrijft de parameters voor het gebruik van het KeyVault-certificaat van een gebruiker voor het beveiligen van een aangepast domein.

Name	Type	Description
deleteRule	DeleteRule	Beschrijft de actie die moet worden uitgevoerd wanneer het certificaat uit Key Vault wordt verwijderd.
resourceGroupName	string	Resourcegroep van de Key Vault van de gebruiker die het SSL-certificaat bevat
secretName	string	De naam van Key Vault Secret (die het volledige PFX-certificaat vertegenwoordigt) in Key Vault.
secretVersion	string	De versie (GUID) van Key Vault Geheim in Key Vault.
subscriptionId	string	Abonnements-id van de Key Vault van de gebruiker die het SSL-certificaat bevat
typeName	string: KeyVaultCertificateSourceParameters
updateRule	UpdateRule	Beschrijft de actie die moet worden uitgevoerd wanneer het certificaat wordt bijgewerkt in Key Vault.
vaultName	string	De naam van de Key Vault van de gebruiker die het SSL-certificaat bevat

MinimumTlsVersion

TLS-protocolversie die wordt gebruikt voor Https

Name	Type	Description
None	string
TLS10	string
TLS12	string

ProtocolType

Definieert het TLS-extensieprotocol dat wordt gebruikt voor veilige levering.

Name	Type	Description
IPBased	string
ServerNameIndication	string

SystemData

Alleen-lezensysteemgegevens

Name	Type	Description
createdAt	string	Het tijdstempel van het maken van resources (UTC)
createdBy	string	Een id voor de identiteit die de resource heeft gemaakt
createdByType	IdentityType	Het type identiteit waarmee de resource is gemaakt
lastModifiedAt	string	Het tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	Een id voor de identiteit die de resource het laatst heeft gewijzigd
lastModifiedByType	IdentityType	Het type identiteit dat de resource het laatst heeft gewijzigd

UpdateRule

Beschrijft de actie die moet worden uitgevoerd wanneer het certificaat wordt bijgewerkt in Key Vault.

Name	Type	Description
NoAction	string

UserManagedHttpsParameters

Definieert de certificaatbronparameters met behulp van het sleutelkluiscertificaat van de gebruiker voor het inschakelen van SSL.

Name	Type	Description
certificateSource	string: AzureKeyVault	Definieert de bron van het SSL-certificaat.
certificateSourceParameters	KeyVaultCertificateSourceParameters	Definieert de certificaatbronparameters met behulp van het sleutelkluiscertificaat van de gebruiker voor het inschakelen van SSL.
minimumTlsVersion	MinimumTlsVersion	TLS-protocolversie die wordt gebruikt voor Https
protocolType	ProtocolType	Definieert het TLS-extensieprotocol dat wordt gebruikt voor veilige levering.