Vpn Sites - Get

Referens

Service:: Virtual WAN

API Version:: 2023-09-01

Hämtar information om en VPN-plats.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Resursgruppens namn på VpnSite.
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.
vpnSiteName	path	True	string	Namnet på vpnSite som hämtas.
api-version	query	True	string	Klient-API-version.

Svar

Name	Typ	Description
200 OK	VpnSite	Begäran lyckades. Returnerar informationen om vpnSite som hämtats.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

VpnSiteGet

Sample Request

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


/**
 * Samples for VpnSites GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-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/2023-09-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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-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/2023-09-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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-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://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 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

Sample Response

Status code:: 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
          }
        }
      }
    ]
  }
}

Definitioner

Name	Description
AddressSpace	AddressSpace innehåller en matris med IP-adressintervall som kan användas av undernät i det virtuella nätverket.
BgpSettings	Information om BGP-inställningar.
CloudError	Ett felsvar från tjänsten.
CloudErrorBody	Ett felsvar från tjänsten.
DeviceProperties	Lista över egenskaper för enheten.
IPConfigurationBgpPeeringAddress	Egenskaper för IPConfigurationBgpPeeringAddress.
O365BreakOutCategoryPolicies	Gruppkategorier för Office 365.
O365PolicyProperties	Utbrytningsprincipen för Office365.
ProvisioningState	Det aktuella etableringstillståndet.
SubResource	Referens till en annan underresurs.
VpnLinkBgpSettings	Information om BGP-inställningar för en länk.
VpnLinkProviderProperties	Lista över egenskaper för en länkprovider.
VpnSite	VpnSite-resurs.
VpnSiteLink	VpnSiteLink-resurs.

AddressSpace

AddressSpace innehåller en matris med IP-adressintervall som kan användas av undernät i det virtuella nätverket.

Name	Typ	Description
addressPrefixes	string[]	En lista över adressblock som är reserverade för det här virtuella nätverket i CIDR-notation.

BgpSettings

Information om BGP-inställningar.

Name	Typ	Description
asn	integer	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	Vikten som läggs till i vägar som lärts från den här BGP-talaren.

CloudError

Ett felsvar från tjänsten.

Name	Typ	Description
error	CloudErrorBody	Molnfeltext.

CloudErrorBody

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.

DeviceProperties

Lista över egenskaper för enheten.

Name	Typ	Description
deviceModel	string	Enhetsmodell.
deviceVendor	string	Namnet på enhetsleverantören.
linkSpeedInMbps	integer	Länkhastighet.

IPConfigurationBgpPeeringAddress

Egenskaper för IPConfigurationBgpPeeringAddress.

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

O365BreakOutCategoryPolicies

Gruppkategorier för Office 365.

Name	Typ	Description
allow	boolean	Flagga för att styra tillåt kategori.
default	boolean	Flagga för att styra standardkategorin.
optimize	boolean	Flagga för att styra optimeringskategorin.

O365PolicyProperties

Utbrytningsprincipen för Office365.

Name	Typ	Description
breakOutCategories	O365BreakOutCategoryPolicies	Gruppkategorier för Office 365.

ProvisioningState

Det aktuella etableringstillståndet.

Name	Typ	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Referens till en annan underresurs.

Name	Typ	Description
id	string	Resurs-ID.

VpnLinkBgpSettings

Information om BGP-inställningar för en länk.

Name	Typ	Description
asn	integer	BGP-talarens ASN.
bgpPeeringAddress	string	BGP-peeringadressen och BGP-identifieraren för den här BGP-talaren.

VpnLinkProviderProperties

Lista över egenskaper för en länkprovider.

Name	Typ	Description
linkProviderName	string	Namnet på länkprovidern.
linkSpeedInMbps	integer	Länkhastighet.

VpnSite

VpnSite-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.addressSpace	AddressSpace	Det AddressSpace som innehåller en matris med IP-adressintervall.
properties.bgpProperties	BgpSettings	Uppsättningen med bgp-egenskaper.
properties.deviceProperties	DeviceProperties	Enhetsegenskaperna.
properties.ipAddress	string	IP-adressen för vpn-platsen.
properties.isSecuritySite	boolean	IsSecuritySite-flagga.
properties.o365Policy	O365PolicyProperties	Office365-princip.
properties.provisioningState	ProvisioningState	Etableringstillståndet för VPN-platsresursen.
properties.siteKey	string	Nyckeln för vpn-plats som kan användas för anslutningar.
properties.virtualWan	SubResource	VirtualWAN som vpnSite tillhör.
properties.vpnSiteLinks	VpnSiteLink[]	Lista över alla vpn-platslänkar.
tags	object	Resurstaggar.
type	string	Resurstyp.

VpnSiteLink

VpnSiteLink-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.bgpProperties	VpnLinkBgpSettings	Uppsättningen med bgp-egenskaper.
properties.fqdn	string	FQDN för vpn-site-link.
properties.ipAddress	string	IP-adressen för vpn-site-link.
properties.linkProperties	VpnLinkProviderProperties	Egenskaperna för länkprovidern.
properties.provisioningState	ProvisioningState	Etableringstillståndet för VPN-platslänkresursen.
type	string	Resurstyp.