How to use the command 'az webapp' (with examples)

The az webapp command is a powerful tool within the Azure Command-Line Interface (CLI) that allows developers and IT professionals to manage web applications hosted on Azure Cloud Services easily. This tool is integral for handling a variety of tasks related to web apps, from creation and deployment to management and deletion. Below, we explore several key use cases, providing practical examples to illustrate how to use this command effectively.

Use case 1: List available runtimes for a web application

Code:

az webapp list-runtimes --os-type windows

Motivation: Understanding the available runtimes is crucial when planning to deploy a web application, as it ensures that your application is compatible with the environment you want to host it in. By listing available runtimes, you can make informed decisions about your software deployment and compatibility aspects.

Explanation:

• az webapp list-runtimes: This part of the command is used to list the runtimes available for web applications in Azure.
• --os-type windows: This flag specifies that the command should list runtimes compatible with Windows-based Azure hosting environments. You can alternatively specify linux for Linux-based environments.

Example output:

[
  ".NET|LTS",
  ".NET|4.8",
  "Java|8-jre8",
  "Node|LTS",
  ...
]

Use case 2: Create a web application

Code:

az webapp up --name MyWebApp --location eastus --runtime "NODE|12-lts"

Motivation: Creating a web application in Azure is often the first step towards deploying your web service to the cloud. This process automatically sets up the necessary resources and links them to your new web application, simplifying the deployment process.

Explanation:

• az webapp up: This command initializes the process to create and deploy a web application.
• --name MyWebApp: This argument sets the unique name for your web application, which will be used to identify and access it.
• --location eastus: Specifies the Azure region where you want the web application and its resources to be hosted.
• --runtime "NODE|12-lts": Defines the runtime stack to be used for this application, in this case, Node.js version 12 on the Long Term Support (LTS) version.

Example output:

{
  "appName": "MyWebApp",
  "state": "Running",
  "defaultHostName": "mywebapp.azurewebsites.net",
  ...
}

Use case 3: List all web applications

Code:

az webapp list

Motivation: Listing all web applications within your Azure account is essential for managing your cloud resources effectively. It helps in auditing, monitoring load distribution, and resource management. Knowing what’s running in your environment can also aid in optimizing costs and improving application performance.

Explanation:

• az webapp list: This command fetches and displays all web applications associated with the user’s Azure subscription, providing a consolidated view of active services.

Example output:

[
  {
    "name": "MyWebApp",
    "resourceGroup": "myResourceGroup",
    "location": "eastus",
    ...
  },
  {
    "name": "AnotherWebApp",
    "resourceGroup": "anotherResourceGroup",
    "location": "westus",
    ...
  }
]

Use case 4: Delete a specific web application

Code:

az webapp delete --name MyWebApp --resource-group myResourceGroup

Motivation: There are times when you need to retire or decommission a web application to free up resources or maintain environmental hygiene. Deleting unused applications helps avoid unnecessary costs and keeps your cloud space organized and efficient.

Explanation:

• az webapp delete: This command initiates the deletion process for a specified web app.
• --name MyWebApp: Identifies the web application to be deleted by its name.
• --resource-group myResourceGroup: Specifies the Azure resource group that contains the web application, ensuring the correct resource is targeted for deletion.

Example output:

Delete deployment for 'MyWebApp'? [y/n] (y): y
{
  "status": "Success",
  "name": "MyWebApp",
  ...
}

Conclusion

The az webapp command is an essential tool for managing Azure-hosted web applications through the Azure CLI. From setting up new applications and choosing the correct runtime to maintaining and cleaning up resources, this command streamlines various administrative tasks. By mastering these use cases, you can more effectively manage your web applications in the Azure cloud environment.