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 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 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 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 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 show |
Get the details of a web app. |
Core | GA |
| 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 status |
Show site runtime status and recent startup summary for a Linux web app. |
Core | Preview |
| az webapp up |
Create a webapp and deploy code from a local workspace to the app. The command is required to run from the folder where the code is present. Current support includes Node, Python, .NET Core and ASP.NET. Node, Python apps are created as Linux apps. .Net Core, ASP.NET, and static HTML apps are created as Windows apps. Append the html flag to deploy as a static HTML app. Each time the command is successfully run, default argument values for resource group, sku, location, plan, and name are saved for the current directory. These defaults are then used for any arguments not provided on subsequent runs of the command in the same directory. Use 'az configure' to manage defaults. Run this command with the --debug parameter to see the API calls and parameters values being used. |
Core | Deprecated |
| 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 |