Quickstart: Criar uma nova instância de serviço de gestão API Azure utilizando o Azure CLI

A Gestão de API (APIM) do Azure ajuda as organizações a publicar APIs para programadores externos, parceiros e internos, de modo a que estes possam explorar ao máximo o potencial dos 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. A APIM permite-lhe criar e gerir os modernos gateways API para serviços de backend existentes hospedados em qualquer lugar. Para obter mais informações, consulte Descrição Geral.

Este quickstart descreve os passos para criar uma nova instância de Gestão de API usando comandos az apim no CLI Azure.

Se não tiver uma subscrição do Azure,crie uma conta gratuita antes de começar.

Pré-requisitos

  • Utilize o ambiente Bash em Azure Cloud Shell.

    Iniciar Cloud Shell numa nova janela

  • Se preferir, instale o CLI do Azure para executar comandos de referência de CLI.

    • 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 obter mais opções de início de sessão, veja Iniciar sessão com o CLI do Azure.

    • Quando lhe for pedido, instale as extensões do CLI do Azure durante a 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 do Azure CLI. Se utilizar o Azure Cloud Shell, a versão mais recente já está instalada.

Criar um grupo de recursos

Os casos de Gestão da API da Azure, como todos os recursos da Azure, devem ser implantados num grupo de recursos. Os grupos de recursos permitem organizar e gerir recursos relacionados do Azure.

Em primeiro lugar, crie um grupo de recursos chamado myResourceGroup na localização central dos EUA com o seguinte grupo az criar comando:

az group create --name myResourceGroup --location centralus

Criar um novo serviço

Agora que tem um grupo de recursos, pode criar uma instância de serviço de Gestão API. Crie um utilizando o az apim criar comando e fornecer um nome de serviço e detalhes do editor. O nome de serviço deve ser único dentro de Azure.

No exemplo seguinte, o myapim é utilizado para o nome de serviço. Atualize o nome para um valor único. Atualize também o nome da organização da editora 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 predefinição, o comando cria a instância no nível de Desenvolvedor, uma opção económica para avaliar a Gestão API da Azure. Este nível não é para uso de 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.

Dica

Pode levar entre 30 a 40 minutos para criar e ativar um serviço de Gestão API neste nível. O comando anterior utiliza a --no-wait opção para que o comando retorne imediatamente enquanto o serviço é criado.

Verifique o estado da implantação executando o comando az apim show:

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

Inicialmente, a produção é semelhante à seguinte, mostrando o Activating estado:

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 estado é Online e a instância de serviço tem um endereço de gateway e endereço IP público. Por enquanto, estes 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 o seu serviço de gestão API estiver online, está pronto para usá-lo. Comece com o tutorial para importar e publicar a sua primeira API.

Limpar os recursos

Quando já não é necessário, pode utilizar o comando de eliminação do grupo AZ para remover o grupo de recursos e a instância do serviço de gestão da API.

az group delete --name myResourceGroup

Passos seguintes