Condividi tramite


Custom Domains - Enable Custom Https

Abilitare il recapito https del dominio personalizzato.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
customDomainName
path True

string

Nome del dominio personalizzato all'interno di un endpoint.

endpointName
path True

string

Nome dell'endpoint nel profilo univoco a livello globale.

profileName
path True

string

Nome del profilo della rete CDN univoco all'interno del gruppo di risorse.

resourceGroupName
path True

string

Nome del gruppo di risorse all'interno della sottoscrizione di Azure.

Criterio di espressione regolare: ^[-\w\._\(\)]+$

subscriptionId
path True

string

ID sottoscrizione di Azure.

api-version
query True

string

Versione dell'API da usare con la richiesta client. La versione corrente è 2024-02-01.

Corpo della richiesta

Il corpo della richiesta può essere uno dei seguenti:

Nome Descrizione
CdnManagedHttpsParameters

Definisce i parametri di origine del certificato usando il certificato gestito della rete CDN per abilitare SSL.

UserManagedHttpsParameters

Definisce i parametri di origine del certificato usando il certificato dell'insieme di credenziali delle chiavi dell'utente per abilitare SSL.

CdnManagedHttpsParameters

Definisce i parametri di origine del certificato usando il certificato gestito della rete CDN per abilitare SSL.

Nome Necessario Tipo Descrizione
certificateSource True string:

Cdn

Definisce l'origine del certificato SSL.

certificateSourceParameters True

CdnCertificateSourceParameters

Definisce i parametri di origine del certificato usando il certificato gestito della rete CDN per abilitare SSL.

protocolType True

ProtocolType

Definisce il protocollo di estensione TLS usato per il recapito sicuro.

minimumTlsVersion

MinimumTlsVersion

Versione del protocollo TLS che verrà usata per Https

UserManagedHttpsParameters

Definisce i parametri di origine del certificato usando il certificato dell'insieme di credenziali delle chiavi dell'utente per abilitare SSL.

Nome Necessario Tipo Descrizione
certificateSource True string:

AzureKeyVault

Definisce l'origine del certificato SSL.

certificateSourceParameters True

KeyVaultCertificateSourceParameters

Definisce i parametri di origine del certificato usando il certificato dell'insieme di credenziali delle chiavi dell'utente per abilitare SSL.

protocolType True

ProtocolType

Definisce il protocollo di estensione TLS usato per il recapito sicuro.

minimumTlsVersion

MinimumTlsVersion

Versione del protocollo TLS che verrà usata per Https

Risposte

Nome Tipo Descrizione
200 OK

CustomDomain

OK. La richiesta ha avuto esito positivo.

202 Accepted

CustomDomain

Accettato e l'operazione verrà completata in modo asincrono.

Intestazioni

location: string

Other Status Codes

ErrorResponse

Risposta di errore della rete CDN che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate
CustomDomains_EnableCustomHttpsUsingYourOwnCertificate

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

Esempio di richiesta

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

Risposta di esempio

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

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
CdnCertificateSourceParameters

Definisce i parametri per l'uso del certificato gestito della rete CDN per la protezione di un dominio personalizzato.

CdnManagedHttpsParameters

Definisce i parametri di origine del certificato usando il certificato gestito della rete CDN per abilitare SSL.

CertificateType

Tipo di certificato usato

CustomDomain

Mapping dei nomi di dominio descrittivi al nome host dell'endpoint fornito dal cliente a scopo di personalizzazione, ad esempio www.contoso.com.

CustomDomainResourceState

Stato della risorsa del dominio personalizzato.

CustomHttpsProvisioningState

Stato del provisioning del dominio personalizzato.

CustomHttpsProvisioningSubstate

Lo stato secondario di provisioning mostra lo stato di avanzamento dell'abilitazione/disabilitazione del processo HTTPS personalizzato passo dopo passo.

DeleteRule

Descrive l'azione che deve essere eseguita quando il certificato viene rimosso da Key Vault.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta di errore

IdentityType

Tipo di identità che crea/modifica le risorse

KeyVaultCertificateSourceParameters

Descrive i parametri per l'uso del certificato KeyVault di un utente per la protezione di un dominio personalizzato.

MinimumTlsVersion

Versione del protocollo TLS che verrà usata per Https

ProtocolType

Definisce il protocollo di estensione TLS usato per il recapito sicuro.

SystemData

Sola lettura dei dati di sistema

UpdateRule

Descrive l'azione che deve essere eseguita quando il certificato viene aggiornato in Key Vault.

UserManagedHttpsParameters

Definisce i parametri di origine del certificato usando il certificato dell'insieme di credenziali delle chiavi dell'utente per abilitare SSL.

CdnCertificateSourceParameters

Definisce i parametri per l'uso del certificato gestito della rete CDN per la protezione di un dominio personalizzato.

Nome Tipo Descrizione
certificateType

CertificateType

Tipo di certificato usato

typeName string:

CdnCertificateSourceParameters

CdnManagedHttpsParameters

Definisce i parametri di origine del certificato usando il certificato gestito della rete CDN per abilitare SSL.

Nome Tipo Descrizione
certificateSource string:

Cdn

Definisce l'origine del certificato SSL.

certificateSourceParameters

CdnCertificateSourceParameters

Definisce i parametri di origine del certificato usando il certificato gestito della rete CDN per abilitare SSL.

minimumTlsVersion

MinimumTlsVersion

Versione del protocollo TLS che verrà usata per Https

protocolType

ProtocolType

Definisce il protocollo di estensione TLS usato per il recapito sicuro.

CertificateType

Tipo di certificato usato

Nome Tipo Descrizione
Dedicated

string

Shared

string

CustomDomain

Mapping dei nomi di dominio descrittivi al nome host dell'endpoint fornito dal cliente a scopo di personalizzazione, ad esempio www.contoso.com.

Nome Tipo Descrizione
id

string

ID risorsa.

name

string

Nome risorsa.

properties.customHttpsParameters CustomDomainHttpsParameters:

Parametri del certificato per la protezione di HTTPS personalizzati

properties.customHttpsProvisioningState

CustomHttpsProvisioningState

Stato del provisioning del dominio personalizzato.

properties.customHttpsProvisioningSubstate

CustomHttpsProvisioningSubstate

Lo stato secondario di provisioning mostra lo stato di avanzamento dell'abilitazione/disabilitazione del processo HTTPS personalizzato passo dopo passo.

properties.hostName

string

Nome host del dominio personalizzato. Deve essere un nome di dominio.

properties.provisioningState

CustomHttpsProvisioningState

Stato del provisioning di Https personalizzato del dominio personalizzato.

properties.resourceState

CustomDomainResourceState

Stato della risorsa del dominio personalizzato.

properties.validationData

string

La convalida o i dati speciali possono essere necessari quando si distribuisce la rete CDN in alcune aree a causa di motivi di conformità locali. Ad esempio, il numero di licenza ICP di un dominio personalizzato è necessario per distribuire contenuto in Cina.

systemData

SystemData

Sola lettura dei dati di sistema

type

string

Tipo di risorsa.

CustomDomainResourceState

Stato della risorsa del dominio personalizzato.

Nome Tipo Descrizione
Active

string

Creating

string

Deleting

string

CustomHttpsProvisioningState

Stato del provisioning del dominio personalizzato.

Nome Tipo Descrizione
Disabled

string

Disabling

string

Enabled

string

Enabling

string

Failed

string

CustomHttpsProvisioningSubstate

Lo stato secondario di provisioning mostra lo stato di avanzamento dell'abilitazione/disabilitazione del processo HTTPS personalizzato passo dopo passo.

Nome Tipo Descrizione
CertificateDeleted

string

CertificateDeployed

string

DeletingCertificate

string

DeployingCertificate

string

DomainControlValidationRequestApproved

string

DomainControlValidationRequestRejected

string

DomainControlValidationRequestTimedOut

string

IssuingCertificate

string

PendingDomainControlValidationREquestApproval

string

SubmittingDomainControlValidationRequest

string

DeleteRule

Descrive l'azione che deve essere eseguita quando il certificato viene rimosso da Key Vault.

Nome Tipo Descrizione
NoAction

string

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.

code

string

Codice di errore.

details

ErrorDetail[]

Dettagli dell'errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

IdentityType

Tipo di identità che crea/modifica le risorse

Nome Tipo Descrizione
application

string

key

string

managedIdentity

string

user

string

KeyVaultCertificateSourceParameters

Descrive i parametri per l'uso del certificato KeyVault di un utente per la protezione di un dominio personalizzato.

Nome Tipo Descrizione
deleteRule

DeleteRule

Descrive l'azione che deve essere eseguita quando il certificato viene rimosso da Key Vault.

resourceGroupName

string

Gruppo di risorse del Key Vault dell'utente contenente il certificato SSL

secretName

string

Nome di Key Vault Segreto (che rappresenta il certificato PFX completo) in Key Vault.

secretVersion

string

Versione (GUID) di Key Vault Segreto in Key Vault.

subscriptionId

string

ID sottoscrizione del Key Vault dell'utente contenente il certificato SSL

typeName string:

KeyVaultCertificateSourceParameters

updateRule

UpdateRule

Descrive l'azione che deve essere eseguita quando il certificato viene aggiornato in Key Vault.

vaultName

string

Nome del Key Vault dell'utente contenente il certificato SSL

MinimumTlsVersion

Versione del protocollo TLS che verrà usata per Https

Nome Tipo Descrizione
None

string

TLS10

string

TLS12

string

ProtocolType

Definisce il protocollo di estensione TLS usato per il recapito sicuro.

Nome Tipo Descrizione
IPBased

string

ServerNameIndication

string

SystemData

Sola lettura dei dati di sistema

Nome Tipo Descrizione
createdAt

string

Timestamp della creazione di risorse (UTC)

createdBy

string

Identificatore per l'identità che ha creato la risorsa

createdByType

IdentityType

Tipo di identità che ha creato la risorsa

lastModifiedAt

string

Timestamp dell'ultima modifica della risorsa (UTC)

lastModifiedBy

string

Identificatore per l'identità che ha modificato l'ultima risorsa

lastModifiedByType

IdentityType

Tipo di identità che ha modificato per l'ultima volta la risorsa

UpdateRule

Descrive l'azione che deve essere eseguita quando il certificato viene aggiornato in Key Vault.

Nome Tipo Descrizione
NoAction

string

UserManagedHttpsParameters

Definisce i parametri di origine del certificato usando il certificato dell'insieme di credenziali delle chiavi dell'utente per abilitare SSL.

Nome Tipo Descrizione
certificateSource string:

AzureKeyVault

Definisce l'origine del certificato SSL.

certificateSourceParameters

KeyVaultCertificateSourceParameters

Definisce i parametri di origine del certificato usando il certificato dell'insieme di credenziali delle chiavi dell'utente per abilitare SSL.

minimumTlsVersion

MinimumTlsVersion

Versione del protocollo TLS che verrà usata per Https

protocolType

ProtocolType

Definisce il protocollo di estensione TLS usato per il recapito sicuro.