Set-AzExpressRouteCrossConnection
Modifies an ExpressRoute cross connection.
Syntax
ModifyByCircuitReference
Set-AzExpressRouteCrossConnection
-ExpressRouteCrossConnection <PSExpressRouteCrossConnection>
[-AsJob]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ModifyByParameterValues
Set-AzExpressRouteCrossConnection
-ResourceGroupName <String>
-Name <String>
[-ServiceProviderProvisioningState <String>]
[-ServiceProviderNotes <String>]
[-Peerings <PSExpressRouteCrossConnectionPeering[]>]
[-AsJob]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AzExpressRouteCrossConnection cmdlet saves the modified ExpressRoute cross connection to Azure.
Examples
Example 1: Change the Service Provider Provisioning State of an ExpressRoute cross connection
$cc = Get-AzExpressRouteCrossConnection -Name $CrossConnectionName -ResourceGroupName $rg
$cc.ServiceProviderProvisioningState = 'Provisioned'
Set-AzExpressRouteCrossConnection -ExpressRouteCrossConnection $cc
Parameters
-AsJob
Run cmdlet in the background
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, 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
-ExpressRouteCrossConnection
Specifies the ExpressRouteCrossConnection object that this cmdlet modifies.
Parameter properties
Parameter sets
ModifyByCircuitReference
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Force
Do not ask for confirmation if you want to overwrite a resource
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of express route cross connection.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ModifyByParameterValues
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Peerings
The list of peerings for the cross connection
Parameter properties
Parameter sets
ModifyByParameterValues
Position: Named Mandatory: False Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The ExpressRouteCrossConnection
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ModifyByParameterValues
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-ServiceProviderNotes
The service provider notes
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ModifyByParameterValues
Position: Named Mandatory: False Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-ServiceProviderProvisioningState
The service provider provisioning state to be set
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ModifyByParameterValues
Position: Named Mandatory: False Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
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 .
PSExpressRouteCrossConnection
Parameter 'ExpressRouteCrossConnection' accepts value of type 'PSExpressRouteCrossConnection' from the pipeline
Outputs
