App Service Environments - Update Ase Custom Dns Suffix Configuration

Reference

Service:: App Service

API Version:: 2023-12-01

Update Custom Dns Suffix configuration of an App Service Environment

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

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Name of the App Service Environment.
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API Version

Request Body

Name	Type	Description
kind	string	Kind of resource.
properties.certificateUrl	string	The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
properties.dnsSuffix	string	The default custom domain suffix to use for all sites deployed on the ASE.
properties.keyVaultReferenceIdentity	string	The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.

Responses

Name	Type	Description
200 OK	CustomDnsSuffixConfiguration	OK.
Other Status Codes	DefaultErrorResponse	App Service error response.

Security

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	impersonate your user account

Examples

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

Definitions

Name	Description
CustomDnsSuffixConfiguration	Full view of the custom domain suffix configuration for ASEv3.
CustomDnsSuffixProvisioningState
DefaultErrorResponse	App Service error response.
Details
Error	Error model.

CustomDnsSuffixConfiguration

Full view of the custom domain suffix configuration for ASEv3.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.certificateUrl	string	The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
properties.dnsSuffix	string	The default custom domain suffix to use for all sites deployed on the ASE.
properties.keyVaultReferenceIdentity	string	The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
properties.provisioningDetails	string
properties.provisioningState	CustomDnsSuffixProvisioningState
type	string	Resource type.

CustomDnsSuffixProvisioningState

Name	Type	Description
Degraded	string
Failed	string
InProgress	string
Succeeded	string

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Share via