Azure Logic Apps のワークフロー入力のためのクロス環境パラメーターを作成する

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

Azure Logic Apps では、"パラメーター" を定義することによって、開発、テスト、および運用環境で、ワークフローで変化する可能性のある値を抽象化できます。 環境固有の変数ではなくパラメーターを使用する場合、最初はワークフローの設計に集中し、後から環境固有の変数を挿入できます。

この記事では、マルチテナントの従量課金ロジック アプリ ワークフローとシングルテナントの Standard ロジック アプリ ワークフローのパラメーターを作成、使用、編集する方法について説明します。 また、環境変数を管理する方法についても説明します。

マルチテナントとシングルテナントの Azure Logic Apps の詳細については、「Azure Logic Apps でのシングルテナント、マルチテナント、統合サービス環境の比較」を参照してください。

前提条件

• Azure アカウントとサブスクリプション。 サブスクリプションをお持ちでない場合には、無料の Azure アカウントにサインアップしてください。

• 従量課金または Standard のロジック アプリ ワークフロー

  ロジック アプリ ワークフローがまだない場合は、Azure portal を使用した従量課金ロジック アプリ ワークフローの例の作成に関するページまたは Azure portal を使用した Standard ロジック アプリ ワークフローの例の作成に関するページを参照してください。

  Note

  現在、従量課金ロジック アプリ ワークフローのパラメーターを作成するには、Azure portal を使用する必要があります。 Standard ロジック アプリ ワークフローのパラメーターを作成するには、Azure portal または Visual Studio Code を使用する必要があります。

従量課金と Standard のロジック アプリ ワークフローのパラメーター

従量課金 と Standard の両方のロジック アプリ ワークフローで、デザイナーを使用してパラメーターを定義できます。 パラメーターを定義した後は、"同じ" ロジック アプリ リソース内の任意のワークフローまたは接続からそのパラメーターを参照できます。

マルチテナントの従量課金ロジック アプリ ワークフローでは、デザイナーでパラメーターを作成して使用した後、Azure Resource Manager テンプレート (ARM テンプレート) とテンプレート パラメーター ファイルで環境変数を定義し、設定します。 このシナリオでは、"デプロイ時に" パラメーターを定義して設定する必要があるため、1 つの変数を変更するだけでも、ロジック アプリの ARM テンプレートを再デプロイする必要があります。

シングルテナントの Standard ロジック アプリ ワークフローでは、パラメーター "および" アプリ設定を使用して、実行時とデプロイの両方で環境変数を操作できます。 アプリ設定には、同じロジック アプリ リソース内の "すべてのワークフロー" のためのグローバル構成オプションが含まれています。 詳細については、シングルテナントベースのロジック アプリのホストとアプリ設定の編集に関するページを参照してください。

Note

Standard ロジック アプリ ワークフローでは、securestring や secureobject などのセキュリティで保護されたデータ型はサポートされていません。 ただし、別のオプションとして、アプリ設定を Azure Key Vault とともに使用できます。 これで、接続文字列やキーなど、セキュリティで保護された文字列を直接参照できます。 デプロイ時に環境変数を定義できる ARM テンプレートと同様に、ロジック アプリのワークフロー定義内でアプリ設定を定義できます。 その後、動的に生成されたインフラストラクチャ値 (接続エンドポイント、ストレージ文字列など) を取得できます。

ただし、アプリ設定にはサイズ制限があり、Azure Logic Apps の特定の領域からは参照できません。 パラメーターでは、大きな値のサイズや複雑なオブジェクトのサポートなど、アプリ設定よりも幅広いユース ケースが提供されます。

たとえば、ローカル開発ツールとして Visual Studio Code を使用してワークフローをローカルで実行する場合、ロジック アプリ プロジェクトでは、parameters.json ファイルを使用してパラメーターを定義できます。 その後、プロジェクトの workflow.json ファイルの任意のワークフローや、プロジェクトの connections.json ファイル内の任意の接続オブジェクトから、このパラメーター ファイル内の任意のパラメーターを参照できます。 次の一覧に、一般的なユースケースをいくつか示します。

• テスト時に使用するすべての値を含むテスト パラメーター ファイルを用意します。 デプロイ時に、テスト パラメーター ファイルを運用パラメーター ファイルに置き換えることができます。

• connections.json ファイルのさまざまな部分をパラメーター化します。 その後、connections.json ファイルをソース管理にチェックインし、parameters.json ファイルを介して接続を管理できます。

• authentication JSON オブジェクトなどの複雑なオブジェクトをパラメーター化します。 たとえば、authentication オブジェクトの値を、単一のパラメーター式 (@parameters('api-auth')など) を保持する文字列に置き換えることができます。

• プロジェクトの local.settings.json ファイルでアプリ設定を確認し、編集します。 その後、これらのアプリ設定をパラメーターで参照できます。

Note

一般的な推奨事項として、値をパラメーター化する既定の方法として、アプリ設定ではなく、パラメーターを使用することを検討してください。 そうすることで、セキュリティで保護されたキーや文字列を格納する必要がある場合、推奨事項に従って、パラメーターからアプリ設定を参照できます。 必要に応じて、両方のオプションをソリューションで使用するには、パラメーターを使用してアプリ設定を参照します。

パラメーターの定義、使用、および編集

従量課金プラン

Azure portal

1. Azure portal で、ロジック アプリ ワークフローを開きます。 [ワークフロー] で、ワークフローを選択してデザイナーで開きます。

2. デザイナーのツール バーから、 [パラメーター] を選択します。

   

3. [パラメーター] ペインで、[パラメーターの追加] を選択します。

4. 作成するパラメーターに関する次の情報を指定します。

   プロパティ	必須	説明
   名前	はい	作成するパラメーターの名前です。
   Type	はい	パラメーターのデータ型。Array、Bool、Float、Int、Object、Secure Object、Secure String、String などです。
   既定値	はい	パラメーターの既定値です。 ワークフロー ロジック、接続情報、パラメーター値が 1 つの場所に存在しないため、既定のパラメーター値を指定する必要があります。 デザイナーでは、読み込み前にパラメーター値を解決できる必要があります。 重要: Secure Object と Secure String のデータ型の場合は、値がプレーンテキストとして格納されるので、既定値を設定しないようにしてください。
   [実際の値]	いいえ	パラメーターの実際の値。

   次の例は、文字列パラメーターの定義を示しています。

   

5. 追加するパラメーターが他にある場合は、[パラメーターの追加] を選択します。 それ以外の場合は、パラメーターのペインを閉じますが、新しいパラメーターの定義を保存するために、必ずワークフローを保存してください。

6. 同じワークフロー内に含まれるトリガーまたはアクションからパラメーターを参照するには、以下の手順を実行します。

   1. デザイナーで、目的のワークフローを開き、トリガーまたはアクションを展開します。

   2. パラメーターを使用するプロパティで、そのプロパティの編集ボックス内をクリックします。

   3. 開いた動的なコンテンツの一覧の [パラメーター] で、以前に作成したパラメーターを選択します。次に例を示します。

      

7. ロジック アプリ ワークフローのパラメーターを表示または編集するには、以下の手順に従います。

   1. デザイナーでロジック アプリ ワークフローを開きます。 デザイナーのツール バーで、 [パラメーター] を選択します。

      [パラメーター] ペインが開き、そのワークフローに定義したすべてのパラメーターが表示されます。

   2. 編集を行い、パラメーターのペインを閉じて、ロジック アプリ ワークフローを保存します。

Standard

Azure portal

1. Azure portal で、ロジック アプリ リソースを開きます。 [ワークフロー] で、ワークフローをデザイナーで開きます。

2. デザイナーのツール バーから、 [パラメーター] を選択します。

   

3. [パラメーター] ペインで、 [パラメーターの作成] を選択します。

4. 作成するパラメーターに関する次の情報を指定します。

   プロパティ	必須	説明
   名前	はい	作成するパラメーターの名前です。
   Type	はい	パラメーターのデータ型。Array、Bool、Float、Int、Object、String などです。 注: Standard ロジック アプリ ワークフローでは、securestring や secureobject などのセキュリティで保護されたデータ型はサポートされていません。
   Value	はい	パラメーターの値。 Standard ロジック アプリ ワークフローでは、ワークフロー ロジック、接続情報、パラメーター値が 1 つの場所に存在しないため、パラメーター値を指定する必要があります。 デザイナーでは、読み込み前にパラメーター値を解決できる必要があります。

   次の例は、文字列パラメーターの定義を示しています。

   

5. 完了したら、 [パラメーター] ペインを閉じますが、新しいパラメーターの定義を保存するために、必ずワークフローを保存してください。

6. 同じロジック アプリ内の任意のワークフローに含まれるトリガーまたはアクションからパラメーターを参照するには、これらの手順を実行します。

   1. デザイナーで、目的のワークフローを開き、トリガーまたはアクションを展開します。

   2. パラメーターを使用するプロパティで、そのプロパティの編集ボックス内をクリックします。

   3. 開いた動的なコンテンツの一覧の [パラメーター] で、以前に作成したパラメーターを選択します。次に例を示します。

      

7. パラメーターを同じロジック アプリで表示または編集するには、次のいずれかの手順に従います。

   • そのロジック アプリで任意のワークフローを開きます。 ワークフロー メニューで、 [デザイナー] を選択します。 デザイナーのツール バーで、 [パラメーター] を選択します。

     [パラメーター] ペインが開き、そのロジック アプリのワークフローから定義したすべてのパラメーターが表示されます。

   • 一括での JSON の表示または編集を行うには、ロジック アプリのメインメニューで、 [パラメーター] を選択します。

     [パラメーター] JSON ビューが開き、そのロジック アプリのワークフローから定義したすべてのパラメーターが表示されます。

Visual Studio Code

1. parameters.json という名前のプロジェクトのルートレベルの JSON ファイルで、"すべて" のパラメーターとその値を定義します。 このファイルには "キーと値" のペアを含むオブジェクトがあります。 各 "キー" は各パラメーターの名前であり、各 "値" は各パラメーターの構造体です。 各構造体には、type と value の両方の宣言を含める必要があります。

   重要

   parameters.json ファイルには、ワークフローの定義や接続など、プロジェクト内の他の場所で参照または使用するすべてのパラメーターとその値を定義し、含める必要があります。

   次の例は、基本的なパラメーター ファイルを示しています。

   {
       "responseString": { 
           "type": "string", 
           "value": "hello" 
       },
       "functionAuth": { 
           "type": "object", 
           "value": { 
               "type": "QueryString", 
               "name": "Code", 
               "value": "@appsetting('<AzureFunctionsOperation-FunctionAppKey>')" 
           }
       }
    }
   

   Note

   parameters.json ファイルでは、@appsetting が唯一有効な式の型です。

2. トリガーまたはアクション入力でパラメーターを参照するには、式 @parameters('<parameter-name>') を使用します。

接続ファイルのパラメーター化

connections.json ファイルをパラメーター化するには、ConnectionRuntimeUrl などのリテラル値を単一の parameters() 式 (たとえば、@parameters('api-runtimeUrl')) に置き換えます。 connections.json ファイルで、有効な式の型は @parameters と @appsetting だけです。

重要

開発時に connections.json ファイルをパラメーター化すると、ローカルと Azure portal の両方でデザイナー エクスペリエンスが制限されます。 デザイナーを開発に使用する必要がある場合は、パラメーター化されていない connections.json ファイルを代わりに使用してください。 その後、デプロイ パイプラインで、パラメーター化されたファイルに置き換えます。 この場合でも、ランタイムはパラメーター化で動作します。 デザイナーの機能強化は、現在開発中です。

次の例では、アプリ設定とパラメーターの両方を使用する、パラメーター化された connections.json ファイルを示します。 可能な限りパラメーターを使用したいところですが、このシナリオは例外またはエッジ ケースになります。ここでパラメーターではなくアプリ設定を使用するのは、アプリ設定がデプロイ時に生成され、開発パイプラインでデータを動的に設定しやすいためです。 このサンプル ファイルでは、複雑な blob_auth 認証オブジェクトにパラメーターを使用し、その他の値にアプリ設定を使用しています。 この場合、パラメーターをワークフローで参照することがほとんどないため、認証オブジェクトにパラメーターを使用できます。

{
   "serviceProviderConnections": {
      "serviceBus": {
         "parameterValues": {
            "connectionString": "@appsetting('serviceBus_connectionString')"
        },
        "serviceProvider": {
           "id": "/serviceProviders/serviceBus"
        },
        "displayName": "servicebus"
     }
   },
   "managedApiConnections": {
      "azureblob": {
         "api": {
            "id": "/subscriptions/@{appsetting('WORKFLOWS_SUBSCRIPTION_ID')}/providers/Microsoft.Web/locations/@{appsetting('WORKFLOWS_LOCATION_NAME')}/managedApis/azureblob"
         },
         "connection": {
            "id": "/subscriptions/@{appsetting('WORKFLOWS_SUBSCRIPTION_ID')}/resourceGroups/@{appsetting('WORKFLOWS_RESOURCE_GROUP_NAME')}/providers/Microsoft.Web/connections/azureblob"
         },
         "connectionRuntimeUrl": "@appsetting('BLOB_CONNECTION_RUNTIMEURL')",
         "authentication": "@parameters('blob_auth')"
      }
   }
}

Note

プレーンテキストでインラインの式がある場合は、その式を中かっこ ({}) で囲み、その式の補間形式を使用してください。 この形式は、解析の問題を回避するのに役立ちます。

たとえば、"<text>/@<function-name>('<parameter-name>')/<text>" がある場合は、代わりに次のバージョンを使用します。 "<text>/@{<function-name>('<parameter-name>')}/<text>"。

詳細については、「関数の使用に関する考慮事項」を参照してください。

パラメーター ファイルを管理する

通常、複数のバージョンのパラメーター ファイルを管理する必要があります。 開発、テスト、運用などのデプロイ環境に応じて、さまざまな目標値が設定されている場合があります。 多くの場合、これらのパラメーター ファイルの管理は、ARM テンプレート パラメーター ファイルの管理と同様です。 特定の環境にデプロイする場合、通常は DevOps のパイプラインを通じて、対応するパラメーター ファイルを昇格させます。

Azure CLI を使用してパラメーター ファイルを動的に置き換えるには、次のコマンドを実行します。

az functionapp deploy --resource-group MyResourceGroup --name MyLogicApp --src-path C:\parameters.json --type static --target-path parameters.json

NuGet ベースのロジック アプリ プロジェクトがある場合は、プロジェクト ファイル ( <ロジック アプリ名>.csproj) を更新し、次のようにビルド出力にパラメーター ファイルを含める作業が必要です。

<ItemGroup>
  <None Update="parameters.json">
    <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
  </None>
</ItemGroup>

Note

現時点ではまだ、パラメーター ファイルを動的に置き換える機能を Azure portal およびワークフロー デザイナーで使用することはできません。

DevOps デプロイ用にロジック アプリを設定する方法の詳細については、次のドキュメントを参照してください。

• シングルテナント ベースのロジック アプリ用の DevOps デプロイの概要
• シングルテナント ベースのロジック アプリ用の DevOps デプロイを設定する

アプリ設定を管理する

シングルテナントの Azure Logic Apps では、アプリ設定に、同じロジック アプリ内の "すべてのワークフロー" に適用されるグローバル構成オプションが含まれています。 ワークフローを Visual Studio Code でローカルに実行すると、これらのアプリ設定に、local.settings.json ファイル内のローカル環境変数としてアクセスできます。 その後、これらのアプリ設定をパラメーターで参照できます。

アプリ設定を追加、更新、または削除するには、Visual Studio Code、Azure portal、Azure CLI、または ARM (Bicep) テンプレートに関する以下のセクションを選択して確認してください。

Azure portal

ロジック アプリ リソースのアプリ設定を Azure portal で確認するには、以下の手順に従います。

1. Azure portal で、ロジック アプリ リソースを開きます。

2. ロジック アプリのメニューにある [設定] で、 [構成] を選択します。

3. [構成] ページの [アプリケーション設定] タブで、ロジック アプリのアプリ設定を確認します。

4. すべての値を表示するには、 [値を表示する] を選択します。 または、1 つの値を表示するには、その値を選択します。

新しい設定を追加するには、次の手順に従います。

1. [アプリケーション設定] タブの [アプリケーション設定] で、 [新しいアプリケーション設定] を選択します。

2. [名前] に、新しい設定の "キー" または名前を入力します。

3. [値] には、新しい設定の値を入力します。

4. 新しい "キーと値" のペアを作成する準備ができたら、 [OK] を選択します。

   

5. 操作が完了したら、[構成] ツールバーで、[保存] を選択します。

Azure CLI

Azure CLI を使用して現在のアプリ設定を確認するには、コマンド az logicapp config appsettings list を実行します。 このコマンドに --name -n および --resource-group -g パラメーターを必ず含めてください。次に例を示します。

az logicapp config appsettings list --name MyLogicApp --resource-group MyResourceGroup

Azure CLI を使用してアプリ設定を追加または更新するには、コマンド az logicapp config appsettings set を実行します。 このコマンドに --name n および --resource-group -g パラメーターを必ず含めてください。 たとえば、次のコマンドを使用して、CUSTOM_LOGIC_APP_SETTING という名前のキーと値 12345 を持つ設定を作成します。

az logicapp config appsettings set --name MyLogicApp --resource-group MyResourceGroup --settings CUSTOM_LOGIC_APP_SETTING=12345 

Resource Manager または Bicep テンプレート

アプリ設定を ARM テンプレートまたは Bicep テンプレートで確認および定義するには、ロジック アプリのリソース定義を見つけて、appSettings JSON オブジェクトを更新します。 リソース定義の詳細については、ARM テンプレートのリファレンスを参照してください。

次の例は、ARM テンプレートまたは Bicep テンプレートのファイル設定を示しています。

"appSettings": [
    {
        "name": "string",
        "value": "string"
    },
    {
        "name": "string",
        "value": "string"
    },
    <...>
], 

次の手順

• Azure Logic Apps でのシングルテナント、マルチテナント、統合サービス環境の比較