az appservice ase
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 IP addresses associated with an App Service Environment. |
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. |
Core | GA |
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. |
Core | GA |
az appservice ase create
Create App Service Environment.
az appservice ase create --name
--resource-group
--subnet
[--ignore-subnet-size-validation {false, true}]
[--kind {ASEv3}]
[--location]
[--no-wait]
[--virtual-ip-type {External, Internal}]
[--vnet-name]
[--zone-redundant {false, true}]
Examples
Create resource group, Virtual Network and App Service Environment 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
Create external App Service Environments in existing resource group and Virtual Network.
az appservice ase create -n MyAseName -g MyResourceGroup --vnet-name MyVirtualNetwork \
--subnet MyAseSubnet --virtual-ip-type External
Create Virtual Network and App Service Environment 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
Create external zone redundant App Service Environment with default values.
az appservice ase create -n MyASEName -g ASEResourceGroup \
--vnet-name MyASEVirtualNetwork --subnet MyASESubnet \
--zone-redundant --virtual-ip-type External
Required Parameters
Name of the app service environment.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of existing subnet. To create vnet and/or subnet use az network vnet [subnet] create
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Do not check if subnet is sized according to recommendations.
Property | Value |
---|---|
Default value: | False |
Accepted values: | false, true |
Specify App Service Environment version.
Property | Value |
---|---|
Default value: | ASEv3 |
Accepted values: | ASEv3 |
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
Specify if app service environment should be accessible from internet.
Property | Value |
---|---|
Default value: | Internal |
Accepted values: | External, Internal |
Name of the vNet. Mandatory if only subnet name is specified.
Configure App Service Environment as Zone Redundant.
Property | Value |
---|---|
Accepted values: | false, true |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az appservice ase create-inbound-services
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 of the app service environment.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of existing subnet for DNS Zone link. To create vnet and/or subnet use az network vnet [subnet] create
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Argument 'skip_dns' has been deprecated and will be removed in version '3.0.0'.
Do not create Private DNS Zone and DNS records.
Property | Value |
---|---|
Default value: | False |
Accepted values: | false, true |
Name of the vNet. Mandatory if only subnet name is specified.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az appservice ase delete
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 of the app service environment.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az appservice ase list
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az appservice ase list-addresses
List IP addresses associated with an App Service Environment.
az appservice ase list-addresses --name
[--resource-group]
Examples
List IPs for an App Service Environment.
az appservice ase list-addresses --name MyAseName
Required Parameters
Name of the app service environment.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az appservice ase list-plans
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 of the app service environment.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az appservice ase send-test-notification
Send a test upgrade notification in App Service Environment.
az appservice ase send-test-notification --name
[--resource-group]
Examples
Send a test upgrade notification in App Service Environment.
az appservice ase send-test-notification -n MyAseName -g MyResourceGroup
Required Parameters
Name of the app service environment.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az appservice ase show
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 of the app service environment.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az appservice ase update
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}]
[--no-wait]
[--resource-group]
Examples
Update App Service Environment to allow new private endpoint connections.
az appservice ase update -n MyAseName -g MyResourceGroup --allow-new-private-endpoint-connections
Update App Service Environment to allow incoming ftp connections.
az appservice ase update -n MyAseName -g MyResourceGroup --allow-incoming-ftp-connections
Update App Service Environment to allow remote debugging.
az appservice ase update -n MyAseName -g MyResourceGroup --allow-remote-debugging
Required Parameters
Name of the app service environment.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
(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.
Property | Value |
---|---|
Accepted values: | false, true |
(ASEv3 only) Configure Apps in App Service Environment to allow new private endpoint connections.
Property | Value |
---|---|
Accepted values: | false, true |
(ASEv3 only) Configure App Service Environment to allow remote debugging. You will still have to configure remote debugging at the individual app level.
Property | Value |
---|---|
Accepted values: | false, true |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az appservice ase upgrade
Upgrade App Service Environment.
az appservice ase upgrade --name
[--no-wait]
[--resource-group]
[--yes]
Examples
Upgrade App Service Environment.
az appservice ase upgrade -n MyAseName -g MyResourceGroup
Required Parameters
Name of the app service environment.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |