Importar um aplicativo de função do Azure como uma API no Gerenciamento de API do Azure

APLICA-SE A: Todas as camadas de gerenciamento de API

O Gerenciamento de API do Azure dá suporte à importação de aplicativos de função do Azure como novas APIs ou ao adicioná-los a APIs existentes. O processo gera automaticamente uma chave de host no aplicativo de função do Azure, que é então atribuída a um valor nomeado no Gerenciamento de API.

Nota

Atualmente, esse recurso não está disponível em espaços de trabalho.

Este artigo descreve como importar um aplicativo de função do Azure como uma API para o Gerenciamento de API do Azure e testar a API.

Você aprenderá a:

Importar um aplicativo de função do Azure como uma API
Acrescentar um aplicativo de função do Azure a uma API
Exibir a nova função chave de host do aplicativo e o valor nomeado do Gerenciamento de API
Testar a API no Portal do Azure

Pré-requisitos

Conclua o início rápido Criar uma instância de Gerenciamento de API do Azure.
Certifique-se de que tem uma aplicação de função do Azure na sua subscrição. Para obter mais informações, consulte Introdução ao Azure Functions. A função deve ter um gatilho HTTP. O nível de autorização deve ser definido como Anônimo ou Função.

Nota

Você também pode usar a extensão de gerenciamento de API para Visual Studio Code para importar e gerenciar suas APIs. Conclua o tutorial API Management Extension para começar.

Importar um aplicativo de função do Azure como uma nova API

Para criar uma nova API a partir de um aplicativo de função do Azure:

Navegue até ao serviço de Gestão de API no portal do Azure.
Selecione APIs> APIs no painel esquerdo.
Em Criar a partir do recurso do Azure, selecione Aplicativo de função:
Selecione o botão Procurar :
Clique no botão Selecionar em Configurar configurações necessárias para escolher na lista de aplicativos de função disponíveis:
Encontre o aplicativo de função do qual deseja importar funções, selecione-o e clique em Selecionar:
Selecione as funções que deseja importar e clique em Selecionar. Você só pode importar funções que tenham um gatilho HTTP e um nível de autorização Anônimo ou Função .
Mude para a vista Completa e atribua um Produto à sua nova API.
Nota

Produtos são associações de uma ou mais APIs que são oferecidas aos desenvolvedores por meio do portal do desenvolvedor. Primeiro, os desenvolvedores devem assinar um produto para obter acesso à API. Quando eles se inscrevem, eles recebem uma chave de assinatura para qualquer API no produto. Se você criou a instância de Gerenciamento de API, é um administrador e está inscrito em todos os produtos por padrão.

Em alguns níveis de preços, as instâncias de Gerenciamento de API vêm com dois produtos de exemplo padrão:
- Inicial
- Ilimitado
Conforme necessário, especifique outras configurações. Você também pode especificar as configurações mais tarde através da guia Configurações . Essas configurações são explicadas no tutorial Importar e publicar sua primeira API .
Selecione Criar.

Acrescentar um aplicativo de função a uma API existente

Para acrescentar um aplicativo de função a uma API existente:

Na sua instância do serviço de Gestão de API do Azure, selecione APIs>APIs no painel esquerdo.
Escolha uma API para a qual você deseja importar um aplicativo de função. Selecione as reticências (...) ao lado da API e, em seguida, selecione Importar:
Selecione o bloco Aplicativo de função :
Na janela Importar do aplicativo de função, selecione Procurar:
Clique no botão Selecionar em Configurar configurações necessárias para escolher na lista de aplicativos de função disponíveis:
Encontre o aplicativo de função do qual deseja importar funções, selecione-o e clique em Selecionar:
Selecione as funções que deseja importar e clique em Selecionar:
Selecione Importar:

Autorização

Quando você importa um aplicativo de função do Azure, esses itens são gerados automaticamente:

Uma chave de host na aplicação de funções. A chave é chamada apim-<your API Management service instance name>.
Um valor nomeado na instância de Gerenciamento de API que tem o nome <your Azure function app instance name>-key. Esse valor contém a chave do host.

Para APIs criadas após 4 de abril de 2019, a chave do host é passada em solicitações HTTP do Gerenciamento de API para o aplicativo de função em um cabeçalho. APIs mais antigas passam a chave do host como um parâmetro de consulta. Você pode alterar esse comportamento usando a chamada da PATCH BackendAPI REST na Backend entidade associada à aplicação de funções.

Aviso

Remover ou alterar o valor da chave de host do aplicativo de função do Azure ou o valor nomeado do Gerenciamento de API desabilitará a comunicação entre os serviços. Os valores não são sincronizados automaticamente.

Se você precisar girar a chave do host, certifique-se de alterar também o valor nomeado no Gerenciamento de API.

Aceder a uma chave de anfitrião da aplicação funcional

Navegue até a instância do aplicativo de função do Azure:
Na seção Funções do painel esquerdo, selecione Teclas do aplicativo:
Encontre as chaves na seção Chaves de host :

Acesse o valor nomeado no Gerenciamento de API

Navegue até a instância de Gerenciamento de API e selecione APIs>Valores nomeados no painel esquerdo. A chave do aplicativo de função do Azure é armazenada lá.

Testar a nova API no portal do Azure

Pode chamar operações diretamente a partir do portal do Azure. Utilizar o portal do Azure é um meio cómodo de ver e testar as operações de uma API.

Selecione a API que criou na secção anterior.
Selecione o separador Teste.
Selecione a operação que deseja testar.
- A página exibe campos para parâmetros de consulta e cabeçalhos.
- Um dos cabeçalhos é Ocp-Apim-Subscription-Key. Esse cabeçalho é para a chave de assinatura do produto associada à API.
- Se criou a instância de gestão de API, é um administrador, então a chave é preenchida automaticamente.
Selecione Enviar.

Quando o teste é bem-sucedido, o back-end responde com 200 OK e alguns dados.

Comentários

Esta página foi útil?

Last updated on 2025-04-16