Vpn Sites - List

Referência

Serviço:: Virtual WAN

Versão da API:: 2024-05-01

Lista todos os VpnSites em uma assinatura.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
subscriptionId	path	True	string	As credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Respostas

Name	Tipo	Description
200 OK	ListVpnSitesResult	Pedido bem-sucedido. Retorna os detalhes de todos os VpnSites na assinatura.
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

VpnSiteList

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

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/VpnSiteList.json
func ExampleVPNSitesClient_NewListPager() {
	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().NewListPager(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/rg2/providers/Microsoft.Network/vpnSites/vpnSite2"),
		// 				Location: to.Ptr("East 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"),
		// 						IsSecuritySite: to.Ptr(false),
		// 						ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 						VirtualWan: &armnetwork.SubResource{
		// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/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

Resposta da amostra

Código de estado:: 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/rg2/providers/Microsoft.Network/vpnSites/vpnSite2",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "location": "East US",
      "name": "vpnSite2",
      "type": "Microsoft.Network/vpnSites",
      "tags": {
        "key1": "value1"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "virtualWan": {
          "id": "/subscriptions/subid/resourceGroups/rg2/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
        },
        "isSecuritySite": false
      }
    }
  ]
}

Definições

Name	Description
AddressSpace	AddressSpace contém uma matriz de intervalos de endereços IP que podem ser usados por sub-redes da rede virtual.
BgpSettings	Detalhes das configurações do BGP.
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
DeviceProperties	Lista de propriedades do dispositivo.
IpamPoolPrefixAllocation	Referência de alocação de prefixo IpamPool.
IPConfigurationBgpPeeringAddress	Propriedades de IPConfigurationBgpPeeringAddress.
ListVpnSitesResult	Resultado da solicitação para listar VpnSites. Ele contém uma lista de VpnSites e um URL nextLink para obter o próximo conjunto de resultados.
O365BreakOutCategoryPolicies	Categorias de breakout do Office365.
O365PolicyProperties	A política de breakout do Office365.
ProvisioningState	O estado de provisionamento atual.
SubResource	Referência a outro subrecurso.
VpnLinkBgpSettings	Detalhes das configurações do BGP para um link.
VpnLinkProviderProperties	Lista de propriedades de um provedor de link.
VpnSite	Recurso VpnSite.
VpnSiteLink	Recurso VpnSiteLink.

AddressSpace

AddressSpace contém uma matriz de intervalos de endereços IP que podem ser usados por sub-redes da rede virtual.

Name	Tipo	Description
addressPrefixes	string[]	Uma lista de blocos de endereços reservados para esta rede virtual na notação CIDR.
ipamPoolPrefixAllocations	IpamPoolPrefixAllocation[]	Uma lista de Pools do IPAM que alocam prefixos de endereço IP.

BgpSettings

Detalhes das configurações do BGP.

Name	Tipo	Description
asn	integer	ASN do orador BGP.
bgpPeeringAddress	string	O endereço de emparelhamento BGP e o identificador BGP deste alto-falante BGP.
bgpPeeringAddresses	IPConfigurationBgpPeeringAddress[]	Endereço de emparelhamento BGP com ID de configuração IP para gateway de rede virtual.
peerWeight	integer	O peso adicionado às rotas aprendidas com este alto-falante BGP.

CloudError

Uma resposta de erro do serviço.

Name	Tipo	Description
error	CloudErrorBody	Corpo do erro na nuvem.

CloudErrorBody

Uma resposta de erro do serviço.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O alvo do erro específico. Por exemplo, o nome da propriedade em erro.

DeviceProperties

Lista de propriedades do dispositivo.

Name	Tipo	Description
deviceModel	string	Modelo do dispositivo.
deviceVendor	string	Nome do fornecedor do dispositivo.
linkSpeedInMbps	integer	Velocidade do link.

IpamPoolPrefixAllocation

Referência de alocação de prefixo IpamPool.

Name	Tipo	Description
allocatedAddressPrefixes	string[]	Lista de prefixos de endereço IP atribuídos no IpamPool do recurso associado.
numberOfIpAddresses	string	Número de endereços IP a alocar.
pool.id	string	ID do recurso associado do Azure IpamPool.

IPConfigurationBgpPeeringAddress

Propriedades de IPConfigurationBgpPeeringAddress.

Name	Tipo	Description
customBgpIpAddresses	string[]	A lista de endereços de emparelhamento BGP personalizados que pertencem à configuração IP.
defaultBgpIpAddresses	string[]	A lista de endereços de emparelhamento BGP padrão que pertencem à configuração IP.
ipconfigurationId	string	O ID da configuração IP que pertence ao gateway.
tunnelIpAddresses	string[]	A lista de endereços IP públicos de túnel que pertencem à configuração IP.

ListVpnSitesResult

Resultado da solicitação para listar VpnSites. Ele contém uma lista de VpnSites e um URL nextLink para obter o próximo conjunto de resultados.

Name	Tipo	Description
nextLink	string	URL para obter o próximo conjunto de resultados da lista de operações, se houver.
value	VpnSite[]	Lista de VpnSites.

O365BreakOutCategoryPolicies

Categorias de breakout do Office365.

Name	Tipo	Description
allow	boolean	Sinalizador para controlar a categoria de permissão.
default	boolean	Sinalizador para controlar a categoria padrão.
optimize	boolean	Sinalizador para controlar a categoria de otimização.

O365PolicyProperties

A política de breakout do Office365.

Name	Tipo	Description
breakOutCategories	O365BreakOutCategoryPolicies	Categorias de breakout do Office365.

ProvisioningState

O estado de provisionamento atual.

Name	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Referência a outro subrecurso.

Name	Tipo	Description
id	string	ID do recurso.

VpnLinkBgpSettings

Detalhes das configurações do BGP para um link.

Name	Tipo	Description
asn	integer	ASN do orador BGP.
bgpPeeringAddress	string	O endereço de emparelhamento BGP e o identificador BGP deste alto-falante BGP.

VpnLinkProviderProperties

Lista de propriedades de um provedor de link.

Name	Tipo	Description
linkProviderName	string	Nome do provedor de link.
linkSpeedInMbps	integer	Velocidade do link.

VpnSite

Recurso VpnSite.

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
location	string	Localização do recurso.
name	string	Nome do recurso.
properties.addressSpace	AddressSpace	O AddressSpace que contém uma matriz de intervalos de endereços IP.
properties.bgpProperties	BgpSettings	O conjunto de propriedades bgp.
properties.deviceProperties	DeviceProperties	As propriedades do dispositivo.
properties.ipAddress	string	O endereço ip do vpn-site.
properties.isSecuritySite	boolean	Sinalizador IsSecuritySite.
properties.o365Policy	O365PolicyProperties	Política do Office365.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de site VPN.
properties.siteKey	string	A chave para vpn-site que pode ser usada para conexões.
properties.virtualWan	SubResource	O VirtualWAN ao qual o vpnSite pertence.
properties.vpnSiteLinks	VpnSiteLink[]	Lista de todos os links de sites vpn.
tags	object	Tags de recursos.
type	string	Tipo de recurso.

VpnSiteLink

Recurso VpnSiteLink.

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso.
properties.bgpProperties	VpnLinkBgpSettings	O conjunto de propriedades bgp.
properties.fqdn	string	FQDN de vpn-site-link.
properties.ipAddress	string	O endereço ip para o vpn-site-link.
properties.linkProperties	VpnLinkProviderProperties	As propriedades do provedor de link.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de link de site VPN.
type	string	Tipo de recurso.

Partilhar via