AzureIoTEdge@2 - Azure IoT Edge v2 タスク

このタスクを使用して、Azure IoT Edge にすばやく効率的にイメージをビルドしてデプロイします。

このタスクでは、カスタム変数がサポートされています。 パイプラインで変数を使用する方法に慣れていない場合は、変数 定義する方法に関するページを参照してください。

注

このタスクでは、ワークフロー ID フェデレーション を使用した Azure Resource Manager 認証はサポートされていません。

構文

# Azure IoT Edge v2
# Build and deploy an Azure IoT Edge image.
- task: AzureIoTEdge@2
  inputs:
    action: 'Build module images' # 'Build module images' | 'Push module images' | 'Generate deployment manifest' | 'Deploy to IoT Edge devices'. Required. Action. Default: Build module images.
    #deploymentFilePath: '$(System.DefaultWorkingDirectory)/config/deployment.json' # string. Required when action == Deploy to IoT Edge devices. Deployment file. Default: $(System.DefaultWorkingDirectory)/config/deployment.json.
    #azureSubscription: # string. Alias: connectedServiceNameARM. Required when action == Deploy to IoT Edge devices. Azure subscription contains IoT Hub. 
    #iothubname: # string. Required when action == Deploy to IoT Edge devices. IoT Hub name. 
    #deviceOption: # 'Single Device' | 'Multiple Devices'. Required when action == Deploy to IoT Edge devices. Choose single/multiple device. 
    #deviceId: # string. Required when deviceOption == Single Device. IoT Edge device ID. 
    #targetcondition: # string. Required when deviceOption == Multiple Devices. IoT Edge device target condition. 
    #containerregistrytype: 'Azure Container Registry' # 'Azure Container Registry' | 'Generic Container Registry'. Required when action = Push module images. Container registry type. Default: Azure Container Registry.
    #dockerRegistryConnection: # string. Alias: dockerRegistryEndpoint. Required when containerregistrytype = Generic Container Registry. Docker Registry Connection. 
    #azureSubscriptionEndpoint: # string. Optional. Use when containerregistrytype = Azure Container Registry. Azure subscription. 
    #azureContainerRegistry: # string. Required when containerregistrytype = Azure Container Registry. Azure Container Registry. 
    #templateFilePath: 'deployment.template.json' # string. Required when action = Build module images || action = Push module images || action = Generate deployment manifest. .template.json file. Default: deployment.template.json.
    #defaultPlatform: 'amd64' # 'amd64' | 'windows-amd64' | 'arm32v7' | 'arm64v8'. Required when action = Build module images || action = Push module images || action = Generate deployment manifest. Default platform. Default: amd64.
    #fillRegistryCredential: 'true' # 'true' | 'false'. Required when action = Push module images. Add registry credential to deployment manifest. Default: true.
    #deploymentManifestOutputPath: '$(System.DefaultWorkingDirectory)/config/deployment.json' # string. Required when action == Generate deployment manifest. Output path. Default: $(System.DefaultWorkingDirectory)/config/deployment.json.
    #validateGeneratedDeploymentManifest: 'false' # 'true' | 'false'. Required when action = Generate deployment manifest. Validate the schema of generated deployment manifest. Default: false.
  # Advanced
    #deploymentid: '$(System.TeamProject)-devops-deployment' # string. Required when action = Deploy to IoT Edge devices. IoT Edge deployment ID. Default: $(System.TeamProject)-devops-deployment.
    #priority: '0' # string. Required when action = Deploy to IoT Edge devices. IoT Edge deployment priority. Default: 0.
  # Advanced
    #bypassModules: # string. Optional. Use when action = Push module images. Bypass module(s).

入力

action - アクションの
string. 必須。 使用できる値: Build module images、Push module images、Generate deployment manifest、Deploy to IoT Edge devices。 既定値: Build module images.

Azure IoT Edge アクションを選択します。

Build module images モジュールのみをビルドします (コンパイル エラーを確認するために使用できます)。

Push module images は、モジュールをコンテナー レジストリにプッシュします。

Deploy to IoT Edge devices は、生成されたデプロイ ファイルを IoT Hub にデプロイします。 (Deploy タスクをリリース パイプラインに配置することをお勧めします)。

deploymentFilePath - 展開ファイルの
string. action == Deploy to IoT Edge devicesする場合に必要です。 既定値: $(System.DefaultWorkingDirectory)/config/deployment.json.

デプロイ json ファイルを選択します。 このタスクが release pipelineされている場合は、アーティファクト内のデプロイ ファイルの場所を設定する必要があります。 (既定値はほとんどの条件で機能します)。このタスクがビルド パイプライン内にある場合は、配置マニフェストの出力パスを指定する必要があります。

Azure サブスクリプションに IoT Hubが含まれている azureSubscription -
入力エイリアス: connectedServiceNameARM。 string. action == Deploy to IoT Edge devicesする場合に必要です。

IoT Hub を含む Azure サブスクリプションを選択します。

iothubname - IoT Hub 名
string. action == Deploy to IoT Edge devicesする場合に必要です。

IoT Hub を選択します。

deploymentid - IoT Edge デプロイ ID
string. action = Deploy to IoT Edge devicesする場合に必要です。 既定値: $(System.TeamProject)-devops-deployment.

IoT Edge デプロイ ID を入力します。 ID が既に存在する場合は、オーバーライドされます。 これには最大 128 個の小文字と数字があり、次の文字を使用できます: -:+%_#*?!(),=@;'。 詳細については、「Azure IoT Edge デプロイ」を参照してください。

IoT Edge デプロイの優先順位を priority - する
string. action = Deploy to IoT Edge devicesする場合に必要です。 既定値: 0.

デプロイの競合を解決するために、priority を正の整数に設定します。 このタスクが複数のデプロイの対象である場合、デバイスは優先度が最も高いものを使用するか、同じ優先度の 2 つのデプロイの場合は、最新の作成時刻を使用します。 詳細については、「Azure IoT Edge デプロイ」を参照してください。

deviceOption - 1 つ以上のデバイス を選択する
string. action == Deploy to IoT Edge devicesする場合に必要です。 使用できる値: Single Device、Multiple Devices。

タグに従って、1 つまたは複数のデバイスにデプロイすることを選択します。

deviceId - IoT Edge デバイス ID
string. deviceOption == Single Deviceする場合に必要です。

IoT Edge device IDを入力します。

IoT Edge デバイスのターゲット条件を targetcondition - する
string. deviceOption == Multiple Devicesする場合に必要です。

展開するデバイスの target condition を入力します。 二重引用符は使用しないでください。 例: tags.building=9 と tags.environment='test'。 詳細については、「Azure IoT Edge デプロイ」を参照してください。

containerregistrytype - コンテナー レジストリの種類
string. action = Push module imagesする場合に必要です。 使用できる値: Azure Container Registry、Generic Container Registry。 既定値: Azure Container Registry.

Container Registry Typeを選択します。 Azure Container Registry は ACR 用であり、Generic Container Registry は Docker ハブを含む汎用レジストリ用です。

Docker レジストリ接続の dockerRegistryConnection -
入力エイリアス: dockerRegistryEndpoint。 string. containerregistrytype = Generic Container Registryする場合に必要です。

汎用 Docker レジストリ接続を選択します。 これはビルドとプッシュに必要です。

Azure サブスクリプション を する
string. 任意 containerregistrytype = Azure Container Registryするときに使用します。

Azure サブスクリプションを選択します。

Azure Container Registryを azureContainerRegistry - する
string. containerregistrytype = Azure Container Registryする場合に必要です。

Azure Container Registry を指定します。 この値は、json 形式で指定する必要があります。

azureContainerRegistry: '{"loginServer": "contoso.azurecr.io"}

templateFilePath - .template.json ファイルの
string. action = Build module images || action = Push module images || action = Generate deployment manifestする場合に必要です。 既定値: deployment.template.json.

Azure IoT Edge ソリューションのパス .template.json。 このファイルは、Azure IoT Edge ソリューションのモジュールとルートを定義します。 ファイル名は .template.jsonで終わる必要があります。

既定のプラットフォームを defaultPlatform - する
string. action = Build module images || action = Push module images || action = Generate deployment manifestする場合に必要です。 使用できる値: amd64、windows-amd64、arm32v7、arm64v8。 既定値: amd64.

.template.jsonでは、モジュール プラットフォームを未指定のままにすることができます。 これらのモジュールでは、既定のプラットフォームが使用されます。

fillRegistryCredential - 配置マニフェストにレジストリ資格情報を追加
string. action = Push module imagesする場合に必要です。 使用できる値: true、false。 既定値: true.

Docker イメージを配置マニフェストにプッシュするためのレジストリ資格情報を追加します。

deploymentManifestOutputPath - 出力パス
string. action == Generate deployment manifestする場合に必要です。 既定値: $(System.DefaultWorkingDirectory)/config/deployment.json.

生成された配置マニフェストの出力パス。

validateGeneratedDeploymentManifest - 生成された配置マニフェストのスキーマを検証
string. action = Generate deployment manifestする場合に必要です。 使用できる値: true、false。 既定値: false.

生成された配置マニフェストがスキーマ検証に合格しない場合、この手順は失敗します。 JSON スキーマ ストア で Azure IoT Edge deployment を検索して、最新のスキーマを検索します。

bypassModules - バイパス モジュールの
string. 任意 action = Push module imagesするときに使用します。

.template.jsonでビルドまたはプッシュする必要のないモジュールを選択し、モジュール名を指定し、コンマで区切ります。 例: .template.json に SampleModule1 と SampleModule2 があり、SampleModule1のみをビルドまたはプッシュする場合は、バイパス モジュールを SampleModule2として設定します。 .template.jsonですべてのモジュールをビルドする場合は、これを空のままにします。

タスク コントロールのオプション

すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「コントロール オプションと一般的なタスク プロパティを参照してください。

出力変数

このタスクでは、次の 出力変数を定義します。この変数は、ダウンストリームのステップ、ジョブ、およびステージで使用できます。

DEPLOYMENT_FILE_PATH
これは、生成されたデプロイ ファイルのパスです。

注釈

このタスクを使用して、アプリケーションを迅速かつ効率的に Azure IoT Edge にビルド、テスト、デプロイします。

このタスクでは、カスタム変数がサポートされています。 パイプラインで変数を使用する方法に慣れていない場合は、「変数を定義する」を参照してください。

例示

モジュール イメージをビルドする

次の YAML の例では、モジュール イメージをビルドします。

- task: AzureIoTEdge@2
  displayName: AzureIoTEdge - Build module images
  inputs:
    action: Build module images
    templateFilePath: deployment.template.json
    defaultPlatform: amd64  

モジュール イメージをプッシュする

次の YAML の例では、モジュール イメージをプッシュします。

variables:
  azureSubscriptionEndpoint: Contoso
  azureContainerRegistry: contoso.azurecr.io

steps:    
- task: AzureIoTEdge@2
  displayName: AzureIoTEdge - Push module images
  inputs:
    action: Push module images
    containerregistrytype: Azure Container Registry
    azureSubscriptionEndpoint: $(azureSubscriptionEndpoint)
    azureContainerRegistry: {"loginServer":"$(azureContainerRegistry)"}
    templateFilePath: deployment.template.json
    defaultPlatform: amd64
    fillRegistryCredential: true

配置マニフェストを生成する

次の YAML の例では、テンプレート ファイルに基づいて配置マニフェストを作成します。

steps:    
- task: AzureIoTEdge@2
  displayName: AzureIoTEdge - Generate deployment manifest
  inputs:
    action: Generate deployment manifest
    templateFilePath: deployment.template.json
    defaultPlatform: amd64
    deploymentManifestOutputPath: $(System.DefaultWorkingDirectory)/config/deployment.json
    validateGeneratedDeploymentManifest: false

IoT Edge デバイスにデプロイする

次の YAML の例では、モジュール イメージをデプロイします。

steps:
- task: AzureIoTEdge@2
  displayName: 'Azure IoT Edge - Deploy to IoT Edge devices'
  inputs:
    action: 'Deploy to IoT Edge devices'
    deploymentFilePath: $(System.DefaultWorkingDirectory)/config/deployment.json
    azureSubscription: $(azureSubscriptionEndpoint)
    iothubname: iothubname
    deploymentid: '$(System.TeamProject)-devops-deployment'
    priority: '0'
    deviceOption: 'Single Device'
    deviceId: deviceId

その他の例

Azure Pipelines でこれらのアクションを使用する方法の詳細な例については、次の記事を参照してください。

• Azure IoT Edge デバイス (YAML) への継続的インテグレーションと継続的デプロイ
• Azure IoT Edge デバイスへの継続的インテグレーションと継続的デプロイの (クラシック エディター)

必要条件

要件	説明
パイプラインの種類	YAML、クラシック ビルド、クラシック リリース
実行日	エージェント、DeploymentGroup
の需要	なし
機能の	このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限	どれでも
設定可能な変数	どれでも
エージェントのバージョン	サポートされているすべてのエージェント バージョン。
タスク カテゴリ	建築する