Vpn Sites - Get

Referencia

Servicio:: Virtual WAN

Versión de la API:: 2024-05-01

Recupera los detalles de un sitio VPN.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos de VpnSite.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
vpnSiteName	path	True	string	Nombre de VpnSite que se va a recuperar.
api-version	query	True	string	Versión de la API de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	VpnSite	Solicitud correcta. Devuelve los detalles del elemento VpnSite recuperado.
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

VpnSiteGet

Solicitud de ejemplo

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

Respuesta de muestra

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
          }
        }
      }
    ]
  }
}

Definiciones

Nombre	Description
AddressSpace	AddressSpace contiene una matriz de intervalos de direcciones IP que pueden usar las subredes de la red virtual.
BgpSettings	Detalles de configuración de BGP.
CloudError	Respuesta de error del servicio.
CloudErrorBody	Respuesta de error del servicio.
DeviceProperties	Lista de propiedades del dispositivo.
IpamPoolPrefixAllocation	Referencia de asignación de prefijos de IpamPool.
IPConfigurationBgpPeeringAddress	Propiedades de IPConfigurationBgpPeeringAddress.
O365BreakOutCategoryPolicies	Categorías de interrupción de Office365.
O365PolicyProperties	Directiva de interrupción de Office365.
ProvisioningState	Estado de aprovisionamiento actual.
SubResource	Referencia a otro subrecurso.
VpnLinkBgpSettings	Detalles de configuración de BGP para un vínculo.
VpnLinkProviderProperties	Lista de propiedades de un proveedor de vínculos.
VpnSite	Recurso VpnSite.
VpnSiteLink	Recurso VpnSiteLink.

AddressSpace

AddressSpace contiene una matriz de intervalos de direcciones IP que pueden usar las subredes de la red virtual.

Nombre	Tipo	Description
addressPrefixes	string[]	Lista de bloques de direcciones reservados para esta red virtual en notación CIDR.
ipamPoolPrefixAllocations	IpamPoolPrefixAllocation[]	Lista de grupos de IPAM que asignan prefijos de dirección IP.

BgpSettings

Detalles de configuración de BGP.

Nombre	Tipo	Description
asn	integer	ASN del altavoz BGP.
bgpPeeringAddress	string	Dirección de emparejamiento BGP e identificador BGP de este altavoz BGP.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	Dirección de emparejamiento BGP con identificador de configuración ip para la puerta de enlace de red virtual.
peerWeight	integer	Peso añadido a las rutas aprendidas de este altavoz BGP.

CloudError

Respuesta de error del servicio.

Nombre	Tipo	Description
error	CloudErrorBody	Cuerpo del error en la nube.

CloudErrorBody

Respuesta de error del servicio.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
target	string	Destino del error concreto. Por ejemplo, el nombre de la propiedad en error.

DeviceProperties

Lista de propiedades del dispositivo.

Nombre	Tipo	Description
deviceModel	string	Modelo del dispositivo.
deviceVendor	string	Nombre del proveedor del dispositivo.
linkSpeedInMbps	integer	Velocidad de vínculo.

IpamPoolPrefixAllocation

Referencia de asignación de prefijos de IpamPool.

Nombre	Tipo	Description
allocatedAddressPrefixes	string[]	Lista de prefijos de dirección IP asignadas en ipamPool del recurso asociado.
numberOfIpAddresses	string	Número de direcciones IP que se van a asignar.
pool.id	string	Identificador de recurso del recurso de Azure IpamPool asociado.

IPConfigurationBgpPeeringAddress

Propiedades de IPConfigurationBgpPeeringAddress.

Nombre	Tipo	Description
customBgpIpAddresses	string[]	Lista de direcciones de emparejamiento BGP personalizadas que pertenecen a la configuración de IP.
defaultBgpIpAddresses	string[]	Lista de direcciones de emparejamiento BGP predeterminadas que pertenecen a la configuración de IP.
ipconfigurationId	string	Identificador de la configuración de IP que pertenece a la puerta de enlace.
tunnelIpAddresses	string[]	Lista de direcciones IP públicas de túnel que pertenecen a la configuración de IP.

O365BreakOutCategoryPolicies

Categorías de interrupción de Office365.

Nombre	Tipo	Description
allow	boolean	Marca para controlar la categoría permitida.
default	boolean	Marca para controlar la categoría predeterminada.
optimize	boolean	Marca para controlar la categoría de optimización.

O365PolicyProperties

Directiva de interrupción de Office365.

Nombre	Tipo	Description
breakOutCategories	O365BreakOutCategoryPolicies	Categorías de interrupción de Office365.

ProvisioningState

Estado de aprovisionamiento actual.

Nombre	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Referencia a otro subrecurso.

Nombre	Tipo	Description
id	string	Identificador de recurso.

VpnLinkBgpSettings

Detalles de configuración de BGP para un vínculo.

Nombre	Tipo	Description
asn	integer	ASN del altavoz BGP.
bgpPeeringAddress	string	Dirección de emparejamiento BGP e identificador BGP de este altavoz BGP.

VpnLinkProviderProperties

Lista de propiedades de un proveedor de vínculos.

Nombre	Tipo	Description
linkProviderName	string	Nombre del proveedor de vínculos.
linkSpeedInMbps	integer	Velocidad de vínculo.

VpnSite

Recurso VpnSite.

Nombre	Tipo	Description
etag	string	Cadena de solo lectura única que cambia cada vez que se actualiza el recurso.
id	string	Identificador de recurso.
location	string	Ubicación del recurso.
name	string	Nombre del recurso.
properties.addressSpace	AddressSpace	Espacio de direcciones que contiene una matriz de intervalos de direcciones IP.
properties.bgpProperties	BgpSettings	Conjunto de propiedades bgp.
properties.deviceProperties	DeviceProperties	Propiedades del dispositivo.
properties.ipAddress	string	Dirección IP del sitio vpn.
properties.isSecuritySite	boolean	Marca IsSecuritySite.
properties.o365Policy	O365PolicyProperties	Directiva de Office365.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso de sitio VPN.
properties.siteKey	string	Clave para vpn-site que se puede usar para las conexiones.
properties.virtualWan	SubResource	VirtualWAN al que pertenece vpnSite.
properties.vpnSiteLinks	VpnSiteLink[]	Lista de todos los vínculos de sitios vpn.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

VpnSiteLink

Recurso VpnSiteLink.

Nombre	Tipo	Description
etag	string	Cadena de solo lectura única que cambia cada vez que se actualiza el recurso.
id	string	Identificador de recurso.
name	string	Nombre del recurso que es único dentro de un grupo de recursos. Este nombre se puede usar para acceder al recurso.
properties.bgpProperties	VpnLinkBgpSettings	Conjunto de propiedades bgp.
properties.fqdn	string	FQDN de vpn-site-link.
properties.ipAddress	string	Dirección IP del vínculo vpn-site-link.
properties.linkProperties	VpnLinkProviderProperties	Propiedades del proveedor de vínculos.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso de vínculo del sitio VPN.
type	string	Tipo de recurso.

Compartir a través de

Vpn Sites - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

VpnSiteGet

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AddressSpace

BgpSettings

CloudError

CloudErrorBody

DeviceProperties

IpamPoolPrefixAllocation

IPConfigurationBgpPeeringAddress

O365BreakOutCategoryPolicies

O365PolicyProperties

ProvisioningState

SubResource

VpnLinkBgpSettings

VpnLinkProviderProperties

VpnSite

VpnSiteLink

Recursos adicionales