Edit

Share via

Create or change a Peering Service connection using PowerShell

  • Article

Azure Peering Service is a networking service that enhances connectivity to Microsoft cloud services such as Microsoft 365, Dynamics 365, software as a service (SaaS) services, Azure, or any Microsoft services accessible via the public internet.

In this article, you learn how to create and change a Peering Service connection using Azure PowerShell. To learn how to manage a Peering Service connection using the Azure portal or Azure CLI, see Create, change, or delete a Peering Service connection using the Azure portal or Create, change, or delete a Peering Service connection using the Azure CLI.

Prerequisites

  • An Azure account with an active subscription. Create an account for free.

  • Azure Cloud Shell or Azure PowerShell installed locally.

    The steps in this article run the Azure PowerShell cmdlets interactively in Azure Cloud Shell. To run the commands in the Cloud Shell, select Open Cloudshell at the upper-right corner of a code block. Select Copy to copy the code and then paste it into Cloud Shell to run it. You can also run the Cloud Shell from within the Azure portal.

    You can also install Azure PowerShell locally to run the cmdlets. This article requires the Azure PowerShell module version 1.0.0 or later. To find the installed version, run Get-Module -ListAvailable Az. If you need to upgrade, see Install Azure PowerShell module. If you run PowerShell locally, sign in to Azure using the Connect-AzAccount cmdlet.

  • A connectivity provider. For more information, see Peering Service partners.

Register your subscription with the resource provider and feature flag

Before you proceed to the steps of creating Peering Service, register your subscription with the resource provider and feature flag using Register-AzResourceProvider and Register-AzProviderFeature:

# Register Microsoft.Peering provider.
Register-AzResourceProvider -ProviderNamespace Microsoft.Peering
# Register AllowPeeringService feature.
Register-AzProviderFeature -FeatureName AllowPeeringService -ProviderNamespace Microsoft.Peering

List Peering Service locations and service providers

Use Get-AzPeeringServiceCountry to list the countries/regions where Peering Service is available and Get-AzPeeringServiceLocation to list the available metro locations in each country/region where you can get the Peering Service:

# List the countries/regions available for Peering Service.
Get-AzPeeringServiceCountry 
# List metro locations serviced in a country/region
Get-AzPeeringServiceLocation -Country "United States"

Use Get-AzPeeringServiceProvider to get a list of available Peering Service providers:

Get-AzPeeringServiceProvider

Create a Peering Service connection

Create a Peering Service connection using New-AzPeeringService:

New-AzPeeringService -ResourceGroupName myResourceGroup -Name myPeeringService -PeeringLocation Virginia -PeeringServiceProvider Contoso

Add the Peering Service prefix

Use New-AzPeeringServicePrefix to add the prefix provided to you by the connectivity provider:

New-AzPeeringServicePrefix -ResourceGroupName myResourceGroup -PeeringServiceName myPeeringService -Name myPrefix -prefix 240.0.0.0/32 -ServiceKey 00000000-0000-0000-0000-000000000000

List all Peering Services connections

To view the list of all Peering Service connections, use Get-AzPeeringService:

Get-AzPeeringService | Format-Table Name, PeeringServiceLocation, PeeringServiceProvider, Location

List all Peering Service prefixes

To view the list of all Peering Service prefixes, use Get-AzPeeringServicePrefix:

Get-AzPeeringServicePrefix -PeeringServiceName myPeeringService -ResourceGroupName myResourceGroup

Remove the Peering Service prefix

To remove the Peering Service prefix, use Remove-AzPeeringServicePrefix:

Remove-AzPeeringServicePrefix -ResourceGroupName myResourceGroup -Name myPeeringService -PrefixName myPrefix

Related content