Custom Domains - Create

Referensi

Service:: CDN

API Version:: 2024-02-01

Membuat domain kustom baru dalam titik akhir.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
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 2024-02-01.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
properties.hostName	True	string	Nama host domain kustom. Harus berupa nama domain.

Respons

Nama	Jenis	Deskripsi
200 OK	CustomDomain	OK. Permintaan telah berhasil.
201 Created	CustomDomain	Dibuat. Permintaan telah dipenuhi dan domain kustom baru telah dibuat.
202 Accepted	CustomDomain	Diterima dan operasi akan selesai secara asinkron. Headers location: string
Other Status Codes	ErrorResponse	Respons kesalahan CDN yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

CustomDomains_Create

Sample Request

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

{
  "properties": {
    "hostName": "www.someDomain.net"
  }
}


import com.azure.resourcemanager.cdn.models.CustomDomainParameters;

/**
 * Samples for CustomDomains Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/CustomDomains_Create.json
     */
    /**
     * Sample code: CustomDomains_Create.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void customDomainsCreate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getCustomDomains().create("RG", "profile1", "endpoint1",
            "www-someDomain-net", new CustomDomainParameters().withHostname("www.someDomain.net"),
            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

package armcdn_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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_Create.json
func ExampleCustomDomainsClient_BeginCreate() {
	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().BeginCreate(ctx, "RG", "profile1", "endpoint1", "www-someDomain-net", armcdn.CustomDomainParameters{
		Properties: &armcdn.CustomDomainPropertiesParameters{
			HostName: to.Ptr("www.someDomain.net"),
		},
	}, 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.CustomHTTPSProvisioningStateEnabling),
	// 		CustomHTTPSProvisioningSubstate: to.Ptr(armcdn.CustomHTTPSProvisioningSubstatePendingDomainControlValidationREquestApproval),
	// 		HostName: to.Ptr("www.someDomain.net"),
	// 		ProvisioningState: to.Ptr(armcdn.CustomHTTPSProvisioningState("Succeeded")),
	// 		ResourceState: to.Ptr(armcdn.CustomDomainResourceStateActive),
	// 	},
	// }
}

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 Creates a new custom domain within an endpoint.
 *
 * @summary Creates a new custom domain within an endpoint.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/CustomDomains_Create.json
 */
async function customDomainsCreate() {
  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 customDomainProperties = {
    hostName: "www.someDomain.net",
  };
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.customDomains.beginCreateAndWait(
    resourceGroupName,
    profileName,
    endpointName,
    customDomainName,
    customDomainProperties,
  );
  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

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": "Enabling",
    "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval",
    "validationData": null
  }
}

Status code:: 201

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

Status code:: 202

azure-asyncoperation: https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-02-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": null
  }
}

Definisi

Nama	Deskripsi
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 ramah ke nama host titik akhir yang disediakan pelanggan untuk tujuan branding, misalnya www.contoso.com.
CustomDomainParameters	Objek JSON customDomain yang diperlukan untuk pembuatan atau pembaruan domain kustom.
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.

Nama	Jenis	Deskripsi
certificateType	CertificateType	Jenis sertifikat yang digunakan
typeName	enum: CdnCertificateSourceParameters

CdnManagedHttpsParameters

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

Nama	Jenis	Deskripsi
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

Nama	Jenis	Deskripsi
Dedicated	string
Shared	string

CustomDomain

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

Nama	Jenis	Deskripsi
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

CustomDomainParameters

Objek JSON customDomain yang diperlukan untuk pembuatan atau pembaruan domain kustom.

Nama	Jenis	Deskripsi
properties.hostName	string	Nama host domain kustom. Harus berupa nama domain.

CustomDomainResourceState

Status sumber daya domain kustom.

Nama	Jenis	Deskripsi
Active	string
Creating	string
Deleting	string

CustomHttpsProvisioningState

Status provisi domain kustom.

Nama	Jenis	Deskripsi
Disabled	string
Disabling	string
Enabled	string
Enabling	string
Failed	string

CustomHttpsProvisioningSubstate

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

Nama	Jenis	Deskripsi
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.

Nama	Jenis	Deskripsi
NoAction	string

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

IdentityType

Jenis identitas yang membuat/memodifikasi sumber daya

Nama	Jenis	Deskripsi
application	string
key	string
managedIdentity	string
user	string

KeyVaultCertificateSourceParameters

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

Nama	Jenis	Deskripsi
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

Nama	Jenis	Deskripsi
None	string
TLS10	string
TLS12	string

ProtocolType

Menentukan protokol ekstensi TLS yang digunakan untuk pengiriman yang aman.

Nama	Jenis	Deskripsi
IPBased	string
ServerNameIndication	string

SystemData

Membaca hanya data sistem

Nama	Jenis	Deskripsi
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.

Nama	Jenis	Deskripsi
NoAction	string

UserManagedHttpsParameters

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

Nama	Jenis	Deskripsi
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.

Share via

Custom Domains - Create

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Scopes

Contoh

CustomDomains_Create

Sample Request

Sample Response

Definisi

CdnCertificateSourceParameters

CdnManagedHttpsParameters

CertificateType

CustomDomain

CustomDomainParameters

CustomDomainResourceState

CustomHttpsProvisioningState

CustomHttpsProvisioningSubstate

DeleteRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdentityType

KeyVaultCertificateSourceParameters

MinimumTlsVersion

ProtocolType

SystemData

UpdateRule

UserManagedHttpsParameters

Sumber Daya Tambahan: