PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/?api-version=2023-01-01

Description for Create or update an App Service Environment.

Servers

https://management.azure.com/

Path parameters

Name	Type	Required	Description
`name`	String	Yes	Name of the App Service Environment.
`subscriptionId`	String	Yes	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
`resourceGroupName`	String	Yes	Name of the resource group to which the resource belongs.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`id`	String	No	Resource Id.
`name`	String	No	Resource Name.
`properties`	Object	No	Description of an App Service Environment.
`properties.ipsslAddressCount`	Integer	No	Number of IP SSL addresses reserved for the App Service Environment.
`properties.multiSize`	String	No	Front-end VM size, e.g. "Medium", "Large".
`properties.dnsSuffix`	String	No	DNS suffix of the App Service Environment.
`properties.customDnsSuffixConfiguration`	Object	No	Full view of the custom domain suffix configuration for ASEv3.
`properties.customDnsSuffixConfiguration.id`	String	No	Resource Id.
`properties.customDnsSuffixConfiguration.name`	String	No	Resource Name.
`properties.customDnsSuffixConfiguration.properties`	Object	No	CustomDnsSuffixConfiguration resource specific properties
`properties.customDnsSuffixConfiguration.properties.dnsSuffix`	String	No	The default custom domain suffix to use for all sites deployed on the ASE.
`properties.customDnsSuffixConfiguration.properties.provisioningState`	String	No	Possible values: `"Degraded"` `"Succeeded"` `"InProgress"` `"Failed"`
`properties.customDnsSuffixConfiguration.properties.keyVaultReferenceIdentity`	String	No	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.customDnsSuffixConfiguration.properties.provisioningDetails`	String	No
`properties.customDnsSuffixConfiguration.properties.certificateUrl`	String	No	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.customDnsSuffixConfiguration.type`	String	No	Resource type.
`properties.customDnsSuffixConfiguration.kind`	String	No	Kind of resource.
`properties.suspended`	Boolean	No	`true` if the App Service Environment is suspended; otherwise, `false`. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
`properties.hasLinuxWorkers`	Boolean	No	Flag that displays whether an ASE has linux workers or not
`properties.maximumNumberOfMachines`	Integer	No	Maximum number of VMs in the App Service Environment.
`properties.frontEndScaleFactor`	Integer	No	Scale factor for front-ends.
`properties.status`	String	No	Current status of the App Service Environment. Possible values: `"Scaling"` `"Preparing"` `"Deleting"` `"Ready"`
`properties.networkingConfiguration`	Object	No	Full view of networking configuration for an ASE.
`properties.networkingConfiguration.id`	String	No	Resource Id.
`properties.networkingConfiguration.name`	String	No	Resource Name.
`properties.networkingConfiguration.properties`	Object	No	AseV3NetworkingConfiguration resource specific properties
`properties.networkingConfiguration.properties.remoteDebugEnabled`	Boolean	No	Property to enable and disable Remote Debug on ASEV3
`properties.networkingConfiguration.properties.allowNewPrivateEndpointConnections`	Boolean	No	Property to enable and disable new private endpoint connection creation on ASE
`properties.networkingConfiguration.properties.ftpEnabled`	Boolean	No	Property to enable and disable FTP on ASEV3
`properties.networkingConfiguration.properties.inboundIpAddressOverride`	String	No	Customer provided Inbound IP Address. Only able to be set on Ase create.
`properties.networkingConfiguration.properties.internalInboundIpAddresses[]`	Array	No
`properties.networkingConfiguration.properties.windowsOutboundIpAddresses[]`	Array	No
`properties.networkingConfiguration.properties.linuxOutboundIpAddresses[]`	Array	No
`properties.networkingConfiguration.properties.externalInboundIpAddresses[]`	Array	No
`properties.networkingConfiguration.type`	String	No	Resource type.
`properties.networkingConfiguration.kind`	String	No	Kind of resource.
`properties.internalLoadBalancingMode`	String	No	Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values: `"Publishing"` `"Web"` `"None"` `"Web, Publishing"`
`properties.userWhitelistedIpRanges[]`	Array	No	User added ip ranges to whitelist on ASE db
`properties.virtualNetwork`	Object	Yes	Specification for using a Virtual Network.
`properties.virtualNetwork.id`	String	Yes	Resource id of the Virtual Network.
`properties.virtualNetwork.name`	String	No	Name of the Virtual Network (read-only).
`properties.virtualNetwork.type`	String	No	Resource type of the Virtual Network (read-only).
`properties.virtualNetwork.subnet`	String	No	Subnet within the Virtual Network.
`properties.provisioningState`	String	No	Provisioning state of the App Service Environment. Possible values: `"Succeeded"` `"Deleting"` `"Canceled"` `"InProgress"` `"Failed"`
`properties.clusterSettings[]`	Array	No	Custom settings for changing the behavior of the App Service Environment.
`properties.clusterSettings[].name`	String	No	Pair name.
`properties.clusterSettings[].value`	String	No	Pair value.
`properties.multiRoleCount`	Integer	No	Number of front-end instances.
`properties.zoneRedundant`	Boolean	No	Whether or not this App Service Environment is zone-redundant.
`properties.upgradeAvailability`	String	No	Whether an upgrade is available for this App Service Environment. Possible values: `"None"` `"Ready"`
`properties.upgradePreference`	String	No	Upgrade Preference Possible values: `"Manual"` `"Late"` `"None"` `"Early"` Default value: "None"
`properties.dedicatedHostCount`	Integer	No	Dedicated Host Count
`type`	String	No	Resource type.
`kind`	String	No	Kind of resource.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.