Get-AzNetworkVirtualApplianceConnection

Module:

Az.Network Module

Get or List Network Virtual Appliances connections connected to a Network Virtual Appliance.

Syntax

ResourceNameParameterSet (Default)

Get-AzNetworkVirtualApplianceConnection
    -ResourceGroupName <String>
    -VirtualApplianceName <String>
    [-Name <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ResourceObjectParameterSet

Get-AzNetworkVirtualApplianceConnection
    -VirtualAppliance <PSNetworkVirtualAppliance>
    [-Name <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ResourceIdParameterSet

Get-AzNetworkVirtualApplianceConnection
    -VirtualApplianceResourceId <String>
    [-Name <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzNetworkVirtualApplianceConnection commands gets or lists connections connected to a Network Virtual Appliance.

Examples

Example 1

Get-AzNetworkVirtualApplianceConnection -ResourceGroupName testrg -VirtualApplianceName nva

Name                   : defaultConnection
ProvisioningState      : Succeeded
PropagateStaticRoutes  : False
EnableInternetSecurity : False
BgpPeerAddress         : []
Asn                    : 65222
TunnelIdentifier       : 0
RoutingConfiguration   : {
                           "AssociatedRouteTable": {
                             "Id":"/subscriptions/{subid}/resourceGroups/{resource-group-name}/providers/Microsoft.Network/virtualHubs/{hub-name}//hubRouteTables/defaultRouteTable"
                           },
                           "PropagatedRouteTables": {
                             "Labels": [],
                             "Ids": [
                               {
                                 "Id": "/subscriptions/{subid}/resourceGroups/{resource-group-name}/providers/Microsoft.Network/virtualHubs/{hub-name}//hubRouteTables/defaultRouteTable"
                               }
                             ]
                           },
                           "InboundRouteMap": {},
                           "OutboundRouteMap": {}
                         }

The above will gets the connection from "testRG" resource group using Resource group and Parent NVA name

Example 2

$nva = Get-AzNetworkVirtualAppliance -ResourceGroupName testrg -Name nva
Get-AzNetworkVirtualApplianceConnection -VirtualAppliance $nva

Name                   : defaultConnection
ProvisioningState      : Succeeded
PropagateStaticRoutes  : False
EnableInternetSecurity : False
BgpPeerAddress         : []
Asn                    : 65222
TunnelIdentifier       : 0
RoutingConfiguration   : {
                           "AssociatedRouteTable": {
                             "Id":"/subscriptions/{subid}/resourceGroups/{resource-group-name}/providers/Microsoft.Network/virtualHubs/{hub-name}//hubRouteTables/defaultRouteTable"
                           },
                           "PropagatedRouteTables": {
                             "Labels": [],
                             "Ids": [
                               {
                                 "Id": "/subscriptions/{subid}/resourceGroups/{resource-group-name}/providers/Microsoft.Network/virtualHubs/{hub-name}//hubRouteTables/defaultRouteTable"
                               }
                             ]
                           },
                           "InboundRouteMap": {},
                           "OutboundRouteMap": {}
                         }

This cmdlet gets the NVA connection using Network Virtual Appliance object.

Parameters

-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

-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:	False
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

-VirtualAppliance

The parent Network Virtual Appliance 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 virtual appliance resource 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

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