Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Set-AzPublicIpAddress

Updates a public IP address.

Syntax

Default (Default)

Set-AzPublicIpAddress
 -PublicIpAddress <PSPublicIpAddress>
 [-AsJob]
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

Description

The Set-AzPublicIpAddress cmdlet updates a public IP address.

Examples

Example 1: Change allocation method of a public IP address

$publicIp = Get-AzPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName

$publicIp.PublicIpAllocationMethod = "Static"

Set-AzPublicIpAddress -PublicIpAddress $publicIp

Get-AzPublicIpAddress -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-AzPublicIPAddress 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.

Example 2: Add DNS domain label of a public IP address

$publicIp = Get-AzPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName

$publicIp.DnsSettings = @{"DomainNameLabel" = "newdnsprefix"}

Set-AzPublicIpAddress -PublicIpAddress $publicIp

$publicIp = Get-AzPublicIpAddress -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-AzPublicIPAddress command updates the public IP address resource with the updated object. DomainNameLabel & Fqdn are modified as expected.

Example 3: Change DNS domain label of a public IP address

$publicIp = Get-AzPublicIpAddress -Name $publicIpName -ResourceGroupName $rgName

$publicIp.DnsSettings.DomainNameLabel = "newdnsprefix"

Set-AzPublicIpAddress -PublicIpAddress $publicIp

$publicIp = Get-AzPublicIpAddress -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-AzPublicIPAddress command updates the public IP address resource with the updated object. DomainNameLabel & Fqdn are modified as expected.

Parameters

-AsJob

Run cmdlet in the background

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-DefaultProfile

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

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

-PublicIpAddress

Specifies a public IP address object representing the state to which the public IP address should be set.

Parameter properties

Type:PSPublicIpAddress
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

PSPublicIpAddress

Outputs

PSPublicIpAddress

Related Links


Feedback

Was this page helpful?