Edit

Share via

Get-AzPeeringRegisteredAsn

  • Preview
Module:
Az.Peering Module

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 an existing registered ASN with the specified name under the given subscription, resource group and peering.

Syntax

List (Default) 

Get-AzPeeringRegisteredAsn
    -PeeringName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityPeering 

Get-AzPeeringRegisteredAsn
    -Name <String>
    -PeeringInputObject <IPeeringIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get 

Get-AzPeeringRegisteredAsn
    -Name <String>
    -PeeringName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity 

Get-AzPeeringRegisteredAsn
    -InputObject <IPeeringIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

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

Examples

Example 1: List all registered asns for peering

Get-AzPeeringRegisteredAsn -PeeringName MapsIxRs -ResourceGroupName MAPSDemo

Name          Asn   PeeringServicePrefixKey              ProvisioningState
----          ---   -----------------------              -----------------
fgfg          6500  767c9f30-7388-49ef-ba8e-e2d16d1c08e4 Succeeded
homedepottest 65000 32259ee0-ea01-495e-8279-06c24ef7aae0 Succeeded
JonOrmondTest 62540 e3f552c5-909e-434b-8fab-93e524a1aeed Succeeded

Lists all registered asn's for a peering

Example 2: Get specific registered asn for peering

Get-AzPeeringRegisteredAsn -PeeringName MapsIxRs -ResourceGroupName MAPSDemo -Name fgfg

Name Asn  PeeringServicePrefixKey              ProvisioningState
---- ---  -----------------------              -----------------
fgfg 6500 767c9f30-7388-49ef-ba8e-e2d16d1c08e4 Succeeded

Gets a specific registered asn for a peering 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 name of the registered ASN.

Parameter properties

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

Parameter sets

GetViaIdentityPeering
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

-PeeringInputObject

Identity Parameter

Parameter properties

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

Parameter sets

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

-PeeringName

The name of the peering.

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

IPeeringRegisteredAsn