Set-AzVirtualNetworkGateway

模組:: Az.Network Module

更新虛擬網路閘道。

語法

Default (預設值)

Set-AzVirtualNetworkGateway
    -VirtualNetworkGateway <PSVirtualNetworkGateway>
    [-GatewaySku <String>]
    [-GatewayDefaultSite <PSLocalNetworkGateway>]
    [-VpnClientAddressPool <String[]>]
    [-VpnClientProtocol <String[]>]
    [-VpnAuthenticationType <String[]>]
    [-VpnClientRootCertificates <PSVpnClientRootCertificate[]>]
    [-VpnClientRevokedCertificates <PSVpnClientRevokedCertificate[]>]
    [-VpnClientIpsecPolicy <PSIpsecPolicy[]>]
    [-Asn <UInt32>]
    [-PeerWeight <Int32>]
    [-IpConfigurationBgpPeeringAddresses <PSIpConfigurationBgpPeeringAddress[]>]
    [-EnableActiveActiveFeature]
    [-EnablePrivateIpAddress <Boolean>]
    [-DisableActiveActiveFeature]
    [-RadiusServerAddress <String>]
    [-RadiusServerSecret <SecureString>]
    [-RadiusServerList <PSRadiusServer[]>]
    [-AadTenantUri <String>]
    [-AadAudienceId <String>]
    [-AadIssuerUri <String>]
    [-RemoveAadAuthentication]
    [-CustomRoute <String[]>]
    [-NatRule <PSVirtualNetworkGatewayNatRule[]>]
    [-BgpRouteTranslationForNat <Boolean>]
    [-MinScaleUnit <Int32>]
    [-MaxScaleUnit <Int32>]
    [-VirtualNetworkGatewayPolicyGroup <PSVirtualNetworkGatewayPolicyGroup[]>]
    [-ClientConnectionConfiguration <PSClientConnectionConfiguration[]>]
    [-AdminState <String>]
    [-AllowRemoteVnetTraffic <Boolean>]
    [-ResiliencyModel <String>]
    [-AllowVirtualWanTraffic <Boolean>]
    [-UserAssignedIdentityId <String>]
    [-Identity <PSManagedServiceIdentity>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateResourceWithTags

Set-AzVirtualNetworkGateway
    -VirtualNetworkGateway <PSVirtualNetworkGateway>
    -Tag <Hashtable>
    [-GatewaySku <String>]
    [-GatewayDefaultSite <PSLocalNetworkGateway>]
    [-VpnClientAddressPool <String[]>]
    [-VpnClientProtocol <String[]>]
    [-VpnAuthenticationType <String[]>]
    [-VpnClientRootCertificates <PSVpnClientRootCertificate[]>]
    [-VpnClientRevokedCertificates <PSVpnClientRevokedCertificate[]>]
    [-VpnClientIpsecPolicy <PSIpsecPolicy[]>]
    [-Asn <UInt32>]
    [-PeerWeight <Int32>]
    [-IpConfigurationBgpPeeringAddresses <PSIpConfigurationBgpPeeringAddress[]>]
    [-EnableActiveActiveFeature]
    [-EnablePrivateIpAddress <Boolean>]
    [-DisableActiveActiveFeature]
    [-RadiusServerAddress <String>]
    [-RadiusServerSecret <SecureString>]
    [-RadiusServerList <PSRadiusServer[]>]
    [-AadTenantUri <String>]
    [-AadAudienceId <String>]
    [-AadIssuerUri <String>]
    [-RemoveAadAuthentication]
    [-CustomRoute <String[]>]
    [-NatRule <PSVirtualNetworkGatewayNatRule[]>]
    [-BgpRouteTranslationForNat <Boolean>]
    [-MinScaleUnit <Int32>]
    [-MaxScaleUnit <Int32>]
    [-VirtualNetworkGatewayPolicyGroup <PSVirtualNetworkGatewayPolicyGroup[]>]
    [-ClientConnectionConfiguration <PSClientConnectionConfiguration[]>]
    [-AdminState <String>]
    [-AllowRemoteVnetTraffic <Boolean>]
    [-ResiliencyModel <String>]
    [-AllowVirtualWanTraffic <Boolean>]
    [-UserAssignedIdentityId <String>]
    [-Identity <PSManagedServiceIdentity>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Set-AzVirtualNetworkGateway Cmdlet 會更新虛擬網路閘道。

範例

範例 1：更新虛擬網路閘道的 ASN

$Gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001"
Set-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway -Asn 1337

第一個命令會取得屬於資源群組 ResourceGroup001 的名為 Gateway01 的虛擬網路閘道，並將它儲存至名為 $Gateway 的變數第二個命令會更新儲存在變數 $Gateway 中的虛擬網路閘道。此命令也會將 ASN 設定為 1337。

範例 2：將 IPsec 原則新增至虛擬網路閘道

$Gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001"
$vpnclientipsecpolicy = New-AzVpnClientIpsecPolicy -IpsecEncryption AES256 -IpsecIntegrity SHA256 -SALifeTime 86472 -SADataSize 429497 -IkeEncryption AES256 -IkeIntegrity SHA256 -DhGroup DHGroup2 -PfsGroup None
Set-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway -VpnClientIpsecPolicy $vpnclientipsecpolicy

第一個命令會取得屬於資源群組 ResourceGroup001 的名為 Gateway01 的虛擬網路閘道，並將它儲存至名為 $Gateway的變數第二個命令會根據指定的 ipsec 參數建立 Vpn ipsec 原則物件。第三個命令會更新儲存在變數$Gateway中的虛擬網路閘道。此命令也會設定虛擬網路閘道上 $vpnclientipsecpolicy 物件中指定的自訂 vpn ipsec 原則。

範例 3：將標籤新增至現有的虛擬網路閘道

$Gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001"
Set-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway -Tag @{ testtagKey="SomeTagKey"; testtagValue="SomeKeyValue" }

Name                   : Gateway001
ResourceGroupName      : ResourceGroup001
Location               : westus
Id                     : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001
Etag                   : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid           : 00000000-0000-0000-0000-000000000000
ProvisioningState      : Succeeded
Tags                   :
                         Name          Value
                         ============  ============
                         testtagValue  SomeKeyValue
                         testtagKey    SomeTagKey

IpConfigurations       : [
                           {
                             "PrivateIpAllocationMethod": "Dynamic",
                             "Subnet": {
                               "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworks/MyVnet/subnets/GatewaySubnet"
                             },
                             "PublicIpAddress": {
                               "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup001/providers/Microsoft.Network/publicIPAddresses/Gateway001Ip"
                             },
                             "Name": "vng1ipConfig",
                             "Etag": "W/\"00000000-0000-0000-0000-000000000000\"",
                             "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/ipConfigurations/Gateway001IpConfig"
                           }
                         ]
GatewayType            : Vpn
VpnType                : RouteBased
EnableBgp              : False
ActiveActive           : False
GatewayDefaultSite     : null
Sku                    : {
                           "Capacity": 2,
                           "Name": "VpnGw1",
                           "Tier": "VpnGw1"
                         }
VpnClientConfiguration : null
BgpSettings            : {
                           "Asn": 65515,
                           "BgpPeeringAddress": "1.2.3.4",
                           "PeerWeight": 0
                         }

第一個命令會取得屬於資源群組 ResourceGroup001 的名為 Gateway01 的虛擬網路閘道，並將它儲存至名為 $Gateway的變數第二個命令會使用標籤 @{ testtagKey=“SomeTagKey”; testtagValue=“SomeKeyValue” } 更新虛擬網路閘道 Gateway01。

範例 4：新增/更新現有虛擬網路閘道 VpnClient 的 AAD 驗證設定

$Gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001"
Set-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway -AadTenantUri "https://login.microsoftonline.com/0ab2c4f4-81e6-44cc-a0b2-b3a47a1443f4" -AadIssuerUri "https://sts.windows.net/0ab2c4f4-81e6-44cc-a0b2-b3a47a1443f4/" -AadAudienceId "a21fce82-76af-45e6-8583-a08cb3b956f9"

Name                   : Gateway001
ResourceGroupName      : ResourceGroup001
Location               : westus
Id                     : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001
Etag                   : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid           : 00000000-0000-0000-0000-000000000000
ProvisioningState      : Succeeded
Tags                   :
                         Name          Value
                         ============  ============
                         testtagValue  SomeKeyValue
                         testtagKey    SomeTagKey

IpConfigurations       : [
                           {
                             "PrivateIpAllocationMethod": "Dynamic",
                             "Subnet": {
                               "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworks/MyVnet/subnets/GatewaySubnet"
                             },
                             "PublicIpAddress": {
                               "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup001/providers/Microsoft.Network/publicIPAddresses/Gateway001Ip"
                             },
                             "Name": "vng1ipConfig",
                             "Etag": "W/\"00000000-0000-0000-0000-000000000000\"",
                             "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/ipConfigurations/Gateway001IpConfig"
                           }
                         ]
GatewayType            : Vpn
VpnType                : RouteBased
EnableBgp              : False
ActiveActive           : False
GatewayDefaultSite     : null
Sku                    : {
                           "Capacity": 2,
                           "Name": "VpnGw1",
                           "Tier": "VpnGw1"
                         }
vpnClientConfiguration : {
                    "vpnClientProtocols": [
					"OpenVPN"
					],

                    "vpnClientAddressPool": {
                    "addressPrefixes": [
                        "101.10.0.0/16"
                    ]
                	},
					"vpnClientRootCertificates": "",
                    "vpnClientRevokedCertificates": "",

                    "radiusServerAddress": "",
                    "radiusServerSecret": "",
					"aadTenantUri": "https://login.microsoftonline.com/0ab2c4f4-81e6-44cc-a0b2-b3a47a1443f4\",
					"aadAudienceId": "a21fce82-76af-45e6-8583-a08cb3b956g9\",
					"aadIssuerUri": "https://sts.windows.net/0ab2c4f4-81e6-44cc-a0b2-b3a47a1443f4/\"
                },
BgpSettings            : {
                           "Asn": 65515,
                           "BgpPeeringAddress": "1.2.3.4",
                           "PeerWeight": 0
                         }

Set-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway -VpnClientRootCertificates $rootCert -RemoveAadAuthentication

第一個命令會取得屬於資源群組 ResourceGroup001 的名為 Gateway01 的虛擬網路閘道，並將它儲存至名為 $Gateway第二個命令會使用 VpnClient 的 AAD 驗證設定參數更新虛擬網路閘道 Gateway01：aadTenantUri、aadAudienceId、aadIssuerUri。第三個命令會從虛擬網路閘道的 VpnClient 移除 AAD 驗證設定。

範例 5：將 IpConfigurationBgpPeeringAddresses 新增至現有的虛擬網路閘道

$Gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001"
$ipconfigurationId1 = '/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/ipConfigurations/default'
$addresslist1 = @('169.254.21.25')
$gw1ipconfBgp1 = New-AzIpConfigurationBgpPeeringAddressObject -IpConfigurationId $ipconfigurationId1 -CustomAddress $addresslist1
Set-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway -IpConfigurationBgpPeeringAddresses $gw1ipconfBgp1

Name                   : Gateway001
ResourceGroupName      : ResourceGroup001
Location               : westcentralus
Id                     : /subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001
Etag                   : W/"a08f13d3-6106-44e0-9127-e35e6f9793d5"
ResourceGuid           : 30993429-a1ed-42ca-9862-9156b013626e
ProvisioningState      : Succeeded
Tags                   :
IpConfigurations       : [
                           {
                             "PrivateIpAllocationMethod": "Dynamic",
                             "Subnet": {
                               "Id": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworks/newApipaNet/subnets/GatewaySubnet"
                             },
                             "PublicIpAddress": {
                               "Id": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/publicIPAddresses/newapipaip"
                             },
                             "Name": "default",
                             "Etag": "W/\"a08f13d3-6106-44e0-9127-e35e6f9793d5\"",
                             "Id": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/ipConfigurations/default"
                           }
                         ]
GatewayType            : Vpn
VpnType                : RouteBased
EnableBgp              : False
ActiveActive           : False
GatewayDefaultSite     : null
Sku                    : {
                           "Capacity": 2,
                           "Name": "VpnGw1",
                           "Tier": "VpnGw1"
                         }
VpnClientConfiguration : null
BgpSettings            : {
                           "Asn": 65515,
                           "BgpPeeringAddress": "10.1.255.30",
                           "PeerWeight": 0,
                           "BgpPeeringAddresses": [
                             {
                               "IpconfigurationId": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/ipConfigurations/default",
                               "DefaultBgpIpAddresses": [
                                 "10.1.255.30"
                               ],
                               "CustomBgpIpAddresses": [
                                 "169.254.21.55"
                               ],
                               "TunnelIpAddresses": [
                                 "13.78.146.151"
                               ]
                             }
                           ]
                         }

第一個命令會取得屬於資源群組 ResourceGroup001 的名為 Gateway01 的虛擬網路閘道，並將它儲存至名為 $Gateway的變數第二個命令會將虛擬網路閘道 Gateway01 IpConfiguration Id 的值指派給變數 ipconfigurationId1。第三個命令將地址列表分配到 addresslist1 中。第四個命令會建立 PSIpConfigurationBgpPeeringAddress 物件。第五個命令將此新建立的 PSIpConfigurationBgpPeeringAddress 設定為 IpConfigurationBgpPeeringAddresses，並更新閘道。

範例 6：將 CustomAddress 更新/移除為虛擬網路閘道的現有 IpConfigurationBgpPeeringAddresses

$Gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001"
$ipconfigurationId1 = '/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/ipConfigurations/default'
$addresslist1 = @()
$gw1ipconfBgp1 = New-AzIpConfigurationBgpPeeringAddressObject -IpConfigurationId $ipconfigurationId1 -CustomAddress $addresslist1
Set-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway -IpConfigurationBgpPeeringAddresses $gw1ipconfBgp1

Name                   : Gateway001
ResourceGroupName      : ResourceGroup001
Location               : westcentralus
Id                     : /subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001
Etag                   : W/"a08f13d3-6106-44e0-9127-e35e6f9793d5"
ResourceGuid           : 30993429-a1ed-42ca-9862-9156b013626e
ProvisioningState      : Succeeded
Tags                   :
IpConfigurations       : [
                           {
                             "PrivateIpAllocationMethod": "Dynamic",
                             "Subnet": {
                               "Id": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworks/newApipaNet/subnets/GatewaySubnet"
                             },
                             "PublicIpAddress": {
                               "Id": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/publicIPAddresses/newapipaip"
                             },
                             "Name": "default",
                             "Etag": "W/\"a08f13d3-6106-44e0-9127-e35e6f9793d5\"",
                             "Id": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/ipConfigurations/default"
                           }
                         ]
GatewayType            : Vpn
VpnType                : RouteBased
EnableBgp              : False
ActiveActive           : False
GatewayDefaultSite     : null
Sku                    : {
                           "Capacity": 2,
                           "Name": "VpnGw1",
                           "Tier": "VpnGw1"
                         }
VpnClientConfiguration : null
BgpSettings            : {
                           "Asn": 65515,
                           "BgpPeeringAddress": "10.1.255.30",
                           "PeerWeight": 0,
                           "BgpPeeringAddresses": [
                             {
                               "IpconfigurationId": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/ipConfigurations/default",
                               "DefaultBgpIpAddresses": [
                                 "10.1.255.30"
                               ],
                               "CustomBgpIpAddresses": [],
                               "TunnelIpAddresses": [
                                 "13.78.146.151"
                               ]
                             }
                           ]
                         }

範例 7：將 NatRules 新增至現有的虛擬網路閘道

$Gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001"
$vngNatRules = $Gateway.NatRules
$natRule = New-AzVirtualNetworkGatewayNatRule -Name "natRule1" -Type "Static" -Mode "IngressSnat" -InternalMapping @("25.0.0.0/16") -ExternalMapping @("30.0.0.0/16")
$vngNatRules.Add($natrule)
Set-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway -NatRule $vngNatRules.NatRules -BgpRouteTranslationForNat $true

Name                   : Gateway001
ResourceGroupName      : ResourceGroup001
Location               : westcentralus
Id                     : /subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001
Etag                   : W/"a08f13d3-6106-44e0-9127-e35e6f9793d5"
ResourceGuid           : 30993429-a1ed-42ca-9862-9156b013626e
ProvisioningState      : Succeeded
Tags                   :
IpConfigurations       : [
                           {
                             "PrivateIpAllocationMethod": "Dynamic",
                             "Subnet": {
                               "Id": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworks/newApipaNet/subnets/GatewaySubnet"
                             },
                             "PublicIpAddress": {
                               "Id": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/publicIPAddresses/newapipaip"
                             },
                             "Name": "default",
                             "Etag": "W/\"a08f13d3-6106-44e0-9127-e35e6f9793d5\"",
                             "Id": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/ipConfigurations/default"
                           }
                         ]
GatewayType            : Vpn
VpnType                : RouteBased
EnableBgp              : False
ActiveActive           : False
GatewayDefaultSite     : null
Sku                    : {
                           "Capacity": 2,
                           "Name": "VpnGw1",
                           "Tier": "VpnGw1"
                         }
VpnClientConfiguration : null
BgpSettings            : {
                           "Asn": 65515,
                           "BgpPeeringAddress": "10.1.255.30",
                           "PeerWeight": 0,
                           "BgpPeeringAddresses": [
                             {
                               "IpconfigurationId": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/ipConfigurations/default",
                               "DefaultBgpIpAddresses": [
                                 "10.1.255.30"
                               ],
                               "CustomBgpIpAddresses": [
                                 "169.254.21.55"
                               ],
                               "TunnelIpAddresses": [
                                 "13.78.146.151"
                               ]
                             }
                           ]
                         }
NatRules                        : [
                                    {
                                      "VirtualNetworkGatewayNatRulePropertiesType": "Static",
                                      "Mode": "IngressSnat",
                                      "InternalMappings": [
                                        {
                                          "AddressSpace": "25.0.0.0/16"
                                        }
                                      ],
                                      "ExternalMappings": [
                                        {
                                          "AddressSpace": "30.0.0.0/16"
                                        }
                                      ],
                                      "ProvisioningState": "Succeeded",
                                      "Name": "natRule1",
                                      "Etag": "W/\"5150d788-e165-42ba-99c4-8138a545fce9\"",
                                      "Id": "/subscriptions/59ac12a6-f2b7-46d4-af3d-98ba9d9dbd92/resourceGroups/ResourceGroup001/providers/Microsoft.Network/virtualNetworkGateways/Gateway001/natRules/natRule1"
                                    }
                                  ]
EnableBgpRouteTranslationForNat : True

第一個命令會取得屬於資源群組 ResourceGroup001 的名為 Gateway01 的虛擬網路閘道，並將它儲存至名為 $Gateway 的變數第二個命令會將現有的 natrules 指派給變數 vngNatRules。第三個命令會將新建立的值 PSVirtualNetworkGatewayNatRule 物件 natrule 指派給變數 natRule。第四個命令會將此 PSVirtualNetworkGatewayNatRule 物件新增至 vngNatRules 清單。第五個命令將此新建立的 PSVirtualNetworkGatewayNatRule 設定為閘道的 NatRules，並更新閘道。

範例 8：刪除現有虛擬網路閘道的多個過期 VpnClientRootCertificates

$Gateway=Get-AzVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001"

$rootCerts=$Gateway.VpnClientConfiguration.VpnClientRootCertificates

$rootCerts.Count
$rootCerts[0]
$rootCerts[1]
$rootCerts.Remove($rootCerts[1])

$Gateway1 = Set-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway -VpnClientRootCertificates $rootCerts

第一個命令會取得屬於資源群組 ResourceGroup001 的名為 Gateway01 的虛擬網路閘道，並將它儲存至名為 $Gateway 的變數第二個命令會取得 VirtualNetworkGateway 上的所有根憑證，並將它儲存至另一個變數 $rootCerts 第三個命令會顯示 VirtualNetworkGateway 上現有的根憑證總數。第四個和第五個命令在這些對應的索引處列印根證書，供客戶查看他們要刪除的證書。第六個命令使用該索引刪除過期的根憑證，例如此處的 1。重複相同的步驟，從變數中移除多個過期的憑證：$rootCerts 第七個命令會更新 VirtualNetworkGateway 以設定有效的根憑證，即存在於變數中的憑證：$rootCerts

範例 9：設定 ExpressRoute 虛擬網路閘道，以允許透過 ExpressRoute 與虛擬 WAN 網路中的其他 ExpressRoute 虛擬網路閘道進行通訊。

# Option 1 - Retrieve the gateway object, modify the property and save the changes.
$gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "resourceGroup001" -Name "gateway001"
$gateway.AllowVirtualWanTraffic = $true
$gateway = Set-AzVirtualNetworkGateway -VirtualNetworkGateway $gateway

# Option 2 - Use the cmdlet switch
$gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "resourceGroup001" -Name "gateway001"
Set-AzVirtualNetworkGateway -VirtualNetworkGateway $gateway -AllowVirtualWanTraffic $true

在這兩種情況下，第一個命令都會擷取閘道。然後，您可以直接修改物件上的屬性並保存它，也可以使用 Set-AzVirtualNetworkGateway Cmdlet 上的參數。

範例 10：設定 ExpressRoute 虛擬網路閘道，以封鎖透過 ExpressRoute 與虛擬 WAN 網路中其他 ExpressRoute 虛擬網路閘道的通訊。

# Option 1 - Retrieve the gateway object, modify the property and save the changes.
$gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "resourceGroup001" -Name "gateway001"
$gateway.AllowVirtualWanTraffic = $false
$gateway = Set-AzVirtualNetworkGateway -VirtualNetworkGateway $gateway

# Option 2 - Use the cmdlet switch
$gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "resourceGroup001" -Name "gateway001"
Set-AzVirtualNetworkGateway -VirtualNetworkGateway $gateway -AllowVirtualWanTraffic $false

在這兩種情況下，第一個命令都會擷取閘道。然後，您可以直接修改物件上的屬性並保存它，也可以使用 Set-AzVirtualNetworkGateway Cmdlet 上的參數。

範例 11：設定 ExpressRoute 虛擬網路閘道，以允許透過 ExpressRoute 與其他 VNet 中的其他 ExpressRoute 虛擬網路閘道進行通訊。

# Option 1 - Retrieve the gateway object, modify the property and save the changes.
$gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "resourceGroup001" -Name "gateway001"
$gateway.AllowRemoteVnetTraffic = $true
$gateway = Set-AzVirtualNetworkGateway -VirtualNetworkGateway $gateway

# Option 2 - Use the cmdlet switch
$gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "resourceGroup001" -Name "gateway001"
Set-AzVirtualNetworkGateway -VirtualNetworkGateway $gateway -AllowRemoteVnetTraffic $true

在這兩種情況下，第一個命令都會擷取閘道。然後，您可以直接修改物件上的屬性並保存它，也可以使用 Set-AzVirtualNetworkGateway Cmdlet 上的參數。

範例 12：設定 ExpressRoute 虛擬網路閘道，以封鎖透過 ExpressRoute 與其他 VNet 中的其他虛擬網路閘道進行通訊。

# Option 1 - Retrieve the gateway object, modify the property and save the changes.
$gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "resourceGroup001" -Name "gateway001"
$gateway.AllowRemoteVnetTraffic = $false
$gateway = Set-AzVirtualNetworkGateway -VirtualNetworkGateway $gateway

# Option 2 - Use the cmdlet switch
$gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "resourceGroup001" -Name "gateway001"
Set-AzVirtualNetworkGateway -VirtualNetworkGateway $gateway -AllowRemoteVnetTraffic $false

在這兩種情況下，第一個命令都會擷取閘道。然後，您可以直接修改物件上的屬性並保存它，也可以使用 Set-AzVirtualNetworkGateway Cmdlet 上的參數。

範例 13：使用使用者指派的受控識別設定虛擬網路閘道

# Create or retrieve the user-assigned managed identity
$identity = Get-AzUserAssignedIdentity -ResourceGroupName "resourceGroup001" -Name "myIdentity001"

# Get the virtual network gateway
$gateway = Get-AzVirtualNetworkGateway -ResourceGroupName "resourceGroup001" -Name "gateway001"

# Set the identity using the UserAssignedIdentityId parameter
Set-AzVirtualNetworkGateway -VirtualNetworkGateway $gateway -UserAssignedIdentityId $identity.Id

此範例示範如何使用使用者指派的受控識別來設定虛擬網路閘道。這會使用 UserAssignedIdentityId 參數來建立受控識別物件。使用者指派的身分識別對於存取 Azure 金鑰保存庫憑證以進行閘道驗證很有用。

參數

-AadAudienceId

P2S AAD 驗證選項：AadAudienceId。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-AadIssuerUri

P2S AAD 驗證選項：AadIssuerUri。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-AadTenantUri

P2S AAD 驗證選項：AadTenantUri。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-AdminState

屬性，指出 vnet 中有多個 Express Route 閘道時，Express Route 閘道是否提供流量：已啟用/已停用

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-AllowRemoteVnetTraffic

判斷此閘道是否應該接受來自其他 VNet 的流量。

參數屬性

類型:	Nullable<T>[Boolean]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-AllowVirtualWanTraffic

判斷此閘道是否應該接受來自其他虛擬 WAN 網路的流量。

參數屬性

類型:	Nullable<T>[Boolean]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-AsJob

在背景執行 Cmdlet

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Asn

虛擬網路閘道的 ASN，用來在 IPsec 通道內設定 BGP 工作階段

參數屬性

類型:	UInt32
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-BgpRouteTranslationForNat

這會在此 VirtualNetworkGateway 上啟用和停用 BgpRouteTranslationForNat

參數屬性

類型:	Nullable<T>[Boolean]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ClientConnectionConfiguration

地址和策略組之間關聯的P2S客戶端連線配置

參數屬性

類型:	PSClientConnectionConfiguration[]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-Confirm

在執行 Cmdlet 之前，提示您進行確認。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	參閱

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-CustomRoute

客戶指定的自訂路由 AddressPool

參數屬性

類型:	String[]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-DefaultProfile

用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。

參數屬性

類型:	IAzureContextContainer
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	AzContext, AzureRmContext, AzureCredential

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-DisableActiveActiveFeature

旗標以停用虛擬網路閘道上的作用中功能

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-EnableActiveActiveFeature

旗標以在虛擬網路閘道上啟用作用中功能

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-EnablePrivateIpAddress

旗標以在虛擬網路閘道上啟用作用中功能

參數屬性

類型:	Nullable<T>[Boolean]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-GatewayDefaultSite

用於強制通道的預設站台。如果指定預設月臺，則來自閘道 vnet 的所有因特網流量都會路由傳送至該月臺。

參數屬性

類型:	PSLocalNetworkGateway
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-GatewaySku

虛擬網路閘道的 SKU

參數屬性

類型:	String
預設值:	None
接受的值:	Basic, Standard, HighPerformance, UltraPerformance, VpnGw1, VpnGw2, VpnGw3, VpnGw4, VpnGw5, VpnGw1AZ, VpnGw2AZ, VpnGw3AZ, VpnGw4AZ, VpnGw5AZ, ErGw1AZ, ErGw2AZ, ErGw3AZ, ErGwScale
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-Identity

虛擬網路閘道的受控識別設定。

參數屬性

類型:	PSManagedServiceIdentity
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-IpConfigurationBgpPeeringAddresses

虛擬網路閘道 bgpsettings 的 BgpPeeringAddresses。

參數屬性

類型:	PSIpConfigurationBgpPeeringAddress[]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-MaxScaleUnit

設定可調整閘道的縮放單位上限

參數屬性

類型:	Int32
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-MinScaleUnit

設定可調整閘道的最小縮放單位

參數屬性

類型:	Int32
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-NatRule

虛擬網路閘道的 NatRules。

參數屬性

類型:	PSVirtualNetworkGatewayNatRule[]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-PeerWeight

新增至透過 BGP 從此虛擬網路閘道學習的路由的權重

參數屬性

類型:	Int32
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-RadiusServerAddress

P2S 外部 Radius 伺服器位址。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-RadiusServerList

P2S 多個外部 Radius 伺服器。

參數屬性

類型:	PSRadiusServer[]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-RadiusServerSecret

P2S 外部 Radius 伺服器密碼。

參數屬性

類型:	SecureString
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-RemoveAadAuthentication

旗標以從虛擬網路閘道移除 P2S 用戶端的 AAD 驗證。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ResiliencyModel

指示 Express Route 閘道上復原模型的屬性：SingleHomed/MultiHomed

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-Tag

P2S 外部 Radius 伺服器位址。

參數屬性

類型:	Hashtable
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

UpdateResourceWithTags

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-UserAssignedIdentityId

要指派給虛擬網路閘道之使用者指派身分識別的 ResourceId。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	UserAssignedIdentity

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-VirtualNetworkGateway

要以修改為基礎的虛擬網路閘道物件。這可以使用 Get-AzVirtualNetworkGateway

參數屬性

類型:	PSVirtualNetworkGateway
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	True
來自管線的值:	True
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-VirtualNetworkGatewayPolicyGroup

已新增至此閘道的 P2S 原則群組

參數屬性

類型:	PSVirtualNetworkGatewayPolicyGroup[]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-VpnAuthenticationType

P2S VPN 用戶端驗證型別清單。

參數屬性

類型:	String[]
預設值:	None
接受的值:	Certificate, Radius, AAD
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-VpnClientAddressPool

要從中配置 VPN 用戶端 IP 位址的位址空間。這不應與虛擬網路或內部部署範圍重疊。

參數屬性

類型:	String[]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-VpnClientIpsecPolicy

P2S VPN 用戶端通道通訊協定的 IPSec 原則清單。

參數屬性

類型:	PSIpsecPolicy[]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-VpnClientProtocol

P2S VPN 用戶端通道通訊協定清單

參數屬性

類型:	String[]
預設值:	None
接受的值:	SSTP, IkeV2, OpenVPN
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-VpnClientRevokedCertificates

已撤銷的 VPN 用戶端憑證清單。提供與其中之一匹配的證書的 VPN 客戶端將被告知消失。

參數屬性

類型:	PSVpnClientRevokedCertificate[]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-VpnClientRootCertificates

用於 VPN 用戶端驗證的 VPN 用戶端根憑證清單。連線的 VPN 用戶端必須提供從其中一個根憑證產生的憑證。

參數屬性

類型:	PSVpnClientRootCertificate[]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。指令未執行。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	威斯康星州

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

CommonParameters

此 Cmdlet 支援常見參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。如需詳細資訊，請參閱 about_CommonParameters。

共用方式為

Set-AzVirtualNetworkGateway

語法

Default (預設值)

UpdateResourceWithTags

Description

範例

範例 1：更新虛擬網路閘道的 ASN

範例 2：將 IPsec 原則新增至虛擬網路閘道

範例 3：將標籤新增至現有的虛擬網路閘道

範例 4：新增/更新現有虛擬網路閘道 VpnClient 的 AAD 驗證設定

範例 5：將 IpConfigurationBgpPeeringAddresses 新增至現有的虛擬網路閘道

範例 6：將 CustomAddress 更新/移除為虛擬網路閘道的現有 IpConfigurationBgpPeeringAddresses

範例 7：將 NatRules 新增至現有的虛擬網路閘道

範例 8：刪除現有虛擬網路閘道的多個過期 VpnClientRootCertificates

範例 9：設定 ExpressRoute 虛擬網路閘道，以允許透過 ExpressRoute 與虛擬 WAN 網路中的其他 ExpressRoute 虛擬網路閘道進行通訊。

範例 10：設定 ExpressRoute 虛擬網路閘道，以封鎖透過 ExpressRoute 與虛擬 WAN 網路中其他 ExpressRoute 虛擬網路閘道的通訊。

範例 11：設定 ExpressRoute 虛擬網路閘道，以允許透過 ExpressRoute 與其他 VNet 中的其他 ExpressRoute 虛擬網路閘道進行通訊。

範例 12：設定 ExpressRoute 虛擬網路閘道，以封鎖透過 ExpressRoute 與其他 VNet 中的其他虛擬網路閘道進行通訊。

範例 13：使用使用者指派的受控識別設定虛擬網路閘道

參數

-AadAudienceId

參數屬性

參數集

-AadIssuerUri

參數屬性

參數集

-AadTenantUri

參數屬性

參數集

-AdminState

參數屬性

參數集

-AllowRemoteVnetTraffic

參數屬性

參數集

-AllowVirtualWanTraffic

參數屬性

參數集

-AsJob

參數屬性

參數集

-Asn

參數屬性

參數集

-BgpRouteTranslationForNat

參數屬性

參數集

-ClientConnectionConfiguration

參數屬性

參數集

-Confirm

參數屬性

參數集

-CustomRoute

參數屬性

參數集

-DefaultProfile

參數屬性

參數集

-DisableActiveActiveFeature

參數屬性

參數集

-EnableActiveActiveFeature

參數屬性

參數集

-EnablePrivateIpAddress

參數屬性

參數集

-GatewayDefaultSite

參數屬性

參數集

-GatewaySku

參數屬性

參數集

-Identity

參數屬性

參數集

-IpConfigurationBgpPeeringAddresses

參數屬性