Vpn Sites - List By Resource Group

Référence

Service:: Virtual WAN

Version d'API:: 2024-05-01

Répertorie tous les vpnSites dans un groupe de ressources.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources du VpnSite.
subscriptionId	path	True	string	Informations d’identification de l’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
api-version	query	True	string	Version de l’API cliente.

Réponses

Nom	Type	Description
200 OK	ListVpnSitesResult	Demande réussie. Retourne les détails de tous les vpnSites dans le groupe de ressources.
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

VpnSiteListByResourceGroup

Exemple de requête

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


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


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnSiteListByResourceGroup.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/VpnSiteListByResourceGroup.json
func ExampleVPNSitesClient_NewListByResourceGroupPager() {
	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)
	}
	pager := clientFactory.NewVPNSitesClient().NewListByResourceGroupPager("rg1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ListVPNSitesResult = armnetwork.ListVPNSitesResult{
		// 	Value: []*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{
		// 									LinkSpeedInMbps: to.Ptr[int32](0),
		// 								},
		// 								ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 							},
		// 					}},
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("vpnSite2"),
		// 				Type: to.Ptr("Microsoft.Network/vpnSites"),
		// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2"),
		// 				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")},
		// 						},
		// 						BgpProperties: &armnetwork.BgpSettings{
		// 							Asn: to.Ptr[int64](1234),
		// 							BgpPeeringAddress: to.Ptr("192.168.0.0"),
		// 						},
		// 						DeviceProperties: &armnetwork.DeviceProperties{
		// 							DeviceModel: to.Ptr("model01"),
		// 							DeviceVendor: to.Ptr("vendor1"),
		// 							LinkSpeedInMbps: to.Ptr[int32](200),
		// 						},
		// 						IPAddress: to.Ptr("10.1.0.0"),
		// 						ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 						VirtualWan: &armnetwork.SubResource{
		// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"),
		// 						},
		// 					},
		// 			}},
		// 		}
	}
}

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 Lists all the vpnSites in a resource group.
 *
 * @summary Lists all the vpnSites in a resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnSiteListByResourceGroup.json
 */
async function vpnSiteListByResourceGroup() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.vpnSites.listByResourceGroup(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "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",
            "type": "Microsoft.Network/vpnSites/vpnSiteLinks",
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1",
            "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
            "properties": {
              "provisioningState": "Succeeded",
              "ipAddress": "50.50.50.56",
              "linkProperties": {
                "linkSpeedInMbps": 0
              },
              "bgpProperties": {
                "bgpPeeringAddress": "192.168.0.0",
                "asn": 1234
              }
            }
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "location": "West US",
      "name": "vpnSite2",
      "type": "Microsoft.Network/vpnSites",
      "tags": {
        "key1": "value1"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "virtualWan": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
        },
        "deviceProperties": {
          "deviceVendor": "vendor1",
          "deviceModel": "model01",
          "linkSpeedInMbps": 200
        },
        "ipAddress": "10.1.0.0",
        "addressSpace": {
          "addressPrefixes": [
            "10.0.0.0/16"
          ]
        },
        "bgpProperties": {
          "bgpPeeringAddress": "192.168.0.0",
          "asn": 1234
        }
      }
    }
  ]
}

Définitions

Nom	Description
AddressSpace	AddressSpace contient un tableau de plages d’adresses IP qui peuvent être utilisées par les sous-réseaux du réseau virtuel.
BgpSettings	Détails des paramètres BGP.
CloudError	Réponse d’erreur du service.
CloudErrorBody	Réponse d’erreur du service.
DeviceProperties	Liste des propriétés de l’appareil.
IpamPoolPrefixAllocation	Référence d’allocation de préfixe IpamPool.
IPConfigurationBgpPeeringAddress	Propriétés d’IPConfigurationBgpPeeringAddress.
ListVpnSitesResult	Résultat de la demande de liste des sites VpnSites. Il contient une liste de vpnSites et une URL nextLink pour obtenir l’ensemble de résultats suivant.
O365BreakOutCategoryPolicies	Catégories de sous-groupes Office365.
O365PolicyProperties	Stratégie de déploiement Office365.
ProvisioningState	État d’approvisionnement actuel.
SubResource	Référence à une autre sous-ressource.
VpnLinkBgpSettings	Détails des paramètres BGP pour un lien.
VpnLinkProviderProperties	Liste des propriétés d’un fournisseur de liens.
VpnSite	Ressource VpnSite.
VpnSiteLink	Ressource VpnSiteLink.

AddressSpace

AddressSpace contient un tableau de plages d’adresses IP qui peuvent être utilisées par les sous-réseaux du réseau virtuel.

Nom	Type	Description
addressPrefixes	string[]	Liste des blocs d’adresses réservés à ce réseau virtuel en notation CIDR.
ipamPoolPrefixAllocations	IpamPoolPrefixAllocation[]	Liste des pools IPAM qui allouent des préfixes d’adresses IP.

BgpSettings

Détails des paramètres BGP.

Nom	Type	Description
asn	integer	ASN de l’orateur BGP.
bgpPeeringAddress	string	Adresse de peering BGP et identificateur BGP de cet orateur BGP.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	Adresse de peering BGP avec l’ID de configuration IP pour la passerelle de réseau virtuel.
peerWeight	integer	Poids ajouté aux itinéraires appris à partir de ce haut-parleur BGP.

CloudError

Réponse d’erreur du service.

Nom	Type	Description
error	CloudErrorBody	Corps de l’erreur cloud.

CloudErrorBody

Réponse d’erreur du service.

Nom	Type	Description
code	string	Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

DeviceProperties

Liste des propriétés de l’appareil.

Nom	Type	Description
deviceModel	string	Modèle de l’appareil.
deviceVendor	string	Nom du fournisseur de l’appareil.
linkSpeedInMbps	integer	Vitesse du lien.

IpamPoolPrefixAllocation

Référence d’allocation de préfixe IpamPool.

Nom	Type	Description
allocatedAddressPrefixes	string[]	Liste des préfixes d’adresse IP affectés dans le Pool Ipam de la ressource associée.
numberOfIpAddresses	string	Nombre d’adresses IP à allouer.
pool.id	string	ID de ressource de la ressource Azure IpamPool associée.

IPConfigurationBgpPeeringAddress

Propriétés d’IPConfigurationBgpPeeringAddress.

Nom	Type	Description
customBgpIpAddresses	string[]	Liste des adresses de peering BGP personnalisées qui appartiennent à la configuration IP.
defaultBgpIpAddresses	string[]	Liste des adresses de peering BGP par défaut qui appartiennent à la configuration IP.
ipconfigurationId	string	ID de la configuration IP qui appartient à la passerelle.
tunnelIpAddresses	string[]	Liste des adresses IP publiques de tunnel qui appartiennent à la configuration IP.

ListVpnSitesResult

Résultat de la demande de liste des sites VpnSites. Il contient une liste de vpnSites et une URL nextLink pour obtenir l’ensemble de résultats suivant.

Nom	Type	Description
nextLink	string	URL permettant d’obtenir le jeu de résultats de liste d’opérations suivant s’il existe.
value	VpnSite[]	Liste des vpnSites.

O365BreakOutCategoryPolicies

Catégories de sous-groupes Office365.

Nom	Type	Description
allow	boolean	Indicateur permettant de contrôler la catégorie d’autorisation.
default	boolean	Indicateur pour contrôler la catégorie par défaut.
optimize	boolean	Indicateur pour contrôler la catégorie d’optimisation.

O365PolicyProperties

Stratégie de déploiement Office365.

Nom	Type	Description
breakOutCategories	O365BreakOutCategoryPolicies	Catégories de sous-groupes Office365.

ProvisioningState

État d’approvisionnement actuel.

Nom	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Référence à une autre sous-ressource.

Nom	Type	Description
id	string	ID de ressource.

VpnLinkBgpSettings

Détails des paramètres BGP pour un lien.

Nom	Type	Description
asn	integer	ASN de l’orateur BGP.
bgpPeeringAddress	string	Adresse de peering BGP et identificateur BGP de cet orateur BGP.

VpnLinkProviderProperties

Liste des propriétés d’un fournisseur de liens.

Nom	Type	Description
linkProviderName	string	Nom du fournisseur de liens.
linkSpeedInMbps	integer	Vitesse du lien.

VpnSite

Ressource VpnSite.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de ressource.
location	string	Emplacement des ressources.
name	string	Nom de la ressource.
properties.addressSpace	AddressSpace	AddressSpace qui contient un tableau de plages d’adresses IP.
properties.bgpProperties	BgpSettings	Ensemble de propriétés bgp.
properties.deviceProperties	DeviceProperties	Propriétés de l’appareil.
properties.ipAddress	string	Adresse IP du site vpn.
properties.isSecuritySite	boolean	Indicateur IsSecuritySite.
properties.o365Policy	O365PolicyProperties	Stratégie Office365.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource de site VPN.
properties.siteKey	string	Clé pour vpn-site qui peut être utilisée pour les connexions.
properties.virtualWan	SubResource	VirtualWAN auquel appartient le vpnSite.
properties.vpnSiteLinks	VpnSiteLink[]	Liste de tous les liens de site vpn.
tags	object	Balises de ressource.
type	string	Type de ressource.

VpnSiteLink

Ressource VpnSiteLink.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de ressource.
name	string	Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
properties.bgpProperties	VpnLinkBgpSettings	Ensemble de propriétés bgp.
properties.fqdn	string	Nom de domaine complet du vpn-site-link.
properties.ipAddress	string	Adresse IP du vpn-site-link.
properties.linkProperties	VpnLinkProviderProperties	Propriétés du fournisseur de liens.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource de liaison de site VPN.
type	string	Type de ressource.

Partager via

Vpn Sites - List By Resource Group

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

VpnSiteListByResourceGroup

Exemple de requête

Exemple de réponse

Définitions

AddressSpace

BgpSettings

CloudError

CloudErrorBody

DeviceProperties

IpamPoolPrefixAllocation

IPConfigurationBgpPeeringAddress

ListVpnSitesResult

O365BreakOutCategoryPolicies

O365PolicyProperties

ProvisioningState

SubResource

VpnLinkBgpSettings

VpnLinkProviderProperties

VpnSite

VpnSiteLink

Ressources supplémentaires