Validate against resource naming rules declared in swagger

[stan-sz]

There's a documented list of resource naming rules: https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules

Describe the solution you'd like
Bicep could (when possible) warn about breaking the naming rules. Lightly related to #1453

[alex-frankel]

@tfitzmac - do you know how that doc is put together? Is it entirely autogenerated?

[tfitzmac]

@alex-frankel - no, I populated as much as I could with rules from the swagger files, but that was not complete. At this point, it is just maintained manually.

[majastrz]

@alex-frankel I think it'll be beneficial to drive some changes through the swagger ecosystem to make this more consistent E2E. We could get new linters built to require naming rules on resource names to be specified (similar to other changes we're driving for what-if), for example.

[stan-sz]

I just hit the problem of exceeding one of the limits... It would have saved me quite a bit of time if this was caught by Bicep. If this was to be coded in a linter, then that linting rule would have to be by default an error (to prevent from deploying something that would fail anyway).

"error": {
    "code": "VaultNameNotValid",
    "message": "The vault name '...' is invalid. A vault's name must be between 3-24 alphanumeric characters. The name must begin with a letter, end with a letter or digit, and not contain consecutive hyphens. Follow this link for more information: https://go.microsoft.com/fwlink/?linkid=2147742"
  }

[alex-frankel]

Should this be part of the linter? I would think this should be part of the core type definitions. At that point, this would show as a warning because we deem the swagger specs unreliable, but we could expose a build command to treat warnings as errors.

[masters3d]

I think this should be part of bicep. For example I have run into issues when using the region name as part of the resource name and finding out that some regions like australia break the build because the name is too long. Perhaps the linter could also catch these by suggesting folks to use a seeded name based on subid, region, rg

[dazinator]

From the perspective of someone getting started with bicep, being able to see some information as to what the naming rules are, would be my main want - fancier stuff like compile time checks (errors, warnings, suggestions) or auto conpletions that use good practices, etc would be bonus.

[jeskew]

This work was completed in Azure/bicep-types-az#1454 & #9870. Bicep should be warning about resource names that will fail validation when deployed as of version 0.21