Get-AzPeeringServicePrefix
Gets an existing prefix with the specified name under the given subscription, resource group and peering service.
Syntax
Get-AzPeeringServicePrefix
-PeeringServiceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-Expand <String>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzPeeringServicePrefix
-Name <String>
-PeeringServiceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-Expand <String>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzPeeringServicePrefix
-InputObject <IPeeringIdentity>
[-Expand <String>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Gets an existing prefix with the specified name under the given subscription, resource group and peering service.
Examples
Example 1: List all peering service prefixes
Get-AzPeeringServicePrefix -PeeringServiceName TestDRInterCloudZurich -ResourceGroupName DemoRG
Name Prefix Key PrefixValidationState LearnedType ProvisioningState
---- ------ --- --------------------- ----------- -----------------
TestPrefix 91.194.255.0/24 6a7f0d42-e49c-4eea-a930-280610671c3f Failed None Succeeded
TestPrefix2 240.0.0.0/24 Failed None Succeeded
Lists all peering service prefixes for the peering service
Example 2: Get specific peering service prefix
Get-AzPeeringServicePrefix -PeeringServiceName TestDRInterCloudZurich -ResourceGroupName DemoRG -Name TestPrefix
Name Prefix Key PrefixValidationState LearnedType ProvisioningState
---- ------ --- --------------------- ----------- -----------------
TestPrefix 91.194.255.0/24 6a7f0d42-e49c-4eea-a930-280610671c3f Failed None Succeeded
Gets a specific peering service prefix
Parameters
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Type: | PSObject |
Aliases: | AzureRMContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Expand
The properties to be expanded.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: | IPeeringIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
The name of the prefix.
Type: | String |
Aliases: | PrefixName |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PeeringServiceName
The name of the peering service.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SubscriptionId
The Azure subscription ID.
Type: | String[] |
Position: | Named |
Default value: | (Get-AzContext).Subscription.Id |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Outputs
Azure PowerShell