Add ArmPrivateDnsZoneVirtualNetworkLink

Add-ArmPrivateDnsZoneVirtualNetworkLink creates a new private DNS zone virtual network link. A private DNS zone (New-ArmPrivateDnsZone) and a virtual network (New-ArmVirtualNetworkResource) are required to use this function. The private DNS zone object will be returned by this function.

Examples

# 1. Simple (required parameters)
    
    $VirtualNetwork = New-ArmResourceName -ResourceType Microsoft.Network/virtualNetworks `
    | New-ArmVirtualNetworkResource

    # a) Pipeline input (private DNS zone only)
    "contoso.com" | New-ArmPrivateDnsZone `
    | Add-ArmPrivateDnsZoneVirtualNetworkLink -VirtualNetwork $VirtualNetwork

    # b) Explicit specification of parameter name/argument
    $PrivateDnsZone = New-ArmPrivateDnsZone -Name "contoso.com"

    Add-ArmPrivateDnsZoneVirtualNetworkLink `
        -PrivateDnsZone $PrivateDnsZone `
        -VirtualNetwork $VirtualNetwork

    # result:
    {    
        _ResourceId : "[resourceId('Microsoft.Network/privateDnsZones/virtualNetworkLinks','contoso.com')]"
        PSTypeName  : "PDNSZVirtualNetworkLink"
        type        : "Microsoft.Network/privateDnsZones/virtualNetworkLinks"
        name        : "[concat('contoso.com/', [concat('-vnet-', uniquestring('vnet','vnet'),'')])]"
        apiVersion  : "2018-09-01"
        location    : "global"
        properties  : {
            virtualNetwork      : {
                id : "[resourceId('Microsoft.Network/virtualNetworks',[concat('-vnet-', uniquestring('vnet','vnet'),'')])]"
            }
            registrationEnabled : $false
        }
        dependsOn   : ["[resourceId('Microsoft.Network/virtualNetworks',[concat('-vnet-', uniquestring('vnet','vnet'),'')])]",
        "[resourceId('Microsoft.Network/privateDnsZones','contoso.com')]"]
    }

# 2. Optional parameters (note that the only valid ApiVersion at the time of writing was 2018-09-01)

    "contoso.com" | New-ArmPrivateDnsZone `
    | Add-ArmPrivateDnsZoneVirtualNetworkLink `
        -VirtualNetwork $VirtualNetwork `
        -RegistrationEnabled `
        -ApiVersion "2018-09-01"

    # result:
    {    
        _ResourceId : "[resourceId('Microsoft.Network/privateDnsZones/virtualNetworkLinks','contoso.com')]"
        PSTypeName  : "PDNSZVirtualNetworkLink"
        type        : "Microsoft.Network/privateDnsZones/virtualNetworkLinks"
        name        : "[concat('contoso.com/', [concat('-vnet-', uniquestring('vnet','vnet'),'')])]"
        apiVersion  : "2018-09-01"
        location    : "global"
        properties  : {
            virtualNetwork      : {
                id : "[resourceId('Microsoft.Network/virtualNetworks',[concat('-vnet-', uniquestring('vnet','vnet'),'')])]"
            }
            registrationEnabled : $true
        }
        dependsOn   : ["[resourceId('Microsoft.Network/virtualNetworks',[concat('-vnet-', uniquestring('vnet','vnet'),'')])]",
        "[resourceId('Microsoft.Network/privateDnsZones','contoso.com')]"]
    }