[AVM Module Issue]: DataFactory Private Endpoint issue

[kevin-381ecc2e]

Check for previous/existing GitHub issues

• I have checked for previous/existing GitHub issues

Issue Type?

Bug

Module Name

avm/res/data-factory/factory

(Optional) Module Version

0.6.2'

Description

We're trying to provision DataFactories with Private Endpoints. However we're unable to provision a privateEndpoint with the groupId: 'portal'.
The template has a hardcoded groupId of 'dataFactory' under the privateLink configuration.

https://github.com/Azure/bicep-registry-modules/blob/main/avm/res/data-factory/factory/main.bicep#L328.

I'm receiving the error:

[
PrivateIPAddress: XXX.XXX.XXX.XXX, 
GroupId: portal, 
MemberName: portal
]
 and its missing these membernames/groupids requested by Private Link service [GroupId: dataFactory, MemberName: dataFactory]. Private Endpoint needs to be reconfigured with missing memberNames.

(Optional) Correlation Id

No response

[microsoft-github-policy-service]

Important

The "Needs: Triage 🔍" label must be removed once the triage process is complete!

Tip

For additional guidance on how to triage this issue/PR, see the BRM Issue Triage documentation.

[avm-team-linter]

@kevin-381ecc2e, thanks for submitting this issue for the avm/res/data-factory/factory module!

Important

A member of the @Azure/avm-res-datafactory-factory-module-owners-bicep or @Azure/avm-res-datafactory-factory-module-contributors-bicep team will review it soon!

[clintgrove]

Hi @kevin-381ecc2e please can you explain more about "portal" I am not aware of this type. Also can you share a bit of the code you have implemented to give us a better idea of what the issue is?

[kevin-381ecc2e]

Hi @kevin-381ecc2e please can you explain more about "portal" I am not aware of this type. Also can you share a bit of the code you have implemented to give us a better idea of what the issue is?

Sure, DataFactory consists of two private endpoints one for 'dataFactory' and one for 'portal'. However it seems when i create the portal one. It expects the groupId and memberId to be DataFactory.

    privateEndpoints: [
      {
        service: 'dataFactory'
        subnetResourceId: '/subscriptions/0000000-0000000000-00000/resourceGroups/rg-datafactory/providers/Microsoft.Network/virtualNetworks/vnet-datafactory/subnets/subnet0'
        customNetworkInterfaceName: 'nicDatafactory'
        name: 'peDatafactory'
        ipConfigurations: [
          {
            name: 'ipconfig1'
            properties: {
              groupId: 'dataFactory'
              memberName: 'dataFactory'
              privateIPAddress: '10.10.10.10'
            }
          }
        ]
        privateDnsZoneGroup: {
          privateDnsZoneGroupConfigs: [
            {
              privateDnsZoneResourceId: '/subscriptions/0000000-0000000000-00000/resourceGroups/rg-datafactory/providers/Microsoft.Network/privateDnsZones/privatelink.datafactory.azure.net'
            }
          ]
        }
      }
      {
        subnetResourceId: '/subscriptions/0000000-0000000000-00000/resourceGroups/rg-datafactory/providers/Microsoft.Network/virtualNetworks/vnet-datafactory/subnets/subnet0'
        customNetworkInterfaceName: 'nicPortal'
        name: 'pePortal'
        ipConfigurations: [
          {
            name: 'ipconfig1'
            properties: {
              groupId: 'portal'
              memberName: 'portal'
              privateIPAddress: '10.10.10.11'
            }
          }
        ]
        privateDnsZoneGroup: {
          privateDnsZoneGroupConfigs: [
            {
              privateDnsZoneResourceId: '/subscriptions/0000000-0000000000-00000/resourceGroups/rg-datafactory/providers/Microsoft.Network/privateDnsZones/privatelink.adf.azure.net'
            }
          ]
        }
      }
    ]

from within the Azure portal i have these options.

[krbar]

Hi @kevin-381ecc2e , thanks for the additional info! I believe your code will deploy successfully if you add:

service: 'portal'

as a property of the second private endpoint. If this property is not set, the module defaults to using dataFactory.

Typically, we set a default service only in modules that support a single private endpoint type. In this case, we apparently overlooked the portal sub-resource. To address this, we will release a new module version that does not include a default service.

[kevin-381ecc2e]

Hi @kevin-381ecc2e , thanks for the additional info! I believe your code will deploy successfully if you add:

service: 'portal'
as a property of the second private endpoint. If this property is not set, the module defaults to using dataFactory.

Typically, we set a default service only in modules that support a single private endpoint type. In this case, we apparently overlooked the portal sub-resource. To address this, we will release a new module version that does not include a default service.

Thank you for your reply. It seems that adding 'service: portal' solves the issue.