az network vpn-gateway connection vpn-site-link-conn

Note

This reference is part of the virtual-wan extension for the Azure CLI (version 2.55.0 or higher). The extension will automatically install the first time you run an az network vpn-gateway connection vpn-site-link-conn command. Learn more about extensions.

Manage site-to-site VPN gateway connection VPN site link connection.

Commands

Name	Description	Type	Status
az network vpn-gateway connection vpn-site-link-conn add	Add a VPN site link connection to a site-to-site VPN gateway connection.	Extension	GA
az network vpn-gateway connection vpn-site-link-conn ipsec-policy	Manage site-to-site VPN gateway connection VPN site link IPSec policies.	Extension	GA
az network vpn-gateway connection vpn-site-link-conn ipsec-policy add	Add an IPSec policy to a site-to-site VPN gateway connection VPN site link.	Extension	GA
az network vpn-gateway connection vpn-site-link-conn ipsec-policy list	List site-to-site VPN gateway connection VPN site link IPSec policies.	Extension	GA
az network vpn-gateway connection vpn-site-link-conn ipsec-policy remove	Remove an IPSec policy from a site-to-site VPN gateway connection VPN site link.	Extension	GA
az network vpn-gateway connection vpn-site-link-conn list	List site-to-site VPN gateway connection VPN site link connection.	Extension	GA
az network vpn-gateway connection vpn-site-link-conn remove	Remove a VPN site link connection from a site-to-site VPN gateway connection.	Extension	GA

az network vpn-gateway connection vpn-site-link-conn add

Add a VPN site link connection to a site-to-site VPN gateway connection.

az network vpn-gateway connection vpn-site-link-conn add --vpn-site-link
                                                         [--connection-bandwidth]
                                                         [--connection-name]
                                                         [--enable-bgp {false, true}]
                                                         [--gateway-name]
                                                         [--ids]
                                                         [--name]
                                                         [--no-wait]
                                                         [--rate-limiting {false, true}]
                                                         [--resource-group]
                                                         [--routing-weight]
                                                         [--shared-key]
                                                         [--subscription]
                                                         [--use-local-azure-ip-address {false, true}]
                                                         [--use-policy-based-traffic-selectors {false, true}]
                                                         [--vpn-connection-protocol-type {IKEv1, IKEv2}]
                                                         [--vpn-link-connection-mode {Default, InitiatorOnly, ResponderOnly}]

Examples

Add a VPN site link connection to site-to-site VPN gateway connection

az network vpn-gateway connection vpn-site-link-conn add -g MyRG --connection-name MyConnection --gateway-name MyGateway -n MyVPNSiteLinkConn --vpn-site-link /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/vpnSites/MyVPNSite/vpnSiteLinks/vpnsitelink --vpn-connection-protocol-type IKEv2

Required Parameters

--vpn-site-link

The resource ID of VPN Site Link.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--connection-bandwidth

Expected bandwidth in Mbps.

--connection-name

Name of the VPN gateway connection.

Property	Value
Parameter group:	Resource Id Arguments

--enable-bgp

Enable BGP.

Property	Value
Accepted values:	false, true

--gateway-name

Name of the VPN gateway.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Name of the VPN site link connection.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--rate-limiting

Enable rate limiting.

Property	Value
Accepted values:	false, true

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--routing-weight

Routing weight.

--shared-key

Shared key.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--use-local-azure-ip-address

Use local azure ip to initiate connection.

Property	Value
Accepted values:	false, true

--use-policy-based-traffic-selectors

Enable policy-based traffic selectors.

Property	Value
Accepted values:	false, true

--vpn-connection-protocol-type

Connection protocol used for this connection.

Property	Value
Accepted values:	IKEv1, IKEv2

--vpn-link-connection-mode

Vpn link connection mode.

Property	Value
Accepted values:	Default, InitiatorOnly, ResponderOnly

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network vpn-gateway connection vpn-site-link-conn list

List site-to-site VPN gateway connection VPN site link connection.

az network vpn-gateway connection vpn-site-link-conn list --connection-name
                                                          --gateway-name
                                                          --resource-group

Examples

List VPN site link connections on site-to-site VPN gateway connection

az network vpn-gateway connection vpn-site-link-conn list -g MyRG --connection-name MyConnection --gateway-name MyGateway

Required Parameters

--connection-name

Name of the VPN gateway connection.

--gateway-name

Name of the VPN gateway.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network vpn-gateway connection vpn-site-link-conn remove

Remove a VPN site link connection from a site-to-site VPN gateway connection.

az network vpn-gateway connection vpn-site-link-conn remove --index
                                                            [--connection-name]
                                                            [--gateway-name]
                                                            [--ids]
                                                            [--no-wait]
                                                            [--resource-group]
                                                            [--subscription]

Examples

Remove aVPN site link connection from site-to-site VPN gateway connection

az network vpn-gateway connection vpn-site-link-conn remove -g MyRG --connection-name MyConnection --gateway-name MyGateway --index 1

Required Parameters

--index

List index of the item (starting with 1).

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--connection-name

Name of the VPN gateway connection.

Property	Value
Parameter group:	Resource Id Arguments

--gateway-name

Name of the VPN gateway.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

แชร์ผ่าน

az network vpn-gateway connection vpn-site-link-conn

Commands

az network vpn-gateway connection vpn-site-link-conn add

Examples

Required Parameters

Optional Parameters

az network vpn-gateway connection vpn-site-link-conn list

Examples

Required Parameters

az network vpn-gateway connection vpn-site-link-conn remove

Examples

Required Parameters

Optional Parameters

คำติชม