クイック スタート:Azure CLI を使用してロジック アプリを作成し、管理するQuickstart: Create and manage logic apps using the Azure CLI

このクイックスタートでは、Azure CLI Logic Apps 拡張機能 (az logic) を使用してロジック アプリを作成し、管理する方法について説明します。This quickstart shows you how to create and manage logic apps by using the Azure CLI Logic Apps extension (az logic). ロジック アプリ ワークフロー定義用の JSON ファイルを使用して、コマンド ラインからロジック アプリを作成することができます。From the command line, you can create a logic app by using the JSON file for a logic app workflow definition. その後、コマンド ラインから、listshow (get)、updatedelete などの操作を実行してロジック アプリを管理できます。You can then manage your logic app by running operations such as list, show (get), update, and delete from the command line.

警告

Azure CLI Logic Apps 拡張機能は、現在、"試験段階" であり、"カスタマーサポートの対象外" です。The Azure CLI Logic Apps extension is currently experimental and not covered by customer support. この CLI 拡張機能は、特に運用環境での使用を選択する場合、慎重に使用してください。Use this CLI extension with caution, especially if you choose to use the extension in production environments.

Logic Apps を初めて使用する場合は、Azure portalVisual Studio、および Visual Studio Code を使用して初めてのロジック アプリを作成する方法も学習できます。If you're new to Logic Apps, you can also learn how to create your first logic apps through the Azure portal, in Visual Studio, and in Visual Studio Code.

前提条件Prerequisites

  • アクティブなサブスクリプションが含まれる Azure アカウント。An Azure account with an active subscription. Azure サブスクリプションをお持ちでない場合は、無料アカウントを作成してください。If you don't have an Azure subscription, create a free account.
  • ご利用のローカル コンピューターに Azure CLI がインストールされていること。The Azure CLI installed on your local computer.
  • ご利用のローカル コンピューターに Azure CLI Logic Apps 拡張機能 がインストールされていること。The Logic Apps Azure CLI extension installed on your computer. この拡張機能をインストールするには、コマンド az extension add --name logic を使用します。To install this extension, use this command: az extension add --name logic
  • ロジック アプリを作成する Azure リソース グループAn Azure resource group in which to create your logic app.

前提条件のチェックPrerequisite check

開始する前に、環境を検証します。Validate your environment before you begin:

例 - リソース グループの作成Example - create resource group

ロジック アプリのリソース グループがまだない場合は、コマンド az group create を実行してグループを作成します。If you don't already have a resource group for your logic app, create the group with the command az group create. たとえば、次のコマンドを実行すると、場所 westustestResourceGroup という名前のリソース グループが作成されます。For example, the following command creates a resource group named testResourceGroup in the location westus.


az group create --name testResourceGroup --location westus

リソース グループが正常に作成された場合、出力には、provisioningStateSucceeded として示されます。The output shows the provisioningState as Succeeded when your resource group is successfully created:


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

ワークフロー定義Workflow definition

Azure CLI を使用して、新しいロジック アプリを作成するか、または既存のロジック アプリを更新する前に、ロジック アプリのワークフロー定義が必要です。Before you create a new logic app or update an existing logic app by using the Azure CLI, you need a workflow definition for your logic app. Azure portal で、デザイナー ビューから コード ビュー に切り替えると、ロジック アプリの基になるワークフロー定義を JSON 形式で表示できます。In the Azure portal, you can view your logic app's underlying workflow definition in JSON format by switching from Designer view to Code view.

コマンドを実行してロジック アプリを作成または更新する場合、ワークフロー定義は必須パラメーター (--definition) としてアップロードされます。When you run the commands to create or update your logic app, your workflow definition is uploaded as a required parameter (--definition). ワークフロー定義は、ワークフロー定義言語のスキーマに従う JSON ファイルとして作成する必要があります。You must create your workflow definition as a JSON file that follows the Workflow Definition Language schema.

CLI からロジック アプリを作成するCreate logic apps from CLI

コマンド az logic workflow create と定義の JSON ファイルを使用して、Azure CLI からロジック アプリのワークフローを作成することができます。You can create a logic app workflow from the Azure CLI using the command az logic workflow create with a JSON file for the definition.


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]

コマンドには、次の必須パラメーターを含める必要があります。Your command must include the following required parameters:

パラメーターParameter Value 説明Description
ワークフロー定義Workflow definition --definition ロジック アプリのワークフロー定義を含む JSON ファイル。A JSON file with your logic app's workflow definition.
場所Location --location -l ロジック アプリを配置する Azure リージョン。The Azure region in which your logic app is located.
名前Name --name -n ロジック アプリの名前。The name of your logic app. 名前に含めることができるのは、文字、数字、ハイフン (-)、アンダースコア (_)、かっこ (())、ピリオド (.) のみです。The name can contain only letters, numbers, hyphens (-), underscores (_), parentheses (()), and periods (.). また、名前はリージョン全体で一意である必要があります。The name must also be unique across regions.
リソース グループ名Resource group name --resource-group -g ロジック アプリを作成する Azure リソース グループThe Azure resource group in which you want to create your logic app. ロジック アプリのリソース グループがまだない場合は、開始する前に、リソース グループを作成します。Create a resource group before you begin if you don't already have one for your logic app.

さらに、省略可能なパラメーターを追加して、ロジック アプリのアクセス制御、エンドポイント、統合アカウント、統合サービス環境、状態、リソース タグを構成することもできます。You can also include additional optional parameters to configure your logic app's access controls, endpoints, integration account, integration service environment, state, and resource tags.

例 - ロジック アプリの作成Example - create logic app

この例では、testLogicApp という名前のワークフローを場所 westus にあるリソース グループ testResourceGroup に作成します。In this example, a workflow named testLogicApp is created in the resource group testResourceGroup in the location westus. JSON ファイル testDefinition.json には、ワークフロー定義が含まれています。The JSON file testDefinition.json contains the workflow definition.


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

ワークフローが正常に作成されると、CLI によって、新しいワークフロー定義の JSON コードが表示されます。When your workflow is successfully created, the CLI shows your new workflow definition's JSON code. ワークフローの作成に失敗した場合は、発生する可能性のあるエラーの一覧を参照してください。If your workflow creation fails, see the list of possible errors.

CLI からロジック アプリを更新するUpdate logic apps from CLI

コマンド az logic workflow create を使用して、Azure CLI からロジック アプリのワークフローを更新することもできます。You can also update a logic app's workflow from the Azure CLI using the command az logic workflow create.

コマンドには、ロジック アプリを作成する場合と同じ必須パラメーターを含める必要があります。Your command must include the same required parameters as when you create a logic app. また、ロジック アプリを作成する場合と同じ省略可能なパラメーターを追加することもできます。You can also add the same optional parameters as when creating a logic app.


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]

例 - ロジック アプリの更新Example - update logic app

この例では、前のセクションで作成したサンプル ワークフローを更新して、別の JSON 定義ファイル newTestDefinition.json を使用し、説明の値を含む 2 つのリソース タグ testTag1testTag2 を追加します。In this example, the sample workflow created in the previous section is updated to use a different JSON definition file, newTestDefinition.json, and add two resource tags, testTag1 and testTag2 with description values.


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

ワークフローが正常に更新されると、CLI によって、ロジック アプリの更新されたワークフロー定義が表示されます。When your workflow is successfully updated, the CLI shows your logic app's updated workflow definition. 更新が失敗した場合は、発生する可能性のあるエラーの一覧を参照してください。If your update fails, see the list of possible errors.

CLI からロジック アプリを削除するDelete logic apps from CLI

コマンド az logic workflow delete を使用して、Azure CLI からロジック アプリのワークフローを削除することができます。You can delete a logic app's workflow from the Azure CLI using the command az logic workflow delete.

コマンドには、次の必須パラメーターを含める必要があります。Your command must include the following required parameters:

パラメーターParameter Value 説明Description
名前Name --name -n ロジック アプリの名前。The name of your logic app.
リソース グループ名Resource group name -resource-group -g ロジック アプリを配置するリソース グループ。The resource group in which your logic app is located.

省略可能なパラメーターを含めて、確認プロンプト --yes -y をスキップすることもできます。You can also include an optional parameter to skip confirmation prompts, --yes -y.


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

この後、CLI によって、ロジック アプリの削除を確認するように求められます。The CLI then prompts you to confirm the deletion of your logic app. コマンドで省略可能なパラメーター --yes -y を使用すると、確認プロンプトをスキップできます。You can skip the confirmation prompt by using the optional parameter --yes -y with your command.


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

ロジック アプリの定義を確認するには、CLI でロジック アプリの一覧を表示するか、または Azure portal でロジック アプリを表示します。You can confirm a logic app's deletion by listing your logic apps in the CLI, or by viewing your logic apps in the Azure portal.

例 - ロジック アプリの削除Example - delete logic app

この例では、前のセクションで作成したサンプル ワークフローを削除します。In this example, the sample workflow created in a previous section is deleted.


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

確認プロンプトに y で応答すると、ロジック アプリが削除されます。After you respond to the confirmation prompt with y, the logic app is deleted.

CLI でロジック アプリを表示するShow logic apps in CLI

コマンド az logic workflow show を使用して、特定のロジック アプリ ワークフローを取得することができます。You can get a specific logic app workflow using the command az logic workflow show.


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

コマンドには、次の必須パラメーターを含める必要がありますYour command must include the following required parameters

パラメーターParameter Value 説明Description
名前Name --name -n ロジック アプリの名前。The name of your logic app.
リソース グループ名Resource group name --resource-group -g ロジック アプリを配置するリソース グループの名前。The name of the resource group in which your logic app is located.

例 - ロジック アプリの取得Example - get logic app

この例では、デバッグ用に、リソース グループ testResourceGroup 内のロジック アプリ testLogicApp が、完全なログと共に返されます。In this example, the logic app testLogicApp in the resource group testResourceGroup is returned with full logs for debugging.


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

CLI でロジック アプリを一覧表示するList logic apps in CLI

コマンド az logic workflow list を使用して、ロジック アプリをサブスクリプション別に一覧表示できます。You can list your logic apps by subscription using the command az logic workflow list. このコマンドでは、ロジック アプリのワークフローの JSON コードが返されます。This command returns the JSON code for your logic apps' workflows.

次の省略可能なパラメーターを使用して、結果をフィルター処理することができます。You can filter your results by the following optional parameters:

パラメーターParameter Value 説明Description
リソース グループ名Resource group name --resource-group -g 結果をフィルター処理するリソース グループの名前。The name of the resource group by which you want to filter your results.
項目数Number of items --top 結果に含める項目の数。The number of items that are included in your results.
AssertFilter --filter 一覧で使用するフィルターの種類。The type of filter that you're using on your list. 状態 (State)、トリガー (Trigger)、参照先リソースの識別子 (ReferencedResourceId) でフィルター処理できます。You can filter by state (State), trigger (Trigger), and the identifier of the referenced resource (ReferencedResourceId).

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

例 - ロジック アプリの一覧表示Example - list logic apps

この例では、リソース グループ testResourceGroup 内の有効化されたすべてのワークフローが ASCII テーブル形式で返されます。In this example, all enabled workflows in the resource group testResourceGroup are returned in an ASCII table format.


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

エラーErrors

次のエラーは、Azure Logic Apps CLI 拡張機能がインストールされていないことを示します。The following error indicates that the Azure Logic Apps CLI extension isn't installed. 前提条件の手順に従って、ご利用のコンピューターに Logic Apps 拡張機能をインストールします。Follow the steps in the prerequisites to install the Logic Apps extension on your computer.


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://docs.microsoft.com/cli/azure/azure-cli-extensions-overview

次のエラーは、ワークフロー定義をアップロードするためのファイル パスが正しくないことを示している可能性があります。The following error might indicate that the file path for uploading your workflow definition is incorrect.


Expecting value: line 1 column 1 (char 0)

グローバル パラメーターGlobal parameters

az logic コマンドでは、次の省略可能なグローバル Azure CLI パラメーターを使用できます。You can use the following optional global Azure CLI parameters with your az logic commands:

パラメーターParameter Value 説明Description
出力形式Output format --output -o 出力形式を既定の JSON から変更します。Change the output format from the default JSON.
エラーのみを表示Only show errors --only-show-errors 警告を表示せず、エラーのみを表示します。Suppress warnings and only show errors.
"詳細"Verbose --verbose 詳細ログを表示します。Show verbose logs.
デバッグDebug --debug すべてのデバッグ ログを表示します。Shows all debug logs.
ヘルプ メッセージHelp message --help -h ヘルプ ダイアログを表示します。Show help dialog.
クエリQuery --query JSON 形式の出力の JMESPath クエリ文字列を設定します。Set a JMESPath query string for JSON output.

次のステップNext steps

Azure CLI の詳細については、Azure CLI のドキュメントのページを参照してください。For more information on the Azure CLI, see the Azure CLI documentation.

その他の Logic Apps CLI スクリプトのサンプルについては、Microsoft のコード サンプル ブラウザーを参照してください。You can find additional Logic Apps CLI script samples in Microsoft's code samples browser.

次に、サンプル スクリプトとワークフロー定義を使用して、Azure CLI からサンプル アプリ ロジックを作成できます。Next, you can create an example app logic through the Azure CLI using a sample script and workflow definition.