Get-AzPeeringService
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 peering service with the specified name under the given subscription and resource group.
Syntax
List1 (Default)
Get-AzPeeringService
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get
Get-AzPeeringService
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
List
Get-AzPeeringService
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentity
Get-AzPeeringService
-InputObject <IPeeringIdentity>
[-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 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 peering.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | PeeringServiceName |
Parameter sets
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
Get
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
List
| 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
List1
| 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 |
List
| 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.
