Vpn Sites - Get

Odwołanie

Usługa:: Virtual WAN

Wersja interfejsu API:: 2024-05-01

Pobiera szczegóły lokacji sieci VPN.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów witryny VpnSite.
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.
vpnSiteName	path	True	string	Nazwa pobieranej witryny VpnSite.
api-version	query	True	string	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	VpnSite	Żądanie powiodło się. Zwraca szczegóły pobranej witryny VpnSite.
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

VpnSiteGet

Przykładowe żądanie

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.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://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 VpnSiteResource created on azure
// for more information of creating VpnSiteResource, please refer to the document of VpnSiteResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string vpnSiteName = "vpnSite1";
ResourceIdentifier vpnSiteResourceId = VpnSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vpnSiteName);
VpnSiteResource vpnSite = client.GetVpnSiteResource(vpnSiteResourceId);

// invoke the operation
VpnSiteResource result = await vpnSite.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
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

Przykładowa odpowiedź

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

Definicje

Nazwa	Opis
AddressSpace	AddressSpace zawiera tablicę zakresów adresów IP, które mogą być używane przez podsieci sieci wirtualnej.
BgpSettings	Szczegóły ustawień protokołu BGP.
CloudError	Odpowiedź na błąd z usługi.
CloudErrorBody	Odpowiedź na błąd z usługi.
DeviceProperties	Lista właściwości urządzenia.
IpamPoolPrefixAllocation	Dokumentacja alokacji prefiksów puli IpamPool.
IPConfigurationBgpPeeringAddress	Właściwości właściwości IPConfigurationBgpPeeringAddress.
O365BreakOutCategoryPolicies	Kategorie podziału usługi Office365.
O365PolicyProperties	Zasady podziału usługi Office365.
ProvisioningState	Bieżący stan aprowizacji.
SubResource	Odwołanie do innego podźródła.
VpnLinkBgpSettings	Szczegóły ustawień protokołu BGP dla linku.
VpnLinkProviderProperties	Lista właściwości dostawcy linków.
VpnSite	Zasób vpnSite.
VpnSiteLink	Zasób VpnSiteLink.

AddressSpace

Object

AddressSpace zawiera tablicę zakresów adresów IP, które mogą być używane przez podsieci sieci wirtualnej.

Nazwa	Typ	Opis
addressPrefixes	string[]	Lista bloków adresów zarezerwowanych dla tej sieci wirtualnej w notacji CIDR.
ipamPoolPrefixAllocations	IpamPoolPrefixAllocation[]	Lista pul usługi IPAM przydzielających prefiksy adresów IP.

BgpSettings

Object

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

Object

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

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

CloudErrorBody

Object

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.

DeviceProperties

Object

Lista właściwości urządzenia.

Nazwa	Typ	Opis
deviceModel	string	Model urządzenia.
deviceVendor	string	Nazwa dostawcy urządzenia.
linkSpeedInMbps	integer	Szybkość łącza.

IpamPoolPrefixAllocation

Object

Dokumentacja alokacji prefiksów puli IpamPool.

Nazwa	Typ	Opis
allocatedAddressPrefixes	string[]	Lista przypisanych prefiksów adresów IP w puli ipam skojarzonego zasobu.
numberOfIpAddresses	string	Liczba adresów IP do przydzielenia.
pool.id	string	Identyfikator zasobu skojarzonego zasobu usługi Azure IpamPool.

IPConfigurationBgpPeeringAddress

Object

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.

O365BreakOutCategoryPolicies

Object

Kategorie podziału usługi Office365.

Nazwa	Typ	Opis
allow	boolean	Flaga umożliwiająca kontrolowanie kategorii dozwolonych.
default	boolean	Flaga do kontrolowania kategorii domyślnej.
optimize	boolean	Flaga do kontrolowania kategorii optymalizacji.

O365PolicyProperties

Object

Zasady podziału usługi Office365.

Nazwa	Typ	Opis
breakOutCategories	O365BreakOutCategoryPolicies	Kategorie podziału usługi Office365.

ProvisioningState

Enumeration

Bieżący stan aprowizacji.

Wartość	Opis
Deleting
Failed
Succeeded
Updating

SubResource

Object

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

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.

VpnLinkBgpSettings

Object

Szczegóły ustawień protokołu BGP dla linku.

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.

VpnLinkProviderProperties

Object

Lista właściwości dostawcy linków.

Nazwa	Typ	Opis
linkProviderName	string	Nazwa dostawcy linków.
linkSpeedInMbps	integer	Szybkość łącza.

VpnSite

Object

Zasób vpnSite.

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.addressSpace	AddressSpace	Przestrzeń adresów zawierająca tablicę zakresów adresów IP.
properties.bgpProperties	BgpSettings	Zestaw właściwości bgp.
properties.deviceProperties	DeviceProperties	Właściwości urządzenia.
properties.ipAddress	string	Adres IP lokacji sieci VPN.
properties.isSecuritySite	boolean	Flaga IsSecuritySite.
properties.o365Policy	O365PolicyProperties	Zasady usługi Office365.
properties.provisioningState	ProvisioningState	Stan aprowizacji zasobu lokacji sieci VPN.
properties.siteKey	string	Klucz dla lokacji sieci VPN, który może być używany na potrzeby połączeń.
properties.virtualWan	SubResource	Wirtualna siećWAN, do której należy vpnSite.
properties.vpnSiteLinks	VpnSiteLink[]	Lista wszystkich linków lokacji sieci VPN.
tags	object	Tagi zasobów.
type	string	Typ zasobu.

VpnSiteLink

Object

Zasób VpnSiteLink.

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.bgpProperties	VpnLinkBgpSettings	Zestaw właściwości bgp.
properties.fqdn	string	Nazwa FQDN łącza vpn-site-link.
properties.ipAddress	string	Adres IP linku vpn-site-link.
properties.linkProperties	VpnLinkProviderProperties	Właściwości dostawcy łącza.
properties.provisioningState	ProvisioningState	Stan aprowizacji zasobu łącza lokacji sieci VPN.
type	string	Typ zasobu.