Edit

Share via

New-AzPeeringService

  • Reference
Module:
Az.Peering

Creates a new peering service or updates an existing peering with the specified name under the given subscription and resource group.

Syntax

PowerShell 
New-AzPeeringService
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -Location <String>
   [-PeeringServiceLocation <String>]
   [-PeeringServiceProvider <String>]
   [-ProviderBackupPeeringLocation <String>]
   [-ProviderPrimaryPeeringLocation <String>]
   [-Sku <String>]
   [-Tag <Hashtable>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Creates a new peering service or updates an existing peering with the specified name under the given subscription and resource group.

Examples

Example 1: Create a new peering service

PowerShell 
New-AzPeeringService -Name TestPeeringService -ResourceGroupName DemoRG -Location "East US 2" -PeeringServiceLocation Georgia -PeeringServiceProvider MicrosoftEdge -ProviderPrimaryPeeringLocation Atlanta

Name               ResourceGroupName PeeringServiceLocation Provider      ProvisioningState   Location
----               ----------------- ---------------------- --------      -----------------   --------
TestPeeringService DemoRG            Georgia                MicrosoftEdge ProvisioningStarted East US 2

Create a new peering service in the resource group

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Location

The location of the resource.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

The name of the peering service.

Type:String
Aliases:PeeringServiceName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PeeringServiceLocation

The location (state/province) of the customer.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PeeringServiceProvider

The name of the service provider.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProviderBackupPeeringLocation

The backup peering (Microsoft/service provider) location to be used for customer traffic.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProviderPrimaryPeeringLocation

The primary peering (Microsoft/service provider) location to be used for customer traffic.

Type:String
Position:Named
Default value:None
Required:False
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

-Sku

The name of the peering service SKU.

Type:String
Aliases:SkuName
Position:Named
Default value:None
Required:False
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

-Tag

The resource tags.

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs