Vpn Gateways - Get

Odwołanie

Usługa:: Virtual WAN

Wersja interfejsu API:: 2024-05-01

Pobiera szczegóły bramy wirtualnej sieci VPN wan.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
gatewayName	path	True	string	Nazwa bramy.
resourceGroupName	path	True	string	Nazwa grupy zasobów bramy VpnGateway.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	VpnGateway	Żądanie powiodło się. Zwraca szczegóły pobranej bramy wirtualnej sieci VPN wan.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

VpnGatewayGet

Przykładowe żądanie

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


/**
 * 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

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

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

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

Przykładowa odpowiedź

Kod stanu:: 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
  }
}

Definicje

Nazwa	Opis
BgpSettings	Szczegóły ustawień protokołu BGP.
CloudError	Odpowiedź na błąd z usługi.
CloudErrorBody	Odpowiedź na błąd z usługi.
DhGroup	Grupy DH używane w fazie IKE 1 dla początkowego sa.
GatewayCustomBgpIpAddressIpConfiguration	GatewayCustomBgpIpAddressIpConfiguration dla połączenia bramy sieci wirtualnej.
IkeEncryption	Algorytm szyfrowania IKE (faza 2).
IkeIntegrity	Algorytm integralności IKE (faza 2).
IPConfigurationBgpPeeringAddress	Właściwości właściwości IPConfigurationBgpPeeringAddress.
IpsecEncryption	Algorytm szyfrowania IPSec (faza 1).
IpsecIntegrity	Algorytm integralności protokołu IPSec (faza 1).
IpsecPolicy	Konfiguracja zasad IPSec dla połączenia bramy sieci wirtualnej.
PfsGroup	Grupy Pfs używane w fazie IKE 2 dla nowego podrzędnego skojarzenia zabezpieczeń.
PropagatedRouteTable	Lista tabeli RouteTables do anonsowania tras do.
ProvisioningState	Bieżący stan aprowizacji.
RoutingConfiguration	Konfiguracja routingu wskazująca skojarzone i propagowane tabele tras dla tego połączenia.
StaticRoute	Lista wszystkich tras statycznych.
StaticRoutesConfig	Konfiguracja tras statycznych w tym hubVnetConnectionConfiguration dla tras statycznych w tym hubVnetConnection.
SubResource	Odwołanie do innego podźródła.
TrafficSelectorPolicy	Zasady selektora ruchu dla połączenia bramy sieci wirtualnej.
VirtualNetworkGatewayConnectionProtocol	Protokół połączenia używany na potrzeby tego połączenia.
VnetLocalRouteOverrideCriteria	Parametr określający, czy urządzenie WUS w sieci wirtualnej szprychy jest pomijane dla ruchu z miejscem docelowym w sieci wirtualnej szprychy.
VnetRoute	Lista tras sterujących routingiem z usługi VirtualHub do połączenia sieci wirtualnej.
VpnConnection	Zasób vpnConnection.
VpnConnectionStatus	Bieżący stan połączenia sieci VPN.
VpnGateway	Zasób vpnGateway.
VpnGatewayIpConfiguration	Konfiguracja adresu IP zasobu usługi VPN Gateway.
VpnGatewayNatRule	Zasób VpnGatewayNatRule.
VpnLinkConnectionMode	Tryb połączenia sieci VPN.
VpnNatRuleMapping	Mapowanie sieci VPN NatRule.
VpnNatRuleMode	Kierunek źródłowego translatora adresów sieciowych sieci VPN.
VpnNatRuleType	Typ reguły translatora adresów sieciowych dla translatora adresów sieciOWYCH sieci VPN.
VpnSiteLinkConnection	Zasób VpnSiteLinkConnection.

BgpSettings

Szczegóły ustawień protokołu BGP.

Nazwa	Typ	Opis
asn	integer	AsN osoby mówiącej BGP.
bgpPeeringAddress	string	Adres komunikacji równorzędnej BGP i identyfikator protokołu BGP tego głośnika BGP.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	Adres komunikacji równorzędnej BGP z identyfikatorem konfiguracji adresu IP dla bramy sieci wirtualnej.
peerWeight	integer	Waga dodana do tras wyciągniętych z tego głośnika BGP.

CloudError

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
error	CloudErrorBody	Treść błędu chmury.

CloudErrorBody

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

DhGroup

Grupy DH używane w fazie IKE 1 dla początkowego sa.

Nazwa	Typ	Opis
DHGroup1	string
DHGroup14	string
DHGroup2	string
DHGroup2048	string
DHGroup24	string
ECP256	string
ECP384	string
None	string

GatewayCustomBgpIpAddressIpConfiguration

GatewayCustomBgpIpAddressIpConfiguration dla połączenia bramy sieci wirtualnej.

Nazwa	Typ	Opis
customBgpIpAddress	string	Niestandardowy element BgpPeeringAddress należący do identyfikatora IpconfigurationId.
ipConfigurationId	string	Identyfikator IpconfigurationId konfiguracji ip, która należy do bramy.

IkeEncryption

Algorytm szyfrowania IKE (faza 2).

Nazwa	Typ	Opis
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES256	string

IkeIntegrity

Algorytm integralności IKE (faza 2).

Nazwa	Typ	Opis
GCMAES128	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string
SHA384	string

IPConfigurationBgpPeeringAddress

Właściwości właściwości IPConfigurationBgpPeeringAddress.

Nazwa	Typ	Opis
customBgpIpAddresses	string[]	Lista niestandardowych adresów komunikacji równorzędnej BGP należących do konfiguracji adresu IP.
defaultBgpIpAddresses	string[]	Lista domyślnych adresów komunikacji równorzędnej BGP należących do konfiguracji adresu IP.
ipconfigurationId	string	Identyfikator konfiguracji adresu IP, która należy do bramy.
tunnelIpAddresses	string[]	Lista publicznych adresów IP tunelu należących do konfiguracji adresu IP.

IpsecEncryption

Algorytm szyfrowania IPSec (faza 1).

Nazwa	Typ	Opis
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES192	string
GCMAES256	string
None	string

IpsecIntegrity

Algorytm integralności protokołu IPSec (faza 1).

Nazwa	Typ	Opis
GCMAES128	string
GCMAES192	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string

IpsecPolicy

Konfiguracja zasad IPSec dla połączenia bramy sieci wirtualnej.

Nazwa	Typ	Opis
dhGroup	DhGroup	Grupa DH używana w fazie IKE 1 dla początkowego sa.
ikeEncryption	IkeEncryption	Algorytm szyfrowania IKE (faza 2).
ikeIntegrity	IkeIntegrity	Algorytm integralności IKE (faza 2).
ipsecEncryption	IpsecEncryption	Algorytm szyfrowania IPSec (faza 1).
ipsecIntegrity	IpsecIntegrity	Algorytm integralności protokołu IPSec (faza 1).
pfsGroup	PfsGroup	Grupa Pfs używana w fazie IKE 2 dla nowego podrzędnego skojarzenia zabezpieczeń.
saDataSizeKilobytes	integer	Rozmiar ładunku skojarzenia zabezpieczeń protokołu IPSec (nazywanego również trybem szybkim lub sa fazy 2) w kb dla tunelu vpn typu lokacja-lokacja.
saLifeTimeSeconds	integer	Okres istnienia skojarzenia zabezpieczeń protokołu IPSec (nazywanego również trybem szybkim lub sa fazy 2) w sekundach dla tunelu vpn typu lokacja-lokacja.

PfsGroup

Grupy Pfs używane w fazie IKE 2 dla nowego podrzędnego skojarzenia zabezpieczeń.

Nazwa	Typ	Opis
ECP256	string
ECP384	string
None	string
PFS1	string
PFS14	string
PFS2	string
PFS2048	string
PFS24	string
PFSMM	string

PropagatedRouteTable

Lista tabeli RouteTables do anonsowania tras do.

Nazwa	Typ	Opis
ids	SubResource[]	Lista identyfikatorów zasobów wszystkich tabel tras.
labels	string[]	Lista etykiet.

ProvisioningState

Bieżący stan aprowizacji.

Nazwa	Typ	Opis
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingConfiguration

Konfiguracja routingu wskazująca skojarzone i propagowane tabele tras dla tego połączenia.

Nazwa	Typ	Opis
associatedRouteTable	SubResource	Identyfikator zasobu RouteTable skojarzony z tą konfiguracją routingu.
inboundRouteMap	SubResource	Identyfikator zasobu RouteMap skojarzony z tą konfiguracją RoutingConfiguration dla tras wyuczonych dla ruchu przychodzącego.
outboundRouteMap	SubResource	Identyfikator zasobu mapyroute skojarzonej z tą konfiguracją routingu dla tras anonsowanych dla ruchu wychodzącego.
propagatedRouteTables	PropagatedRouteTable	Lista tabeli RouteTables do anonsowania tras do.
vnetRoutes	VnetRoute	Lista tras sterujących routingiem z usługi VirtualHub do połączenia sieci wirtualnej.

StaticRoute

Lista wszystkich tras statycznych.

Nazwa	Typ	Opis
addressPrefixes	string[]	Lista wszystkich prefiksów adresów.
name	string	Nazwa usługi StaticRoute, która jest unikatowa w ramach usługi VnetRoute.
nextHopIpAddress	string	Adres IP następnego przeskoku.

StaticRoutesConfig

Konfiguracja tras statycznych w tym hubVnetConnectionConfiguration dla tras statycznych w tym hubVnetConnection.

Nazwa	Typ	Opis
propagateStaticRoutes	boolean	Wartość logiczna wskazująca, czy trasy statyczne w tym połączeniu są automatycznie propagowane do tabel tras, do których propaguje to połączenie.
vnetLocalRouteOverrideCriteria	VnetLocalRouteOverrideCriteria	Parametr określający, czy urządzenie WUS w sieci wirtualnej szprychy jest pomijane dla ruchu z miejscem docelowym w szprychach.

SubResource

Odwołanie do innego podźródła.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.

TrafficSelectorPolicy

Zasady selektora ruchu dla połączenia bramy sieci wirtualnej.

Nazwa	Typ	Opis
localAddressRanges	string[]	Kolekcja lokalnych przestrzeni adresowych w formacie CIDR.
remoteAddressRanges	string[]	Kolekcja zdalnych przestrzeni adresowych w formacie CIDR.

VirtualNetworkGatewayConnectionProtocol

Protokół połączenia używany na potrzeby tego połączenia.

Nazwa	Typ	Opis
IKEv1	string
IKEv2	string

VnetLocalRouteOverrideCriteria

Parametr określający, czy urządzenie WUS w sieci wirtualnej szprychy jest pomijane dla ruchu z miejscem docelowym w sieci wirtualnej szprychy.

Nazwa	Typ	Opis
Contains	string
Equal	string

VnetRoute

Lista tras sterujących routingiem z usługi VirtualHub do połączenia sieci wirtualnej.

Nazwa	Typ	Opis
bgpConnections	SubResource[]	Lista odwołań do obiektów HubBgpConnection.
staticRoutes	StaticRoute[]	Lista wszystkich tras statycznych.
staticRoutesConfig	StaticRoutesConfig	Konfiguracja tras statycznych w tym hubVnetConnection.

VpnConnection

Zasób vpnConnection.

Nazwa	Typ	Opis
etag	string	Unikatowy ciąg tylko do odczytu, który zmienia się za każdym razem, gdy zasób jest aktualizowany.
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu, który jest unikatowy w grupie zasobów. Ta nazwa może służyć do uzyskiwania dostępu do zasobu.
properties.connectionBandwidth	integer	Oczekiwana przepustowość w MBPS.
properties.connectionStatus	VpnConnectionStatus	Stan połączenia.
properties.dpdTimeoutSeconds	integer	Limit czasu usługi DPD w sekundach dla połączenia sieci VPN.
properties.egressBytesTransferred	integer	Przetransferowane bajty ruchu wychodzącego.
properties.enableBgp	boolean	Flaga EnableBgp.
properties.enableInternetSecurity	boolean	Włącz zabezpieczenia internetowe.
properties.enableRateLimiting	boolean	Flaga EnableBgp.
properties.ingressBytesTransferred	integer	Przetransferowane bajty ruchu przychodzącego.
properties.ipsecPolicies	IpsecPolicy[]	Zasady protokołu IPSec, które mają być brane pod uwagę przez to połączenie.
properties.provisioningState	ProvisioningState	Stan aprowizacji zasobu połączenia sieci VPN.
properties.remoteVpnSite	SubResource	Identyfikator połączonej lokacji sieci VPN.
properties.routingConfiguration	RoutingConfiguration	Konfiguracja routingu wskazująca skojarzone i propagowane tabele tras w tym połączeniu.
properties.routingWeight	integer	Waga routingu dla połączenia sieci VPN.
properties.sharedKey	string	SharedKey dla połączenia sieci VPN.
properties.trafficSelectorPolicies	TrafficSelectorPolicy[]	Zasady selektora ruchu, które mają być brane pod uwagę przez to połączenie.
properties.useLocalAzureIpAddress	boolean	Użyj lokalnego adresu IP platformy Azure, aby zainicjować połączenie.
properties.usePolicyBasedTrafficSelectors	boolean	Włącz selektory ruchu oparte na zasadach.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Protokół połączenia używany na potrzeby tego połączenia.
properties.vpnLinkConnections	VpnSiteLinkConnection[]	Lista wszystkich połączeń połączenia lokacji sieci VPN z bramą.

VpnConnectionStatus

Bieżący stan połączenia sieci VPN.

Nazwa	Typ	Opis
Connected	string
Connecting	string
NotConnected	string
Unknown	string

VpnGateway

Zasób vpnGateway.

Nazwa	Typ	Opis
etag	string	Unikatowy ciąg tylko do odczytu, który zmienia się za każdym razem, gdy zasób jest aktualizowany.
id	string	Identyfikator zasobu.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu.
properties.bgpSettings	BgpSettings	Ustawienia głośnika BGP bramy sieci lokalnej.
properties.connections	VpnConnection[]	Lista wszystkich połączeń sieci VPN z bramą.
properties.enableBgpRouteTranslationForNat	boolean	Włącz translacja tras protokołu BGP dla translatora adresów sieciowych w tej bramie VpnGateway.
properties.ipConfigurations	VpnGatewayIpConfiguration[]	Lista wszystkich adresów IP skonfigurowanych w bramie.
properties.isRoutingPreferenceInternet	boolean	Włącz właściwość Preferencja routingu dla publicznego interfejsu IP bramy VpnGateway.
properties.natRules	VpnGatewayNatRule[]	Lista wszystkich reguł nat skojarzonych z bramą.
properties.provisioningState	ProvisioningState	Stan aprowizacji zasobu bramy sieci VPN.
properties.virtualHub	SubResource	Usługa VirtualHub, do której należy brama.
properties.vpnGatewayScaleUnit	integer	Jednostka skalowania dla tej bramy sieci VPN.
tags	object	Tagi zasobów.
type	string	Typ zasobu.

VpnGatewayIpConfiguration

Konfiguracja adresu IP zasobu usługi VPN Gateway.

Nazwa	Typ	Opis
id	string	Identyfikator konfiguracji adresu IP dla bramy sieci VPN.
privateIpAddress	string	Prywatny adres IP tej konfiguracji adresu IP.
publicIpAddress	string	Publiczny adres IP tej konfiguracji adresu IP.

VpnGatewayNatRule

Zasób VpnGatewayNatRule.

Nazwa	Typ	Opis
etag	string	Unikatowy ciąg tylko do odczytu, który zmienia się za każdym razem, gdy zasób jest aktualizowany.
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu, który jest unikatowy w grupie zasobów. Ta nazwa może służyć do uzyskiwania dostępu do zasobu.
properties.egressVpnSiteLinkConnections	SubResource[]	Lista połączeń wychodzących VpnSiteLinkConnections.
properties.externalMappings	VpnNatRuleMapping[]	Zewnętrzne mapowanie prywatnego adresu IP dla translatora adresów sieciowych.
properties.ingressVpnSiteLinkConnections	SubResource[]	Lista połączeń przychodzących VpnSiteLinkConnections.
properties.internalMappings	VpnNatRuleMapping[]	Wewnętrzne mapowanie prywatnego adresu IP dla translatora adresów sieciowych.
properties.ipConfigurationId	string	Identyfikator konfiguracji adresu IP, do których ma zastosowanie ta reguła translatora adresów sieciowych.
properties.mode	VpnNatRuleMode	Kierunek źródłowego translatora adresów sieciowych sieci VPN.
properties.provisioningState	ProvisioningState	Stan aprowizacji zasobu reguły translatora adresów sieciowych.
properties.type	VpnNatRuleType	Typ reguły translatora adresów sieciowych dla translatora adresów sieciOWYCH sieci VPN.
type	string	Typ zasobu.

VpnLinkConnectionMode

Tryb połączenia sieci VPN.

Nazwa	Typ	Opis
Default	string
InitiatorOnly	string
ResponderOnly	string

VpnNatRuleMapping

Mapowanie sieci VPN NatRule.

Nazwa	Typ	Opis
addressSpace	string	Przestrzeń adresowa mapowania sieci Vpn NatRule.
portRange	string	Zakres portów dla mapowania translatora adresów sieci Vpn natRule.

VpnNatRuleMode

Kierunek źródłowego translatora adresów sieciowych sieci VPN.

Nazwa	Typ	Opis
EgressSnat	string
IngressSnat	string

VpnNatRuleType

Typ reguły translatora adresów sieciowych dla translatora adresów sieciOWYCH sieci VPN.

Nazwa	Typ	Opis
Dynamic	string
Static	string

VpnSiteLinkConnection

Zasób VpnSiteLinkConnection.

Nazwa	Typ	Opis
etag	string	Unikatowy ciąg tylko do odczytu, który zmienia się za każdym razem, gdy zasób jest aktualizowany.
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu, który jest unikatowy w grupie zasobów. Ta nazwa może służyć do uzyskiwania dostępu do zasobu.
properties.connectionBandwidth	integer	Oczekiwana przepustowość w MBPS.
properties.connectionStatus	VpnConnectionStatus	Stan połączenia.
properties.dpdTimeoutSeconds	integer	Upłynął limit czasu wykrywania utraconych elementów równorzędnych w sekundach dla połączenia VpnLink.
properties.egressBytesTransferred	integer	Przetransferowane bajty ruchu wychodzącego.
properties.egressNatRules	SubResource[]	Lista ruchu wychodzącego NatRules.
properties.enableBgp	boolean	Flaga EnableBgp.
properties.enableRateLimiting	boolean	Flaga EnableBgp.
properties.ingressBytesTransferred	integer	Przetransferowane bajty ruchu przychodzącego.
properties.ingressNatRules	SubResource[]	Lista ruchu przychodzącego NatRules.
properties.ipsecPolicies	IpsecPolicy[]	Zasady protokołu IPSec, które mają być brane pod uwagę przez to połączenie.
properties.provisioningState	ProvisioningState	Stan aprowizacji zasobu połączenia połączenia lokacji sieci VPN.
properties.routingWeight	integer	Waga routingu dla połączenia sieci VPN.
properties.sharedKey	string	SharedKey dla połączenia sieci VPN.
properties.useLocalAzureIpAddress	boolean	Użyj lokalnego adresu IP platformy Azure, aby zainicjować połączenie.
properties.usePolicyBasedTrafficSelectors	boolean	Włącz selektory ruchu oparte na zasadach.
properties.vpnConnectionProtocolType	VirtualNetworkGatewayConnectionProtocol	Protokół połączenia używany na potrzeby tego połączenia.
properties.vpnGatewayCustomBgpAddresses	GatewayCustomBgpIpAddressIpConfiguration[]	vpnGatewayCustomBgpAddresses używane przez to połączenie.
properties.vpnLinkConnectionMode	VpnLinkConnectionMode	Tryb połączenia sieci VPN.
properties.vpnSiteLink	SubResource	Identyfikator łącza połączonej lokacji sieci VPN.
type	string	Typ zasobu.

Udostępnij za pośrednictwem

Vpn Gateways - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

VpnGatewayGet

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

BgpSettings

CloudError

CloudErrorBody

DhGroup

GatewayCustomBgpIpAddressIpConfiguration

IkeEncryption

IkeIntegrity

IPConfigurationBgpPeeringAddress

IpsecEncryption

IpsecIntegrity

IpsecPolicy

PfsGroup

PropagatedRouteTable

ProvisioningState

RoutingConfiguration

StaticRoute

StaticRoutesConfig

SubResource

TrafficSelectorPolicy

VirtualNetworkGatewayConnectionProtocol

VnetLocalRouteOverrideCriteria

VnetRoute

VpnConnection

VpnConnectionStatus

VpnGateway

VpnGatewayIpConfiguration

VpnGatewayNatRule

VpnLinkConnectionMode

VpnNatRuleMapping

VpnNatRuleMode

VpnNatRuleType

VpnSiteLinkConnection

Dodatkowe zasoby