Get-AzPublicIpPrefix
Gets a public IP prefix
Syntax
ListParameterSet (Default)
Get-AzPublicIpPrefix
[-Name <String>]
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByResourceIdParameterSet
Get-AzPublicIpPrefix
-ResourceId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzPublicIpPrefix cmdlet gets one or more public IP prefixes in a resource group.
Examples
Example 1
Get-AzPublicIpPrefix -ResourceGroupName myRg -Name myPublicIpPrefix1
Name : myPublicIpPrefix1
ResourceGroupName : myRg
Location : westus
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRg/providers/Mic
rosoft.Network/publicIPPrefixes/myPublicIpPrefix1
Etag : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid : 00000000-0000-0000-0000-000000000000
ProvisioningState : Succeeded
Tags :
PublicIpAddressVersion : IPv4
PrefixLength : 28
IPPrefix : xx.xx.xx.xx/xx
IdleTimeoutInMinutes :
Zones : {}
Sku : {
"Name": "Standard",
"Tier":"Regional"
}
IpTags : []
PublicIpAddresses : []
This command gets a public IP prefix resource with myPublicIpPrefix1 in resource group myRg
Example 2
Get-AzPublicIpPrefix -Name myPublicIpPrefix*
Name : myPublicIpPrefix1
ResourceGroupName : myRg
Location : westus
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRg/providers/Mic
rosoft.Network/publicIPPrefixes/myPublicIpPrefix1
Etag : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid : 00000000-0000-0000-0000-000000000000
ProvisioningState : Succeeded
Tags :
PublicIpAddressVersion : IPv4
PrefixLength : 28
IPPrefix : xx.xx.xx.xx/xx
IdleTimeoutInMinutes :
Zones : {}
Sku : {
"Name": "Standard",
"Tier": "Regional"
}
IpTags : []
PublicIpAddresses : []
This command gets all public IP prefix resources that start with myPublicIpPrefix.
Parameters
-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
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
The resource name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
| Aliases: | ResourceName |
Parameter sets
ListParameterSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceGroupName
The resource group name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
ListParameterSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceId
The resource Id.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByResourceIdParameterSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
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.
