Unable to output entire resource object?

[jamesongithub]

when you output an entire resource the object seems to change. Was expecting this to work but it does not

Bicep CLI version 0.3.255 (589f037)

// network.bicep
resource vnet 'Microsoft.Network/virtualNetworks@2020-06-01' = {
  name: 'default'
  location: location
  properties: {
    addressSpace: {
      addressPrefixes: [
        '10.0.0.0/8'
      ]
    }
}

output vnet object = vnet

// vnl.bicep
param vnet object

resource vnl 'Microsoft.Network/privateDnsZones/virtualNetworkLinks@2020-06-01' = {
  name: 'vnl'
  location: 'global'
  parent: pdz
  properties: {
    virtualNetwork: {
      id: vnet.id
    }
    registrationEnabled: true
  }
}

deployment

Deployment failed. Correlation ID:  -{
  "status": "Failed",
  "error": {
    "code": "ResourceDeploymentFailure",
    "message": "The resource operation completed with terminal provisioning state 'Failed'.",
    "details": [
      {
        "code": "DeploymentFailed",
        "message": "At least one resource deployment operation failed. Please list deployment operations for details. Please see https://aka.ms/DeployOperations for usage details.",
        "details": [
          {
            "code": "BadRequest",
            "message": "{\r\n  \"error\": {\r\n    \"code\": \"InvalidTemplate\",\r\n    \"message\": \"Unable to process template language expressions for resource '/subscriptions/-/resourceGroups/jy-sap/providers/Microsoft.Network/privateDnsZones/privatelink.file.core.windows.net/virtualNetworkLinks/nfs' at line '1' and column '5908'. 'The language expression property 'id' doesn't exist, available properties are 'apiVersion, location, properties, subscriptionId, resourceGroupName, scope, resourceId, referenceApiVersion, condition, isConditionTrue, isTemplateResource, isAction, provisioningOperation'.'\",\r\n    \"additionalInfo\": [\r\n      {\r\n        \"type\": \"TemplateViolation\",\r\n        \"info\": {\r\n          \"lineNumber\": 1,\r\n          \"linePosition\": 5908,\r\n          \"path\": \"\"\r\n        }\r\n      }\r\n    ]\r\n  }\r\n}"
          }
        ]
      }
    ]
  }
}

trying

    virtualNetwork: {
      id: vnet.resourceId
    }

results in

Deployment failed. Correlation ID: -. {
  "status": "Failed",
  "error": {
    "code": "ResourceDeploymentFailure",
    "message": "The resource operation completed with terminal provisioning state 'Failed'.",
    "details": [
      {
        "code": "DeploymentFailed",
        "message": "At least one resource deployment operation failed. Please list deployment operations for details. Please see https://aka.ms/DeployOperations for usage details.",
        "details": [
          {
            "code": "BadRequest",
            "message": "{\r\n  \"error\": {\r\n    \"code\": \"LinkedInvalidPropertyId\",\r\n    \"message\": \"Property id 'Microsoft.Network/virtualNetworks/default' at path 'properties.virtualNetwork.id' is invalid. Expect fully qualified resource Id that start with '/subscriptions/{subscriptionId}' or '/providers/{resourceProviderNamespace}/'.\"\r\n  }\r\n}"
          }
        ]
      }
    ]
  }

had to resort to outputting pieces of the vnet resource

[brwilkinson]

Hi @jamesongithub,

You would most likely be interested in this proposal.. Which covers what you are asking, as a new feature.

#2246

allow a new parameter (or output) type of resource (allow constraining it to a specific resource type) and pass in a full resource object to reference it within a Module.

Saves you having to use the existing lookup in the Module, just pass in the full resource via the params

[brwilkinson]

@jamesongithub The workaround (or current supported method) is to rehydrate the resource in the destination with 'existing'.

which is still fairly simple:

resource VNET 'Microsoft.Network/virtualNetworks@2020-11-01' existing = {
  name: '${Deployment}-vn'
}

or in your case

param vnet object

resource VNET 'Microsoft.Network/virtualNetworks@2020-11-01' existing = {
  name: vnet.name
}

resource vnl 'Microsoft.Network/privateDnsZones/virtualNetworkLinks@2020-06-01' = {
  name: 'vnl'
  location: 'global'
  parent: pdz
  properties: {
    virtualNetwork: {
      id: VNET.id
    }
    registrationEnabled: true
  }
}

[jamesongithub]

ah ok, presumably you can also output that existing in the source module as well.

[brwilkinson]

Well if you create the resource in the source then you already have the object i.e. vnet. The proposal that I linked will allow you to just pass that to the child Module... however since we don't have that as yet, you need whatever properties in the child module to be able to use the 'existing'. which at a minimum is just the name, however there could be a value for the scope property if it's in a different subscription/resource group etc.

see a comment on scope here: https://github.com/Azure/bicep/blob/main/docs/tutorial/05-loops-conditions-existing.md#existing-keyword

resource VNET 'Microsoft.Network/virtualNetworks@2020-11-01' existing = {
  name: vNetName
  scope: resourceGroup(subscriptionID,resourceGroupName)
}

e.g. peering

https://github.com/brwilkinson/AzureDeploymentFramework/blob/dev/ADF/bicep/VNET-Peering.bicep

[brwilkinson]

Hi @jamesongithub I wanted to check in if you all of the information that you needed on this, if so we can mark it as answered?

[jamesongithub]

yes. thank you.