How to check if array contains string with Azure DevOps pipeline expressions

Question

I have the following pipeline template that I want to use to conditionally execute stages based on the input parameter stages.

parameters:
- name: dryRun
  default: false
  type: boolean
- name: path
  type: string
  default: terraform
- name: stages
  type: object
  default:
  - test
  - prod

stages:
  - stage:
    pool: 
      vmImage: 'ubuntu-latest'
    displayName: "Deploy to test"
    condition: in('test', ${{ parameters.stages }})
    jobs:
    - template: terraform-job.yaml
      parameters:
        stage: test
        path: ${{ parameters.path }}
        dryRun: ${{ parameters.dryRun }}
  - stage:
    pool: 
      vmImage: 'ubuntu-latest'
    displayName: "Deploy to production"
    condition: in('prod', '${{ join(', ', parameters.stages) }}')
    jobs:
    - template: terraform-job.yaml
      parameters:
        stage: production
        path: ${{ parameters.path }}
        dryRun: ${{ parameters.dryRun }}

In the example you can see two of the approached I tried (I tried a lot...). The last one (in('prod', '${{ join(', ', parameters.stages) }}')) actually compiles but then the check only works partially as the array gets converted into a single string: 'test,prod' which will fail the in('test', 'test,prod') check.

And the first example (in('test', ${{ parameters.stages }})) is the one I think should work with logical thinking but I get the following error when compiling the template: /terraform-deployment.yml (Line: 19, Col: 16): Unable to convert from Array to String. Value: Array.

So now the question:

How do I check if a string is part of an array that was defined as a parameter?

patriml · Accepted Answer · 2022-02-07 20:48:06Z

13

2022 update

You can now use containsValue:

condition: ${{ containsValue(parameters.stages, 'test') }}

answered Feb 7, 2022 at 20:48

patriml

5874 silver badges9 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Robert Over a year ago

beware containsValue is case-insensitive

Cece Dong - MSFT · Accepted Answer · 2020-08-18 09:30:37Z

6

Try contains instead:

condition: contains('${{ join(';',parameters.stages) }}', 'test')

answered Aug 18, 2020 at 9:30

Cece Dong - MSFT

31.3k1 gold badge35 silver badges46 bronze badges

Collectives™ on Stack Overflow

How to check if array contains string with Azure DevOps pipeline expressions

How do I check if a string is part of an array that was defined as a parameter?

2 Answers 2

2022 update

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

How do I check if a string is part of an array that was defined as a parameter?

2 Answers 2

2022 update

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related