Edit

Share via


Update-AzNetworkVirtualApplianceConnection

Update or Change a Network Virtual Appliance Connection resource.

Syntax

ResourceNameParameterSet (Default)

Update-AzNetworkVirtualApplianceConnection
    -ResourceGroupName <String>
    -VirtualApplianceName <String>
    -Name <String>
    [-RoutingConfiguration <PSRoutingConfiguration>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ResourceObjectParameterSet

Update-AzNetworkVirtualApplianceConnection
    -VirtualAppliance <PSNetworkVirtualAppliance>
    -Name <String>
    [-RoutingConfiguration <PSRoutingConfiguration>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ResourceIdParameterSet

Update-AzNetworkVirtualApplianceConnection
    -VirtualApplianceResourceId <String>
    -Name <String>
    [-RoutingConfiguration <PSRoutingConfiguration>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Update-AzNetworkVirtualApplianceConnection modifies a Network Virtual Appliance Connection resource.

Examples

Example 1

$rt1 = Get-AzVHubRouteTable -ResourceGroupName testrg -VirtualHubName vhub1 -Name "noneRouteTable"
$routingconfig = New-AzRoutingConfiguration -AssociatedRouteTable $rt1.Id -Label @("none") -Id @($rt1.Id)
Update-AzNetworkVirtualApplianceConnection -ResourceGroupName testrg -VirtualApplianceName nva -Name defaultConnection -RoutingConfiguration $routingconfig
Name                   : defaultConnection
ProvisioningState      : Succeeded
EnableInternetSecurity : False
BgpPeerAddress         : {10.2.112.5, 10.2.112.6}
Asn                    : 64512
TunnelIdentifier       : 0
RoutingConfiguration   : {
                           "AssociatedRouteTable": {
                             "Id": "/subscriptions/{subscriptionId}/resourceGroups/testrg/providers/Microsoft.Network/virtualHubs
                         /vhub1/hubRouteTables/noneRouteTable"
                           },
                           "PropagatedRouteTables": {
                             "Labels": [
                               "none"
                             ],
                             "Ids": [
                               {
                                 "Id": "/subscriptions/{subscriptionId}/resourceGroups/testrg/providers/Microsoft.Network/virtualHubs
                         /vhub1/hubRouteTables/noneRouteTable"
                               }
                             ]
                           },
                           "InboundRouteMap": {},
                           "OutboundRouteMap": {}
                         }

Parameters

-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

-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 resource name.

Parameter properties

Type:String
Default value:None
Supports wildcards:True
DontShow:False
Aliases:ResourceName, NetworkVirtualApplianceConnectionName

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

The resource group name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ResourceNameParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RoutingConfiguration

The routing configuration for this nva connection

Parameter properties

Type:PSRoutingConfiguration
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

-VirtualAppliance

The parent Network Virtual Appliance object for this connection.

Parameter properties

Type:PSNetworkVirtualAppliance
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ParentNva, NetworkVirtualAppliance

Parameter sets

ResourceObjectParameterSet
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VirtualApplianceName

The parent Network Virtual Appliance name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ParentNvaName, NetworkVirtualApplianceName

Parameter sets

ResourceNameParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VirtualApplianceResourceId

The resource id of the parent Network Virtual Appliance for this connection.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ParentNvaId, NetworkVirtualApplianceId

Parameter sets

ResourceIdParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
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.

Inputs

PSNetworkVirtualAppliance

String

Outputs

PSNetworkVirtualApplianceConnection