Azure / Azure/bicep

Configure deployment scopes using configuration files in VS Code deployment pane

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

Description

**Is your feature request related to a problem? Please describe.**
The deployment pane is a fast and convenient way to deploy a Bicep file. However, it can be challenging to find the correct scope to deploy a file to. We have a large repository with many Bicep-files that are deployed to any of a large number of resource groups, subscriptions, or management groups.

**Describe the solution you'd like**
I would like to configure the deployment scope for a given Bicep-file using a separate configuration file. This would allow new users of the file to get the correct scope without any further research. This file would be checked in to the repository together with the Bicep files.

An example of what this could look like:

```shell
$ tree .
.
├── bicep-deployment-pane.json
├── main.bicep
└── other.bicep
```

```jsonc
// bicep-deployment-pane.json
{
"main.bicep": {
// resource-group scoped deployments only require a scope
"scope": "/subscriptions//resourceGroups/"
},
"other.bicep": {
// subscription scoped deployments require a location too
"scope": "/subscriptions/",
"location": "swedencentral"
}
}
```

FYI:
I did a small investigation if there was a way to configure this using the VS Code configuration files, but have not been able to find any way. It seems like extension stores its state in the VS Code extension context.

Contributor guide

Open the contributing guide

Research direction

Start by locating the VS Code deployment pane implementation and the extension context where deployment state is stored. Use the proposed bicep-deployment-pane.json alongside main.bicep and other.bicep as the behavioral example; done means repository configuration can supply the correct scope and location for each file.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, vscode
Domain
cloud, devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.