Azure / Azure/bicep

Deployment name best practices in bicep

Open
#18,464 2 comments 0 reactions 0 assignees View on GitHub
enhancement story: scopes
Dominant language
Bicep
Stars
3.6k
Forks
830
Avg merge
1d 2h
Merged PRs (30d)
79

Description

When dolng bicep deployments I often run into the problem where my deployment name exceeds 64 characters. What however is not very clear is how good deployment names are made.

Suppose i have the following example deployment:

1.Create Resourcegroup
1.1 Create keyvault
1.2 create RBAC for other resource on keyvault

Usually my deployment names start with something unique so i use -timestamp for the main deployment on the RG, The 'sub' deployment have an own unique name and get a suffix so you can can see what is what.

1 testdeploy-20251114
1.1 testdeploy-20251114-rg
1.2 testdeploy-20251114-keyvault
1.3 testdeploy-20251114-keyvault-rbac

(the numbering is just to indicate what belongs together and that there is a hierachical aspect to a deployment,

This makes it that on each level of the deployment you know what happens for what deployment. Also this example doesnt deploy stuff to different resourcegroups but you get the general idea.

**Describe the solution you'd like**
A clear and concise document which states how to handle deployment names (or a fix for the 64 character deployment name limit). Giving best practices on how to make those names unique BUT still readable and tracable in the azure portal.

OR

Fix the 64 characted limit! Deployment name should be a value that mean something. We are not doing mainframe programming in 1980.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the deployment-name examples and the reported 64-character limit in this issue, then verify the relevant Azure and Bicep deployment naming constraints. Done means providing a clear, readable naming recommendation with uniqueness and hierarchy guidance, or documenting the confirmed limitation and whether a change is feasible; no file or test is named.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure
Domain
cloud, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.