Set-​Azure​Rm​Public​Ip​Address

Sets the goal state for a public IP address.

Syntax

Set-AzureRmPublicIpAddress
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   -PublicIpAddress <PSPublicIpAddress>
   [<CommonParameters>]

Description

The Set-AzureRmPublicIpAddress cmdlet sets the goal state for a public IP address.

Examples

1: Change allocation method of a public IP address

PS C:\> $publicIp = Get-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName

PS C:\> $publicIp.PublicIpAllocationMethod = "Dynamic"
    
PS C:\> Set-AzureRmPublicIpAddress -PublicIpAddress $publicIp

PS C:\> $publicIp = Get-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName

First command gets the public IP address resource with name $publicIPName in the resource group $rgName. Second command sets the allocation method of the public IP address object to "Static". Set-AzureRmPublicIPAddress command updates the public IP address resource with the updated object, and modifies the allocation method to 'Static'. A public IP address gets allocated immediately.

2: Change DNS domain label of a public IP address

PS C:\> $publicIp = Get-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName

PS C:\> $publicIp.DnsSettings.DomainNameLabel = "newdnsprefix"
    
PS C:\> Set-AzureRmPublicIpAddress -PublicIpAddress $publicIp

PS C:\> $publicIp = Get-AzureRmPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName

First command gets the public IP address resource with name $publicIPName in the resource group $rgName. Second command sets the DomainNameLabel property to the required dns prefix. Set-AzureRmPublicIPAddress command updates the public IP address resource with the updated object. DomainNameLabel & Fqdn are modified as expected.

Required Parameters

-PublicIpAddress

Specifies a PublicIpAddress object that represents the goal state to which the public IP address should be set.

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

Optional Parameters

-InformationAction

Specifies how this cmdlet responds to an information event.The acceptable values for this parameter are:- Continue

  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False