Edit

Share via

Get-AzPeeringServicePrefix

Module:
Az.Peering Module

Gets an existing prefix with the specified name under the given subscription, resource group and peering service.

Syntax

List (Default) 

Get-AzPeeringServicePrefix
    -PeeringServiceName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-Expand <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityPeeringService 

Get-AzPeeringServicePrefix
    -Name <String>
    -PeeringServiceInputObject <IPeeringIdentity>
    [-Expand <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get 

Get-AzPeeringServicePrefix
    -Name <String>
    -PeeringServiceName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-Expand <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity 

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.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases: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

-Expand

The properties to be expanded.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter

Parameter properties

Type:IPeeringIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

The name of the prefix.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:PrefixName

Parameter sets

GetViaIdentityPeeringService
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PeeringServiceInputObject

Identity Parameter

Parameter properties

Type:IPeeringIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentityPeeringService
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-PeeringServiceName

The name of the peering service.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

The name of the resource group.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

The Azure subscription ID.

Parameter properties

Type:

String[]

Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
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.

Inputs

IPeeringIdentity

Outputs

IPeeringServicePrefix