Ability to specify the shape of object parameters and variables

[Va55ago]

Suggestion: When creating bicep modules, could the "shape" of any object parameters be specified. I.e.

param storageAccount object {
  prefix string,
  skuName string = "Standard_LRS",
  example_sub_object = {
    prop1 string,
    prop2 int = 2
  }
}

This would enable bicep to validate the usage of this parameter in the module and will also mean that VS Code can provide intellisense.

[alex-frankel]

It's a good idea, but there is a lot of design work to consider for a feature like this as it can get complex very quickly. We'd love to do it and think it'd be a powerful feature, but not something we will get to quickly.

This is somewhat related, but different from #114

[alex-frankel]

Added to title that this would also be useful for variables.

[aelij]

Adding my suggestion from #1871

Is your feature request related to a problem? Please describe.
Many times when we declare a variable, it represents a part of a larger type's schema. For example:

var agentPoolProfiles = [
  {
    name: 'primary'
    mode: 'System'
    count: nodeCount
    vmSize: vmSize
  }
]

resource aksCluster 'Microsoft.ContainerService/managedClusters@2020-12-01' = {
  name: clusterName
  location: clusterLocation
  properties: {
    agentPoolProfiles: agentPoolProfiles
  }
}

Right now there's no completion or validation for that variable.

Describe the solution you'd like

I would like to be able to specify a schema for a variable, e.g. using the type name from Swagger:

var agentPoolProfiles 'Microsoft.ContainerService/managedClusters@2020-12-01/ManagedClusterAgentPoolProfile[]' = [

[takekazuomi]

Due to the lack of this function, it is difficult to use an object as a parameter. For those who use a template, I'm using the default to suggest a data structure. In that case, allow, secure, etc. cannot be used, which is quite inconvenient.
I'm waiting for this.

[majastrz]

@takekazuomi Why can't you use secure or allowed with a default value on a parameter? Both the decorator and the deprecated modifier syntax should allow it.

[anthony-c-martin]

Example of @allowed with default value:

bicep/docs/examples/101/aci-linuxcontainer-public-ip/main.bicep

Lines 7 to 12 in 9b39718

	@allowed([
	'Always'
	'Never'
	'OnFailure'
	])
	param restartPolicy string = 'Always'

[takekazuomi]

I didn't have enough words. I'm currently using the default to suggest a property of type object.

param foo object = {
  restartPolicy : 'Always'
  boo: 'some value'
}

However, in this case, I cannot use @Allowed or @Scure in default object values. It cannot be written as below.

param foo object = {
  @allowed([
    'Always'
    'Never'
    'OnFailure'
  ])
  restartPolicy : 'Always'
 
@secure
  boo: 'some value'
}

The dedicated syntax for defining the structure of an object is useful.

[miqm]

I think this is related to what was discussed in #622

[Va55ago]

@miqm, #622 is discussing whether it should be possible to define resources without specifying their full resource provider & version. IMHO, that's a separate concern to being able to define the expected structure of custom object parameters and variables.

[miqm]

I agree however if you look at the last comments we were discussing some approach how to define such types. I've just linked those two issues as they touches same mechanism in compiler.

[alex-frankel]

Closing and tracking with #4158