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 Storage plugin

azureDownload: Download from Azure storage

  • storageCredentialId : String
  • downloadType : String
  • buildSelector (optional)
      Nested Choice of Objects
    • downstream
      • upstreamProjectName : String

        Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

        Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

        Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

        AbstractProject based projects:
        Freestyle projects
        Multi-configuration projects
        Maven projects
        Non AbstractProject based projects:
        Pipeline jobs (aka. Workflow jobs)

      • upstreamBuildNumber : String
        The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.
    • lastWithArtifacts
      • lastCompleted
        • $class: 'MultiJobBuildSelector'
          • buildParameter
            • parameterName : String
              Name of the "build selector" parameter. A parameter with this name should be added in the build parameters section above. There is a special parameter type for choosing the build selector.

              You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.

          • permalink
            • id : String
          • $class: 'PromotedBuildSelector'
            • level : int
          • latestSavedBuild
            • specific
              • buildNumber : String
                While this selector is for build numbers (e.g. "22" for build #22), you can also resolve build parameters or environment variables (e.g. "${PARAM}"). The display name of a build and permalinks (e.g. "lastSuccessfulBuild", "lastBuild"...) can be used as well.
            • lastSuccessful
              • stable : boolean (optional)
            • upstream
              • allowUpstreamDependencies : boolean (optional)
              • fallbackToLastSuccessful : boolean (optional)
              • upstreamFilterStrategy (optional)
                Jenkins launches only one build when multiple upstreams triggered the same project at the same time. This field specifies from which upstream build to copy artifacts in those cases. "Use the oldest" copies artifacts from the upstream build with the smallest build number (that is, oldest). "Use the newest" copies artifacts from the upstream build with the largest build number (that is, newest). The default value is "Use global setting", which behaves as configured in "Manage Jenkins" > "Configure System".
                • Values: UseGlobalSetting, UseOldest, UseNewest
            • workspace
            • containerName : String (optional)
              Enter a storage container name.
              Environment variables can also be referenced.
              For example: ${JOB_NAME}
            • deleteFromAzureAfterDownload : boolean (optional)
              If checked, the file copy on Azure will be removed after it's downloaded to local.
            • downloadDirLoc : String (optional)
              Enter a download path. If not specified, the files will be downloaded into the job's workspace.
              Environment variables can also be referenced, for example: ${JOB_NAME} If "Flatten Directories" is checked, this directory will contain all outputs.
            • excludeFilesPattern : String (optional)
              Enter a pattern of blobs to exclude from the download. Ant fileset syntax. Leaving blank will download the entire container. Environment variables can also be referenced.
              For example: ${JOB_NAME}
            • fileShare : String (optional)
              Enter a Azure File Storage Share name.
              Environment variables can also be referenced.
              For example: ${JOB_NAME}
            • flattenDirectories : boolean (optional)
              If checked, all files specified for download will be flattened to the single download directory. If two files are named the same in different directories, only one will remain.
            • includeArchiveZips : boolean (optional)
              The archive zip files generated ( in the root of the container/virtual path) are typically excluded from download. Check this to enable downloading of the archive zip.
            • includeFilesPattern : String (optional)
              Enter a pattern of blobs to download. Ant fileset syntax. Environment variables can also be referenced.
              For example: ${JOB_NAME}
            • projectName : String (optional)
              The name of the project to download the managed artifact from.
            • verbose : boolean (optional)

              Enabling this will provide more logging on downloading files.

            azureUpload: Upload artifacts to Azure Storage

            • storageCredentialId : String
            • filesPath : String
            • storageType : String
            • allowAnonymousAccess : boolean (optional)
            • blobProperties (optional)
                Nested Object
              • cacheControl : String (optional)
              • contentEncoding : String (optional)
              • contentLanguage : String (optional)
              • contentType : String (optional)
              • detectContentType : boolean (optional)

                Auto detect content type based on file content and file name if content type is not set.

                This detection is provided by Apache Tika and may not always be accurate.

            • cleanUpContainerOrShare : boolean (optional)
            • cleanUpVirtualPath : boolean (optional)
            • containerName : String (optional)
            • doNotFailIfArchivingReturnsNothing : boolean (optional)
            • doNotUploadIndividualFiles : boolean (optional)
            • doNotWaitForPreviousBuild : boolean (optional)
            • excludeFilesPath : String (optional)
            • fileShareName : String (optional)
            • metadata (optional)
                Array / List of Nested Object
              • key : String
                Metadata key for the files from this build. It will be prefixed by "x-ms-meta-" when uploaded to Azure. Can contain macros (e.g. environment variables).
              • value : String
                Metadata value for the files from this build. Can contain macros (e.g. environment variables).
            • onlyUploadModifiedArtifacts : boolean (optional)
            • pubAccessible : boolean (optional)
            • removePrefixPath : String (optional)
            • uploadArtifactsOnlyIfSuccessful : boolean (optional)
            • uploadZips : boolean (optional)
            • verbose : boolean (optional)

              Enabling this will provide more logging on uploading files.

            • virtualPath : String (optional)

            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.