New-AzureVirtualNetworkGatewayConnection
Creates an Azure virtual gateway network connection.
Note
The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.
The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.
Syntax
New-AzureVirtualNetworkGatewayConnection
-ConnectedEntityId <String>
-GatewayConnectionName <String>
-GatewayConnectionType <String>
[-RoutingWeight <Int32>]
[-SharedKey <String>]
-VirtualNetworkGatewayId <String>
[-EnableBgp <String>]
[-Profile <AzureSMProfile>]
[<CommonParameters>] Description
The New-AzureVirtualNetworkGatewayConnection cmdlet creates an Azure virtual gateway network connection.
Parameters
-ConnectedEntityId
Specifies the ID of a connected entity.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnableBgp
Enables Border Gateway Protocol (BGP).
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GatewayConnectionName
Specifies a name for the gateway connection.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GatewayConnectionType
Specifies the type of gateway connection.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Profile
Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.
| Type: | AzureSMProfile |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RoutingWeight
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SharedKey
Specifies a shared key.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VirtualNetworkGatewayId
Specifies the ID of a virtual network gateway.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |