Guia de início rápido: criar uma instância de serviço do Gerenciamento de API do Azure usando a CLI do Azure
APLICA-SE A: Consumo | Desenvolvedor | Básico | Standard | Premium
Esse início rápido descreve as etapas para criar uma instância de Gerenciamento de API usando comandos da CLI do Azure. Depois de criar uma instância, você pode usar a CLI do Azure para tarefas comuns de gerenciamento, como importar APIs em sua instância de Gerenciamento de API.
O Gerenciamento de API do Azure ajuda as organizações a publicar APIs para parceiros externos e desenvolvedores internos e a fim de viabilizar o potencial de seus dados e serviços. O Gerenciamento de API fornece as competências essenciais para garantir um programa de API de sucesso através do envolvimento do desenvolvedor, ideias de negócios, análises, segurança e proteção. O Gerenciamento de API permite que você crie e gerencie gateways de API modernos para serviços de back-end hospedados em qualquer lugar.
Caso você não tenha uma assinatura do Azure, crie uma conta gratuita do Azure antes de começar.
Pré-requisitos
Use o ambiente Bash no Azure Cloud Shell. Para obter mais informações, confira Início Rápido para Bash no Azure Cloud Shell.
Se preferir executar os comandos de referência da CLI localmente, instale a CLI do Azure. Para execuções no Windows ou no macOS, considere executar a CLI do Azure em um contêiner do Docker. Para obter mais informações, confira Como executar a CLI do Azure em um contêiner do Docker.
Se estiver usando uma instalação local, entre com a CLI do Azure usando o comando az login. Para concluir o processo de autenticação, siga as etapas exibidas no terminal. Para ver outras opções de entrada, confira Conectar-se com a CLI do Azure.
Quando solicitado, instale a extensão da CLI do Azure no primeiro uso. Para obter mais informações sobre extensões, confira Usar extensões com a CLI do Azure.
Execute az version para localizar a versão e as bibliotecas dependentes que estão instaladas. Para fazer a atualização para a versão mais recente, execute az upgrade.
- Este artigo exige a versão 2.11.1 ou posterior da CLI do Azure. Se você está usando o Azure Cloud Shell, a versão mais recente já está instalada.
Criar um grupo de recursos
As instâncias de Gerenciamento de API do Azure, assim como todos os recursos do Azure, precisam ser implantadas em um grupo de recursos. Os grupos de recursos permitem que você organize e gerencie os recursos relacionados ao Azure.
Primeiramente, crie um grupo de recursos denominado myResourceGroup no local EUA Central com o seguinte comando az group create:
az group create --name myResourceGroup --location centralus
Criar uma instância de Gerenciamento de API
Agora que você tem um grupo de recursos, você pode criar uma instância de serviço do Gerenciamento de API. Crie uma usando o comando az apim create e forneça um nome de serviço e detalhes do editor. O nome do serviço precisa ser único no Azure.
No exemplo a seguir, myapim é usado para o nome do serviço. Atualize o nome para um valor exclusivo. Também atualize o nome da organização do editor da API e o endereço de email para receber notificações.
az apim create --name myapim --resource-group myResourceGroup \
--publisher-name Contoso --publisher-email admin@contoso.com \
--no-wait
Por padrão, o comando cria a instância na camada Desenvolvedor, uma opção econômica para avaliar o Gerenciamento de API do Azure. Essa camada não é para uso em produção. Para obter mais informações sobre a colocação em escala das camadas de Gerenciamento de API, confira atualizar e dimensionar.
Dica
A criação e a ativação de um serviço de Gerenciamento de API nessa camada leva de 30 a 40 minutos. O comando anterior usa a opção --no-wait para que o comando seja retornado imediatamente enquanto o serviço é criado.
Verifique o status da implantação executando o comando az apim show:
az apim show --name myapim --resource-group myResourceGroup --output table
Inicialmente, a saída se assemelha ao seguinte, mostrando o status Activating:
NAME RESOURCE GROUP LOCATION GATEWAY ADDR PUBLIC IP PRIVATE IP STATUS TIER UNITS
----------- ---------------- ---------- -------------- ----------- ------------ ---------- --------- -------
myapim myResourceGroup Central US Activating Developer 1
Após a ativação, o status será Online e a instância de serviço tem um endereço de gateway e um endereço IP público. Por enquanto, esses endereços não expõem nenhum conteúdo. Por exemplo:
NAME RESOURCE GROUP LOCATION GATEWAY ADDR PUBLIC IP PRIVATE IP STATUS TIER UNITS
----------- ---------------- ---------- --------------------------------- ------------ ------------ -------- --------- -------
myapim myResourceGroup Central US https://myapim.azure-api.net 203.0.113.1 Online Developer 1
Quando sua instância de serviço de Gerenciamento de API estiver online, você estará pronto para usá-la. Comece com o tutorial para importar e publicar sua primeira API.
Limpar os recursos
Você pode usar o comando az group delete para remover o grupo de recursos e a instância de serviço do Gerenciamento de API quando eles não forem necessários.
az group delete --name myResourceGroup