Quickstart: Create a new Azure API Management instance by using the Azure CLI

APPLIES TO: Consumption | Developer | Basic | Standard | Premium

This quickstart describes the steps for creating a new API Management instance by using Azure CLI commands. After creating an instance, you can use the Azure CLI for common management tasks such as importing APIs in your API Management instance.

Azure API Management helps organizations publish APIs to external, partner, and internal developers to unlock the potential of their data and services. API Management provides the core competencies to ensure a successful API program through developer engagement, business insights, analytics, security, and protection. With API Management, create and manage modern API gateways for existing backend services hosted anywhere.

If you don't have an Azure subscription, create a trial account before you begin.

• This article requires version 2.11.1 or later of the Azure CLI.

Create a resource group

Azure API Management instances, like all Azure resources, must be deployed into a resource group. Resource groups let you organize and manage related Azure resources.

First, create a resource group named myResourceGroup in the China East location with the following az group create command:

az group create --name myResourceGroup --location chinaeast

Create an API Management instance

Now that you have a resource group, you can create an API Management instance. Create one by using the az apim create command and provide a service name and publisher details. The service name must be unique within Azure.

In the following example, myapim is used for the service name. Update the name to a unique value. Also update the name of the API publisher's organization and the email address to receive notifications.

az apim create --name myapim --resource-group myResourceGroup \
  --publisher-name Contoso --publisher-email admin@contoso.com \
  --no-wait

By default, the command creates the instance in the Developer tier, an economical option to evaluate Azure API Management. This tier isn't for production use. For more information about scaling the API Management tiers, see upgrade and scale.

Check the status of the deployment by running the az apim show command:

az apim show --name myapim --resource-group myResourceGroup --output table

Initially, output is similar to the following, showing the Activating status:

NAME         RESOURCE GROUP    LOCATION    GATEWAY ADDR    PUBLIC IP    PRIVATE IP    STATUS      TIER       UNITS
-----------  ----------------  ----------  --------------  -----------  ------------  ----------  ---------  -------
myapim       myResourceGroup   China East                                             Activating  Developer  1

After activation, the status is Online and the service instance has a gateway address and public IP address. For now, these addresses don't expose any content. For example:

NAME         RESOURCE GROUP    LOCATION    GATEWAY ADDR                       PUBLIC IP     PRIVATE IP    STATUS    TIER       UNITS
-----------  ----------------  ----------  ---------------------------------  ------------  ------------  --------  ---------  -------
myapim       myResourceGroup   China East  https://myapim.azure-api.cn       203.0.113.1                 Online    Developer  1

When your API Management service instance is online, you're ready to use it. Start with the tutorial to import and publish your first API.

Clean up resources

You can use the az group delete command to remove the resource group and the API Management service instance when they aren't needed.

az group delete --name myResourceGroup

Next steps