Custom Domains - Enable Custom Https

Referensi

Service:: CDN

API Version:: 2021-06-01

Aktifkan pengiriman https domain kustom.

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

Parameter URI

Name	In	Required	Type	Description
customDomainName	path	True	string	Nama domain kustom dalam titik akhir.
endpointName	path	True	string	Nama titik akhir di bawah profil yang unik secara global.
profileName	path	True	string	Nama profil CDN yang unik dalam grup sumber daya.
resourceGroupName	path	True	string	Nama grup Sumber Daya dalam langganan Azure. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	ID Langganan Azure.
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan klien. Versi saat ini adalah 2021-06-01.

Isi Permintaan

Isi permintaan dapat berupa salah satu hal berikut:

Name	Description
CdnManagedHttpsParameters	Menentukan parameter sumber sertifikat menggunakan sertifikat terkelola CDN untuk mengaktifkan SSL.
UserManagedHttpsParameters	Menentukan parameter sumber sertifikat menggunakan sertifikat keyvault pengguna untuk mengaktifkan SSL.

CdnManagedHttpsParameters

Menentukan parameter sumber sertifikat menggunakan sertifikat terkelola CDN untuk mengaktifkan SSL.

Name	Required	Type	Description
certificateSource	True	string: Cdn	Menentukan sumber sertifikat SSL.
certificateSourceParameters	True	CdnCertificateSourceParameters	Menentukan parameter sumber sertifikat menggunakan sertifikat terkelola CDN untuk mengaktifkan SSL.
protocolType	True	ProtocolType	Menentukan protokol ekstensi TLS yang digunakan untuk pengiriman yang aman.
minimumTlsVersion		MinimumTlsVersion	Versi protokol TLS yang akan digunakan untuk Https

UserManagedHttpsParameters

Menentukan parameter sumber sertifikat menggunakan sertifikat keyvault pengguna untuk mengaktifkan SSL.

Name	Required	Type	Description
certificateSource	True	string: AzureKeyVault	Menentukan sumber sertifikat SSL.
certificateSourceParameters	True	KeyVaultCertificateSourceParameters	Menentukan parameter sumber sertifikat menggunakan sertifikat keyvault pengguna untuk mengaktifkan SSL.
protocolType	True	ProtocolType	Menentukan protokol ekstensi TLS yang digunakan untuk pengiriman yang aman.
minimumTlsVersion		MinimumTlsVersion	Versi protokol TLS yang akan digunakan untuk Https

Respons

Name	Type	Description
200 OK	CustomDomain	OK. Permintaan telah berhasil.
202 Accepted	CustomDomain	Diterima dan operasi akan selesai secara asinkron.
Other Status Codes	ErrorResponse	CDN respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

CustomDomains_EnableCustomHttpsUsingYourOwnCertificate

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

Sample Request

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

import com.azure.core.util.Context;

/** Samples for CustomDomains EnableCustomHttps. */
public final class Main {
    /*
     * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2021-06-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()
            .enableCustomHttpsWithResponse("RG", "profile1", "endpoint1", "www-someDomain-net", null, Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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/2021-06-01/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json
 */
async function customDomainsEnableCustomHttpsUsingCdnManagedCertificate() {
  const subscriptionId = "subid";
  const resourceGroupName = "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.enableCustomHttps(
    resourceGroupName,
    profileName,
    endpointName,
    customDomainName
  );
  console.log(result);
}

customDomainsEnableCustomHttpsUsingCdnManagedCertificate().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 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"
  }
}

Status code:: 202

azure-asyncoperation: https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2021-06-01

Response Body

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

Sample Request

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

import com.azure.core.util.Context;

/** Samples for CustomDomains EnableCustomHttps. */
public final class Main {
    /*
     * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2021-06-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()
            .enableCustomHttpsWithResponse("RG", "profile1", "endpoint1", "www-someDomain-net", null, Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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/2021-06-01/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json
 */
async function customDomainsEnableCustomHttpsUsingYourOwnCertificate() {
  const subscriptionId = "subid";
  const resourceGroupName = "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.enableCustomHttps(
    resourceGroupName,
    profileName,
    endpointName,
    customDomainName
  );
  console.log(result);
}

customDomainsEnableCustomHttpsUsingYourOwnCertificate().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 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"
  }
}

Status code:: 202

azure-asyncoperation: https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2021-06-01

Response Body

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

Definisi

CdnCertificateSourceParameters	Menentukan parameter untuk menggunakan sertifikat terkelola CDN untuk mengamankan domain kustom.
CdnManagedHttpsParameters	Menentukan parameter sumber sertifikat menggunakan sertifikat terkelola CDN untuk mengaktifkan SSL.
CertificateType	Jenis sertifikat yang digunakan
CustomDomain	Pemetaan nama domain yang mudah diingat ke nama host titik akhir yang disediakan pelanggan untuk tujuan branding, misalnya www.contoso.com.
CustomDomainResourceState	Status sumber daya domain kustom.
CustomHttpsProvisioningState	Status provisi domain kustom.
CustomHttpsProvisioningSubstate	Substate provisi menunjukkan kemajuan HTTPS kustom yang mengaktifkan/menonaktifkan proses langkah demi langkah.
DeleteRule	Menjelaskan tindakan yang harus diambil ketika sertifikat dihapus dari Key Vault.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
IdentityType	Jenis identitas yang membuat/memodifikasi sumber daya
KeyVaultCertificateSourceParameters	Menjelaskan parameter untuk menggunakan sertifikat KeyVault pengguna untuk mengamankan domain kustom.
MinimumTlsVersion	Versi protokol TLS yang akan digunakan untuk Https
ProtocolType	Menentukan protokol ekstensi TLS yang digunakan untuk pengiriman yang aman.
SystemData	Membaca hanya data sistem
UpdateRule	Menjelaskan tindakan yang harus diambil ketika sertifikat diperbarui dalam Key Vault.
UserManagedHttpsParameters	Menentukan parameter sumber sertifikat menggunakan sertifikat keyvault pengguna untuk mengaktifkan SSL.

CdnCertificateSourceParameters

Menentukan parameter untuk menggunakan sertifikat terkelola CDN untuk mengamankan domain kustom.

Name	Type	Description
certificateType	CertificateType	Jenis sertifikat yang digunakan
typeName	enum: CdnCertificateSourceParameters

CdnManagedHttpsParameters

Menentukan parameter sumber sertifikat menggunakan sertifikat terkelola CDN untuk mengaktifkan SSL.

Name	Type	Description
certificateSource	string: Cdn	Menentukan sumber sertifikat SSL.
certificateSourceParameters	CdnCertificateSourceParameters	Menentukan parameter sumber sertifikat menggunakan sertifikat terkelola CDN untuk mengaktifkan SSL.
minimumTlsVersion	MinimumTlsVersion	Versi protokol TLS yang akan digunakan untuk Https
protocolType	ProtocolType	Menentukan protokol ekstensi TLS yang digunakan untuk pengiriman yang aman.

CertificateType

Jenis sertifikat yang digunakan

Name	Type	Description
Dedicated	string
Shared	string

CustomDomain

Pemetaan nama domain yang mudah diingat ke nama host titik akhir yang disediakan pelanggan untuk tujuan branding, misalnya www.contoso.com.

Name	Type	Description
id	string	ID Sumber Daya.
name	string	Nama sumber daya.
properties.customHttpsParameters	CustomDomainHttpsParameters: CdnManagedHttpsParameters UserManagedHttpsParameters	Parameter sertifikat untuk mengamankan HTTPS kustom
properties.customHttpsProvisioningState	CustomHttpsProvisioningState	Status provisi domain kustom.
properties.customHttpsProvisioningSubstate	CustomHttpsProvisioningSubstate	Substate provisi menunjukkan kemajuan HTTPS kustom yang mengaktifkan/menonaktifkan proses langkah demi langkah.
properties.hostName	string	Nama host domain kustom. Harus berupa nama domain.
properties.provisioningState	CustomHttpsProvisioningState	Status provisi Https Kustom domain kustom.
properties.resourceState	CustomDomainResourceState	Status sumber daya domain kustom.
properties.validationData	string	Validasi atau data khusus mungkin diperlukan saat mengirimkan CDN ke beberapa wilayah karena alasan kepatuhan lokal. Misalnya nomor lisensi ICP dari domain kustom diperlukan untuk mengirimkan konten di Tiongkok.
systemData	SystemData	Membaca hanya data sistem
type	string	Jenis sumber daya

CustomDomainResourceState

Status sumber daya domain kustom.

Name	Type	Description
Active	string
Creating	string
Deleting	string

CustomHttpsProvisioningState

Status provisi domain kustom.

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

CustomHttpsProvisioningSubstate

Substate provisi menunjukkan kemajuan HTTPS kustom yang mengaktifkan/menonaktifkan proses langkah demi langkah.

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

DeleteRule

Menjelaskan tindakan yang harus diambil ketika sertifikat dihapus dari Key Vault.

Name	Type	Description
NoAction	string

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Name	Type	Description
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan

Name	Type	Description
error	ErrorDetail	Objek kesalahan.

IdentityType

Jenis identitas yang membuat/memodifikasi sumber daya

Name	Type	Description
application	string
key	string
managedIdentity	string
user	string

KeyVaultCertificateSourceParameters

Menjelaskan parameter untuk menggunakan sertifikat KeyVault pengguna untuk mengamankan domain kustom.

Name	Type	Description
deleteRule	DeleteRule	Menjelaskan tindakan yang harus diambil ketika sertifikat dihapus dari Key Vault.
resourceGroupName	string	Grup sumber daya Key Vault pengguna yang berisi sertifikat SSL
secretName	string	Nama Rahasia Key Vault (mewakili sertifikat lengkap PFX) dalam Key Vault.
secretVersion	string	Versi (GUID) rahasia Key Vault di Key Vault.
subscriptionId	string	Id Langganan Key Vault pengguna yang berisi sertifikat SSL
typeName	enum: KeyVaultCertificateSourceParameters
updateRule	UpdateRule	Menjelaskan tindakan yang harus diambil ketika sertifikat diperbarui dalam Key Vault.
vaultName	string	Nama Key Vault pengguna yang berisi sertifikat SSL

MinimumTlsVersion

Versi protokol TLS yang akan digunakan untuk Https

Name	Type	Description
None	string
TLS10	string
TLS12	string

ProtocolType

Menentukan protokol ekstensi TLS yang digunakan untuk pengiriman yang aman.

Name	Type	Description
IPBased	string
ServerNameIndication	string

SystemData

Membaca hanya data sistem

Name	Type	Description
createdAt	string	Tanda waktu pembuatan sumber daya (UTC)
createdBy	string	Pengidentifikasi untuk identitas yang membuat sumber daya
createdByType	IdentityType	Jenis identitas yang membuat sumber daya
lastModifiedAt	string	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Pengidentifikasi untuk identitas yang terakhir memodifikasi sumber daya
lastModifiedByType	IdentityType	Jenis identitas yang terakhir mengubah sumber daya

UpdateRule

Menjelaskan tindakan yang harus diambil ketika sertifikat diperbarui dalam Key Vault.

Name	Type	Description
NoAction	string

UserManagedHttpsParameters

Menentukan parameter sumber sertifikat menggunakan sertifikat keyvault pengguna untuk mengaktifkan SSL.

Name	Type	Description
certificateSource	string: AzureKeyVault	Menentukan sumber sertifikat SSL.
certificateSourceParameters	KeyVaultCertificateSourceParameters	Menentukan parameter sumber sertifikat menggunakan sertifikat keyvault pengguna untuk mengaktifkan SSL.
minimumTlsVersion	MinimumTlsVersion	Versi protokol TLS yang akan digunakan untuk Https
protocolType	ProtocolType	Menentukan protokol ekstensi TLS yang digunakan untuk pengiriman yang aman.