AzureIoTEdge@2 - Azure IoT Edge v2 工作

使用此工作快速且有效率地建置映像至 Azure IoT Edge。

此工作支援自定義變數。 如果您不熟悉如何在 Pipelines 中使用變數，請參閱 定義變數。

備註

此工作不支援使用工作流程身分識別同盟 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 imagesGenerate 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中樞。 （我們建議將 Deploy 工作放在發行管線中。

deploymentFilePath - 部署檔案
string。 action == Deploy to IoT Edge devices時為必要項。 預設值：$(System.DefaultWorkingDirectory)/config/deployment.json。

選取部署 JSON 檔案。 如果這項工作位於 release pipeline中，您必須在成品中設定部署檔案的位置。 （預設值適用於大多數條件。如果這項工作位於組建管線中，您必須指定部署指令清單輸出路徑。

azureSubscription - Azure 訂用帳戶包含 IoT 中樞
輸入別名：connectedServiceNameARM。 string。 action == Deploy to IoT Edge devices時為必要項。

選取包含IoT中樞的 Azure 訂用帳戶。

iothubname - IoT 中樞名稱
string。 action == Deploy to IoT Edge devices時為必要項。

選取IoT中樞。

deploymentid - IoT Edge 部署標識碼
string。 action = Deploy to IoT Edge devices時為必要項。 預設值：$(System.TeamProject)-devops-deployment。

輸入IoT Edge部署標識碼。 如果標識碼已經存在，則會被覆寫。 這最多有 128 個小寫字母和數位，而且允許下列字元：-:+%_#*?!(),=@;'。 如需詳細資訊，請參閱 Azure IoT Edge 部署。

priority - IoT Edge 部署優先順序
string。 action = Deploy to IoT Edge devices時為必要項。 預設值：0。

將 priority 設定為正整數，以解決部署衝突。 當此工作以多個部署為目標時，裝置會使用優先順序最高的部署，或在兩個具有相同優先順序的部署時，使用最新的建立時間。 如需詳細資訊，請參閱 Azure IoT Edge 部署。

deviceOption - 選擇單一/多個裝置
string。 action == Deploy to IoT Edge devices時為必要項。 允許的值：Single Device、Multiple Devices。

根據標籤，選擇部署到單一或多個裝置。

deviceId - IoT Edge 裝置識別碼
string。 deviceOption == Single Device時為必要項。

輸入 IoT Edge device ID。

targetcondition - IoT Edge 裝置目標條件
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 中樞在內的泛型登錄。

dockerRegistryConnection - Docker 登錄連線
輸入別名：dockerRegistryEndpoint。 string。 containerregistrytype = Generic Container Registry時為必要項。

選取一般 Docker 登錄連線。 這是建置和推送的必要專案。

azureSubscriptionEndpoint - Azure 訂用帳戶
string。 選擇性。 containerregistrytype = Azure Container Registry時使用 。

選取 Azure 訂用帳戶。

azureContainerRegistry - Azure Container Registry
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-amd64arm32v7。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、傳統組建、傳統版本
執行於	Agent、DeploymentGroup
需求	沒有
功能	此工作不符合作業中後續工作的任何需求。
命令限制	任意
Settable 變數	任意
代理程式版本	所有支援的代理程式版本。
工作類別	建造