Azure Question posted in
The official documentation to get you started can be found here.

Azure – How to dynamically get the current deployment scope of the current file in Bicep?

I want to create a function that computes a unique string based on the deployment scope’s ID, e.g. subscription or resource group.

Consider the following:

@export()
@description('Get a unique string based on the resource group ID')
func getResourceNameSuffix(length resourceNameSuffixLength) resourceNameSuffix =>
  take(uniqueString(resourceGroup().id), length)

This would only work, if the current file’s deployment scope is a resource group.

I would like to make it generic, so I can also call it from a subscription scope, e.g.:

@export()
@description('Get a unique string based on the resource group ID')
func getResourceNameSuffix(length resourceNameSuffixLength) resourceNameSuffix =>
  take(uniqueString(scope().id), length)

But I can’t find such generic scope() function. Is there a way to get the ID of the current scope dynamically?

Bonus:

Is it possible to throw exceptions in Bicep, so that I could throw an exception from getResourceNameSuffix(), if it was called from a management group scope?

Tags:

2

Answers


  1. 0

    Within the Bicep file, it is not exactly possible to dynamically retrieve the current deployment scope as it is not explicitly defined but later retrieved based on the deployment context.

    Usually, to get to know the current deployment scope of bicep file targetscope has to be the main way. Based on the targetscope parameter value, the deployment scope can be easily known.

    And also, there is a function called scope available in bicep which is used to specify a different deployment scope other than the default or the root deployment. After the deployment, this scope Id value can be known based on the deployment context.

    The other workaround is using deployment() function in bicep which,

    Returns information about the current deployment operation.

    I have created a sample bicep file to deploy a new resource group as shown below. I have used a deployment() function as mentioned and it retrieved all the relevant information of the current deployment.

    targetScope='subscription'

param resourceGroup string = 'xxxx'
param location string = 'WestUs2'

resource newRG 'Microsoft.Resources/resourceGroups@2024-03-01' = {
  name: resourceGroup
  location: location
}
output deployment object = deployment()
output deploymentname string = deployment().name

    enter image description here

    Later, if I click on the $schema template link from the output block, it redirects to the detailed template output as shown below. There also, you can be able to view the current deployment scope.

    enter image description here

    Mentioning all of the above, I would suggest you use scope Id externally to set the deployment scope or refer to the bicep file to know the target scope and proceed further to avoid conflicts.

    Login or Signup to reply.
  2. 0

    You could always pass the scope to your function:

    @export()
@description('Get a unique string based on the specified scope')
func getResourceNameSuffix(scope string, length int) string  =>
  take(uniqueString(scope), length)

    This would work for subscription and resource group. I don’t think there is much you could do for management group scope.

    Login or Signup to reply.
Please signup or login to give your own answer.

Back To Top
Search