Skip to content

Commit 7473fc6

Browse files
Merge pull request #286915 from halkazwini/er-qs-ps2
ER PowerShell quickstart update 2
2 parents bb9887f + bd7ebf4 commit 7473fc6

File tree

1 file changed

+71
-6
lines changed

1 file changed

+71
-6
lines changed

articles/expressroute/expressroute-howto-circuit-arm.md

Lines changed: 71 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ description: This quickstart shows you how to create, provision, verify, update,
44
services: expressroute
55
author: duongau
66
ms.author: duau
7-
ms.date: 12/28/2023
7+
ms.date: 09/25/2024
88
ms.topic: quickstart
99
ms.service: azure-expressroute
1010
ms.custom: devx-track-azurepowershell, mode-api
1111
---
1212

1313
# Quickstart: Create and modify an ExpressRoute circuit using Azure PowerShell
1414

15-
This quickstart shows you how to create an ExpressRoute circuit using PowerShell cmdlets and the Azure Resource Manager deployment model. You can also check the status, update, delete, or deprovision a circuit.
15+
This quickstart shows you how to create an ExpressRoute circuit in three different resiliency types: **Maximum Resiliency**, **High Resiliency**, and **Standard Resiliency** using Azure PowerShell. You'll learn how to check the status, update, delete, or deprovision a circuit using PowerShell cmdlets.
1616

1717
:::image type="content" source="media/expressroute-howto-circuit-portal-resource-manager/environment-diagram.png" alt-text="Diagram of ExpressRoute circuit deployment environment using Azure PowerShell." lightbox="media/expressroute-howto-circuit-portal-resource-manager/environment-diagram.png":::
1818

@@ -48,19 +48,85 @@ Check to see if your connectivity provider is listed there. Make a note of the f
4848

4949
You're now ready to create an ExpressRoute circuit.
5050

51+
### Get the list of resilient locations
52+
53+
If you're creating an ExpressRoute circuit with a resiliency type of **Maximum Resiliency**, you need to know the list of resilient locations. Here are the steps to retrieve this information:
54+
55+
#### Clone the script
56+
57+
```azurepowershell-interactive
58+
# Clone the setup script from GitHub.
59+
git clone https://github.com/Azure-Samples/azure-docs-powershell-samples/
60+
# Change to the directory where the script is located.
61+
CD azure-docs-powershell-samples/expressroute/
62+
```
63+
64+
#### Run resilient locations script
65+
66+
Run the **Get-AzExpressRouteResilientLocations.ps1** script to get the list of resilient locations. The following example shows how to get the resilient locations for a specific subscription sorted by distance from Silicon Valley:
67+
68+
```azurepowershell-interactive
69+
$SubscriptionId = Get-AzureSubscription -SubscriptionName "<SubscriptionName>"
70+
highAvailabilitySetup/Get-AzExpressRouteResilientLocations.ps1 -SubscriptionId $SubscriptionId -RelativeLocation "silicon valley"
71+
```
72+
If you don't specify the location, you get a list of all resilient locations.
73+
5174
### Create an ExpressRoute circuit
5275

53-
If you don't already have a resource group, you must create one before you create your ExpressRoute circuit. You can do so by running the following command:
76+
If you don't already have a resource group, you must create one before you create your ExpressRoute circuit. You can do so by running the **New-AzResourceGroup** cmdlet:
5477

5578
```azurepowershell-interactive
56-
New-AzResourceGroup -Name "ExpressRouteResourceGroup" -Location "West US"
79+
$resourceGroupName = (New-AzResourceGroup -Name "ExpressRouteResourceGroup" -Location "West US").ResourceGroupName
5780
```
5881

59-
The following example shows how to create a 200-Mbps ExpressRoute circuit through Equinix in Silicon Valley. If you're using a different provider and different settings, replace that information when you make your request. Use the following example to request a new service key:
82+
If you already have a resource group, you can use **Get-AzResourceGroup** to get the resource group name into a variable:
83+
84+
```azurepowershell-interactive
85+
$resourceGroupName = (Get-AzResourceGroup -Name "<ResourceGroupName>").ResourceGroupName
86+
```
87+
88+
# [**Maximum Resiliency**](#tab/maximum)
89+
90+
**Maximum Resiliency** (Recommended) provides the highest level of resiliency for your ExpressRoute connection. It provides two ExpressRoute circuits with local redundancy in two different ExpressRoute edge locations.
91+
92+
The following example shows how to create two ExpressRoute circuits through Equinix with local redundancy in Silicon Valley and Washington DC. If you're using a different provider and different settings, replace that information when you make your request.
93+
94+
> [!NOTE]
95+
> This example uses the **New-AzHighAvailabilityExpressRouteCircuits.ps1** script. You must clone the script from GitHub to create the circuits. For more information, see [Clone the script](#clone-the-script).
96+
97+
```azurepowershell-interactive
98+
$SubscriptionId = Get-AzureSubscription -SubscriptionName "<SubscriptionName>"
99+
highAvailabilitySetup/New-AzHighAvailabilityExpressRouteCircuits.ps1 -SubscriptionId $SubscriptionId -ResourceGroupName $resourceGroupName -Location "westus" -Name1 $circuit1Name -Name2 $circuit2Name -SkuFamily1 "MeteredData" -SkuFamily2 "MeteredData" -SkuTier1 "Standard" -SkuTier2 "Standard" -ServiceProviderName1 "Equinix" -ServiceProviderName2 "Equinix" -PeeringLocation1 "Silicon Valley" -PeeringLocation2 "Washington DC" -BandwidthInMbps 1000
100+
```
101+
102+
:::image type="content" source="./media/expressroute-howto-circuit-portal-resource-manager/maximum-resiliency.png" alt-text="Diagram of maximum resiliency for an ExpressRoute connection.":::
103+
104+
> [!NOTE]
105+
> Maximum Resiliency provides maximum protection against location wide outages and connectivity failures in an ExpressRoute location. This option is strongly recommended for all critical and production workloads.
106+
107+
# [**High Resiliency**](#tab/high)
108+
109+
**High Resiliency** provides resiliency against location wide outages through a single ExpressRoute circuit across two locations in a metropolitan area.
110+
111+
The following example shows how to create an ExpressRoute circuit through Equinix in Amsterdam Metro. If you're using a different provider and different settings, replace that information when you make your request. Use the following example to request a new service key.
112+
113+
```azurepowershell-interactive
114+
New-AzExpressRouteCircuit -Name "ExpressRouteARMCircuit" -ResourceGroupName "ExpressRouteResourceGroup" -Location "West EU" -SkuTier Standard -SkuFamily MeteredData -ServiceProviderName "Equinix" -PeeringLocation "Amsterdam Metro" -BandwidthInMbps 200
115+
```
116+
:::image type="content" source="./media/expressroute-howto-circuit-portal-resource-manager/high-resiliency.png" alt-text="Diagram of high resiliency for an ExpressRoute connection.":::
117+
118+
# [**Standard Resiliency**](#tab/standard)
119+
120+
**Standard Resiliency** provides a single ExpressRoute circuit with local redundancy at a single ExpressRoute location.
121+
122+
The following example shows how to create an ExpressRoute circuit through Equinix in Silicon Valley. If you're using a different provider and different settings, replace that information when you make your request. Use the following example to request a new service key.
60123

61124
```azurepowershell-interactive
62125
New-AzExpressRouteCircuit -Name "ExpressRouteARMCircuit" -ResourceGroupName "ExpressRouteResourceGroup" -Location "West US" -SkuTier Standard -SkuFamily MeteredData -ServiceProviderName "Equinix" -PeeringLocation "Silicon Valley" -BandwidthInMbps 200
63126
```
127+
:::image type="content" source="./media/expressroute-howto-circuit-portal-resource-manager/standard-resiliency.png" alt-text="Diagram of standard resiliency for an ExpressRoute connection.":::
128+
129+
---
64130

65131
Make sure that you specify the correct SKU tier and SKU family:
66132

@@ -69,7 +135,6 @@ Make sure that you specify the correct SKU tier and SKU family:
69135

70136
> [!IMPORTANT]
71137
> Your ExpressRoute circuit is billed from the moment a service key is issued. Ensure that you perform this operation when the connectivity provider is ready to provision the circuit.
72-
>
73138
74139
The response contains the service key. You can get detailed descriptions of all the parameters by running the following command:
75140

0 commit comments

Comments
 (0)