loadTextContent() - support variable or parameter as input #3816

slavizh · 2021-07-29T09:08:54Z

Is your feature request related to a problem? Please describe.

I would like for loadTextContent() to support variable or parameter as input parameter. What I would like to offer is for the end user to specify text from file or to use the default file available. Currently if I use the below syntax I get error:
The value must be a compile-time constant.bicep(BCP032)

I know that function is being used at compile time so this will probably require some other approach and even changes in template spec for supporting it there as well.

var alertRules = {
  memoryLow: {
    description: empty(bastionHostMonitoring.alertRules.memoryLow.descriptionFilePath) ? loadTextContent('alert-descriptions/memory-low.txt') : loadTextContent(bastionHostMonitoring.alertRules.memoryLow.descriptionFilePath)
  }
}

alex-frankel · 2021-07-29T15:35:21Z

We cannot do this with a param since we won't know the value at compile time. In other words, if you were to run bicep build with a param argument, we'd have no idea which file to "load".

In theory, this should be possible with variables, but my understanding is it requires more of #444 implemented

mblant · 2021-12-16T22:25:11Z

Very interested in this thread.

The ability to load another file inside a var would open a load of options around not hardcoded 10s or 100s are variables to reference existing file to load data

var manifest = json(loadTextContent('./data/manifest.json'))

var itemsArray = [ for item in manifest : {
  data: json(loadTextContent('./data/${item.dataFile}'))
  parameters: json(loadTextContent('./data/${item.parametersFile}'))
}

In theory, this should all be available at compile time as all files are static and nothing is dynamically generated.
The manifest object is be generated. So, the itemsArray should be compiled off manifest as well at compile time. Depending on how the complier interrupts order of operation, right?

alex-frankel · 2021-12-22T18:12:44Z

#3607 seems related to this @mblant, but it is not the same ask

mblant · 2022-01-05T23:30:49Z

I removed the string interpellation and just put the file path in the manifest file and it worked. So, I then assumed it is the interpellation causing the compile time error.

But then, after three or four runs in my test environment, it’s back to the compile time error “The value must be a compile-time constant. bicep(BCP032)”
Not sure what is up in the compiler that it let it run several times (and it actually worked!!) only to go back to throwing the error with no changes?
Happy to get some more data, if someone can give a pointer on where to start.

az bicep version
Bicep CLI version 0.4.1124 (66c84c8)

mblant · 2022-01-06T01:56:49Z

Interesting. No errors if there is only a single element in the manifest.json. Add additional elements and back to failure.

leechan-bicep · 2022-01-17T12:57:36Z

Hi, I have the same error when providing more than one file location getting the "The value must be a compile-time constant." error.Please let us know how to fix this issue

var stringArray = [
'./policies/policy_1.json'
]

var policies = [for i in range(0, length(stringArray)): json(loadTextContent(stringArray[i]))]

alex-frankel · 2022-01-24T03:53:25Z

Repro for triage:

works:

var stringArray = [
  './policies/policy_1.json'
]
  
var policies = [for i in range(0, length(stringArray)): json(loadTextContent(stringArray[i]))]

doesn't work:

var stringArray = [
  './policies/policy_1.json'
  './policies/policy_2.json'
]
  
var policies = [for i in range(0, length(stringArray)): json(loadTextContent(stringArray[i]))]

alex-frankel · 2022-01-26T20:07:34Z

The reason this works is because the type of a single-item string array gets simplified down to a string literal, which the function can handle. It's not something we intentionally designed and in fact we should probably block this scenario. We are going to take a look at validating this better.

alex-frankel · 2022-01-26T20:08:24Z

@miqm will break out this last comment and track the fix with a separate issue

miqm · 2022-01-27T11:35:09Z

Anyway, back to the original proposal - using parameters as arguments for loadTextContent is not possible. Parameters are evaluated during the deployment (runtime), while file loading in loadTextContent is done during compilation (bicep build command). the azure cli does the compilation on the fly before the actual deployment occurs, hence the impression that it could be done.

The only way I can think of to provide this functionality is to introduce a compile-time parameters (similar to C# symbols - https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/preprocessor-directives#conditional-compilation).
AFAIR there are some other issues that refers to introducing similar functionality (i.e. #3109, #1761). It might be worth to think about it. but IMHO it will not be as fast as you would like :)

cpinotossi · 2022-02-07T17:19:02Z

Hello, would be great if we would support this and make it more general. So it will also support similar functions like loadFileAsBase64.
It would give more flexibility when working with modules.

miqm · 2022-02-07T18:17:42Z

Would having function that loads json from file be a solution? Mind, that vars can be runtime values, while load* functions can accept only compile-time values as arguments.

wsucoug69 · 2022-04-01T14:23:21Z

We have the same requirement\need, we are creating role definitions and looking to pass in the json file containing the permissions.

garrettsingletary · 2022-04-01T15:06:38Z

+1 to this. Have the same need for populating permissions from json.

charotAmine · 2022-05-10T12:52:20Z

Hello @leechan-bicep , @alex-frankel

A workaround for this :

Hi, I have the same error when providing more than one file location getting the "The value must be a compile-time constant." error.Please let us know how to fix this issue

var stringArray = [ './policies/policy_1.json' ]

var policies = [for i in range(0, length(stringArray)): json(loadTextContent(stringArray[i]))]

May be :
var stringArray = [
loadTextContent('./policy-1.json')
loadTextContent('./policy-2.json')
loadTextContent('./policy-3.json')
]

var policies = [for i in range(0, length(stringArray)): json(stringArray[i])]
Since in anyways, we should put a constant path.

SeSeicht · 2022-06-01T17:33:09Z

hey, I tried @charotAmine code, but it didn't worked for me. But I created a similar way to solve this:
@alex-frankel goes in the same direction like your code snippet

var stringArray = [
  json(loadTextContent('./file1.json'))
  json(loadTextContent('./file2json'))
  json(loadTextContent('./file3.json'))
  ]

module m_pol_def 'br/modules:microsoft.authorization.policydefinitions:1.0' = [for onePol in stringArray: { 
  name: onePol.name
    params: {...}
}]

calebherbison · 2022-06-20T04:28:20Z

+1 for using this to load local files for openapi specs

krowlandson · 2022-07-21T09:00:24Z

@alex-frankel

I have a similar situation which appears to be a cross between this issue and #3607.

In my case, I am looking to load multiple "resource configuration" files. These files may vary from deployment to deployment but will be re-usable. Depending on the specific scenario, I would like to point my Bicep configuration at a single JSON file containing a list of required "resource configuration" files, and then loop over that to load in the "resource configuration" files.

I will always know the location of the first file, and the point of this is to abstract the list of other sources from the template to simplify code maintenance and D.R.Y.

Take an example such as the following:

`configLocations.Scenario1.json` example

[
    "config/resource1settings.json",
    "config/resource2settings.json",
    "config/resource3settings.json",
    "config/resource4settings.json",
    "config/resource5settings.json",
    "config/resource6settings.json"
]

`config/resource1settings.json` example

{
  "setting1": "value",
  "setting2": 100,
  "setting3": true,
  "setting4": []
}

`sample.bicep` example

// The following var is used to load the list of resource configs to import
var listResourceConfigs = loadJsonContent('configLocations.Scenario1.json')

// The following var is used to load the resource configs
var resourceConfigs = [for config in listResourceConfigs: loadJsonContent(config)]

This results in the error The value must be a compile-time constant.bicep(BCP032):

As such, it would be really useful to have a way to do the following for compile-time operations:

Declare constants (only visible in Bicep, maybe using a decorator format such as @constant(key='value'))
Support for loops (again, possibly using a different format to declare the loops so they are explicitly identified as used at compile-time)

In my scenario, explicitly declaring the list of "resource configuration" files into the bicep file as proposed in the above "work-arounds" would defeat the point of this abstraction.

Thank you

akhilthomas011 · 2023-01-05T15:34:04Z

@alex-frankel +1. This is a frequent use case for us.

Kaloszer · 2023-01-18T11:44:54Z

+1

sofia-valles · 2023-01-23T10:55:16Z

+1

Gabriel123N · 2023-03-08T09:38:39Z

+1

tuomaskujala · 2023-03-14T10:21:48Z

+1

asos-gurpreetsingh · 2023-03-14T16:56:40Z

+100 from my company

brwilkinson · 2023-03-21T18:59:21Z

Adding comment for support.

Currently a custom PowerShell deployment Script is required to pass in metadata for deployment.
- I would like to remove the requirement for this custom deploy script.

I currently pull in 3 files with Global or Regional metadata.

Global metadata
Regional metadata
Custom role definition lookups

E.g. For 3, exported lists for role assignments for a specific subscription, to do friendly name lookups for role assignments. This is required because different custom role assignments are available in different subscriptions.

    # Read in the Rolegroups Lookup.
    $RolesGroupsLookup = Get-Content -Path $Artifacts/tenants/$App/Global-Config.json | ConvertFrom-Json -Depth 10 | ForEach-Object RolesGroupsLookup
    $Global.Add('RolesGroupsLookup', ($RolesGroupsLookup | ConvertTo-Json -Compress -Depth 10))

I would like to move this into the Bicep template file itself.

param App string = 'LAB'
var computeGlobal = json(loadTextContent('../tenants/${App}/Global-Config.json'))

Since the project can deploy to multiple subscriptions, I need to pass in the App to differentiate which Role lookup file to use,

The value must be a compile-time constant.

Since this is unsupported, I still depend on the custom deployment PowerShell script.

The deployment script that I currently use for ALL deployments.

https://github.com/brwilkinson/AzureDeploymentFramework/blob/main/ADF/release-az/Start-AzDeploy.psm1#L66

Examples of the metadata files that I have-to pass in at runtime (per tenant/App) in the above script.

UmairSyed · 2023-04-27T00:39:54Z

+1 please

Kielar-Peter · 2023-04-27T07:55:24Z

+1

AshutoshNirkhe · 2023-06-02T11:41:19Z

This will be really a value addition!

jamesSampica · 2023-06-07T18:57:00Z

This is something Terraform supports so Bicep should too. It is not possible to download and deploy a certificate resource unless the path is known at deploy time. Only workaround is using a keyvault instead.

Terraform:

resource "azurerm_app_service_certificate" "webapp_certificate" {
    ...
    pfx_blob = filebase64(var.certificate_path) // Works
}

Bicep:

resource certificate 'Microsoft.Web/certificates@2022-09-01' = {
    ...
    properties: {
        pfx_blob: loadFileAsBase64(certificate_path) // Compile error
    }
}

brwilkinson · 2023-06-07T19:01:45Z

An additional comment on this... If you test out bicepparam you can create a parameter that uses loadtextcontent() or other loadX() to read the file. By having this in the parameter file instead of the template, you get some degree in flexibility to read different files based on the parameter file you are using.

jamesSampica · 2023-06-08T13:20:03Z

Good to know. I dont think a parameter file will work in my case because I want to download a secure file from Azure DevOps and read the contents in.

brwilkinson · 2023-06-08T21:29:56Z

@jamesSampica

Bicep functions are supported in bicepparam.

https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/bicep-functions-string#base64tostring

https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/bicep-functions-files#loadfileasbase64

brwilkinson · 2023-06-21T01:45:32Z

Still exploring bicepparam

I like that you can reference other parameters in bicepparam file. E.g. Prefix below.

using '../../bicep/00-ALL-SUB.bicep'

param Global = union(
  loadJsonContent('Global-${Prefix}.json'), // Can reference this file based on the region I am in... clone the file, update the Prefix
  loadJsonContent('Global-Global.json'),
  loadJsonContent('Global-Config.json')
  )

param Prefix = 'AWU3'
param Environment = 'P'
param DeploymentID = '0'

I haven't completed testing all scenarios, however I believe this covers my needs from my previous comment in this thread, where I achieved the above union with PowerShell custom code.

loadTextContent() - support variable or parameter as input #3816 (comment)

sohirani · 2023-06-28T02:59:04Z

+1

gscorrea · 2023-07-08T21:49:41Z

+1
I am in the middle of defining variables that need to ready yaml/json/text contents from files to build AOSM NFDV for a bicep publisher file.
The thing is that besides these variables the bicep publisher is common to several of my NFs to be published, so I do not want to have to make copies of same files several times to build the NFDV for my NFs, but I want to use params/variables to build the load(Yaml/Json/Text)Content filePath and use same bicep to publish my NFs NFDVs.
Commented out below is how I tried to implement with params on the filePath and did not work, but this is needed.
I understand that at this time the bicep build process happens before the params are read, but I have a need to have the params available at bicep build time.

param aksClusterGroup string
param aksClusterName string
param aosmParametersLocation string
param aosmSchemaLocation string
param aosmSetSetFilesParametersLocation string
param artifactManifestName string
param artifactStore string
param cgsName string
param cgvName string
param cnfName string
param helmPackageName string
param helmPackageVersion string
param helmReleaseName string
param location string = resourceGroup().location
param nfdgroupName string
param nfdvNfName string
param nfdversion string
param nsdGroup string
param nsdvName string
param publisherName string
param releaseNamespace string
param resourceExists bool = false
param siteName string
param snsName string
param valuesLocation string
param valuesParam object
param yamlLocation string
//********************************************
//LOADING ALL VALUES ON allTogether
//********************************************
//var mval = loadYamlContent(valuesLocation'/'cnfName'-values.yaml') //parameters passed to helm chart
//var svals = loadJsonContent(aosmSetSetFilesParametersLocation'/'cnfName'_nf_deployment_set_parameters.json') //file with --set parameters for helm
var mval = loadYamlContent('../values.final/my_cnf-values.yaml') //parameters passed to helm chart
var svals = loadJsonContent('../aosmSetSetFilesParameters.final/my_cnf_nf_deployment_set_parameters.json') //file with --set parameters for helm
var allTogether= union(mval, svals) //joining parameters. change order of list to use correct precedence.

Afsalmc · 2023-07-18T02:41:57Z

I am facing the same issue while loading a script for deploymentscript bicep module.

obriankevin11 · 2023-10-15T10:44:09Z

same here

lesca · 2023-11-07T07:18:43Z

+1

phrueegsegger · 2023-11-28T15:06:52Z

+1

hybridtechie · 2024-03-09T12:21:56Z

+1

Saulopv · 2024-03-26T14:29:29Z

+1

SvenRelijveld1995 · 2024-04-04T14:49:53Z

+1

dewolfs · 2024-04-05T08:10:26Z

Running into the error

Error BCP032: The value must be a compile-time constant.

when trying to import an API into Azure API Management based on the OpenAPI specification.
Our API is private so we need to use format openapi+json.

openapi+json: The contents are inline and Content Type is a OpenAPI 3.0 JSON Document.
openapi-link: The OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.

Ref: https://learn.microsoft.com/en-us/javascript/api/@azure/arm-apimanagement/contentformat?view=azure-node-latest

param openApiSpecJSON string

resource apis 'Microsoft.ApiManagement/service/apis@2022-08-01' = {
    ...
    description: api.apiDescription
    format: 'openapi+json'
    value: loadTextContent('${openApiSpecJSON}')
  }
}

nayanshah · 2024-04-24T07:19:04Z

Repro for triage:

works:

var stringArray = [
  './policies/policy_1.json'
]
  
var policies = [for i in range(0, length(stringArray)): json(loadTextContent(stringArray[i]))]

doesn't work:

var stringArray = [
  './policies/policy_1.json'
  './policies/policy_2.json'
]
  
var policies = [for i in range(0, length(stringArray)): json(loadTextContent(stringArray[i]))]

The currently supported way for making this work involves duplicating loadTextContent calls which gets annoying if additional logic is needed like in #10112. This violates Goal-4 i.e. "Code re-use should not require any 'copy/paste'-ing".

P.S: my workaround for this issue is generating a .bicep file before compilation which isn't ideal but gets the job done - Example: https://gist.github.com/nayanshah/7c86cfe6c9882c9e8133cee6ce17c9bb

woeterman94 · 2024-06-25T12:20:27Z

Any update on this?
I'd love to be able to do:
value: loadTextContent('policies/${environmentName}.xml')

slavizh added the enhancement New feature or request label Jul 29, 2021

ghost added the Needs: Triage 🔍 label Jul 29, 2021

majastrz added awaiting response and removed Needs: Triage 🔍 labels Jul 29, 2021

alex-frankel added the Needs: Triage 🔍 label Jan 24, 2022

alex-frankel removed the awaiting response label Jan 24, 2022

alex-frankel assigned miqm Jan 26, 2022

alex-frankel removed the Needs: Triage 🔍 label Jan 26, 2022

alex-frankel added this to the Committed Backlog milestone Jan 26, 2022

alex-frankel unassigned miqm Jan 26, 2022

miqm mentioned this issue Jan 27, 2022

LoadTextContent should take only compile-time constants as parameters #5766

Open

miqm added the Needs: Upvote This issue requires more votes to be considered label Jan 27, 2022

brwilkinson mentioned this issue Apr 28, 2023

Add support for environment variable values #9576

Closed

stephaniezyen mentioned this issue Oct 18, 2023

Allow String Interpolation for folder paths #12031

Closed

alex-frankel mentioned this issue Oct 18, 2023

add support for load file with variable/parameter replacement #10112

Open

loadTextContent() - support variable or parameter as input #3816

loadTextContent() - support variable or parameter as input #3816

Comments

slavizh commented Jul 29, 2021

alex-frankel commented Jul 29, 2021

mblant commented Dec 16, 2021 • edited by alex-frankel Loading

alex-frankel commented Dec 22, 2021

mblant commented Jan 5, 2022

mblant commented Jan 6, 2022

leechan-bicep commented Jan 17, 2022

alex-frankel commented Jan 24, 2022

alex-frankel commented Jan 26, 2022

alex-frankel commented Jan 26, 2022

miqm commented Jan 27, 2022

cpinotossi commented Feb 7, 2022

miqm commented Feb 7, 2022

wsucoug69 commented Apr 1, 2022

garrettsingletary commented Apr 1, 2022

charotAmine commented May 10, 2022 • edited Loading

SeSeicht commented Jun 1, 2022 • edited Loading

calebherbison commented Jun 20, 2022

krowlandson commented Jul 21, 2022

configLocations.Scenario1.json example

config/resource1settings.json example

sample.bicep example

akhilthomas011 commented Jan 5, 2023

Kaloszer commented Jan 18, 2023

sofia-valles commented Jan 23, 2023

Gabriel123N commented Mar 8, 2023

tuomaskujala commented Mar 14, 2023

asos-gurpreetsingh commented Mar 14, 2023

brwilkinson commented Mar 21, 2023

Adding comment for support.

UmairSyed commented Apr 27, 2023

Kielar-Peter commented Apr 27, 2023

AshutoshNirkhe commented Jun 2, 2023

jamesSampica commented Jun 7, 2023 • edited Loading

brwilkinson commented Jun 7, 2023

jamesSampica commented Jun 8, 2023

brwilkinson commented Jun 8, 2023

brwilkinson commented Jun 21, 2023 • edited Loading

sohirani commented Jun 28, 2023

gscorrea commented Jul 8, 2023 • edited by anthony-c-martin Loading

Afsalmc commented Jul 18, 2023

obriankevin11 commented Oct 15, 2023

lesca commented Nov 7, 2023

phrueegsegger commented Nov 28, 2023

hybridtechie commented Mar 9, 2024

Saulopv commented Mar 26, 2024

SvenRelijveld1995 commented Apr 4, 2024

dewolfs commented Apr 5, 2024

nayanshah commented Apr 24, 2024 • edited Loading

woeterman94 commented Jun 25, 2024

mblant commented Dec 16, 2021 •

edited by alex-frankel

Loading

charotAmine commented May 10, 2022 •

edited

Loading

SeSeicht commented Jun 1, 2022 •

edited

Loading

`configLocations.Scenario1.json` example

`config/resource1settings.json` example

`sample.bicep` example

jamesSampica commented Jun 7, 2023 •

edited

Loading

brwilkinson commented Jun 21, 2023 •

edited

Loading

gscorrea commented Jul 8, 2023 •

edited by anthony-c-martin

Loading

nayanshah commented Apr 24, 2024 •

edited

Loading