Edit

Get-AzPeeringService

  • Reference
Module:
Az.Peering

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

Syntax

Get-AzPeeringService
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzPeeringService
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzPeeringService
   -InputObject <IPeeringIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzPeeringService
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

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

Examples

Example 1: List all peering services under subscription

Get-AzPeeringService

Name                               ResourceGroupName PeeringServiceLocation Provider      ProvisioningState Location
----                               ----------------- ---------------------- --------      ----------------- --------
TestPrefixForAtlanta               DemoRG            Georgia                MicrosoftEdge Succeeded         East US 2
TestExtension                      DemoRG            Virginia               MicrosoftEdge Succeeded         East US
TestExtension2                     DemoRG            Virginia               MicrosoftEdge Succeeded         East US
DemoPeeringServiceInterCloudLondon DemoRG            London                 InterCloud    Succeeded         UK South
DRTestInterCloud                   DemoRG            Ile-de-France          InterCloud    Succeeded         UK South
Gaurav Thareja                     DemoRG            Ile-de-France          InterCloud    Succeeded         UK South
TestDRInterCloudZurich             DemoRG            Zurich                 InterCloud    Succeeded         France Central
DRTest                             DemoRG            Ile-de-France          InterCloud    Succeeded         France Central

Lists all peering services under default subscription

Example 2: List all peering services under a specific resource group

Get-AzPeeringService -ResourceGroupName DemoRG

Name                               ResourceGroupName PeeringServiceLocation Provider      ProvisioningState Location
----                               ----------------- ---------------------- --------      ----------------- --------
TestPrefixForAtlanta               DemoRG            Georgia                MicrosoftEdge Succeeded         East US 2
TestExtension                      DemoRG            Virginia               MicrosoftEdge Succeeded         East US
TestExtension2                     DemoRG            Virginia               MicrosoftEdge Succeeded         East US
DemoPeeringServiceInterCloudLondon DemoRG            London                 InterCloud    Succeeded         UK South
DRTestInterCloud                   DemoRG            Ile-de-France          InterCloud    Succeeded         UK South
Gaurav Thareja                     DemoRG            Ile-de-France          InterCloud    Succeeded         UK South
TestDRInterCloudZurich             DemoRG            Zurich                 InterCloud    Succeeded         France Central
DRTest                             DemoRG            Ile-de-France          InterCloud    Succeeded         France Central

Lists all the peering services under a resource group

Example 3: List all peering services under a specific resource group

Get-AzPeeringService -ResourceGroupName DemoRG -Name TestExtension

Name                               ResourceGroupName PeeringServiceLocation Provider      ProvisioningState Location
----                               ----------------- ---------------------- --------      ----------------- --------
TestExtension                      DemoRG            Virginia               MicrosoftEdge Succeeded         East US

Gets a peering service with matching name and resource group

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
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 peering.

Type:String
Aliases:PeeringServiceName
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

IPeeringIdentity

Outputs

IPeeringService

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IPeeringIdentity>: Identity Parameter

  • [ConnectionMonitorTestName <String>]: The name of the connection monitor test
  • [Id <String>]: Resource identity path
  • [PeerAsnName <String>]: The peer ASN name.
  • [PeeringName <String>]: The name of the peering.
  • [PeeringServiceName <String>]: The name of the peering service.
  • [PrefixName <String>]: The name of the prefix.
  • [RegisteredAsnName <String>]: The name of the registered ASN.
  • [RegisteredPrefixName <String>]: The name of the registered prefix.
  • [ResourceGroupName <String>]: The name of the resource group.
  • [SubscriptionId <String>]: The Azure subscription ID.