Custom Domains - Enable Custom Https

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.

Regex pattern: ^[-\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.

Headers

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.

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

Scopes

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

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

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 enum:

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:

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 enum:

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.