Início Rápido: Criar e gerir fluxos de trabalho com a CLI do Azure no Azure Logic Apps

Artigo
01/04/2024

Aplica-se a: Azure Logic Apps (Consumo)

Este início rápido mostra como criar e gerir fluxos de trabalho automatizados que são executados no Azure Logic Apps com a extensão do Logic Apps da CLI do Azure (az logic). A partir da linha de comandos, pode criar uma aplicação lógica consumo no Azure Logic Apps multi-inquilino com o ficheiro JSON para uma definição de fluxo de trabalho de aplicação lógica. Em seguida, pode gerir a sua aplicação lógica ao executar operações como list, show (get), updatee delete a partir da linha de comandos.

Aviso

A extensão do Logic Apps da CLI do Azure é atualmente experimental e não é abrangida pelo suporte ao cliente. Utilize esta extensão da CLI com cuidado, especialmente se optar por utilizar a extensão em ambientes de produção.

Este início rápido aplica-se atualmente apenas aos fluxos de trabalho da aplicação lógica de consumo que são executados no Azure Logic Apps multi-inquilino. A CLI do Azure está atualmente indisponível para fluxos de trabalho de aplicações lógicas Standard que são executados no Azure Logic Apps de inquilino único. Para obter mais informações, veja O tipo de recurso e as diferenças de anfitrião no Azure Logic Apps.

Se não estiver familiarizado com o Azure Logic Apps, saiba como criar o seu primeiro fluxo de trabalho da aplicação lógica de consumo através do portal do Azure, no Visual Studio e 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 do Azure Logic Apps instalada no seu computador. Para instalar esta extensão, utilize este comando: az extension add --name logic
Um grupo de recursos do Azure no qual pode criar a sua aplicação lógica.

Verificação de pré-requisitos

Antes de começar, valide o seu ambiente:

Inicie sessão no portal do Azure e verifique se a sua subscrição está ativa ao executar az login.
Verifique a sua versão da CLI do Azure num terminal ou janela de comandos ao executar az --version. Para obter a versão mais recente, veja as notas de versão mais recentes.

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

Exemplo - Criar grupo de recursos

Se ainda não tiver um grupo de recursos para a sua aplicação lógica, crie o grupo com o comando az group create. Por exemplo, o seguinte comando cria um grupo de recursos com o nome testResourceGroup na localização westus.

az group create --name testResourceGroup --location westus

O resultado mostra como Succeeded quando o provisioningState grupo de recursos é criado com êxito:

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

Definição do fluxo de trabalho

Antes de criar uma nova aplicação lógica ou atualizar uma aplicação lógica existente com a CLI do Azure, precisa de uma definição de fluxo de trabalho para a sua aplicação lógica. No portal do Azure, pode ver a definição de fluxo de trabalho subjacente da sua aplicação lógica no formato JSON ao mudar da vista estruturador para a vista Código.

Quando executa os comandos para criar ou atualizar a sua aplicação lógica, a definição do fluxo de trabalho é carregada como um parâmetro necessário (--definition). Tem de criar a definição do fluxo de trabalho como um ficheiro JSON que siga o esquema Idioma da Definição de Fluxo de Trabalho.

Criar aplicações lógicas a partir da CLI

Para criar um fluxo de trabalho de aplicação lógica a partir da CLI do Azure, utilize o comando az logic workflow create com um ficheiro JSON para a definição.

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]

O comando tem de incluir os seguintes parâmetros necessários:

Parâmetro	Valor	Descrição
Definição do fluxo de trabalho	`--definition`	Um ficheiro JSON com a definição de fluxo de trabalho da sua aplicação lógica.
Localização	`--location -l`	A região do Azure na qual a sua aplicação lógica está localizada.
Name	`--name -n`	O nome da sua aplicação lógica. O nome só pode conter letras, números, hífenes (`-`), sublinhados (`_`), parênteses (`()`) e períodos (`.`). O nome também tem de ser exclusivo entre regiões.
Nome do grupo de recursos	`--resource-group -g`	O grupo de recursos do Azure no qual pretende criar a sua aplicação lógica. Crie um grupo de recursos antes de começar se ainda não tiver um para a sua aplicação lógica.

Também pode incluir parâmetros opcionais adicionais para configurar os controlos de acesso, pontos finais, conta de integração, ambiente de serviço de integração, estado e etiquetas de recursos da sua aplicação lógica.

Exemplo - Criar aplicação lógica

Neste exemplo, é criado um fluxo de trabalho com o nome testLogicApp no grupo testResourceGroup de recursos na localização westus. O ficheiro 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 for 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, veja a lista de possíveis erros.

Atualizar aplicações lógicas da CLI

Para atualizar o fluxo de trabalho de uma aplicação lógica a partir da CLI do Azure, utilize o comando az logic workflow create.

O comando tem de incluir os mesmos parâmetros necessários que quando cria uma aplicação lógica. Também pode adicionar os mesmos parâmetros opcionais que ao criar uma aplicação lógica.

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 a aplicação lógica

Neste exemplo, o fluxo de trabalho de exemplo criado na secção anterior é atualizado para utilizar um ficheiro de definição JSON diferente, newTestDefinition.json, e adicionar duas etiquetas 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 da sua aplicação lógica. Se a atualização falhar, veja a lista de possíveis erros.

Eliminar aplicações lógicas da CLI

Para eliminar o fluxo de trabalho de uma aplicação lógica da CLI do Azure, utilize o comando az logic workflow delete.

O comando tem de incluir os seguintes parâmetros necessários:

Parâmetro	Valor	Descrição
Nome	`--name -n`	O nome da sua aplicação lógica.
Nome do grupo de recursos	`-resource-group -g`	O grupo de recursos no qual a sua aplicação lógica está localizada.

Também pode incluir um parâmetro opcional para ignorar pedidos de confirmação, --yes -y.

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

Em seguida, a CLI pede-lhe para confirmar a eliminação da sua aplicação lógica. Pode ignorar o pedido de confirmação com o parâmetro --yes -y opcional com o comando .

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

Para confirmar a eliminação de uma aplicação lógica, liste as suas aplicações lógicas na CLI ou veja as suas aplicações lógicas no portal do Azure.

Exemplo - Eliminar aplicação lógica

Neste exemplo, o fluxo de trabalho de exemplo criado numa secção anterior é eliminado.

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

Depois de responder ao pedido de confirmação com yo , a aplicação lógica é eliminada.

Considerações - Eliminar a aplicação lógica

Eliminar uma aplicação lógica afeta as instâncias de fluxo de trabalho das seguintes formas:

O Azure Logic Apps faz o melhor esforço para cancelar quaisquer execuções em curso e pendentes.

Mesmo com um volume grande ou um atraso, a maioria das execuções são canceladas antes de serem concluídas ou iniciadas. No entanto, o processo de cancelamento pode demorar algum tempo a concluir. Entretanto, algumas execuções podem ser recolhidas para execução enquanto o runtime funciona através do processo de cancelamento.
O Azure Logic Apps não cria nem executa novas instâncias de fluxo de trabalho.
Se eliminar 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 eliminado. Tem de guardar novamente qualquer fluxo de trabalho chamado fluxo de trabalho eliminado. Dessa forma, o autor da chamada obtém as informações corretas para o fluxo de trabalho recriado. Caso contrário, as chamadas para o fluxo de trabalho recriado falham com um Unauthorized erro. Este comportamento também se aplica a fluxos de trabalho que utilizam artefactos em contas de integração e fluxos de trabalho que chamam funções do Azure.

Mostrar aplicações lógicas na CLI

Para obter um fluxo de trabalho de aplicação lógica específico, utilize o comando az logic workflow show.

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

O comando tem de incluir os seguintes parâmetros necessários

Parâmetro	Valor	Descrição
Nome	`--name -n`	O nome da sua aplicação lógica.
Nome do grupo de recursos	`--resource-group -g`	O nome do grupo de recursos no qual a aplicação lógica está localizada.

Exemplo - Obter aplicação lógica

Neste exemplo, a aplicação testLogicApp lógica no grupo testResourceGroup de recursos é devolvida com registos completos para depuração.

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

Listar aplicações lógicas na CLI

Para listar as suas aplicações lógicas por subscrição, utilize o comando az logic workflow list. Este comando devolve o código JSON para os fluxos de trabalho da aplicação lógica.

Pode filtrar 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 pretende filtrar os 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. Pode filtrar por estado (`State`), acionador (`Trigger`) e o identificador do recurso referenciado (`ReferencedResourceId`).

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

Exemplo - Listar aplicações lógicas

Neste exemplo, todos os fluxos de trabalho ativados no grupo testResourceGroup de recursos são devolvidos num formato de tabela ASCII.

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

Erros

O seguinte erro indica que a extensão da CLI do Azure Logic Apps não está instalada. Siga os passos nos pré-requisitos para instalar a extensão do 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 seguinte pode indicar que o caminho do ficheiro para carregar a definição do fluxo de trabalho está incorreto.

Expecting value: line 1 column 1 (char 0)

Parâmetros globais

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

Parâmetro	Valor	Descrição
Formato de saída	`--output -o`	Altere o formato de saída do JSON predefinido.
Mostrar apenas erros	`--only-show-errors`	Suprimir avisos e mostrar apenas erros.
Verboso	`--verbose`	Mostrar registos verbosos.
Depurar	`--debug`	Mostra todos os registos de depuração.
Mensagem de ajuda	`--help -h`	Mostrar caixa de diálogo de ajuda.
Consulta	`--query`	Defina uma cadeia de consulta JMESPath para a saída JSON.

Passos seguintes

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

Pode encontrar exemplos adicionais de scripts da CLI do Azure Logic Apps no browser de exemplos de código da Microsoft.

Em seguida, pode criar uma lógica de aplicação de exemplo através da CLI do Azure com um script de exemplo e uma definição de fluxo de trabalho.

Crie uma aplicação lógica com o script de exemplo.