How to use the Json Variables in Azure DevOps YAML Pipeline?

Question

How to use the Json Variables in Azure DevOps YAML Pipeline?

Shekhar Khadka 5

I want to deploy the azure resources(ADF) and while deploying I need to override some DEV ARM template parameters and one of the parameters to deploy is of JSON OBJECT which I store its value in the pipeline Variable Group as below,

User's image

Actually the value looks like this {"minutes":[00],"hours":[5],"weekDays":["Monday","Tuesday","Wednesday","Thursday","Friday"]}

Since in azure DevOps pipeline, every Variable value that we fetch will be treated as a string type but my parameter for the ARM template need the value of Json type.

- task: AzurePowerShell@5
      displayName: Deploy ADF
      inputs:
        azureSubscription: '$(azureSubscription)'
        ScriptType: 'InlineScript'
        Inline: 

          New-AzResourceGroupDeployment `
             -ResourceGroupName "$(DeploymentResourceGroupName)" `
             -TemplateParameterFile "$(System.DefaultWorkingDirectory)/$(SourceDataFactoryName)/ARMTemplateParametersForFactory.json" `
             -TemplateFile "$(System.DefaultWorkingDirectory)/$(SourceDataFactoryName)/ARMTemplateForFactory.json" `
             -factoryName "$(DeployDataFactoryName)" `
             -LocalTesting_properties_typeProperties_recurrence_schedule $Trigger_Schedule `
             #

1 answer

Your answer

Answer 1

Vahid Ghafarpour 23,385 Volunteer Moderator

You can pass JSON object as a string to the pipeline just need to replace " with "

For example this YAML file:

steps:
- task: AzureResourceManagerTemplateDeployment@3
  inputs:
    deploymentScope: 'Resource Group'  # Change this to 'Subscription' if needed
    azureResourceManagerConnection: 'YourAzureServiceConnection'  # Replace with your service connection name
    subscriptionId: 'YourSubscriptionId'
    action: 'Create Or Update Resource Group'
    resourceGroupName: 'YourResourceGroupName'
    location: 'YourResourceGroupLocation'
    templateLocation: 'Linked artifact'
    csmFile: 'path/to/your/template.json'  # Path to your ARM template file
    csmParametersFile: 'path/to/your/parameters.json'  # Path to a JSON file containing parameters (if needed)
    overrideParameters: '-MyJsonObjectParameter "{\"minutes\":[00],\"hours\":[5],\"weekDays\":[\"Monday\",\"Tuesday\",\"Wednesday\",\"Thursday\",\"Friday\"]}"'

Shekhar Khadka 5 Reputation points

2023-08-01T03:34:53.7633333+00:00

@Vahid Ghafarpour I don't want to hard code the value in the YAML script, so instead I want to fetch it from the variable group because I want to use the same script for the PROD deployment as well so want to make the code more dynamic as possible
Hitesh N 40 Reputation points

2025-05-30T03:29:35.2133333+00:00
@Shekhar Khadka Even I had Issue of how to Pass JSON File Arguments to PowerShell File and how to set the JSON File Configuration in YAML file in Azure Devops Pipeline.

How to Pass Arguments of the variables (storageAccountName,location,storageSKU) From the JSON File to the to powershell File , and how to set the JSON File Configuration in YAML file to fetch the json file object in the Azure Devops Pipeline.

Below Example of the JSON , PowerShell and YAML files.

JSON File - test.json

{

storageAccountName = "xxxstoragetest123" location = useast2 storageSKU = "xyz"

}

PowerShell File - test.ps1

$Parameters = @{

storageAccountName = "value from-json-file"

location = "value from-json-file" storageSKU = "value from-json-file"

}

YAML File- test.yaml

trigger:

master

pool:

vmImage: ubuntu-latest

steps:

task: AzurePowerShell@5 inputs: azureSubscription: 'xxxx' ScriptType: 'FilePath' ScriptPath: 'test.ps1' #scriptArguments:
-Arg1 Hello `

-Arg2 World
azurePowerShellVersion: LatestVersion pwsh: true

Share via

How to use the Json Variables in Azure DevOps YAML Pipeline?

1 answer

-Arg1 Hello `

-Arg2 World

Your answer