az webapp
Note
This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.
Manage web apps.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az webapp auth |
Manage webapp authentication and authorization. To use v2 auth commands, run "az extension add --name authV2" to add the authV2 CLI extension. |
Core and Extension | GA |
| az webapp auth-classic |
Manage webapp authentication and authorization in the classic format. |
Extension | GA |
| az webapp auth-classic show |
Show the authentication settings for the webapp in the classic format. |
Extension | GA |
| az webapp auth-classic update |
Update the authentication settings for the webapp in the classic format. |
Extension | GA |
| az webapp auth apple |
Manage webapp authentication and authorization of the Apple identity provider. |
Extension | GA |
| az webapp auth apple show |
Show the authentication settings for the Apple identity provider. |
Extension | GA |
| az webapp auth apple update |
Update the client id and client secret for the Apple identity provider. |
Extension | GA |
| az webapp auth config-version |
Manage the state of the configuration version for the authentication settings for the webapp. Configuration version v1 refers to the /authSettings endpoints whereas v2 refers to the /authSettingsV2 endpoints. |
Extension | GA |
| az webapp auth config-version revert |
Reverts the configuration version of the authentication settings for the webapp from v2 to v1 (classic). |
Extension | GA |
| az webapp auth config-version show |
Show the configuration version of the authentication settings for the webapp. Configuration version v1 refers to the /authSettings endpoints whereas v2 refers to the /authSettingsV2 endpoints. |
Extension | GA |
| az webapp auth config-version upgrade |
Upgrades the configuration version of the authentication settings for the webapp from v1 (classic) to v2. |
Extension | GA |
| az webapp auth facebook |
Manage webapp authentication and authorization of the Facebook identity provider. |
Extension | GA |
| az webapp auth facebook show |
Show the authentication settings for the Facebook identity provider. |
Extension | GA |
| az webapp auth facebook update |
Update the app id and app secret for the Facebook identity provider. |
Extension | GA |
| az webapp auth github |
Manage webapp authentication and authorization of the GitHub identity provider. |
Extension | GA |
| az webapp auth github show |
Show the authentication settings for the GitHub identity provider. |
Extension | GA |
| az webapp auth github update |
Update the client id and client secret for the GitHub identity provider. |
Extension | GA |
| az webapp auth google |
Manage webapp authentication and authorization of the Google identity provider. |
Extension | GA |
| az webapp auth google show |
Show the authentication settings for the Google identity provider. |
Extension | GA |
| az webapp auth google update |
Update the client id and client secret for the Google identity provider. |
Extension | GA |
| az webapp auth microsoft |
Manage webapp authentication and authorization of the Microsoft identity provider. |
Extension | GA |
| az webapp auth microsoft show |
Show the authentication settings for the Azure Active Directory identity provider. |
Extension | GA |
| az webapp auth microsoft update |
Update the client id and client secret for the Azure Active Directory identity provider. |
Extension | GA |
| az webapp auth openid-connect |
Manage webapp authentication and authorization of the custom OpenID Connect identity providers. |
Extension | GA |
| az webapp auth openid-connect add |
Configure a new custom OpenID Connect identity provider. |
Extension | GA |
| az webapp auth openid-connect remove |
Removes an existing custom OpenID Connect identity provider. |
Extension | GA |
| az webapp auth openid-connect show |
Show the authentication settings for the custom OpenID Connect identity provider. |
Extension | GA |
| az webapp auth openid-connect update |
Update the client id and client secret setting name for an existing custom OpenID Connect identity provider. |
Extension | GA |
| az webapp auth set |
Sets the authentication settings for the webapp in the v2 format, overwriting any existing settings. |
Extension | GA |
| az webapp auth show |
Show the authentification settings for the webapp. |
Core | GA |
| az webapp auth show (authV2 extension) |
Show the authentication settings for the webapp in the v2 format. |
Extension | GA |
| az webapp auth twitter |
Manage webapp authentication and authorization of the Twitter identity provider. |
Extension | GA |
| az webapp auth twitter show |
Show the authentication settings for the Twitter identity provider. |
Extension | GA |
| az webapp auth twitter update |
Update the consumer key and consumer secret for the Twitter identity provider. |
Extension | GA |
| az webapp auth update |
Update the authentication settings for the webapp. |
Core | GA |
| az webapp auth update (authV2 extension) |
Update the authentication settings for the webapp in the v2 format. |
Extension | GA |
| az webapp browse |
Open a web app in a browser. This is not supported in Azure Cloud Shell. |
Core | GA |
| az webapp config |
Configure a web app. |
Core | GA |
| az webapp config access-restriction |
Methods that show, set, add, and remove access restrictions on a webapp. |
Core | GA |
| az webapp config access-restriction add |
Adds an Access Restriction to the webapp. |
Core | GA |
| az webapp config access-restriction remove |
Removes an Access Restriction from the webapp. |
Core | GA |
| az webapp config access-restriction set |
Sets if SCM site is using the same restrictions as the main site and default actions. |
Core | GA |
| az webapp config access-restriction show |
Show Access Restriction settings for webapp. |
Core | GA |
| az webapp config appsettings |
Configure web app settings. Updating or removing application settings will cause an app recycle. |
Core | GA |
| az webapp config appsettings delete |
Delete web app settings. |
Core | GA |
| az webapp config appsettings list |
Get the details of a web app's settings. |
Core | GA |
| az webapp config appsettings set |
Set a web app's settings. |
Core | GA |
| az webapp config backup |
Manage backups for web apps. |
Core | GA |
| az webapp config backup create |
Create a backup of a web app. |
Core | GA |
| az webapp config backup delete |
Delete a web app backup. |
Core | GA |
| az webapp config backup list |
List backups of a web app. |
Core | GA |
| az webapp config backup restore |
Restore a web app from a backup. |
Core | GA |
| az webapp config backup show |
Show the backup schedule for a web app. |
Core | GA |
| az webapp config backup update |
Configure a new backup schedule for a web app. |
Core | GA |
| az webapp config connection-string |
Manage a web app's connection strings. |
Core | GA |
| az webapp config connection-string delete |
Delete a web app's connection strings. |
Core | GA |
| az webapp config connection-string list |
Get a web app's connection strings. |
Core | GA |
| az webapp config connection-string set |
Update a web app's connection strings. |
Core | GA |
| az webapp config container |
Manage an existing web app's container settings. |
Core | GA |
| az webapp config container delete |
Delete an existing web app's container settings. |
Core | GA |
| az webapp config container set |
Set an existing web app's container settings. |
Core | GA |
| az webapp config container show |
Get details of a web app's container settings. |
Core | GA |
| az webapp config egress |
Manage virtualized backend connections for a web app. |
Core | Preview |
| 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 hostname |
Configure hostnames for a web app. |
Core | GA |
| az webapp config hostname add |
Bind a hostname to a web app. |
Core | GA |
| az webapp config hostname delete |
Unbind a hostname from a web app. |
Core | GA |
| az webapp config hostname get-external-ip |
Get the external-facing IP address for a web app. |
Core | GA |
| az webapp config hostname list |
List all hostname bindings for a web app. |
Core | GA |
| az webapp config set |
Set a web app's configuration. |
Core | GA |
| az webapp config show |
Get the details of a web app's configuration. |
Core | GA |
| az webapp config snapshot |
Manage web app snapshots. |
Core | GA |
| az webapp config snapshot list |
List the restorable snapshots for a web app. |
Core | GA |
| az webapp config snapshot restore |
Restore a web app snapshot. |
Core | GA |
| az webapp config ssl |
Configure SSL certificates for web apps. |
Core | GA |
| az webapp config ssl bind |
Bind an SSL certificate to a web app. |
Core | GA |
| az webapp config ssl create |
Create a Managed Certificate for a hostname in a webapp app. |
Core | Preview |
| az webapp config ssl delete |
Delete an SSL certificate from a web app. |
Core | GA |
| az webapp config ssl import |
Import an SSL or App Service Certificate to a web app from Key Vault. |
Core | GA |
| az webapp config ssl list |
List SSL certificates for a web app. |
Core | GA |
| az webapp config ssl show |
Show the details of an SSL certificate for a web app. |
Core | GA |
| az webapp config ssl unbind |
Unbind an SSL certificate from a web app. |
Core | GA |
| az webapp config ssl upload |
Upload an SSL certificate to a web app. |
Core | GA |
| az webapp config storage-account |
Manage a web app's Azure storage account configurations. |
Core | GA |
| az webapp config storage-account add |
Add an Azure storage account configuration to a web app. |
Core | GA |
| az webapp config storage-account delete |
Delete a web app's Azure storage account configuration. |
Core | GA |
| az webapp config storage-account list |
Get a web app's Azure storage account configurations. |
Core | GA |
| az webapp config storage-account update |
Update an existing Azure storage account configuration on a web app. |
Core | GA |
| az webapp connection |
Commands to manage webapp connections. |
Core and Extension | GA |
| az webapp connection create |
Create a connection between a webapp and a target resource. |
Core and Extension | GA |
| az webapp connection create app-insights |
Create a webapp connection to app-insights. |
Core | GA |
| az webapp connection create appconfig |
Create a webapp connection to appconfig. |
Core | GA |
| az webapp connection create cognitiveservices |
Create a webapp connection to cognitiveservices. |
Core | GA |
| az webapp connection create confluent-cloud |
Create a webapp connection to confluent-cloud. |
Core | GA |
| az webapp connection create cosmos-cassandra |
Create a webapp connection to cosmos-cassandra. |
Core | GA |
| az webapp connection create cosmos-gremlin |
Create a webapp connection to cosmos-gremlin. |
Core | GA |
| az webapp connection create cosmos-mongo |
Create a webapp connection to cosmos-mongo. |
Core | GA |
| az webapp connection create cosmos-sql |
Create a webapp connection to cosmos-sql. |
Core | GA |
| az webapp connection create cosmos-table |
Create a webapp connection to cosmos-table. |
Core | GA |
| az webapp connection create eventhub |
Create a webapp connection to eventhub. |
Core | GA |
| az webapp connection create fabric-sql |
Create a webapp connection to fabric-sql. |
Core | GA |
| az webapp connection create fabric-sql (serviceconnector-passwordless extension) |
Create a webapp connection to fabric-sql. |
Extension | GA |
| az webapp connection create keyvault |
Create a webapp connection to keyvault. |
Core | GA |
| az webapp connection create mongodb-atlas |
Create a webapp connection to mongodb-atlas. |
Core | GA |
| az webapp connection create mysql |
Create a webapp connection to mysql. |
Core | Deprecated |
| az webapp connection create mysql-flexible |
Create a webapp connection to mysql-flexible. |
Core | GA |
| az webapp connection create mysql-flexible (serviceconnector-passwordless extension) |
Create a webapp connection to mysql-flexible. |
Extension | GA |
| az webapp connection create neon-postgres |
Create a webapp connection to neon-postgres. |
Core | GA |
| az webapp connection create postgres |
Create a webapp connection to postgres. |
Core | Deprecated |
| az webapp connection create postgres-flexible |
Create a webapp connection to postgres-flexible. |
Core | GA |
| az webapp connection create postgres-flexible (serviceconnector-passwordless extension) |
Create a webapp connection to postgres-flexible. |
Extension | GA |
| az webapp connection create redis |
Create a webapp connection to redis. |
Core | GA |
| az webapp connection create redis-enterprise |
Create a webapp connection to redis-enterprise. |
Core | GA |
| az webapp connection create servicebus |
Create a webapp connection to servicebus. |
Core | GA |
| az webapp connection create signalr |
Create a webapp connection to signalr. |
Core | GA |
| az webapp connection create sql |
Create a webapp connection to sql. |
Core | GA |
| az webapp connection create sql (serviceconnector-passwordless extension) |
Create a webapp connection to sql. |
Extension | GA |
| az webapp connection create storage-blob |
Create a webapp connection to storage-blob. |
Core | GA |
| az webapp connection create storage-file |
Create a webapp connection to storage-file. |
Core | GA |
| az webapp connection create storage-queue |
Create a webapp connection to storage-queue. |
Core | GA |
| az webapp connection create storage-table |
Create a webapp connection to storage-table. |
Core | GA |
| az webapp connection create webpubsub |
Create a webapp connection to webpubsub. |
Core | GA |
| az webapp connection delete |
Delete a webapp connection. |
Core | GA |
| az webapp connection list |
List connections of a webapp. |
Core | GA |
| az webapp connection list-configuration |
List source configurations of a webapp connection. |
Core | GA |
| az webapp connection list-support-types |
List client types and auth types supported by webapp connections. |
Core | GA |
| az webapp connection show |
Get the details of a webapp connection. |
Core | GA |
| az webapp connection update |
Update a webapp connection. |
Core | GA |
| az webapp connection update app-insights |
Update a webapp to app-insights connection. |
Core | GA |
| az webapp connection update appconfig |
Update a webapp to appconfig connection. |
Core | GA |
| az webapp connection update cognitiveservices |
Update a webapp to cognitiveservices connection. |
Core | GA |
| az webapp connection update confluent-cloud |
Update a webapp to confluent-cloud connection. |
Core | GA |
| az webapp connection update cosmos-cassandra |
Update a webapp to cosmos-cassandra connection. |
Core | GA |
| az webapp connection update cosmos-gremlin |
Update a webapp to cosmos-gremlin connection. |
Core | GA |
| az webapp connection update cosmos-mongo |
Update a webapp to cosmos-mongo connection. |
Core | GA |
| az webapp connection update cosmos-sql |
Update a webapp to cosmos-sql connection. |
Core | GA |
| az webapp connection update cosmos-table |
Update a webapp to cosmos-table connection. |
Core | GA |
| az webapp connection update eventhub |
Update a webapp to eventhub connection. |
Core | GA |
| az webapp connection update fabric-sql |
Update a webapp to fabric-sql connection. |
Core | GA |
| az webapp connection update keyvault |
Update a webapp to keyvault connection. |
Core | GA |
| az webapp connection update mongodb-atlas |
Update a webapp to mongodb-atlas connection. |
Core | GA |
| az webapp connection update mysql |
Update a webapp to mysql connection. |
Core | Deprecated |
| az webapp connection update mysql-flexible |
Update a webapp to mysql-flexible connection. |
Core | GA |
| az webapp connection update neon-postgres |
Update a webapp to neon-postgres connection. |
Core | GA |
| az webapp connection update postgres |
Update a webapp to postgres connection. |
Core | Deprecated |
| az webapp connection update postgres-flexible |
Update a webapp to postgres-flexible connection. |
Core | GA |
| az webapp connection update redis |
Update a webapp to redis connection. |
Core | GA |
| az webapp connection update redis-enterprise |
Update a webapp to redis-enterprise connection. |
Core | GA |
| az webapp connection update servicebus |
Update a webapp to servicebus connection. |
Core | GA |
| az webapp connection update signalr |
Update a webapp to signalr connection. |
Core | GA |
| az webapp connection update sql |
Update a webapp to sql connection. |
Core | GA |
| az webapp connection update storage-blob |
Update a webapp to storage-blob connection. |
Core | GA |
| az webapp connection update storage-file |
Update a webapp to storage-file connection. |
Core | GA |
| az webapp connection update storage-queue |
Update a webapp to storage-queue connection. |
Core | GA |
| az webapp connection update storage-table |
Update a webapp to storage-table connection. |
Core | GA |
| az webapp connection update webpubsub |
Update a webapp to webpubsub connection. |
Core | GA |
| az webapp connection validate |
Validate a webapp connection. |
Core | GA |
| az webapp connection wait |
Place the CLI in a waiting state until a condition of the connection is met. |
Core | GA |
| az webapp cors |
Manage Cross-Origin Resource Sharing (CORS). |
Core | GA |
| az webapp cors add |
Add allowed origins. |
Core | GA |
| az webapp cors remove |
Remove allowed origins. |
Core | GA |
| az webapp cors show |
Show allowed origins. |
Core | GA |
| az webapp create |
Create a web app. |
Core | GA |
| az webapp create-remote-connection |
Creates a remote connection using a tcp tunnel to your web app. |
Core | GA |
| az webapp delete |
Delete a web app. |
Core | GA |
| az webapp deleted |
Manage deleted web apps. |
Core | Preview |
| az webapp deleted list |
List web apps that have been deleted. |
Core | Preview |
| az webapp deleted restore |
Restore a deleted web app. |
Core | Preview |
| az webapp deploy |
Deploys a provided artifact to Azure Web Apps. |
Core | GA |
| az webapp deployment |
Manage web app deployments. |
Core | GA |
| az webapp deployment container |
Manage container-based continuous deployment. |
Core | GA |
| az webapp deployment container config |
Configure continuous deployment via containers. |
Core | GA |
| az webapp deployment container show-cd-url |
Get the URL which can be used to configure webhooks for continuous deployment. Requires SCM Basic Auth Publishing Credentials to be enabled. |
Core | GA |
| az webapp deployment github-actions |
Configure GitHub Actions for a webapp. |
Core | GA |
| az webapp deployment github-actions add |
Add a GitHub Actions workflow file to the specified repository. The workflow will build and deploy your app to the specified webapp. |
Core | GA |
| az webapp deployment github-actions remove |
Remove and disconnect the GitHub Actions workflow file from the specified repository. |
Core | GA |
| az webapp deployment list-publishing-credentials |
Get the details for available web app publishing credentials. |
Core | GA |
| az webapp deployment list-publishing-profiles |
Get the details for available web app deployment profiles. |
Core | GA |
| az webapp deployment slot |
Manage web app deployment slots. |
Core | GA |
| az webapp deployment slot auto-swap |
Configure deployment slot auto swap. |
Core | GA |
| az webapp deployment slot create |
Create a deployment slot. |
Core | GA |
| az webapp deployment slot delete |
Delete a deployment slot. |
Core | GA |
| az webapp deployment slot list |
List all deployment slots. |
Core | GA |
| az webapp deployment slot swap |
Swap deployment slots for a web app. |
Core | GA |
| az webapp deployment source |
Manage web app deployment via source control. |
Core | GA |
| az webapp deployment source config |
Manage deployment from git or Mercurial repositories. |
Core | GA |
| az webapp deployment source config-local-git |
Get a URL for a git repository endpoint to clone and push to for web app deployment. |
Core | GA |
| az webapp deployment source delete |
Delete a source control deployment configuration. |
Core | GA |
| az webapp deployment source show |
Get the details of a source control deployment configuration. |
Core | GA |
| az webapp deployment source sync |
Synchronize from the repository. Only needed under manual integration mode. |
Core | GA |
| az webapp deployment source update-token |
Update source control token cached in Azure app service. |
Core | GA |
| az webapp deployment user |
Manage user credentials for deployment. |
Core | GA |
| az webapp deployment user set |
Update deployment credentials. |
Core | GA |
| az webapp deployment user show |
Get deployment publishing user. |
Core | GA |
| az webapp exec |
Open an interactive shell session or run a command in a Linux web app container. |
Core | Preview |
| az webapp hybrid-connection |
Methods that list, add and remove hybrid-connections from webapps. |
Core | GA |
| az webapp hybrid-connection add |
Add an existing hybrid-connection to a webapp. |
Core | GA |
| az webapp hybrid-connection list |
List the hybrid-connections on a webapp. |
Core | GA |
| az webapp hybrid-connection remove |
Remove a hybrid-connection from a webapp. |
Core | GA |
| az webapp identity |
Manage web app's managed identity. |
Core | GA |
| az webapp identity assign |
Assign managed identity to the web app. |
Core | GA |
| az webapp identity remove |
Disable web app's managed identity. |
Core | GA |
| az webapp identity show |
Display web app's managed identity. |
Core | GA |
| az webapp last-known-good |
Manage a web app's last known good configuration. |
Core | Preview |
| az webapp last-known-good list |
List the last known good configurations of a web app. |
Core | Preview |
| az webapp last-known-good mark |
Mark the latest ready revision of a web app as last known good. |
Core | Preview |
| az webapp last-known-good show |
Show the default last known good configuration of a web app. |
Core | Preview |
| az webapp list |
List web apps. |
Core | GA |
| az webapp list-instances |
List all scaled out instances of a web app or web app slot. |
Core | GA |
| az webapp list-runtimes |
List available built-in stacks which can be used for web apps. |
Core | GA |
| az webapp log |
Manage web app logs. |
Core | GA |
| az webapp log config |
Configure logging for a web app. |
Core | GA |
| az webapp log deployment |
Manage web app deployment logs. |
Core | GA |
| az webapp log deployment list |
List deployments associated with web app. |
Core | GA |
| az webapp log deployment show |
Show deployment logs of the latest deployment, or a specific deployment if deployment-id is specified. |
Core | GA |
| az webapp log download |
Download a web app's log history as a zip file. |
Core | GA |
| az webapp log show |
Get the details of a web app's logging configuration. |
Core | GA |
| az webapp log startup |
View web app container startup logs. |
Core | Preview |
| az webapp log startup list |
List all container startup log files for a web app. |
Core | Preview |
| az webapp log startup show |
Show the content of a container startup log. |
Core | Preview |
| az webapp log tail |
Start live log tracing for a web app. |
Core | GA |
| az webapp managed-traffic |
Manage a web app's Active Backup traffic configuration. |
Core | Preview |
| az webapp managed-traffic list |
List the managed traffic configurations of a web app. |
Core | Preview |
| az webapp managed-traffic show |
Show the default managed traffic configuration of a web app. |
Core | Preview |
| az webapp managed-traffic update |
Update the default managed traffic configuration of a web app. |
Core | Preview |
| az webapp restart |
Restart a web app. |
Core | GA |
| az webapp scan |
Holds group of commands which cater to webapp scans. Currently available only for Linux based webapps. |
Extension | GA |
| az webapp scan list-result |
Get details of all scans conducted on webapp, upto max scan limit set on the webapp This will get you the scan log results in addition to the scan status of each scan conducted on the webapp. |
Extension | GA |
| az webapp scan show-result |
Get results of specified scan-id. This will fetch you the Scan log results of the specified scan-id. |
Extension | GA |
| az webapp scan start |
Starts the scan on the specified webapp files in the wwwroot directory. It returns a JSON containing the ScanID, traking and results URL. |
Extension | GA |
| az webapp scan stop |
Stops the current executing scan. Does nothing if no scan is executing. |
Extension | GA |
| az webapp scan track |
Track status of scan by providing scan-id. You can track the status of the scan from [Starting, Success, Failed, TimeoutFailure, Executing]. |
Extension | GA |
| az webapp secure-build |
Review open source vulnerabilities in a web app's packages. |
Core | Preview |
| az webapp secure-build show |
Show the Secure Build report for the active deployment of a Linux web app. |
Core | Preview |
| az webapp show |
Get the details of a web app. |
Core | GA |
| az webapp silo |
Manage Active Backup silos for a web app. |
Core | Preview |
| az webapp silo create |
Create a web app silo. |
Core | Preview |
| az webapp silo delete |
Delete a web app silo. |
Core | Preview |
| az webapp silo list |
List the silos of a web app. |
Core | Preview |
| az webapp silo refresh |
Refresh the silos of the primary web app. |
Core | Preview |
| az webapp silo show |
Show a web app silo. |
Core | Preview |
| az webapp silo update |
Update a web app silo. |
Core | Preview |
| az webapp silo vnet-integration |
Manage a web app silo's virtual network connection. |
Core | Preview |
| az webapp silo vnet-integration add |
Add a virtual network connection to a web app silo. |
Core | Preview |
| az webapp silo vnet-integration remove |
Remove the virtual network connection of a web app silo. |
Core | Preview |
| az webapp silo vnet-integration show |
Show the virtual network connection of a web app silo. |
Core | Preview |
| az webapp silo vnet-integration update |
Update a web app silo's virtual network connection using PATCH. |
Core | Preview |
| az webapp silo wait |
Wait for a web app silo to satisfy a condition. |
Core | Preview |
| az webapp sitecontainers |
Manage linux web apps sitecontainers. |
Core | GA |
| az webapp sitecontainers convert |
Convert a webapp from sitecontainers to a classic custom container and vice versa. Supports both single-container (DOCKER|) and multi-container (COMPOSE|) apps. |
Core | GA |
| az webapp sitecontainers create |
Create sitecontainers for a linux webapp. |
Core | GA |
| az webapp sitecontainers delete |
Delete a sitecontainer for a linux webapp. |
Core | GA |
| az webapp sitecontainers list |
List all the sitecontainers for a linux webapp. |
Core | GA |
| az webapp sitecontainers log |
Get the logs of a sitecontainer for a linux webapp. |
Core | GA |
| az webapp sitecontainers show |
List the details of a sitecontainer for a linux webapp. |
Core | GA |
| az webapp sitecontainers status |
Get the status of a sitecontainer for a linux webapp. |
Core | GA |
| az webapp sitecontainers update |
Update an existing sitecontainer for a linux webapp. |
Core | GA |
| az webapp ssh |
SSH command establishes a ssh session to the web container and developer would get a shell terminal remotely. |
Core | Preview |
| az webapp start |
Start a web app. |
Core | GA |
| az webapp stop |
Stop a web app. |
Core | GA |
| az webapp traffic-routing |
Manage traffic routing for web apps. |
Core | GA |
| az webapp traffic-routing clear |
Clear the routing rules and send all traffic to production. |
Core | GA |
| az webapp traffic-routing set |
Configure routing traffic to deployment slots. |
Core | GA |
| az webapp traffic-routing show |
Display the current distribution of traffic across slots. |
Core | GA |
| az webapp troubleshoot |
Diagnose common Linux web app problems. |
Core | Preview |
| az webapp troubleshoot collect |
Collect diagnostic artifacts from a Linux web app. |
Core | Preview |
| az webapp troubleshoot collect network-capture |
Collect and analyze a packet capture from a Linux web app container. |
Core | Preview |
| az webapp troubleshoot config |
Validate configuration for a Linux web app and surface a recent runtime error. |
Core | Preview |
| az webapp troubleshoot deployment |
Show the latest deployment state and diagnostic information for a Linux web app. |
Core | Preview |
| az webapp troubleshoot status |
Show site runtime status and recent startup summary for a Linux web app. |
Core | Preview |
| az webapp up |
Deprecated command. |
Core | GA |
| az webapp update |
Update an existing web app. |
Core | GA |
| az webapp vnet-integration |
Methods that list, add, and remove virtual network integrations from a webapp. |
Core | GA |
| 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 webjob |
Allows management operations for webjobs on a web app. |
Core | GA |
| az webapp webjob continuous |
Allows management operations of continuous webjobs on a web app. |
Core | GA |
| az webapp webjob continuous list |
List all continuous webjobs on a selected web app. |
Core | GA |
| az webapp webjob continuous remove |
Delete a specific continuous webjob. |
Core | GA |
| az webapp webjob continuous start |
Start a specific continuous webjob on a selected web app. |
Core | GA |
| az webapp webjob continuous stop |
Stop a specific continuous webjob. |
Core | GA |
| az webapp webjob triggered |
Allows management operations of triggered webjobs on a web app. |
Core | GA |
| az webapp webjob triggered list |
List all triggered webjobs hosted on a web app. |
Core | GA |
| az webapp webjob triggered log |
Get history of a specific triggered webjob hosted on a web app. |
Core | GA |
| az webapp webjob triggered remove |
Delete a specific triggered webjob hosted on a web app. |
Core | GA |
| az webapp webjob triggered run |
Run a specific triggered webjob hosted on a web app. |
Core | GA |
az webapp browse
Open a web app in a browser. This is not supported in Azure Cloud Shell.
az webapp browse [--acquire-policy-token]
[--change-reference]
[--ids]
[--logs]
[--name]
[--resource-group]
[--slot]
[--subscription]
Examples
Open a web app in a browser. (autogenerated)
az webapp browse --name MyWebapp --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.
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 |
Enable viewing the log stream immediately after launching the web app.
| Property | Value |
|---|---|
| Default value: | False |
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 create
Create a web app.
The web app's name must be able to produce a unique FQDN as AppName.azurewebsites.net.
This command creates the web app resource but does not deploy code. Use 'az webapp list-runtimes' to see available runtimes.
Suggested next steps after creation:
- Deploy your code: az webapp deploy -g MyResourceGroup -n MyAppName --src-path app.zip
- For Linux apps loading large models or dependencies at startup, increase the container start time limit (default 230s, max 1800s): az webapp config appsettings set -g MyResourceGroup -n MyAppName --settings WEBSITES_CONTAINER_START_TIME_LIMIT=1800.
az webapp create --name
--plan
--resource-group
[--acquire-policy-token]
[--acr-identity]
[--acr-use-identity]
[--assign-identity]
[--basic-auth {Disabled, Enabled}]
[--change-reference]
[--container-image-name]
[--container-registry-password]
[--container-registry-url]
[--container-registry-user]
[--deployment-container-image-name]
[--deployment-local-git]
[--deployment-source-branch]
[--deployment-source-url]
[--docker-registry-server-password]
[--docker-registry-server-user]
[--domain-name-scope {NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse}]
[--end-to-end-encryption-enabled {false, true}]
[--enriched-errors {false, true}]
[--https-only {false, true}]
[--min-tls-cipher-suite]
[--min-tls-version]
[--multicontainer-config-file]
[--multicontainer-config-type {COMPOSE, KUBE}]
[--public-network-access {Disabled, Enabled}]
[--role]
[--runtime]
[--scope]
[--site-scoped-certs {false, true}]
[--sitecontainers-app {false, true}]
[--startup-file]
[--subnet]
[--tags]
[--vnet]
Examples
Create a web app with the default configuration.
az webapp create -g MyResourceGroup -p MyPlan -n MyUniqueAppName
Create a web app with a Java 21 runtime.
az webapp create -g MyResourceGroup -p MyPlan -n MyUniqueAppName --runtime "JAVA:21-java21"
Create a web app with a NodeJS 20 runtime and deployed from a local git repository.
az webapp create -g MyResourceGroup -p MyPlan -n MyUniqueAppName --runtime "node:20LTS" --deployment-local-git
Create a web app with both SCM and FTP Basic Auth Publishing Credentials disabled.
az webapp create -g MyResourceGroup -p MyPlan -n MyUniqueAppName --basic-auth Disabled
Create a web app which supports sitecontainers.
az webapp create -g MyResourceGroup -p MyPlan -n MyUniqueAppName --sitecontainers-app
Create a web app with an image from DockerHub.
az webapp create -g MyResourceGroup -p MyPlan -n MyUniqueAppName -i nginx
Create a web app with an image from a private DockerHub registry.
az webapp create -g MyResourceGroup -p MyPlan -n MyUniqueAppName -i MyImageName -s username -w password
Create a web app with an image from a private Azure Container Registry.
az webapp create -g MyResourceGroup -p MyPlan -n MyUniqueAppName -i myregistry.azurecr.io/docker-image:tag
create a WebApp using shared App Service Plan that is in a different resource group.
AppServicePlanID=$(az appservice plan show -n SharedAppServicePlan -g MyASPRG --query "id" --out tsv) az webapp create -g MyResourceGroup -p "$AppServicePlanID" -n MyUniqueAppName
Create a container webapp with an image pulled from a private Azure Container Registry using a User Assigned Managed Identity
az webapp create -g MyResourceGroup -p MyPlan -n MyUniqueAppName --container-image-name myregistry.azurecr.io/docker-image:tag --assign-identity MyAssignIdentities --acr-use-identity --acr-identity MyUserAssignedIdentityResourceId
Create a web app with end-to-end encryption enabled and minimum TLS version 1.2
az webapp create -g MyResourceGroup -p MyPlan -n MyUniqueAppName --end-to-end-encryption-enabled true --min-tls-version 1.2
Create a Linux Python web app with a custom startup command.
az webapp create -g MyResourceGroup -p MyLinuxPlan -n MyUniqueAppName --runtime "PYTHON:3.14" --startup-file "gunicorn --bind=0.0.0.0 app:app"
Create a Linux Python web app with a startup script.
az webapp create -g MyResourceGroup -p MyLinuxPlan -n MyUniqueAppName --runtime "PYTHON:3.14" --startup-file "startup.sh"
Required Parameters
Name of the new web app. Web app name can contain only allow alphanumeric characters and hyphens, it cannot start or end in a hyphen, and must be less than 64 characters.
Name or resource id of the app service plan. Use 'appservice plan create' to get one.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
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 |
Accept system or user assigned identity which will be set for acr image pull. Use '[system]' to refer system assigned identity, or a resource id to refer user assigned identity.
Enable or disable pull image from acr use managed identity.
| Property | Value |
|---|---|
| Default value: | False |
Accept system or user assigned identities separated by spaces. Use '[system]' to refer system assigned identity, or a resource id to refer user assigned identity. Check out help for more examples.
Enable or disable basic auth for both SCM and FTP Basic Auth Publishing Credentials. Disabled by default for new apps. See https://aka.ms/app-service-basic-auth to learn more.
| Property | Value |
|---|---|
| Accepted values: | Disabled, Enabled |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The container custom image name and optionally the tag name (e.g., <registry-name>/<image-name>:<tag>). Note: if --container-registry-url is also provided, use <image-name>:<tag> without the registry name.
The container registry server password. Required for private registries.
The container registry server url.
The container registry server username.
Option '--deployment-container-image-name' has been deprecated and will be removed in a future release.
Container image name from container registry, e.g. publisher/image-name:tag.
Enable local git.
The branch to deploy.
| Property | Value |
|---|---|
| Default value: | master |
Git repository URL to link with manual integration.
Option '--docker-registry-server-password' has been deprecated and will be removed in a future release. Use '--container-registry-password' instead.
The container registry server password. Required for private registries.
Option '--docker-registry-server-user' has been deprecated and will be removed in a future release. Use '--container-registry-user' instead.
The container registry server username.
Specify the scope of uniqueness for the default hostname during resource creation.
| Property | Value |
|---|---|
| Accepted values: | NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse |
Enable or disable end-to-end encryption between the Front End and the Workers.
| Property | Value |
|---|---|
| Accepted values: | false, true |
If true, Linux web app creation failures will show context-enriched diagnostics with error codes, suggested fixes, and Copilot prompts. This flag only applies to Linux apps.
| Property | Value |
|---|---|
| Default value: | False |
| Accepted values: | false, true |
Redirect all traffic made to an app using HTTP to HTTPS.
| Property | Value |
|---|---|
| Default value: | False |
| Accepted values: | false, true |
The minimum TLS Cipher Suite required for requests, e.g., 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384'.
The minimum version of TLS required for SSL requests, e.g., '1.0', '1.1', '1.2'.
Linux only. Config file for multicontainer apps. (local or remote).
Linux only.
| Property | Value |
|---|---|
| Accepted values: | COMPOSE, KUBE |
Enable or disable public access to the web app.
| Property | Value |
|---|---|
| Accepted values: | Disabled, Enabled |
Role name or id the system assigned identity will have.
| Property | Value |
|---|---|
| Default value: | Contributor |
Canonicalized web runtime in the format of Framework:Version, e.g. "PYTHON:3.14".Use az webapp list-runtimes for available list.
Scope that the system assigned identity can access.
Enable or disable site-scoped certificates.
| Property | Value |
|---|---|
| Accepted values: | false, true |
If true, a webapp which supports sitecontainers will be created.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Linux only. The web's startup command or script file. Required for FastAPI and other ASGI frameworks (auto-detection is not supported). Example command: "gunicorn --bind=0.0.0.0 --timeout 600 app:app". Example for FastAPI: "gunicorn -k uvicorn.workers.UvicornWorker app:app". Example script file: "startup.sh".
Name or resource ID of the pre-existing subnet to have the webapp join. The --vnet is argument also needed if specifying subnet by name.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Name or resource ID of the regional virtual network. 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. Must be used with --subnet argument.
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 webapp create-remote-connection
Creates a remote connection using a tcp tunnel to your web app.
az webapp create-remote-connection [--acquire-policy-token]
[--change-reference]
[--ids]
[--instance]
[--name]
[--port]
[--resource-group]
[--slot]
[--subscription]
[--timeout]
Examples
Create a remote connection using a tcp tunnel to your web app
az webapp create-remote-connection --name MyWebApp --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.
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 |
Webapp instance to connect to. Defaults to none.
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 |
Port for the remote connection. Default: Random available port.
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 |
Timeout in seconds. Defaults to none.
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 delete
Delete a web app.
az webapp delete [--acquire-policy-token]
[--change-reference]
[--ids]
[--keep-dns-registration]
[--keep-empty-plan]
[--keep-metrics]
[--name]
[--resource-group]
[--slot]
[--subscription]
Examples
Delete a web app. (autogenerated)
az webapp delete --name MyWebapp --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.
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 |
Argument 'keep_dns_registration' has been deprecated and will be removed in version '3.0.0'.
Keep DNS registration.
Keep empty app service plan.
Keep app metrics.
The name of the webapp.
| 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 deploy
Deploys a provided artifact to Azure Web Apps.
Deploys a zip, war, jar, ear, static file, startup script, or library to an existing Azure Web App. The web app must already exist — use 'az webapp create' to create one first.
IMPORTANT: Zip deployment does NOT automatically run build automation (dependency installation, compilation, etc.). If your package is not pre-built, you must set the app setting SCM_DO_BUILD_DURING_DEPLOYMENT=true before deploying:
az webapp config appsettings set -g ResourceGroup -n AppName --settings SCM_DO_BUILD_DURING_DEPLOYMENT=true
Supported --type values: zip, war, jar, ear, lib, static, startup.
az webapp deploy [--acquire-policy-token]
[--async {false, true}]
[--change-reference]
[--clean {false, true}]
[--deploymentTag]
[--enable-kudu-warmup {false, true}]
[--enriched-errors {false, true}]
[--ids]
[--ignore-stack {false, true}]
[--name]
[--resource-group]
[--restart {false, true}]
[--show-secure-build]
[--slot]
[--src-path]
[--src-url]
[--subscription]
[--tag]
[--target-path]
[--timeout]
[--track-status {false, true}]
[--type {ear, jar, lib, startup, static, war, zip}]
Examples
Enable remote build and deploy an app from a zip file.
az webapp config appsettings set -g ResourceGroup -n AppName --settings SCM_DO_BUILD_DURING_DEPLOYMENT=true
az webapp deploy -g ResourceGroup -n AppName --src-path app.zip
Deploy a war file asynchronously.
az webapp deploy --resource-group ResourceGroup --name AppName --src-path SourcePath --type war --async true
Deploy a static text file to wwwroot/staticfiles/test.txt
az webapp deploy --resource-group ResourceGroup --name AppName --src-path SourcePath --type static --target-path staticfiles/test.txt
Deploy a zip file with enriched error diagnostics on failure.
az webapp deploy -g ResourceGroup -n AppName --src-path app.zip --enriched-errors true
Deploy a Python app and show a Secure Build summary and full-report link.
az webapp deploy -g ResourceGroup -n AppName --src-path app.zip --show-secure-build
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 |
If true, the artifact is deployed asynchronously. (The command will exit once the artifact is pushed to the web app.). Synchronous deployments are not yet supported when using "--src-url".
| Property | Value |
|---|---|
| Accepted values: | false, true |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
If true, cleans the target directory prior to deploying the file(s). Default value is determined based on artifact type.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Linux only. A friendly name used to identify the deployment.
If true, kudu will be warmed up before performing deployment for a linux webapp.
| Property | Value |
|---|---|
| Default value: | True |
| Accepted values: | false, true |
If true, deployment failures will show context-enriched diagnostics with error codes, suggested fixes, and Copilot prompts. Enabled by default; use --enriched-errors false to disable.
| Property | Value |
|---|---|
| Default value: | True |
| Accepted values: | false, true |
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 |
If true, any stack-specific defaults are ignored.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Name of the webapp to deploy to.
| 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 |
If true, the web app will be restarted following the deployment. Set this to false if you are deploying multiple artifacts and do not want to restart the site on the earlier deployments.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Show a Secure Build summary and full-report link after a local deployment, including when --async true is used. For URL deployments, show the command to run after deployment completes. Supported only for Linux web apps. Secure Build analysis can add several minutes to a local deployment.
| Property | Value |
|---|---|
| Default value: | False |
The name of the slot. Default to the productions slot if not specified.
Path of the artifact to be deployed. Ex: "myapp.zip" or "/myworkspace/apps/myapp.war".
URL of the artifact. The webapp will pull the artifact from this URL. Ex: "http://mysite.com/files/myapp.war?key=123".
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 |
Option '--tag' has been deprecated and will be removed in a future release. Use '--deploymentTag' instead.
Linux only. A friendly name used to identify the deployment.
Absolute path that the artifact should be deployed to. Defaults to "home/site/wwwroot/" Ex: "/home/site/deployments/tools/", "/home/site/scripts/startup-script.sh".
Timeout for the deployment operation in milliseconds. Ignored when using "--src-url" since synchronous deployments are not yet supported when using "--src-url".
If true, web app startup status during deployment will be tracked for linux web apps.
| Property | Value |
|---|---|
| Default value: | True |
| Accepted values: | false, true |
Used to override the type of artifact being deployed.
| Property | Value |
|---|---|
| Accepted values: | ear, jar, lib, startup, static, war, zip |
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 exec
This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Open an interactive shell session or run a command in a Linux web app container.
Interact with your Linux web app container in two modes:
- 'shell' (default): open an interactive shell session in your main app container.
- 'execute': fire-and-forget a command in your main app container; returns immediately, no output.
Only supported for Linux App Service plans.
'shell' mode: Open an interactive shell in your app's main container. Use --target kudu to connect to the Kudu container instead. A session ends automatically after 3 hours of inactivity, and may also end if the underlying instance is reimaged or platform components are updated.
'execute' mode: Fire-and-forget a command in the main app container. A 'succeeded' result means the command was accepted. It does not confirm the command ran or completed, and no logs, output, or exit code are returned. For immediate output, use 'shell' mode. The CLI reports failure only if the command (or the shell) could not be started. This makes execute mode well-suited to background or long-running work. The process runs detached and lives for the lifetime of the container (or until it finishes on its own). Use --command to run a single program, e.g. "npm start". Use --shell-command to run a shell command line where shell operators (|, &&, >, etc.) work, e.g. "cat log.txt | grep error > out.txt". Check the parameters and examples below, including how to capture output to a file.
az webapp exec --name
--resource-group
[--acquire-policy-token]
[--change-reference]
[--command]
[--cwd --working-directory]
[--instance]
[--mode {execute, shell}]
[--shell]
[--shell-command]
[--slot]
[--target {app, kudu}]
Examples
Start an interactive shell session with the web app container
az webapp exec -g MyResourceGroup -n MyWebapp --mode shell
Start an interactive shell session on a specific instance
az webapp exec -g MyResourceGroup -n MyWebapp --mode shell --instance MyInstanceId
Start an interactive shell session using a specific shell
az webapp exec -g MyResourceGroup -n MyWebapp --mode shell --shell /bin/sh
Start an interactive shell session with the Kudu container
az webapp exec -g MyResourceGroup -n MyWebapp --mode shell --target kudu
Run a direct command in the container
az webapp exec -g MyResourceGroup -n MyWebapp --mode execute --command "mkdir /home/site/newdir"
Run a shell command and redirect output to a file
az webapp exec -g MyResourceGroup -n MyWebapp --mode execute --shell-command "echo hello > /home/LogFiles/out.txt 2>&1"
Run a command in a specific working directory
az webapp exec -g MyResourceGroup -n MyWebapp --mode execute --cwd /home/site --command "touch newfile.txt"
Run a Python script in the container
az webapp exec -g MyResourceGroup -n MyWebapp --mode execute --command "python3 /home/site/wwwroot/script.py"
Run a shell command with a non-default shell
az webapp exec -g MyResourceGroup -n MyWebapp --mode execute --shell /bin/sh --shell-command "echo hi | grep h"
Execute a command on a specific instance
az webapp exec -g MyResourceGroup -n MyWebapp --mode execute --command "touch newfile.txt" --instance MyInstanceId
Execute a command on all instances
az webapp exec -g MyResourceGroup -n MyWebapp --mode execute --command "touch newfile.txt" --instance all
Execute a command on a deployment slot
az webapp exec -g MyResourceGroup -n MyWebapp -s staging --mode execute --command "touch newfile.txt"
Required Parameters
Name of the web app.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
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 |
[Execute mode] A command to run directly in the container, without a shell. Quote the whole command (e.g. --command "python /home/site/app.py --port 8080"). Shell operators (>, |, &&, etc.) are not interpreted - use --shell-command for those. Mutually exclusive with --shell-command.
[Execute mode] Absolute working directory for command execution. Defaults to the container's working directory.
Webapp instance(s) to target. Specify a comma-separated list of instance IDs (use "az webapp list-instances" to get IDs) or "all" for all instances. Defaults to a random instance. Specifying multiple instances (a comma-separated list or "all") is supported only in 'execute' mode.
Execution mode. 'shell' (default): Starts an interactive shell session with the main web app container. 'execute': Starts command execution and returns immediately without returning command output.
| Property | Value |
|---|---|
| Default value: | shell |
| Accepted values: | execute, shell |
Absolute path of the shell to use (e.g. /bin/sh); defaults to /bin/bash. In 'shell' mode it is the interactive shell to launch; in 'execute' mode it is the shell used to run --shell-command.
[Execute mode] A command line to run through a shell, so shell operators (|, &&, >, etc.) work (e.g. --shell-command "echo hi > /home/LogFiles/out.txt"). Runs as <shell> -c <command>; the shell defaults to /bin/bash and can be overridden with --shell. Mutually exclusive with --command.
Name of the web app slot. Default to the production slot if not specified.
Container to connect to in 'shell' mode. 'app' targets the main web app container; 'kudu' targets the Kudu (SCM) container. In 'execute' mode, only 'app' is supported.
| Property | Value |
|---|---|
| Default value: | app |
| Accepted values: | app, kudu |
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 webapp list
List web apps.
az webapp list [--resource-group]
[--show-details]
Examples
List all web apps in MyResourceGroup.
az webapp list --resource-group MyResourceGroup
List default host name and state for all web apps.
az webapp list --query "[].{hostName: defaultHostName, state: state}"
List all running web apps.
az webapp list --query "[?state=='Running']"
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>.
Include detailed site configuration of listed web apps in output.
| 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 webapp list-instances
List all scaled out instances of a web app or web app slot.
az webapp list-instances --name
--resource-group
[--acquire-policy-token]
[--change-reference]
[--slot]
Required Parameters
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>.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
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 |
Name of the web app slot. Default to the productions slot if not 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 webapp list-runtimes
List available built-in stacks which can be used for web apps.
The config field uses Framework:Version, which can be passed directly to --runtime. Use ':' as the runtime separator in commands. Existing pipe-separated runtime input remains accepted. The --runtime filter selects a family, such as python or dotnet, not a full Framework:Version value. When a Linux web app runtime is rejected, run the suggested list-runtimes command to find supported runtime values.
az webapp list-runtimes [--acquire-policy-token]
[--change-reference]
[--os --os-type {linux, windows}]
[--runtime {dotnet, java, node, php, python}]
[--support {active, all, eol, near, supported}]
Examples
List supported Python runtimes for Linux.
az webapp list-runtimes --os-type linux --runtime python --output table
List runtime values that can be passed to --runtime.
az webapp list-runtimes --os-type linux --runtime dotnet --query "[].config" --output tsv
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 |
Limit the output to just windows or linux runtimes.
| Property | Value |
|---|---|
| Accepted values: | linux, windows |
Limit the output to a specific runtime family.
| Property | Value |
|---|---|
| Accepted values: | dotnet, java, node, php, python |
Filter by support lifecycle status. Default: supported.
| Property | Value |
|---|---|
| Accepted values: | active, all, eol, near, supported |
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 webapp restart
Restart a web app.
az webapp restart [--acquire-policy-token]
[--change-reference]
[--ids]
[--name]
[--resource-group]
[--slot]
[--subscription]
Examples
Restart a web app. (autogenerated)
az webapp restart --name MyWebapp --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.
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 show
Get the details of a web app.
az webapp show [--ids]
[--name]
[--resource-group]
[--slot]
[--subscription]
Examples
Get the details of a web app. (autogenerated)
az webapp show --name MyWebapp --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.
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 ssh
This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
SSH command establishes a ssh session to the web container and developer would get a shell terminal remotely.
az webapp ssh [--acquire-policy-token]
[--change-reference]
[--ids]
[--instance]
[--name]
[--port]
[--resource-group]
[--slot]
[--subscription]
[--timeout]
Examples
ssh into a web app
az webapp ssh -n MyUniqueAppName -g 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.
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 |
Webapp instance to connect to. Defaults to none.
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 |
Port for the remote connection. Default: Random available port.
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 |
Timeout in seconds. Defaults to none.
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 start
Start a web app.
az webapp start [--acquire-policy-token]
[--change-reference]
[--ids]
[--name]
[--resource-group]
[--slot]
[--subscription]
Examples
Start a web app. (autogenerated)
az webapp start --name MyWebapp --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.
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 stop
Stop a web app.
az webapp stop [--acquire-policy-token]
[--change-reference]
[--ids]
[--name]
[--resource-group]
[--slot]
[--subscription]
Examples
Stop a web app. (autogenerated)
az webapp stop --name MyWebapp --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.
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 up
Deprecated command.
The 'az webapp up' command is deprecated and no longer supported for Azure App Service. Use 'webapp create and webapp deploy' instead.
Invocations exit with an error without creating or deploying resources. Legacy arguments are accepted only to report this error and are hidden from help.
az webapp up [--acquire-policy-token]
[--change-reference]
Examples
Show the retirement message. This command exits with an error.
az webapp up
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 |
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 webapp update
Update an existing web app.
az webapp update [--acquire-policy-token]
[--add]
[--basic-auth {Disabled, Enabled}]
[--change-reference]
[--client-affinity-enabled {false, true}]
[--end-to-end-encryption-enabled {false, true}]
[--force-dns-registration {false, true}]
[--force-string]
[--https-only {false, true}]
[--ids]
[--minimum-elastic-instance-count]
[--name]
[--platform-release-channel {Extended, Latest, Standard}]
[--prewarmed-instance-count]
[--remove]
[--resource-group]
[--set]
[--site-scoped-certs {false, true}]
[--skip-custom-domain-verification {false, true}]
[--skip-dns-registration {false, true}]
[--slot]
[--subscription]
[--ttl-in-seconds {false, true}]
Examples
Update the tags of a web app.
az webapp update -g MyResourceGroup -n MyAppName --set tags.tagName=tagValue
Update a web app. (autogenerated)
az webapp update --https-only true --name MyAppName --resource-group MyResourceGroup
Update the platform release channel of a web app. Possible values are Latest, Standard, Extended.
az webapp update --platform-release-channel Extended --name MyAppName --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.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.
| Property | Value |
|---|---|
| Parameter group: | Generic Update Arguments |
| Default value: | [] |
Enable or disable basic auth.
| Property | Value |
|---|---|
| Accepted values: | Disabled, Enabled |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
Enables sending session affinity cookies.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Enable or disable end-to-end encryption between the Front End and the Workers.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Argument 'force_dns_registration' has been deprecated and will be removed in version '3.0.0'.
If true, web app hostname is force registered with DNS.
| Property | Value |
|---|---|
| Accepted values: | false, true |
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
| Property | Value |
|---|---|
| Parameter group: | Generic Update Arguments |
| Default value: | False |
Redirect all traffic made to an app using HTTP to HTTPS.
| Property | Value |
|---|---|
| Accepted values: | false, true |
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 |
Minimum number of instances. App must be in an elastic scale App Service Plan.
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 |
Set the platform release channel for the web app. Possible values: Latest, Standard, Extended.
| Property | Value |
|---|---|
| Accepted values: | Extended, Latest, Standard |
Number of preWarmed instances. App must be in an elastic scale App Service Plan.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.
| Property | Value |
|---|---|
| Parameter group: | Generic Update Arguments |
| Default value: | [] |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.
| Property | Value |
|---|---|
| Parameter group: | Generic Update Arguments |
| Default value: | [] |
Enable or disable site-scoped certificates.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Argument 'skip_custom_domain_verification' has been deprecated and will be removed in version '3.0.0'.
If true, custom (non *.azurewebsites.net) domains associated with web app are not verified.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Argument 'skip_dns_registration' has been deprecated and will be removed in version '3.0.0'.
If true web app hostname is not registered with DNS on creation.
| Property | Value |
|---|---|
| Accepted values: | false, true |
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 |
Argument 'ttl_in_seconds' has been deprecated and will be removed in version '3.0.0'.
Time to live in seconds for web app's default domain name.
| 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.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |