Vpn Sites - Get

Referenz

Dienst:: Virtual WAN

API-Version:: 2024-05-01

Ruft die Details eines VPN-Standorts ab.

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

URI-Parameter

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

Antworten

Name	Typ	Beschreibung
200 OK	VpnSite	Anforderung erfolgreich. Gibt die Details der abgerufenen VpnSite 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

VpnSiteGet

Beispielanforderung

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


/**
 * Samples for VpnSites GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnSiteGet.json
     */
    /**
     * Sample code: VpnSiteGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void vpnSiteGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVpnSites().getByResourceGroupWithResponse("rg1", "vpnSite1",
            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_site_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_sites.get(
        resource_group_name="rg1",
        vpn_site_name="vpnSite1",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnSiteGet.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/VpnSiteGet.json
func ExampleVPNSitesClient_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.NewVPNSitesClient().Get(ctx, "rg1", "vpnSite1", 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.VPNSite = armnetwork.VPNSite{
	// 	Name: to.Ptr("vpnSite1"),
	// 	Type: to.Ptr("Microsoft.Network/vpnSites"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 	},
	// 	Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 	Properties: &armnetwork.VPNSiteProperties{
	// 		AddressSpace: &armnetwork.AddressSpace{
	// 			AddressPrefixes: []*string{
	// 				to.Ptr("10.0.0.0/16")},
	// 			},
	// 			DeviceProperties: &armnetwork.DeviceProperties{
	// 				LinkSpeedInMbps: to.Ptr[int32](0),
	// 			},
	// 			IsSecuritySite: to.Ptr(false),
	// 			ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 			VirtualWan: &armnetwork.SubResource{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"),
	// 			},
	// 			VPNSiteLinks: []*armnetwork.VPNSiteLink{
	// 				{
	// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1"),
	// 					Name: to.Ptr("vpnSiteLink1"),
	// 					Type: to.Ptr("Microsoft.Network/vpnSites/vpnSiteLinks"),
	// 					Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
	// 					Properties: &armnetwork.VPNSiteLinkProperties{
	// 						BgpProperties: &armnetwork.VPNLinkBgpSettings{
	// 							Asn: to.Ptr[int64](1234),
	// 							BgpPeeringAddress: to.Ptr("192.168.0.0"),
	// 						},
	// 						IPAddress: to.Ptr("50.50.50.56"),
	// 						LinkProperties: &armnetwork.VPNLinkProviderProperties{
	// 							LinkProviderName: to.Ptr("vendor1"),
	// 							LinkSpeedInMbps: to.Ptr[int32](0),
	// 						},
	// 						ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 					},
	// 			}},
	// 		},
	// 	}
}

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 VPN site.
 *
 * @summary Retrieves the details of a VPN site.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnSiteGet.json
 */
async function vpnSiteGet() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const vpnSiteName = "vpnSite1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.vpnSites.get(resourceGroupName, vpnSiteName);
  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

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.Resources;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnSiteGet.json
// this example is just showing the usage of "VpnSites_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://zcusa.951200.xyz/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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this VpnSiteResource
VpnSiteCollection collection = resourceGroupResource.GetVpnSites();

// invoke the operation
string vpnSiteName = "vpnSite1";
NullableResponse<VpnSiteResource> response = await collection.GetIfExistsAsync(vpnSiteName);
VpnSiteResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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
    VpnSiteData 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

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "name": "vpnSite1",
  "type": "Microsoft.Network/vpnSites",
  "tags": {
    "key1": "value1"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "virtualWan": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
    },
    "deviceProperties": {
      "linkSpeedInMbps": 0
    },
    "addressSpace": {
      "addressPrefixes": [
        "10.0.0.0/16"
      ]
    },
    "isSecuritySite": false,
    "vpnSiteLinks": [
      {
        "name": "vpnSiteLink1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1",
        "type": "Microsoft.Network/vpnSites/vpnSiteLinks",
        "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
        "properties": {
          "provisioningState": "Succeeded",
          "ipAddress": "50.50.50.56",
          "linkProperties": {
            "linkProviderName": "vendor1",
            "linkSpeedInMbps": 0
          },
          "bgpProperties": {
            "bgpPeeringAddress": "192.168.0.0",
            "asn": 1234
          }
        }
      }
    ]
  }
}

Definitionen

Name	Beschreibung
AddressSpace	AddressSpace enthält ein Array von IP-Adressbereichen, die von Subnetzen des virtuellen Netzwerks verwendet werden können.
BgpSettings	Details zu den BGP-Einstellungen.
CloudError	Eine Fehlerantwort des Diensts.
CloudErrorBody	Eine Fehlerantwort des Diensts.
DeviceProperties	Liste der Eigenschaften des Geräts.
IpamPoolPrefixAllocation	IpamPool-Präfixzuordnungsreferenz.
IPConfigurationBgpPeeringAddress	Eigenschaften von IPConfigurationBgpPeeringAddress.
O365BreakOutCategoryPolicies	Office365-Gruppenkategorien.
O365PolicyProperties	Die Office365-Gruppentrennungsrichtlinie.
ProvisioningState	Der aktuelle Bereitstellungsstatus.
SubResource	Verweisen auf eine andere Unterressource.
VpnLinkBgpSettings	Details zu den BGP-Einstellungen für einen Link.
VpnLinkProviderProperties	Liste der Eigenschaften eines Linkanbieters.
VpnSite	VpnSite-Ressource.
VpnSiteLink	VpnSiteLink-Ressource.

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.
ipamPoolPrefixAllocations	IpamPoolPrefixAllocation[]	Eine Liste der IPAM-Pools, die IP-Adresspräfixe zuordnen.

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.

DeviceProperties

Liste der Eigenschaften des Geräts.

Name	Typ	Beschreibung
deviceModel	string	Modell des Geräts.
deviceVendor	string	Name des Geräteanbieters.
linkSpeedInMbps	integer	Verbindungsgeschwindigkeit.

IpamPoolPrefixAllocation

IpamPool-Präfixzuordnungsreferenz.

Name	Typ	Beschreibung
allocatedAddressPrefixes	string[]	Liste der zugewiesenen IP-Adresspräfixe im IpamPool der zugeordneten Ressource.
numberOfIpAddresses	string	Anzahl der IP-Adressen, die zugewiesen werden sollen.
pool.id	string	Ressourcen-ID der zugeordneten Azure IpamPool-Ressource.

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.

O365BreakOutCategoryPolicies

Office365-Gruppenkategorien.

Name	Typ	Beschreibung
allow	boolean	Kennzeichnung zum Steuern der Zulässigen Kategorie.
default	boolean	Kennzeichnen, um die Standardkategorie zu steuern.
optimize	boolean	Kennzeichnen, um die Kategorie zu optimieren.

O365PolicyProperties

Die Office365-Gruppentrennungsrichtlinie.

Name	Typ	Beschreibung
breakOutCategories	O365BreakOutCategoryPolicies	Office365-Gruppenkategorien.

ProvisioningState

Der aktuelle Bereitstellungsstatus.

Name	Typ	Beschreibung
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Verweisen auf eine andere Unterressource.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.

VpnLinkBgpSettings

Details zu den BGP-Einstellungen für einen Link.

Name	Typ	Beschreibung
asn	integer	Der ASN des BGP-Sprechers.
bgpPeeringAddress	string	Die BGP-Peeringadresse und der BGP-Bezeichner dieses BGP-Lautsprechers.

VpnLinkProviderProperties

Liste der Eigenschaften eines Linkanbieters.

Name	Typ	Beschreibung
linkProviderName	string	Name des Linkanbieters.
linkSpeedInMbps	integer	Verbindungsgeschwindigkeit.

VpnSite

VpnSite-Ressource.

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID.
location	string	Ressourcenspeicherort.
name	string	Ressourcenname.
properties.addressSpace	AddressSpace	AddressSpace, das ein Array von IP-Adressbereichen enthält.
properties.bgpProperties	BgpSettings	Der Satz von bgp-Eigenschaften.
properties.deviceProperties	DeviceProperties	Die Geräteeigenschaften.
properties.ipAddress	string	Die IP-Adresse für die vpn-Site.
properties.isSecuritySite	boolean	IsSecuritySite-Flag.
properties.o365Policy	O365PolicyProperties	Office365-Richtlinie.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der VPN-Standortressource.
properties.siteKey	string	Der Schlüssel für vpn-Site, der für Verbindungen verwendet werden kann.
properties.virtualWan	SubResource	Der VirtualWAN, zu dem die vpnSite gehört.
properties.vpnSiteLinks	VpnSiteLink[]	Liste aller VPN-Websitelinks.
tags	object	Ressourcentags.
type	string	Ressourcentyp.

VpnSiteLink

VpnSiteLink-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.bgpProperties	VpnLinkBgpSettings	Der Satz von bgp-Eigenschaften.
properties.fqdn	string	FQDN von vpn-site-link.
properties.ipAddress	string	Die IP-Adresse für den vpn-site-link.
properties.linkProperties	VpnLinkProviderProperties	Die Eigenschaften des Verknüpfungsanbieters.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der VPN-Standortverknüpfungsressource.
type	string	Ressourcentyp.