Skip to content

Latest commit

 

History

History
101 lines (73 loc) · 2.62 KB

Set-AzExpressRouteCircuit.md

File metadata and controls

101 lines (73 loc) · 2.62 KB
external help file Module Name ms.assetid online version schema
Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml
Az.Network
2A3B7343-9AA0-4505-AEDE-31C0C5B98694
2.0.0

Set-AzExpressRouteCircuit

SYNOPSIS

Modifies an ExpressRoute circuit.

SYNTAX

Set-AzExpressRouteCircuit -ExpressRouteCircuit <PSExpressRouteCircuit> [-AsJob]
 [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]

DESCRIPTION

The Set-AzExpressRouteCircuit cmdlet saves the modified ExpressRoute circuit to Azure.

EXAMPLES

Example 1: Change the ServiceKey of an ExpressRoute circuit

$ckt = Get-AzExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg
$ckt.ServiceKey = '64ce99dd-ee70-4e74-b6b8-91c6307433a0'
Set-AzExpressRouteCircuit -ExpressRouteCircuit $ckt

PARAMETERS

-AsJob

Run cmdlet in the background

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

-DefaultProfile

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

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

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

-ExpressRouteCircuit

Specifies the ExpressRouteCircuit object that this cmdlet modifies.

Type: Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit

OUTPUTS

Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit

NOTES

RELATED LINKS

Get-AzExpressRouteCircuit

Move-AzExpressRouteCircuit

New-AzExpressRouteCircuit

Remove-AzExpressRouteCircuit