Custom Domains - Enable Custom Https

Usługa:

CDN

Wersja interfejsu API:

2024-02-01

Włącz dostarczanie https domeny niestandardowej.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
customDomainName	path	True	string	Nazwa domeny niestandardowej w punkcie końcowym.
endpointName	path	True	string	Nazwa punktu końcowego w profilu, który jest unikatowy globalnie.
profileName	path	True	string	Nazwa profilu usługi CDN, który jest unikatowy w grupie zasobów.
resourceGroupName	path	True	string	Nazwa grupy zasobów w ramach subskrypcji platformy Azure. Wzorzec wyrażenia regularnego: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta. Bieżąca wersja to 2024-02-01.

Treść żądania

Treść żądania może być jedną z następujących:

Nazwa	Opis
CdnManagedHttpsParameters	Definiuje parametry źródła certyfikatu przy użyciu certyfikatu zarządzanego usługi CDN na potrzeby włączania protokołu SSL.
UserManagedHttpsParameters	Definiuje parametry źródła certyfikatu przy użyciu certyfikatu magazynu kluczy użytkownika na potrzeby włączania protokołu SSL.

CdnManagedHttpsParameters

Definiuje parametry źródła certyfikatu przy użyciu certyfikatu zarządzanego usługi CDN na potrzeby włączania protokołu SSL.

Nazwa	Wymagane	Typ	Opis
certificateSource	True	string: Cdn	Definiuje źródło certyfikatu SSL.
certificateSourceParameters	True	CdnCertificateSourceParameters	Definiuje parametry źródła certyfikatu przy użyciu certyfikatu zarządzanego usługi CDN na potrzeby włączania protokołu SSL.
protocolType	True	ProtocolType	Definiuje protokół rozszerzenia TLS używany do bezpiecznego dostarczania.
minimumTlsVersion		MinimumTlsVersion	Wersja protokołu TLS, która będzie używana dla protokołu Https

UserManagedHttpsParameters

Definiuje parametry źródła certyfikatu przy użyciu certyfikatu magazynu kluczy użytkownika na potrzeby włączania protokołu SSL.

Nazwa	Wymagane	Typ	Opis
certificateSource	True	string: AzureKeyVault	Definiuje źródło certyfikatu SSL.
certificateSourceParameters	True	KeyVaultCertificateSourceParameters	Definiuje parametry źródła certyfikatu przy użyciu certyfikatu magazynu kluczy użytkownika na potrzeby włączania protokołu SSL.
protocolType	True	ProtocolType	Definiuje protokół rozszerzenia TLS używany do bezpiecznego dostarczania.
minimumTlsVersion		MinimumTlsVersion	Wersja protokołu TLS, która będzie używana dla protokołu Https

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CustomDomain	OK. Żądanie zakończyło się pomyślnie.
202 Accepted	CustomDomain	Zaakceptowane i operacja zostanie ukończona asynchronicznie. Nagłówki location: string
Other Status Codes	ErrorResponse	Odpowiedź z błędem usługi CDN opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

CustomDomains_EnableCustomHttpsUsingYourOwnCertificate

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Kod stanu:

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Kod stanu:

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

Definicje

Nazwa	Opis
CdnCertificateSourceParameters	Definiuje parametry używania certyfikatu zarządzanego usługi CDN do zabezpieczania domeny niestandardowej.
CdnManagedHttpsParameters	Definiuje parametry źródła certyfikatu przy użyciu certyfikatu zarządzanego usługi CDN na potrzeby włączania protokołu SSL.
CertificateType	Typ używanego certyfikatu
CustomDomain	Przyjazne mapowanie nazwy domeny na nazwę hosta punktu końcowego, którą klient udostępnia do celów znakowania, np. www.contoso.com.
CustomDomainResourceState	Stan zasobu domeny niestandardowej.
CustomHttpsProvisioningState	Stan aprowizacji domeny niestandardowej.
CustomHttpsProvisioningSubstate	Podstan aprowizacji pokazuje postęp niestandardowego włączania/wyłączania procesu HTTPS krok po kroku.
DeleteRule	Opisuje działanie, które należy podjąć po usunięciu certyfikatu z Key Vault.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
IdentityType	Typ tożsamości, która tworzy/modyfikuje zasoby
KeyVaultCertificateSourceParameters	Opisuje parametry używania certyfikatu keyVault użytkownika do zabezpieczania domeny niestandardowej.
MinimumTlsVersion	Wersja protokołu TLS, która będzie używana dla protokołu Https
ProtocolType	Definiuje protokół rozszerzenia TLS używany do bezpiecznego dostarczania.
SystemData	Dane systemowe tylko do odczytu
UpdateRule	Opisuje działanie, które należy podjąć podczas aktualizacji certyfikatu w Key Vault.
UserManagedHttpsParameters	Definiuje parametry źródła certyfikatu przy użyciu certyfikatu magazynu kluczy użytkownika na potrzeby włączania protokołu SSL.

CdnCertificateSourceParameters

Definiuje parametry używania certyfikatu zarządzanego usługi CDN do zabezpieczania domeny niestandardowej.

Nazwa	Typ	Opis
certificateType	CertificateType	Typ używanego certyfikatu
typeName	string: CdnCertificateSourceParameters

CdnManagedHttpsParameters

Definiuje parametry źródła certyfikatu przy użyciu certyfikatu zarządzanego usługi CDN na potrzeby włączania protokołu SSL.

Nazwa	Typ	Opis
certificateSource	string: Cdn	Definiuje źródło certyfikatu SSL.
certificateSourceParameters	CdnCertificateSourceParameters	Definiuje parametry źródła certyfikatu przy użyciu certyfikatu zarządzanego usługi CDN na potrzeby włączania protokołu SSL.
minimumTlsVersion	MinimumTlsVersion	Wersja protokołu TLS, która będzie używana dla protokołu Https
protocolType	ProtocolType	Definiuje protokół rozszerzenia TLS używany do bezpiecznego dostarczania.

CertificateType

Typ używanego certyfikatu

Nazwa	Typ	Opis
Dedicated	string
Shared	string

CustomDomain

Przyjazne mapowanie nazwy domeny na nazwę hosta punktu końcowego, którą klient udostępnia do celów znakowania, np. www.contoso.com.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.customHttpsParameters	CustomDomainHttpsParameters: CdnManagedHttpsParameters UserManagedHttpsParameters	Parametry certyfikatu do zabezpieczania niestandardowego protokołu HTTPS
properties.customHttpsProvisioningState	CustomHttpsProvisioningState	Stan aprowizacji domeny niestandardowej.
properties.customHttpsProvisioningSubstate	CustomHttpsProvisioningSubstate	Podstan aprowizacji pokazuje postęp niestandardowego włączania/wyłączania procesu HTTPS krok po kroku.
properties.hostName	string	Nazwa hosta domeny niestandardowej. Musi być nazwą domeny.
properties.provisioningState	CustomHttpsProvisioningState	Stan aprowizacji niestandardowej https domeny niestandardowej.
properties.resourceState	CustomDomainResourceState	Stan zasobu domeny niestandardowej.
properties.validationData	string	W przypadku dostarczania usługi CDN do niektórych regionów ze względu na lokalną zgodność może być wymagana specjalna walidacja lub dane. Na przykład numer licencji ICP domeny niestandardowej jest wymagany do dostarczania zawartości w Chinach.
systemData	SystemData	Dane systemowe tylko do odczytu
type	string	Typ zasobu.

CustomDomainResourceState

Stan zasobu domeny niestandardowej.

Nazwa	Typ	Opis
Active	string
Creating	string
Deleting	string

CustomHttpsProvisioningState

Stan aprowizacji domeny niestandardowej.

Nazwa	Typ	Opis
Disabled	string
Disabling	string
Enabled	string
Enabling	string
Failed	string

CustomHttpsProvisioningSubstate

Podstan aprowizacji pokazuje postęp niestandardowego włączania/wyłączania procesu HTTPS krok po kroku.

Nazwa	Typ	Opis
CertificateDeleted	string
CertificateDeployed	string
DeletingCertificate	string
DeployingCertificate	string
DomainControlValidationRequestApproved	string
DomainControlValidationRequestRejected	string
DomainControlValidationRequestTimedOut	string
IssuingCertificate	string
PendingDomainControlValidationREquestApproval	string
SubmittingDomainControlValidationRequest	string

DeleteRule

Opisuje działanie, które należy podjąć po usunięciu certyfikatu z Key Vault.

Nazwa	Typ	Opis
NoAction	string

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt error.

IdentityType

Typ tożsamości, która tworzy/modyfikuje zasoby

Nazwa	Typ	Opis
application	string
key	string
managedIdentity	string
user	string

KeyVaultCertificateSourceParameters

Opisuje parametry używania certyfikatu keyVault użytkownika do zabezpieczania domeny niestandardowej.

Nazwa	Typ	Opis
deleteRule	DeleteRule	Opisuje działanie, które należy podjąć po usunięciu certyfikatu z Key Vault.
resourceGroupName	string	Grupa zasobów Key Vault użytkownika zawierająca certyfikat SSL
secretName	string	Nazwa wpisu tajnego Key Vault (reprezentująca pełny certyfikat PFX) w Key Vault.
secretVersion	string	Wersja (GUID) wpisu tajnego Key Vault w Key Vault.
subscriptionId	string	Identyfikator subskrypcji Key Vault użytkownika zawierający certyfikat SSL
typeName	string: KeyVaultCertificateSourceParameters
updateRule	UpdateRule	Opisuje działanie, które należy podjąć podczas aktualizacji certyfikatu w Key Vault.
vaultName	string	Nazwa Key Vault użytkownika zawierająca certyfikat SSL

MinimumTlsVersion

Wersja protokołu TLS, która będzie używana dla protokołu Https

Nazwa	Typ	Opis
None	string
TLS10	string
TLS12	string

ProtocolType

Definiuje protokół rozszerzenia TLS używany do bezpiecznego dostarczania.

Nazwa	Typ	Opis
IPBased	string
ServerNameIndication	string

SystemData

Dane systemowe tylko do odczytu

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC)
createdBy	string	Identyfikator tożsamości, która utworzyła zasób
createdByType	IdentityType	Typ tożsamości, która utworzyła zasób
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Identyfikator tożsamości, która ostatnio zmodyfikowała zasób
lastModifiedByType	IdentityType	Typ tożsamości, która ostatnio zmodyfikowała zasób

UpdateRule

Opisuje działanie, które należy podjąć podczas aktualizacji certyfikatu w Key Vault.

Nazwa	Typ	Opis
NoAction	string

UserManagedHttpsParameters

Definiuje parametry źródła certyfikatu przy użyciu certyfikatu magazynu kluczy użytkownika na potrzeby włączania protokołu SSL.

Nazwa	Typ	Opis
certificateSource	string: AzureKeyVault	Definiuje źródło certyfikatu SSL.
certificateSourceParameters	KeyVaultCertificateSourceParameters	Definiuje parametry źródła certyfikatu przy użyciu certyfikatu magazynu kluczy użytkownika na potrzeby włączania protokołu SSL.
minimumTlsVersion	MinimumTlsVersion	Wersja protokołu TLS, która będzie używana dla protokołu Https
protocolType	ProtocolType	Definiuje protokół rozszerzenia TLS używany do bezpiecznego dostarczania.