Início rápido: Criar e gerenciar fluxos de trabalho com a CLI do Azure nos Aplicativos Lógicos do Azure

Artigo
01/04/2024

Aplica-se a: Aplicativos Lógicos do Azure (Consumo)

Este início rápido mostra como criar e gerenciar fluxos de trabalho automatizados que são executados nos Aplicativos Lógicos do Azure usando a extensão de Aplicativos Lógicos da CLI do Azure (az logic). Na linha de comando, você pode criar um aplicativo lógico de Consumo nos Aplicativos Lógicos multilocatário do Azure usando o arquivo JSON para uma definição de fluxo de trabalho de aplicativo lógico. Em seguida, você pode gerenciar seu aplicativo lógico executando operações como list, show (get), update e delete na linha de comando.

Aviso

Atualmente, a extensão de Aplicativos Lógicos para a CLI do Azure está em fase experimental e não é coberta pelo atendimento ao cliente. Use essa extensão da CLI com cuidado, especialmente se optar por usar a extensão em ambientes de produção.

Este início rápido atualmente se aplica apenas a fluxos de trabalho de aplicativos lógicos de consumo que são executados nos Aplicativos Lógicos do Azure multilocatário. Atualmente, a CLI do Azure não está disponível para fluxos de trabalho do aplicativo lógico Standard que são executados nos Aplicativos Lógicos do Azure de locatário único. Para saber mais, veja Diferenças de host e tipo de recurso nos Aplicativos Lógicos do Azure.

Se você não estiver familiarizado com os Aplicativos Lógicos do Azure, aprenda a criar seu primeiro fluxo de trabalho de aplicativo lógico de consumo por meio do portal do Azure, no Visual Studio e no Visual Studio Code.

Pré-requisitos

Uma conta do Azure com uma assinatura ativa. Se você não tiver uma assinatura do Azure, crie uma conta gratuita.
A CLI do Azure instalada no computador local.
A extensão de Aplicativos Lógicos do Azure para a CLI instalada no computador. Para instalar essa extensão, use este comando: az extension add --name logic
Um grupo de recursos do Azure no qual o aplicativo lógico será criado.

Verificação de pré-requisitos

Antes de começar, valide seu ambiente:

Entre no portal do Azure e verifique se a sua assinatura está ativa executando az login.
Verifique sua versão da CLI do Azure em uma janela Comando ou de terminal executando az --version. Para obter a última versão, confira as notas sobre a versão mais recente.

Caso não tenha a última versão, atualize a instalação seguindo o guia de instalação para seu sistema operacional ou sua plataforma.

Exemplo – Criar o grupo de recursos

Caso ainda não tenha um grupo de recursos para seu aplicativo lógico, crie o grupo com o comando az group create. Por exemplo, o comando a seguir cria um grupo de recursos chamado testResourceGroup na localização westus.

az group create --name testResourceGroup --location westus

A saída mostra o provisioningState como Succeeded quando o grupo de recursos é criado com êxito:

<...>
  "name": "testResourceGroup",
  "properties": {
    "provisioningState": "Succeeded"
  },
<...>

Definição de fluxo de trabalho

Para criar um aplicativo lógico ou atualizar um aplicativo lógico existente usando a CLI do Azure, você precisará ter uma definição de fluxo de trabalho para o aplicativo lógico. No portal do Azure, veja a definição de fluxo de trabalho subjacente do aplicativo lógico no formato JSON alternando a exibição de Designer para a exibição de Código.

Quando você executa os comandos necessários para criar ou atualizar o aplicativo lógico, a definição de fluxo de trabalho é carregada como um parâmetro obrigatório (--definition). Você precisa criar a definição de fluxo de trabalho como um arquivo JSON que segue o esquema da Linguagem de Definição de Fluxo de Trabalho.

Criar aplicativos lógicos por meio da CLI

Para criar um fluxo de trabalho de aplicativo lógico por meio da CLI do Azure, use o comando az logic workflow create com um arquivo JSON para a definição.

az logic workflow create --definition
                         --location
                         --name
                         --resource-group
                         [--access-control]
                         [--endpoints-configuration]
                         [--integration-account]
                         [--state {Completed, Deleted, Disabled, Enabled, NotSpecified, Suspended}]
                         [--tags]

O comando precisa incluir os seguintes parâmetros obrigatórios:

Parâmetro	Valor	Descrição
Definição de fluxo de trabalho	`--definition`	Um arquivo JSON com a definição de fluxo de trabalho do aplicativo lógico.
Location	`--location -l`	A região do Azure na qual o aplicativo lógico está localizado.
Nome	`--name -n`	O nome do aplicativo lógico. O nome só pode conter letras, números, hifens (`-`), sublinhados (`_`), parênteses (`()`) e pontos (`.`). O nome também precisa ser exclusivo entre as regiões.
Nome do grupo de recursos	`--resource-group -g`	O grupo de recursos do Azure no qual você deseja criar o aplicativo lógico. Crie um grupo de recursos antes de começar, caso ainda não tenha um para seu aplicativo lógico.

Você também pode incluir parâmetros adicionais opcionais para configurar os controles de acesso, os pontos de extremidade, a conta de integração, o estado e as marcas de recurso do seu aplicativo lógico.

Exemplo – Criar o aplicativo lógico

Neste exemplo, um fluxo de trabalho chamado testLogicApp é criado no grupo de recursos testResourceGroup na localização westus. O arquivo JSON testDefinition.json contém a definição de fluxo de trabalho.

az logic workflow create --resource-group "testResourceGroup" --location "westus" --name "testLogicApp" --definition "testDefinition.json"

Quando o fluxo de trabalho é criado com êxito, a CLI mostra o código JSON da nova definição de fluxo de trabalho. Se a criação do fluxo de trabalho falhar, confira a lista de possíveis erros.

Atualizar aplicativos lógicos por meio da CLI

Para atualizar o fluxo de trabalho de um aplicativo lógico por meio da CLI do Azure, use o comando az logic workflow create.

O comando precisa incluir os mesmos parâmetros obrigatórios usados quando você cria um aplicativo lógico. Adicione também os mesmos parâmetros opcionais usados durante a criação de um aplicativo lógico.

az logic workflow create --definition
                         --location
                         --name
                         --resource-group
                         [--access-control]
                         [--endpoints-configuration]
                         [--integration-account]
                         [--integration-service-environment]
                         [--state {Completed, Deleted, Disabled, Enabled, NotSpecified, Suspended}]
                         [--tags]

Exemplo – Atualizar o aplicativo lógico

Neste exemplo, o fluxo de trabalho de exemplo criado na seção anterior é atualizado para usar outro arquivo de definição JSON, newTestDefinition.json e adicionar duas marcas de recurso, testTag1 e testTag2, com valores de descrição.

az logic workflow create --resource-group "testResourceGroup" --location "westus" --name "testLogicApp" --definition "newTestDefinition.json" --tags "testTag1=testTagValue1" "testTag2=testTagValue"

Quando o fluxo de trabalho é atualizado com êxito, a CLI mostra a definição de fluxo de trabalho atualizada do aplicativo lógico. Se a atualização falhar, confira a lista de possíveis erros.

Excluir aplicativos lógicos por meio da CLI

Para excluir o fluxo de trabalho de um aplicativo lógico por meio da CLI do Azure, use o comando az logic workflow delete.

O comando precisa incluir os seguintes parâmetros obrigatórios:

Parâmetro	Valor	Descrição
Nome	`--name -n`	O nome do aplicativo lógico.
Nome do grupo de recursos	`-resource-group -g`	O grupo de recursos no qual o aplicativo lógico está localizado.

Inclua também um parâmetro opcional para ignorar os avisos de confirmação, --yes -y.

az logic workflow delete --name
                         --resource-group
                         [--yes]

Em seguida, a CLI solicita a confirmação da exclusão do aplicativo lógico. Ignore o aviso de confirmação usando o parâmetro opcional --yes -y com o comando.

Are you sure you want to perform this operation? (y/n):

Para confirmar a exclusão de um aplicativo lógico, liste seus aplicativos lógicos na CLI ou veja-os no portal do Azure.

Exemplo – Excluir o aplicativo lógico

Neste exemplo, o fluxo de trabalho de exemplo criado em uma seção anterior é excluído.

az logic workflow delete --resource-group "testResourceGroup" --name "testLogicApp"

Depois que você responde ao aviso de confirmação com y, o aplicativo lógico é excluído.

Considerações – Excluir o aplicativo lógico

A exclusão de um aplicativo lógico afeta as instâncias de fluxo de trabalho das seguintes maneiras:

Os Aplicativos Lógicos do Azure têm como meta cancelar qualquer execução em andamento e pendente.

Mesmo com um grande volume ou uma lista de pendências, a maioria das execuções é cancelada antes da conclusão ou do início. No entanto, o processo de cancelamento pode levar algum tempo para ser concluído. Enquanto isso, algumas execuções podem ser selecionadas para execução enquanto o runtime funciona por meio do processo de cancelamento.
Os Aplicativos Lógicos do Azure não criam nem executam novas instâncias do fluxo de trabalho.
Se você excluir um fluxo de trabalho e recriar o mesmo fluxo de trabalho, o fluxo de trabalho recriado não terá os mesmos metadados do fluxo de trabalho excluído. Você precisará salvar novamente qualquer fluxo de trabalho que chamou o fluxo de trabalho excluído. Dessa forma, o chamador obtém as informações corretas para o fluxo de trabalho recriado. Caso contrário, as chamadas ao fluxo de trabalho recriado falharão com um erro Unauthorized. Esse comportamento também se aplica aos fluxos de trabalho que usam artefatos em contas de integração e fluxos de trabalho que chamam funções do Azure.

Mostrar aplicativos lógicos na CLI

Para obter o fluxo de trabalho de um aplicativo lógico específico, use o comando az logic workflow show.

az logic workflow show --name
                       --resource-group

O comando precisa incluir os parâmetros obrigatórios a seguir

Parâmetro	Valor	Descrição
Nome	`--name -n`	O nome do aplicativo lógico.
Nome do grupo de recursos	`--resource-group -g`	O nome do grupo de recursos no qual o aplicativo lógico está localizado.

Exemplo – Obter o aplicativo lógico

Neste exemplo, o aplicativo lógico testLogicApp no grupo de recursos testResourceGroup é retornado com logs completos para depuração.

az logic workflow show --resource-group "testResourceGroup" --name "testLogicApp" --debug

Listar aplicativos lógicos na CLI

Para listar seus aplicativos lógicos por assinatura, use o comando az logic workflow list. Ele retorna o código JSON para os fluxos de trabalho do aplicativo lógico.

Filtre os resultados pelos seguintes parâmetros opcionais:

Parâmetro	Valor	Descrição
Nome do grupo de recursos	`--resource-group -g`	O nome do grupo de recursos pelo qual você deseja filtrar os resultados.
Número de itens	`--top`	O número de itens incluídos nos resultados.
Filtrar	`--filter`	O tipo de filtro que você está usando na sua lista. Filtre a lista por estado (`State`), por gatilho (`Trigger`) e pelo identificador do recurso referenciado (`ReferencedResourceId`).

az logic workflow list [--filter]
                       [--resource-group]
                       [--top]

Exemplo – Listar os aplicativos lógicos

Neste exemplo, todos os fluxos de trabalho habilitados no grupo de recursos testResourceGroup são retornados em um formato de tabela ASCII.

az logic workflow list --resource-group "testResourceGroup" --filter "(State eq 'Enabled')" --output "table"

Errors

O erro a seguir indica que a extensão de Aplicativos Lógicos do Azure para a CLI não está instalada. Siga as etapas em pré-requisitos para instalar a extensão dos Aplicativos Lógicos no computador.

az: 'logic' is not in the 'az' command group. See 'az --help'. If the command is from an extension, please make sure the corresponding extension is installed. To learn more about extensions, please visit https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview

O erro a seguir pode indicar que o caminho do arquivo para carregar a definição de fluxo de trabalho está incorreto.

Expecting value: line 1 column 1 (char 0)

Parâmetros globais

Use os seguintes parâmetros opcionais globais da CLI do Azure com os comandos az logic:

Parâmetro	Valor	Descrição
Formato da saída	`--output -o`	Altere o formato de saída do JSON padrão.
Mostrar somente erros	`--only-show-errors`	Suprime os avisos e mostra somente os erros.
Detalhado	`--verbose`	Mostra logs detalhados.
Depurar	`--debug`	Mostra todos os logs de depuração.
Mensagem de ajuda	`--help -h`	Mostra a caixa de diálogo de ajuda.
Consulta	`--query`	Define uma cadeia de consulta JMESPath para a saída JSON.

Próximas etapas

Para saber mais sobre a CLI do Azure, confira a Documentação da CLI do Azure.

Veja exemplos de script adicionais da CLI dos Aplicativos Lógicos no navegador de exemplos de código da Microsoft.

Em seguida, você poderá criar uma lógica de aplicativo de exemplo por meio da CLI do Azure usando uma definição de fluxo de trabalho e script de exemplo.

Criar aplicativo lógico usando script de exemplo.

Compartilhar via