Início Rápido: criar uma função Python no Azure da linha de comando

Artigo
03/07/2024

Neste artigo, você usa ferramentas de linha de comando para criar uma função em Python que responde a solicitações HTTP. Após testar o código localmente, implante-o no ambiente sem servidor do Azure Functions.

Esse artigo utiliza o modelo de programação Python v2 para Azure Functions, que fornece uma abordagem baseada em decorador para a criação de funções. Para saber mais sobre o modelo de programação Python v2, veja o Guia de referência do desenvolvedor

A realização deste início rápido gera um pequeno custo de alguns centavos de dólar ou menos em sua conta do Azure.

Há também uma versão baseada no Visual Studio Code deste artigo.

Configurar o ambiente local

Antes de começar, você precisa ter os seguintes requisitos em vigor:

Uma conta do Azure com uma assinatura ativa. Crie uma conta gratuitamente.
Uma das seguintes ferramentas para a criação de recursos do Azure:
- CLI do Azure, versão 2.4 ou posterior.
- O módulo PowerShell Az do Azure, versão 5.9.0 ou posterior.
Uma versão do Python com suporte do Azure Functions.
O emulador de armazenamento do Azurite. Embora você também possa usar uma conta real do Armazenamento do Azure, o artigo pressupõe que você esteja usando esse emulador.

Instalação das ferramentas básicas do Azure Functions

A maneira recomendada de instalar o Core Tools depende do sistema operacional do computador de desenvolvimento local.

As etapas a seguir usam um instalador do Windows (MSI) para instalar o Core Tools v4.x. Para obter mais informações sobre outros instaladores baseados em pacote, confira o arquivo leiame do Core Tools.

Baixe e execute o instalador do Core Tools, com base em sua versão do Windows:

v4.x - Windows de 64 bits (recomendado. A depuração do Visual Studio Code requer 64 bits).
v4.x – Windows 32 bits

Se você usou anteriormente o instalador do Windows (MSI) para instalar o Core Tools no Windows, desinstale a versão antiga em Adicionar ou Remover Programas antes de instalar a versão mais recente.

As etapas a seguir usam o Homebrew para instalar as ferramentas principais em macOS.

Instale o Homebrew, se ele ainda não estiver instalado.

Instale o pacote de ferramentas principais:

brew tap azure/functions
brew install azure-functions-core-tools@4
# if upgrading on a machine that has 2.x or 3.x installed:
brew link --overwrite azure-functions-core-tools@4

As etapas a seguir usma APT para instalar as ferramentas principais em sua distribuição Ubuntu/Debian Linux. Para outras distribuições do Linux, confira o arquivo Leiame das ferramentas principais.

Instale a chave GPG do repositório de pacotes da Microsoft para validar a integridade do pacote:

curl https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor > microsoft.gpg
sudo mv microsoft.gpg /etc/apt/trusted.gpg.d/microsoft.gpg

Configure a lista de fontes de APT antes de fazer uma atualização de APT.

Ubuntu

sudo sh -c 'echo "deb [arch=amd64] https://packages.microsoft.com/repos/microsoft-ubuntu-$(lsb_release -cs 2>/dev/null)-prod $(lsb_release -cs 2>/dev/null) main" > /etc/apt/sources.list.d/dotnetdev.list'

Debian

sudo sh -c 'echo "deb [arch=amd64] https://packages.microsoft.com/debian/$(lsb_release -rs 2>/dev/null | cut -d'.' -f 1)/prod $(lsb_release -cs 2>/dev/null) main" > /etc/apt/sources.list.d/dotnetdev.list'

Verifique se o arquivo /etc/apt/sources.list.d/dotnetdev.list contém uma das cadeias de cadeia de caracteres de versões apropriadas do Linux na tabela a seguir:

Distribuição do Linux	Versão
Debian 12	`bookworm`
Debian 11	`bullseye`
Debian 10	`buster`
Debian 9	`stretch`
Ubuntu 22.04	`jammy`
Ubuntu 20.04	`focal`
Ubuntu 19.04	`disco`
Ubuntu 18.10	`cosmic`
Ubuntu 18.04	`bionic`
Ubuntu 17.04	`zesty`
Ubuntu 16.04/Linux Mint 18	`xenial`

Inicie a atualização da fonte de APT:
```
sudo apt-get update
```

Instale o pacote de ferramentas principais:

sudo apt-get install azure-functions-core-tools-4

Use o comando func --version para garantir que sua versão do Core Tools seja pelo menos 4.0.5530.

Criar e ativar um ambiente virtual

Em uma pasta adequada, execute os comandos a seguir para criar e ativar um ambiente virtual chamado .venv. Verifique se você está usando uma versão do Python com suporte do Azure Functions.

python -m venv .venv

source .venv/bin/activate

Se o Python não instalou o pacote venv na distribuição do Linux, execute o seguinte comando:

sudo apt-get install python3-venv

py -m venv .venv

.venv\scripts\activate

py -m venv .venv

.venv\scripts\activate

Você executará todos os comandos posteriores neste ambiente virtual ativado.

Criar uma função local

No Azure Functions, um projeto de função é um contêiner para uma ou mais funções individuais que respondem, cada uma, a um gatilho específico. Todas as funções em um projeto compartilham as configurações locais e de hospedagem.

Nesta seção, você cria um projeto de função e adiciona uma função disparada por HTTP.

Execute o comando da func init seguinte maneira para criar um projeto de funções do Python v2 no ambiente virtual.
```
func init --python
```
Essa pasta contém vários arquivos do projeto, incluindo arquivos de configuração chamados local.settings.json e host.json. Como local.settings.json pode conter segredos baixados do Azure, o arquivo é excluído do controle do código-fonte por padrão no arquivo .gitignore.
Adicione uma função ao projeto usando o comando a seguir, em que o argumento --name é o nome exclusivo da função (HttpExample) e o argumento --template especifica o gatilho da função (HTTP).
```
func new --name HttpExample --template "HTTP trigger" --authlevel "anonymous"
```
Se solicitado, escolha a opção ANONYMOUS . func new adiciona um ponto de extremidade de gatilho HTTP nomeado HttpExample para o function_app.py arquivo, que é acessível sem autenticação.

Executar a função localmente

Execute a função iniciando o host de runtime local do Azure Functions na pasta LocalFunctionProj.
```
func start
```
Perto do fim da saída, as seguintes linhas precisam ser exibidas:

Observação

Se HttpExample não aparece conforme mostrado acima, é provável que você tenha iniciado o host fora da pasta raiz do projeto. Nesse caso, use CTRL+C para interromper o host, procure a pasta raiz do projeto e execute o comando anterior novamente.
Copie a URL da função HTTP dessa saída para um navegador e acrescente a cadeia de caracteres de consulta ?name=<YOUR_NAME>, fazendo com que a URL completa seja http://localhost:7071/api/HttpExample?name=Functions. O navegador exibirá uma mensagem de resposta que retorna o valor da cadeia de consulta. O terminal em que você iniciou seu projeto também mostra a saída do log conforme você faz solicitações.
Quando terminar, pressione CTRL + C e digite y para interromper o host de funções.

Criar recursos de suporte do Azure para a função

Antes de poder implantar o código da função no Azure, você precisa criar três recursos:

Um grupo de recursos, que é um contêiner lógico para recursos relacionados.
Uma conta de armazenamento, que mantém o estado e outras informações sobre seus projetos.
Um aplicativo de funções, que fornece o ambiente para a execução do código de função. Um aplicativo de funções é mapeado para seu projeto de função local e permite agrupar funções como uma unidade lógica para facilitar o gerenciamento, a implantação e o compartilhamento de recursos.

Use os comandos a seguir para criar esses itens. Tanto a CLI do Azure quanto o PowerShell são compatíveis.

Se necessário, entre no Azure.
- CLI do Azure
- PowerShell do Azure
```
az login
```
O comando az login conecta você à conta do Azure.
```
Connect-AzAccount
```
O cmdlet Connect-AzAccount conecta você à conta do Azure.
Crie um grupo de recursos chamado AzureFunctionsQuickstart-rg na região de sua escolha.
- CLI do Azure
- PowerShell do Azure
```
az group create --name AzureFunctionsQuickstart-rg --location <REGION>
```
O comando az group create cria um grupo de recursos. No comando acima, substitua <REGION> por uma região perto de você, usando um código de região disponível retornado do comando <REGION>.
```
New-AzResourceGroup -Name AzureFunctionsQuickstart-rg -Location '<REGION>'
```
O comando New-AzResourceGroup cria um grupo de recursos. De modo geral, você cria o grupo de recursos e os recursos em uma região próxima a você usando uma região disponível retornada do cmdlet Get-AzLocation.
Observação

Você não pode hospedar aplicativos Windows e Linux no mesmo grupo de recursos. Se você tiver um grupo de recursos chamado AzureFunctionsQuickstart-rg com um aplicativo de funções ou um aplicativo Web do Windows, você precisará usar um grupo de recursos diferente.
Crie uma conta de armazenamento para uso geral no grupo de recursos e na região.
- CLI do Azure
- PowerShell do Azure
```
az storage account create --name <STORAGE_NAME> --location <REGION> --resource-group AzureFunctionsQuickstart-rg --sku Standard_LRS
```
O comando az storage account create cria a conta de armazenamento.
```
New-AzStorageAccount -ResourceGroupName AzureFunctionsQuickstart-rg -Name <STORAGE_NAME> -SkuName Standard_LRS -Location <REGION>
```
O cmdlet New-AzStorageAccount cria a conta de armazenamento.
No exemplo anterior, substitua <STORAGE_NAME> por um nome que seja apropriado para você e exclusivo no Armazenamento do Azure. Os nomes precisam conter de três a 24 caracteres e só podem conter números e letras minúsculas. Standard_LRS especifica uma conta de uso geral, compatível com o Functions.

A conta de armazenamento gera apenas alguns centavos de dólar para este início rápido.
Crie o aplicativo de funções no Azure.
- CLI do Azure
- PowerShell do Azure
```
az functionapp create --resource-group AzureFunctionsQuickstart-rg --consumption-plan-location westeurope --runtime python --runtime-version <PYTHON_VERSION> --functions-version 4 --name <APP_NAME> --os-type linux --storage-account <STORAGE_NAME>
```
O comando az functionapp create cria o aplicativo de funções no Azure. Você deve fornecer --os-type linux porque as funções do Python só são executadas no Linux.
```
New-AzFunctionApp -Name <APP_NAME> -ResourceGroupName AzureFunctionsQuickstart-rg -StorageAccountName <STORAGE_NAME> -FunctionsVersion 4 -RuntimeVersion <PYTHON_VERSION> -Runtime python -Location '<REGION>'
```
O cmdlet New-AzFunctionApp cria o aplicativo de funções no Azure.
No exemplo anterior, substitua <APP_NAME> por um nome exclusivo globalmente que for adequado para você. O <APP_NAME> também é o domínio do DNS padrão para o aplicativo de funções. Verifique se o valor definido <PYTHON_VERSION> é uma versão compatível com o Functions e é a mesma versão usada durante o desenvolvimento local.

Este comando cria um aplicativo de funções que executa o runtime da linguagem especificada no Plano de Consumo do Azure Functions, que é gratuito para o uso que você fará aqui. O comando também cria uma instância associada do Azure Application Insights no mesmo grupo de recursos, com o qual será possível monitorar o aplicativo de funções e exibir os logs. Para saber mais, consulte Monitorar Azure Functions. A instância não gera nenhum custo até você ativá-la.

Implantar o projeto de funções no Azure

Depois de criar com êxito o seu aplicativo de funções no Azure, agora você estará pronto para implantar seu projeto de funções local usando o comando func azure functionapp publish.

Na pasta raiz do projeto, execute este comando func azure functionapp publish:

func azure functionapp publish <APP_NAME>

Nesse exemplo, substitua <APP_NAME> pelo nome de seu aplicativo. Uma implantação bem-sucedida mostra resultados semelhantes à seguinte saída (truncada para simplificar):

...

Getting site publishing info...
Creating archive for current directory...
Performing remote build for functions project.

...

Deployment successful.
Remote build succeeded!
Syncing triggers...
Functions in msdocs-azurefunctions-qs:
    HttpExample - [httpTrigger]
        Invoke url: https://msdocs-azurefunctions-qs.azurewebsites.net/api/httpexample

Invocar a função no Azure

Como a função usa um gatilho HTTP, você a invoca fazendo uma solicitação HTTP para sua URL no navegador ou usando uma ferramenta como curl.

Navegador
curl

Copie a URL de Invocação completa mostrada na saída do comando publish na barra de endereços de um navegador, acrescentando o parâmetro de consulta ?name=Functions. O navegador deverá exibir uma saída semelhante à que foi exibida quando você executou a função localmente.

Limpar os recursos

Se você prosseguir para a próxima etapa e adicionar uma associação de saída da fila do Armazenamento do Azure, mantenha todos os recursos, pois você se baseará no que já fez.

Caso contrário, use o comando a seguir para excluir o grupo de recursos e todos os recursos contidos nele para evitar custos adicionais.

CLI do Azure
PowerShell do Azure

az group delete --name AzureFunctionsQuickstart-rg

Remove-AzResourceGroup -Name AzureFunctionsQuickstart-rg

Próximas etapas

Conectar-se ao Azure Cosmos DB

Conectar-se a uma fila do Armazenamento do Azure

Problemas com este artigo?

Compartilhar via