VSCode Extension – `required-properties` doesn't add all required properties

[SetTrend]

Bicep version

Bicep CLI version 0.8.9 (33a85174de)

Describe the bug

After adding a resource and selecting the required-properties drop-down item, only the name property was added. There required scope property, however, was not added.

To Reproduce

Add a resource, similar to this:

resource kv 'Microsoft.KeyVault/vaults@2021-10-01' existing =

The result is: Only the name property will be added:

resource kv 'Microsoft.KeyVault/vaults@2021-10-01' existing = {
  name: ''
}

[alex-frankel]

scope is not required for an existing resource if it exists in the same scope as your current deployment.

[SetTrend]

That's strange …

When I run this test Bicep file:

resource kv 'Microsoft.KeyVault/vaults@2021-10-01' existing = {
  name: 'PATs'
}

output o object = kv

… I get the following error message when running it with Azure PowerShell:

I need to supply the resource group for the Bicep file to succeed:

resource kv 'Microsoft.KeyVault/vaults@2021-10-01' existing = {
  name: 'PATs'
  scope: resourceGroup('myRG')
}

[alex-frankel]

Ah, this is because you should be using New-AzResourceGroupDeployment instead of New-AzDeployment. We have it on our list to validate that you are using the right command in powershell, but haven't been able to prioritize it. We check this in CLI and have not ported the logic over.

[SetTrend]

Excellent! Thanks for enlightening me!

I don't want to bother you unduly, but would you mind helping me with another question I have about a common use case scenario:

The use case to accomplish is to create a new resource group and add resources to that new resource group.

This way, a resource group could easily be deleted and a new resource group, along with all its resource, could easily be established on any system.

This is the workflow I'm aiming at:

I'm not able to use the resource group created by the module, because resources in the main Bicep file don't provide a scope property.

What is your team's suggested approach for this kind of (common) scenario?

I asked my question on StackOverflow but didn't get satisfying answers yet.

Perhaps you would want to point out a valid implementation suggestion to me?

[alex-frankel]

Just FWIW, it's good to ask questions like this in the "Discussions" section of the repo, but happy to answer it here.

I think the order in your diagram is off. Typically, you will start the deployment at subscription scope, create the RG, then use that RG as the scope for a module deployment to that RG. Here is an example of that pattern:
https://github.com/jongio/memealyzer/blob/main/iac/main.bicep

Notice on L24, Jon is using the new RG as the scope for the module: https://github.com/jongio/memealyzer/blob/main/iac/main.bicep#L24

[SetTrend]

Thanks a lot again, @alex-frankel!

I didn't recognize there was a "Discussion" tab above. Please pardon me for that,