快速入门：在 Azure 逻辑应用中通过 Azure PowerShell 创建和管理工作流

项目
10/30/2024

适用于：Azure 逻辑应用（消耗）

本快速入门介绍如何使用 Azure PowerShell 创建和管理在 Azure 逻辑应用中运行的自动化工作流。在 PowerShell，可以使用逻辑应用工作流定义的 JSON 文件来创建多租户 Azure 逻辑应用中的消耗逻辑应用。随后可以通过在 Az.LogicApp PowerShell 模块中运行 cmdlet 来管理逻辑应用。

注意

本快速入门目前仅适用于在多租户 Azure 逻辑应用中运行的消耗逻辑应用工作流。 Azure PowerShell 目前不适用于在单租户 Azure 逻辑应用中运行的标准逻辑应用工作流。有关详细信息，请查看 Azure 逻辑应用的资源类型和主机差异。

如果不熟悉 Azure 逻辑应用，还可以了解如何通过 Azure 门户以及如何在 Visual Studio 中和在 Visual Studio Code 中创建第一个消耗逻辑应用工作流。

先决条件

具有活动订阅的 Azure 帐户。如果你没有 Azure 订阅，请创建一个试用版订阅。
在本地计算机上安装 Az PowerShell 模块。
要在其中创建逻辑应用的 Azure 资源组。

先决条件检查

开始之前验证环境：

登录 Azure 门户，并通过运行 Connect-AzAccount 来检查订阅是否处于活动状态。
通过运行 Get-InstalledModule -Name Az 来检查Azure PowerShell 的版本。有关最新版本，请参阅最新发行说明。

如果没有最新版本，请按照更新 Azure PowerShell 模块的步骤来更新安装。

示例 - 创建资源组

如果还没有用于逻辑应用的资源组，请使用 New-AzResourceGroup cmdlet 创建该组。例如，以下命令在位置 chinanorth 创建名为 testResourceGroup 的资源组。

New-AzResourceGroup -Name testResourceGroup -Location chinanorth

已成功创建资源组时，输出会将 ProvisioningState 显示为 Succeeded：

ResourceGroupName : testResourceGroup
Location          : chinanorth
ProvisioningState : Succeeded
Tags              :
ResourceId        : /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/testResourceGroup

工作流定义

使用 Azure PowerShell 创建新逻辑应用或更新现有逻辑应用之前，需要逻辑应用的工作流定义。若要查看示例工作流定义，请在Azure 门户中打开设计器中的任何现有逻辑应用工作流。在“设计器”工具栏上，选择“代码视图”，该视图以 JSON 格式显示工作流的基础定义。

运行命令以创建或更新逻辑应用时，工作流定义会作为必需参数 (Definition) 或 (DefinitionFilePath)（具体取决于参数集）进行上传。必须将工作流定义创建为遵循工作流定义语言架构的 JSON 文件。

从 PowerShell 创建逻辑应用

可以使用 cmdlet New-AzLogicApp 以及定义的 JSON 文件，从 Azure PowerShell 创建逻辑应用工作流。

示例 - 创建逻辑应用

此示例在资源组 testResourceGroup（位置为 chinanorth）中创建一个名为 testLogicApp 的工作流。 JSON 文件 testDefinition.json 包含工作流定义。

New-AzLogicApp -ResourceGroupName testResourceGroup -Location chinanorth -Name testLogicApp -DefinitionFilePath .\testDefinition.json

成功创建工作流后，PowerShell 会显示新工作流定义。

从 PowerShell 更新逻辑应用

还可以使用 cmdlet Set-AzLogicApp 从 Azure PowerShell 更新逻辑应用的工作流。

示例 - 更新逻辑应用

此示例演示如何使用不同的 JSON 定义文件 newTestDefinition.json 更新在上一部分中创建的示例工作流。

Set-AzLogicApp -ResourceGroupName testResourceGroup -Name testLogicApp -DefinitionFilePath .\newTestDefinition.json

成功更新工作流后，PowerShell 会显示逻辑应用更新后的工作流定义。

从 PowerShell 删除逻辑应用

还可以使用 cmdlet Remove-AzLogicApp 从 Azure PowerShell 删除逻辑应用的工作流。

示例 - 删除逻辑应用

此示例会删除在上一节中创建的示例工作流。

Remove-AzLogicApp -ResourceGroupName testResourceGroup -Name testLogicApp

在使用 y 响应确认提示之后，会删除逻辑应用。

注意事项 - 删除逻辑应用

删除逻辑应用会以下列方式方式影响工作流实例：

Azure 逻辑应用会尽力取消任何正在进行的和挂起的运行。

即使使用较大的卷或积压工作 (backlog)，大多数运行在完成或开始之前都将被取消。但是，取消过程可能需要一些时间才能完成。同时，在运行时执行取消过程中，可能会选取某些运行来执行。
Azure 逻辑应用不会创建或运行新的工作流实例。
如果删除工作流，然后重新创建相同的工作流，则重新创建的工作流不会具有与删除的工作流相同的元数据。必须重新保存任何调用删除工作流的工作流。这样，调用方就可获取重新创建的工作流的正确信息。否则，对重新创建的工作流的调用将失败并显示 Unauthorized 错误。此行为也适用于在集成帐户中使用项目的工作流和调用 Azure 函数的工作流。

在 PowerShell 中显示逻辑应用

可以使用命令 Get-AzLogicApp 获取特定逻辑应用工作流。

示例 - 获取逻辑应用

此示例在资源组 testResourceGroup 中返回逻辑应用 testLogicApp。

Get-AzLogicApp -ResourceGroupName testResourceGroup -Name testLogicApp

后续步骤

有关 Azure PowerShell 的详细信息，请参阅 Azure PowerShell 文档。

可以在 Microsoft 代码示例浏览器中找到其他逻辑应用脚本示例。

通过