Azure devops pipeline restAPI How to pass varible with SourceFolder for CopyFiles Task , self hosted agent in container

Question

my set up is as follow I have hosted agent that as first job copies files from the self-hosted agent which is started as a docker container

the hosted pipeline is triggered with pipeline "run" rest API :
https://docs.microsoft.com/en-us/rest/api/azure/devops/pipelines/runs/run%20pipeline?view=azure-devops-rest-6.0

this is how the body looks like now :

"resources": {
        "repositories:": {
            "self": {
                "refName": "refs/heads/my_branch"
            }
        }
    }

it is working great.
now the part of the hosted pipeline looks like this :

- job: self_hosted_connect
  timeoutInMinutes: 10
  pool: Default
  steps:
  - task: CopyFiles@2
    inputs:
      SourceFolder: '/home/copy_dir'
      Contents: '**'
      TargetFolder: '$(build.artifactstagingdirectory)'

also, work great.

My questions are :

I like to send in the "run" rest API another parameter that contains the SourceFolder path so that the CopyFiles task will be dynamic and not have hardcode SourceFolder path
When i run the self-hosted agent from docker how do i tell the self-hosted agent to include the directory outside its working dir? so the pipeline will not fail with the error :

#[error]Unhandled: Not found SourceFolder: /home/copy_dir

UPDATE i updated the request to :

{
    "resources": {
        "repositories:": {
            "self": {
                "refName": "refs/heads/my_branch"
            }
        }
    },
    "templateParameters": {
        "Folderpath":"{/home/foo/my_dir}"
    }
}

but I'm getting an error:

{
    "$id": "1",
    "innerException": null,
    "message": "Unexpected parameter 'Folderpath'",
    "typeName": "Microsoft.Azure.Pipelines.WebApi.PipelineValidationException, Microsoft.Azure.Pipelines.WebApi",
    "typeKey": "PipelineValidationException",
    "errorCode": 0,
    "eventId": 3000
}

Vito Liu Vito Liu · Accepted Answer · 2020-09-04T08:06:34

send in the "run" rest API another parameter that contains the SourceFolder path We can use runtime parameters in pipeline.

YAML sample:

parameters:
- name: Folderpath
  displayName: 'configure Folder path'
  type: string
  default: {SourceFolder path}

steps:
- task: CopyFiles@2
  inputs:
    SourceFolder: '${{ parameters.Folderpath}}'
    Contents: '**'
    TargetFolder: '$(build.artifactstagingdirectory)'

Request URL:

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=6.0-preview.1

Request Body:

{
    "resources":{
        "repositories":{
            "self":{"refName":"refs/heads/{my_branch}"
            }
         }
    },
    "templateParameters": {
        "Folderpath":"{SourceFolder path}"
        }
}

how do i tell the self-hosted agent to include the directory outside its working dir?

We can copy the local folder or azure DevOps predefined variables to define the source folder.

Update1

We should define the parameter in the YAML build, if not, we will get the error Unexpected parameter 'Folderpath'"

UPDATE 2

as i like it to take from the real path (the one i pass in the request ) on the disc where the self-hosted docker running and not relative to the docker working dir, so now it gives me this error :

[error]Unhandled: Not found SourceFolder: /azp/agent/_work/1/s/{/home/copy_dir}

where /azp is the docker working dir

i configured docker from this link :
https://docs.microsoft.com/en-us/azure/devops/pipelines/agents/docker?view=azure-devops

Azure devops pipeline restAPI How to pass varible with SourceFolder for CopyFiles Task , self hosted agent in container

1 Answers