az appservice ase

Reference

Manage App Service Environments.

Commands

Name	Description	Type	Status
az appservice ase create	Create app service environment.	Core	GA
az appservice ase create-inbound-services	Private DNS Zone for Internal (ILB) App Service Environments.	Core	Preview
az appservice ase delete	Delete app service environment.	Core	GA
az appservice ase list	List app service environments.	Core	GA
az appservice ase list-addresses	List VIPs associated with an app service environment v2.	Core	GA
az appservice ase list-plans	List app service plans associated with an app service environment.	Core	GA
az appservice ase send-test-notification	Send a test upgrade notification in app service environment v3.	Core	Preview
az appservice ase show	Show details of an app service environment.	Core	GA
az appservice ase update	Update app service environment.	Core	GA
az appservice ase upgrade	Upgrade app service environment v3.	Core	Preview

az appservice ase create

Edit

Create app service environment.

az appservice ase create --name
                         --resource-group
                         --subnet
                         [--force-network-security-group {false, true}]
                         [--force-route-table {false, true}]
                         [--front-end-scale-factor]
                         [--front-end-sku {I1, I2, I3}]
                         [--ignore-network-security-group {false, true}]
                         [--ignore-route-table {false, true}]
                         [--ignore-subnet-size-validation {false, true}]
                         [--kind {ASEv2, ASEv3}]
                         [--location]
                         [--no-wait]
                         [--os-preference {Linux, Windows}]
                         [--virtual-ip-type {External, Internal}]
                         [--vnet-name]
                         [--zone-redundant {false, true}]

Examples

Create resource group, Virtual Network and App Service Environment v3 with default values.

az group create -g MyResourceGroup --location westeurope

az network vnet create -g MyResourceGroup -n MyVirtualNetwork \
  --address-prefixes 10.0.0.0/16 --subnet-name MyAseSubnet --subnet-prefixes 10.0.0.0/24

az appservice ase create -n MyAseName -g MyResourceGroup --vnet-name MyVirtualNetwork \
  --subnet MyAseSubnet --kind asev3

Create external App Service Environments v3 in existing resource group and Virtual Network.

az appservice ase create -n MyAseName -g MyResourceGroup --vnet-name MyVirtualNetwork \
  --subnet MyAseSubnet --virtual-ip-type External --kind asev3

Create Virtual Network and App Service Environment v3 in a smaller than recommended subnet in existing resource group.

az network vnet create -g MyResourceGroup -n MyVirtualNetwork \
  --address-prefixes 10.0.0.0/16 --subnet-name MyAseSubnet --subnet-prefixes 10.0.0.0/26

az appservice ase create -n MyAseName -g MyResourceGroup --vnet-name MyVirtualNetwork \
  --subnet MyAseSubnet --ignore-subnet-size-validation --kind asev3

Create external zone redundant App Service Environment v3 with default values.

az appservice ase create -n MyASEv3Name -g ASEv3ResourceGroup \
  --vnet-name MyASEv3VirtualNetwork --subnet MyASEv3Subnet --kind asev3 \
  --zone-redundant --virtual-ip-type External

Required Parameters

--name -n

Name of the app service environment.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subnet

Name or ID of existing subnet. To create vnet and/or subnet use az network vnet [subnet] create.

Optional Parameters

--force-network-security-group

Override network security group for subnet. Applies to ASEv2 only.

Accepted values: false, true

Default value: False

--force-route-table

Override route table for subnet. Applies to ASEv2 only.

Accepted values: false, true

Default value: False

--front-end-scale-factor

Scale of front ends to app service plan instance ratio. Applies to ASEv2 only.

Default value: 15

--front-end-sku

Size of front end servers. Applies to ASEv2 only.

Accepted values: I1, I2, I3

Default value: I1

--ignore-network-security-group

Configure network security group manually. Applies to ASEv2 only.

Accepted values: false, true

Default value: False

--ignore-route-table

Configure route table manually. Applies to ASEv2 only.

Accepted values: false, true

Default value: False

--ignore-subnet-size-validation

Do not check if subnet is sized according to recommendations.

Accepted values: false, true

Default value: False

--kind -k

Specify App Service Environment version.

Accepted values: ASEv2, ASEv3

Default value: ASEv3

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False

--os-preference

Determine if app service environment should start with Linux workers. Applies to ASEv2 only.

Accepted values: Linux, Windows

--virtual-ip-type

Specify if app service environment should be accessible from internet.

Accepted values: External, Internal

Default value: Internal

--vnet-name

Name of the vNet. Mandatory if only subnet name is specified.

--zone-redundant

Configure App Service Environment as Zone Redundant. Applies to ASEv3 only.

Accepted values: false, true

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az appservice ase create-inbound-services

Edit

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Private DNS Zone for Internal (ILB) App Service Environments.

az appservice ase create-inbound-services --name
                                          --resource-group
                                          --subnet
                                          [--skip-dns {false, true}]
                                          [--vnet-name]

Examples

Create Private DNS Zone and A records.

az appservice ase create-inbound-services -n MyASEName -g ASEResourceGroup \
  --vnet-name MyASEVirtualNetwork --subnet MyAseSubnet

Required Parameters

--name -n

Name of the app service environment.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subnet

Name or ID of existing subnet for DNS Zone link. To create vnet and/or subnet use az network vnet [subnet] create.

Optional Parameters

--skip-dns

Deprecated

Argument 'skip_dns' has been deprecated and will be removed in version '3.0.0'.

Do not create Private DNS Zone and DNS records.

Accepted values: false, true

Default value: False

--vnet-name

Name of the vNet. Mandatory if only subnet name is specified.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az appservice ase delete

Edit

Delete app service environment.

az appservice ase delete --name
                         [--no-wait]
                         [--resource-group]
                         [--yes]

Examples

Delete app service environment.

az appservice ase delete -n MyAseName

Required Parameters

--name -n

Name of the app service environment.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Default value: False

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az appservice ase list

Edit

List app service environments.

az appservice ase list [--resource-group]

Examples

List all app service environments in subscription.

az appservice ase list

List all app service environment in resource group.

az appservice ase list --resource-group MyResourceGroup

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az appservice ase list-addresses

Edit

List VIPs associated with an app service environment v2.

az appservice ase list-addresses --name
                                 [--resource-group]

Examples

List VIPs for an app service environments.

az appservice ase list-addresses --name MyAseName

Required Parameters

--name -n

Name of the app service environment.

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az appservice ase list-plans

Edit

List app service plans associated with an app service environment.

az appservice ase list-plans --name
                             [--resource-group]

Examples

List app service plans for an app service environments.

az appservice ase list-plans --name MyAseName

Required Parameters

--name -n

Name of the app service environment.

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az appservice ase send-test-notification

Edit

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Send a test upgrade notification in app service environment v3.

az appservice ase send-test-notification --name
                                         [--resource-group]

Examples

Send a test upgrade notification in app service environment v3.

az appservice ase send-test-notification -n MyAseV3Name -g MyResourceGroup

Required Parameters

--name -n

Name of the app service environment.

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az appservice ase show

Edit

Show details of an app service environment.

az appservice ase show --name
                       [--resource-group]

Examples

Show app service environment.

az appservice ase show --name MyAseName

Required Parameters

--name -n

Name of the app service environment.

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az appservice ase update

Edit

Update app service environment.

az appservice ase update --name
                         [--allow-incoming-ftp-connections {false, true}]
                         [--allow-new-private-endpoint-connections {false, true}]
                         [--allow-remote-debugging {false, true}]
                         [--front-end-scale-factor]
                         [--front-end-sku {I1, I2, I3}]
                         [--no-wait]
                         [--resource-group]

Examples

Update app service environment v2 with medium front-ends and scale factor of 10.

az appservice ase update -n MyAseV2Name -g MyResourceGroup --front-end-sku I2 \
  --front-end-scale-factor 10

Update app service environment v3 to allow new private endpoint connections.

az appservice ase update -n MyAseV3Name -g MyResourceGroup --allow-new-private-endpoint-connections

Update app service environment v3 to allow incoming ftp connections.

az appservice ase update -n MyAseV3Name -g MyResourceGroup --allow-incoming-ftp-connections

Update app service environment v3 to allow remote debugging.

az appservice ase update -n MyAseV3Name -g MyResourceGroup --allow-remote-debugging

Required Parameters

--name -n

Name of the app service environment.

Optional Parameters

--allow-incoming-ftp-connections -f

(ASEv3 only) Configure App Service Environment to allow FTP access. This ftpEnabled setting allows you to allow or deny FTP connections on the App Service Environment level. Individual apps will still need to configure FTP access.

Accepted values: false, true

--allow-new-private-endpoint-connections -p

(ASEv3 only) Configure Apps in App Service Environment to allow new private endpoint connections.

Accepted values: false, true

--allow-remote-debugging -r

(ASEv3 only) Configure App Service Environment to allow remote debugging. You will still have to configure remote debugging at the individual app level.

Accepted values: false, true

--front-end-scale-factor

(ASEv2 only) Scale of front ends to app service plan instance ratio between 5 and 15.

--front-end-sku

(ASEv2 only) Size of front end servers.

Accepted values: I1, I2, I3

--no-wait

Do not wait for the long-running operation to finish.

Default value: False

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az appservice ase upgrade

Edit

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Upgrade app service environment v3.

az appservice ase upgrade --name
                          [--no-wait]
                          [--resource-group]
                          [--yes]

Examples

Upgrade app service environment v3.

az appservice ase upgrade -n MyAseV3Name -g MyResourceGroup

Required Parameters

--name -n

Name of the app service environment.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Default value: False

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Share via

az appservice ase

Commands

az appservice ase create

Examples

Required Parameters

Optional Parameters

az appservice ase create-inbound-services

Examples

Required Parameters

Optional Parameters

az appservice ase delete

Examples

Required Parameters

Optional Parameters

az appservice ase list

Examples

Optional Parameters

az appservice ase list-addresses

Examples

Required Parameters

Optional Parameters

az appservice ase list-plans

Examples

Required Parameters

Optional Parameters

az appservice ase send-test-notification

Examples

Required Parameters

Optional Parameters

az appservice ase show

Examples

Required Parameters

Optional Parameters

az appservice ase update

Examples

Required Parameters

Optional Parameters

az appservice ase upgrade

Examples

Required Parameters

Optional Parameters

Additional resources