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

Custom Domains - Create

在终结点中创建新的自定义域。

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

URI 参数

Name In Required Type Description
customDomainName
path True
  • string

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

endpointName
path True
  • string

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

profileName
path True
  • string

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

resourceGroupName
path True
  • string

Azure 订阅中的资源组的名称。

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

subscriptionId
path True
  • string

Azure 订阅 ID。

api-version
query True
  • string

要用于客户端请求的 API 的版本。 当前版本为 2021-06-01。

请求正文

Name Required Type Description
properties.hostName True
  • string

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

响应

Name Type Description
200 OK

没问题。 请求已成功。

201 Created

Created. 请求已完成,并创建了一个新的自定义域。

202 Accepted

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

Other Status Codes

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

安全性

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 模拟用户帐户

示例

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=2021-06-01

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

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

定义

CdnCertificateSourceParameters

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

CdnManagedHttpsParameters

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

CertificateType

使用的证书类型

CustomDomain

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

CustomDomainParameters

自定义域创建或更新所需的 customDomain JSON 对象。

CustomDomainResourceState

自定义域的资源状态。

CustomHttpsProvisioningState

自定义域的预配状态。

CustomHttpsProvisioningSubstate

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

DeleteRule

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

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

IdentityType

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

KeyVaultCertificateSourceParameters

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

MinimumTlsVersion

将用于 Https 的 TLS 协议版本

ProtocolType

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

SystemData

只读系统数据

UpdateRule

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

UserManagedHttpsParameters

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

CdnCertificateSourceParameters

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

Name Type Description
certificateType

使用的证书类型

typeName enum:

CdnManagedHttpsParameters

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

Name Type Description
certificateSource string:
  • Cdn

定义 SSL 证书的源。

certificateSourceParameters

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

minimumTlsVersion

将用于 Https 的 TLS 协议版本

protocolType

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

CertificateType

使用的证书类型

Name Type Description
Dedicated
  • string
Shared
  • string

CustomDomain

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

Name Type Description
id
  • string

资源 ID。

name
  • string

资源名称。

properties.customHttpsParameters CustomDomainHttpsParameters:

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

properties.customHttpsProvisioningState

自定义域的预配状态。

properties.customHttpsProvisioningSubstate

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

properties.hostName
  • string

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

properties.provisioningState

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

properties.resourceState

自定义域的资源状态。

properties.validationData
  • string

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

systemData

只读系统数据

type
  • string

资源类型。

CustomDomainParameters

自定义域创建或更新所需的 customDomain JSON 对象。

Name Type Description
properties.hostName
  • string

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

CustomDomainResourceState

自定义域的资源状态。

Name Type Description
Active
  • string
Creating
  • string
Deleting
  • string

CustomHttpsProvisioningState

自定义域的预配状态。

Name Type Description
Disabled
  • string
Disabling
  • string
Enabled
  • string
Enabling
  • string
Failed
  • string

CustomHttpsProvisioningSubstate

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

Name Type Description
CertificateDeleted
  • string
CertificateDeployed
  • string
DeletingCertificate
  • string
DeployingCertificate
  • string
DomainControlValidationRequestApproved
  • string
DomainControlValidationRequestRejected
  • string
DomainControlValidationRequestTimedOut
  • string
IssuingCertificate
  • string
PendingDomainControlValidationREquestApproval
  • string
SubmittingDomainControlValidationRequest
  • string

DeleteRule

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

Name Type Description
NoAction
  • string

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorDetail

错误详细信息。

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

ErrorResponse

错误响应

Name Type Description
error

错误对象。

IdentityType

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

Name Type Description
application
  • string
key
  • string
managedIdentity
  • string
user
  • string

KeyVaultCertificateSourceParameters

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

Name Type Description
deleteRule

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

resourceGroupName
  • string

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

secretName
  • string

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

secretVersion
  • string

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

subscriptionId
  • string

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

typeName enum:
updateRule

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

vaultName
  • string

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

MinimumTlsVersion

将用于 Https 的 TLS 协议版本

Name Type Description
None
  • string
TLS10
  • string
TLS12
  • string

ProtocolType

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

Name Type Description
IPBased
  • string
ServerNameIndication
  • string

SystemData

只读系统数据

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC)

createdBy
  • string

创建资源的标识的标识符

createdByType

创建资源的标识的类型

lastModifiedAt
  • string

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

lastModifiedBy
  • string

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

lastModifiedByType

上次修改资源的标识类型

UpdateRule

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

Name Type Description
NoAction
  • string

UserManagedHttpsParameters

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

Name Type Description
certificateSource string:
  • AzureKeyVault

定义 SSL 证书的源。

certificateSourceParameters

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

minimumTlsVersion

将用于 Https 的 TLS 协议版本

protocolType

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