你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
AFD Custom Domains - Update
汇报配置文件中的现有域。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}?api-version=2023-05-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
custom
|
path | True |
string |
配置文件下全局唯一的域的名称 |
profile
|
path | True |
string |
资源组中唯一的 Azure Front Door Standard 或 Azure Front Door Premium 配置文件的名称。 |
resource
|
path | True |
string |
Azure 订阅中的资源组的名称。 正则表达式模式: |
subscription
|
path | True |
string |
Azure 订阅 ID。 |
api-version
|
query | True |
string |
要与客户端请求一起使用的 API 的版本。 当前版本为 2023-05-01。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
properties.azureDnsZone |
Azure DNS 区域的资源引用 |
|
properties.preValidatedCustomDomainResourceId |
对已预先验证自定义域所有权的 Azure 资源的资源引用 |
|
properties.tlsSettings |
指定如何为域启用 HTTPS 的配置 - 使用 AzureFrontDoor 托管证书或用户自己的证书。 如果未指定,则启用 ssl 默认使用 AzureFrontDoor 托管证书。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
确定 |
|
202 Accepted |
已接受。 已接受请求进行处理,操作将以异步方式完成。 标头 location: string |
|
Other Status Codes |
描述操作失败原因的 Azure Front Door 错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
AFDCustomDomains_Update
示例请求
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1?api-version=2023-05-01
{
"properties": {
"tlsSettings": {
"certificateType": "CustomerCertificate",
"minimumTlsVersion": "TLS12"
},
"azureDnsZone": {
"id": ""
}
}
}
示例响应
{
"id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1",
"name": "domain1",
"type": "Microsoft.Cdn/profiles/customdomains",
"properties": {
"profileName": "profile1",
"hostName": "www.contoso.com",
"tlsSettings": {
"certificateType": "ManagedCertificate",
"minimumTlsVersion": "TLS12",
"secret": {
"id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/mysecert"
}
},
"azureDnsZone": {
"id": ""
},
"preValidatedCustomDomainResourceId": {
"id": ""
},
"validationProperties": {
"validationToken": "8c9912db-c615-4eeb-8465",
"expirationDate": "2009-06-15T13:45:43.0000000Z"
},
"domainValidationState": "Approved",
"provisioningState": "Updating",
"deploymentStatus": "NotStarted"
}
}
azure-asyncoperation: https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2023-05-01
{
"id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1",
"name": "domain1",
"type": "Microsoft.Cdn/profiles/customdomains",
"properties": {
"profileName": "profile1",
"hostName": "www.contoso.com",
"tlsSettings": {
"certificateType": "ManagedCertificate",
"minimumTlsVersion": "TLS12",
"secret": {
"id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/mysecert"
}
},
"azureDnsZone": {
"id": ""
},
"preValidatedCustomDomainResourceId": {
"id": ""
},
"validationProperties": {
"validationToken": "8c9912db-c615-4eeb-8465",
"expirationDate": "2009-06-15T13:45:43.0000000Z"
},
"domainValidationState": "Approved",
"provisioningState": "Updating",
"deploymentStatus": "NotStarted"
}
}
定义
名称 | 说明 |
---|---|
Afd |
定义 SSL 证书的源。 |
AFDDomain |
友好的域名映射到客户出于品牌打造目的提供的终结点主机名,例如 www.contoso.com。 |
AFDDomain |
包含用于保护域的属性的 JSON 对象。 |
AFDDomain |
创建或更新域所需的域 JSON 对象。 |
Afd |
错误响应 |
Afd |
将用于 Https 的 TLS 协议版本 |
Afd |
预配状态 |
Deployment |
|
Domain |
包含用于验证域的属性的 JSON 对象。 |
Domain |
预配子状态逐步显示自定义 HTTPS 启用/禁用过程的进度。 DCV 代表 DomainControlValidation。 |
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Identity |
创建/修改资源的标识类型 |
Resource |
对另一个资源的引用。 |
System |
只读系统数据 |
AfdCertificateType
定义 SSL 证书的源。
名称 | 类型 | 说明 |
---|---|---|
AzureFirstPartyManagedCertificate |
string |
|
CustomerCertificate |
string |
|
ManagedCertificate |
string |
AFDDomain
友好的域名映射到客户出于品牌打造目的提供的终结点主机名,例如 www.contoso.com。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID。 |
name |
string |
资源名称。 |
properties.azureDnsZone |
Azure DNS 区域的资源引用 |
|
properties.deploymentStatus | ||
properties.domainValidationState |
预配子状态逐步显示自定义 HTTPS 启用/禁用过程的进度。 DCV 代表 DomainControlValidation。 |
|
properties.extendedProperties |
object |
表示域迁移属性的 Key-Value 对。 |
properties.hostName |
string |
域的主机名。 必须是域名。 |
properties.preValidatedCustomDomainResourceId |
对已预先验证自定义域所有权的 Azure 资源的资源引用 |
|
properties.profileName |
string |
保存域的配置文件的名称。 |
properties.provisioningState |
预配状态 |
|
properties.tlsSettings |
指定如何为域启用 HTTPS 的配置 - 使用 AzureFrontDoor 托管证书或用户自己的证书。 如果未指定,则启用 ssl 默认使用 AzureFrontDoor 托管证书。 |
|
properties.validationProperties |
客户验证域所有权所需的值 |
|
systemData |
只读系统数据 |
|
type |
string |
资源类型。 |
AFDDomainHttpsParameters
包含用于保护域的属性的 JSON 对象。
名称 | 类型 | 说明 |
---|---|---|
certificateType |
定义 SSL 证书的源。 |
|
minimumTlsVersion |
将用于 Https 的 TLS 协议版本 |
|
secret |
对机密的资源引用。即。subs/rg/profile/secret |
AFDDomainUpdateParameters
创建或更新域所需的域 JSON 对象。
名称 | 类型 | 说明 |
---|---|---|
properties.azureDnsZone |
Azure DNS 区域的资源引用 |
|
properties.preValidatedCustomDomainResourceId |
对已预先验证自定义域所有权的 Azure 资源的资源引用 |
|
properties.profileName |
string |
保存域的配置文件的名称。 |
properties.tlsSettings |
指定如何为域启用 HTTPS 的配置 - 使用 AzureFrontDoor 托管证书或用户自己的证书。 如果未指定,则启用 ssl 默认使用 AzureFrontDoor 托管证书。 |
AfdErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
AfdMinimumTlsVersion
将用于 Https 的 TLS 协议版本
名称 | 类型 | 说明 |
---|---|---|
TLS10 |
string |
|
TLS12 |
string |
AfdProvisioningState
预配状态
名称 | 类型 | 说明 |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
DeploymentStatus
名称 | 类型 | 说明 |
---|---|---|
Failed |
string |
|
InProgress |
string |
|
NotStarted |
string |
|
Succeeded |
string |
DomainValidationProperties
包含用于验证域的属性的 JSON 对象。
名称 | 类型 | 说明 |
---|---|---|
expirationDate |
string |
令牌过期的日期时间 |
validationToken |
string |
用于 DNS TXT 记录或基于文件的验证的质询 |
DomainValidationState
预配子状态逐步显示自定义 HTTPS 启用/禁用过程的进度。 DCV 代表 DomainControlValidation。
名称 | 类型 | 说明 |
---|---|---|
Approved |
string |
|
InternalError |
string |
|
Pending |
string |
|
PendingRevalidation |
string |
|
RefreshingValidationToken |
string |
|
Rejected |
string |
|
Submitting |
string |
|
TimedOut |
string |
|
Unknown |
string |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
IdentityType
创建/修改资源的标识类型
名称 | 类型 | 说明 |
---|---|---|
application |
string |
|
key |
string |
|
managedIdentity |
string |
|
user |
string |
ResourceReference
对另一个资源的引用。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID。 |
SystemData
只读系统数据
名称 | 类型 | 说明 |
---|---|---|
createdAt |
string |
资源的创建时间戳 (UTC) |
createdBy |
string |
创建资源的标识的标识符 |
createdByType |
创建资源的标识类型 |
|
lastModifiedAt |
string |
资源上次修改的时间戳 (UTC) |
lastModifiedBy |
string |
上次修改资源的标识的标识符 |
lastModifiedByType |
上次修改资源的标识类型 |