Compartilhar via

Início Rápido: Criar um aplicativo Python Durable Functions

  • Artigo

Use Durable Functions, um recurso do Azure Functions, para escrever funções com estado em um ambiente sem servidor. Você instala Durable Functions ​​instalando a extensão do Azure Functions no Visual Studio Code. A extensão gerencia estado, pontos de verificação e reinicializações em seu aplicativo.

Nesse início rápido, você usa a extensão de Funções Duráveis ​​no Visual Studio Code para criar e testar localmente um aplicativo de Durable Functions ​​"olá mundo" no Azure Functions. O aplicativo Durable Functions ​​orquestra e encadeia chamadas para outras funções. Em seguida, você publica o código de função no Azure. As ferramentas que você usa estão disponíveis por meio da extensão Visual Studio Code.

Captura de tela do aplicativo Durable Functions em execução no Azure.

Pré-requisitos

Para concluir este início rápido, você precisa de:

Caso você não tenha uma assinatura do Azure, crie uma conta gratuita do Azure antes de começar.

Criar seu projeto local

Nesta seção, você usará o Visual Studio Code para criar um projeto local do Azure Functions.

  1. No Visual Studio Code, selecione F1 (ou selecione Ctrl/Cmd+Shift+P) para abrir a paleta de comandos. No prompt (>), insira e selecione Azure Functions: Criar Novo Projeto.

    Captura de tela da janela Criar função.

  2. Selecione Procurar. Na caixa de diálogo Selecionar pasta, vá para uma pasta a ser usada em seu projeto e escolha Selecionar.

  1. Nos prompts, forneça as informações a seguir:

    Prompt Ação Descrição
    Selecione um idioma para o seu projeto de aplicativo de funções Selecione Python. Cria um projeto local do Python Functions.
    Selecione uma versão Selecione Azure Functions v4. Você verá essa opção somente quando o Core Tools ainda não estiver instalado. Nesse caso, o Core Tools é instalado na primeira vez que você executa o aplicativo.
    Versão do Python Selecione Python 3.7, Python 3.8, Python 3.9 ou Python 3.10. O Visual Studio Code cria um ambiente virtual usando a versão selecionada.
    Selecione um modelo para a primeira função do projeto Selecione Ignorar por enquanto.
    Selecione como deseja abrir o projeto Selecione Abrir na janela atual. Abre o Visual Studio Code na pasta selecionada.

  1. Nos prompts, forneça as informações a seguir:

    Prompt Valor Descrição
    Selecionar um idioma Selecione Python (modelo de programação V2). Cria um projeto local do Python Functions usando o modelo de programação V2.
    Selecione uma versão Selecione Azure Functions v4. Você verá essa opção somente quando o Core Tools ainda não estiver instalado. Nesse caso, o Core Tools é instalado na primeira vez que você executa o aplicativo.
    Versão do Python Selecione Python 3.7, Python 3.8, Python 3.9 ou Python 3.10. O Visual Studio Code cria um ambiente virtual usando a versão selecionada.
    Selecione como deseja abrir o projeto Selecione Abrir na janela atual. Abre o Visual Studio Code na pasta selecionada.

O Visual Studio Code instala as Azure Functions Core Tools se for necessário criar um projeto. Ele também cria o projeto de aplicativo de funções em uma pasta. Este projeto contém os arquivos de configuração host.json e local.settings.json.

Um arquivo requirements.txt também será criado na pasta raiz. Ele especifica os pacotes do Python necessários para a execução do aplicativo de funções.

Instalar o azure-functions-durable de PyPI

Quando você cria o projeto, a extensão Visual Studio Code do Azure Functions cria automaticamente um ambiente virtual com a versão Python selecionada. Em seguida, você precisará ativar o ambiente virtual em um terminal e instalar algumas dependências necessárias para o Azure Functions e as Durable Functions.

  1. Abra o arquivo requirements.txt no editor e altere o conteúdo dele para o seguinte código:

    azure-functions
azure-functions-durable

  2. Na pasta atual, abra o terminal integrado do editor (Ctrl+Shift+`).

  3. No terminal integrado, ative o ambiente virtual na pasta atual, dependendo do seu sistema operacional.

    source .venv/bin/activate

Em seguida, no terminal integrado onde o ambiente virtual está ativado, use pip para instalar os pacotes que você definiu.

python -m pip install -r requirements.txt

Criar suas funções

O aplicativo Durable Functions mais básico tem três funções:

  • Função orquestradora: um fluxo de trabalho que orquestra outras funções.
  • Função de atividade: uma função que é chamada pela função orquestradora, executa trabalho e, opcionalmente, retorna um valor.
  • Função de cliente: uma função regular no Azure que inicia uma função de orquestrador. Esse exemplo usa uma função acionada por HTTP.

Função de orquestrador

Você usa um modelo para criar o código do aplicativo Durable Functions ​​em seu projeto.

  1. Na paleta de comandos, insira e selecione Azure Functions: Criar Função.

  2. Nos prompts, forneça as informações a seguir:

    Prompt Ação Descrição
    Selecione um modelo para a função Selecione Orquestrador de Durable Functions. Cria uma orquestração de aplicativos de Durable Functions.
    Forneça um nome de função Selecione HelloOrchestrator. Um nome para sua função durável.

Você adicionou um orquestrador para coordenar funções de atividade. Abra HelloOrchestrator/__init__.py para ver a função de orquestrador. Cada chamada para context.call_activity invoca uma função de atividade chamada Hello.

Em seguida, você adiciona a função de atividade Hello referenciada.

Função de atividade

  1. Na paleta de comandos, insira e selecione Azure Functions: Criar Função.

  2. Nos prompts, forneça as informações a seguir:

    Prompt Ação Descrição
    Selecione um modelo para a função Selecione atividade Durable Functions. Cria uma função de atividade.
    Forneça um nome de função Digite Olá. O nome da sua função de atividade.

Você adicionou a função de atividade Hello que é chamada pelo orquestrador. Abra Hello/__init__.py para ver que ele aceita um nome como entrada e retorna uma saudação. Uma função de atividade é onde você executa ações como fazer uma chamada de banco de dados ou realizar um cálculo.

Por fim, você adiciona uma função acionada por HTTP que inicia a orquestração.

Função de cliente (iniciador de HTTP)

  1. Na paleta de comandos, insira e selecione Azure Functions: Criar Função.

  2. Nos prompts, forneça as informações a seguir:

    Prompt Ação Descrição
    Selecione um modelo para a função Selecione Iniciador HTTP de Durable Functions. Cria uma função inicial HTTP.
    Forneça um nome de função Insira DurableFunctionsHttpStart. O nome da sua função cliente
    Nível de autorização Selecione Anônimo. Para fins de demonstração, esse valor permite que a função seja chamada sem usar autenticação.

Você adicionou uma função acionada por HTTP que inicia uma orquestração. Abra DurableFunctionsHttpStart/__init__.py para ver que ele usa client.start_new para iniciar uma nova orquestração. Em seguida, ela usa client.create_check_status_response para retornar uma resposta HTTP contendo URLs que podem ser usadas para monitorar e gerenciar a nova orquestração.

Agora, você tem um aplicativo das Durable Functions que pode ser executado localmente e implantado no Azure.

Requisitos

A versão 2 do modelo de programação Python requer as seguintes versões mínimas:

Habilite o modelo de programação v2

A seguinte configuração de aplicativo é necessária para executar o modelo de programação v2:

  • Nome: AzureWebJobsFeatureFlags
  • Valor: EnableWorkerIndexing

Se você estiver executando localmente usando Azure Functions Core Tools, adicione essa configuração ao seu arquivo local.settings.json. Se você estiver executando no Azure, conclua essas etapas usando uma ferramenta relevante:

Substitua <FUNCTION_APP_NAME> e <RESOURCE_GROUP_NAME> pelo nome do seu aplicativo de funções e grupo de recursos, respectivamente.

az functionapp config appsettings set --name <FUNCTION_APP_NAME> --resource-group <RESOURCE_GROUP_NAME> --settings AzureWebJobsFeatureFlags=EnableWorkerIndexing

Para criar um aplicativo básico de Durable Functions ​​usando esses três tipos de função, substitua o conteúdo de function_app.py pelo seguinte código Python:

import azure.functions as func
import azure.durable_functions as df

myApp = df.DFApp(http_auth_level=func.AuthLevel.ANONYMOUS)

# An HTTP-triggered function with a Durable Functions client binding
@myApp.route(route="orchestrators/{functionName}")
@myApp.durable_client_input(client_name="client")
async def http_start(req: func.HttpRequest, client):
    function_name = req.route_params.get('functionName')
    instance_id = await client.start_new(function_name)
    response = client.create_check_status_response(req, instance_id)
    return response

# Orchestrator
@myApp.orchestration_trigger(context_name="context")
def hello_orchestrator(context):
    result1 = yield context.call_activity("hello", "Seattle")
    result2 = yield context.call_activity("hello", "Tokyo")
    result3 = yield context.call_activity("hello", "London")

    return [result1, result2, result3]

# Activity
@myApp.activity_trigger(input_name="city")
def hello(city: str):
    return f"Hello {city}"

Revise a tabela a seguir para obter uma explicação de cada função e sua finalidade no exemplo:

Método Descrição
hello_orchestrator A função de orquestrador, que descreve o fluxo de trabalho. Nesse caso, a orquestração é iniciada, invoca três funções em sequência e depois retorna os resultados ordenados de todas as três funções em uma lista.
hello A função de atividade, que executa o trabalho orquestrado. A função retorna uma saudação simples para a cidade passada como um argumento.
http_start Uma função acionada por HTTP que inicia uma instância da orquestração e retorna uma check status resposta.

Observação

Durable Functions ​​também suportam blueprints do Python v2. Para usar blueprints, registre suas funções de blueprint usando a classe azure-functions-durable Blueprint . Você pode registrar o blueprint resultante normalmente. Você pode usar nosso exemplo como exemplo.

Testar a função localmente

O Azure Functions Core Tools oferece a capacidade de executar um projeto do Azure Functions em seu computador de desenvolvimento local. Se não estiver instalado, você será solicitado a instalar essas ferramentas na primeira vez que iniciar uma função no Visual Studio Code.

  1. Para testar sua função, defina um ponto de interrupção no código de função de Hello atividade (em Hello/__init__.py). Selecione F5 ou selecione Debug: Start Debugging na paleta de comandos para iniciar o projeto do aplicativo de funções. A saída do Core Tools aparece no painel do terminal.

    Observação

    Para obter mais informações sobre depuração, veja Diagnóstico de Durable Functions.

  1. Para testar a função, defina um ponto de interrupção no código da função de atividade hello. Selecione F5 ou selecione Debug: Start Debugging na paleta de comandos para iniciar o projeto do aplicativo de funções. A saída do Core Tools aparece no painel do terminal.

    Observação

    Para obter mais informações sobre depuração, veja Diagnóstico de Durable Functions.

  1. A Durable Functions ​​requerem uma conta de armazenamento do Azure para funcionar. Quando o Visual Studio Code solicitar a seleção de uma conta de armazenamento, escolha Selecionar conta de armazenamento.

    Captura de tela de como criar uma conta de armazenamento.

  2. Quando solicitado, forneça as seguintes informações para criar uma nova conta de armazenamento no Azure.

    Prompt Ação Descrição
    Selecionar uma assinatura Selecione o nome da sua assinatura. Sua assinatura do Azure.
    Selecione uma conta de armazenamento Selecione Criar uma nova conta de armazenamento.
    Insira o nome da nova conta de armazenamento Insira um nome exclusivo. O nome da conta de armazenamento a ser criada.
    Selecione um grupo de recursos Insira um nome exclusivo. Nome do grupo de recursos a ser criado.
    Selecionar um local Selecionar uma Região do Azure. Selecione uma região que esteja perto de você.

  3. No painel do terminal, copie o ponto de extremidade da URL da sua função acionada por HTTP.

    Captura de tela da saída local do Azure.

  1. Use seu navegador ou uma ferramenta de teste HTTP para enviar uma solicitação HTTP POST para o ponto de extremidade da URL.

    Substitua o último segmento pelo nome da função de orquestrador (HelloOrchestrator). A URL deve ser semelhante a http://localhost:7071/api/orchestrators/HelloOrchestrator.

    A resposta é o resultado inicial da função HTTP. Ele permite que você saiba que a orquestração durável foi iniciada com êxito. Ainda não exibe o resultado final da orquestração. A resposta inclui algumas URLs úteis. Por enquanto, consulte o status da orquestração.

  2. Copie o valor do URL para statusQueryGetUri, cole-o na barra de endereço do seu navegador e execute a solicitação. Você também pode continuar a usar sua ferramenta de teste HTTP para emitir a solicitação GET.

    A solicitação consulta a instância de orquestração do status. Você deverá ver que a instância foi concluída e inclui as saídas ou resultados da função durável. Ele é semelhante a este exemplo:

    {
    "name": "HelloOrchestrator",
    "instanceId": "9a528a9e926f4b46b7d3deaa134b7e8a",
    "runtimeStatus": "Completed",
    "input": null,
    "customStatus": null,
    "output": [
        "Hello Tokyo!",
        "Hello Seattle!",
        "Hello London!"
    ],
    "createdTime": "2020-03-18T21:54:49Z",
    "lastUpdatedTime": "2020-03-18T21:54:54Z"
}

  1. Use seu navegador ou uma ferramenta de teste HTTP para enviar uma solicitação HTTP POST para o ponto de extremidade da URL.

    Substitua o último segmento pelo nome da função de orquestrador (HelloOrchestrator). A URL deve ser semelhante a http://localhost:7071/api/orchestrators/HelloOrchestrator.

    A resposta é o resultado inicial da função HTTP. Ele permite que você saiba que a orquestração durável foi iniciada com êxito. Ainda não exibe o resultado final da orquestração. A resposta inclui algumas URLs úteis. Por enquanto, consulte o status da orquestração.

  2. Copie o valor do URL para statusQueryGetUri, cole-o na barra de endereço do seu navegador e execute a solicitação. Você também pode continuar a usar sua ferramenta de teste HTTP para emitir a solicitação GET.

    A solicitação consulta a instância de orquestração do status. Você deverá ver que a instância foi concluída e inclui as saídas ou resultados da função durável. Ele é semelhante a este exemplo:

    {
    "name": "hello_orchestrator",
    "instanceId": "9a528a9e926f4b46b7d3deaa134b7e8a",
    "runtimeStatus": "Completed",
    "input": null,
    "customStatus": null,
    "output": [
        "Hello Tokyo!",
        "Hello Seattle!",
        "Hello London!"
    ],
    "createdTime": "2020-03-18T21:54:49Z",
    "lastUpdatedTime": "2020-03-18T21:54:54Z"
}
  1. Para interromper a depuração, no Visual Studio Code, selecione Shift+F5.

Depois de verificar se a função funciona corretamente no seu computador local, é hora de publicar o projeto no Azure.

Entrar no Azure

Antes de criar recursos do Azure ou publicar o aplicativo, entre no Azure.

  1. Se ainda não estiver conectado, selecione o ícone do Azure na barra de Atividades. Em seguida, em Recursos, selecione Entrar no Azure.

    Captura de tela do login na janela do Azure no Visual Studio Code.

    Se você já estiver conectado e puder ver suas assinaturas existentes, vá para a próxima seção. Se ainda não tiver uma conta do Azure, selecione Criar uma Conta do Azure. Os alunos podem selecionar Criar uma Conta do Microsoft Azure for Students.

  2. Quando for solicitado no navegador, selecione sua conta do Azure e entre usando as credenciais da sua conta do Azure. Se você criar uma conta, poderá se conectar depois que a conta for criada.

  3. Após fazer login com sucesso, você poderá fechar a nova janela do navegador. As assinaturas que pertencem à sua conta do Azure são exibidas na barra lateral.

Criar o aplicativo de funções no Azure

Nesta seção, você criará um aplicativo de funções e os recursos relacionados na sua assinatura do Azure. Muitas das decisões de criação de recursos são tomadas para você com base em comportamentos padrão. Para obter mais controle sobre os recursos criados, você deve, em vez disso, criar seu aplicativo de funções com opções avançadas.

  1. No Visual Studio Code, pressione F1 para abrir a paleta de comandos. No prompt (>), insira e, em seguida, selecione Azure Functions: Criar Aplicativo de Funções no Azure.

  2. Nos prompts, forneça as informações a seguir:

    Prompt Ação
    Selecionar uma assinatura Selecione a Assinatura do Azure a ser usada. O prompt não aparece quando você tem apenas uma assinatura visível em Recursos.
    Insira um nome exclusivo globalmente para o aplicativo de funções Digite um nome que seja válido em um caminho de URL. O nome que você digitar será validado para garantir que seja exclusivo no Azure Functions.
    Selecionar uma pilha de runtime Selecione a versão da linguagem que você executa localmente no momento.
    Selecione uma localização para novos recursos Selecionar uma Região do Azure. Para obter um melhor desempenho, escolha uma região perto de você.

    No painel Azure: Log de Atividades, a extensão do Azure mostra o status dos recursos individuais à medida que são criados no Azure.

    Captura de tela mostrando o log da criação de recursos do Azure.

  3. Quando o aplicativo de funções é criado, os seguintes recursos relacionados são criados na sua assinatura do Azure. Os recursos são nomeados com base no nome que você inseriu para o seu aplicativo de funções.

    • Um grupo de recursos, que é um contêiner lógico para recursos relacionados.
    • Uma conta de armazenamento do Azure padrão, 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 lhe permite agrupar funções como uma unidade lógica para facilitar o gerenciamento, a implantação e o compartilhamento de recursos dentro do mesmo plano de hospedagem.
    • Um plano do Serviço de Aplicativo do Azure, que define o host subjacente do seu aplicativo de funções.
    • Uma instância do Application Insights conectada ao aplicativo de funções que acompanha o uso das suas funções no aplicativo.

    Uma notificação é exibida depois que seu aplicativo de funções é criado e o pacote de implantação é aplicado.

    Dica

    Por padrão, os recursos do Azure exigidos por seu aplicativo de funções são criados com base no nome que você inseriu para o seu aplicativo de funções. Por padrão, os recursos são criados com o aplicativo de funções no mesmo novo grupo de recursos. Para personalizar os nomes dos recursos associados ou reutilizar os recursos existentes, publique o projeto com opções avançadas de criação.

Implantar o projeto no Azure

Importante

A implantação em um aplicativo de funções existente sempre substitui o conteúdo do aplicativo no Azure.

  1. Na paleta de comandos, insira e, em seguida, selecione Azure Functions: Implantar no Aplicativo de Funções.

  2. Selecione o aplicativo de funções que você acabou de criar. Quando solicitado sobre a substituição de implantações anteriores, selecione Implantar para implantar seu código de função no novo recurso do aplicativo de funções.

  3. Após sua implantação ser concluída, escolha Ver o resultado para ver os resultados da criação e da implantação, incluindo os recursos do Azure que você criou. Se você deixou passar a notificação, selecione o ícone de sino no canto inferior direito para vê-la novamente.

    Captura de tela da janela Exibir saída

Testar sua função no Azure

  1. Copie a URL do gatilho HTTP do painel de saída. A URL que chama sua função acionada por HTTP deve estar nesse formato:

    https://<functionappname>.azurewebsites.net/api/orchestrators/HelloOrchestrator

  1. Copie a URL do gatilho HTTP do painel de saída. A URL que chama sua função acionada por HTTP deve estar nesse formato:

    https://<functionappname>.azurewebsites.net/api/orchestrators/hello_orchestrator

  1. Cole o novo URL da solicitação HTTP na barra de endereço do seu navegador. Ao usar o aplicativo publicado, você pode esperar obter a mesma resposta de status que obteve quando testou localmente.

O aplicativo Python Durable Functions que você criou e publicou usando o Visual Studio Code está pronto para uso.

Limpar os recursos

Se já não precisar dos recursos que criou para concluir o arranque rápido, para evitar custos relacionados na sua subscrição do Azure, elimine o grupo de recursos e todos os recursos relacionados.

Conteúdo relacionado