Virtual Networks - Update

Service:

Dev Test Labs

API Version:

2018-09-15

Позволяет изменять теги виртуальных сетей. Все остальные свойства будут игнорироваться.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks/{name}?api-version=2018-09-15

Параметры URI

Имя	В	Обязательно	Тип	Описание
labName	path	True	string	Имя лаборатории.
name	path	True	string	Имя виртуальной сети.
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Идентификатор подписки.
api-version	query	True	string	Версия API клиента.

Текст запроса

Имя	Тип	Описание
tags	object	Теги ресурса.

Ответы

Имя	Тип	Описание
200 OK	VirtualNetwork	ОК
Other Status Codes	CloudError	BadRequest

Безопасность

azure_auth

Неявное предоставление OAuth2

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

Scopes

Имя	Описание
user_impersonation	Доступ к Microsoft Azure

Примеры

VirtualNetworks_Update

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks/{virtualNetworkName}?api-version=2018-09-15

{
  "tags": {
    "tagName1": "tagValue1"
  }
}

Java

import com.azure.resourcemanager.devtestlabs.models.VirtualNetwork;
import java.util.HashMap;
import java.util.Map;

/** Samples for VirtualNetworks Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Update.json
     */
    /**
     * Sample code: VirtualNetworks_Update.
     *
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void virtualNetworksUpdate(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        VirtualNetwork resource =
            manager
                .virtualNetworks()
                .getWithResponse(
                    "resourceGroupName", "{labName}", "{virtualNetworkName}", null, com.azure.core.util.Context.NONE)
                .getValue();
        resource.update().withTags(mapOf("tagName1", "tagValue1")).apply();
    }

    // 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.devtestlabs import DevTestLabsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devtestlabs
# USAGE
    python virtual_networks_update.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 = DevTestLabsClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscriptionId}",
    )

    response = client.virtual_networks.update(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
        name="{virtualNetworkName}",
    )
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Update.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 armdevtestlabs_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/devtestlabs/armdevtestlabs"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Update.json
func ExampleVirtualNetworksClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdevtestlabs.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVirtualNetworksClient().Update(ctx, "resourceGroupName", "{labName}", "{virtualNetworkName}", armdevtestlabs.VirtualNetworkFragment{
		Tags: map[string]*string{
			"tagName1": to.Ptr("tagValue1"),
		},
	}, 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.VirtualNetwork = armdevtestlabs.VirtualNetwork{
	// 	Name: to.Ptr("{virtualNetworkName}"),
	// 	Type: to.Ptr("Microsoft.DevTestLab/labs/virtualNetworks"),
	// 	ID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualnetworks/{virtualNetworkName}"),
	// 	Tags: map[string]*string{
	// 		"tagName1": to.Ptr("tagValue1"),
	// 	},
	// 	Properties: &armdevtestlabs.VirtualNetworkProperties{
	// 		CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-01T20:01:44.600Z"); return t}()),
	// 		ExternalProviderResourceID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}"),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		SubnetOverrides: []*armdevtestlabs.SubnetOverride{
	// 			{
	// 				LabSubnetName: to.Ptr("{virtualNetworkName}Subnet"),
	// 				ResourceID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{virtualNetworkName}Subnet"),
	// 				SharedPublicIPAddressConfiguration: &armdevtestlabs.SubnetSharedPublicIPAddressConfiguration{
	// 					AllowedPorts: []*armdevtestlabs.Port{
	// 						{
	// 							BackendPort: to.Ptr[int32](3389),
	// 							TransportProtocol: to.Ptr(armdevtestlabs.TransportProtocolTCP),
	// 						},
	// 						{
	// 							BackendPort: to.Ptr[int32](22),
	// 							TransportProtocol: to.Ptr(armdevtestlabs.TransportProtocolTCP),
	// 					}},
	// 				},
	// 				UseInVMCreationPermission: to.Ptr(armdevtestlabs.UsagePermissionTypeAllow),
	// 				UsePublicIPAddressPermission: to.Ptr(armdevtestlabs.UsagePermissionTypeAllow),
	// 		}},
	// 		UniqueIdentifier: to.Ptr("{uniqueIdentifier}"),
	// 	},
	// }
}

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 { DevTestLabsClient } = require("@azure/arm-devtestlabs");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Allows modifying tags of virtual networks. All other properties will be ignored.
 *
 * @summary Allows modifying tags of virtual networks. All other properties will be ignored.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Update.json
 */
async function virtualNetworksUpdate() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const name = "{virtualNetworkName}";
  const virtualNetwork = {
    tags: { tagName1: "tagValue1" },
  };
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.virtualNetworks.update(
    resourceGroupName,
    labName,
    name,
    virtualNetwork
  );
  console.log(result);
}

virtualNetworksUpdate().catch(console.error);

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.DevTestLabs;
using Azure.ResourceManager.DevTestLabs.Models;

// Generated from example definition: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Update.json
// this example is just showing the usage of "VirtualNetworks_Update" 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 DevTestLabVirtualNetworkResource created on azure
// for more information of creating DevTestLabVirtualNetworkResource, please refer to the document of DevTestLabVirtualNetworkResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "resourceGroupName";
string labName = "{labName}";
string name = "{virtualNetworkName}";
ResourceIdentifier devTestLabVirtualNetworkResourceId = DevTestLabVirtualNetworkResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, labName, name);
DevTestLabVirtualNetworkResource devTestLabVirtualNetwork = client.GetDevTestLabVirtualNetworkResource(devTestLabVirtualNetworkResourceId);

// invoke the operation
DevTestLabVirtualNetworkPatch patch = new DevTestLabVirtualNetworkPatch()
{
    Tags =
    {
    ["tagName1"] = "tagValue1",
    },
};
DevTestLabVirtualNetworkResource result = await devTestLabVirtualNetwork.UpdateAsync(patch);

// 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
DevTestLabVirtualNetworkData 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

{
  "properties": {
    "externalProviderResourceId": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}",
    "subnetOverrides": [
      {
        "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{virtualNetworkName}Subnet",
        "labSubnetName": "{virtualNetworkName}Subnet",
        "useInVmCreationPermission": "Allow",
        "usePublicIpAddressPermission": "Allow",
        "sharedPublicIpAddressConfiguration": {
          "allowedPorts": [
            {
              "transportProtocol": "Tcp",
              "backendPort": 3389
            },
            {
              "transportProtocol": "Tcp",
              "backendPort": 22
            }
          ]
        }
      }
    ],
    "createdDate": "2018-10-01T13:01:44.6005134-07:00",
    "provisioningState": "Succeeded",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualnetworks/{virtualNetworkName}",
  "name": "{virtualNetworkName}",
  "type": "Microsoft.DevTestLab/labs/virtualNetworks",
  "tags": {
    "tagName1": "tagValue1"
  }
}

Определения

Имя	Описание
CloudError	Ошибка из запроса REST.
CloudErrorBody	Текст ошибки из запроса REST.
ExternalSubnet	Сведения о подсети, возвращаемые API Microsoft.Network.
Port	Свойства сетевого порта.
Subnet	Сведения о подсети.
SubnetOverride	Свойство переопределяется в подсети виртуальной сети.
SubnetSharedPublicIpAddressConfiguration	Настройка общего доступа к общедоступным IP-адресам.
TransportProtocol	Транспортный протокол для конечной точки.
UsagePermissionType	Политика разрешений подсети для разрешения общедоступных IP-адресов (т. е. Разрешить, Запретить)).
VirtualNetwork	Виртуальная сеть.
VirtualNetworkFragment	Виртуальная сеть.

CloudError

Ошибка из запроса REST.

Имя	Тип	Описание
error	CloudErrorBody	Произошла облачная ошибка

CloudErrorBody

Текст ошибки из запроса REST.

Имя	Тип	Описание
code	string	Код ошибки.
details	CloudErrorBody[]	Внутренние ошибки.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ExternalSubnet

Сведения о подсети, возвращаемые API Microsoft.Network.

Имя	Тип	Описание
id	string	Возвращает или задает идентификатор.
name	string	Возвращает или задает имя.

Port

Свойства сетевого порта.

Имя	Тип	Описание
backendPort	integer	Внутренний порт целевой виртуальной машины.
transportProtocol	TransportProtocol	Тип протокола порта.

Subnet

Сведения о подсети.

Имя	Тип	Описание
allowPublicIp	UsagePermissionType	Политика разрешений подсети для разрешения общедоступных IP-адресов (т. е. Разрешить, Запретить)).
labSubnetName	string	Имя подсети, как показано в лаборатории.
resourceId	string	Идентификатор ресурса подсети.

SubnetOverride

Свойство переопределяется в подсети виртуальной сети.

Имя	Тип	Описание
labSubnetName	string	Имя, данное подсети в лаборатории.
resourceId	string	Идентификатор ресурса подсети.
sharedPublicIpAddressConfiguration	SubnetSharedPublicIpAddressConfiguration	Свойства, которые будут совместно использовать виртуальные машины в этой подсети.
useInVmCreationPermission	UsagePermissionType	Указывает, можно ли использовать эту подсеть во время создания виртуальной машины (например, Разрешить, Запретить).
usePublicIpAddressPermission	UsagePermissionType	Указывает, можно ли назначать общедоступные IP-адреса виртуальным машинам в этой подсети (т. е. Разрешить, Запретить).
virtualNetworkPoolName	string	Пул виртуальных сетей, связанный с этой подсетью.

SubnetSharedPublicIpAddressConfiguration

Настройка общего доступа к общедоступным IP-адресам.

Имя	Тип	Описание
allowedPorts	Port[]	Внутренние порты, которые могут предоставляться виртуальным машинам в этой подсети

TransportProtocol

Транспортный протокол для конечной точки.

Имя	Тип	Описание
Tcp	string
Udp	string

UsagePermissionType

Политика разрешений подсети для разрешения общедоступных IP-адресов (т. е. Разрешить, Запретить)).

Имя	Тип	Описание
Allow	string
Default	string
Deny	string

VirtualNetwork

Виртуальная сеть.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
location	string	Расположение ресурса.
name	string	Имя ресурса.
properties.allowedSubnets	Subnet[]	Разрешенные подсети виртуальной сети.
properties.createdDate	string	Дата создания виртуальной сети.
properties.description	string	Описание виртуальной сети.
properties.externalProviderResourceId	string	Идентификатор ресурса Microsoft.Network виртуальной сети.
properties.externalSubnets	ExternalSubnet[]	Свойства внешней подсети.
properties.provisioningState	string	Состояние подготовки ресурса.
properties.subnetOverrides	SubnetOverride[]	Переопределения подсети виртуальной сети.
properties.uniqueIdentifier	string	Уникальный неизменяемый идентификатор ресурса (GUID).
tags	object	Теги ресурса.
type	string	Тип ресурса.

VirtualNetworkFragment

Виртуальная сеть.

Имя	Тип	Описание
tags	object	Теги ресурса.