Share via


Custom Domains - Enable Custom Https

Özel etki alanının https teslimini etkinleştirin.

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 Parametreleri

Name İçinde Gerekli Tür Description
customDomainName
path True

string

Uç nokta içindeki özel etki alanının adı.

endpointName
path True

string

Genel olarak benzersiz olan profilin altındaki uç noktanın adı.

profileName
path True

string

Kaynak grubu içinde benzersiz olan CDN profilinin adı.

resourceGroupName
path True

string

Azure aboneliğindeki Kaynak grubunun adı.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Azure Abonelik Kimliği.

api-version
query True

string

İstemci isteğiyle kullanılacak API'nin sürümü. Geçerli sürüm: 2024-02-01.

İstek Gövdesi

İstek gövdesi şunlardan biri olabilir:

Name Description
CdnManagedHttpsParameters

SSL'yi etkinleştirmek için CDN ile yönetilen sertifikayı kullanarak sertifika kaynak parametrelerini tanımlar.

UserManagedHttpsParameters

SSL'yi etkinleştirmek için kullanıcının keyvault sertifikasını kullanarak sertifika kaynak parametrelerini tanımlar.

CdnManagedHttpsParameters

SSL'yi etkinleştirmek için CDN ile yönetilen sertifikayı kullanarak sertifika kaynak parametrelerini tanımlar.

Name Gerekli Tür Description
certificateSource True string:

Cdn

SSL sertifikasının kaynağını tanımlar.

certificateSourceParameters True

CdnCertificateSourceParameters

SSL'yi etkinleştirmek için CDN ile yönetilen sertifikayı kullanarak sertifika kaynak parametrelerini tanımlar.

protocolType True

ProtocolType

Güvenli teslim için kullanılan TLS uzantısı protokollerini tanımlar.

minimumTlsVersion

MinimumTlsVersion

Https için kullanılacak TLS protokolü sürümü

UserManagedHttpsParameters

SSL'yi etkinleştirmek için kullanıcının keyvault sertifikasını kullanarak sertifika kaynak parametrelerini tanımlar.

Name Gerekli Tür Description
certificateSource True string:

AzureKeyVault

SSL sertifikasının kaynağını tanımlar.

certificateSourceParameters True

KeyVaultCertificateSourceParameters

SSL'yi etkinleştirmek için kullanıcının keyvault sertifikasını kullanarak sertifika kaynak parametrelerini tanımlar.

protocolType True

ProtocolType

Güvenli teslim için kullanılan TLS uzantısı protokollerini tanımlar.

minimumTlsVersion

MinimumTlsVersion

Https için kullanılacak TLS protokolü sürümü

Yanıtlar

Name Tür Description
200 OK

CustomDomain

Tamam ögesini seçin. İstek başarılı oldu.

202 Accepted

CustomDomain

Kabul edilir ve işlem zaman uyumsuz olarak tamamlanır.

Headers

location: string

Other Status Codes

ErrorResponse

İşlemin neden başarısız olduğunu açıklayan CDN hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

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=2024-02-01

Sample Response

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

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=2024-02-01

Sample Response

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

Tanımlar

Name Description
CdnCertificateSourceParameters

Özel etki alanının güvenliğini sağlamak için CDN yönetilen sertifikasını kullanmaya yönelik parametreleri tanımlar.

CdnManagedHttpsParameters

SSL'yi etkinleştirmek için CDN ile yönetilen sertifikayı kullanarak sertifika kaynak parametrelerini tanımlar.

CertificateType

Kullanılan sertifika türü

CustomDomain

Müşterinin markalama amacıyla sağladığı uç nokta ana bilgisayar adıyla (örneğin , www.contoso.com) kolay etki alanı adı eşlemesi.

CustomDomainResourceState

Özel etki alanının kaynak durumu.

CustomHttpsProvisioningState

Özel etki alanının sağlama durumu.

CustomHttpsProvisioningSubstate

Sağlama alt durumu, özel HTTPS etkinleştirme/devre dışı bırakma işleminin ilerleme durumunu adım adım gösterir.

DeleteRule

Sertifika Key Vault kaldırıldığında gerçekleştirilecek eylemi açıklar.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

ErrorDetail

Hata ayrıntısı.

ErrorResponse

Hata yanıtı

IdentityType

Kaynakları oluşturan/değiştiren kimlik türü

KeyVaultCertificateSourceParameters

Özel etki alanının güvenliğini sağlamak için kullanıcının KeyVault sertifikasını kullanma parametrelerini açıklar.

MinimumTlsVersion

Https için kullanılacak TLS protokolü sürümü

ProtocolType

Güvenli teslim için kullanılan TLS uzantısı protokollerini tanımlar.

SystemData

Salt okunur sistem verileri

UpdateRule

Sertifika Key Vault güncelleştirildiğinde gerçekleştirilecek eylemi açıklar.

UserManagedHttpsParameters

SSL'yi etkinleştirmek için kullanıcının keyvault sertifikasını kullanarak sertifika kaynak parametrelerini tanımlar.

CdnCertificateSourceParameters

Özel etki alanının güvenliğini sağlamak için CDN yönetilen sertifikasını kullanmaya yönelik parametreleri tanımlar.

Name Tür Description
certificateType

CertificateType

Kullanılan sertifika türü

typeName enum:

CdnCertificateSourceParameters

CdnManagedHttpsParameters

SSL'yi etkinleştirmek için CDN ile yönetilen sertifikayı kullanarak sertifika kaynak parametrelerini tanımlar.

Name Tür Description
certificateSource string:

Cdn

SSL sertifikasının kaynağını tanımlar.

certificateSourceParameters

CdnCertificateSourceParameters

SSL'yi etkinleştirmek için CDN ile yönetilen sertifikayı kullanarak sertifika kaynak parametrelerini tanımlar.

minimumTlsVersion

MinimumTlsVersion

Https için kullanılacak TLS protokolü sürümü

protocolType

ProtocolType

Güvenli teslim için kullanılan TLS uzantısı protokollerini tanımlar.

CertificateType

Kullanılan sertifika türü

Name Tür Description
Dedicated

string

Shared

string

CustomDomain

Müşterinin markalama amacıyla sağladığı uç nokta ana bilgisayar adıyla (örneğin , www.contoso.com) kolay etki alanı adı eşlemesi.

Name Tür Description
id

string

Kaynak Kimliği.

name

string

Kaynak adı.

properties.customHttpsParameters CustomDomainHttpsParameters:

Özel HTTPS güvenliğini sağlamak için sertifika parametreleri

properties.customHttpsProvisioningState

CustomHttpsProvisioningState

Özel etki alanının sağlama durumu.

properties.customHttpsProvisioningSubstate

CustomHttpsProvisioningSubstate

Sağlama alt durumu, özel HTTPS etkinleştirme/devre dışı bırakma işleminin ilerleme durumunu adım adım gösterir.

properties.hostName

string

Özel etki alanının ana bilgisayar adı. Etki alanı adı olmalıdır.

properties.provisioningState

CustomHttpsProvisioningState

Özel etki alanının Özel Https sağlama durumu.

properties.resourceState

CustomDomainResourceState

Özel etki alanının kaynak durumu.

properties.validationData

string

Yerel uyumluluk nedenleriyle bazı bölgelere CDN teslimi sırasında özel doğrulama veya veri gerekebilir. Örneğin, Çin'de içerik teslim etmek için özel bir etki alanının ICP lisans numarası gereklidir.

systemData

SystemData

Salt okunur sistem verileri

type

string

Kaynak türü.

CustomDomainResourceState

Özel etki alanının kaynak durumu.

Name Tür Description
Active

string

Creating

string

Deleting

string

CustomHttpsProvisioningState

Özel etki alanının sağlama durumu.

Name Tür Description
Disabled

string

Disabling

string

Enabled

string

Enabling

string

Failed

string

CustomHttpsProvisioningSubstate

Sağlama alt durumu, özel HTTPS etkinleştirme/devre dışı bırakma işleminin ilerleme durumunu adım adım gösterir.

Name Tür Description
CertificateDeleted

string

CertificateDeployed

string

DeletingCertificate

string

DeployingCertificate

string

DomainControlValidationRequestApproved

string

DomainControlValidationRequestRejected

string

DomainControlValidationRequestTimedOut

string

IssuingCertificate

string

PendingDomainControlValidationREquestApproval

string

SubmittingDomainControlValidationRequest

string

DeleteRule

Sertifika Key Vault kaldırıldığında gerçekleştirilecek eylemi açıklar.

Name Tür Description
NoAction

string

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name Tür Description
info

object

Ek bilgiler.

type

string

Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name Tür Description
additionalInfo

ErrorAdditionalInfo[]

Hata ek bilgileri.

code

string

Hata kodu.

details

ErrorDetail[]

Hata ayrıntıları.

message

string

Hata iletisi.

target

string

Hata hedefi.

ErrorResponse

Hata yanıtı

Name Tür Description
error

ErrorDetail

Hata nesnesi.

IdentityType

Kaynakları oluşturan/değiştiren kimlik türü

Name Tür Description
application

string

key

string

managedIdentity

string

user

string

KeyVaultCertificateSourceParameters

Özel etki alanının güvenliğini sağlamak için kullanıcının KeyVault sertifikasını kullanma parametrelerini açıklar.

Name Tür Description
deleteRule

DeleteRule

Sertifika Key Vault kaldırıldığında gerçekleştirilecek eylemi açıklar.

resourceGroupName

string

KULLANıCıNıN SSL sertifikasını içeren Key Vault kaynak grubu

secretName

string

Key Vault'da Key Vault Gizli Anahtarın (tam sertifika PFX'ini temsil eden) adı.

secretVersion

string

Key Vault'da Key Vault Gizli Dizisinin sürümü(GUID).

subscriptionId

string

SSL sertifikasını içeren kullanıcının Key Vault abonelik kimliği

typeName enum:

KeyVaultCertificateSourceParameters

updateRule

UpdateRule

Sertifika Key Vault güncelleştirildiğinde gerçekleştirilecek eylemi açıklar.

vaultName

string

SSL sertifikasını içeren kullanıcının Key Vault adı

MinimumTlsVersion

Https için kullanılacak TLS protokolü sürümü

Name Tür Description
None

string

TLS10

string

TLS12

string

ProtocolType

Güvenli teslim için kullanılan TLS uzantısı protokollerini tanımlar.

Name Tür Description
IPBased

string

ServerNameIndication

string

SystemData

Salt okunur sistem verileri

Name Tür Description
createdAt

string

Kaynak oluşturma zaman damgası (UTC)

createdBy

string

Kaynağı oluşturan kimliğin tanımlayıcısı

createdByType

IdentityType

Kaynağı oluşturan kimliğin türü

lastModifiedAt

string

Kaynağın son değişikliğinin zaman damgası (UTC)

lastModifiedBy

string

Kaynağı son değiştiren kimliğin tanımlayıcısı

lastModifiedByType

IdentityType

Kaynağı en son değiştiren kimliğin türü

UpdateRule

Sertifika Key Vault güncelleştirildiğinde gerçekleştirilecek eylemi açıklar.

Name Tür Description
NoAction

string

UserManagedHttpsParameters

SSL'yi etkinleştirmek için kullanıcının keyvault sertifikasını kullanarak sertifika kaynak parametrelerini tanımlar.

Name Tür Description
certificateSource string:

AzureKeyVault

SSL sertifikasının kaynağını tanımlar.

certificateSourceParameters

KeyVaultCertificateSourceParameters

SSL'yi etkinleştirmek için kullanıcının keyvault sertifikasını kullanarak sertifika kaynak parametrelerini tanımlar.

minimumTlsVersion

MinimumTlsVersion

Https için kullanılacak TLS protokolü sürümü

protocolType

ProtocolType

Güvenli teslim için kullanılan TLS uzantısı protokollerini tanımlar.