クイックスタート: マルチテナント Azure Logic Apps と Visual Studio Code を使用して、ロジックアプリワークフローの定義を作成および管理する

[アーティクル]
01/04/2024

適用対象: Azure Logic Apps (従量課金)

このクイックスタートでは、マルチテナント Azure Logic Apps と Visual Studio Code を使って、組織間や企業間でアプリ、データ、システム、サービスを統合するタスクとプロセスを自動化するために役立つロジックアプリワークフローを作成および管理する方法を示します。コードベースのエクスペリエンスを通じて、ロジックアプリの JavaScript Object Notation (JSON) を使用する、基になるワークフロー定義を作成および編集します。 Azure に既にデプロイされている既存のロジックアプリを使用することもできます。マルチテナントとシングルテナントのモデルの比較について詳しくは、シングルテナントとマルチテナント、および統合サービス環境に関する記事をご覧ください。

これらのタスクは Azure portal と Visual Studio でも実行できますが、既にロジックアプリ定義を使い慣れていて、コードで直接作業する場合は、Visual Studio Code の方が迅速に作業を開始できます。たとえば、既に作成されているロジックアプリを無効化、有効化、削除、更新することができます。また、Visual Studio Code が実行されている開発プラットフォーム (Linux、Windows、Mac など) からロジックアプリと統合アカウントを操作することもできます。

この記事では、基本的な概念に重点を置いたクイックスタートと同じロジックアプリを作成できます。 Visual Studio でサンプルアプリを作成する方法について学習することも、Azure CLI を使用してアプリを作成および管理する方法について学習することもできます。 Visual Studio Code では、ロジックアプリは次の例のようになります。

Example logic app workflow definition

前提条件

開始する前に、以下を用意してください。

Azure アカウントとサブスクリプションがない場合は、無料の Azure アカウントにサインアップしてください。
JSON で記述されているロジックアプリのワークフロー定義とその構造についての基礎知識

Azure Logic Apps を初めて使用する場合は、こちらのクイックスタートをお試しください。Azure portal で初めてのロジックアプリワークフローを作成し、基本的な概念を重点的に身に付けることができます。
Azure と Azure サブスクリプションにサインインするための Web へのアクセス
まだお持ちでない場合は、以下のツールをダウンロードしてインストールしてください。
- Visual Studio Code バージョン 1.25.1 以降 (無料)
- Azure Logic Apps 用 Visual Studio Code 拡張機能
  
  この拡張機能は、Visual Studio Marketplace からダウンロードしてインストールすることも、Visual Studio Code 内から直接インストールすることもできます。インストール後、Visual Studio Code を再度読み込む必要があります。
  
  拡張機能が正しくインストールされたことを確認するには、Visual Studio Code ツールバーにある Azure アイコンを選択します。
  
  詳細については、「Extension Marketplace (拡張機能 Marketplace)」をご覧ください。この拡張機能のオープンソースバージョンに協力するには、GitHub の Visual Studio Code 用 Azure Logic Apps 拡張機能に関するページを参照してください。
ロジックアプリが特定の IP アドレスへのトラフィックを制限するファイアウォールを経由して通信する必要がある場合、そのファイアウォールは、Azure Logic Apps またはロジックアプリが存在する Azure リージョンのランタイムが使用するインバウンドとアウトバウンドの IP アドレスの "両方" のアクセスを許可する必要があります。また、ロジックアプリが Office 365 Outlook コネクタや SQL コネクタなどのマネージドコネクタを使用している場合、またはカスタムコネクタを使用している場合、そのファイアウォールでは、ロジックアプリの Azure リージョン内の "すべて" のマネージドコネクタアウトバウンド IP アドレスへのアクセスを許可する必要もあります。

Visual Studio Code から Azure にアクセスする

Visual Studio Code を開きます。 Visual Studio Code ツールバーで、Azure アイコンを選択します。
Azure ウィンドウで、 [Logic Apps] の [Sign in to Azure](Azure にサインインする) を選択します。 Microsoft サインインページが表示されたら、Azure アカウントでサインインします。
1. サインインに通常よりも長い時間がかかる場合、Visual Studio Code はユーザーにデバイスコードを提供して、Microsoft 認証 Web サイトでサインインするよう求めます。代わりにコードでサインインするには、 [Use Device Code] (デバイスコードを使用) を選択します。
2. コードをコピーするには、[Copy & Open] (コピーして開く) を選択します。
3. 新しいブラウザーウィンドウを開いて認証 Web サイトに進むには、 [リンクを開く] を選択します。
4. [アカウントにサインインする] ページで認証コードを入力し、 [次へ] を選択します。
Azure アカウントを選択します。サインインしたら、ブラウザーを閉じて Visual Studio Code に戻ることができます。

Azure ウィンドウの [ロジックアプリ] と [統合アカウント] セクションに、アカウントに関連付けられた Azure サブスクリプションが表示されます。ただし、想定しているサブスクリプションが表示されない場合、またはセクションにサブスクリプションが多すぎる場合は、次の手順を実行します。
1. ポインターを [ロジックアプリ] ラベルの上に移動します。ツールバーが表示されたら、 [サブスクリプションの選択] (フィルターアイコン) を選択します。
2. 表示された一覧から、表示したいサブスクリプションを選択します。
[ロジックアプリ] で目的のサブスクリプションを選択します。サブスクリプションノードが展開され、そのサブスクリプションに存在するすべてのロジックアプリが表示されます。

ヒント

[統合アカウント] でサブスクリプションを選択すると、そのサブスクリプションに存在する統合アカウントが表示されます。

新しいロジックアプリを作成する

まだ Visual Studio Code 内から Azure アカウントおよびサブスクリプションにサインインしていない場合は、先ほどの手順に従って今すぐサインインします。
Visual Studio Code の [ロジックアプリ] でサブスクリプションのショートカットメニューを開き、 [ロジックアプリの作成] を選択します。

一覧が表示され、サブスクリプション内の Azure リソースグループが表示されます。
リソースグループのリストから、 [新しいリソースグループの作成] または既存のリソースグループを選択します。この例では、新しいリソースグループを作成します。
Azure リソースグループの名前を指定し、Enter キーを押します。
ロジックアプリのメタデータを保存する Azure リージョンを選択します。
ロジックアプリの名前を指定し、Enter キーを押します。

Azure ウィンドウの Azure サブスクリプションの下に新しい空のロジックアプリが表示されます。また Visual Studio Code では、ロジックアプリのスケルトンワークフロー定義を含む JSON (.logicapp.json) ファイルも開きます。これで、この JSON ファイルにロジックアプリのワークフロー定義を手動で作成することができます。ワークフロー定義の構造と構文に関するテクニカルリファレンスについては、「Azure Logic Apps のワークフロー定義言語スキーマ」を参照してください。

たとえば、次に示すのは、RSS トリガーと Office 365 Outlook アクションから始まるサンプルロジックアプリワークフロー定義です。通常、JSON 要素は各セクション内でアルファベット順に表示されます。ただし、このサンプルでは、ロジックアプリのステップがデザイナーに表示される順序でこれらの要素を大まかに示しています。

重要

このサンプルロジックアプリの定義を再利用する場合は、@fabrikam.com などの組織アカウントが必要です。架空の電子メールアドレスを実際の電子メールアドレスに置き換えてください。 Outlook.com や Gmail など、別の電子メールコネクタを使用するには、Send_an_email_action アクションを、Azure Logic Apps がサポートしている電子メールコネクタから入手できる同様のアクションに置き換えます。

Gmail コネクタの使用を希望する場合、ロジックアプリで制限なしにこのコネクタを使用できるのは、G-Suite ビジネスアカウントだけです。 Gmail コンシューマーアカウントを持っている場合は、Google によって承認された特定のサービスのみでこのコネクタを使用できるほか、認証に使用する Google クライアントアプリを Gmail コネクタで作成することができます。詳細については、「Azure Logic Apps での Google コネクタのデータセキュリティとプライバシーポリシー」を参照してください。
```
{
 "$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#",
 "contentVersion": "1.0.0.0",
 "parameters": {
 "$connections": {
 "defaultValue": {},
 "type": "Object"
 }
 },
 "triggers": {
 "When_a_feed_item_is_published": {
 "recurrence": {
 "frequency": "Minute",
 "interval": 1
 },
 "splitOn": "@triggerBody()?['value']",
 "type": "ApiConnection",
 "inputs": {
 "host": {
 "connection": {
 "name": "@parameters('$connections')['rss']['connectionId']"
 }
 },
 "method": "get",
 "path": "/OnNewFeed",
 "queries": {
 "feedUrl": "http://feeds.reuters.com/reuters/topNews"
 }
 }
 }
 },
 "actions": {
 "Send_an_email_(V2)": {
 "runAfter": {},
 "type": "ApiConnection",
 "inputs": {
 "body": {
 "Body": "Title: @{triggerBody()?['title']} \n \nDate published: @{triggerBody()?['updatedOn']} \n \nLink: @{triggerBody()?['primaryLink']}",
 "Subject": "RSS item: @{triggerBody()?['title']}",
 "To": "sophia-owen@fabrikam.com"
 },
 "host": {
 "connection": {
 "name": "@parameters('$connections')['office365']['connectionId']"
 }
 },
 "method": "post",
 "path": "/v2/Mail"
 }
 }
 },
 "outputs": {}
}
```
完了したら、ロジックアプリのワークフロー定義を保存します。 ([ファイル] メニュー> [保存]、または Ctrl + S キーを押す)
ロジックアプリを Azure サブスクリプションにアップロードするように求めるメッセージが表示されたら、[アップロード] を選択します。

この手順では、ロジックアプリを Azure portalに発行します。これにより、ロジックが有効になり、Azure で実行されます。

デザイナーでロジックアプリを表示する

Visual Studio Code では、読み取り専用のデザインビューでロジックアプリを開くことができます。デザイナーでロジックアプリを編集することはできませんが、デザイナービューを使用すると、ロジックアプリのワークフローを視覚的に確認できます。

Azure ウィンドウの [ロジックアプリ] で、ロジックアプリのショートカットメニューを開き、 [Open in Designer] (デザイナーで開く) を選択します。

読み取り専用のデザイナーが別のウィンドウで開き、ロジックアプリのワークフローが表示されます。次に例を示します。

View logic app in read-only designer

Azure portal に表示

Azure portal でロジックアプリを確認するには、次の手順を実行します。

ロジックアプリに関連付けられているのと同じ Azure アカウントとサブスクリプションを使用して、Azure portal にサインインします。
Azure portal の検索ボックスに、ロジックアプリの名前を入力します。結果の一覧からロジックアプリを選択します。

デプロイされたロジックアプリの編集

Visual Studio Code では、既に Azure にデプロイされているロジックアプリのワークフロー定義を開いて編集することができます。

重要

実稼働環境でアクティブに実行されているロジックアプリを編集する前に、まずロジックアプリを無効化することで、ロジックアプリが破損するリスクを回避し、中断を最小限に抑えることができます。

まだ Visual Studio Code 内から Azure アカウントおよびサブスクリプションにサインインしていない場合は、先ほどの手順に従って今すぐサインインします。
Azure ウィンドウの [Logic Apps] で、Azure サブスクリプションを展開し、目的のロジックアプリを選択します。
ロジックアプリのメニューを開き、 [エディターで開く] を選択します。または、ロジックアプリ名の横の編集アイコンを選択します。

Visual Studio Code はローカルの一時フォルダーにある .logicapp.json ファイルを開き、ロジックアプリのワークフロー定義を表示します。
ロジックアプリのワークフロー定義を変更します。
完了したら、変更を保存します。 ([ファイル] メニュー> [保存]、または Ctrl + S キーを押す)
変更内容をアップロードして Azure portal の既存のロジックアプリ上書きするように求められたら、 [アップロード] を選択します。

この手順では、Azure portal のロジックアプリのアップデートを発行します。

他のバージョンを表示または昇格する

Visual Studio Code では、以前のバージョンのロジックアプリを開いて確認することができます。また、以前のバージョンを現在のバージョンに昇格させることもできます。

重要

実稼働環境でアクティブに実行されているロジックアプリを変更する前に、まずロジックアプリを無効化することで、ロジックアプリが破損するリスクを回避し、中断を最小限に抑えることができます。

サブスクリプション内のすべてのロジックアプリを表示できるように、Azure ウィンドウの [ロジックアプリ] で、Azure サブスクリプションを展開します。
サブスクリプションの下で、ロジックアプリを展開し、 [バージョン] を展開します。

[バージョン] 一覧に、ロジックアプリの以前のバージョン (存在する場合) が表示されます。
以前のバージョンを表示するには、次のいずれかの手順を選択します。
- JSON 定義を表示するには、 [バージョン] で、その定義のバージョン番号を選択します。または、そのバージョンのショートカットメニューを開き、 [エディターで開く] を選択します。
  
  ローカルコンピューターで新しいファイルが開き、そのバージョンの JSON 定義が表示されます。
- 読み取り専用のデザイナービューでバージョンを表示するには、そのバージョンのショートカットメニューを開き、 [デザイナーで開く] を選択します。
以前のバージョンを現在のバージョンに昇格させるには、次の手順に従います。
1. [バージョン] で、以前のバージョンのショートカットメニューを開き、 [昇格] を選択します。
2. Visual Studio Code で確認を求めるメッセージが表示されたら、 [はい] を選択して続行します。
  
  Visual Studio Code は選択したバージョンを現在のバージョンに昇格させ、昇格したバージョンに新しい番号を割り当てます。以前のバージョンは、昇格されたバージョンの下に表示されます。

ロジックアプリを無効または有効にする

Visual Studio Code では、発行されたロジックアプリを編集して変更を保存すると、既にデプロイされているアプリを上書きします。運用環境でのロジックアプリの中断を回避し、中断を最小限に抑えるには、ロジックアプリを最初に無効にします。ロジックアプリが引き続き動作することを確認した後で、ロジックアプリを再度有効にすることができます。

Azure Logic Apps サービスによって、進行中および保留中の実行がすべてその完了まで続行されます。このプロセスは、ボリュームやバックログによっては、完了までに時間がかかる場合があります。
Azure Logic Apps は、新しいワークフローインスタンスを作成することも実行することもありません。
トリガーは、次にその条件が満たされたときに起動されません。
トリガーの状態には、ロジックアプリが停止したポイントが記憶されます。そのため、ロジックアプリを再度有効にすると、前回の実行以降のすべての未処理の項目に対してトリガーが起動されます。

前回の実行以降の未処理の項目に対してトリガーが起動しないようにするには、ロジックアプリを再度有効にする前に、トリガーの状態をクリアします。
1. ロジックアプリで、ワークフローのトリガーをどこでもかまわないので編集します。
2. 変更を保存します。この手順により、トリガーの現在の状態がリセットされます。
3. ロジックアプリを再度有効にします。
ワークフローが無効になっている場合でも、実行を再送信できます。

まだ Visual Studio Code 内から Azure アカウントおよびサブスクリプションにサインインしていない場合は、先ほどの手順に従って今すぐサインインします。
サブスクリプション内のすべてのロジックアプリを表示できるように、Azure ウィンドウの [ロジックアプリ] で、Azure サブスクリプションを展開します。
1. ロジックアプリを無効にするには、ロジックアプリのメニューを開き、 [Disable](無効化) を選択します。
2. ロジックアプリを再度有効にする準備ができたら、ロジックアプリのメニューを開き、 [Enable](有効化) を選択します。

ロジックアプリを削除する

ロジックアプリを削除すると、ワークフローインスタンスに次のような影響が生じます。

進行中および保留中の実行があれば、それらのキャンセルを Azure Logic Apps がベストエフォートで試みます。

大量のボリュームやバックログがあったとしても、ほとんどの実行は完了前または開始前にキャンセルされます。ただし、キャンセルプロセスは完了までに時間がかかる場合があります。その間、サービスによってキャンセルプロセスが処理される一方、いくつかの実行が実行対象として取り上げられてしまう可能性があります。
Azure Logic Apps は、新しいワークフローインスタンスを作成することも実行することもありません。
ワークフローを削除してから同じワークフローを再作成しても、再作成されたワークフローに、削除したワークフローと同じメタデータが割り当てられることはありません。削除したワークフローの呼び出し元となったワークフローを再保存する必要があります。これにより、呼び出し元は、再作成されたワークフローの正しい情報を取得します。それ以外の場合、再作成したワークフローの呼び出しは、Unauthorized エラーで失敗します。この動作は、統合アカウントのアーティファクトを使用するワークフローや、Azure 関数を呼び出すワークフローにも当てはまります。

まだ Visual Studio Code 内から Azure アカウントおよびサブスクリプションにサインインしていない場合は、先ほどの手順に従って今すぐサインインします。
サブスクリプション内のすべてのロジックアプリを表示できるように、Azure ウィンドウの [ロジックアプリ] で、Azure サブスクリプションを展開します。
削除したいロジックアプリを見つけてそのメニューを開き、 [削除] を選択します。

次のステップ

Visual Studio Code でシングルテナントベースのロジックアプリワークフローを作成する

クイック スタート: マルチテナント Azure Logic Apps と Visual Studio Code を使用して、ロジック アプリ ワークフローの定義を作成および管理する

前提条件

Visual Studio Code から Azure にアクセスする

新しいロジック アプリを作成する

デザイナーでロジック アプリを表示する

Azure portal に表示

デプロイされたロジック アプリの編集