Override parameter with a space in the parameter name

Question

In an Azure Resource Group Deployment task, can I override a parameter that has a space in its name?

I followed this guide to create an Azure resource group deployment project. In that project I'm able to create parameters with spaces in the name and successfully deploy it via Visual Studio.

azuredeploy.json

{
  "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "My easy to read parameter": {
      "type": "string",
      "defaultValue": "hello world"
    }
  },
  "resources": [
    {
      "name": "[parameters('My easy to read parameter')]",
      "type": "Microsoft.Storage/storageAccounts",
      "location": "[resourceGroup().location]",
      "apiVersion": "2016-01-01",
      "sku": {
        "name": "[parameters('StorageType')]"
      },
      "dependsOn": [],
      "tags": {
        "displayName": "MyTag"
      },
      "kind": "Storage"
    }
  ]
}

It appears I can override parameters using this: overrideParameters: '-myNotSoEasyToReadParameter integration-webfarm' source.

How do I do that on a parameter w/ spaces?

overrideParameters: '-My easy to read parameter integration-webfarm'

Can you share the log of the Azure Resource Group Deployment task?So I can judge which parameters are used in the API according your service .The parameters set in override template parameters need to be used in the API. If they are not used, it is meaningless to override them. — Hugh Lin
– Hugh Lin, Commented Oct 31, 2019 at 11:12
Hi @HughLin-MSFT - thanks for the reply. I haven't tried running it as I know I don't have the correct syntax. I am confident I'm using the parameter. I've updated my question. — spottedmahn
– spottedmahn, Commented Oct 31, 2019 at 18:58

Mengdi Liang · Accepted Answer · 2019-11-06 14:01:51Z

4

The answer is Yes and No.

The Yes means this special parameter name My easy to read parameter can be override. And No means the approach you are using is not correct.

Firstly, hello world is a invalid value. Since what you defined it is a Microsoft.Storage/storageAccounts type, it does not allow you to use the characters other than lowercase letters and numbers, including spaces.

To achieve overriding the parameter name My easy to read parameter, you can not directly override it in the task configuration:

The name with spaces could not be recognized by the task. Because of the spaces, this task could not treat this special name as one completed string and will try to parse it. Then you would received the error like follow show:

Even not work by using double quotes around it.

The correct and succeed overriding method is using Override Parameter json file.

Create a new parameter json file, then specified the parameter name and value which you want to be override.

For example:

(1). This is my template json file which parameter name is My easy to read parameter and value is merlinliang:

(2). Now, create a another parameter json file. Specified a new value merlinoverride in it:

(3). In ARM deploy task configuration, configure like this:

You can see the name was override successfully:

edited Nov 6, 2019 at 14:01

answered Nov 6, 2019 at 13:49

Mengdi Liang

19.3k2 gold badges35 silver badges43 bronze badges

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

2 Comments

spottedmahn Over a year ago

I guess I couldn’t pass parameters from my pipeline down then 😢 if the only option is a params file

Mengdi Liang Over a year ago

@spottedmahn. Any limitation? Because only there 2 method can override the parameter in this task. One is directly specify in the input box under Override template parameters by using -{name} {new value}. And another one is using parameter file.

Collectives™ on Stack Overflow

Override parameter with a space in the parameter name

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related