你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Virtual Machines - Update

参考

服务:: Operator Nexus - Network Cloud

API 版本:: 2023-07-01

修补虚拟机。
修补提供的虚拟机的属性，或更新与虚拟机关联的标记。属性和标记更新可以独立完成。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}?api-version=2023-07-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
virtualMachineName	path	True	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$	虚拟机的名称。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求正文

名称	类型	说明
properties.vmImageRepositoryCredentials	ImageRepositoryCredentials	ImageRepositoryCredentials 表示用于登录到映像存储库的凭据。用于登录到有权访问指定映像的映像存储库的凭据。
tags	object	将替换现有标记的 Azure 资源标记。

响应

名称

类型

说明

200 OK

还行

202 Accepted

已接受

标头

Azure-AsyncOperation: string

Other Status Codes

描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Patch virtual machine

示例请求

PATCH https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName?api-version=2023-07-01

{
  "tags": {
    "key1": "myvalue1",
    "key2": "myvalue2"
  },
  "properties": {
    "vmImageRepositoryCredentials": {
      "username": "myuser",
      "password": "{password}",
      "registryUrl": "myacr.azurecr.io"
    }
  }
}

import com.azure.resourcemanager.networkcloud.models.ImageRepositoryCredentials;
import com.azure.resourcemanager.networkcloud.models.VirtualMachine;
import java.util.HashMap;
import java.util.Map;

/** Samples for VirtualMachines Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2023-07-01/examples/VirtualMachines_Patch.json
     */
    /**
     * Sample code: Patch virtual machine.
     *
     * @param manager Entry point to NetworkCloudManager.
     */
    public static void patchVirtualMachine(com.azure.resourcemanager.networkcloud.NetworkCloudManager manager) {
        VirtualMachine resource =
            manager
                .virtualMachines()
                .getByResourceGroupWithResponse(
                    "resourceGroupName", "virtualMachineName", com.azure.core.util.Context.NONE)
                .getValue();
        resource
            .update()
            .withTags(mapOf("key1", "fakeTokenPlaceholder", "key2", "fakeTokenPlaceholder"))
            .withVmImageRepositoryCredentials(
                new ImageRepositoryCredentials()
                    .withPassword("fakeTokenPlaceholder")
                    .withRegistryUrl("myacr.azurecr.io")
                    .withUsername("myuser"))
            .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

from azure.identity import DefaultAzureCredential
from azure.mgmt.networkcloud import NetworkCloudMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-networkcloud
# USAGE
    python virtual_machines_patch.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 = NetworkCloudMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="123e4567-e89b-12d3-a456-426655440000",
    )

    response = client.virtual_machines.begin_update(
        resource_group_name="resourceGroupName",
        virtual_machine_name="virtualMachineName",
    ).result()
    print(response)


# x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2023-07-01/examples/VirtualMachines_Patch.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 armnetworkcloud_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/networkcloud/armnetworkcloud"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2023-07-01/examples/VirtualMachines_Patch.json
func ExampleVirtualMachinesClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetworkcloud.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewVirtualMachinesClient().BeginUpdate(ctx, "resourceGroupName", "virtualMachineName", armnetworkcloud.VirtualMachinePatchParameters{
		Properties: &armnetworkcloud.VirtualMachinePatchProperties{
			VMImageRepositoryCredentials: &armnetworkcloud.ImageRepositoryCredentials{
				Password:    to.Ptr("{password}"),
				RegistryURL: to.Ptr("myacr.azurecr.io"),
				Username:    to.Ptr("myuser"),
			},
		},
		Tags: map[string]*string{
			"key1": to.Ptr("myvalue1"),
			"key2": to.Ptr("myvalue2"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.VirtualMachine = armnetworkcloud.VirtualMachine{
	// 	Name: to.Ptr("virtualMachineName"),
	// 	Type: to.Ptr("Microsoft.NetworkCloud/virtualMachines"),
	// 	ID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName"),
	// 	SystemData: &armnetworkcloud.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-22T13:27:03.008Z"); return t}()),
	// 		CreatedBy: to.Ptr("identityA"),
	// 		CreatedByType: to.Ptr(armnetworkcloud.CreatedByTypeApplication),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-22T13:29:03.001Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("identityB"),
	// 		LastModifiedByType: to.Ptr(armnetworkcloud.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("location"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("myvalue1"),
	// 		"key2": to.Ptr("myvalue2"),
	// 	},
	// 	ExtendedLocation: &armnetworkcloud.ExtendedLocation{
	// 		Name: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"),
	// 		Type: to.Ptr("CustomLocation"),
	// 	},
	// 	Properties: &armnetworkcloud.VirtualMachineProperties{
	// 		AdminUsername: to.Ptr("username"),
	// 		AvailabilityZone: to.Ptr("1"),
	// 		BareMetalMachineID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName"),
	// 		BootMethod: to.Ptr(armnetworkcloud.VirtualMachineBootMethodUEFI),
	// 		CloudServicesNetworkAttachment: &armnetworkcloud.NetworkAttachment{
	// 			AttachedNetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName"),
	// 			IPAllocationMethod: to.Ptr(armnetworkcloud.VirtualMachineIPAllocationMethodDynamic),
	// 		},
	// 		ClusterID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName"),
	// 		CPUCores: to.Ptr[int64](2),
	// 		DetailedStatus: to.Ptr(armnetworkcloud.VirtualMachineDetailedStatusAvailable),
	// 		DetailedStatusMessage: to.Ptr("VM is up and healthy"),
	// 		MemorySizeGB: to.Ptr[int64](8),
	// 		NetworkAttachments: []*armnetworkcloud.NetworkAttachment{
	// 			{
	// 				AttachedNetworkID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName"),
	// 				DefaultGateway: to.Ptr(armnetworkcloud.DefaultGatewayTrue),
	// 				IPAllocationMethod: to.Ptr(armnetworkcloud.VirtualMachineIPAllocationMethodDynamic),
	// 				IPv4Address: to.Ptr("198.51.100.1"),
	// 				IPv6Address: to.Ptr("2001:0db8:0000:0000:0000:0000:0000:0000"),
	// 				MacAddress: to.Ptr("bf:1c:29:31:31:1f"),
	// 				NetworkAttachmentName: to.Ptr("netAttachName01"),
	// 		}},
	// 		NetworkData: to.Ptr("bmV0d29ya0RhdGVTYW1wbGU="),
	// 		PlacementHints: []*armnetworkcloud.VirtualMachinePlacementHint{
	// 			{
	// 				HintType: to.Ptr(armnetworkcloud.VirtualMachinePlacementHintTypeAffinity),
	// 				ResourceID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName"),
	// 				SchedulingExecution: to.Ptr(armnetworkcloud.VirtualMachineSchedulingExecutionHard),
	// 				Scope: to.Ptr(armnetworkcloud.VirtualMachinePlacementHintPodAffinityScope("")),
	// 		}},
	// 		PowerState: to.Ptr(armnetworkcloud.VirtualMachinePowerStateOn),
	// 		ProvisioningState: to.Ptr(armnetworkcloud.VirtualMachineProvisioningStateSucceeded),
	// 		SSHPublicKeys: []*armnetworkcloud.SSHPublicKey{
	// 			{
	// 				KeyData: to.Ptr("ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"),
	// 		}},
	// 		StorageProfile: &armnetworkcloud.StorageProfile{
	// 			OSDisk: &armnetworkcloud.OsDisk{
	// 				CreateOption: to.Ptr(armnetworkcloud.OsDiskCreateOptionEphemeral),
	// 				DeleteOption: to.Ptr(armnetworkcloud.OsDiskDeleteOptionDelete),
	// 				DiskSizeGB: to.Ptr[int64](120),
	// 			},
	// 			VolumeAttachments: []*string{
	// 				to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName")},
	// 			},
	// 			UserData: to.Ptr("dXNlckRhdGVTYW1wbGU="),
	// 			VMDeviceModel: to.Ptr(armnetworkcloud.VirtualMachineDeviceModelTypeT2),
	// 			VMImage: to.Ptr("myacr.azurecr.io/foobar:latest"),
	// 			VMImageRepositoryCredentials: &armnetworkcloud.ImageRepositoryCredentials{
	// 				RegistryURL: to.Ptr("myacr.azurecr.io"),
	// 				Username: to.Ptr("myuser"),
	// 			},
	// 			Volumes: []*string{
	// 				to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName")},
	// 			},
	// 		}
}

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

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

/**
 * This sample demonstrates how to Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine. Properties and tag updates can be done independently.
 *
 * @summary Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine. Properties and tag updates can be done independently.
 * x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2023-07-01/examples/VirtualMachines_Patch.json
 */
async function patchVirtualMachine() {
  const subscriptionId =
    process.env["NETWORKCLOUD_SUBSCRIPTION_ID"] || "123e4567-e89b-12d3-a456-426655440000";
  const resourceGroupName = process.env["NETWORKCLOUD_RESOURCE_GROUP"] || "resourceGroupName";
  const virtualMachineName = "virtualMachineName";
  const virtualMachineUpdateParameters = {
    tags: { key1: "myvalue1", key2: "myvalue2" },
    vmImageRepositoryCredentials: {
      password: "{password}",
      registryUrl: "myacr.azurecr.io",
      username: "myuser",
    },
  };
  const options = {
    virtualMachineUpdateParameters,
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkCloud(credential, subscriptionId);
  const result = await client.virtualMachines.beginUpdateAndWait(
    resourceGroupName,
    virtualMachineName,
    options
  );
  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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.NetworkCloud;
using Azure.ResourceManager.NetworkCloud.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2023-07-01/examples/VirtualMachines_Patch.json
// this example is just showing the usage of "VirtualMachines_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 NetworkCloudVirtualMachineResource created on azure
// for more information of creating NetworkCloudVirtualMachineResource, please refer to the document of NetworkCloudVirtualMachineResource
string subscriptionId = "123e4567-e89b-12d3-a456-426655440000";
string resourceGroupName = "resourceGroupName";
string virtualMachineName = "virtualMachineName";
ResourceIdentifier networkCloudVirtualMachineResourceId = NetworkCloudVirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineName);
NetworkCloudVirtualMachineResource networkCloudVirtualMachine = client.GetNetworkCloudVirtualMachineResource(networkCloudVirtualMachineResourceId);

// invoke the operation
NetworkCloudVirtualMachinePatch patch = new NetworkCloudVirtualMachinePatch()
{
    Tags =
    {
    ["key1"] = "myvalue1",
    ["key2"] = "myvalue2",
    },
    VmImageRepositoryCredentials = new ImageRepositoryCredentials("myacr.azurecr.io", "myuser")
    {
        Password = "{password}",
    },
};
ArmOperation<NetworkCloudVirtualMachineResource> lro = await networkCloudVirtualMachine.UpdateAsync(WaitUntil.Completed, patch);
NetworkCloudVirtualMachineResource result = lro.Value;

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

示例响应

状态代码:: 200

{
  "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName",
  "name": "virtualMachineName",
  "systemData": {
    "createdAt": "2021-01-22T13:27:03.008Z",
    "createdBy": "identityA",
    "createdByType": "Application",
    "lastModifiedAt": "2021-01-22T13:29:03.001Z",
    "lastModifiedBy": "identityB",
    "lastModifiedByType": "User"
  },
  "type": "Microsoft.NetworkCloud/virtualMachines",
  "location": "location",
  "tags": {
    "key1": "myvalue1",
    "key2": "myvalue2"
  },
  "extendedLocation": {
    "type": "CustomLocation",
    "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"
  },
  "properties": {
    "vmImage": "myacr.azurecr.io/foobar:latest",
    "vmImageRepositoryCredentials": {
      "username": "myuser",
      "registryUrl": "myacr.azurecr.io"
    },
    "vmDeviceModel": "T2",
    "cpuCores": 2,
    "memorySizeGB": 8,
    "storageProfile": {
      "osDisk": {
        "createOption": "Ephemeral",
        "deleteOption": "Delete",
        "diskSizeGB": 120
      },
      "volumeAttachments": [
        "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName"
      ]
    },
    "cloudServicesNetworkAttachment": {
      "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName",
      "ipAllocationMethod": "Dynamic"
    },
    "networkAttachments": [
      {
        "networkAttachmentName": "netAttachName01",
        "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName",
        "ipAllocationMethod": "Dynamic",
        "ipv4Address": "198.51.100.1",
        "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000",
        "macAddress": "bf:1c:29:31:31:1f",
        "defaultGateway": "True"
      }
    ],
    "placementHints": [
      {
        "hintType": "Affinity",
        "schedulingExecution": "Hard",
        "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName",
        "scope": ""
      }
    ],
    "userData": "dXNlckRhdGVTYW1wbGU=",
    "networkData": "bmV0d29ya0RhdGVTYW1wbGU=",
    "bootMethod": "UEFI",
    "adminUsername": "username",
    "sshPublicKeys": [
      {
        "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"
      }
    ],
    "provisioningState": "Succeeded",
    "availabilityZone": "1",
    "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName",
    "powerState": "On",
    "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName",
    "detailedStatus": "Available",
    "detailedStatusMessage": "VM is up and healthy",
    "volumes": [
      "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName"
    ]
  }
}

状态代码:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-07-01

{
  "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName",
  "name": "virtualMachineName",
  "systemData": {
    "createdAt": "2021-01-22T13:27:03.008Z",
    "createdBy": "identityA",
    "createdByType": "Application",
    "lastModifiedAt": "2021-01-22T13:29:03.001Z",
    "lastModifiedBy": "identityB",
    "lastModifiedByType": "User"
  },
  "type": "Microsoft.NetworkCloud/virtualMachines",
  "location": "location",
  "tags": {
    "key1": "myvalue1",
    "key2": "myvalue2"
  },
  "extendedLocation": {
    "type": "CustomLocation",
    "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"
  },
  "properties": {
    "vmImage": "myacr.azurecr.io/foobar:latest",
    "vmImageRepositoryCredentials": {
      "username": "myuser",
      "registryUrl": "myacr.azurecr.io"
    },
    "vmDeviceModel": "T2",
    "cpuCores": 2,
    "memorySizeGB": 8,
    "storageProfile": {
      "osDisk": {
        "createOption": "Ephemeral",
        "deleteOption": "Delete",
        "diskSizeGB": 120
      },
      "volumeAttachments": [
        "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName"
      ]
    },
    "cloudServicesNetworkAttachment": {
      "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName",
      "ipAllocationMethod": "Dynamic"
    },
    "networkAttachments": [
      {
        "networkAttachmentName": "netAttachName01",
        "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName",
        "ipAllocationMethod": "Dynamic",
        "ipv4Address": "198.51.100.1",
        "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000",
        "macAddress": "bf:1c:29:31:31:1f",
        "defaultGateway": "True"
      }
    ],
    "placementHints": [
      {
        "hintType": "Affinity",
        "schedulingExecution": "Hard",
        "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName",
        "scope": ""
      }
    ],
    "userData": "dXNlckRhdGVTYW1wbGU=",
    "networkData": "bmV0d29ya0RhdGVTYW1wbGU=",
    "bootMethod": "UEFI",
    "adminUsername": "username",
    "sshPublicKeys": [
      {
        "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"
      }
    ],
    "provisioningState": "Accepted",
    "availabilityZone": "1",
    "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName",
    "powerState": "On",
    "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName",
    "detailedStatus": "Available",
    "detailedStatusMessage": "VM is up and healthy",
    "volumes": [
      "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName"
    ]
  }
}

定义

名称	说明
createdByType	创建资源的标识的类型。
DefaultGateway	指示这是否为默认网关。单个计算机的附加网络（包括 CloudServicesNetwork 附件）只能指定为 True。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ExtendedLocation	ExtendedLocation 表示将在其中创建资源的 Azure 自定义位置。
ImageRepositoryCredentials	ImageRepositoryCredentials 表示用于登录到映像存储库的凭据。
NetworkAttachment	NetworkAttachment 表示单个网络附件。
OsDisk	OsDisk 表示启动磁盘的配置。
OsDiskCreateOption	创建 OS 磁盘的策略。
OsDiskDeleteOption	删除 OS 磁盘的策略。
SshPublicKey	SshPublicKey 表示用于通过 SSH 向资源进行身份验证的公钥。
StorageProfile	StorageProfile 表示有关磁盘的信息。
systemData	与创建和上次修改资源相关的元数据。
VirtualMachine	VirtualMachine 表示本地网络云虚拟机。
VirtualMachineBootMethod	选择虚拟机的启动方法。
VirtualMachineDetailedStatus	虚拟机的更详细状态。
VirtualMachineDeviceModelType	要使用的设备模型的类型。
VirtualMachineIPAllocationMethod	虚拟机的 IP 分配机制。动态和静态仅适用于 l3Network，也可能指定“已禁用”。否则，Disabled 是唯一允许的值。
VirtualMachineIsolateEmulatorThread	字段已弃用，如果提供该值，将忽略该值。指示是否隔离指定 CPU 核心之一来运行此虚拟机的仿真器线程。
VirtualMachinePatchParameters	VirtualMachinePatchParameters 表示修补虚拟机的请求正文。
VirtualMachinePlacementHint	VirtualMachinePlacementHint 表示虚拟机的单个计划提示。
VirtualMachinePlacementHintPodAffinityScope	虚拟机关联或反关联放置提示的范围。在节点关联的情况下，它应始终为“计算机”。
VirtualMachinePlacementHintType	此提示是否支持与所引用资源的相关性或反相关性的规范。
VirtualMachinePowerState	虚拟机的电源状态。
VirtualMachineProvisioningState	虚拟机的预配状态。
VirtualMachineSchedulingExecution	指示提示是计划期间的硬要求还是软要求。
VirtualMachineVirtioInterfaceType	字段已弃用，请改用 virtualizationModel。 virtio 接口的类型。

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

DefaultGateway

枚举

指示这是否为默认网关。单个计算机的附加网络（包括 CloudServicesNetwork 附件）只能指定为 True。

值	说明
False
True

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ExtendedLocation

Object

ExtendedLocation 表示将在其中创建资源的 Azure 自定义位置。

名称	类型	说明
name	string	要在其中创建资源的扩展位置的资源 ID。
type	string	扩展的位置类型，例如 CustomLocation。

ImageRepositoryCredentials

Object

ImageRepositoryCredentials 表示用于登录到映像存储库的凭据。

名称	类型	说明
password	string minLength: 1	用于访问目标存储库中的映像的密码或令牌。
registryUrl	string	用于验证存储库凭据的身份验证服务器的 URL。
username	string minLength: 1	用于访问目标存储库中的映像的用户名。

NetworkAttachment

Object

NetworkAttachment 表示单个网络附件。

名称	类型	说明
attachedNetworkId	string	附加到虚拟机的关联网络的资源 ID。它可以是 cloudServicesNetwork、l3Network、l2Network 或 trunkedNetwork 资源之一。
defaultGateway	DefaultGateway	指示这是否为默认网关。单个计算机的附加网络（包括 CloudServicesNetwork 附件）只能指定为 True。
ipAllocationMethod	VirtualMachineIPAllocationMethod	虚拟机的 IP 分配机制。动态和静态仅适用于 l3Network，也可能指定“已禁用”。否则，Disabled 是唯一允许的值。
ipv4Address	string	虚拟机的 IPv4 地址。仅当附加网络具有 IPV4 或 DualStack 的 IPAllocationType 时，才使用此字段。如果 IPAllocationMethod 为：Static - 此字段必须包含用户从附加网络中指定的子网内的指定 IPv4 地址。动态 - 此字段为只读字段，但将使用附加网络中指定的子网中的地址进行填充。已禁用 - 此字段将为空。
ipv6Address	string	虚拟机的 IPv6 地址。仅当附加网络具有 IPV6 或 DualStack 的 IPAllocationType 时，才使用此字段。如果 IPAllocationMethod 为：Static - 此字段必须包含从附加网络中指定的范围内的 IPv6 地址范围。动态 - 此字段为只读字段，但将从附加网络中指定的子网内填充范围。已禁用 - 此字段将为空。
macAddress	string	对应于此网络附件的虚拟机的接口的 MAC 地址。
networkAttachmentName	string maxLength: 15	关联的网络的接口名称。如果指定，则网络附件名称的最大长度为 15 个字符，并且必须对此虚拟机是唯一的。如果用户未指定此值，将使用网络资源的默认接口名称。对于 CloudServicesNetwork 资源，将忽略此名称。

OsDisk

Object

OsDisk 表示启动磁盘的配置。

名称	类型	默认值	说明
createOption	OsDiskCreateOption	Ephemeral	创建 OS 磁盘的策略。
deleteOption	OsDiskDeleteOption	Delete	删除 OS 磁盘的策略。
diskSizeGB	integer (int64)		磁盘的大小（以 GB 为单位）。如果 createOption 为临时，则为必需。

OsDiskCreateOption

枚举

创建 OS 磁盘的策略。

值	说明
Ephemeral

OsDiskDeleteOption

枚举

删除 OS 磁盘的策略。

值	说明
Delete

SshPublicKey

Object

SshPublicKey 表示用于通过 SSH 向资源进行身份验证的公钥。

名称	类型	说明
keyData	string minLength: 1	SSH 公钥数据。

StorageProfile

Object

StorageProfile 表示有关磁盘的信息。

名称	类型	说明
osDisk	OsDisk	OsDisk 表示启动磁盘的配置。要用于此虚拟机的磁盘。
volumeAttachments	string[]	请求附加到虚拟机的卷的资源 ID。

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

VirtualMachine

Object

VirtualMachine 表示本地网络云虚拟机。

名称	类型	默认值	说明
extendedLocation	ExtendedLocation		ExtendedLocation 表示将在其中创建资源的 Azure 自定义位置。与资源关联的群集的扩展位置。
id	string (arm-id)		资源的完全限定资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
location	string		资源所在的地理位置
name	string		资源的名称
properties.adminUsername	string minLength: 1 maxLength: 32 pattern: ^[a-z_][a-z0-9_]{0,31}$		将 SSH 公钥添加到授权密钥的管理员的名称。
properties.availabilityZone	string		包含此虚拟机的群集可用性区域。
properties.bareMetalMachineId	string		虚拟机已到达的裸机的资源 ID。
properties.bootMethod	VirtualMachineBootMethod	UEFI	选择虚拟机的启动方法。
properties.cloudServicesNetworkAttachment	NetworkAttachment		NetworkAttachment 表示单个网络附件。为虚拟机提供平台级服务的云服务网络。
properties.clusterId	string		要为其创建虚拟机的群集的资源 ID。
properties.cpuCores	integer (int64) minimum: 2		虚拟机中的 CPU 核心数。
properties.detailedStatus	VirtualMachineDetailedStatus		虚拟机的更详细状态。
properties.detailedStatusMessage	string		有关当前详细状态的描述性消息。
properties.isolateEmulatorThread	VirtualMachineIsolateEmulatorThread	True	字段已弃用，如果提供该值，将忽略该值。指示是否隔离指定 CPU 核心之一来运行此虚拟机的仿真器线程。
properties.memorySizeGB	integer (int64) minimum: 1		虚拟机的内存大小（以 GB 为单位）。
properties.networkAttachments	NetworkAttachment[]		虚拟机的网络附件列表。
properties.networkData	string		Base64 编码的 cloud-init 网络数据。
properties.placementHints	VirtualMachinePlacementHint[]		虚拟机的计划提示。
properties.powerState	VirtualMachinePowerState		虚拟机的电源状态。
properties.provisioningState	VirtualMachineProvisioningState		虚拟机的预配状态。
properties.sshPublicKeys	SshPublicKey[]		ssh 公钥列表。将使用 adminUsername 的 cloud-init ssh_authorized_keys机制将每个密钥添加到虚拟机。
properties.storageProfile	StorageProfile		StorageProfile 表示有关磁盘的信息。指定与虚拟机相关的磁盘的大小和其他参数的存储配置文件。
properties.userData	string		Base64 编码的 cloud-init 用户数据。
properties.virtioInterface	VirtualMachineVirtioInterfaceType	Modern	字段已弃用，请改用 virtualizationModel。 virtio 接口的类型。
properties.vmDeviceModel	VirtualMachineDeviceModelType	T2	要使用的设备模型的类型。
properties.vmImage	string		当前预配到 OS 磁盘的虚拟机映像，使用用于拉取映像的完整 URL 和标记表示法。
properties.vmImageRepositoryCredentials	ImageRepositoryCredentials		ImageRepositoryCredentials 表示用于登录到映像存储库的凭据。用于登录到有权访问指定映像的映像存储库的凭据。
properties.volumes	string[]		附加到虚拟机的卷的资源 ID。
systemData	systemData		包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object		资源标记。
type	string		资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

VirtualMachineBootMethod

枚举

选择虚拟机的启动方法。

值	说明
BIOS
UEFI

VirtualMachineDetailedStatus

枚举

虚拟机的更详细状态。

值	说明
Available
Error
Provisioning
Running
Scheduling
Stopped
Terminating
Unknown

VirtualMachineDeviceModelType

枚举

要使用的设备模型的类型。

值	说明
T1
T2

VirtualMachineIPAllocationMethod

枚举

虚拟机的 IP 分配机制。动态和静态仅适用于 l3Network，也可能指定“已禁用”。否则，Disabled 是唯一允许的值。

值	说明
Disabled
Dynamic
Static

VirtualMachineIsolateEmulatorThread

枚举

字段已弃用，如果提供该值，将忽略该值。指示是否隔离指定 CPU 核心之一来运行此虚拟机的仿真器线程。

值	说明
False
True

VirtualMachinePatchParameters

Object

VirtualMachinePatchParameters 表示修补虚拟机的请求正文。

名称	类型	说明
properties.vmImageRepositoryCredentials	ImageRepositoryCredentials	ImageRepositoryCredentials 表示用于登录到映像存储库的凭据。用于登录到有权访问指定映像的映像存储库的凭据。
tags	object	将替换现有标记的 Azure 资源标记。

VirtualMachinePlacementHint

Object

VirtualMachinePlacementHint 表示虚拟机的单个计划提示。

名称	类型	说明
hintType	VirtualMachinePlacementHintType	此提示是否支持与所引用资源的相关性或反相关性的规范。
resourceId	string minLength: 1	要托管虚拟机的裸机节点等，将检查放置提示的目标对象的资源 ID。
schedulingExecution	VirtualMachineSchedulingExecution	指示提示是计划期间的硬要求还是软要求。
scope	VirtualMachinePlacementHintPodAffinityScope	虚拟机关联或反关联放置提示的范围。在节点关联的情况下，它应始终为“计算机”。

VirtualMachinePlacementHintPodAffinityScope

枚举

虚拟机关联或反关联放置提示的范围。在节点关联的情况下，它应始终为“计算机”。

值	说明
Machine
Rack

VirtualMachinePlacementHintType

枚举

此提示是否支持与所引用资源的相关性或反相关性的规范。

值	说明
Affinity
AntiAffinity

VirtualMachinePowerState

枚举

虚拟机的电源状态。

值	说明
Off
On
Unknown

VirtualMachineProvisioningState

枚举

虚拟机的预配状态。

值	说明
Accepted
Canceled
Failed
Provisioning
Succeeded

VirtualMachineSchedulingExecution

枚举

指示提示是计划期间的硬要求还是软要求。

值	说明
Hard
Soft

VirtualMachineVirtioInterfaceType

枚举

字段已弃用，请改用 virtualizationModel。 virtio 接口的类型。

值	说明
Modern
Transitional