Set-AzureRmPublicIpAddress

Reference

Module:: AzureRM.Network

Sets the goal state for a public IP address.

Important

Because Az PowerShell modules now have all the capabilities of AzureRM PowerShell modules and more, we'll retire AzureRM PowerShell modules on 29 February 2024.

To avoid service interruptions, update your scripts that use AzureRM PowerShell modules to use Az PowerShell modules by 29 February 2024. To automatically update your scripts, follow the quickstart guide.

Syntax

Set-AzureRmPublicIpAddress
   -PublicIpAddress <PSPublicIpAddress>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [<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 = "Static"
    
PS C:\> Set-AzureRmPublicIpAddress -PublicIpAddress $publicIp

PS C:\> 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.

Parameters

-AsJob

Run cmdlet in the background

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

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-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
Accept wildcard characters:	False

Inputs

PSPublicIpAddress

Parameters: PublicIpAddress (ByValue)

Outputs