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

App Service Environments - Update Ase Custom Dns Suffix Configuration

参考

Service:: App Service

API Version:: 2023-12-01

更新应用服务环境的自定义 Dns 后缀配置

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix?api-version=2023-12-01

URI 参数

名称	在	必需	类型	说明
name	path	True	string	应用服务环境的名称。
resourceGroupName	path	True	string	资源所属的资源组的名称。 Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Azure 订阅 ID。这是一个 GUID 格式的字符串， (例如 00000000-0000-0000-0000-0000000000000) 。
api-version	query	True	string	API 版本

请求正文

名称	类型	说明
kind	string	资源类型。
properties.certificateUrl	string	引用 Azure 密钥保管库证书机密的 URL，该机密应用作具有自定义域后缀的站点的默认 SSL/TLS 证书。
properties.dnsSuffix	string	要用于 ASE 上部署的所有站点的默认自定义域后缀。
properties.keyVaultReferenceIdentity	string	用户分配的标识，用于解析密钥保管库证书引用。如果未指定，将使用系统分配的 ASE 标识（如果可用）。

响应

名称	类型	说明
200 OK	CustomDnsSuffixConfiguration	没问题。
Other Status Codes	DefaultErrorResponse	App 服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Update ASE custom DNS suffix configuration

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/customdnssuffix?api-version=2023-12-01

{
  "properties": {
    "dnsSuffix": "contoso.com",
    "certificateUrl": "https://test-kv.vault.azure.net/secrets/contosocert",
    "keyVaultReferenceIdentity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi"
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/customdnssuffix",
  "name": "customDnsSuffix",
  "type": "Microsoft.Web/hostingEnvironments/configurations/customdnssuffix",
  "properties": {
    "provisioningState": "Succeeded",
    "provisioningDetails": null,
    "dnsSuffix": "contoso.com",
    "certificateUrl": "https://test-kv.vault.azure.net/secrets/contosocert",
    "keyVaultReferenceIdentity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi"
  }
}

定义

名称	说明
CustomDnsSuffixConfiguration	ASEv3 的自定义域后缀配置的完整视图。
CustomDnsSuffixProvisioningState
DefaultErrorResponse	App 服务错误响应。
Details
Error	错误模型。

CustomDnsSuffixConfiguration

ASEv3 的自定义域后缀配置的完整视图。

名称	类型	说明
id	string	资源 ID。
kind	string	资源类型。
name	string	资源名称。
properties.certificateUrl	string	引用 Azure 密钥保管库证书机密的 URL，该机密应用作具有自定义域后缀的站点的默认 SSL/TLS 证书。
properties.dnsSuffix	string	要用于 ASE 上部署的所有站点的默认自定义域后缀。
properties.keyVaultReferenceIdentity	string	用户分配的标识，用于解析密钥保管库证书引用。如果未指定，将使用系统分配的 ASE 标识（如果可用）。
properties.provisioningDetails	string
properties.provisioningState	CustomDnsSuffixProvisioningState
type	string	资源类型。

CustomDnsSuffixProvisioningState

名称	类型	说明
Degraded	string
Failed	string
InProgress	string
Succeeded	string

DefaultErrorResponse

App 服务错误响应。

名称	类型	说明
error	Error	错误模型。

Details

名称	类型	说明
code	string	标准化字符串，用于以编程方式标识错误。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

Error

错误模型。

名称	类型	说明
code	string	标准化字符串，用于以编程方式标识错误。
details	Details[]	详细错误。
innererror	string	调试错误的详细信息。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。