Importar um aplicativo de funções do Azure como uma API no Gerenciamento de API do Azure

2025-04-16

APLICA-SE A: todas as camadas do Gerenciamento de API

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

Observação

Atualmente, esse recurso não está disponível em workspaces.

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

Você aprenderá a:

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

Pré-requisitos

Conclua o guia de início rápido Criar uma instância do Gerenciamento de API do Azure.
Verifique se você tem um aplicativo de funções do Azure em sua assinatura. Para saber mais, confira Introdução a 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.

Observação

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 da Extensão de Gerenciamento de API para começar.

Importar um aplicativo de funções do Azure como uma nova API

Para criar uma nova API a partir de um aplicativo de funções do Azure:

Navegue até o serviço de Gerenciamento de API no portal do Azure.
Selecione APIs> no painel esquerdo.
Em Criar a partir do recurso do Azure, selecione Aplicativo de Funções:
Selecione o botão Procurar :
Clique no botão Selecionar em Definir as configurações necessárias para escolher na lista de aplicativos de funções disponíveis:
Localize o aplicativo de funções do qual você deseja importar funções, selecione-o e clique em Selecionar:
Selecione as funções que você deseja importar e clique em Selecionar. Você só pode importar funções com base nos gatilhos HTTP com os níveis de autorização Anônimo ou Função.
Alterne para o modo de exibição Completo e atribua um Produto à sua nova API.
Observação

Os 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 precisam assinar um produto para obter acesso à API. Quando eles assinam, eles obtêm uma chave de assinatura para qualquer API no produto. Se você criou a instância de Gerenciamento de API, é um administrador e está automaticamente inscrito em cada produto por padrão.

Em alguns tipos de preço, 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 configurações posteriormente por meio 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ções a uma API existente

Para acrescentar um aplicativo de funções a uma API existente:

Na instância do serviço gerenciamento de API do Azure, selecione APIs> no painel esquerdo.
Escolha uma API para a qual você deseja importar um aplicativo de funções. Selecione as reticências (...) ao lado da API e selecione Importar:
Selecione o bloco Aplicativo de funções:
Na Janela Importar do Aplicativo de Funções, selecione Procurar:
Clique no botão Selecionar em Definir as configurações necessárias para escolher na lista de aplicativos de funções disponíveis:
Localize o aplicativo de funções do qual você 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ções do Azure, esses itens são gerados automaticamente:

Uma chave de host no aplicativo 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 de host.

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

Aviso

A remoção ou alteração do valor da chave do host do aplicativo de funções do Azure ou do valor nomeado do Gerenciamento de API do Azure interromperá a comunicação entre os serviços. Os valores não são sincronizados automaticamente.

Se você precisar girar a chave de host, também altere o valor nomeado no Gerenciamento de API.

Acessar a chave de host do Aplicativo de funções do Azure

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

Acessar o valor nomeado no Gerenciamento de API

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

Testar a nova API no portal do Azure

Você pode chamar as operações diretamente do portal do Azure. Usar o portal do Azure é uma maneira conveniente de exibir e testar as operações de uma API.

Selecione a API criada na seção anterior.
Selecione a guia Testar.
Selecione a operação que você deseja testar.
- A página exibe os campos dos parâmetros de consulta e dos cabeçalhos.
- Um dos cabeçalhos é Ocp-Apim-Subscription-Key. Esse cabeçalho é para a chave de assinatura do produto associada à API.
- Se você criou a instância de Gerenciamento de API, será um administrador, portanto, a chave será preenchida automaticamente.
Selecione Enviar.

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

Compartilhar via