Get-AzCustomIpPrefix
Gets a CustomIpPrefix resource
Note
This is the previous version of our documentation. Please consult the most recent version for up-to-date information.
Syntax
Get-AzCustomIpPrefix
[-Name <String>]
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzCustomIpPrefix
-ResourceId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzCustomIpPrefix cmdlet gets one or more CustomIpPrefixes given the set of input parameters
Examples
Example 1
PS C:\> Get-AzCustomIpPrefix -ResourceGroupName myRg -Name myCustomIpPrefix
Name : myCustomIpPrefix
ResourceGroupName : myRg
Location : westus
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/byoip-test-rg/providers/Micro
soft.Network/customIPPrefixes/testCustomIpPrefix
Etag : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid : 00000000-0000-0000-0000-000000000000
ProvisioningState : Succeeded
Tags :
Cidr : 111.111.111.111/24
CommissionedState : Provisioning
PublicIpPrefixes : []
Zones : {}
SignedMessage : SignedMessage
AuthorizationMessage : AuthorizationMessage
CustomIpPrefixParent :
ChildCustomIpPrefixes: []
This command gets a CustomIpPrefix resource named myCustomIpPrefix in resource group myRg
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
The resource name.
| Type: | String |
| Aliases: | ResourceName |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
The resource group name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceId
The resource id.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |