The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Azure IoT Edge Plugin

azureIoTEdgeDeploy: Azure IoT Edge Deploy

  • azureCredentialsId (optional)
    • Type: String
  • resourceGroup (optional)
    • Type: String
  • rootPath (optional)

    In some cases, the Edge solution is not under the root of the code repository. You can specify path to the root of Edge solution in build definition. Example: If your code repository is an Edge solution, then leave it to default value './'. If your solution is under subfolder 'edge', then set it to 'edge'" Please notice that the module.json file path is relative to the root path of solution.

    • Type: String
  • deploymentId (optional)

    Input the IoT Edge Deployment ID, if ID exists, it will be overridden.Lowercase letters, numbers and the following characters are allowed [ -:+%_#*?!(),=@;' ], no more than 128 characters. For more information: Visit docs

    • Type: String
  • deploymentType (optional)
    • Type: String
  • deviceId (optional)
    • Type: String
  • iothubName (optional)
    • Type: String
  • priority (optional)

    Set the priority to a positive integer to resolve deployment conflicts: when targeted by multiple deployments a device will use the one with highest priority or (in case of two deployments with the same priority) latest creation time. For more information: Visit docs

    • Type: String
  • targetCondition (optional)

    A target condition to determine which devices will be targeted with this deployment. Example tags.environment='test', properties.reported.devicemodel='4000x'

    • Type: String

azureIoTEdgePush: Azure IoT Edge Build and Push

  • azureCredentialsId (optional)
    • Type: String
  • resourceGroup (optional)
    • Type: String
  • rootPath (optional)

    In some cases, the Edge solution is not under the root of the code repository. You can specify path to the root of Edge solution in build definition. Example: If your code repository is an Edge solution, then leave it to default value './'. If your solution is under subfolder 'edge', then set it to 'edge'" Please notice that the module.json file path is relative to the root path of solution.

    • Type: String
  • acrName (optional)
    • Type: String
  • bypassModules (optional)

    List of modules to bypass when building.

    You can leave this field empty to build all modules

    Or use comma delimited list of modules. Example "ModuleA,ModuleB"

    • Type: String
  • dockerRegistryEndpoint (optional)
      Nested Object
    • url
      URL to the Docker registry you are using. May be left blank to use the public DockerHub registry (currently https://index.docker.io/v1/).
      • Type: String
    • credentialsId
      • Type: String
  • dockerRegistryType (optional)
    • Type: String

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.