Pass anything to a bicep template

Question

Pass anything to a bicep template

Hasan Al-Saadi 0

Hi.

I have a problem passing a number to a Bicep template

Bicep template:

// This module patches a setting into an existing Azure App Configuration.

param appConfigName string
param appConfigKey string
param appConfigValue any
param isKeyVaultRef bool

var contentTypeKeyVaultRef = 'application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8'
var contentTypeString = ''

resource AppConfigurationResource 'Microsoft.AppConfiguration/configurationStores@2021-03-01-preview' existing = {
  name: appConfigName
}

resource ConfigStoreKeyValue 'Microsoft.AppConfiguration/configurationStores/keyValues@2021-10-01-preview' = {
  parent: AppConfigurationResource
  name: appConfigKey
  properties: {
    value: isKeyVaultRef ? '{"uri":"${appConfigValue}"}' : appConfigValue
    contentType: isKeyVaultRef ? contentTypeKeyVaultRef : contentTypeString
  }
}

The way I pass the values from a different bicep fil:

This how I am passing the numbers 
module appConfigPatchPlainValues '../../shared/modules/configStorePatch.bicep' = [for pv in plainValues: {
  name: 'deploy-${configStoreName}-${replace(pv.key, ':', '-')}'
  dependsOn: [
    configStoreModule
  ]
  params: {
    appConfigName: configStoreName
    appConfigKey: pv.key
    appConfigValue: pv.value
    isKeyVaultRef: false
  }
}]

According to microsoft "data-type-assignable" we are be able to use "any" datatype

https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/data-types#data-type-assignability

The error I am getting during the deployment

ERROR: /home/vsts/work/1/shared/modules/configStorePatch.bicep(5,22) : Error BCP302: The name "any" is not a valid type. Please specify one of the following types: "array", "bool", "int", "object", "string". [https://aka.ms/bicep/core-diagnostics#BCP302]

Smaran Thoomu 32,615 Reputation points Microsoft External Staff Moderator

2024-11-01T01:32:12.4133333+00:00

@Hasan Al-Saadi Just checking in to see if the below answer provided by @Amira Bedhiafi helped.

If this answers your query, do click Accept Answer and Yes for was this answer helpful. And, if you have any further query do let us know.

1 answer

Your answer

Smaran Thoomu 32,615 Reputation points Microsoft External Staff Moderator

2024-11-01T01:32:12.4133333+00:00

@Hasan Al-Saadi Just checking in to see if the below answer provided by @Amira Bedhiafi helped.

If this answers your query, do click Accept Answer and Yes for was this answer helpful. And, if you have any further query do let us know.

Answer 1

Amira Bedhiafi 41,121 Volunteer Moderator

In Bicep, while any is conceptually supported, it's not directly specified as a valid parameter type. You can work around this by using conditional logic based on the expected input types (like int, string, bool). I updated the template like below :


param appConfigName string

param appConfigKey string

param appConfigValue string  // Change "any" to "string"

param isKeyVaultRef bool

var contentTypeKeyVaultRef = 'application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8'

var contentTypeString = ''

resource AppConfigurationResource 'Microsoft.AppConfiguration/configurationStores@2021-03-01-preview' existing = {

  name: appConfigName

}

resource ConfigStoreKeyValue 'Microsoft.AppConfiguration/configurationStores/keyValues@2021-10-01-preview' = {

  parent: AppConfigurationResource

  name: appConfigKey

  properties: {

    value: isKeyVaultRef ? '{"uri":"${appConfigValue}"}' : appConfigValue

    contentType: isKeyVaultRef ? contentTypeKeyVaultRef : contentTypeString

  }

}

If you’re passing integers or booleans, you can convert them to strings at the calling template level. This way, all values are received as strings in the main template.


module appConfigPatchPlainValues '../../shared/modules/configStorePatch.bicep' = [for pv in plainValues: {

  name: 'deploy-${configStoreName}-${replace(pv.key, ':', '-')}'

  dependsOn: [

    configStoreModule

  ]

  params: {

    appConfigName: configStoreName

    appConfigKey: pv.key

    appConfigValue: string(pv.value)  // Convert all to string

    isKeyVaultRef: false

  }

}]

Hasan Al-Saadi 0 Reputation points

2024-11-04T08:11:48.8766667+00:00

We already do that, actually. I was wondering if there was a way to get rid of this workaround. Wouldn't this workaround bring conversion issues when reading these values?

For instance we should have "string" as datatype in our .NET class instead of having "int"
Hasan Al-Saadi 0 Reputation points

2024-11-04T15:37:31.7466667+00:00

Thanks for your answer @Amira Bedhiafi
Hasan Al-Saadi 0 Reputation points

2024-11-08T08:32:34.4266667+00:00

I would like to reopen this ticket. When I pass an integer as a string to the app-config, it requires me to cast the string back to an integer in my .net application which is not a desired thing. Could you please explain how this situation is handled in your end @Amira Bedhiafi ? @Smaran Thoomu
Smaran Thoomu 32,615 Reputation points Microsoft External Staff Moderator

2024-11-08T10:11:01.7433333+00:00

Hasan Al-Saadi It seems that you are trying to pass a number to a Bicep template, but you are encountering an error. According to Microsoft, while the "any" data type is conceptually supported in Bicep, it's not directly specified as a valid parameter type. However, you can work around this by using conditional logic based on the expected input types (like int, string, bool).

In your case, you can convert integers or booleans to strings at the calling template level. This way, all values are received as strings in the main template. However, this workaround may bring conversion issues when reading these values. For instance, you should have "string" as the data type in your .NET class instead of having "int". When you pass an integer as a string to the app-config, it requires you to cast the string back to an integer in your .NET application, which is not a desired thing.

I hope this helps. Let me know if you have any further questions.
Hasan Al-Saadi 0 Reputation points

2024-11-08T10:26:02.1333333+00:00

Yeah, I will do the undesired thing :D. Thanks for helping @Smaran Thoomu

Share via

Pass anything to a bicep template

1 answer

Your answer