Guia de início rápido: criar uma nova instância de Gerenciamento de API do Azure usando a CLI do Azure

Artigo
12/15/2023

APLICA-SE A: Consumo | Programador | Básico | Padrão | Prémio

Este guia de início rápido descreve as etapas para criar uma nova 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 desenvolvedores externos, parceiros e internos para desbloquear o potencial de seus dados e serviços. A Gestão de API fornece as competências essenciais para garantir um programa de API bem-sucedido através do envolvimento dos programadores, das informações de negócio, da análise, da segurança e da proteção. Com o Gerenciamento de API, crie e gerencie gateways de API modernos para serviços de back-end existentes hospedados em qualquer lugar.

Se não tiver uma subscrição 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, consulte Guia de início rápido para Bash no Azure Cloud Shell.
Se preferir executar comandos de referência da CLI localmente, instale a CLI do Azure. Se estiver a utilizar o Windows ou macOS, considere executar a CLI do Azure num contentor Docker. Para obter mais informações, consulte Como executar a CLI do Azure em um contêiner do Docker.
- Se estiver a utilizar uma instalação local, inicie sessão no CLI do Azure ao utilizar o comando az login. Para concluir o processo de autenticação, siga os passos apresentados no seu terminal. Para outras opções de entrada, consulte Entrar com a CLI do Azure.
- Quando solicitado, instale a extensão da CLI do Azure na primeira utilização. Para obter mais informações sobre as extensões, veja Utilizar extensões com o CLI do Azure.
- Execute o comando az version para localizar a versão e as bibliotecas dependentes instaladas. Para atualizar para a versão mais recente, execute o comando az upgrade.

Este artigo requer a versão 2.11.1 ou posterior da CLI do Azure. Se estiver 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, como todos os recursos do Azure, devem ser implantadas em um grupo de recursos. Os grupos de recursos permitem organizar e gerenciar recursos relacionados do Azure.

Primeiro, crie um grupo de recursos chamado myResourceGroup no local Central dos EUA com o seguinte comando az group create :

az group create --name myResourceGroup --location centralus

Criar uma instância da Gestão de API

Agora que você tem um grupo de recursos, pode criar uma instância de Gerenciamento de API. Crie um usando o comando az apim create e forneça um nome de serviço e detalhes do editor. O nome do serviço deve ser exclusivo no Azure.

No exemplo a seguir, myapim é usado para o nome do serviço. Atualize o nome para um valor exclusivo. Atualize também o nome da organização do editor da API e o endereço de e-mail 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 de desenvolvedor, uma opção econômica para avaliar o Gerenciamento de API do Azure. Esta camada não é para uso em produção. Para obter mais informações sobre o dimensionamento dos escalões da Gestão de API, consulte Atualização de versão do software e dimensionamento.

Gorjeta

Pode levar entre 30 e 40 minutos para criar e ativar um serviço de Gerenciamento de API nessa camada. O comando anterior usa a --no-wait opção para que o comando retorne 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 é semelhante à seguinte, mostrando o Activating status:

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 é 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.

Clean up resources (Limpar recursos)

Você pode usar o comando az group delete para remover o grupo de recursos e a instância do serviço de Gerenciamento de API quando eles não forem necessários.

az group delete --name myResourceGroup

Próximos passos

Importar e publicar a sua primeira API

Partilhar via