Vpn Sites - Update Tags

Service:

Virtual WAN

API Version:

2023-09-01

Novedades etiquetas VpnSite.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}?api-version=2023-09-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	Las credenciales de suscripción que identifican de forma exclusiva la suscripción a Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
vpnSiteName	path	True	string	Nombre del vpnSite que se está actualizando.
api-version	query	True	string	Versión de API del cliente.

Cuerpo de la solicitud

Nombre	Tipo	Description
tags	object	Etiquetas del recurso.

Respuestas

Nombre	Tipo	Description
200 OK	VpnSite	Solicitud correcta. Devuelve los detalles de VpnSite actualizado.
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

VpnSiteUpdate

Sample Request

HTTP

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

{
  "tags": {
    "key1": "value1",
    "key2": "value2"
  }
}

Java

import com.azure.resourcemanager.network.models.TagsObject;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for VpnSites UpdateTags.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnSiteUpdateTags.json
     */
    /**
     * Sample code: VpnSiteUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void vpnSiteUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVpnSites().updateTagsWithResponse("rg1", "vpnSite1",
            new TagsObject().withTags(mapOf("key1", "fakeTokenPlaceholder", "key2", "fakeTokenPlaceholder")),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

Python

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_update_tags.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.update_tags(
        resource_group_name="rg1",
        vpn_site_name="vpnSite1",
        vpn_site_parameters={"tags": {"key1": "value1", "key2": "value2"}},
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnSiteUpdateTags.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

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/VpnSiteUpdateTags.json
func ExampleVPNSitesClient_UpdateTags() {
	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().UpdateTags(ctx, "rg1", "vpnSite1", armnetwork.TagsObject{
		Tags: map[string]*string{
			"key1": to.Ptr("value1"),
			"key2": to.Ptr("value2"),
		},
	}, 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"),
	// 		"key2": to.Ptr("value2"),
	// 	},
	// 	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.0.0.0"),
	// 			ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 			VirtualWan: &armnetwork.SubResource{
	// 			},
	// 		},
	// 	}
}

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

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates VpnSite tags.
 *
 * @summary Updates VpnSite tags.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VpnSiteUpdateTags.json
 */
async function vpnSiteUpdate() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const vpnSiteName = "vpnSite1";
  const vpnSiteParameters = {
    tags: { key1: "value1", key2: "value2" },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.vpnSites.updateTags(
    resourceGroupName,
    vpnSiteName,
    vpnSiteParameters,
  );
  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

dotnet

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/VpnSiteUpdateTags.json
// this example is just showing the usage of "VpnSites_UpdateTags" 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
NetworkTagsObject vpnSiteParameters = new NetworkTagsObject()
{
    Tags =
    {
    ["key1"] = "value1",
    ["key2"] = "value2",
    },
};
VpnSiteResource result = await vpnSite.UpdateAsync(vpnSiteParameters);

// 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",
    "key2": "value2"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1",
    "deviceProperties": {
      "deviceVendor": "vendor1",
      "deviceModel": "model01",
      "linkSpeedInMbps": 200
    },
    "ipAddress": "10.0.0.0",
    "addressSpace": {
      "addressPrefixes": [
        "10.0.0.0/16"
      ]
    },
    "bgpProperties": {
      "bgpPeeringAddress": "192.168.0.0",
      "asn": 1234
    }
  }
}

Definiciones

Nombre	Description
AddressSpace	AddressSpace contiene una matriz de intervalos de direcciones IP que pueden utilizarse en 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.
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.
TagsObject	Objeto Tags para operaciones de revisión.
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 utilizarse en 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.

BgpSettings

Detalles de configuración de BGP.

Nombre	Tipo	Description
asn	integer	ASN del altavoz BGP.
bgpPeeringAddress	string	La dirección de emparejamiento BGP y el 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	El peso agregado 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 del vínculo.

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 del recurso.

TagsObject

Objeto Tags para operaciones de revisión.

Nombre	Tipo	Description
tags	object	Etiquetas del recurso.

VpnLinkBgpSettings

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

Nombre	Tipo	Description
asn	integer	ASN del altavoz BGP.
bgpPeeringAddress	string	La dirección de emparejamiento BGP y el 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 del 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 del 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	La 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 sitio vpn.
tags	object	Etiquetas del recurso.
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 del 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.