您可以将变量组值传递给 yaml 中的子模板吗？

Question

我正在尝试创建一个多阶段管道，其中为管道的每个阶段定义了变量组。目标是将组中的值作为参数传递给子模板。似乎在阶段定义的 Group 的值没有传递到子模板。它用空字符串覆盖“DEFAULTVALUE”。

pipeline.yml

trigger:
- none

pool:
  name: 'Azure Pipelines'
  vmImage: windows-latest

stages:
  - stage: DEV
    variables:
      - group: my-group-dev
    jobs:
      - template: sub-template.yml
        parameters:
          env: 'dev'
          subscriptionName: '$(SubscriptionName)' # This reference from the variable group doesn't get passed in
          subscriptionId: '$(SubscriptionId)'

  - stage: TEST
    variables:
      - group: my-group-test
    jobs:
      - template: sub-template.yml
        parameters:
          env: 'test'
          subscriptionName: '$(SubscriptionName)' # This reference from the variable group doesn't get passed in
          subscriptionId: '$(SubscriptionId)'

sub-template.yml

parameters:
  env: 'DEFAULTVALUE'
  subscriptionName: 'DEFAULTVALUE'
  subscriptionId: 'DEFAULTVALUE'

jobs:
  - deployment: ResourceDeployment
    displayName: Deploy Resources ${{ parameters.env }}
    environment: ${{ parameters.env }}
    strategy:
      runOnce:
        deploy:
          steps:
            - task: AzureFileCopy@4
              displayName: 'Upload ARM Templates'
              inputs:
                sourcePath: '$(Pipeline.Workspace)/templates'
                azureSubscription: '${{ parameters.subscriptionName }}'
                destination: 'azureBlob'
                storage: 'my-storage-account'
                containerName: 'arm'
              name: AzureFileCopy

            - task: AzureResourceManagerTemplateDeployment@3
              inputs:
                deploymentScope: 'Resource Group'
                azureResourceManagerConnection: '${{ parameters.subscriptionName }}'
                subscriptionId: '${{ parameters.subscriptionId }}'
                action: 'Create Or Update Resource Group'
                resourceGroupName: 'my-resource-group'
                location: 'eastus2'
                templateLocation: 'URL of the file'
                csmFileLink: '$(AzureFileCopy.StorageContainerUri)${{ parameters.env }}/templates/main.json$(AzureFileCopy.StorageContainerSasToken)'

我也尝试在子模板中添加变量组，但也无法正确解析...

有谁知道这是否可行？

Answer 1

在阶段级别下定义的变量组中无法引用服务连接端点是一个已知问题。

您可以通过以下解决方法解决此问题：

1、在全局级别而不是阶段级别定义变量组见下图：

trigger:
- none

pool:
  name: 'Azure Pipelines'
  vmImage: windows-latest

# define the variable group under global level.

variables:
- group: my-group-dev
- group: my-group-test


stages:
  - stage: DEV
    jobs:
      - template: sub-template.yml
        parameters:
          env: 'dev'
          subscriptionName: '$(SubscriptionName)' # This reference from the variable group doesn't get passed in
          subscriptionId: '$(SubscriptionId)'

  - stage: TEST
    jobs:
      - template: sub-template.yml
        parameters:
          env: 'test'
          subscriptionName: '$(SubscriptionName)' # This reference from the variable group doesn't get passed in
          subscriptionId: '$(SubscriptionId)'

2、在UI页面链接变量组。

在yaml管道编辑页面-->点击3dots-->Triggers-->Variables Tab-->Link Variables组

请参阅下面的主题以获取更多信息。

Using a variable for the service connection

Azure subscription endpoint ID cannot be provided through a variable in build definition YAML file

Answer 2

您需要将变量组名称传递给模板，并在模板级别将其应用于变量范围，如下所示：

parameters:
  env: 'DEFAULTVALUE'
  subscriptionName: 'DEFAULTVALUE'
  subscriptionId: 'DEFAULTVALUE'
  variableGroupName: 'DEFAULTVALUE`

jobs:
  - deployment: ResourceDeployment
    displayName: Deploy Resources ${{ parameters.env }}
    environment: ${{ parameters.env }}
    variables:
      - group: {{ paramaters.variableGroupName }}
    strategy:
      runOnce:
        deploy:
          steps:
            - task: AzureFileCopy@4
              displayName: 'Upload ARM Templates'
              inputs:
                sourcePath: '$(Pipeline.Workspace)/templates'
                azureSubscription: '${{ parameters.subscriptionName }}'
                destination: 'azureBlob'
                storage: 'my-storage-account'
                containerName: 'arm'
              name: AzureFileCopy

            - task: AzureResourceManagerTemplateDeployment@3
              inputs:
                deploymentScope: 'Resource Group'
                azureResourceManagerConnection: '${{ parameters.subscriptionName }}'
                subscriptionId: '${{ parameters.subscriptionId }}'
                action: 'Create Or Update Resource Group'
                resourceGroupName: 'my-resource-group'
                location: 'eastus2'
                templateLocation: 'URL of the file'
                csmFileLink: '$(AzureFileCopy.StorageContainerUri)${{ parameters.env }}/templates/main.json$(AzureFileCopy.StorageContainerSasToken)'

这类似于this topic:

出于安全原因，我们只允许您通过显式参数将信息传递到模板代码中。 https://docs.microsoft.com/en-us/azure/devops/pipelines/process/templates?view=azure-devops

这意味着使用您的模板的管道的作者需要提交更改，他们将所需的信息明确传递到您的模板代码中。

这有一些例外，变量是在同一个文件中或在管道编译时静态定义的，但一般来说，最好对不涉及系统定义的只读动态变量的所有内容使用参数和自定义的动态输出变量。

我必须变量组

• 质量检查
• 产品

两者都有isProd变量

然后我的模板是

parameters:
  variableGroupName: 'QA'

jobs:
- job: ResourceDeployment
  variables:
  - group: ${{ parameters.variableGroupName }}
  steps:
  - script: echo '$(isProd)'

主文件是

trigger: none
pr: none

stages:
- stage: QA
  jobs:
  - template: sub-template.yml
    parameters:
      variableGroupName: 'QA'

- stage: PROD
  jobs:
  - template: sub-template.yml
    parameters:
      variableGroupName: 'PROD'

我得到了：

和