Sincronizar 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 inventário do centro de APIs.

Sobre a vinculação de 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, acontece o seguinte:

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 APIs.
2. Você configura um ambiente do tipo Gerenciamento de API do Azure no centro de APIs.
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 APIs sempre que as configurações das APIs existentes são 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 de volta à instância de Gerenciamento de API.

Nota

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

Entidades sincronizadas a partir do Gerenciamento de API

Você pode adicionar ou atualizar propriedades e documentação de metadados em seu centro de API para ajudar as partes interessadas 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 na Central 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 recursos ou sistema das entidades na Central de API do Azure são gerados automaticamente e não podem ser modificados.

Entidade	Propriedades configuráveis no Centro de API	Propriedades determinadas no Gerenciamento de API
API	Resumo ciclo de vidaEstágio termosdeserviço license externalDocumentação customProperties	title descrição variante
Versão da API	ciclo de vidaEstágio	title
Environment	title descrição tipo server.managementPortalUri inclusão customProperties	servidor.type
Implementação	title descrição servidor state 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 subscrição do Azure. Se você ainda não criou um, consulte Guia de início rápido: criar sua central de APIs.

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

  Nota

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

  Consulte as notas de versão para obter as alterações e atualizações mais recentes no apic-extension.

  Nota

  Os exemplos de comandos da CLI do Azure neste artigo podem ser executados no PowerShell ou em um shell bash. Quando necessário devido à sintaxe variável diferente, exemplos de comandos separados são fornecidos para os dois shells.

Adicionar uma identidade gerenciada em seu 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 gerenciada atribuída pelo sistema ou uma ou mais identidades gerenciadas atribuídas pelo usuário.

Os exemplos a seguir mostram como configurar uma identidade gerenciada atribuída ao sistema usando o portal do Azure ou a CLI do Azure. Em um alto nível, as etapas de configuração são semelhantes para uma identidade gerenciada atribuída pelo usuário.

Portal

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

CLI do Azure

Defina a identidade atribuída ao sistema em seu centro de API usando o seguinte comando az apic update . Substitua os nomes do seu centro de API e 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 de Serviço de Gerenciamento de API

Para permitir a importação de APIs, atribua à identidade gerenciada do seu centro de API a função Leitor de Serviço de Gerenciamento de API em sua instância de Gerenciamento de API . Você pode usar o portal ou a CLI do Azure.

Portal

1. No portal, navegue até sua instância de Gerenciamento de API.
2. No menu à esquerda, selecione Controle de acesso (IAM).
3. Selecione + Adicionar atribuição de função.
4. Na página Adicionar atribuição de função, defina os valores da seguinte forma:
   1. Na guia Função - Selecione API Management Service Reader.
   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 ao sistema do seu centro de API que você adicionou na seção anterior. Clique em Selecionar.
   4. Selecione Rever + atribuir.

CLI do Azure

1. Obtenha o ID principal 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 o ID do recurso da sua 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 à identidade gerenciada a função Leitor de 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 
   

Vincular 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é o centro de APIs.
2. Em Ativos, selecione Ambientes.
3. Selecione Links (visualização)>+ 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 do ambiente (nome), Tipo de ambiente e Descrição opcional do ambiente.
   4. Em Detalhes da API, selecione um estágio do ciclo de vida para as APIs sincronizadas. (Você pode atualizar esse valor para suas APIs depois que elas forem adicionadas ao seu centro de APIs.) Além disso, selecione se deseja sincronizar as definições de API.
5. Selecione Criar.

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

Excluir um link

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

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

Para excluir um link de Gerenciamento de API:

1. No portal, navegue até o centro de APIs.
2. Em Ativos, selecione Link Ambientes>(visualização).
3. Selecione o link e, em seguida, selecione Excluir (ícone da lixeira).

Conteúdos relacionados

• Gerenciar 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 Azure API Management