Get-AzPeeringAsn
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.
Gets the peer ASN with the specified name under the given subscription.
Syntax
List (Default)
Get-AzPeeringAsn
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get
Get-AzPeeringAsn
-Name <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentity
Get-AzPeeringAsn
-InputObject <IPeeringIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Gets the peer ASN with the specified name under the given subscription.
Examples
Example 1: List PeerAsns
Get-AzPeeringAsn
Name PeerName PropertiesPeerAsn ValidationState PeerContactDetail
---- -------- ----------------- --------------- -----------------
ContosoEdgeTest Contoso 65000 Approved {{…}}
List all the peer asns under subscription
Example 2: Get Specific PeerAsn
Get-AzPeeringAsn -Name ContosoEdgeTest
Name PeerName PropertiesPeerAsn ValidationState PeerContactDetail
---- -------- ----------------- --------------- -----------------
ContosoEdgeTest Contoso 65000 Approved {{…}}
Get peer asn by name
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 |
-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 peer ASN name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | PeerAsnName |
Parameter sets
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.
