Importar todas as APIs de uma instância de Gerenciamento de API

Este artigo mostra como criar um link para uma instância de Gerenciamento de API para que as APIs das instâncias sejam continuamente mantidas atualizadas em seu estoque do centro de API.

Sobre como vincular uma instância de Gerenciamento de API

Embora você possa usar a CLI do Azure para importar APIs sob demanda do Gerenciamento de API do Azure para o Centro de API do Azure, vincular uma instância de Gerenciamento de API permite a sincronização contínua para que o inventário de API permaneça atualizado.

Quando você vincula uma instância de Gerenciamento de API como uma fonte de API, o seguinte acontece:

1. Todas as APIs e, opcionalmente, as definições de API (especificações), da instância de Gerenciamento de API, são adicionadas ao inventário do centro de API.
2. Você configura um ambiente do tipo Gerenciamento de API do Azure no centro de API.
3. Uma implantação associada é criada para cada definição de API sincronizada do Gerenciamento de API.

As APIs de Gerenciamento de API são sincronizadas automaticamente com o centro de API sempre que as configurações das APIs existentes forem alteradas (por exemplo, novas versões são adicionadas), novas APIs são criadas ou APIs são excluídas. Essa sincronização é unidirecional do Gerenciamento de API para o centro de API do Azure, o que significa que as atualizações de API no centro de API não são sincronizadas novamente com a instância de Gerenciamento de API.

Observação

• Há limites para o número de instâncias de Gerenciamento de API vinculadas (fontes de API).
• As atualizações de API no Gerenciamento de API normalmente são sincronizadas com o centro de API em poucos minutos, mas a sincronização pode levar até 24 horas.

Entidades sincronizadas do Gerenciamento de API

Você pode adicionar ou atualizar propriedades de metadados e documentação em seu centro de API para ajudar os stakeholders a descobrir, entender e consumir as APIs sincronizadas. Saiba mais sobre as propriedades de metadados internas e personalizadas do Centro de API do Azure.

A tabela a seguir mostra as propriedades da entidade que podem ser modificadas no Centro de API do Azure e as propriedades que são determinadas com base em seus valores em uma instância vinculada do Gerenciamento de API do Azure. Além disso, os identificadores de sistema ou recursos de entidades no Centro de API do Azure são gerados automaticamente e não podem ser modificados.

Entity	Propriedades configuráveis no Centro de API	Propriedades determinadas no Gerenciamento de API
API	summary lifecycleStage termsOfService license externalDocumentation customProperties	title descrição kind
Versão da API	lifecycleStage	title
Ambiente	title descrição kind server.managementPortalUri integração customProperties	server.type
Implantação	title descrição servidor estado customProperties	server.runtimeUri

Para obter detalhes da propriedade, consulte a Referência da API REST do Centro de API do Azure.

Pré-requisitos

• Um centro de API na sua assinatura do Azure. Se você não criou um, consulte Início Rápido: criar seu centro de API.

• Uma instância de Gerenciamento de API do Azure, na mesma assinatura ou em uma assinatura diferente. A instância deve estar no mesmo diretório.

• Para a CLI do Azure:

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

  Observação

  Os comandos az apic exigem a extensão da CLI do Azure apic-extension. Se você não tiver usado comandos az apic, a extensão poderá ser instalada dinamicamente quando você executar seu primeiro comando az apic ou instalar a extensão manualmente. Saiba mais sobre as extensões da CLI do Azure.

  Confira as notas sobre a versão para ver as últimas alterações e atualizações no apic-extension.

  Observação

  Os exemplos de comando da CLI do Azure incluídos neste artigo podem ser executados no PowerShell ou em um shell do Bash. Sempre que necessário, devido às diferentes sintaxes variáveis, são fornecidos exemplos de comando separados para os dois shells.

Adicionar uma identidade gerenciada no centro de API

Para esse cenário, seu centro de API usa uma identidade gerenciada para acessar APIs em sua instância de Gerenciamento de API. Dependendo das suas necessidades, configure uma identidade gerida atribuída pelo sistema ou uma ou mais identidades geridas atribuídas pelo utilizador.

Os exemplos a seguir mostram como configurar uma identidade gerenciada atribuída pelo sistema usando o portal do Azure ou a CLI do Azure. A um nível elevado, os passos de configuração são semelhantes para uma identidade gerida atribuída pelo utilizador.

Portal

1. No portal, navegue até seu centro de API.
2. No menu à esquerda, em Segurança, selecione Identidades Gerenciadas.
3. Selecione Sistema atribuído e defina o status como Ativado.
4. Selecione Salvar.

CLI do Azure

Defina a identidade atribuída pelo sistema no centro de API usando o seguinte comando az apic update. Substitua os nomes do centro de API e do grupo de recursos:

az apic update --name <api-center-name> --resource-group <resource-group-name> --identity '{"type": "SystemAssigned"}'

Atribuir a identidade gerenciada à função Leitor do Serviço de Gerenciamento de API

Para permitir a importação de APIs, atribua a identidade gerenciada do centro de API a função Leitor do Serviço de Gerenciamento de API em sua instância de Gerenciamento de API. É possível usar o portal ou a CLI do Azure.

Portal

1. No portal do Azure, navegue até a instância do Gerenciamento de API.
2. No menu à esquerda, selecione Controle de acesso (IAM) .
3. Escolha Adicionar atribuição de função.
4. Na página Adicionar atribuição de função, defina os valores da seguinte maneira:
   1. Na guia Função – Selecione Leitor do Serviço de Gerenciamento de API.
   2. Na guia Membros, em Atribuir acesso a – Selecione Identidade Gerenciada > + Selecionar membros.
   3. Na página Selecionar identidades gerenciadas - Selecione a identidade gerenciada atribuída pelo sistema do seu centro de API que você adicionou na seção anterior. Clique em Selecionar.
   4. Selecione Examinar + atribuir.

CLI do Azure

1. Obtenha a ID da entidade de segurança da identidade. Para uma identidade atribuída pelo sistema, use o comando az apic show.

   #! /bin/bash
   apicObjID=$(az apic show --name <api-center-name> \
       --resource-group <resource-group-name> \
       --query "identity.principalId" --output tsv)
   

   # Formatted for PowerShell
   $apicObjID=$(az apic show --name <api-center-name> `
       --resource-group <resource-group-name> `
       --query "identity.principalId" --output tsv)
   

2. Obtenha a ID do recurso da instância de Gerenciamento de API usando o comando az apim show.

   #! /bin/bash
   apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query "id" --output tsv)
   

   # Formatted for PowerShell
   $apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query "id" --output tsv)
   

3. Atribua a identidade gerenciada à função Leitor do Serviço de Gerenciamento de API em sua instância de Gerenciamento de API usando o comando az role assignment create.

   #! /bin/bash
   scope="${apimID:1}"
   
   az role assignment create \
       --role "API Management Service Reader Role" \
       --assignee-object-id $apicObjID \
       --assignee-principal-type ServicePrincipal \
       --scope $scope 
   

   # Formatted for PowerShell
   $scope=$apimID.substring(1)
   
   az role assignment create `
       --role "API Management Service Reader Role" `
       --assignee-object-id $apicObjID `
       --assignee-principal-type ServicePrincipal `
       --scope $scope 
   

Ter uma instância de Gerenciamento de API.

Você pode vincular uma instância de Gerenciamento de API usando o portal.

1. No portal, navegue até seu centro de API.
2. Em Ativos, selecione Ambientes.
3. Selecione Links (versão prévia)>+ Novo link.
4. Na página Vincular seu Serviço de Gerenciamento de API do Azure:
   1. Selecione a Assinatura, o Grupo de recursos e o Serviço de Gerenciamento de API do Azure que você deseja vincular.
   2. Em Detalhes do Link, insira um identificador.
   3. Em Detalhes do Ambiente, insira um Título de ambiente(nome), Tipo de ambiente e, opcionalmente, uma Descrição do ambiente..
   4. Em detalhes da API, selecione um Estágio de ciclo de vida para as APIs sincronizadas. (Você pode atualizar esse valor para suas APIs depois que elas forem adicionadas ao centro de API.) Além disso, selecione se deseja sincronizar definições de API.
5. Selecione Criar.

O ambiente é adicionado ao centro de API. As APIs de Gerenciamento de API são importadas para o inventário do centro de API.

Excluir um link

Embora uma instância de Gerenciamento de API esteja vinculada, você não pode excluir APIs sincronizadas do centro de API. Se você precisar, poderá excluir o link. Quando você exclui um link:

• As APIs de Gerenciamento de API sincronizadas no inventário do centro de API são excluídas
• O ambiente e as implantações associadas à instância de Gerenciamento de API são excluídas

Para excluir um link de Gerenciamento de API:

1. No portal, navegue até seu centro de API.
2. Em Ativos, selecione Ambientes>Link (versão prévia).
3. Selecione o link e, em seguida, selecione Excluir (ícone de lixeira).

Conteúdo relacionado

• Gerenciar o inventário de API com comandos da CLI do Azure
• Importar APIs do Gerenciamento de API para o centro de API do Azure
• Documentação do Gerenciamento de API do Azure