Vpn Gateways - Get

Tjänst:

Virtual WAN

API-version:

2024-05-01

Hämtar information om en vpn-gateway för virtuellt wan.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}?api-version=2024-05-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
gatewayName	path	True	string	Namnet på gatewayen.
resourceGroupName	path	True	string	Resursgruppens namn på VpnGateway.
subscriptionId	path	True	string	Autentiseringsuppgifterna för prenumerationen som unikt identifierar Microsoft Azure-prenumerationen. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Svar

Name	Typ	Description
200 OK	VpnGateway	Begäran lyckades. Returnerar information om vpn-gatewayen för virtuellt wan som hämtats.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

VpnGatewayGet

Exempelbegäran

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1?api-version=2024-05-01

Java

/**
 * Samples for VpnGateways GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayGet.json
     */
    /**
     * Sample code: VpnGatewayGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void vpnGatewayGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVpnGateways().getByResourceGroupWithResponse("rg1", "gateway1",
            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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python vpn_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.vpn_gateways.get(
        resource_group_name="rg1",
        gateway_name="gateway1",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayGet.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

Go

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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayGet.json
func ExampleVPNGatewaysClient_Get() {
	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.NewVPNGatewaysClient().Get(ctx, "rg1", "gateway1", 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.VPNGateway = armnetwork.VPNGateway{
	// 	Name: to.Ptr("gateway1"),
	// 	Type: to.Ptr("Microsoft.Network/vpnGateways"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1"),
	// 	Location: to.Ptr("West US"),
	// 	Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 	Properties: &armnetwork.VPNGatewayProperties{
	// 		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.5")},
	// 						DefaultBgpIPAddresses: []*string{
	// 							to.Ptr("10.30.0.4")},
	// 							IPConfigurationID: to.Ptr("Instance0"),
	// 							TunnelIPAddresses: []*string{
	// 								to.Ptr("104.208.48.178")},
	// 							},
	// 							{
	// 								CustomBgpIPAddresses: []*string{
	// 									to.Ptr("169.254.21.10")},
	// 									DefaultBgpIPAddresses: []*string{
	// 										to.Ptr("10.30.0.5")},
	// 										IPConfigurationID: to.Ptr("Instance1"),
	// 										TunnelIPAddresses: []*string{
	// 											to.Ptr("104.208.48.179")},
	// 									}},
	// 									PeerWeight: to.Ptr[int32](0),
	// 								},
	// 								Connections: []*armnetwork.VPNConnection{
	// 									{
	// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1"),
	// 										Name: to.Ptr("vpnConnection1"),
	// 										Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 										Properties: &armnetwork.VPNConnectionProperties{
	// 											EgressBytesTransferred: to.Ptr[int64](0),
	// 											EnableInternetSecurity: to.Ptr(false),
	// 											IngressBytesTransferred: to.Ptr[int64](0),
	// 											ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 											RemoteVPNSite: &armnetwork.SubResource{
	// 												ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"),
	// 											},
	// 											RoutingConfiguration: &armnetwork.RoutingConfiguration{
	// 												AssociatedRouteTable: &armnetwork.SubResource{
	// 													ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"),
	// 												},
	// 												PropagatedRouteTables: &armnetwork.PropagatedRouteTable{
	// 													IDs: []*armnetwork.SubResource{
	// 														{
	// 															ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"),
	// 														},
	// 														{
	// 															ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2"),
	// 														},
	// 														{
	// 															ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3"),
	// 													}},
	// 													Labels: []*string{
	// 														to.Ptr("label1"),
	// 														to.Ptr("label2")},
	// 													},
	// 													VnetRoutes: &armnetwork.VnetRoute{
	// 														StaticRoutes: []*armnetwork.StaticRoute{
	// 														},
	// 													},
	// 												},
	// 												VPNLinkConnections: []*armnetwork.VPNSiteLinkConnection{
	// 													{
	// 														ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1"),
	// 														Name: to.Ptr("Connection-Link1"),
	// 														Type: to.Ptr("Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"),
	// 														Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 														Properties: &armnetwork.VPNSiteLinkConnectionProperties{
	// 															ConnectionBandwidth: to.Ptr[int32](200),
	// 															EgressBytesTransferred: to.Ptr[int64](0),
	// 															EnableBgp: to.Ptr(false),
	// 															EnableRateLimiting: to.Ptr(false),
	// 															IngressBytesTransferred: to.Ptr[int64](0),
	// 															IngressNatRules: []*armnetwork.SubResource{
	// 																{
	// 																	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"),
	// 															}},
	// 															IPSecPolicies: []*armnetwork.IPSecPolicy{
	// 															},
	// 															ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 															RoutingWeight: to.Ptr[int32](0),
	// 															SharedKey: to.Ptr("key"),
	// 															UseLocalAzureIPAddress: to.Ptr(false),
	// 															UsePolicyBasedTrafficSelectors: to.Ptr(false),
	// 															VPNConnectionProtocolType: to.Ptr(armnetwork.VirtualNetworkGatewayConnectionProtocolIKEv2),
	// 															VPNSiteLink: &armnetwork.SubResource{
	// 																ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"),
	// 															},
	// 														},
	// 													},
	// 													{
	// 														ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2"),
	// 														Name: to.Ptr("Connection-Link2"),
	// 														Type: to.Ptr("Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"),
	// 														Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 														Properties: &armnetwork.VPNSiteLinkConnectionProperties{
	// 															ConnectionBandwidth: to.Ptr[int32](200),
	// 															EgressBytesTransferred: to.Ptr[int64](0),
	// 															EgressNatRules: []*armnetwork.SubResource{
	// 																{
	// 																	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat04"),
	// 															}},
	// 															EnableBgp: to.Ptr(false),
	// 															EnableRateLimiting: to.Ptr(false),
	// 															IngressBytesTransferred: to.Ptr[int64](0),
	// 															IPSecPolicies: []*armnetwork.IPSecPolicy{
	// 															},
	// 															ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 															RoutingWeight: to.Ptr[int32](0),
	// 															SharedKey: to.Ptr("key"),
	// 															UseLocalAzureIPAddress: to.Ptr(false),
	// 															UsePolicyBasedTrafficSelectors: to.Ptr(false),
	// 															VPNConnectionProtocolType: to.Ptr(armnetwork.VirtualNetworkGatewayConnectionProtocolIKEv2),
	// 															VPNSiteLink: &armnetwork.SubResource{
	// 																ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2"),
	// 															},
	// 														},
	// 												}},
	// 											},
	// 									}},
	// 									EnableBgpRouteTranslationForNat: to.Ptr(false),
	// 									IsRoutingPreferenceInternet: to.Ptr(false),
	// 									NatRules: []*armnetwork.VPNGatewayNatRule{
	// 										{
	// 											ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"),
	// 											Name: to.Ptr("nat03"),
	// 											Type: to.Ptr("Microsoft.Network/vpnGateways/natRules"),
	// 											Properties: &armnetwork.VPNGatewayNatRuleProperties{
	// 												Type: to.Ptr(armnetwork.VPNNatRuleTypeDynamic),
	// 												ExternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 													{
	// 														AddressSpace: to.Ptr("192.168.0.0/26"),
	// 												}},
	// 												IngressVPNSiteLinkConnections: []*armnetwork.SubResource{
	// 													{
	// 														ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1"),
	// 												}},
	// 												InternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 													{
	// 														AddressSpace: to.Ptr("0.0.0.0/26"),
	// 												}},
	// 												Mode: to.Ptr(armnetwork.VPNNatRuleMode("IgressSnat")),
	// 											},
	// 										},
	// 										{
	// 											ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat04"),
	// 											Name: to.Ptr("nat04"),
	// 											Type: to.Ptr("Microsoft.Network/vpnGateways/natRules"),
	// 											Properties: &armnetwork.VPNGatewayNatRuleProperties{
	// 												Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
	// 												EgressVPNSiteLinkConnections: []*armnetwork.SubResource{
	// 													{
	// 														ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link2"),
	// 												}},
	// 												ExternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 													{
	// 														AddressSpace: to.Ptr("192.168.0.0/26"),
	// 												}},
	// 												InternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 													{
	// 														AddressSpace: to.Ptr("0.0.0.0/26"),
	// 												}},
	// 												Mode: to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
	// 											},
	// 									}},
	// 									ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 									VirtualHub: &armnetwork.SubResource{
	// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"),
	// 									},
	// 								},
	// 							}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Retrieves the details of a virtual wan vpn gateway.
 *
 * @summary Retrieves the details of a virtual wan vpn gateway.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayGet.json
 */
async function vpnGatewayGet() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const gatewayName = "gateway1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.vpnGateways.get(resourceGroupName, gatewayName);
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnGatewayGet.json
// this example is just showing the usage of "VpnGateways_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VpnGatewayResource created on azure
// for more information of creating VpnGatewayResource, please refer to the document of VpnGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string gatewayName = "gateway1";
ResourceIdentifier vpnGatewayResourceId = VpnGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, gatewayName);
VpnGatewayResource vpnGateway = client.GetVpnGatewayResource(vpnGatewayResourceId);

// invoke the operation
VpnGatewayResource result = await vpnGateway.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
VpnGatewayData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Exempelsvar

Statuskod:

200

{
  "name": "gateway1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "type": "Microsoft.Network/vpnGateways",
  "properties": {
    "provisioningState": "Succeeded",
    "virtualHub": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
    },
    "connections": [
      {
        "name": "vpnConnection1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1",
        "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
        "properties": {
          "provisioningState": "Succeeded",
          "remoteVpnSite": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
          },
          "enableInternetSecurity": false,
          "ingressBytesTransferred": 0,
          "egressBytesTransferred": 0,
          "vpnLinkConnections": [
            {
              "name": "Connection-Link1",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
              "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
              "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
              "properties": {
                "provisioningState": "Succeeded",
                "vpnSiteLink": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
                },
                "connectionBandwidth": 200,
                "ipsecPolicies": [],
                "vpnConnectionProtocolType": "IKEv2",
                "sharedKey": "key",
                "ingressBytesTransferred": 0,
                "egressBytesTransferred": 0,
                "enableBgp": false,
                "enableRateLimiting": false,
                "useLocalAzureIpAddress": false,
                "usePolicyBasedTrafficSelectors": false,
                "routingWeight": 0,
                "ingressNatRules": [
                  {
                    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"
                  }
                ]
              }
            },
            {
              "name": "Connection-Link2",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2",
              "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections",
              "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
              "properties": {
                "provisioningState": "Succeeded",
                "vpnSiteLink": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2"
                },
                "connectionBandwidth": 200,
                "ipsecPolicies": [],
                "vpnConnectionProtocolType": "IKEv2",
                "sharedKey": "key",
                "ingressBytesTransferred": 0,
                "egressBytesTransferred": 0,
                "enableBgp": false,
                "enableRateLimiting": false,
                "useLocalAzureIpAddress": false,
                "usePolicyBasedTrafficSelectors": false,
                "routingWeight": 0,
                "egressNatRules": [
                  {
                    "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat04"
                  }
                ]
              }
            }
          ],
          "routingConfiguration": {
            "associatedRouteTable": {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
            },
            "propagatedRouteTables": {
              "labels": [
                "label1",
                "label2"
              ],
              "ids": [
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"
                },
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2"
                },
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3"
                }
              ]
            },
            "vnetRoutes": {
              "staticRoutes": []
            }
          }
        }
      }
    ],
    "bgpSettings": {
      "asn": 65514,
      "bgpPeeringAddress": "10.0.1.30",
      "peerWeight": 0,
      "bgpPeeringAddresses": [
        {
          "ipconfigurationId": "Instance0",
          "defaultBgpIpAddresses": [
            "10.30.0.4"
          ],
          "customBgpIpAddresses": [
            "169.254.21.5"
          ],
          "tunnelIpAddresses": [
            "104.208.48.178"
          ]
        },
        {
          "ipconfigurationId": "Instance1",
          "defaultBgpIpAddresses": [
            "10.30.0.5"
          ],
          "customBgpIpAddresses": [
            "169.254.21.10"
          ],
          "tunnelIpAddresses": [
            "104.208.48.179"
          ]
        }
      ]
    },
    "natRules": [
      {
        "name": "nat03",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03",
        "properties": {
          "type": "Dynamic",
          "mode": "IgressSnat",
          "internalMappings": [
            {
              "addressSpace": "0.0.0.0/26"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "192.168.0.0/26"
            }
          ],
          "ingressVpnSiteLinkConnections": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1"
            }
          ]
        },
        "type": "Microsoft.Network/vpnGateways/natRules"
      },
      {
        "name": "nat04",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat04",
        "properties": {
          "type": "Static",
          "mode": "EgressSnat",
          "internalMappings": [
            {
              "addressSpace": "0.0.0.0/26"
            }
          ],
          "externalMappings": [
            {
              "addressSpace": "192.168.0.0/26"
            }
          ],
          "egressVpnSiteLinkConnections": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link2"
            }
          ]
        },
        "type": "Microsoft.Network/vpnGateways/natRules"
      }
    ],
    "isRoutingPreferenceInternet": false,
    "enableBgpRouteTranslationForNat": false
  }
}

Definitioner

Name	Description
BgpSettings	Information om BGP-inställningar.
CloudError	Ett felsvar från tjänsten.
CloudErrorBody	Ett felsvar från tjänsten.
DhGroup	De DH-grupper som används i IKE Fas 1 för inledande SA.
GatewayCustomBgpIpAddressIpConfiguration	GatewayCustomBgpIpAddressIpConfiguration för en virtuell nätverksgatewayanslutning.
IkeEncryption	IKE-krypteringsalgoritmen (IKE fas 2).
IkeIntegrity	IKE-integritetsalgoritmen (IKE fas 2).
IPConfigurationBgpPeeringAddress	Egenskaper för IPConfigurationBgpPeeringAddress.
IpsecEncryption	IPSec-krypteringsalgoritmen (IKE-fas 1).
IpsecIntegrity	IPSec-integritetsalgoritmen (IKE fas 1).
IpsecPolicy	En IPSec-principkonfiguration för en anslutning till en virtuell nätverksgateway.
PfsGroup	Pfs-grupper som används i IKE Fas 2 för ny underordnad SA.
PropagatedRouteTable	Listan med RouteTables som du vill annonsera vägarna till.
ProvisioningState	Det aktuella etableringstillståndet.
RoutingConfiguration	Routningskonfiguration som anger de associerade och distribuerade routningstabellerna för den här anslutningen.
StaticRoute	Lista över alla statiska vägar.
StaticRoutesConfig	Konfiguration för statiska vägar på detta HubVnetConnectionConfiguration för statiska vägar på denna HubVnetConnection.
SubResource	Referens till en annan underresurs.
TrafficSelectorPolicy	En trafikväljarprincip för en virtuell nätverksgatewayanslutning.
VirtualNetworkGatewayConnectionProtocol	Anslutningsprotokoll som används för den här anslutningen.
VnetLocalRouteOverrideCriteria	Parameter som avgör om NVA i eker-vnet kringgås för trafik med målet i det virtuella ekernätverket.
VnetRoute	Lista över vägar som styr routning från VirtualHub till en virtuell nätverksanslutning.
VpnConnection	VpnConnection-resurs.
VpnConnectionStatus	Vpn-anslutningens aktuella tillstånd.
VpnGateway	VpnGateway-resurs.
VpnGatewayIpConfiguration	IP-konfiguration av en VPN Gateway-resurs.
VpnGatewayNatRule	VpnGatewayNatRule-resurs.
VpnLinkConnectionMode	Anslutningsläge för VPN-länk.
VpnNatRuleMapping	Vpn NatRule-mappning.
VpnNatRuleMode	Nat-källriktningen för en VPN NAT.
VpnNatRuleType	Typ av NAT-regel för VPN NAT.
VpnSiteLinkConnection	VpnSiteLinkConnection-resurs.

BgpSettings

Objekt

Information om BGP-inställningar.

Name	Typ	Description
asn	integer (int64) minimum: 0 maximum: 4294967295	BGP-talarens ASN.
bgpPeeringAddress	string	BGP-peeringadressen och BGP-identifieraren för den här BGP-talaren.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	BGP-peeringadress med IP-konfigurations-ID för virtuell nätverksgateway.
peerWeight	integer (int32)	Vikten som lagts till i vägar som lärts från den här BGP-talaren.

CloudError

Objekt

Ett felsvar från tjänsten.

Name	Typ	Description
error	CloudErrorBody	Molnfeltext.

CloudErrorBody

Objekt

Ett felsvar från tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
details	CloudErrorBody[]	En lista med ytterligare information om felet.
message	string	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
target	string	Målet för det specifika felet. Till exempel namnet på egenskapen i fel.

DhGroup

Uppräkning

De DH-grupper som används i IKE Fas 1 för inledande SA.

Värde	Description
DHGroup1
DHGroup14
DHGroup2
DHGroup2048
DHGroup24
ECP256
ECP384
None

GatewayCustomBgpIpAddressIpConfiguration

Objekt

GatewayCustomBgpIpAddressIpConfiguration för en virtuell nätverksgatewayanslutning.

Name	Typ	Description
customBgpIpAddress	string	Den anpassade BgpPeeringAddress som tillhör IpconfigurationId.
ipConfigurationId	string	IpconfigurationId för ipconfiguration som tillhör gatewayen.

IkeEncryption

Uppräkning

IKE-krypteringsalgoritmen (IKE fas 2).

Värde	Description
AES128
AES192
AES256
DES
DES3
GCMAES128
GCMAES256

IkeIntegrity

Uppräkning

IKE-integritetsalgoritmen (IKE fas 2).

Värde	Description
GCMAES128
GCMAES256
MD5
SHA1
SHA256
SHA384

IPConfigurationBgpPeeringAddress

Objekt

Egenskaper för IPConfigurationBgpPeeringAddress.

Name	Typ	Description
customBgpIpAddresses	string[]	Listan över anpassade BGP-peeringadresser som tillhör IP-konfigurationen.
defaultBgpIpAddresses	string[]	Listan över standardadresser för BGP-peering som tillhör IP-konfigurationen.
ipconfigurationId	string	ID för IP-konfiguration som tillhör gatewayen.
tunnelIpAddresses	string[]	Listan över offentliga IP-adresser för tunnlar som tillhör IP-konfigurationen.

IpsecEncryption

Uppräkning

IPSec-krypteringsalgoritmen (IKE-fas 1).

Värde	Description
AES128
AES192
AES256
DES
DES3
GCMAES128
GCMAES192
GCMAES256
None

IpsecIntegrity

Uppräkning

IPSec-integritetsalgoritmen (IKE fas 1).

Värde	Description
GCMAES128
GCMAES192
GCMAES256
MD5
SHA1
SHA256

IpsecPolicy

Objekt

En IPSec-principkonfiguration för en anslutning till en virtuell nätverksgateway.

Name	Typ	Description
dhGroup	DhGroup	Den DH-grupp som används i IKE Fas 1 för inledande SA.
ikeEncryption	IkeEncryption	IKE-krypteringsalgoritmen (IKE fas 2).
ikeIntegrity	IkeIntegrity	IKE-integritetsalgoritmen (IKE fas 2).
ipsecEncryption	IpsecEncryption	IPSec-krypteringsalgoritmen (IKE-fas 1).
ipsecIntegrity	IpsecIntegrity	IPSec-integritetsalgoritmen (IKE fas 1).
pfsGroup	PfsGroup	Pfs-gruppen som används i IKE Fas 2 för ny underordnad SA.
saDataSizeKilobytes	integer (int32)	IPSec-säkerhetsassociationen (kallas även snabbläge eller fas 2 SA) nyttolaststorlek i KB för en VPN-tunnel från plats till plats.
saLifeTimeSeconds	integer (int32)	IPSec-säkerhetsassociationen (kallas även snabbläge eller fas 2 SA) i sekunder för en VPN-tunnel för plats-till-plats.

PfsGroup

Uppräkning

Pfs-grupper som används i IKE Fas 2 för ny underordnad SA.

Värde	Description
ECP256
ECP384
None
PFS1
PFS14
PFS2
PFS2048
PFS24
PFSMM

PropagatedRouteTable

Objekt

Listan med RouteTables som du vill annonsera vägarna till.

Name	Typ	Description
ids	SubResource[]	Listan över resurs-ID:t för alla RouteTables.
labels	string[]	Listan med etiketter.

ProvisioningState

Uppräkning

Det aktuella etableringstillståndet.

Värde	Description
Deleting
Failed
Succeeded
Updating

RoutingConfiguration

Objekt

Routningskonfiguration som anger de associerade och distribuerade routningstabellerna för den här anslutningen.

Name	Typ	Description
associatedRouteTable	SubResource	Resurs-ID:t RouteTable som är associerad med den här RoutingConfiguration.
inboundRouteMap	SubResource	Resurs-ID för RouteMap som är associerad med den här RoutingConfiguration för inkommande inlärda vägar.
outboundRouteMap	SubResource	Resurs-ID för denRouteMap som är associerad med den här RoutingConfiguration för utgående annonserade vägar.
propagatedRouteTables	PropagatedRouteTable	Listan med RouteTables som du vill annonsera vägarna till.
vnetRoutes	VnetRoute	Lista över vägar som styr routning från VirtualHub till en virtuell nätverksanslutning.

StaticRoute

Objekt

Lista över alla statiska vägar.

Name	Typ	Description
addressPrefixes	string[]	Lista över alla adressprefix.
name	string	Namnet på StaticRoute som är unikt i en VnetRoute.
nextHopIpAddress	string	IP-adressen för nästa hopp.

StaticRoutesConfig

Objekt

Konfiguration för statiska vägar på detta HubVnetConnectionConfiguration för statiska vägar på denna HubVnetConnection.

Name	Typ	Description
propagateStaticRoutes	boolean	Booleskt värde som anger om statiska vägar i den här anslutningen automatiskt sprids till routningstabeller som anslutningen sprids till.
vnetLocalRouteOverrideCriteria	VnetLocalRouteOverrideCriteria	Parameter som avgör om NVA i eker-vnet kringgås för trafik med målet i eker.

SubResource

Objekt

Referens till en annan underresurs.

Name	Typ	Description
id	string	Resurs-ID.

TrafficSelectorPolicy

Objekt

En trafikväljarprincip för en virtuell nätverksgatewayanslutning.

Name	Typ	Description
localAddressRanges	string[]	En samling lokala adressutrymmen i CIDR-format.
remoteAddressRanges	string[]	En samling fjärradressutrymmen i CIDR-format.

VirtualNetworkGatewayConnectionProtocol

Uppräkning

Anslutningsprotokoll som används för den här anslutningen.

Värde	Description
IKEv1
IKEv2

VnetLocalRouteOverrideCriteria

Uppräkning

Parameter som avgör om NVA i eker-vnet kringgås för trafik med målet i det virtuella ekernätverket.

Värde	Description
Contains
Equal

VnetRoute

Objekt

Lista över vägar som styr routning från VirtualHub till en virtuell nätverksanslutning.

Name	Typ	Description
bgpConnections	SubResource[]	Listan med referenser till HubBgpConnection-objekt.
staticRoutes	StaticRoute[]	Lista över alla statiska vägar.
staticRoutesConfig	StaticRoutesConfig	Konfiguration för statiska vägar på denna HubVnetConnection.

VpnConnection

Objekt

VpnConnection-resurs.

Name	Typ	Description
etag	string	En unik skrivskyddad sträng som ändras när resursen uppdateras.
id	string	Resurs-ID.
name	string	Namnet på resursen som är unik i en resursgrupp. Det här namnet kan användas för att komma åt resursen.
properties.connectionBandwidth	integer (int32)	Förväntad bandbredd i MBPS.
properties.connectionStatus	VpnConnectionStatus	Anslutningsstatus.
properties.dpdTimeoutSeconds	integer (int32)	DPD-timeout i sekunder för VPN-anslutning.
properties.egressBytesTransferred	integer (int64)	Utgående byte har överförts.
properties.enableBgp	boolean	AktiveraBgp-flagga.
properties.enableInternetSecurity	boolean	Aktivera internetsäkerhet.
properties.enableRateLimiting	boolean	AktiveraBgp-flagga.
properties.ingressBytesTransferred	integer (int64)	Inkommande byte har överförts.
properties.ipsecPolicies	IpsecPolicy[]	IPSec-principerna som ska beaktas av den här anslutningen.
properties.provisioningState	ProvisioningState	Etableringstillståndet för VPN-anslutningsresursen.
properties.remoteVpnSite	SubResource	ID för den anslutna VPN-platsen.
properties.routingConfiguration	RoutingConfiguration	Routningskonfigurationen som anger de associerade och spridade routningstabellerna i den här anslutningen.
properties.routingWeight	integer (int32)	Routningsvikt för VPN-anslutning.
properties.sharedKey	string	SharedKey för VPN-anslutningen.
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	De trafikväljarprinciper som ska beaktas av den här anslutningen.
properties.useLocalAzureIpAddress	boolean	Använd lokal azure ip för att initiera anslutningen.
properties.usePolicyBasedTrafficSelectors	boolean	Aktivera principbaserade trafikväljare.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Anslutningsprotokoll som används för den här anslutningen.
properties.vpnLinkConnections	VpnSiteLinkConnection[]	Lista över alla vpn-platslänkanslutningar till gatewayen.

VpnConnectionStatus

Uppräkning

Vpn-anslutningens aktuella tillstånd.

Värde	Description
Connected
Connecting
NotConnected
Unknown

VpnGateway

Objekt

VpnGateway-resurs.

Name	Typ	Description
etag	string	En unik skrivskyddad sträng som ändras när resursen uppdateras.
id	string	Resurs-ID.
location	string	Resursplats.
name	string	Resursnamn.
properties.bgpSettings	BgpSettings	BGP-talarinställningar för den lokala nätverksgatewayen.
properties.connections	VpnConnection[]	Lista över alla VPN-anslutningar till gatewayen.
properties.enableBgpRouteTranslationForNat	boolean	Aktivera översättning av BGP-vägar för NAT på denna VpnGateway.
properties.ipConfigurations	VpnGatewayIpConfiguration[]	Lista över alla IP-adresser som har konfigurerats på gatewayen.
properties.isRoutingPreferenceInternet	boolean	Aktivera egenskapen Routningsinställning för det offentliga IP-gränssnittet för VpnGateway.
properties.natRules	VpnGatewayNatRule[]	Lista över alla nat-regler som är associerade med gatewayen.
properties.provisioningState	ProvisioningState	Etableringstillståndet för VPN-gatewayresursen.
properties.virtualHub	SubResource	Den VirtualHub som gatewayen tillhör.
properties.vpnGatewayScaleUnit	integer (int32)	Skalningsenheten för den här VPN-gatewayen.
tags	object	Resurstaggar.
type	string	Resurstyp.

VpnGatewayIpConfiguration

Objekt

IP-konfiguration av en VPN Gateway-resurs.

Name	Typ	Description
id	string	Identifieraren för IP-konfigurationen för en VPN Gateway.
privateIpAddress	string	Den privata IP-adressen för den här IP-konfigurationen.
publicIpAddress	string	Den offentliga IP-adressen för den här IP-konfigurationen.

VpnGatewayNatRule

Objekt

VpnGatewayNatRule-resurs.

Name	Typ	Description
etag	string	En unik skrivskyddad sträng som ändras när resursen uppdateras.
id	string	Resurs-ID.
name	string	Namnet på resursen som är unik i en resursgrupp. Det här namnet kan användas för att komma åt resursen.
properties.egressVpnSiteLinkConnections	SubResource[]	Lista över utgående VPNSiteLinkConnections.
properties.externalMappings	VpnNatRuleMapping[]	Den privata IP-adressens externa mappning för NAT.
properties.ingressVpnSiteLinkConnections	SubResource[]	Lista över inkommande VPNSiteLinkConnections.
properties.internalMappings	VpnNatRuleMapping[]	Intern mappning av den privata IP-adressen för NAT.
properties.ipConfigurationId	string	IP-konfigurations-ID:t som den här NAT-regeln gäller för.
properties.mode	VpnNatRuleMode	Nat-källriktningen för en VPN NAT.
properties.provisioningState	ProvisioningState	Etableringstillståndet för NAT-regelresursen.
properties.type	VpnNatRuleType	Typ av NAT-regel för VPN NAT.
type	string	Resurstyp.

VpnLinkConnectionMode

Uppräkning

Anslutningsläge för VPN-länk.

Värde	Description
Default
InitiatorOnly
ResponderOnly

VpnNatRuleMapping

Objekt

Vpn NatRule-mappning.

Name	Typ	Description
addressSpace	string	Adressutrymme för Vpn NatRule-mappning.
portRange	string	Portintervall för Vpn NatRule-mappning.

VpnNatRuleMode

Uppräkning

Nat-källriktningen för en VPN NAT.

Värde	Description
EgressSnat
IngressSnat

VpnNatRuleType

Uppräkning

Typ av NAT-regel för VPN NAT.

Värde	Description
Dynamic
Static

VpnSiteLinkConnection

Objekt

VpnSiteLinkConnection-resurs.

Name	Typ	Description
etag	string	En unik skrivskyddad sträng som ändras när resursen uppdateras.
id	string	Resurs-ID.
name	string	Namnet på resursen som är unik i en resursgrupp. Det här namnet kan användas för att komma åt resursen.
properties.connectionBandwidth	integer (int32)	Förväntad bandbredd i MBPS.
properties.connectionStatus	VpnConnectionStatus	Anslutningsstatus.
properties.dpdTimeoutSeconds	integer (int32)	Tidsgränsen för död peeridentifiering i sekunder för VpnLink-anslutning.
properties.egressBytesTransferred	integer (int64)	Utgående byte har överförts.
properties.egressNatRules	SubResource[]	Lista över utgående NatRules.
properties.enableBgp	boolean	AktiveraBgp-flagga.
properties.enableRateLimiting	boolean	AktiveraBgp-flagga.
properties.ingressBytesTransferred	integer (int64)	Inkommande byte har överförts.
properties.ingressNatRules	SubResource[]	Lista över inkommande NatRules.
properties.ipsecPolicies	IpsecPolicy[]	IPSec-principerna som ska beaktas av den här anslutningen.
properties.provisioningState	ProvisioningState	Etableringstillståndet för VPN-platslänkanslutningsresursen.
properties.routingWeight	integer (int32)	Routningsvikt för VPN-anslutning.
properties.sharedKey	string	SharedKey för VPN-anslutningen.
properties.useLocalAzureIpAddress	boolean	Använd lokal azure ip för att initiera anslutningen.
properties.usePolicyBasedTrafficSelectors	boolean	Aktivera principbaserade trafikväljare.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Anslutningsprotokoll som används för den här anslutningen.
properties.vpnGatewayCustomBgpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	vpnGatewayCustomBgpAddresses som används av den här anslutningen.
properties.vpnLinkConnectionMode	VpnLinkConnectionMode	Anslutningsläge för VPN-länk.
properties.vpnSiteLink	SubResource	Id för den anslutna vpn-platslänken.
type	string	Resurstyp.