你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Set-AzureRmVirtualNetworkGateway

汇报虚拟网络网关。

警告

截至 2024 年 2 月 29 日,AzureRM PowerShell 模块已正式弃用。 为了确保持续获得支持和更新,建议用户从 AzureRM 迁移到 Az PowerShell 模块。

尽管 AzureRM 模块仍可能正常运行,但它不再维护或受支持,但会根据用户的自由裁量权和风险继续使用任何继续使用模块。 有关过渡到 Az 模块的指导,请参阅我们的迁移资源

语法

Set-AzureRmVirtualNetworkGateway
   -VirtualNetworkGateway <PSVirtualNetworkGateway>
   [-GatewaySku <String>]
   [-GatewayDefaultSite <PSLocalNetworkGateway>]
   [-VpnClientAddressPool <System.Collections.Generic.List`1[System.String]>]
   [-VpnClientProtocol <System.Collections.Generic.List`1[System.String]>]
   [-VpnClientRootCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate]>]
   [-VpnClientRevokedCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate]>]
   [-VpnClientIpsecPolicy <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy]>]
   [-Asn <UInt32>]
   [-PeerWeight <Int32>]
   [-EnableActiveActiveFeature]
   [-DisableActiveActiveFeature]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmVirtualNetworkGateway
   -VirtualNetworkGateway <PSVirtualNetworkGateway>
   [-GatewaySku <String>]
   [-GatewayDefaultSite <PSLocalNetworkGateway>]
   [-VpnClientAddressPool <System.Collections.Generic.List`1[System.String]>]
   [-VpnClientProtocol <System.Collections.Generic.List`1[System.String]>]
   [-VpnClientRootCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate]>]
   [-VpnClientRevokedCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate]>]
   [-VpnClientIpsecPolicy <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy]>]
   [-Asn <UInt32>]
   [-PeerWeight <Int32>]
   [-EnableActiveActiveFeature]
   [-DisableActiveActiveFeature]
   -RadiusServerAddress <String>
   -RadiusServerSecret <SecureString>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

Set-AzureRmVirtualNetworkGateway cmdlet 更新虚拟网络网关。

示例

示例 1:设置虚拟网络网关的目标状态

PS C:\>$Gateway = Get-AzureRmVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001"
PS C:\> Set-AzureRmVirtualNetworkGateway -VirtualNetworkGateway $Gateway -Asn 1337

第一个命令获取一个名为 Gateway01 的虚拟网络网关,该网关属于资源组 ResourceGroup001,并将其存储在名为“$Gateway”的变量中。第二个命令为存储在变量$Gateway中的虚拟网络网关设置目标状态。 该命令还将 ASN 设置为 1337。

示例 2:设置虚拟网络网关的目标状态

PS C:\>$Gateway = Get-AzureRmVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001"
PS C:\> $vpnclientipsecpolicy = New-AzureRmVpnClientIpsecPolicy -IpsecEncryption AES256 -IpsecIntegrity SHA256 -SALifeTimeSeconds 86472 -SADataSizeKilobytes 429497 -IkeEncryption AES256 -IkeIntegrity SHA256 -DhGroup DHGroup2 -PfsGroup None
PS C:\> $gateway = Set-AzureRmVirtualNetworkGateway -VirtualNetworkGateway $Gateway -VpnClientIpsecPolicy $vpnclientipsecpolicy

第一个命令获取一个名为 Gateway01 的虚拟网络网关,该网关属于资源组 ResourceGroup001,并将其存储在名为$Gateway第二个命令创建的 Vpn ipsec 策略对象(根据指定的 ipsec 参数)。 第三个命令设置存储在变量$Gateway中的虚拟网络网关的目标状态。 该命令还设置虚拟网络网关上$vpnclientipsecpolicy对象中指定的自定义 vpn ipsec 策略。

参数

-AsJob

在后台运行 cmdlet

类型:SwitchParameter
Position:Named
默认值:None
必需:False
Accept pipeline input:False
Accept wildcard characters:False

-Asn

指定用于在 IPsec 隧道内设置边界网关协议(BGP)会话的虚拟网络网关自治系统编号(ASN)。

类型:UInt32
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

提示你在运行 cmdlet 之前进行确认。

类型:SwitchParameter
Aliases:cf
Position:Named
默认值:None
必需:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

类型:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
默认值:None
必需:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableActiveActiveFeature

禁用主动-主动功能。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
Accept pipeline input:False
Accept wildcard characters:False

-EnableActiveActiveFeature

启用主动-主动功能。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
Accept pipeline input:False
Accept wildcard characters:False

-GatewayDefaultSite

指定要用于强制隧道的默认站点。 如果指定了默认站点,来自网关的虚拟专用网络(VPN)的所有 Internet 流量将路由到该站点。

类型:PSLocalNetworkGateway
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-GatewaySku

指定虚拟网络网关的库存单位(SKU)。 此参数的可接受值为:

  • 基本
  • Standard
  • HighPerformance
  • VpnGw1
  • VpnGw2
  • VpnGw3
  • VpnGw1AZ
  • VpnGw2AZ
  • VpnGw3AZ
  • ErGw1AZ
  • ErGw2AZ
  • ErGw3AZ
类型:String
接受的值:Basic, Standard, HighPerformance, UltraPerformance, VpnGw1, VpnGw2, VpnGw3, VpnGw1AZ, VpnGw2AZ, VpnGw3AZ, ErGw1AZ, ErGw2AZ, ErGw3AZ
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-PeerWeight

指定从此虚拟网络网关通过 BGP 学习的路由添加的权重

类型:Int32
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-RadiusServerAddress

P2S 外部 Radius 服务器地址。

类型:String
Position:Named
默认值:None
必需:True
Accept pipeline input:True
Accept wildcard characters:False

-RadiusServerSecret

P2S 外部 Radius 服务器机密。

类型:SecureString
Position:Named
默认值:None
必需:True
Accept pipeline input:True
Accept wildcard characters:False

-VirtualNetworkGateway

指定要基于其进行基本修改的虚拟网络网关对象。 可以使用 Get-AzureRmVirtualNetworkGateway cmdlet 获取虚拟网络网关对象。

类型:PSVirtualNetworkGateway
Position:Named
默认值:None
必需:True
Accept pipeline input:True
Accept wildcard characters:False

-VpnClientAddressPool

指定此 cmdlet 用于分配 VPN 客户端 IP 地址的地址空间。 这不应与虚拟网络或本地范围重叠。

类型:List<T>[String]
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-VpnClientIpsecPolicy

P2S VPN 客户端隧道协议的 IPSec 策略列表。

类型:List<T>[PSIpsecPolicy]
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-VpnClientProtocol

P2S VPN 客户端隧道协议列表

类型:List<T>[String]
接受的值:SSTP, IkeV2, OpenVPN
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-VpnClientRevokedCertificates

指定已吊销的 VPN 客户端证书的列表。 将删除一个与其中一个匹配的证书的 VPN 客户端。

类型:List<T>[PSVpnClientRevokedCertificate]
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-VpnClientRootCertificates

指定要用于 VPN 客户端身份验证的 VPN 客户端根证书的列表。 连接 VPN 客户端必须提供从其中一个根证书生成的证书。

类型:List<T>[PSVpnClientRootCertificate]
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
Aliases:wi
Position:Named
默认值:None
必需:False
Accept pipeline input:False
Accept wildcard characters:False

输入

PSVirtualNetworkGateway

参数:VirtualNetworkGateway (ByValue)

String

PSLocalNetworkGateway

List<T>[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

List<T>[[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]]

List<T>[[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]]

List<T>[[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]]

UInt32

Int32

SecureString

输出

PSVirtualNetworkGateway

备注

  • 关键字:azure, azurerm, arm, 资源, 管理, 经理, 网络, 网络