12

在 Azure DevOps 管道模板中，我将参数声明为数组/序列

parameters:
  mySubscription: ''
  myArray: []

steps:
- AzureCLI@2
  inputs:
    azureSubscription: ${{ parameters.mySubscription }}
    scriptType: pscore
    scriptPath: $(Build.SourcesDirectory)/script.ps1
    arguments: '-MyYAMLArgument ${{ parameters.myArray }}'

然后参数的值从管道定义传递为

steps:
- template: myTemplate.yml
  parameters:
    mySubscription: 'azure-connection'
    myArray:
    - field1: 'a'
      field2: 'b'
    - field1: 'aa'
      field2: 'bb'

我的问题是我无法在 YAML 语法（类型ToString()）中按原样传递该数组，以便能够在我的模板中从 PowerShell 使用和处理该数组。尝试运行此管道时，出现以下错误： /myTemplate.yml (Line: X, Col: X): Unable to convert from Array to String. Value: Array. 错误消息中引用的行/列对应arguments: '-MyYAMLArgument ${{ parameters.myArray }}'于我的模板。

我还尝试将参数映射为我的脚本的环境

- AzureCLI@2
  inputs:
    azureSubscription: ${{ parameters.mySubscription }}
    scriptType: pscore
    scriptPath: $(Build.SourcesDirectory)/script.ps1
    arguments: '-MyYAMLArgument $Env:MY_ENV_VAR'
  env:
    MY_ENV_VAR: ${{ parameters.myArray }}

这也不起作用： /myTemplate.yml (Line: X, Col: Y): A sequence was not expected. 该时间线/列指的是MY_ENV_VAR: ${{ parameters.myArray }}.

有没有人遇到过类似的要求，将管道定义中定义的复杂类型（这里是对象的数组/序列）传递给 PowerShell 脚本？如果是这样，您是如何实现的？

4

5 回答 5

9

您现在可以使用 convertToJsonADO 管道中的函数将这些类型的参数转换为字符串：

parameters:
  - name: myParameter
    type: object
    default:
        name1: value1
        name2: value2

...

- task: Bash@3
  inputs:
    targetType: inline
    script: |
      echo "${{ convertToJson(parameters.myParameter) }}"

参考：https ://developercommunity.visualstudio.com/t/allow-type-casting-or-expression-function-from-yam/880210

convertToJson：https ://docs.microsoft.com/en-us/azure/devops/pipelines/process/expressions?view=azure-devops#converttojson

于 2021-04-06T21:41:13.973 回答
4

我也面临着类似的问题，我的解决方法是使用不同尺寸的不同分隔符将数组展平为字符串。

例如，我想让一些参数成为必需的，如果这些参数没有传递，则构建失败，而不是为每个要检查的参数添加一个任务，我想在单个任务中执行此操作。

为此，我首先将check-required-params.yml一个数组作为参数（传递给另一个模板，该模板称为负责检查参数的任务），其中每个元素都是一个类型的字符串，它是和name:value的连接（使用format表达式）由冒号分隔的必需参数name：value

# templates/pipeline-template.yml
parameters:
- name: endpoint
  type: string
  default: ''
- name: rootDirectory
  type: string
  default: $(Pipeline.Workspace)
- name: remoteDirectory
  type: string
  default: '/'
- name: archiveName
  type: string
  default: ''
    
#other stuff

      - template: check-required-params.yml
        parameters:
          requiredParams:
          - ${{ format('endpoint:{0}', parameters.endpont) }}
          - ${{ format('archiveName:{0}', parameters.archiveName) }}

然后在check-required-params.yml我加入数组中，使用表达式用分号分隔元素${{ join(';', parameters.requiredParams) }}，这将创建一个类型的字符串endpoint:value;archiveName:value并将其作为环境变量传递。

此时，使用一些字符串操作，在脚本中我可以使用分号作为分隔符拆分字符串，这样我将得到一个字符串数组name:value，我可以进一步拆分，但这次使用冒号作为分隔符。我的check-required-params.yml样子：

# templates/check-required-params.yml
parameters:
- name: requiredParams
  type: object
  default: []    
        
steps:
- task: PowerShell@2
  env:
    REQURED_PARAMS: ${{ join(';', parameters.requiredParams) }}
  displayName: Check for required parameters
  inputs:
    targetType: inline
    pwsh: true
    script: |
      $params = $env:REQURED_PARAMS -split ";"
      foreach($param in $params) {
        if ([string]::IsNullOrEmpty($param.Split(":")[1])) {
          Write-Host "##vso[task.logissue type=error;]Missing template parameter $($param.Split(":")[0])"
          Write-Host "##vso[task.complete result=Failed;]"
      }
    }

然后在我的azure-pipelines.yml我可以做：

#other stuff
- template: templates/pipeline-template.yml
  parameters:
    endpoint: 'myEndpoint'
    rootDirectory: $(Pipeline.Workspace)/mycode

在此示例中，构建将失败，因为我没有传递参数archiveName

您可以通过使用变量来定义分隔符而不是在脚本和表达式中硬编码来增加一些灵活性

于 2020-03-25T09:17:24.363 回答
4

基于 @ed-randall 的 convertToJson 思想，结合 ConvertFrom-Json Powershell 函数，我们可以使用 JSON 'contract' 在 yaml 和 PS 脚本之间传递值：

- powershell: |
    $myArray = '${{ convertToJson(parameters.myArray) }}' | ConvertFrom-Json
    ...
于 2021-08-13T14:07:42.987 回答
1

正如@Leo Liu MSFT 在其回答中提到的那样，目前确实不支持此功能，但有人已经为此改进提出了问题。

此问题还包含一个很好的解决方法，现在可以改为使用环境变量。该解决方案的缺点是您需要了解数据结构才能正确映射它。

parameters:
  mylist:[]
  #where mylist is a sequence of object matching the mapping:
  #- name: 'the name 1'
  #  value: 'the value of 1'
  #  index: 0
  #- name: 'the name 2'
  #  value: 'the value of 2'
  #  index: 1

env:
  ${{ each item in parameters.mylist }}:
    ${{ format('SCRIPT_PARAM_{0}_KEY', item.index) }}: ${{ item.name }}
    ${{ format('SCRIPT_PARAM_{0}_VAL', item.index) }}: ${{ item.value }}
于 2020-02-03T15:14:23.003 回答
0

如何将复杂的 DevOps 管道模板参数传递给脚本

恐怕我们无法将复杂的 DevOps 管道模板参数传递给 PowerShell 脚本。

目前，Azure devops 的任务只支持一维数组的传输。它不能接受和传输二维数组。虽然我们可以定义二维数组的参数，但我们需要通过脚本从模板中扩展参数，例如：

- ${{ each field in parameters.myArray}}:

我们可以像这样使用它：

- ${{ each step in parameters.buildSteps }}:
  #- ${{ each pair in step }}:

    - task: PowerShell@2
      inputs:
        targetType : inline
        script: |
          Write-Host 'Hello World'

但是我们不能将二维数组直接传递给这样的任务：[field1: 'a', field2: 'b']. 这就是你得到错误的原因Unable to convert from Array to String。

您可以从模板检查文档扩展以获取更多详细信息。

希望这可以帮助。

于 2020-01-30T13:37:50.087 回答