您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

az network vpn-gateway connection

备注

此引用是 Azure CLI 的 虚拟广域网 扩展的一部分,需要2.0.67 或更高版本。 首次运行 az 网络 vpn 网关连接 命令时,该扩展将自动安装。 详细了解扩展。

管理站点到站点 VPN 网关连接。

命令

az network vpn-gateway connection create

创建站点到站点 VPN 网关连接。

az network vpn-gateway connection delete

删除站点到站点 VPN 网关连接。

az network vpn-gateway connection ipsec-policy

管理站点到站点 VPN 网关连接 IPSec 策略。

az network vpn-gateway connection ipsec-policy add

将 IPSec 策略添加到站点到站点 VPN 网关连接。

az network vpn-gateway connection ipsec-policy list

列出站点到站点 VPN 网关连接 IPSec 策略。

az network vpn-gateway connection ipsec-policy remove

从站点到站点 VPN 网关连接中删除 IPSec 策略。

az network vpn-gateway connection list

列出站点到站点 VPN 网关连接。

az network vpn-gateway connection show

获取站点到站点 VPN 网关连接的详细信息。

az network vpn-gateway connection update

更新 VPN 网关连接的设置。

az network vpn-gateway connection wait

将 CLI 置于等待状态,直到满足站点到站点 VPN 网关连接的条件。

az network vpn-gateway connection create

创建站点到站点 VPN 网关连接。

az network vpn-gateway connection create --gateway-name
                                         --name
                                         --remote-vpn-site
                                         --resource-group
                                         [--associated]
                                         [--connection-bandwidth]
                                         [--enable-bgp {false, true}]
                                         [--internet-security {false, true}]
                                         [--labels]
                                         [--no-wait]
                                         [--propagated]
                                         [--protocol-type {IKEv1, IKEv2}]
                                         [--rate-limiting {false, true}]
                                         [--routing-weight]
                                         [--shared-key]

示例

创建站点到站点 VPN 网关连接

az network vpn-gateway connection create -g MyRG -n MyConnection --gateway-name MyGateway --remote-vpn-site /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/vpnSites/MyVPNSite --associated-route-table /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable1 --propagated-route-tables /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable1 /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable2 --labels label1 label2

必需参数

--gateway-name

VPN 网关的名称。

--name -n

VPN 网关连接的名称。

--remote-vpn-site

远程 VPN 站点的 ID 的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--associated --associated-route-table

与此路由配置关联的路由表的资源 id。

--connection-bandwidth

预期带宽(Mbps)。

--enable-bgp

启用 BGP。

接受的值: false, true
--internet-security

启用 internet 安全。

接受的值: false, true
--labels

传播路由表的标签的空格分隔列表。

--no-wait

不等待长时间运行的操作完成。

--propagated --propagated-route-tables

传播的路由表的资源 id 的空格分隔列表。

--protocol-type

连接协议。

接受的值: IKEv1, IKEv2
--rate-limiting

启用速率限制。

接受的值: false, true
--routing-weight

路由权重。

--shared-key

共享密钥。

az network vpn-gateway connection delete

删除站点到站点 VPN 网关连接。

az network vpn-gateway connection delete --gateway-name
                                         --name
                                         --resource-group

示例

删除站点到站点 VPN 网关连接

az network vpn-gateway connection delete -g MyRG -n MyConnection --gateway-name MyGateway

必需参数

--gateway-name

VPN 网关的名称。

--name -n

VPN 网关连接的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

az network vpn-gateway connection list

列出站点到站点 VPN 网关连接。

az network vpn-gateway connection list --gateway-name
                                       --resource-group

示例

列出给定站点到站点 VPN 网关的所有连接

az network vpn-gateway connection list -g MyRG --gateway-name MyGateway

必需参数

--gateway-name

VPN 网关的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

az network vpn-gateway connection show

获取站点到站点 VPN 网关连接的详细信息。

az network vpn-gateway connection show --gateway-name
                                       --name
                                       --resource-group

示例

获取站点到站点 VPN 网关连接的详细信息

az network vpn-gateway connection show -g MyRG -n MyConnection --gateway-name MyGateway

必需参数

--gateway-name

VPN 网关的名称。

--name -n

VPN 网关连接的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

az network vpn-gateway connection update

更新 VPN 网关连接的设置。

az network vpn-gateway connection update --gateway-name
                                         --name
                                         --resource-group
                                         [--add]
                                         [--associated]
                                         [--force-string]
                                         [--labels]
                                         [--no-wait]
                                         [--propagated]
                                         [--remove]
                                         [--set]

示例

更新 VPN 网关连接的设置。

az network vpn-gateway connection update -g MyRG -n MyConnection --gateway-name MyGateway --labels NewLabel1 NewLabels2

添加 VPN 网关连接的标签。

az network vpn-gateway connection update -g MyRG -n MyConnection --gateway-name MyGateway --add routingConfiguration.propagatedRouteTables.labels Newlabel1 Newlabel2

重置 VPN 网关连接的标签。

az network vpn-gateway connection update -g MyRG -n MyConnection --gateway-name MyGateway --set routingConfiguration.propagatedRouteTables.labels[0]=Newlabel1

必需参数

--gateway-name

VPN 网关的名称。

--name -n

VPN 网关连接的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--add

通过指定路径和键值对,将对象添加到对象列表中。 示例:--添加 listProperty <键 = 值、字符串或 JSON 字符串>。

--associated --associated-route-table

与此路由配置关联的路由表的资源 id。

--force-string

使用 "set" 或 "add" 时,保留字符串文本,而不是尝试转换为 JSON。

--labels

传播路由表的标签的空格分隔列表。

--no-wait

不等待长时间运行的操作完成。

--propagated --propagated-route-tables

传播的路由表的资源 id 的空格分隔列表。

--remove

从列表中删除属性或元素。 示例:--remove property. list 或--Remove propertyToRemove。

--set

通过指定要设置的属性路径和值来更新对象。 示例:--set property1. property2 =.

az network vpn-gateway connection wait

将 CLI 置于等待状态,直到满足站点到站点 VPN 网关连接的条件。

az network vpn-gateway connection wait --gateway-name
                                       --name
                                       --resource-group
                                       [--created]
                                       [--custom]
                                       [--deleted]
                                       [--exists]
                                       [--interval]
                                       [--timeout]
                                       [--updated]

必需参数

--gateway-name

VPN 网关的名称。

--name -n

VPN 网关连接的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--created

等待 "provisioningState" 在 "Succeeded" 处创建。

--custom

等到条件满足自定义 JMESPath 查询。 例如 provisioningState! = "InProgress",instanceView [? code = = ' PowerState/正在运行 ']。

--deleted

等待,直到被删除。

--exists

等待该资源存在。

--interval

轮询间隔(秒)。

默认值: 30
--timeout

最长等待时间(秒)。

默认值: 3600
--updated

请等待,直到在 "Succeeded" 中更新 provisioningState。