AzureIoTEdge@2 - Azure IoT Edge v2-taak

Gebruik deze taak om snel en efficiënt installatiekopieën te bouwen en implementeren in Azure IoT Edge.

Deze taak ondersteunt aangepaste variabelen. Zie variabelen definiërenals u niet bekend bent met het gebruik van variabelen in Pijplijnen.

Notitie

Deze taak biedt geen ondersteuning voor Azure Resource Manager-verificatie metvoor werkstroomidentiteitsfederatie.

Syntaxis

# 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).

Invoer

action - actie-
string. Verplicht. Toegestane waarden: Build module images, Push module images, Generate deployment manifest, . Deploy to IoT Edge devices Standaardwaarde: Build module images.

Hiermee selecteert u een Azure IoT Edge-actie.

Build module images alleen modules bouwt (u kunt deze gebruiken om compilatiefouten te controleren).

Push module images modules pusht naar het containerregister.

Deploy to IoT Edge devices implementeert het gegenereerde implementatiebestand in IoT Hub. (U wordt aangeraden de Deploy taak in de release-pijplijn te plaatsen.)

deploymentFilePath - implementatiebestand
string. Vereist wanneer action == Deploy to IoT Edge devices. Standaardwaarde: $(System.DefaultWorkingDirectory)/config/deployment.json.

Hiermee selecteert u het JSON-implementatiebestand. Als deze taak zich in release pipelinebevindt, moet u de locatie van het implementatiebestand in artefact instellen. (De standaardwaarde werkt voor de meeste voorwaarden.) Als deze taak zich in een build-pijplijn bevindt, moet u het uitvoerpad voor het implementatiemanifest opgeven.

azureSubscription - Azure-abonnement bevat IoT Hub-
Invoeralias: connectedServiceNameARM. string. Vereist wanneer action == Deploy to IoT Edge devices.

Selecteert een Azure-abonnement dat IoT Hub bevat.

iothubname - IoT Hub-naam
string. Vereist wanneer action == Deploy to IoT Edge devices.

Selecteert de IoT Hub.

deploymentid - ioT Edge-implementatie-id
string. Vereist wanneer action = Deploy to IoT Edge devices. Standaardwaarde: $(System.TeamProject)-devops-deployment.

De IoT Edge-implementatie-id invoeren. Als de id al bestaat, wordt deze overschreven. Dit heeft maximaal 128 kleine letters en cijfers en de volgende tekens zijn toegestaan: -:+%_#*?!(),=@;'. Zie Azure IoT Edge-implementatievoor meer informatie.

prioriteit priority - IoT Edge-implementatieprioriteit
string. Vereist wanneer action = Deploy to IoT Edge devices. Standaardwaarde: 0.

Hiermee stelt u de priority in op een positief geheel getal om implementatieconflicten op te lossen. Wanneer deze taak is gericht op meerdere implementaties, gebruikt een apparaat de taak met de hoogste prioriteit of, in het geval van twee implementaties met dezelfde prioriteit, de laatste aanmaaktijd. Zie Azure IoT Edge-implementatievoor meer informatie.

deviceOption - Kies één/meerdere apparaten
string. Vereist wanneer action == Deploy to IoT Edge devices. Toegestane waarden: Single Device, Multiple Devices.

Volgens tags kiest u ervoor om te implementeren op één of meerdere apparaten.

deviceId - ioT Edge-apparaat-id
string. Vereist wanneer deviceOption == Single Device.

De IoT Edge-device IDinvoeren.

targetcondition - doelvoorwaarde voor IoT Edge-apparaten
string. Vereist wanneer deviceOption == Multiple Devices.

De target condition invoert van apparaten die u wilt implementeren. Gebruik geen dubbele aanhalingstekens. Voorbeeld: tags.building=9 en tags.environment='test'. Zie Azure IoT Edge-implementatievoor meer informatie.

containerregistrytype - containerregistertype
string. Vereist wanneer action = Push module images. Toegestane waarden: Azure Container Registry, Generic Container Registry. Standaardwaarde: Azure Container Registry.

Selecteert een Container Registry Type. Azure Container Registry is bedoeld voor ACR en Generic Container Registry is bedoeld voor algemene registers, waaronder docker hub.

dockerRegistryConnection - Docker-registerverbinding
Invoeralias: dockerRegistryEndpoint. string. Vereist wanneer containerregistrytype = Generic Container Registry.

Hiermee selecteert u een algemene Docker-registerverbinding. Dit is vereist voor het bouwen en pushen.

azureSubscriptionEndpoint - Azure-abonnement
string. Facultatief. Gebruiken wanneer containerregistrytype = Azure Container Registry.

Selecteert een Azure-abonnement.

azureContainerRegistry - Azure Container Registry-
string. Vereist wanneer containerregistrytype = Azure Container Registry.

Hiermee geeft u een Azure Container Registry op. Deze waarde moet worden opgegeven in json indeling.

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

templateFilePath - .template.json bestand
string. Vereist wanneer action = Build module images || action = Push module images || action = Generate deployment manifest. Standaardwaarde: deployment.template.json.

Het pad van de Azure IoT Edge-oplossing .template.json. Dit bestand definieert de modules en routes in de Azure IoT Edge-oplossing. De bestandsnaam moet eindigen op .template.json.

defaultPlatform - standaardplatform
string. Vereist wanneer action = Build module images || action = Push module images || action = Generate deployment manifest. Toegestane waarden: amd64, windows-amd64, arm32v7, . arm64v8 Standaardwaarde: amd64.

In uw .template.jsonkunt u het modulesplatform niet opgegeven laten. Voor deze modules wordt het standaardplatform gebruikt.

fillRegistryCredential - registerreferenties toevoegen aan het implementatiemanifest
string. Vereist wanneer action = Push module images. Toegestane waarden: true, false. Standaardwaarde: true.

Hiermee voegt u de registerreferentie voor het pushen van Docker-installatiekopieën toe aan het implementatiemanifest.

deploymentManifestOutputPath - uitvoerpad
string. Vereist wanneer action == Generate deployment manifest. Standaardwaarde: $(System.DefaultWorkingDirectory)/config/deployment.json.

Het uitvoerpad van het gegenereerde implementatiemanifest.

validateGeneratedDeploymentManifest - het schema van het gegenereerde implementatiemanifest valideren
string. Vereist wanneer action = Generate deployment manifest. Toegestane waarden: true, false. Standaardwaarde: false.

Voer deze stap uit als het gegenereerde implementatiemanifest geen schemavalidatie doorgeeft. Zoek Azure IoT Edge deployment in JSON Schema Store- om het meest recente schema te vinden.

bypassModules - module(s) overslaan
string. Facultatief. Gebruiken wanneer action = Push module images.

Selecteert de module(s) die u niet hoeft te bouwen of pushen in .template.json, geeft de modulenamen op en scheidt deze met komma's. Voorbeeld: als u SampleModule1 en SampleModule2 in uw .template.json hebt en u alleen SampleModule1wilt bouwen of pushen, stelt u de bypass-modules in als SampleModule2. Laat dit leeg als u alle modules in .template.jsonwilt bouwen.

Opties voor taakbeheer

Alle taken hebben besturingsopties naast hun taakinvoer. Zie Opties en algemene taakeigenschappenvoor meer informatie.

Uitvoervariabelen

Deze taak definieert de volgende uitvoervariabelen, die u kunt gebruiken in downstreamstappen, taken en fasen.

DEPLOYMENT_FILE_PATH
Dit is het pad van het gegenereerde implementatiebestand.

Opmerkingen

Gebruik deze taak om snel en efficiënt toepassingen te bouwen, testen en implementeren in Azure IoT Edge.

Deze taak ondersteunt aangepaste variabelen. Zie Variabelen definiërenals u niet bekend bent met het gebruik van variabelen in Pijplijnen.

Voorbeelden

Module-installatiekopieën bouwen

In het volgende YAML-voorbeeld worden moduleinstallatiekopieën gebouwd:

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

Installatiekopieën van pushmodules

In het volgende YAML-voorbeeld worden moduleinstallatiekopieën gepusht:

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

Implementatiemanifest genereren

In het volgende YAML-voorbeeld wordt een implementatiemanifest gemaakt op basis van het sjabloonbestand:

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

Implementeren naar IoT Edge-apparaten

In het volgende YAML-voorbeeld worden moduleinstallatiekopieën geïmplementeerd:

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

Meer voorbeelden

Zie de volgende artikelen voor stapsgewijze voorbeelden van het gebruik van deze acties in Azure Pipelines:

• continue integratie en continue implementatie naar YAML-apparaten (Azure IoT Edge)
• Doorlopende integratie en doorlopende implementatie op Azure IoT Edge-apparaten (de klassieke editor)

Vereisten

Voorwaarde	Beschrijving
Pijplijntypen	YAML, klassieke build, klassieke release
Wordt uitgevoerd op	Agent, DeploymentGroup
eisen	Geen
mogelijkheden	Deze taak voldoet niet aan de vereisten voor volgende taken in de taak.
opdrachtbeperkingen	Welk dan ook
variabelen instellen	Welk dan ook
Agentversie	Alle ondersteunde agentversies.
Taakcategorie	Bouwen