App Service Environments - Update

Service:

App Service

API Version:

2024-04-01

Description for Create or update an App Service Environment.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}?api-version=2024-04-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	Required	Type	Description
properties.virtualNetwork	True	VirtualNetworkProfile	Description of the Virtual Network.
kind		string	Kind of resource.
properties.clusterSettings		NameValuePair[]	Custom settings for changing the behavior of the App Service Environment.
properties.customDnsSuffixConfiguration		CustomDnsSuffixConfiguration	Full view of the custom domain suffix configuration for ASEv3.
properties.dedicatedHostCount		integer	Dedicated Host Count
properties.dnsSuffix		string	DNS suffix of the App Service Environment.
properties.frontEndScaleFactor		integer	Scale factor for front-ends.
properties.internalLoadBalancingMode		LoadBalancingMode	Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
properties.ipsslAddressCount		integer	Number of IP SSL addresses reserved for the App Service Environment.
properties.multiSize		string	Front-end VM size, e.g. "Medium", "Large".
properties.networkingConfiguration		AseV3NetworkingConfiguration	Full view of networking configuration for an ASE.
properties.upgradePreference		UpgradePreference	Upgrade Preference
properties.userWhitelistedIpRanges		string[]	User added ip ranges to whitelist on ASE db
properties.zoneRedundant		boolean	Whether or not this App Service Environment is zone-redundant.

Responses

Name	Type	Description
200 OK	AppServiceEnvironmentResource	OK
201 Created	AppServiceEnvironmentResource	Created
202 Accepted	AppServiceEnvironmentResource	Operation is in progress.
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

Create or update an App Service Environment.

Sample request

HTTP

PATCH https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase?api-version=2024-04-01

{
  "properties": {
    "frontEndScaleFactor": 20,
    "virtualNetwork": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated"
    }
  }
}

Java

import com.azure.resourcemanager.appservice.fluent.models.AppServiceEnvironmentPatchResourceInner;
import com.azure.resourcemanager.appservice.models.VirtualNetworkProfile;

/**
 * Samples for AppServiceEnvironments Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Update.json
     */
    /**
     * Sample code: Create or update an App Service Environment.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createOrUpdateAnAppServiceEnvironment(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getAppServiceEnvironments().updateWithResponse("test-rg", "test-ase",
            new AppServiceEnvironmentPatchResourceInner().withVirtualNetwork(new VirtualNetworkProfile().withId(
                "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated"))
                .withFrontEndScaleFactor(20),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python app_service_environments_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.app_service_environments.update(
        resource_group_name="test-rg",
        name="test-ase",
        hosting_environment_envelope={
            "properties": {
                "frontEndScaleFactor": 20,
                "virtualNetwork": {
                    "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated"
                },
            }
        },
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Update.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Update.json
func ExampleEnvironmentsClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewEnvironmentsClient().Update(ctx, "test-rg", "test-ase", armappservice.EnvironmentPatchResource{
		Properties: &armappservice.Environment{
			FrontEndScaleFactor: to.Ptr[int32](20),
			VirtualNetwork: &armappservice.VirtualNetworkProfile{
				ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.EnvironmentResource = armappservice.EnvironmentResource{
	// 	Name: to.Ptr("test-ase"),
	// 	Type: to.Ptr("Microsoft.Web/hostingEnvironments"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase"),
	// 	Kind: to.Ptr("ASEV3"),
	// 	Location: to.Ptr("South Central US"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armappservice.Environment{
	// 		DedicatedHostCount: to.Ptr[int32](0),
	// 		DNSSuffix: to.Ptr("test-ase.p.azurewebsites.net"),
	// 		FrontEndScaleFactor: to.Ptr[int32](15),
	// 		HasLinuxWorkers: to.Ptr(true),
	// 		InternalLoadBalancingMode: to.Ptr(armappservice.LoadBalancingModeNone),
	// 		IpsslAddressCount: to.Ptr[int32](0),
	// 		MaximumNumberOfMachines: to.Ptr[int32](250),
	// 		MultiSize: to.Ptr("Standard_D2d_v4"),
	// 		NetworkingConfiguration: &armappservice.AseV3NetworkingConfiguration{
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking"),
	// 			Properties: &armappservice.AseV3NetworkingConfigurationProperties{
	// 				AllowNewPrivateEndpointConnections: to.Ptr(false),
	// 				ExternalInboundIPAddresses: []*string{
	// 					to.Ptr("52.153.248.36")},
	// 					FtpEnabled: to.Ptr(false),
	// 					InternalInboundIPAddresses: []*string{
	// 					},
	// 					LinuxOutboundIPAddresses: []*string{
	// 						to.Ptr("20.88.241.56"),
	// 						to.Ptr("20.88.241.9")},
	// 						RemoteDebugEnabled: to.Ptr(false),
	// 						WindowsOutboundIPAddresses: []*string{
	// 							to.Ptr("20.88.241.56"),
	// 							to.Ptr("20.88.241.9")},
	// 						},
	// 					},
	// 					ProvisioningState: to.Ptr(armappservice.ProvisioningStateSucceeded),
	// 					Status: to.Ptr(armappservice.HostingEnvironmentStatusReady),
	// 					Suspended: to.Ptr(false),
	// 					VirtualNetwork: &armappservice.VirtualNetworkProfile{
	// 						Name: to.Ptr("delegated"),
	// 						Type: to.Ptr("Microsoft.Network/virtualNetworks/subnets"),
	// 						ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated"),
	// 						Subnet: to.Ptr(""),
	// 					},
	// 					ZoneRedundant: to.Ptr(false),
	// 				},
	// 			}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Create or update an App Service Environment.
 *
 * @summary Description for Create or update an App Service Environment.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Update.json
 */
async function createOrUpdateAnAppServiceEnvironment() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "test-rg";
  const name = "test-ase";
  const hostingEnvironmentEnvelope = {
    frontEndScaleFactor: 20,
    virtualNetwork: {
      id: "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.appServiceEnvironments.update(
    resourceGroupName,
    name,
    hostingEnvironmentEnvelope,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/AppServiceEnvironments_Update.json
// this example is just showing the usage of "AppServiceEnvironments_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this AppServiceEnvironmentResource created on azure
// for more information of creating AppServiceEnvironmentResource, please refer to the document of AppServiceEnvironmentResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "test-rg";
string name = "test-ase";
ResourceIdentifier appServiceEnvironmentResourceId = AppServiceEnvironmentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
AppServiceEnvironmentResource appServiceEnvironment = client.GetAppServiceEnvironmentResource(appServiceEnvironmentResourceId);

// invoke the operation
AppServiceEnvironmentPatch patch = new AppServiceEnvironmentPatch()
{
    VirtualNetwork = new AppServiceVirtualNetworkProfile(new ResourceIdentifier("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated")),
    FrontEndScaleFactor = 20,
};
AppServiceEnvironmentResource result = await appServiceEnvironment.UpdateAsync(patch);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
AppServiceEnvironmentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase",
  "name": "test-ase",
  "type": "Microsoft.Web/hostingEnvironments",
  "kind": "ASEV3",
  "location": "South Central US",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "status": "Ready",
    "virtualNetwork": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated",
      "name": "delegated",
      "type": "Microsoft.Network/virtualNetworks/subnets",
      "subnet": ""
    },
    "internalLoadBalancingMode": "None",
    "multiSize": "Standard_D2d_v4",
    "multiRoleCount": null,
    "ipsslAddressCount": 0,
    "dnsSuffix": "test-ase.p.azurewebsites.net",
    "maximumNumberOfMachines": 250,
    "frontEndScaleFactor": 15,
    "suspended": false,
    "clusterSettings": null,
    "userWhitelistedIpRanges": null,
    "hasLinuxWorkers": true,
    "dedicatedHostCount": 0,
    "zoneRedundant": false,
    "networkingConfiguration": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking",
      "properties": {
        "windowsOutboundIpAddresses": [
          "20.88.241.56",
          "20.88.241.9"
        ],
        "linuxOutboundIpAddresses": [
          "20.88.241.56",
          "20.88.241.9"
        ],
        "externalInboundIpAddresses": [
          "52.153.248.36"
        ],
        "internalInboundIpAddresses": [],
        "allowNewPrivateEndpointConnections": false,
        "ftpEnabled": false,
        "remoteDebugEnabled": false,
        "inboundIpAddressOverride": null
      }
    }
  }
}

Status code:

201

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase",
  "name": "test-ase",
  "type": "Microsoft.Web/hostingEnvironments",
  "kind": "ASEV3",
  "location": "South Central US",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "status": "Ready",
    "virtualNetwork": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated",
      "name": "delegated",
      "type": "Microsoft.Network/virtualNetworks/subnets",
      "subnet": ""
    },
    "internalLoadBalancingMode": "None",
    "multiSize": "Standard_D2d_v4",
    "multiRoleCount": null,
    "ipsslAddressCount": 0,
    "dnsSuffix": "test-ase.p.azurewebsites.net",
    "maximumNumberOfMachines": 250,
    "frontEndScaleFactor": 15,
    "suspended": false,
    "clusterSettings": null,
    "userWhitelistedIpRanges": null,
    "hasLinuxWorkers": true,
    "dedicatedHostCount": 0,
    "zoneRedundant": false,
    "networkingConfiguration": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking",
      "properties": {
        "windowsOutboundIpAddresses": [
          "20.88.241.56",
          "20.88.241.9"
        ],
        "linuxOutboundIpAddresses": [
          "20.88.241.56",
          "20.88.241.9"
        ],
        "externalInboundIpAddresses": [
          "52.153.248.36"
        ],
        "internalInboundIpAddresses": [],
        "allowNewPrivateEndpointConnections": false,
        "ftpEnabled": false,
        "remoteDebugEnabled": false,
        "inboundIpAddressOverride": null
      }
    }
  }
}

Status code:

202

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase",
  "name": "test-ase",
  "type": "Microsoft.Web/hostingEnvironments",
  "kind": "ASEV3",
  "location": "South Central US",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "status": "Ready",
    "virtualNetwork": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated",
      "name": "delegated",
      "type": "Microsoft.Network/virtualNetworks/subnets",
      "subnet": ""
    },
    "internalLoadBalancingMode": "None",
    "multiSize": "Standard_D2d_v4",
    "multiRoleCount": null,
    "ipsslAddressCount": 0,
    "dnsSuffix": "test-ase.p.azurewebsites.net",
    "maximumNumberOfMachines": 250,
    "frontEndScaleFactor": 15,
    "suspended": false,
    "clusterSettings": null,
    "userWhitelistedIpRanges": null,
    "hasLinuxWorkers": true,
    "dedicatedHostCount": 0,
    "zoneRedundant": false,
    "networkingConfiguration": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking",
      "properties": {
        "windowsOutboundIpAddresses": [
          "20.88.241.56",
          "20.88.241.9"
        ],
        "linuxOutboundIpAddresses": [
          "20.88.241.56",
          "20.88.241.9"
        ],
        "externalInboundIpAddresses": [
          "52.153.248.36"
        ],
        "internalInboundIpAddresses": [],
        "allowNewPrivateEndpointConnections": false,
        "ftpEnabled": false,
        "remoteDebugEnabled": false,
        "inboundIpAddressOverride": null
      }
    }
  }
}

Definitions

Name	Description
AppServiceEnvironmentPatchResource	ARM resource for a app service environment.
AppServiceEnvironmentResource	App Service Environment ARM resource.
AseV3NetworkingConfiguration	Full view of networking configuration for an ASE.
CustomDnsSuffixConfiguration	Full view of the custom domain suffix configuration for ASEv3.
CustomDnsSuffixProvisioningState
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
HostingEnvironmentStatus	Current status of the App Service Environment.
LoadBalancingMode	Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
NameValuePair	Name value pair.
ProvisioningState	Provisioning state of the App Service Environment.
UpgradeAvailability	Whether an upgrade is available for this App Service Environment.
UpgradePreference	Upgrade Preference
VirtualNetworkProfile	Specification for using a Virtual Network.

AppServiceEnvironmentPatchResource

ARM resource for a app service environment.

Name	Type	Default value	Description
id	string		Resource Id.
kind	string		Kind of resource.
name	string		Resource Name.
properties.clusterSettings	NameValuePair[]		Custom settings for changing the behavior of the App Service Environment.
properties.customDnsSuffixConfiguration	CustomDnsSuffixConfiguration		Full view of the custom domain suffix configuration for ASEv3.
properties.dedicatedHostCount	integer		Dedicated Host Count
properties.dnsSuffix	string		DNS suffix of the App Service Environment.
properties.frontEndScaleFactor	integer		Scale factor for front-ends.
properties.hasLinuxWorkers	boolean		Flag that displays whether an ASE has linux workers or not
properties.internalLoadBalancingMode	LoadBalancingMode		Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
properties.ipsslAddressCount	integer		Number of IP SSL addresses reserved for the App Service Environment.
properties.maximumNumberOfMachines	integer		Maximum number of VMs in the App Service Environment.
properties.multiRoleCount	integer		Number of front-end instances.
properties.multiSize	string		Front-end VM size, e.g. "Medium", "Large".
properties.networkingConfiguration	AseV3NetworkingConfiguration		Full view of networking configuration for an ASE.
properties.provisioningState	ProvisioningState		Provisioning state of the App Service Environment.
properties.status	HostingEnvironmentStatus		Current status of the App Service Environment.
properties.suspended	boolean		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.upgradeAvailability	UpgradeAvailability		Whether an upgrade is available for this App Service Environment.
properties.upgradePreference	UpgradePreference	None	Upgrade Preference
properties.userWhitelistedIpRanges	string[]		User added ip ranges to whitelist on ASE db
properties.virtualNetwork	VirtualNetworkProfile		Description of the Virtual Network.
properties.zoneRedundant	boolean		Whether or not this App Service Environment is zone-redundant.
type	string		Resource type.

AppServiceEnvironmentResource

App Service Environment ARM resource.

Name	Type	Default value	Description
id	string		Resource Id.
kind	string		Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
location	string		Resource Location.
name	string		Resource Name.
properties.clusterSettings	NameValuePair[]		Custom settings for changing the behavior of the App Service Environment.
properties.customDnsSuffixConfiguration	CustomDnsSuffixConfiguration		Full view of the custom domain suffix configuration for ASEv3.
properties.dedicatedHostCount	integer		Dedicated Host Count
properties.dnsSuffix	string		DNS suffix of the App Service Environment.
properties.frontEndScaleFactor	integer		Scale factor for front-ends.
properties.hasLinuxWorkers	boolean		Flag that displays whether an ASE has linux workers or not
properties.internalLoadBalancingMode	LoadBalancingMode		Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
properties.ipsslAddressCount	integer		Number of IP SSL addresses reserved for the App Service Environment.
properties.maximumNumberOfMachines	integer		Maximum number of VMs in the App Service Environment.
properties.multiRoleCount	integer		Number of front-end instances.
properties.multiSize	string		Front-end VM size, e.g. "Medium", "Large".
properties.networkingConfiguration	AseV3NetworkingConfiguration		Full view of networking configuration for an ASE.
properties.provisioningState	ProvisioningState		Provisioning state of the App Service Environment.
properties.status	HostingEnvironmentStatus		Current status of the App Service Environment.
properties.suspended	boolean		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.upgradeAvailability	UpgradeAvailability		Whether an upgrade is available for this App Service Environment.
properties.upgradePreference	UpgradePreference	None	Upgrade Preference
properties.userWhitelistedIpRanges	string[]		User added ip ranges to whitelist on ASE db
properties.virtualNetwork	VirtualNetworkProfile		Description of the Virtual Network.
properties.zoneRedundant	boolean		Whether or not this App Service Environment is zone-redundant.
tags	object		Resource tags.
type	string		Resource type.

AseV3NetworkingConfiguration

Full view of networking configuration for an ASE.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.allowNewPrivateEndpointConnections	boolean	Property to enable and disable new private endpoint connection creation on ASE
properties.externalInboundIpAddresses	string[]
properties.ftpEnabled	boolean	Property to enable and disable FTP on ASEV3
properties.inboundIpAddressOverride	string	Customer provided Inbound IP Address. Only able to be set on Ase create.
properties.internalInboundIpAddresses	string[]
properties.linuxOutboundIpAddresses	string[]
properties.remoteDebugEnabled	boolean	Property to enable and disable Remote Debug on ASEV3
properties.windowsOutboundIpAddresses	string[]
type	string	Resource type.

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.

HostingEnvironmentStatus

Current status of the App Service Environment.

Name	Type	Description
Deleting	string
Preparing	string
Ready	string
Scaling	string

LoadBalancingMode

Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.

Name	Type	Description
None	string
Publishing	string
Web	string
Web, Publishing	string

NameValuePair

Name value pair.

Name	Type	Description
name	string	Pair name.
value	string	Pair value.

ProvisioningState

Provisioning state of the App Service Environment.

Name	Type	Description
Canceled	string
Deleting	string
Failed	string
InProgress	string
Succeeded	string

UpgradeAvailability

Whether an upgrade is available for this App Service Environment.

Name	Type	Description
None	string	No upgrade is currently available for this App Service Environment
Ready	string	An upgrade is ready to be manually initiated on this App Service Environment

UpgradePreference

Upgrade Preference

Name	Type	Description
Early	string	This App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late'
Late	string	This App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early'
Manual	string	ASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically
None	string	No preference on when this App Service Environment will be upgraded

VirtualNetworkProfile

Specification for using a Virtual Network.

Name	Type	Description
id	string	Resource id of the Virtual Network.
name	string	Name of the Virtual Network (read-only).
subnet	string	Subnet within the Virtual Network.
type	string	Resource type of the Virtual Network (read-only).