Loop dictionary object conditionally

[mc2cloud]

Hi all,

Bit stuck with this one as my condition appears to set both properties to the same value but i cant work out why it is doing this. I am aware there is another approach for additionalLocations but i am using the dictionary objects for other resource types also so is more efficient the have all location information in one object.

I am trying to iterate through an object but omit the value 'primaryLocation':

param parLocationObject object = {
  primaryLocation: {
    location: 'uksouth'
    vnetAddressPrefix: '10.0.0.0/16'
    subnets: [
      {
        name: 'snet-appGateway'
        addressPrefix: '10.0.0.0/24'
        nsgName: 'nsg-appgateway'
      }
      {
        name: 'snet-apim'
        addressPrefix: '10.0.1.0/24'
        nsgName: 'nsg-apim'
      }
    ]
  }
  location2: {
    location: 'ukwest'
    vnetAddressPrefix: '10.1.0.0/16'
    subnets: [
      {
        name: 'snet-appGateway'
        addressPrefix: '10.1.0.0/24'
        nsgName: 'nsg-appgateway'
      }
      {
        name: 'snet-apim'
        addressPrefix: '10.1.1.0/24'
        nsgName: 'nsg-apim'
      }
    ]
  }
}

This is the property code but it still includes the value primaryLocation when run:

additionalLocations: [for locationObject in items(parLocationObject): (locationObject.value == 'primaryLocation') ? {} : {
      location: locationObject.value.location
      publicIpAddressId: resourceId('Microsoft.Network/publicIPAddresses', 'pip-apim-${locationObject.value.location}')
      sku: {
        name: apimSku
        capacity: skuCount
      }
      virtualNetworkConfiguration: any((locationObject.value == '')) ? null : {
        subnetResourceId: resourceId('rg-network-${locationObject.value.location}','Microsoft.Network/virtualNetworks/subnets','vnet-${locationObject.value.location}','${locationObject.value.subnets[1].name}')
      }
      zones: ((length(availabilityZones) == 0) ? null : availabilityZones)}]

Any pointers / ideas would be a great help

[brwilkinson]

I would recommend to just use outputs to evaluate the objects or array data that you have.

e,g,

output info array = items(parLocationObject)

provides

[
    {
        "key": "location2",
        "value": {
            "location": "ukwest",
            "vnetAddressPrefix": "10.1.0.0/16",
            "subnets": [
                {
                    "name": "snet-appGateway",
                    "addressPrefix": "10.1.0.0/24",
                    "nsgName": "nsg-appgateway"
                },
                {
                    "name": "snet-apim",
                    "addressPrefix": "10.1.1.0/24",
                    "nsgName": "nsg-apim"
                }
            ]
        }
    },
    {
        "key": "primaryLocation",
        "value": {
            "location": "uksouth",
            "vnetAddressPrefix": "10.0.0.0/16",
            "subnets": [
                {
                    "name": "snet-appGateway",
                    "addressPrefix": "10.0.0.0/24",
                    "nsgName": "nsg-appgateway"
                },
                {
                    "name": "snet-apim",
                    "addressPrefix": "10.0.1.0/24",
                    "nsgName": "nsg-apim"
                }
            ]
        }
    }
]

Notice the key and value properties.

[mc2cloud]

Thanks Ben,

I was trying to pass it to a module via the main bicep file.

Would using an output still be best practice? I would usually use passing an output from a module.

[brwilkinson]

Hi @balirizaaf

No using the output will help you to debug your issue.

If you view the json data/object that was output, you will see why your original solution is not working.

I would be happy to point it out for you, however I feel like it will be best if you discover it yourself.

[mc2cloud]

Ah I see, thank you. I will review and feedback 👍

[brwilkinson]

@balirizaaf

Sure, feel free to share your latest code, if you are looking for some further guidance.

[mc2cloud]

Thanks @brwilkinson ,

additionalLocations: [for locationObject in items(parLocationObject): (locationObject.key == 'primaryLocation') ? {} : {location: locationObject.value.location
      publicIpAddressId: resourceId('Microsoft.Network/publicIPAddresses', 'pip-apim-${locationObject.value.location}')
      sku: {
        name: apimSku
        capacity: skuCount
      }
      virtualNetworkConfiguration: any((locationObject.value == '')) ? null : {
        subnetResourceId: resourceId('rg-network-${locationObject.value.location}','Microsoft.Network/virtualNetworks/subnets','vnet-${locationObject.value.location}','${locationObject.value.subnets[1].name}')
      }
      zones: ((length(availabilityZones) == 0) ? null : availabilityZones)}]

I can see it is actually still setting a property for the value i want to avoid adding as an additionalLocation from the output:

properties.additionalLocations: [
        0:

          location:                                     "ukwest"
          publicIpAddressId:                            "/subscriptions/subID/resourceGroups/rg-apim-uksouth/providers/Microsoft.Network/publicIPAddresses/pip-apim-ukwest" 
          sku.capacity:                                 1
          sku.name:                                     "Premium"
          virtualNetworkConfiguration.subnetResourceId: "/subscriptions/subID/resourceGroups/rg-network-ukwest/providers/Microsoft.Network/virtualNetworks/vnet-ukwest/subnets/snet-apim"
          zones: [
            0: "1"
          ]

        1: {}

I just want to avoid setting a value for the primaryLocation but it is setting it to 'null'

[brwilkinson]

Yes, this is a common ask and there is a Pull Request in at the moment to add some additional functionality for this based on list manipulation. #7083

One way to get around this at the moment is to simply call a Module.

with a Module or a Resource you can use an if() statement, which compiles to a ARM condition.

By using that it will only process the module for the elements that match the condition. Essentially there is no else here, which is the null value that you are getting at the moment.

here is an example of the if()

https://github.com/brwilkinson/AzureDeploymentFramework/blob/main/ADF/bicep/SA.bicep#L48

notice I still shift the logic to a variable loop, which will be a boolean, so then I just use that result in the if() on the module.

https://github.com/brwilkinson/AzureDeploymentFramework/blob/main/ADF/bicep/SA.bicep#L44

[mc2cloud]

Thanks again @brwilkinson

AdditionalLocations is a property within the module which I need to loop over - not sure how I will handle that at this stage.

I will try and have a think about how I can tackle this tomorrow - getting late over here now. I did look at creating a separate object or array for AdditionalLocations but because locations are used in other areas of the code it became messy.

Thanks again for your help up until this point 👍

[brwilkinson]

If you pass that object into the module, then add the if() when you call the module based on the value of that property.

[mc2cloud]

@brwilkinson had a look at this but the API-M module must be called anyway so i cant use a 'if' statement at the module level.

I need to re-iterate through AdditionalLocations as its a property of the API-M. I tried using if at the property level but it wont let me.

main.bicep (snipped)

param parLocationObject object = {
  primaryLocation: {
    location: 'uksouth'
    vnetAddressPrefix: '10.0.0.0/16'
    subnets: [
      {
        name: 'snet-appGateway'
        addressPrefix: '10.0.0.0/24'
        nsgName: 'nsg-appgateway'
      }
      {
        name: 'snet-apim'
        addressPrefix: '10.0.1.0/24'
        nsgName: 'nsg-apim'
      }
    ]
  }
  location2: {
    location: 'ukwest'
    vnetAddressPrefix: '10.1.0.0/16'
    subnets: [
      {
        name: 'snet-appGateway'
        addressPrefix: '10.1.0.0/24'
        nsgName: 'nsg-appgateway'
      }
      {
        name: 'snet-apim'
        addressPrefix: '10.1.1.0/24'
        nsgName: 'nsg-apim'
      }
    ]
  }
}

module apim 'Resources/apim.bicep' = {
  scope: resourceGroup(varApimRgName)
  name: 'apim'
  dependsOn: [
    apimPip
    network
  ]
  params: {
    location: varPrimaryLocation
    parLocationObject: parLocationObject
    apimPublisherEmail: apimPublisherEmail
    apimPublisherName: apimPublisherName
    apimSku: apimSku
    }
  }

apim.bicep (snipped)

resource apim 'Microsoft.ApiManagement/service@2021-08-01' = {
  name: apiManagementName
  location: location
  sku: {
    name: apimSku
    capacity: skuCount
  }
  zones: ((length(availabilityZones) == 0) ? null : availabilityZones)
  properties: {
    publisherEmail: apimPublisherEmail
    publisherName: apimPublisherName
    virtualNetworkType: 'Internal'
    publicIpAddressId: resourceId('Microsoft.Network/publicIPAddresses', 'pip-apim-${parLocationObject.primaryLocation.location}')
    virtualNetworkConfiguration: {
      subnetResourceId: resourceId(varPrimaryNetworkRg,'Microsoft.Network/virtualNetworks/subnets',varPrimaryVnetName,varApimSubnet)
      // subnetResourceId: resourceId(replace(resourceGroup().name, varApimRgName, varPrimaryNetworkRg), 'Microsoft.Network/virtualNetworks/subnets', '${replace(Deployment, Prefix, extra.prefix)}-vn', varApimSubnet)
    }
    additionalLocations: [for (locationObject, index) in items(parLocationObject): if (additionalLocations[index].match) {location: locationObject.value.location
      publicIpAddressId: resourceId('Microsoft.Network/publicIPAddresses', 'pip-apim-${locationObject.value.location}')
      sku: {
        name: apimSku
        capacity: skuCount
      }
      virtualNetworkConfiguration: any((locationObject.value == '')) ? null : {
        subnetResourceId: resourceId('rg-network-${locationObject.value.location}','Microsoft.Network/virtualNetworks/subnets','vnet-${locationObject.value.location}','${locationObject.value.subnets[1].name}')
      }
      zones: ((length(availabilityZones) == 0) ? null : availabilityZones)}]

Apologies if i am missing what you are suggesting in your work around.

[brwilkinson]

Here is my APIM example. .

https://github.com/brwilkinson/AzureDeploymentFramework/blob/main/ADF/tenants/AOA/AEU1.T4.parameters.json#L464

That is the definition.

Then below I'd the template.

https://github.com/brwilkinson/AzureDeploymentFramework/blob/main/ADF/bicep/APIM-APIM.bicep

[mc2cloud]

@brwilkinson

Thanks again Ben - your APIM config (including the additionalLocations) is nice and neatly defined in its own object. This was an approach i considered but thought it would be easier to put all location details in one object as i can re-use them for other resources i am deploying. Its sounds a lot simpler but Bicep does not make it easy for me to skip one of the object values.

However nasty it is, i may have to define another object for additionalLocations with repeated data for now so i can get this in place. The alternative would be to follow the approach you have put in place for my deployment but this would require re-writing a lot of what i have done.

😞

[brwilkinson]

The PR is in for the Lambda and filter support. #7083

This functionality should be available in the next month or less, I am guessing and maybe sooner.

Once that is in there will be many more options that will open up to filter objects or arrays etc. So I would stay tuned for that.

[mc2cloud]

Look forward to it - thanks for all your help - it makes a big difference.