次の方法で共有

Set-AzVirtualNetworkGateway

  • リファレンス
モジュール:
Az.Network

仮想ネットワーク ゲートウェイを更新します。

構文

Set-AzVirtualNetworkGateway
   -VirtualNetworkGateway <PSVirtualNetworkGateway>
   [-GatewaySku <String>]
   [-GatewayDefaultSite <PSLocalNetworkGateway>]
   [-VpnClientAddressPool <String[]>]
   [-VpnClientProtocol <String[]>]
   [-VpnAuthenticationType <String[]>]
   [-VpnClientRootCertificates <PSVpnClientRootCertificate[]>]
   [-VpnClientRevokedCertificates <PSVpnClientRevokedCertificate[]>]
   [-VpnClientIpsecPolicy <PSIpsecPolicy[]>]
   [-Asn <UInt32>]
   [-PeerWeight <Int32>]
   [-MinScaleUnit <Int32>]
   [-MaxScaleUnit <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>]
   [-VirtualNetworkGatewayPolicyGroup <PSVirtualNetworkGatewayPolicyGroup[]>]
   [-ClientConnectionConfiguration <PSClientConnectionConfiguration[]>]
   [-AdminState <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
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>]
   [-VirtualNetworkGatewayPolicyGroup <PSVirtualNetworkGatewayPolicyGroup[]>]
   [-ClientConnectionConfiguration <PSClientConnectionConfiguration[]>]
   -Tag <Hashtable>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-AzVirtualNetworkGateway コマンドレットは、仮想ネットワーク ゲートウェイを更新します。

例

例 1: 仮想ネットワーク ゲートウェイの ASN を更新する

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

最初のコマンドは、リソース グループ ResourceGroup001 に属する Gateway01 という名前の仮想ネットワーク ゲートウェイを取得し、それを $Gateway という名前の変数に格納します。2 番目のコマンドは、変数$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 という名前の変数に格納します。2 番目のコマンドは、指定された ipsec パラメーターに従って Vpn ipsec ポリシー オブジェクトを作成します。 3 番目のコマンドは、変数 $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 という名前の変数に格納します。2 番目のコマンドは、タグ @{ 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 という名前の変数に格納します。2 番目のコマンドは、仮想ネットワーク ゲートウェイ Gateway01 を AAD 認証構成 params:aadTenantUri、aadAudienceId、aadIssuerUri for VpnClient で更新します。 3 番目のコマンドは、仮想ネットワーク ゲートウェイの 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 という名前の変数に格納します。2 番目のコマンドは、仮想ネットワーク ゲートウェイ Gateway01 IpConfiguration Id の値を変数 ipconfigurationId1 に割り当てます。 3 番目のコマンドは、アドレス一覧を addresslist1 に割り当てます。 4 番目のコマンドは、PSIpConfigurationBgpPeeringAddress オブジェクトを作成しました。 5 番目のコマンドは、この新しく作成された PSIpConfigurationBgpPeeringAddress を IpConfigurationBgpPeeringAddresses に設定し、ゲートウェイを更新します。

例 6: 仮想ネットワーク ゲートウェイの既存の IpConfigurationBgpPeeringAddresses に対する CustomAddress の更新/削除

$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"
                               ]
                             }
                           ]
                         }

最初のコマンドは、リソース グループ ResourceGroup001 に属する Gateway01 という名前の仮想ネットワーク ゲートウェイを取得し、それを $Gateway という名前の変数に格納します。2 番目のコマンドは、仮想ネットワーク ゲートウェイ Gateway01 IpConfiguration Id の値を変数 ipconfigurationId1 に割り当てます。 3 番目のコマンドは、アドレス一覧を addresslist1 に割り当てます。 4 番目のコマンドは、PSIpConfigurationBgpPeeringAddress オブジェクトを作成しました。 5 番目のコマンドは、この新しく作成された PSIpConfigurationBgpPeeringAddress を IpConfigurationBgpPeeringAddresses に設定し、ゲートウェイを更新します。

例 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 という名前の変数に格納します。2 番目のコマンドは、既存の natrules を変数 vngNatRules に割り当てます。 3 番目のコマンドは、新しく作成された PSVirtualNetworkGatewayNatRule オブジェクト natrule の値を変数 natRule に割り当てます。 4 番目のコマンドは、この PSVirtualNetworkGatewayNatRule オブジェクトを vngNatRules リストに追加します。 5 番目のコマンドは、この新しく作成された 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 という名前の変数に格納します。2 番目のコマンドは、VirtualNetworkGateway 上のすべてのルート証明書を取得し、別の変数に保存します$rootCerts 3 番目のコマンドは、VirtualNetworkGateway 上の既存のルート証明書の合計数を示します。 4 番目と 5 番目のコマンドは、顧客が削除するインデックスを確認するために、対応するインデックスにルート証明書を出力します。 6 番目のコマンドは、そのインデックスを使用して有効期限が切れたルート証明書を削除します (例: ここで 1)。 同じ手順を繰り返して、複数の期限切れの証明書を変数から削除します。$rootCerts 7 番目のコマンドは、VirtualNetworkGateway を更新して、有効なルート証明書 (つまり、変数に存在する証明書) を設定します$rootCerts

例 9: ExpressRoute 仮想ネットワーク ゲートウェイを構成して、Virtual Wan ネットワーク内の他の ExpressRoute 仮想ネットワーク ゲートウェイと 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 コマンドレットでスイッチを使用できます。

例 10: ExpressRoute 仮想ネットワーク ゲートウェイを構成して、Virtual Wan ネットワーク内の他の ExpressRoute 仮想ネットワーク ゲートウェイとの 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 コマンドレットでスイッチを使用できます。

例 11: ExpressRoute 仮想ネットワーク ゲートウェイを構成して、他の VNet 内の他の ExpressRoute 仮想ネットワーク ゲートウェイとの 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 コマンドレットでスイッチを使用できます。

例 12: 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 = $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 コマンドレットでスイッチを使用できます。

パラメーター

-AadAudienceId

P2S AAD 認証オプション:AadAudienceId。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-AadIssuerUri

P2S AAD 認証オプション:AadIssuerUri。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-AadTenantUri

P2S AAD 認証オプション:AadTenantUri。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-AsJob

バックグラウンドでコマンドレットを実行する

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Asn

仮想ネットワーク ゲートウェイの ASN。IPsec トンネル内で BGP セッションを設定するために使用されます

型:UInt32
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-BgpRouteTranslationForNat

これにより、この VirtualNetworkGateway で BgpRouteTranslationForNat が有効および無効になります。

型:Nullable<T>[Boolean]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ClientConnectionConfiguration

アドレスとポリシー グループの間で関連付けされる P2S クライアント接続の構成

型:PSClientConnectionConfiguration[]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:SwitchParameter
Aliases:cf
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-CustomRoute

顧客によって指定されたカスタム ルート AddressPool

型:String[]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

型:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DisableActiveActiveFeature

仮想ネットワーク ゲートウェイでアクティブなアクティブ機能を無効にするフラグ

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-EnableActiveActiveFeature

仮想ネットワーク ゲートウェイでアクティブなアクティブ機能を有効にするフラグ

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-EnablePrivateIpAddress

仮想ネットワーク ゲートウェイでアクティブなアクティブ機能を有効にするフラグ

型:Nullable<T>[Boolean]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-GatewayDefaultSite

強制トンネリングに使用する既定のサイト。 既定のサイトを指定すると、ゲートウェイの vnet からのすべてのインターネット トラフィックがそのサイトにルーティングされます。

型:PSLocalNetworkGateway
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-GatewaySku

仮想ネットワーク ゲートウェイの SKU

型:String
指定可能な値:Basic, Standard, HighPerformance, UltraPerformance, VpnGw1, VpnGw2, VpnGw3, VpnGw4, VpnGw5, VpnGw1AZ, VpnGw2AZ, VpnGw3AZ, VpnGw4AZ, VpnGw5AZ, ErGw1AZ, ErGw2AZ, ErGw3AZ
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-IpConfigurationBgpPeeringAddresses

仮想ネットワーク ゲートウェイ bgpsettings の BgpPeeringAddresses。

型:PSIpConfigurationBgpPeeringAddress[]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-NatRule

仮想ネットワーク ゲートウェイの NatRules。

型:PSVirtualNetworkGatewayNatRule[]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-PeerWeight

この仮想ネットワーク ゲートウェイから BGP 経由で学習されたルートに追加された重み

型:Int32
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-RadiusServerAddress

P2S 外部 Radius サーバー アドレス。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-RadiusServerList

P2S 複数の外部 Radius サーバー。

型:PSRadiusServer[]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-RadiusServerSecret

P2S 外部 Radius サーバー シークレット。

型:SecureString
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-RemoveAadAuthentication

仮想ネットワーク ゲートウェイから P2S クライアントの AAD 認証を削除するフラグ。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Tag

P2S 外部 Radius サーバー アドレス。

型:Hashtable
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-VirtualNetworkGateway

基本変更の対象となる仮想ネットワーク ゲートウェイ オブジェクト。 これは Get-AzVirtualNetworkGateway を使用して取得できます

型:PSVirtualNetworkGateway
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-VirtualNetworkGatewayPolicyGroup

このゲートウェイに追加された P2S ポリシー グループ

型:PSVirtualNetworkGatewayPolicyGroup[]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-VpnAuthenticationType

P2S VPN クライアント認証の種類の一覧。

型:String[]
指定可能な値:Certificate, Radius, AAD
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-VpnClientAddressPool

VPN クライアントの IP アドレスを割り当てるアドレス空間。 これは、仮想ネットワークまたはオンプレミスの範囲と重複しないようにする必要があります。

型:String[]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-VpnClientIpsecPolicy

P2S VPN クライアント トンネリング プロトコルの IPSec ポリシーの一覧。

型:PSIpsecPolicy[]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-VpnClientProtocol

P2S VPN クライアント トンネリング プロトコルの一覧

型:String[]
指定可能な値:SSTP, IkeV2, OpenVPN
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-VpnClientRevokedCertificates

失効した VPN クライアント証明書の一覧。 これらのいずれかに一致する証明書を提示する VPN クライアントは、退出するように伝えます。

型:PSVpnClientRevokedCertificate[]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-VpnClientRootCertificates

VPN クライアント認証に使用する VPN クライアント ルート証明書の一覧。 VPN クライアントに接続するには、これらのルート証明書のいずれかから生成された証明書を提示する必要があります。

型:PSVpnClientRootCertificate[]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

型:SwitchParameter
Aliases:wi
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

PSVirtualNetworkGateway

String

PSLocalNetworkGateway

String[]

PSVpnClientRootCertificate[]

PSVpnClientRevokedCertificate[]

PSIpsecPolicy[]

UInt32

Int32

PSIpConfigurationBgpPeeringAddress[]

SecureString

PSRadiusServer[]

PSVirtualNetworkGatewayNatRule[]

出力

PSVirtualNetworkGateway