Get-AzureRmPublicIpAddress
Gets a public IP address.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
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 $rgNameThis 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExpandResource
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IpConfigurationName
Network Interface IP Configuration Name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NetworkInterfaceName
Virtual Machine Network Interface Name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VirtualMachineIndex
Virtual Machine Index.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VirtualMachineScaleSetName
Virtual Machine Scale Set Name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |