az webapp config egress
This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage virtualized backend connections for a web app.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az webapp config egress connection |
Manage named connections in a web app's egress configuration. |
Core | Preview |
| az webapp config egress connection add |
Add or replace a named egress connection. |
Core | Preview |
| az webapp config egress connection remove |
Remove a named egress connection. |
Core | Preview |
| az webapp config egress connection show |
Show a named egress connection. |
Core | Preview |
| az webapp config egress set |
Set the enabled state of a web app's egress configuration. |
Core | Preview |
| az webapp config egress show |
Show the egress configuration for a web app. |
Core | Preview |
az webapp config egress set
Command group 'webapp config egress' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Set the enabled state of a web app's egress configuration.
Read the existing egress configuration, update its enabled state, and write it back while preserving all connections and their settings, identities, and credential injection configuration. --enabled is required. Use --enabled true to enable virtual connections or --enabled false to disable them. Add at least one connection with "az webapp config egress connection add" before enabling or disabling egress. Manage individual connections with "az webapp config egress connection add" and "az webapp config egress connection remove".
az webapp config egress set --enabled {false, true}
[--acquire-policy-token]
[--change-reference]
[--ids]
[--name]
[--resource-group]
[--slot]
[--subscription]
Examples
Enable virtual connections without modifying any connection definitions.
az webapp config egress set --resource-group MyRG --name MyApp --enabled true
Disable virtual connections for a deployment slot while preserving its connections.
az webapp config egress set --resource-group MyRG --name MyApp --slot staging --enabled false
Enable virtual connections using the flag without a value.
az webapp config egress set --resource-group MyRG --name MyApp --enabled
Required Parameters
Enable virtual connections with true or disable them with false.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
The name of the slot. Default to the productions slot if not specified.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az webapp config egress show
Command group 'webapp config egress' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Show the egress configuration for a web app.
az webapp config egress show [--ids]
[--name]
[--resource-group]
[--slot]
[--subscription]
Examples
Show the enabled state and all connections.
az webapp config egress show --resource-group MyRG --name MyApp
Show only the connections for a deployment slot.
az webapp config egress show --resource-group MyRG --name MyApp --slot staging --query properties.connections
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
The name of the slot. Default to the productions slot if not specified.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |