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

This article provides examples on how to use the az apim command, which is used to manage Azure API Management services.

Use case 1: List API Management services within a resource group

Code:

az apim list --resource-group resource_group

Motivation: This use case is useful when you want to retrieve a list of all API Management services within a specific resource group. It allows you to quickly check the existing services and their details.

Explanation:

• az apim list: This command is used to retrieve a list of Azure API Management services.
• --resource-group: Specifies the resource group where the API Management services are located.

Example output:

[
  {
    "name": "example-apim",
    "location": "eastus",
    "sku": {
      "name": "Developer",
      "capacity": 1
    },
    "subscriptionId": "abc123",
    ...
  },
  {
    "name": "my-apim",
    "location": "westus",
    "sku": {
      "name": "Developer",
      "capacity": 1
    },
    "subscriptionId": "abc123",
    ...
  }
]

Use case 2: Create an API Management service instance

Code:

az apim create --name name --resource-group resource_group --publisher-email email --publisher-name name

Motivation: This use case is helpful when you need to create a new API Management service instance in Azure. It allows you to configure the necessary parameters, such as the name, publisher email, and publisher name, for the new instance.

Explanation:

• az apim create: This command is used to create a new Azure API Management service instance.
• --name: Specifies the name of the new API Management service instance.
• --resource-group: Specifies the resource group in which the new instance will be created.
• --publisher-email: Specifies the email address of the publisher for the instance.
• --publisher-name: Specifies the name of the publisher for the instance.

Example output:

{
  "name": "example-apim",
  "location": "eastus",
  "sku": {
    "name": "Developer",
    "capacity": 1
  },
  "subscriptionId": "abc123",
  ...
}

Use case 3: Delete an API Management service

Code:

az apim delete --name name --resource-group resource_group

Motivation: This use case is useful when you want to delete an existing API Management service. It allows you to remove a service that is no longer needed, freeing up resources and reducing cost.

Explanation:

• az apim delete: This command is used to delete an Azure API Management service.
• --name: Specifies the name of the API Management service to delete.
• --resource-group: Specifies the resource group where the API Management service is located.

Example output:

The command completed successfully.

Use case 4: Show details of an API Management service instance

Code:

az apim show --name name --resource-group resource_group

Motivation: This use case is helpful when you want to retrieve the details of a specific API Management service. It allows you to get information about the service, such as its location, SKU, and other properties.

Explanation:

• az apim show: This command is used to retrieve the details of an Azure API Management service instance.
• --name: Specifies the name of the API Management service.
• --resource-group: Specifies the resource group where the API Management service is located.

Example output:

{
  "name": "example-apim",
  "location": "eastus",
  "sku": {
    "name": "Developer",
    "capacity": 1
  },
  "subscriptionId": "abc123",
  ...
}

Use case 5: Update an API Management service instance

Code:

az apim update --name name --resource-group resource_group

Motivation: This use case is useful when you need to update the properties of an existing API Management service instance. It allows you to modify the configuration of the service, such as its location, SKU, and other properties.

Explanation:

• az apim update: This command is used to update an Azure API Management service instance.
• --name: Specifies the name of the API Management service to update.
• --resource-group: Specifies the resource group where the API Management service is located.

Example output:

{
  "name": "example-apim",
  "location": "westus",
  "sku": {
    "name": "Standard",
    "capacity": 2
  },
  "subscriptionId": "abc123",
  ...
}

Conclusion:

The az apim command is a powerful tool for managing Azure API Management services. With the provided examples, you can list, create, delete, show details, and update API Management service instances within your Azure environment.