Azure/bicep

Module `name` property is missing intellisense description and length constraint

asilverman opened this issue · 0 comments

asilverman commented

Bicep version

Name: Bicep
Id: ms-azuretools.vscode-bicep
Description: Bicep language support for Visual Studio Code
Version: 0.30.23
Publisher: Microsoft
VS Marketplace Link: https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-bicep

Describe the bug
The name property in module declarations, doesn’t provide a description and also doesn't provide the constraints on character length. During deployment, however, if the name exceeds 64 characters, the deployment fails with the following error:

Code: InvalidDeployment
Message: The provided deployment name 'Update-PolicyAssignmentId-asilverman-v1_Tenant-Microsoft_ManagementGroup-********-****-****-****-72748dccbe2d' has a length of '109' which exceeds the maximum length of '64'. Please see https://aka.ms/arm-deploy for usage details.

This limitation isn’t clear from the current documentation of the name property in Bicep. It would be incredibly helpful if the name property description could include guidance on the 64-character constraint, as this would prevent deployment-time errors due to overly long names.

See below screenshot of 'hover' on the name property
Image

To Reproduce
Steps to reproduce the behavior:

  • Hover over the name property, you expect some description telling you about the constraint, none exists
  • Create a bicep deployment with a module whose name exceeds 64 characters

Additional Info

Image