Get-AzureRmPublicIpAddress

Reference

Module:: AzureRM.Network

Gets 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

Get-AzureRmPublicIpAddress
   [-Name <String>]
   [-ResourceGroupName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmPublicIpAddress
   -Name <String>
   -ResourceGroupName <String>
   -ExpandResource <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmPublicIpAddress
   [-Name <String>]
   -ResourceGroupName <String>
   [-VirtualMachineScaleSetName <String>]
   [-VirtualMachineIndex <String>]
   [-NetworkInterfaceName <String>]
   [-IpConfigurationName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmPublicIpAddress
   -Name <String>
   -ResourceGroupName <String>
   -VirtualMachineScaleSetName <String>
   -VirtualMachineIndex <String>
   -NetworkInterfaceName <String>
   -IpConfigurationName <String>
   -ExpandResource <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmPublicIPAddress cmdlet gets one or more public IP addresses in a resource group.

Examples

1: Get a public IP resource

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

This command gets a public IP address resource with name $publicIPName in the resource group $rgName.

Parameters

-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

-ExpandResource

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

-IpConfigurationName

Network Interface IP Configuration Name.

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

-Name

Specifies the name of the public IP address that this cmdlet gets.

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

-NetworkInterfaceName

Virtual Machine Network Interface Name.

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

-ResourceGroupName

Specifies the name of the resource group that contains the public IP address that this cmdlet gets.

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

-VirtualMachineIndex

Virtual Machine Index.

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

-VirtualMachineScaleSetName

Virtual Machine Scale Set Name.

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

Inputs

String

Outputs

PSPublicIpAddress