Get-AzPeeringLegacy
This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus.
Lists all of the legacy peerings under the given subscription matching the specified kind and location.
Syntax
Default (Default)
Get-AzPeeringLegacy
[-SubscriptionId <String[]>]
-Kind <String>
-PeeringLocation <String>
[-Asn <Int32>]
[-DirectPeeringType <String>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Lists all of the legacy peerings under the given subscription matching the specified kind and location.
Examples
Example 1: Gets legacy peering object
Get-AzPeeringLegacy -Kind Direct -PeeringLocation Seattle
Name SkuName Kind PeeringLocation ProvisioningState Location
---- ------- ---- --------------- ----------------- --------
DemoComp1 Premium_Direct_Free Direct Dallas Succeeded South Central US
DemoPeering Premium_Direct_Free Direct Dallas Succeeded South Central US
TestEdgeZone Premium_Direct_Free Direct Atlanta Succeeded East US 2
Gets legacy peering object
Parameters
-Asn
The ASN number associated with a legacy peering.
Parameter properties
| Type: | Int32 |
| 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 |
-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 |
-DirectPeeringType
The direct peering type.
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 |
-Kind
The kind of the peering.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PeeringLocation
The location of the peering.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| 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
(All)
| 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.