Skip to content

Latest commit

 

History

History
264 lines (208 loc) · 7.9 KB

Set-AzPrivateDnsVirtualNetworkLink.md

File metadata and controls

264 lines (208 loc) · 7.9 KB
Raw
external help file Module Name ms.assetid online version schema
Microsoft.Azure.PowerShell.Cmdlets.PrivateDns.dll-Help.xml
Az.PrivateDns
A8E230A0-5057-40BC-81CD-6D397A503A84
2.0.0

Set-AzPrivateDnsVirtualNetworkLink

SYNOPSIS

Updates/Sets a virtual network link associated with a private zone and a resource group.

SYNTAX

Fields (Default)

Set-AzPrivateDnsVirtualNetworkLink -ResourceGroupName <String> -ZoneName <String> -Name <String>
 [-IsRegistrationEnabled <Boolean>] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

Object

Set-AzPrivateDnsVirtualNetworkLink -InputObject <PSPrivateDnsVirtualNetworkLink>
 [-IsRegistrationEnabled <Boolean>] [-Tag <Hashtable>] [-Overwrite] [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

ResourceId

Set-AzPrivateDnsVirtualNetworkLink -ResourceId <String> [-IsRegistrationEnabled <Boolean>] [-Tag <Hashtable>]
 [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Set-AzPrivateDnsVirtualNetworkLink cmdlet updates a link associated with a zone from a specified resource group. You can pass a PSPrivateDnsVirtualNetworkLink object using the Link parameter or by using the pipeline operator, or alternatively you can specify the Name ZoneName and ResourceGroupName parameters. You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation. When specifying the zone using a PSPrivateDnsVirtualNetworkLink object (passed via the pipeline or Link parameter), the link is not updated if it has been changed in Azure DNS since the local PSPrivateDnsVirtualNetworkLink object was retrieved. This provides protection for concurrent link changes. This can be suppressed using the Overwrite parameter, which updates the link regardless of concurrent changes.

EXAMPLES

Example 1: Set a link

Set-AzPrivateDnsVirtualNetworkLink -ZoneName "myzone.com" -ResourceGroupName "MyResourceGroup" -Name "mylink" -Tag @{} -IsRegistrationEnabled $true
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                    : {}
RegistrationEnabled     : True
VirtualNetworkLinkState : Completed
ProvisioningState       : Succeeded

This command sets IsRegistrationEnabled to True for the link named mylink, linked to zone named myzone.com from the resource group named MyResourceGroup.

PARAMETERS

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InputObject

The virtual network link object to set.

Type: Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsVirtualNetworkLink
Parameter Sets: Object
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-IsRegistrationEnabled

Boolean that represents if registration is enabled on the virtual network link.

Type: System.Nullable`1[System.Boolean]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the name of the link that this cmdlet removes. You must also specify the ResourceGroupName and ZoneName parameter. Alternatively, you can specify the private DNS link using the link parameter.

Type: System.String
Parameter Sets: Fields
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Overwrite

When specifying the link using a PSPrivateDnsVirtualNetworkLink object (passed via the pipeline or Link parameter), the link is not deleted if it has been changed in Azure DNS since the local PSPrivateDnsVirtualNetworkLink object was retrieved. This provides protection for concurrent link changes. This can be suppressed using the Overwrite parameter, which deletes the link regardless of concurrent changes.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: Object
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceGroupName

Specifies the name of the resource group that contains the link to remove. You must also specify the ZoneName and Name parameter. Alternatively, you can specify the virtual network link using a PSPrivateDnsVirtualNetworkLink object, passed via either the pipeline or the Link parameter.

Type: System.String
Parameter Sets: Fields
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceId

Private DNS Zone ResourceID.

Type: System.String
Parameter Sets: ResourceId
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Tag

A hash table which represents resource tags.

Type: System.Collections.Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ZoneName

Specifies the name of the DNS zone that this cmdlet removes. You must also specify the Name and ResourceGroupName parameter. Alternatively, you can specify the private DNS link using the link parameter.

Type: System.String
Parameter Sets: Fields
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsVirtualNetworkLink

System.String

OUTPUTS

Microsoft.Azure.Commands.PrivateDns.Models.PSPrivateDnsVirtualNetworkLink

NOTES

RELATED LINKS

Get-AzPrivateDnsVirtualNetworkLink

New-AzPrivateDnsVirtualNetworkLink

Set-AzPrivateDnsVirtualNetworkLink