Virtual Network Gateways - Get

Referenz

Dienst:: Network Gateway

API-Version:: 2023-11-01

Ruft das angegebene virtuelle Netzwerkgateway nach Ressourcengruppe ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}?api-version=2023-11-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
virtualNetworkGatewayName	path	True	string	Der Name des virtuellen Netzwerkgateways.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	VirtualNetworkGateway	Anforderung erfolgreich. Der Vorgang gibt eine VirtualNetworkGateway-Ressource zurück.
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

GetVirtualNetworkGateway

GetVirtualNetworkScalableGateway

GetVirtualNetworkGateway

Beispielanforderung

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw?api-version=2023-11-01


/**
 * Samples for VirtualNetworkGateways GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkGatewayGet.json
     */
    /**
     * Sample code: GetVirtualNetworkGateway.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getVirtualNetworkGateway(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualNetworkGateways().getByResourceGroupWithResponse("rg1",
            "vpngw", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python virtual_network_gateway_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.virtual_network_gateways.get(
        resource_group_name="rg1",
        virtual_network_gateway_name="vpngw",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkGatewayGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f4c6c8697c59f966db0d1e36b62df3af3bca9065/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkGatewayGet.json
func ExampleVirtualNetworkGatewaysClient_Get_getVirtualNetworkGateway() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVirtualNetworkGatewaysClient().Get(ctx, "rg1", "vpngw", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VirtualNetworkGateway = armnetwork.VirtualNetworkGateway{
	// 	Name: to.Ptr("vpngw"),
	// 	Type: to.Ptr("Microsoft.Network/virtualNetworkGateways"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw"),
	// 	Location: to.Ptr("centralus"),
	// 	Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
	// 	Properties: &armnetwork.VirtualNetworkGatewayPropertiesFormat{
	// 		Active: to.Ptr(false),
	// 		AllowRemoteVnetTraffic: to.Ptr(false),
	// 		AllowVirtualWanTraffic: to.Ptr(false),
	// 		BgpSettings: &armnetwork.BgpSettings{
	// 			Asn: to.Ptr[int64](65514),
	// 			BgpPeeringAddress: to.Ptr("10.0.1.30"),
	// 			BgpPeeringAddresses: []*armnetwork.IPConfigurationBgpPeeringAddress{
	// 				{
	// 					CustomBgpIPAddresses: []*string{
	// 						to.Ptr("169.254.21.10")},
	// 						DefaultBgpIPAddresses: []*string{
	// 							to.Ptr("10.3.1.254")},
	// 							IPConfigurationID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1"),
	// 							TunnelIPAddresses: []*string{
	// 								to.Ptr("52.161.10.135")},
	// 						}},
	// 						PeerWeight: to.Ptr[int32](0),
	// 					},
	// 					CustomRoutes: &armnetwork.AddressSpace{
	// 						AddressPrefixes: []*string{
	// 							to.Ptr("101.168.0.6/32")},
	// 						},
	// 						DisableIPSecReplayProtection: to.Ptr(false),
	// 						EnableBgp: to.Ptr(false),
	// 						EnableBgpRouteTranslationForNat: to.Ptr(false),
	// 						EnablePrivateIPAddress: to.Ptr(false),
	// 						GatewayType: to.Ptr(armnetwork.VirtualNetworkGatewayTypeVPN),
	// 						IPConfigurations: []*armnetwork.VirtualNetworkGatewayIPConfiguration{
	// 							{
	// 								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1"),
	// 								Name: to.Ptr("gwipconfig1"),
	// 								Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
	// 								Properties: &armnetwork.VirtualNetworkGatewayIPConfigurationPropertiesFormat{
	// 									PrivateIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodDynamic),
	// 									ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 									PublicIPAddress: &armnetwork.SubResource{
	// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"),
	// 									},
	// 									Subnet: &armnetwork.SubResource{
	// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"),
	// 									},
	// 								},
	// 						}},
	// 						NatRules: []*armnetwork.VirtualNetworkGatewayNatRule{
	// 							{
	// 								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1"),
	// 								Name: to.Ptr("natRule1"),
	// 								Etag: to.Ptr("W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\""),
	// 								Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
	// 									Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
	// 									ExternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 										{
	// 											AddressSpace: to.Ptr("50.0.0.0/24"),
	// 									}},
	// 									InternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 										{
	// 											AddressSpace: to.Ptr("10.10.0.0/24"),
	// 									}},
	// 									Mode: to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
	// 									ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 								},
	// 							},
	// 							{
	// 								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2"),
	// 								Name: to.Ptr("natRule2"),
	// 								Etag: to.Ptr("W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\""),
	// 								Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
	// 									Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
	// 									ExternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 										{
	// 											AddressSpace: to.Ptr("30.0.0.0/24"),
	// 									}},
	// 									InternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 										{
	// 											AddressSpace: to.Ptr("20.10.0.0/24"),
	// 									}},
	// 									Mode: to.Ptr(armnetwork.VPNNatRuleModeIngressSnat),
	// 									ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 								},
	// 						}},
	// 						ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 						ResourceGUID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 						SKU: &armnetwork.VirtualNetworkGatewaySKU{
	// 							Name: to.Ptr(armnetwork.VirtualNetworkGatewaySKUNameVPNGw1),
	// 							Capacity: to.Ptr[int32](0),
	// 							Tier: to.Ptr(armnetwork.VirtualNetworkGatewaySKUTierVPNGw1),
	// 						},
	// 						VPNClientConfiguration: &armnetwork.VPNClientConfiguration{
	// 							RadiusServers: []*armnetwork.RadiusServer{
	// 								{
	// 									RadiusServerAddress: to.Ptr("10.1.0.0"),
	// 									RadiusServerScore: to.Ptr[int64](20),
	// 							}},
	// 							VPNClientProtocols: []*armnetwork.VPNClientProtocol{
	// 								to.Ptr(armnetwork.VPNClientProtocolOpenVPN)},
	// 								VPNClientRevokedCertificates: []*armnetwork.VPNClientRevokedCertificate{
	// 								},
	// 								VPNClientRootCertificates: []*armnetwork.VPNClientRootCertificate{
	// 								},
	// 							},
	// 							VPNGatewayGeneration: to.Ptr(armnetwork.VPNGatewayGenerationNone),
	// 							VPNType: to.Ptr(armnetwork.VPNTypeRouteBased),
	// 						},
	// 					}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the specified virtual network gateway by resource group.
 *
 * @summary Gets the specified virtual network gateway by resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkGatewayGet.json
 */
async function getVirtualNetworkGateway() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualNetworkGatewayName = "vpngw";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualNetworkGateways.get(
    resourceGroupName,
    virtualNetworkGatewayName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:: 200

{
  "name": "vpngw",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw",
  "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
  "type": "Microsoft.Network/virtualNetworkGateways",
  "location": "centralus",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-000000000000",
    "ipConfigurations": [
      {
        "name": "gwipconfig1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1",
        "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAllocationMethod": "Dynamic",
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"
          },
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"
          }
        }
      }
    ],
    "natRules": [
      {
        "name": "natRule1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1",
        "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"",
        "properties": {
          "provisioningState": "Succeeded",
          "type": "Static",
          "mode": "EgressSnat",
          "internalMappings": [
            {
              "addressSpace": "10.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "50.0.0.0/24"
            }
          ]
        }
      },
      {
        "name": "natRule2",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2",
        "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"",
        "properties": {
          "provisioningState": "Succeeded",
          "type": "Static",
          "mode": "IngressSnat",
          "internalMappings": [
            {
              "addressSpace": "20.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "30.0.0.0/24"
            }
          ]
        }
      }
    ],
    "enableBgpRouteTranslationForNat": false,
    "sku": {
      "name": "VpnGw1",
      "tier": "VpnGw1",
      "capacity": 0
    },
    "gatewayType": "Vpn",
    "vpnType": "RouteBased",
    "vpnGatewayGeneration": "None",
    "enableBgp": false,
    "enablePrivateIpAddress": false,
    "activeActive": false,
    "disableIPSecReplayProtection": false,
    "vpnClientConfiguration": {
      "vpnClientProtocols": [
        "OpenVPN"
      ],
      "vpnClientRootCertificates": [],
      "vpnClientRevokedCertificates": [],
      "radiusServers": [
        {
          "radiusServerAddress": "10.1.0.0",
          "radiusServerScore": 20
        }
      ]
    },
    "bgpSettings": {
      "asn": 65514,
      "bgpPeeringAddress": "10.0.1.30",
      "peerWeight": 0,
      "bgpPeeringAddresses": [
        {
          "ipconfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1",
          "defaultBgpIpAddresses": [
            "10.3.1.254"
          ],
          "customBgpIpAddresses": [
            "169.254.21.10"
          ],
          "tunnelIpAddresses": [
            "52.161.10.135"
          ]
        }
      ]
    },
    "customRoutes": {
      "addressPrefixes": [
        "101.168.0.6/32"
      ]
    },
    "allowVirtualWanTraffic": false,
    "allowRemoteVnetTraffic": false
  }
}

GetVirtualNetworkScalableGateway

Beispielanforderung

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw?api-version=2023-11-01


/**
 * Samples for VirtualNetworkGateways GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/
     * VirtualNetworkScalableGatewayGet.json
     */
    /**
     * Sample code: GetVirtualNetworkScalableGateway.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getVirtualNetworkScalableGateway(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualNetworkGateways().getByResourceGroupWithResponse("rg1",
            "ergw", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python virtual_network_scalable_gateway_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.virtual_network_gateways.get(
        resource_group_name="rg1",
        virtual_network_gateway_name="ergw",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkScalableGatewayGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f4c6c8697c59f966db0d1e36b62df3af3bca9065/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkScalableGatewayGet.json
func ExampleVirtualNetworkGatewaysClient_Get_getVirtualNetworkScalableGateway() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVirtualNetworkGatewaysClient().Get(ctx, "rg1", "ergw", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VirtualNetworkGateway = armnetwork.VirtualNetworkGateway{
	// 	Name: to.Ptr("ergw"),
	// 	Type: to.Ptr("Microsoft.Network/virtualNetworkGateways"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw"),
	// 	Location: to.Ptr("centralus"),
	// 	Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
	// 	Properties: &armnetwork.VirtualNetworkGatewayPropertiesFormat{
	// 		Active: to.Ptr(false),
	// 		AllowRemoteVnetTraffic: to.Ptr(false),
	// 		AllowVirtualWanTraffic: to.Ptr(false),
	// 		AutoScaleConfiguration: &armnetwork.VirtualNetworkGatewayAutoScaleConfiguration{
	// 			Bounds: &armnetwork.VirtualNetworkGatewayAutoScaleBounds{
	// 				Max: to.Ptr[int32](3),
	// 				Min: to.Ptr[int32](2),
	// 			},
	// 		},
	// 		DisableIPSecReplayProtection: to.Ptr(false),
	// 		EnableBgp: to.Ptr(false),
	// 		EnableBgpRouteTranslationForNat: to.Ptr(false),
	// 		EnablePrivateIPAddress: to.Ptr(false),
	// 		GatewayType: to.Ptr(armnetwork.VirtualNetworkGatewayTypeExpressRoute),
	// 		IPConfigurations: []*armnetwork.VirtualNetworkGatewayIPConfiguration{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/ipConfigurations/default"),
	// 				Name: to.Ptr("gwipconfig1"),
	// 				Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
	// 				Properties: &armnetwork.VirtualNetworkGatewayIPConfigurationPropertiesFormat{
	// 					PrivateIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodStatic),
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 					PublicIPAddress: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"),
	// 					},
	// 					Subnet: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"),
	// 					},
	// 				},
	// 		}},
	// 		NatRules: []*armnetwork.VirtualNetworkGatewayNatRule{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule1"),
	// 				Name: to.Ptr("natRule1"),
	// 				Etag: to.Ptr("W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\""),
	// 				Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
	// 					Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
	// 					ExternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 						{
	// 							AddressSpace: to.Ptr("50.0.0.0/24"),
	// 					}},
	// 					InternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 						{
	// 							AddressSpace: to.Ptr("10.10.0.0/24"),
	// 					}},
	// 					Mode: to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 				},
	// 			},
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule2"),
	// 				Name: to.Ptr("natRule2"),
	// 				Etag: to.Ptr("W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\""),
	// 				Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
	// 					Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
	// 					ExternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 						{
	// 							AddressSpace: to.Ptr("30.0.0.0/24"),
	// 					}},
	// 					InternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 						{
	// 							AddressSpace: to.Ptr("20.10.0.0/24"),
	// 					}},
	// 					Mode: to.Ptr(armnetwork.VPNNatRuleModeIngressSnat),
	// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 				},
	// 		}},
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		ResourceGUID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		SKU: &armnetwork.VirtualNetworkGatewaySKU{
	// 			Name: to.Ptr(armnetwork.VirtualNetworkGatewaySKUNameErGwScale),
	// 			Capacity: to.Ptr[int32](2),
	// 			Tier: to.Ptr(armnetwork.VirtualNetworkGatewaySKUTierErGwScale),
	// 		},
	// 		VPNGatewayGeneration: to.Ptr(armnetwork.VPNGatewayGenerationNone),
	// 		VPNType: to.Ptr(armnetwork.VPNTypePolicyBased),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the specified virtual network gateway by resource group.
 *
 * @summary Gets the specified virtual network gateway by resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/VirtualNetworkScalableGatewayGet.json
 */
async function getVirtualNetworkScalableGateway() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualNetworkGatewayName = "ergw";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualNetworkGateways.get(
    resourceGroupName,
    virtualNetworkGatewayName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:: 200

{
  "name": "ergw",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw",
  "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
  "type": "Microsoft.Network/virtualNetworkGateways",
  "location": "centralus",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-000000000000",
    "ipConfigurations": [
      {
        "name": "gwipconfig1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/ipConfigurations/default",
        "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAllocationMethod": "Static",
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"
          },
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"
          }
        }
      }
    ],
    "natRules": [
      {
        "name": "natRule1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule1",
        "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"",
        "properties": {
          "provisioningState": "Succeeded",
          "type": "Static",
          "mode": "EgressSnat",
          "internalMappings": [
            {
              "addressSpace": "10.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "50.0.0.0/24"
            }
          ]
        }
      },
      {
        "name": "natRule2",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/natRules/natRule2",
        "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"",
        "properties": {
          "provisioningState": "Succeeded",
          "type": "Static",
          "mode": "IngressSnat",
          "internalMappings": [
            {
              "addressSpace": "20.10.0.0/24"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "30.0.0.0/24"
            }
          ]
        }
      }
    ],
    "enableBgpRouteTranslationForNat": false,
    "sku": {
      "name": "ErGwScale",
      "tier": "ErGwScale",
      "capacity": 2
    },
    "autoScaleConfiguration": {
      "bounds": {
        "min": 2,
        "max": 3
      }
    },
    "gatewayType": "ExpressRoute",
    "vpnType": "PolicyBased",
    "vpnGatewayGeneration": "None",
    "enableBgp": false,
    "enablePrivateIpAddress": false,
    "activeActive": false,
    "disableIPSecReplayProtection": false,
    "vpnClientConfiguration": null,
    "bgpSettings": null,
    "customRoutes": null,
    "allowVirtualWanTraffic": false,
    "allowRemoteVnetTraffic": false
  }
}

Definitionen

Name	Beschreibung
AddressSpace	AddressSpace enthält ein Array von IP-Adressbereichen, die von Subnetzen des virtuellen Netzwerks verwendet werden können.
adminState	Eigenschaft, die angibt, ob das Express Route Gateway Datenverkehr liefert, wenn mehrere ExpressRoute-Gateways im vnet vorhanden sind
BgpSettings	Details zu den BGP-Einstellungen.
CloudError	Eine Fehlerantwort des Diensts.
CloudErrorBody	Eine Fehlerantwort des Diensts.
DhGroup	Die DH-Gruppen, die in IKE Phase 1 für die erste SA verwendet werden.
ExtendedLocation	Komplexer ExtendedLocation-Typ.
ExtendedLocationTypes	Der Typ des erweiterten Speicherorts.
IkeEncryption	Der IKE-Verschlüsselungsalgorithmus (IKE Phase 2).
IkeIntegrity	Der IKE-Integritätsalgorithmus (IKE Phase 2).
IPAllocationMethod	IP-Adresszuweisungsmethode.
IPConfigurationBgpPeeringAddress	Eigenschaften von IPConfigurationBgpPeeringAddress.
IpsecEncryption	Der IPSec-Verschlüsselungsalgorithmus (IKE Phase 1).
IpsecIntegrity	Der IPSec-Integritätsalgorithmus (IKE Phase 1).
IpsecPolicy	Eine IPSec-Richtlinienkonfiguration für eine Verbindung mit einem virtuellen Netzwerkgateway.
PfsGroup	Die pfs Groups, die in IKE Phase 2 für neue untergeordnete SA verwendet werden.
ProvisioningState	Der aktuelle Bereitstellungsstatus.
RadiusServer	Radius-Servereinstellungen.
SubResource	Verweisen auf eine andere Unterressource.
VirtualNetworkGateway	Eine allgemeine Klasse für allgemeine Ressourceninformationen.
VirtualNetworkGatewayAutoScaleBounds
VirtualNetworkGatewayAutoScaleConfiguration	Details zur Autoskalenkonfiguration für virtuelles Netzwerkgateway
VirtualNetworkGatewayIPConfiguration	IP-Konfiguration für virtuelles Netzwerkgateway.
VirtualNetworkGatewayNatRule	VirtualNetworkGatewayNatRule-Ressource.
VirtualNetworkGatewayPolicyGroup	Parameter für VirtualNetworkGatewayPolicyGroup.
VirtualNetworkGatewayPolicyGroupMember	Mitglied "PolicyGroup" für die Vpn-Clientverbindungskonfiguration
VirtualNetworkGatewaySku	VirtualNetworkGatewaySku-Details.
VirtualNetworkGatewaySkuName	Gateway-SKU-Name.
VirtualNetworkGatewaySkuTier	Gateway-SKU-Ebene.
VirtualNetworkGatewayType	Der Typ dieses virtuellen Netzwerkgateways.
VngClientConnectionConfiguration	Eine VPN-Clientverbindungskonfiguration für die Clientverbindungskonfiguration.
VpnAuthenticationType	VPN-Authentifizierungstypen für das virtuelle Netzwerkgateway..
VpnClientConfiguration	VpnClientConfiguration für P2S-Client.
VpnClientProtocol	VpnClientProtocols für virtuelles Netzwerkgateway.
VpnClientRevokedCertificate	VPN-Client hat das Zertifikat des virtuellen Netzwerkgateways widerrufen.
VpnClientRootCertificate	VPN-Clientstammzertifikat des virtuellen Netzwerkgateways.
VpnGatewayGeneration	Die Generation für dieses VirtualNetworkGateway. Muss keine sein, wenn gatewayType kein VPN ist.
VpnNatRuleMapping	Vpn NatRule-Zuordnung.
VpnNatRuleMode	Die Quell-NAT-Richtung eines VPN-NAT.
VpnNatRuleType	Der Typ der NAT-Regel für VPN NAT.
VpnPolicyMemberAttributeType	Der Attributtyp des VPN-Richtlinienmitglieds.
VpnType	Der Typ dieses virtuellen Netzwerkgateways.

AddressSpace

AddressSpace enthält ein Array von IP-Adressbereichen, die von Subnetzen des virtuellen Netzwerks verwendet werden können.

Name	Typ	Beschreibung
addressPrefixes	string[]	Eine Liste von Adressblöcken, die für dieses virtuelle Netzwerk in CIDR-Notation reserviert sind.

adminState

Eigenschaft, die angibt, ob das Express Route Gateway Datenverkehr liefert, wenn mehrere ExpressRoute-Gateways im vnet vorhanden sind

Name	Typ	Beschreibung
Disabled	string
Enabled	string

BgpSettings

Details zu den BGP-Einstellungen.

Name	Typ	Beschreibung
asn	integer	Der ASN des BGP-Sprechers.
bgpPeeringAddress	string	Die BGP-Peeringadresse und der BGP-Bezeichner dieses BGP-Lautsprechers.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	BGP-Peeringadresse mit IP-Konfigurations-ID für virtuelles Netzwerkgateway.
peerWeight	integer	Das Gewicht, das zu Routen hinzugefügt wurde, die von diesem BGP-Lautsprecher gelernt wurden.

CloudError

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Cloudfehlertext.

CloudErrorBody

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

DhGroup

Die DH-Gruppen, die in IKE Phase 1 für die erste SA verwendet werden.

Name	Typ	Beschreibung
DHGroup1	string
DHGroup14	string
DHGroup2	string
DHGroup2048	string
DHGroup24	string
ECP256	string
ECP384	string
None	string

ExtendedLocation

Komplexer ExtendedLocation-Typ.

Name	Typ	Beschreibung
name	string	Der Name des erweiterten Speicherorts.
type	ExtendedLocationTypes	Der Typ des erweiterten Speicherorts.

ExtendedLocationTypes

Der Typ des erweiterten Speicherorts.

Name	Typ	Beschreibung
EdgeZone	string

IkeEncryption

Der IKE-Verschlüsselungsalgorithmus (IKE Phase 2).

Name	Typ	Beschreibung
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES256	string

IkeIntegrity

Der IKE-Integritätsalgorithmus (IKE Phase 2).

Name	Typ	Beschreibung
GCMAES128	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string
SHA384	string

IPAllocationMethod

IP-Adresszuweisungsmethode.

Name	Typ	Beschreibung
Dynamic	string
Static	string

IPConfigurationBgpPeeringAddress

Eigenschaften von IPConfigurationBgpPeeringAddress.

Name	Typ	Beschreibung
customBgpIpAddresses	string[]	Die Liste der benutzerdefinierten BGP-Peeringadressen, die zur IP-Konfiguration gehören.
defaultBgpIpAddresses	string[]	Die Liste der standardmäßigen BGP-Peeringadressen, die zur IP-Konfiguration gehören.
ipconfigurationId	string	Die ID der IP-Konfiguration, die zum Gateway gehört.
tunnelIpAddresses	string[]	Die Liste der öffentlichen Tunnel-IP-Adressen, die zur IP-Konfiguration gehören.

IpsecEncryption

Der IPSec-Verschlüsselungsalgorithmus (IKE Phase 1).

Name	Typ	Beschreibung
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES192	string
GCMAES256	string
None	string

IpsecIntegrity

Der IPSec-Integritätsalgorithmus (IKE Phase 1).

Name	Typ	Beschreibung
GCMAES128	string
GCMAES192	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string

IpsecPolicy

Eine IPSec-Richtlinienkonfiguration für eine Verbindung mit einem virtuellen Netzwerkgateway.

Name	Typ	Beschreibung
dhGroup	DhGroup	Die DH Group wurde in IKE Phase 1 für die erste SA verwendet.
ikeEncryption	IkeEncryption	Der IKE-Verschlüsselungsalgorithmus (IKE Phase 2).
ikeIntegrity	IkeIntegrity	Der IKE-Integritätsalgorithmus (IKE Phase 2).
ipsecEncryption	IpsecEncryption	Der IPSec-Verschlüsselungsalgorithmus (IKE Phase 1).
ipsecIntegrity	IpsecIntegrity	Der IPSec-Integritätsalgorithmus (IKE Phase 1).
pfsGroup	PfsGroup	Die Pfs Group, die in IKE Phase 2 für neue untergeordnete SA verwendet wird.
saDataSizeKilobytes	integer	Die Nutzlastgröße der IPSec-Sicherheitszuordnung (auch als Schnellmodus oder Phase 2 SA bezeichnet) in KB für einen Standort-zu-Standort-VPN-Tunnel.
saLifeTimeSeconds	integer	Die IPSec Security Association (auch als Schnellmodus oder Phase 2 SA bezeichnet) Lebensdauer in Sekunden für einen Standort-zu-Standort-VPN-Tunnel.

PfsGroup

Die pfs Groups, die in IKE Phase 2 für neue untergeordnete SA verwendet werden.

Name	Typ	Beschreibung
ECP256	string
ECP384	string
None	string
PFS1	string
PFS14	string
PFS2	string
PFS2048	string
PFS24	string
PFSMM	string

ProvisioningState

Der aktuelle Bereitstellungsstatus.

Name	Typ	Beschreibung
Deleting	string
Failed	string
Succeeded	string
Updating	string

RadiusServer

Radius-Servereinstellungen.

Name	Typ	Beschreibung
radiusServerAddress	string	Die Adresse dieses Radiusservers.
radiusServerScore	integer	Die anfängliche Bewertung, die diesem Radiusserver zugewiesen ist.
radiusServerSecret	string	Der geheime Schlüssel, der für diesen Radiusserver verwendet wird.

SubResource

Verweisen auf eine andere Unterressource.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.

VirtualNetworkGateway

Eine allgemeine Klasse für allgemeine Ressourceninformationen.

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
extendedLocation	ExtendedLocation	Der erweiterte Speicherort des Typs "Lokales virtuelles Netzwerkgateway".
id	string	Ressourcen-ID.
location	string	Ressourcenspeicherort.
name	string	Ressourcenname.
properties.activeActive	boolean	ActiveActive-Flag.
properties.adminState	adminState	Eigenschaft, die angibt, ob das Express Route Gateway Datenverkehr liefert, wenn mehrere ExpressRoute-Gateways im vnet vorhanden sind
properties.allowRemoteVnetTraffic	boolean	Konfigurieren Sie dieses Gateway so, dass Datenverkehr von anderen virtuellen Azure-Netzwerken akzeptiert wird. Diese Konfiguration unterstützt keine Verbindung mit Azure Virtual WAN.
properties.allowVirtualWanTraffic	boolean	Konfiguriert dieses Gateway so, dass Datenverkehr aus virtuellen WAN-Remotenetzwerken akzeptiert wird.
properties.autoScaleConfiguration	VirtualNetworkGatewayAutoScaleConfiguration	Autoskalenkonfiguration für virutales Netzwerkgateway
properties.bgpSettings	BgpSettings	BGP-Lautsprechereinstellungen des virtuellen Netzwerkgateways.
properties.customRoutes	AddressSpace	Der Verweis auf die Adressraumressource, die den vom Kunden angegebenen benutzerdefinierten Routenadressraum für virtuelles Netzwerkgateway und VpnClient darstellt.
properties.disableIPSecReplayProtection	boolean	disableIPSecReplayProtection-Flag.
properties.enableBgp	boolean	Gibt an, ob BGP für dieses virtuelle Netzwerkgateway aktiviert ist oder nicht.
properties.enableBgpRouteTranslationForNat	boolean	EnableBgpRouteTranslationForNat-Flag.
properties.enableDnsForwarding	boolean	Gibt an, ob die DNS-Weiterleitung aktiviert ist oder nicht.
properties.enablePrivateIpAddress	boolean	Gibt an, ob private IP für Verbindungen auf diesem Gateway aktiviert werden muss.
properties.gatewayDefaultSite	SubResource	Der Verweis auf die LocalNetworkGateway-Ressource, die den lokalen Netzwerkstandort mit Standardrouten darstellt. Weisen Sie null-Wert zu, wenn Sie vorhandene Standardwebsiteeinstellungen entfernen.
properties.gatewayType	VirtualNetworkGatewayType	Der Typ dieses virtuellen Netzwerkgateways.
properties.inboundDnsForwardingEndpoint	string	Die vom Gateway zugewiesene IP-Adresse, an die DNS-Anforderungen gesendet werden können.
properties.ipConfigurations	VirtualNetworkGatewayIPConfiguration[]	IP-Konfigurationen für virtuelles Netzwerkgateway.
properties.natRules	VirtualNetworkGatewayNatRule[]	NatRules für virtuelles Netzwerkgateway.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der Ressource des virtuellen Netzwerkgateways.
properties.resourceGuid	string	Die GUID-Eigenschaft der Ressourcen-GUID der Ressource des virtuellen Netzwerkgateways.
properties.sku	VirtualNetworkGatewaySku	Der Verweis auf die VirtualNetworkGatewaySku-Ressource, die die für das virtuelle Netzwerkgateway ausgewählte SKU darstellt.
properties.vNetExtendedLocationResourceId	string	Kunden-vnet-Ressourcen-ID. VirtualNetworkGateway vom Typ "Lokales Gateway" ist dem vnet des Kunden zugeordnet.
properties.virtualNetworkGatewayPolicyGroups	VirtualNetworkGatewayPolicyGroup[]	Der Verweis auf die VirtualNetworkGatewayPolicyGroup-Ressource, die die verfügbare VirtualNetworkGatewayPolicyGroup für das Gateway darstellt.
properties.vpnClientConfiguration	VpnClientConfiguration	Der Verweis auf die VpnClientConfiguration-Ressource, die die P2S VpnClient-Konfigurationen darstellt.
properties.vpnGatewayGeneration	VpnGatewayGeneration	Die Generation für dieses VirtualNetworkGateway. Muss keine sein, wenn gatewayType kein VPN ist.
properties.vpnType	VpnType	Der Typ dieses virtuellen Netzwerkgateways.
tags	object	Ressourcentags.
type	string	Ressourcentyp.

VirtualNetworkGatewayAutoScaleBounds

Name	Typ	Beschreibung
max	integer	Maximale Skalierungseinheiten für die Autoskalenkonfiguration
min	integer	Minimale Skalierungseinheiten für die Autoskalenkonfiguration

VirtualNetworkGatewayAutoScaleConfiguration

Details zur Autoskalenkonfiguration für virtuelles Netzwerkgateway

Name	Typ	Beschreibung
bounds	VirtualNetworkGatewayAutoScaleBounds	Die Grenzen der Konfiguration der automatischen Skalierung

VirtualNetworkGatewayIPConfiguration

IP-Konfiguration für virtuelles Netzwerkgateway.

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID.
name	string	Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.
properties.privateIPAddress	string	Private IP-Adresse für dieses Gateway.
properties.privateIPAllocationMethod	IPAllocationMethod	Die private IP-Adresszuweisungsmethode.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der IP-Konfigurationsressource des virtuellen Netzwerkgateways.
properties.publicIPAddress	SubResource	Der Verweis auf die öffentliche IP-Ressource.
properties.subnet	SubResource	Der Verweis auf die Subnetzressource.

VirtualNetworkGatewayNatRule

VirtualNetworkGatewayNatRule-Ressource.

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID.
name	string	Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.
properties.externalMappings	VpnNatRuleMapping[]	Die externe Zuordnung der privaten IP-Adresse für NAT.
properties.internalMappings	VpnNatRuleMapping[]	Die interne Zuordnung der privaten IP-Adresse für NAT.
properties.ipConfigurationId	string	Die IP-Konfigurations-ID, für die diese NAT-Regel gilt.
properties.mode	VpnNatRuleMode	Die Quell-NAT-Richtung eines VPN-NAT.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der NAT-Regelressource.
properties.type	VpnNatRuleType	Der Typ der NAT-Regel für VPN NAT.
type	string	Ressourcentyp.

VirtualNetworkGatewayPolicyGroup

Parameter für VirtualNetworkGatewayPolicyGroup.

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID.
name	string	Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.
properties.isDefault	boolean	Zeigt an, ob es sich um eine Default VirtualNetworkGatewayPolicyGroup handelt oder nicht.
properties.policyMembers	VirtualNetworkGatewayPolicyGroupMember[]	Mehrere PolicyMembers für VirtualNetworkGatewayPolicyGroup.
properties.priority	integer	Priorität für VirtualNetworkGatewayPolicyGroup.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der VirtualNetworkGatewayPolicyGroup-Ressource.
properties.vngClientConnectionConfigurations	SubResource[]	Liste der Verweise auf vngClientConnectionConfigurations.

VirtualNetworkGatewayPolicyGroupMember

Mitglied "PolicyGroup" für die Vpn-Clientverbindungskonfiguration

Name	Typ	Beschreibung
attributeType	VpnPolicyMemberAttributeType	Der Attributtyp des VPN-Richtlinienmitglieds.
attributeValue	string	Der Wert des Attributs, das für diese VirtualNetworkGatewayPolicyGroupMember verwendet wird.
name	string	Name der VirtualNetworkGatewayPolicyGroupMember.

VirtualNetworkGatewaySku

VirtualNetworkGatewaySku-Details.

Name	Typ	Beschreibung
capacity	integer	Die Kapazität.
name	VirtualNetworkGatewaySkuName	Gateway-SKU-Name.
tier	VirtualNetworkGatewaySkuTier	Gateway-SKU-Ebene.

VirtualNetworkGatewaySkuName

Gateway-SKU-Name.

Name	Typ	Beschreibung
Basic	string
ErGw1AZ	string
ErGw2AZ	string
ErGw3AZ	string
ErGwScale	string
HighPerformance	string
Standard	string
UltraPerformance	string
VpnGw1	string
VpnGw1AZ	string
VpnGw2	string
VpnGw2AZ	string
VpnGw3	string
VpnGw3AZ	string
VpnGw4	string
VpnGw4AZ	string
VpnGw5	string
VpnGw5AZ	string

VirtualNetworkGatewaySkuTier

Gateway-SKU-Ebene.

Name	Typ	Beschreibung
Basic	string
ErGw1AZ	string
ErGw2AZ	string
ErGw3AZ	string
ErGwScale	string
HighPerformance	string
Standard	string
UltraPerformance	string
VpnGw1	string
VpnGw1AZ	string
VpnGw2	string
VpnGw2AZ	string
VpnGw3	string
VpnGw3AZ	string
VpnGw4	string
VpnGw4AZ	string
VpnGw5	string
VpnGw5AZ	string

VirtualNetworkGatewayType

Der Typ dieses virtuellen Netzwerkgateways.

Name	Typ	Beschreibung
ExpressRoute	string
LocalGateway	string
Vpn	string

VngClientConnectionConfiguration

Eine VPN-Clientverbindungskonfiguration für die Clientverbindungskonfiguration.

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID.
name	string	Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der VngClientConnectionConfiguration-Ressource.
properties.virtualNetworkGatewayPolicyGroups	SubResource[]	Liste der Verweise auf virtualNetworkGatewayPolicyGroups
properties.vpnClientAddressPool	AddressSpace	Der Verweis auf die Adressraumressource, die den Adressraum für P2S VpnClient darstellt.

VpnAuthenticationType

VPN-Authentifizierungstypen für das virtuelle Netzwerkgateway..

Name	Typ	Beschreibung
AAD	string
Certificate	string
Radius	string

VpnClientConfiguration

VpnClientConfiguration für P2S-Client.

Name	Typ	Beschreibung
aadAudience	string	Die AADAudience-Eigenschaft der VirtualNetworkGateway-Ressource für vpn-Clientverbindung, die für die AAD-Authentifizierung verwendet wird.
aadIssuer	string	Die AADIssuer-Eigenschaft der VirtualNetworkGateway-Ressource für vpn-Clientverbindung, die für die AAD-Authentifizierung verwendet wird.
aadTenant	string	Die AADTenant-Eigenschaft der VirtualNetworkGateway-Ressource für vpn-Clientverbindung, die für die AAD-Authentifizierung verwendet wird.
radiusServerAddress	string	Die Radius-Serveradresseneigenschaft der VirtualNetworkGateway-Ressource für vpn-Clientverbindung.
radiusServerSecret	string	Die radius secret-Eigenschaft der VirtualNetworkGateway-Ressource für vpn-Clientverbindung.
radiusServers	RadiusServer[]	Die RadiusServers-Eigenschaft für die Konfiguration mehrerer Radius-Server.
vngClientConnectionConfigurations	VngClientConnectionConfiguration[]	pro IP-Adresspoolverbindungsrichtlinie für den P2S-Client des virtuellen Netzwerks.
vpnAuthenticationTypes	VpnAuthenticationType[]	VPN-Authentifizierungstypen für das virtuelle Netzwerkgateway..
vpnClientAddressPool	AddressSpace	Der Verweis auf die Adressraumressource, die den Adressraum für P2S VpnClient darstellt.
vpnClientIpsecPolicies	IpsecPolicy[]	VpnClientIpsecPolicies für den P2S-Client für virtuelles Netzwerkgateway.
vpnClientProtocols	VpnClientProtocol[]	VpnClientProtocols für virtuelles Netzwerkgateway.
vpnClientRevokedCertificates	VpnClientRevokedCertificate[]	VpnClientRevokedCertificate für virtuelles Netzwerkgateway.
vpnClientRootCertificates	VpnClientRootCertificate[]	VpnClientRootCertificate für virtuelles Netzwerkgateway.

VpnClientProtocol

VpnClientProtocols für virtuelles Netzwerkgateway.

Name	Typ	Beschreibung
IkeV2	string
OpenVPN	string
SSTP	string

VpnClientRevokedCertificate

VPN-Client hat das Zertifikat des virtuellen Netzwerkgateways widerrufen.

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID.
name	string	Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus des VPN-Clients hat die Zertifikatressource widerrufen.
properties.thumbprint	string	Der widerrufene VPN-Client-Zertifikatfingerabdruck.

VpnClientRootCertificate

VPN-Clientstammzertifikat des virtuellen Netzwerkgateways.

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID.
name	string	Der Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der VPN-Clientstammzertifikatressource.
properties.publicCertData	string	Die öffentlichen Zertifikatdaten.

VpnGatewayGeneration

Die Generation für dieses VirtualNetworkGateway. Muss keine sein, wenn gatewayType kein VPN ist.

Name	Typ	Beschreibung
Generation1	string
Generation2	string
None	string

VpnNatRuleMapping

Vpn NatRule-Zuordnung.

Name	Typ	Beschreibung
addressSpace	string	Adressraum für vpn NatRule-Zuordnung.
portRange	string	Portbereich für vpn NatRule-Zuordnung.

VpnNatRuleMode

Die Quell-NAT-Richtung eines VPN-NAT.

Name	Typ	Beschreibung
EgressSnat	string
IngressSnat	string

VpnNatRuleType

Der Typ der NAT-Regel für VPN NAT.

Name	Typ	Beschreibung
Dynamic	string
Static	string

VpnPolicyMemberAttributeType

Der Attributtyp des VPN-Richtlinienmitglieds.

Name	Typ	Beschreibung
AADGroupId	string
CertificateGroupId	string
RadiusAzureGroupId	string

VpnType

Der Typ dieses virtuellen Netzwerkgateways.

Name	Typ	Beschreibung
PolicyBased	string
RouteBased	string

Freigeben über

Virtual Network Gateways - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

GetVirtualNetworkGateway

Beispielanforderung

Beispiel für eine Antwort

GetVirtualNetworkScalableGateway

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AddressSpace

adminState

BgpSettings

CloudError

CloudErrorBody

DhGroup

ExtendedLocation

ExtendedLocationTypes

IkeEncryption

IkeIntegrity

IPAllocationMethod

IPConfigurationBgpPeeringAddress

IpsecEncryption

IpsecIntegrity

IpsecPolicy

PfsGroup

ProvisioningState

RadiusServer

SubResource

VirtualNetworkGateway

VirtualNetworkGatewayAutoScaleBounds

VirtualNetworkGatewayAutoScaleConfiguration

VirtualNetworkGatewayIPConfiguration

VirtualNetworkGatewayNatRule

VirtualNetworkGatewayPolicyGroup

VirtualNetworkGatewayPolicyGroupMember

VirtualNetworkGatewaySku

VirtualNetworkGatewaySkuName

VirtualNetworkGatewaySkuTier

VirtualNetworkGatewayType

VngClientConnectionConfiguration

VpnAuthenticationType

VpnClientConfiguration

VpnClientProtocol

VpnClientRevokedCertificate

VpnClientRootCertificate

VpnGatewayGeneration

VpnNatRuleMapping

VpnNatRuleMode

VpnNatRuleType

VpnPolicyMemberAttributeType

VpnType

Zusätzliche Ressourcen