Get-AzPrivateDnsVirtualNetworkLink
Gets a virtual network link associated with the specified Private DNS zone.
Syntax
Get-AzPrivateDnsVirtualNetworkLink
-ResourceGroupName <String>
-ZoneName <String>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzPrivateDnsVirtualNetworkLink cmdlet gets virtual network links associated with a particular Private DNS zone from the specified resource group. If you specify the Name parameter, a single PSPrivateDnsVirtualNetworkLink object is returned. If you do not specify the Name parameter, an array containing all of the links associated with the zone in the specified resource group is returned. You can use the PSPrivateDnsVirtualNetworkLink object to update the link.
Examples
Example 1: Get a virtual network link.
$Link = Get-AzPrivateDnsVirtualNetworkLink -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -Name "mylink"
The link object returned looks like the following:
Name : mylink
ResourceId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.N
etwork/privateDnsZones/myzone.com/virtualNetworkLinks/mylink
ResourceGroupName : MyResourceGroup
ZoneName : myzone.com
VirtualNetworkId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.N
etwork/virtualNetworks/myvirtualnetwork
Location :
Etag : "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Tags : {tag1}
RegistrationEnabled : True
VirtualNetworkLinkState : Completed
ProvisioningState : Succeeded
This example gets the virtual network link mylink associated with the Private DNS zone named myzone.com from the specified resource group, and then stores it in the $Link variable.
Example 2: Get all of the links associated with a zone in a resource group.
$Links = Get-AzPrivateDnsVirtualNetworkLink -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com"
Name : mylink1
ResourceId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.N
etwork/privateDnsZones/myzone.com/virtualNetworkLinks/mylink1
ResourceGroupName : MyResourceGroup
ZoneName : myzone.com
VirtualNetworkId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.N
etwork/virtualNetworks/myvirtualnetwork
Location :
Etag : "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Tags : {tag1}
RegistrationEnabled : True
VirtualNetworkLinkState : Completed
ProvisioningState : Succeeded
Name : mylink2
ResourceId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.N
etwork/privateDnsZones/myzone.com/virtualNetworkLinks/mylink2
ResourceGroupName : MyResourceGroup
ZoneName : myzone.com
VirtualNetworkId : /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.N
etwork/virtualNetworks/myvirtualnetwork
Location :
Etag : "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Tags : {tag1}
RegistrationEnabled : True
VirtualNetworkLinkState : Completed
ProvisioningState : Succeeded
This example gets all of the virtual network links associated with the Private DNS zone "myzone.com" in the specified resource group, and then stores it in the $Links variable.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Specifies the name of the virtual network link to get. If you do not specify a value for the Name parameter, this cmdlet gets all links associated with the specified Private DNS zone in the specified resource group.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
Specifies the name of the resource group that contains the virtual network link to get.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ZoneName
Specifies the name of the Private DNS zone that the virtual network link is linked to.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
None
Outputs
PSPrivateDnsVirtualNetworkLink
Related Links
Azure PowerShell