Get-AzPublicIpAddress
Gets a public IP address.
Syntax
Get-AzPublicIpAddress
[-Name <String>]
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzPublicIpAddress
-Name <String>
-ResourceGroupName <String>
-ExpandResource <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzPublicIpAddress
[-Name <String>]
-ResourceGroupName <String>
[-VirtualMachineScaleSetName <String>]
[-VirtualMachineIndex <String>]
[-NetworkInterfaceName <String>]
[-IpConfigurationName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzPublicIpAddress
-Name <String>
-ResourceGroupName <String>
-VirtualMachineScaleSetName <String>
-VirtualMachineIndex <String>
-NetworkInterfaceName <String>
-IpConfigurationName <String>
-ExpandResource <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzPublicIPAddress cmdlet gets one or more public IP addresses in a resource group.
Examples
Example 1: Get a public IP resource
Get-AzPublicIpAddress -Name myPublicIp1 -ResourceGroupName myRg
Name : myPublicIp1
ResourceGroupName : myRg
Location : westus2
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRg/providers/Microsoft
.Network/publicIPAddresses/myPublicIp1
Etag : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid : 00000000-0000-0000-0000-000000000000
ProvisioningState : Succeeded
Tags :
PublicIpAllocationMethod : Dynamic
IpAddress : Not Assigned
PublicIpAddressVersion : IPv4
IdleTimeoutInMinutes : 4
IpConfiguration : {
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRg/providers/
Microsoft.Network/networkInterfaces/ps-azure-env407/ipConfigurations/ipconfig1"
}
DnsSettings : null
Zones : {}
Sku : {
"Name": "Basic",
"Tier": "Regional"
}
IpTags : []
This command gets a public IP address resource with name myPublicIp in the resource group myRg.
Example 2: Get public IP resources using filtering
Get-AzPublicIpAddress -Name myPublicIp*
Name : myPublicIp1
ResourceGroupName : myRg
Location : westus2
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRg/providers/Microsoft
.Network/publicIPAddresses/myPublicIp1
Etag : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid : 00000000-0000-0000-0000-000000000000
ProvisioningState : Succeeded
Tags :
PublicIpAllocationMethod : Dynamic
IpAddress : Not Assigned
PublicIpAddressVersion : IPv4
IdleTimeoutInMinutes : 4
IpConfiguration : {
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRg/providers/
Microsoft.Network/networkInterfaces/ps-azure-env407/ipConfigurations/ipconfig1"
}
DnsSettings : null
Zones : {}
Sku : {
"Name": "Basic",
"Tier": "Regional"
}
IpTags : []
This command gets all public IP address resources whose name starts with myPublicIp.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, 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: | True |
-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: | True |
-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 |