你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Custom Domains - Enable Custom Https

启用自定义域的 https 传递。

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 参数

名称 必需 类型 说明
customDomainName
path True

string

终结点中自定义域的名称。

endpointName
path True

string

配置文件下全局唯一的终结点的名称。

profileName
path True

string

资源组中唯一的 CDN 配置文件的名称。

resourceGroupName
path True

string

Azure 订阅中资源组的名称。

正则表达式模式: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Azure 订阅 ID。

api-version
query True

string

要与客户端请求一起使用的 API 的版本。 当前版本为 2024-02-01。

请求正文

请求正文可以为下列任一内容:

名称 说明
CdnManagedHttpsParameters

使用 CDN 托管证书定义证书源参数,以启用 SSL。

UserManagedHttpsParameters

使用用户的 keyvault 证书来定义证书源参数,以启用 SSL。

CdnManagedHttpsParameters

使用 CDN 托管证书定义证书源参数,以启用 SSL。

名称 必需 类型 说明
certificateSource True string:

Cdn

定义 SSL 证书的源。

certificateSourceParameters True

CdnCertificateSourceParameters

使用 CDN 托管证书定义证书源参数,以启用 SSL。

protocolType True

ProtocolType

定义用于安全传递的 TLS 扩展协议。

minimumTlsVersion

MinimumTlsVersion

将用于 Https 的 TLS 协议版本

UserManagedHttpsParameters

使用用户的 keyvault 证书来定义证书源参数,以启用 SSL。

名称 必需 类型 说明
certificateSource True string:

AzureKeyVault

定义 SSL 证书的源。

certificateSourceParameters True

KeyVaultCertificateSourceParameters

使用用户的 keyvault 证书来定义证书源参数,以启用 SSL。

protocolType True

ProtocolType

定义用于安全传递的 TLS 扩展协议。

minimumTlsVersion

MinimumTlsVersion

将用于 Https 的 TLS 协议版本

响应

名称 类型 说明
200 OK

CustomDomain

没问题。 请求已成功。

202 Accepted

CustomDomain

接受,操作将以异步方式完成。

标头

location: string

Other Status Codes

ErrorResponse

描述操作失败原因的 CDN 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate
CustomDomains_EnableCustomHttpsUsingYourOwnCertificate

CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate

示例请求

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

示例响应

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

示例请求

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

示例响应

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

定义

名称 说明
CdnCertificateSourceParameters

定义使用 CDN 托管证书保护自定义域的参数。

CdnManagedHttpsParameters

使用 CDN 托管证书定义证书源参数,以启用 SSL。

CertificateType

使用的证书类型

CustomDomain

友好域名映射到客户提供的终结点主机名,用于品牌打造,例如 www.contoso.com

CustomDomainResourceState

自定义域的资源状态。

CustomHttpsProvisioningState

自定义域的预配状态。

CustomHttpsProvisioningSubstate

预配子状态显示逐步启用/禁用自定义 HTTPS 过程的进度。

DeleteRule

描述从密钥保管库中删除证书时应执行的操作。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

IdentityType

创建/修改资源的标识类型

KeyVaultCertificateSourceParameters

介绍使用用户的 KeyVault 证书保护自定义域的参数。

MinimumTlsVersion

将用于 Https 的 TLS 协议版本

ProtocolType

定义用于安全传递的 TLS 扩展协议。

SystemData

只读系统数据

UpdateRule

描述在 密钥保管库 中更新证书时应执行的操作。

UserManagedHttpsParameters

使用用户的 keyvault 证书来定义证书源参数,以启用 SSL。

CdnCertificateSourceParameters

定义使用 CDN 托管证书保护自定义域的参数。

名称 类型 说明
certificateType

CertificateType

使用的证书类型

typeName enum:

CdnCertificateSourceParameters

CdnManagedHttpsParameters

使用 CDN 托管证书定义证书源参数,以启用 SSL。

名称 类型 说明
certificateSource string:

Cdn

定义 SSL 证书的源。

certificateSourceParameters

CdnCertificateSourceParameters

使用 CDN 托管证书定义证书源参数,以启用 SSL。

minimumTlsVersion

MinimumTlsVersion

将用于 Https 的 TLS 协议版本

protocolType

ProtocolType

定义用于安全传递的 TLS 扩展协议。

CertificateType

使用的证书类型

名称 类型 说明
Dedicated

string

Shared

string

CustomDomain

友好域名映射到客户提供的终结点主机名,用于品牌打造,例如 www.contoso.com

名称 类型 说明
id

string

资源 ID。

name

string

资源名称。

properties.customHttpsParameters CustomDomainHttpsParameters:

用于保护自定义 HTTPS 的证书参数

properties.customHttpsProvisioningState

CustomHttpsProvisioningState

自定义域的预配状态。

properties.customHttpsProvisioningSubstate

CustomHttpsProvisioningSubstate

预配子状态显示逐步启用/禁用自定义 HTTPS 过程的进度。

properties.hostName

string

自定义域的主机名。 必须是域名。

properties.provisioningState

CustomHttpsProvisioningState

自定义域的自定义 Https 的预配状态。

properties.resourceState

CustomDomainResourceState

自定义域的资源状态。

properties.validationData

string

由于本地合规性原因,将 CDN 传送到某些区域时,可能需要特殊验证或数据。 例如,在中国交付内容需要自定义域的 ICP 许可证编号。

systemData

SystemData

只读系统数据

type

string

资源类型。

CustomDomainResourceState

自定义域的资源状态。

名称 类型 说明
Active

string

Creating

string

Deleting

string

CustomHttpsProvisioningState

自定义域的预配状态。

名称 类型 说明
Disabled

string

Disabling

string

Enabled

string

Enabling

string

Failed

string

CustomHttpsProvisioningSubstate

预配子状态显示逐步启用/禁用自定义 HTTPS 过程的进度。

名称 类型 说明
CertificateDeleted

string

CertificateDeployed

string

DeletingCertificate

string

DeployingCertificate

string

DomainControlValidationRequestApproved

string

DomainControlValidationRequestRejected

string

DomainControlValidationRequestTimedOut

string

IssuingCertificate

string

PendingDomainControlValidationREquestApproval

string

SubmittingDomainControlValidationRequest

string

DeleteRule

描述从密钥保管库中删除证书时应执行的操作。

名称 类型 说明
NoAction

string

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

IdentityType

创建/修改资源的标识类型

名称 类型 说明
application

string

key

string

managedIdentity

string

user

string

KeyVaultCertificateSourceParameters

介绍使用用户的 KeyVault 证书保护自定义域的参数。

名称 类型 说明
deleteRule

DeleteRule

描述从密钥保管库中删除证书时应执行的操作。

resourceGroupName

string

包含 SSL 证书的用户密钥保管库的资源组

secretName

string

密钥保管库 机密 (的名称,表示 密钥保管库 中的完整证书 PFX) 。

secretVersion

string

密钥保管库 中密钥保管库机密的版本 (GUID) 。

subscriptionId

string

包含 SSL 证书的用户密钥保管库的订阅 ID

typeName enum:

KeyVaultCertificateSourceParameters

updateRule

UpdateRule

描述在 密钥保管库 中更新证书时应执行的操作。

vaultName

string

包含 SSL 证书的用户密钥保管库的名称

MinimumTlsVersion

将用于 Https 的 TLS 协议版本

名称 类型 说明
None

string

TLS10

string

TLS12

string

ProtocolType

定义用于安全传递的 TLS 扩展协议。

名称 类型 说明
IPBased

string

ServerNameIndication

string

SystemData

只读系统数据

名称 类型 说明
createdAt

string

资源创建时间戳 (UTC)

createdBy

string

创建资源的标识的标识符

createdByType

IdentityType

创建资源的标识类型

lastModifiedAt

string

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识的标识符

lastModifiedByType

IdentityType

上次修改资源的标识类型

UpdateRule

描述在 密钥保管库 中更新证书时应执行的操作。

名称 类型 说明
NoAction

string

UserManagedHttpsParameters

使用用户的 keyvault 证书来定义证书源参数,以启用 SSL。

名称 类型 说明
certificateSource string:

AzureKeyVault

定义 SSL 证书的源。

certificateSourceParameters

KeyVaultCertificateSourceParameters

使用用户的 keyvault 证书来定义证书源参数,以启用 SSL。

minimumTlsVersion

MinimumTlsVersion

将用于 Https 的 TLS 协议版本

protocolType

ProtocolType

定义用于安全传递的 TLS 扩展协议。