Partilhar via

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

  • Artigo

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

Este guia de 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 em aplicativos lógicos do Azure multilocatários 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), updatee delete a partir da linha de comando.

Aviso

A extensão de Aplicativos Lógicos da CLI do Azure é atualmente experimental e não é coberta pelo suporte ao cliente. Use essa extensão da CLI com cuidado, especialmente se você optar por usar a extensão em ambientes de produção.

Atualmente, este início rápido aplica-se apenas a fluxos de trabalho de aplicativos lógicos de consumo executados em Aplicativos Lógicos do Azure multilocatário. A CLI do Azure está atualmente indisponível para fluxos de trabalho de aplicativos lógicos padrão executados em Aplicativos Lógicos do Azure de locatário único. Para obter mais informações, consulte Tipo de recurso e diferenças de host nos Aplicativos Lógicos do Azure.

Se você é novo nos Aplicativos Lógicos do Azure, saiba como criar seu primeiro fluxo de trabalho de aplicativo lógico de consumo no portal do Azure ou no Visual Studio Code.

Pré-requisitos

  • Uma conta do Azure com uma subscrição ativa. Se não tiver uma subscrição do Azure, crie uma conta gratuita.

  • A CLI do Azure instalada no seu computador local.

  • A extensão da CLI dos Aplicativos Lógicos do Azure instalada no seu computador. Para instalar esta extensão, use este comando: az extension add --name logic

  • Um grupo de recursos do Azure no qual criar seu aplicativo lógico.

Verificação de pré-requisitos

Antes de começar, valide seu ambiente:

  • Entre no portal do Azure e verifique se sua assinatura está ativa executando az logino .

  • Verifique sua versão da CLI do Azure em um terminal ou janela de comando executando az --version. Para obter a versão mais recente, consulte as notas de versão mais recentes.

    Se não tiver a versão mais recente, atualize a instalação seguindo o guia de instalação do seu sistema operativo ou plataforma.

Exemplo - Criar grupo de recursos

Se você ainda não tiver 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 nomeado testResourceGroup no local westus.

az group create --name testResourceGroup --location westus

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

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

Definição do fluxo de trabalho

Antes de criar um novo aplicativo lógico ou atualizar um aplicativo lógico existente usando a CLI do Azure, você precisa de uma definição de fluxo de trabalho para seu aplicativo lógico. No portal do Azure, você pode exibir a definição de fluxo de trabalho subjacente do seu aplicativo lógico no formato JSON alternando do modo Designer para o modo Código.

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

Criar aplicativos lógicos a partir da CLI

Para criar um fluxo de trabalho de aplicativo lógico a partir 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]

Seu comando deve incluir os seguintes parâmetros necessários:

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

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

Exemplo - Criar aplicativo lógico

Neste exemplo, um fluxo de trabalho nomeado testLogicApp é criado no grupo testResourceGroup de recursos no local westus. O arquivo testDefinition.json JSON contém a definição do 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, consulte a lista de possíveis erros.

Atualizar aplicativos lógicos da CLI

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

Seu comando deve incluir os mesmos parâmetros necessários que quando você cria um aplicativo lógico. Você também pode adicionar os mesmos parâmetros opcionais que ao criar 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 aplicativo lógico

Neste exemplo, o fluxo de trabalho de exemplo criado na seção anterior é atualizado para usar um arquivo de definição JSON diferente, newTestDefinition.jsone adicionar duas marcas testTag1 de recurso 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 seu aplicativo lógico. Se a atualização falhar, consulte a lista de possíveis erros.

Excluir aplicativos lógicos da CLI

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

Seu comando deve incluir os seguintes parâmetros necessários:

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

Você também pode incluir um parâmetro opcional para ignorar prompts de confirmação, --yes -y.

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

Em seguida, a CLI solicita que você confirme a exclusão do seu aplicativo lógico. Você pode ignorar o prompt de confirmação usando o parâmetro --yes -y opcional com seu 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 exiba seus aplicativos lógicos no portal do Azure.

Exemplo - Excluir 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 de responder ao prompt de confirmação com y, o aplicativo lógico é excluído.

Considerações - Excluir 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 fazem o melhor esforço para cancelar quaisquer execuções em andamento e pendentes.

    Mesmo com um grande volume ou lista de pendências, a maioria das execuções são canceladas antes de terminarem ou começarem. No entanto, o processo de cancelamento pode levar tempo para ser concluído. Enquanto isso, algumas execuções podem ser pegas para execução enquanto o tempo de execução funciona através do processo de cancelamento.

  • Os Aplicativos Lógicos do Azure não criam nem executam novas instâncias de fluxo de trabalho.

  • Se você excluir um fluxo de trabalho e, em seguida, recriar o mesmo fluxo de trabalho, o fluxo de trabalho recriado não terá os mesmos metadados que o fluxo de trabalho excluído. Você precisa salvar novamente qualquer fluxo de trabalho chamado 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 para o fluxo de trabalho recriado falharão com um Unauthorized erro. Esse comportamento também se aplica a 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 um fluxo de trabalho de aplicativo lógico específico, use o comando az logic workflow show.

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

Seu comando deve incluir os seguintes parâmetros necessários:

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

Exemplo - Obter aplicativo lógico

Neste exemplo, o aplicativo testLogicApp lógico no grupo testResourceGroup de recursos é 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. Este comando retorna o código JSON para seus fluxos de trabalho de aplicativo lógico.

Você pode filtrar seus resultados pelos seguintes parâmetros opcionais:

Parâmetro valor Description
Nome do grupo de recursos --resource-group -g O nome do grupo de recursos pelo qual você deseja filtrar seus resultados.
Número de itens --top O número de itens incluídos nos resultados.
Filtro --filter O tipo de filtro que está a utilizar na sua lista. Você pode filtrar por estado (State), trigger (Trigger) e o identificador do recurso referenciado (ReferencedResourceId). 
az logic workflow list [--filter]
                       [--resource-group]
                       [--top]

Exemplo - Listar aplicativos lógicos

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

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

Erros

O erro a seguir indica que a extensão da CLI dos Aplicativos Lógicos do Azure não está instalada. Siga as etapas nos pré-requisitos para instalar a extensão Logic Apps no seu 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 sua definição de fluxo de trabalho está incorreto.

Expecting value: line 1 column 1 (char 0)

Parâmetros globais

Você pode usar os seguintes parâmetros globais opcionais da CLI do Azure com seus az logic comandos:

Parâmetro valor Description
Formato de saída --output -o Altere o formato de saída do JSON padrão.
Mostrar apenas erros --only-show-errors Suprima avisos e mostre apenas erros.
Verboso --verbose Mostrar logs detalhados.
Depurar --debug Mostra todos os logs de depuração.
Mensagem de ajuda --help -h Mostrar caixa de diálogo de ajuda.
Query --query Defina uma cadeia de caracteres de consulta JMESPath para saída JSON.

Próximos passos

Para obter mais informações sobre a CLI do Azure, consulte a documentação da CLI do Azure.

Você pode encontrar exemplos de script CLI adicionais dos Aplicativos Lógicos do Azure no navegador de exemplos de código da Microsoft.

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

Crie um aplicativo lógico usando um script de exemplo.