Share via

az webapp vnet-integration

  • Reference

Methods that list, add, and remove virtual network integrations from a webapp.

Commands

Name Description Type Status
az webapp vnet-integration add

Add a regional virtual network integration to a webapp.

 Core GA
az webapp vnet-integration list

List the virtual network integrations on a webapp.

 Core GA
az webapp vnet-integration remove

Remove a regional virtual network integration from webapp.

 Core GA

az webapp vnet-integration add

Add a regional virtual network integration to a webapp.

If there are multiple vnets of the same name across different resource groups, use vnet resource id to specify which vnet to use. If vnet name is used, by default, the vnet in the same resource group as the webapp will be used.

az webapp vnet-integration add --name
                               --resource-group
                               --subnet
                               --vnet
                               [--skip-delegation-check {false, true}]
                               [--slot]

Examples

Add a regional virtual network integration to a webapp

az webapp vnet-integration add -g MyResourceGroup -n MyWebapp --vnet MyVnetName --subnet MySubnetName -s [slot]

Add a regional virtual network integration to a webapp using vnet resource id

az webapp vnet-integration add -g MyResourceGroup -n MyWebapp --vnet /subscriptions/[SubscriptionId]/resourceGroups/[MyResourceGroup]/providers/Microsoft.Network/virtualNetworks/[MyVnetName] --subnet MySubnetName -s [slot]

Add a regional virtual network integration to a webapp using subnet resource id

az webapp vnet-integration add -g MyResourceGroup -n MyWebapp --vnet MyVnetName --subnet /subscriptions/[SubscriptionId]/resourceGroups/[MyResourceGroup]/providers/Microsoft.Network/virtualNetworks/[MyVnetName]/subnets/MySubnetName -s [slot]

Required Parameters

--name -n

Name of the web app. If left unspecified, a name will be randomly generated. You can configure the default using az configure --defaults web=<name>.

--resource-group -g

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

--subnet

The name or resource ID of the subnet.

--vnet

The name or resource ID of the Vnet.

Optional Parameters

--skip-delegation-check

Skip check if you do not have permission or the VNet is in another subscription.

Accepted values: false, true
Default value: False
--slot -s

The name of the slot. Default to the productions slot if not 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 webapp vnet-integration list

List the virtual network integrations on a webapp.

az webapp vnet-integration list --name
                                --resource-group
                                [--slot]

Examples

list the virtual network integrations on a webapp

az webapp vnet-integration list -g MyResourceGroup -n MyWebapp -s [slot]

Required Parameters

--name -n

Name of the web app. If left unspecified, a name will be randomly generated. You can configure the default using az configure --defaults web=<name>.

--resource-group -g

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

Optional Parameters

--slot -s

The name of the slot. Default to the productions slot if not 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 webapp vnet-integration remove

Remove a regional virtual network integration from webapp.

az webapp vnet-integration remove --name
                                  --resource-group
                                  [--slot]

Examples

remove a regional virtual network integration from webapp

az webapp vnet-integration remove -g MyResourceGroup -n MyWebapp -s [slot]

Required Parameters

--name -n

Name of the web app. If left unspecified, a name will be randomly generated. You can configure the default using az configure --defaults web=<name>.

--resource-group -g

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

Optional Parameters

--slot -s

The name of the slot. Default to the productions slot if not 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.