Virtual Machine Instances - Update

  • Reference
Service:
Azure Arc enabled SCVMM
API Version:
2024-06-01

Updates a virtual machine.
The operation to update a virtual machine instance.

PATCH https://management.azure.com/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default?api-version=2024-06-01

URI Parameters

Name In Required Type Description
resourceUri
 path True

string

The fully qualified Azure Resource manager identifier of the resource.
api-version
 query True

string

The API version to use for this operation.

Request Body

Name Type Description
properties.availabilitySets

AvailabilitySetListItem[]

Availability Sets in vm.
properties.hardwareProfile

HardwareProfileUpdate

Hardware properties.
properties.infrastructureProfile

InfrastructureProfileUpdate

Gets the infrastructure profile.
properties.networkProfile

NetworkProfileUpdate

Network properties.
properties.storageProfile

StorageProfileUpdate

Storage properties.

Responses

Name Type Description
200 OK

VirtualMachineInstance

Azure operation completed successfully.
202 Accepted

Resource update request accepted.

Headers

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

VirtualMachineInstances_Update_MaximumSet
VirtualMachineInstances_Update_MinimumSet

VirtualMachineInstances_Update_MaximumSet

Sample request

PATCH https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default?api-version=2024-06-01

{
  "properties": {
    "availabilitySets": [
      {
        "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName",
        "name": "lwbhaseo"
      }
    ],
    "hardwareProfile": {
      "memoryMB": 5,
      "cpuCount": 22,
      "limitCpuForMigration": "true",
      "dynamicMemoryEnabled": "true",
      "dynamicMemoryMaxMB": 2,
      "dynamicMemoryMinMB": 30
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "name": "kvofzqulbjlbtt",
          "macAddress": "oaeqqegt",
          "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName",
          "ipv4AddressType": "Dynamic",
          "ipv6AddressType": "Dynamic",
          "macAddressType": "Dynamic",
          "nicId": "roxpsvlo"
        }
      ]
    },
    "storageProfile": {
      "disks": [
        {
          "name": "fgnckfymwdsqnfxkdvexuaobe",
          "diskId": "ltdrwcfjklpsimhzqyh",
          "diskSizeGB": 30,
          "bus": 8,
          "lun": 10,
          "busType": "zu",
          "vhdType": "cnbeeeylrvopigdynvgpkfp",
          "storageQoSPolicy": {
            "name": "ceiyfrflu",
            "id": "o"
          }
        }
      ]
    },
    "infrastructureProfile": {
      "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz"
    }
  }
}

Sample response

Status code:
200 
{
  "properties": {
    "availabilitySets": [
      {
        "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName",
        "name": "lwbhaseo"
      }
    ],
    "osProfile": {
      "computerName": "uuxpcxuxcufllc",
      "osType": "Windows",
      "osSku": "cxqnjxgkts",
      "osVersion": "djt"
    },
    "hardwareProfile": {
      "memoryMB": 5,
      "cpuCount": 22,
      "limitCpuForMigration": "true",
      "dynamicMemoryEnabled": "true",
      "dynamicMemoryMaxMB": 2,
      "dynamicMemoryMinMB": 30,
      "isHighlyAvailable": "true"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "name": "kvofzqulbjlbtt",
          "displayName": "yoayfd",
          "ipv4Addresses": [
            "eeunirpkpqazzxhsqonkxcfuks"
          ],
          "ipv6Addresses": [
            "pk"
          ],
          "macAddress": "oaeqqegt",
          "virtualNetworkId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualNetworks/virtualNetworkName",
          "networkName": "lqbm",
          "ipv4AddressType": "Dynamic",
          "ipv6AddressType": "Dynamic",
          "macAddressType": "Dynamic",
          "nicId": "roxpsvlo"
        }
      ]
    },
    "storageProfile": {
      "disks": [
        {
          "name": "fgnckfymwdsqnfxkdvexuaobe",
          "displayName": "fgladknawlgjodo",
          "diskId": "ltdrwcfjklpsimhzqyh",
          "diskSizeGB": 30,
          "maxDiskSizeGB": 18,
          "bus": 8,
          "lun": 10,
          "busType": "zu",
          "vhdType": "cnbeeeylrvopigdynvgpkfp",
          "volumeType": "ckkymkuekzzqhexyjueruzlfemoeln",
          "vhdFormatType": "vbcrrmhgahznifudvhxfagwoplcb",
          "templateDiskId": "lcdwrokpyvekqccclf",
          "storageQoSPolicy": {
            "name": "ceiyfrflu",
            "id": "o"
          },
          "createDiffDisk": "true"
        }
      ]
    },
    "infrastructureProfile": {
      "inventoryItemId": "ihkkqmg",
      "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName",
      "cloudId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName",
      "templateId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineTemplates/virtualMachineTemplateName",
      "vmName": "qovpayfydhcvfrhe",
      "uuid": "hrpw",
      "lastRestoredVMCheckpoint": {
        "parentCheckpointID": "hqhhzikoxunuqguouw",
        "checkpointID": "wsqmrje",
        "name": "keqn",
        "description": "qurzfrgyflrh"
      },
      "checkpointType": "jkbpzjxpeegackhsvikrnlnwqz",
      "generation": 28,
      "biosGuid": "xixivxifyql",
      "checkpoints": [
        {
          "parentCheckpointID": "hqhhzikoxunuqguouw",
          "checkpointID": "wsqmrje",
          "name": "keqn",
          "description": "kz"
        }
      ]
    },
    "powerState": "dbqyxewvrbqcifpwfvxyllwyaffmvm",
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "type": "customLocation",
    "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName"
  },
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default",
  "name": "uuqpsdoiyvedvqtrwop",
  "type": "zculorteltpvthtzgnpgdpoe",
  "systemData": {
    "createdBy": "p",
    "createdByType": "User",
    "createdAt": "2024-01-29T22:28:00.094Z",
    "lastModifiedBy": "goxcwpyyqlxndquly",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-01-29T22:28:00.095Z"
  }
}
Status code:
202 
location: https://contoso.com/operationstatus

VirtualMachineInstances_Update_MinimumSet

Sample request

PATCH https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default?api-version=2024-06-01

{}

Sample response

Status code:
200 
{
  "extendedLocation": {}
}
Status code:
202 
location: https://contoso.com/operationstatus

Definitions

Name Description
AllocationMethod

Network address allocation method.
AvailabilitySetListItem

Availability Set model
Checkpoint

Defines the resource properties.
createdByType

The type of identity that created the resource.
CreateDiffDisk

Create diff disk.
DynamicMemoryEnabled

Dynamic memory enabled.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
ExtendedLocation

The extended location.
HardwareProfile

Defines the resource properties.
HardwareProfileUpdate

Defines the resource update properties.
InfrastructureProfile

Specifies the vmmServer infrastructure specific settings for the virtual machine instance.
InfrastructureProfileUpdate

Specifies the vmmServer infrastructure specific update settings for the virtual machine instance.
IsHighlyAvailable

Highly available.
LimitCpuForMigration

Limit CPU for migration.
NetworkInterface

Network Interface model
NetworkInterfaceUpdate

Network Interface Update model
NetworkProfile

Defines the resource properties.
NetworkProfileUpdate

Defines the resource update properties.
OsProfileForVmInstance

Defines the resource properties.
OsType

Virtual machine operating system type.
ProvisioningState

The provisioning state of the resource.
StorageProfile

Defines the resource properties.
StorageProfileUpdate

Defines the resource update properties.
StorageQosPolicyDetails

The StorageQoSPolicyDetails definition.
systemData

Metadata pertaining to creation and last modification of the resource.
VirtualDisk

Virtual disk model
VirtualDiskUpdate

Virtual Disk Update model
VirtualMachineInstance

Define the virtualMachineInstance.
VirtualMachineInstanceUpdate

The type used for update operations of the VirtualMachineInstance.

AllocationMethod

Network address allocation method.

Name Type Description
Dynamic

string

Dynamically allocated address.
Static

string

Statically allocated address.

AvailabilitySetListItem

Availability Set model

Name Type Description
id

string

Gets the ARM Id of the microsoft.scvmm/availabilitySets resource.
name

string

Gets or sets the name of the availability set.

Checkpoint

Defines the resource properties.

Name Type Description
checkpointID

string

Gets ID of the checkpoint.
description

string

Gets description of the checkpoint.
name

string

Gets name of the checkpoint.
parentCheckpointID

string

Gets ID of parent of the checkpoint.

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

CreateDiffDisk

Create diff disk.

Name Type Description
false

string

Disable create diff disk.
true

string

Enable create diff disk.

DynamicMemoryEnabled

Dynamic memory enabled.

Name Type Description
false

string

Disable dynamic memory.
true

string

Enable dynamic memory.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

ExtendedLocation

The extended location.

Name Type Description
name

string

The extended location name.
type

string

The extended location type.

HardwareProfile

Defines the resource properties.

Name Type Description
cpuCount

integer

Gets or sets the number of vCPUs for the vm.
dynamicMemoryEnabled

DynamicMemoryEnabled

Gets or sets a value indicating whether to enable dynamic memory or not.
dynamicMemoryMaxMB

integer

Gets or sets the max dynamic memory for the vm.
dynamicMemoryMinMB

integer

Gets or sets the min dynamic memory for the vm.
isHighlyAvailable

IsHighlyAvailable

Gets highly available property.
limitCpuForMigration

LimitCpuForMigration

Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs.
memoryMB

integer

MemoryMB is the size of a virtual machine's memory, in MB.

HardwareProfileUpdate

Defines the resource update properties.

Name Type Description
cpuCount

integer

Gets or sets the number of vCPUs for the vm.
dynamicMemoryEnabled

DynamicMemoryEnabled

Gets or sets a value indicating whether to enable dynamic memory or not.
dynamicMemoryMaxMB

integer

Gets or sets the max dynamic memory for the vm.
dynamicMemoryMinMB

integer

Gets or sets the min dynamic memory for the vm.
limitCpuForMigration

LimitCpuForMigration

Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs.
memoryMB

integer

MemoryMB is the size of a virtual machine's memory, in MB.

InfrastructureProfile

Specifies the vmmServer infrastructure specific settings for the virtual machine instance.

Name Type Description
biosGuid

string

Gets or sets the bios guid for the vm.
checkpointType

string

Type of checkpoint supported for the vm.
checkpoints

Checkpoint[]

Checkpoints in the vm.
cloudId

string

ARM Id of the cloud resource to use for deploying the vm.
generation

integer

Gets or sets the generation for the vm.
inventoryItemId

string

Gets or sets the inventory Item ID for the resource.
lastRestoredVMCheckpoint

Checkpoint

Last restored checkpoint in the vm.
templateId

string

ARM Id of the template resource to use for deploying the vm.
uuid

string

Unique ID of the virtual machine.
vmName

string

VMName is the name of VM on the SCVmm server.
vmmServerId

string

ARM Id of the vmmServer resource in which this resource resides.

InfrastructureProfileUpdate

Specifies the vmmServer infrastructure specific update settings for the virtual machine instance.

Name Type Description
checkpointType

string

Type of checkpoint supported for the vm.

IsHighlyAvailable

Highly available.

Name Type Description
false

string

Disable highly available.
true

string

Enable highly available.

LimitCpuForMigration

Limit CPU for migration.

Name Type Description
false

string

Disable limit CPU for migration.
true

string

Enable limit CPU for migration.

NetworkInterface

Network Interface model

Name Type Description
displayName

string

Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set.
ipv4AddressType

AllocationMethod

Gets or sets the ipv4 address type.
ipv4Addresses

string[]

Gets the nic ipv4 addresses.
ipv6AddressType

AllocationMethod

Gets or sets the ipv6 address type.
ipv6Addresses

string[]

Gets the nic ipv6 addresses.
macAddress

string

Gets or sets the nic MAC address.
macAddressType

AllocationMethod

Gets or sets the mac address type.
name

string

Gets or sets the name of the network interface.
networkName

string

Gets the name of the virtual network in vmmServer that the nic is connected to.
nicId

string

Gets or sets the nic id.
virtualNetworkId

string

Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic.

NetworkInterfaceUpdate

Network Interface Update model

Name Type Description
ipv4AddressType

AllocationMethod

Gets or sets the ipv4 address type.
ipv6AddressType

AllocationMethod

Gets or sets the ipv6 address type.
macAddress

string

Gets or sets the nic MAC address.
macAddressType

AllocationMethod

Gets or sets the mac address type.
name

string

Gets or sets the name of the network interface.
nicId

string

Gets or sets the nic id.
virtualNetworkId

string

Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic.

NetworkProfile

Defines the resource properties.

Name Type Description
networkInterfaces

NetworkInterface[]

Gets or sets the list of network interfaces associated with the virtual machine.

NetworkProfileUpdate

Defines the resource update properties.

Name Type Description
networkInterfaces

NetworkInterfaceUpdate[]

Gets or sets the list of network interfaces associated with the virtual machine.

OsProfileForVmInstance

Defines the resource properties.

Name Type Description
adminPassword

string

Admin password of the virtual machine.
computerName

string

Gets or sets computer name.
domainName

string

Gets or sets the domain name.
domainPassword

string

Password of the domain the VM has to join.
domainUsername

string

Gets or sets the domain username.
osSku

string

Gets os sku.
osType

OsType

Gets the type of the os.
osVersion

string

Gets os version.
productKey

string

Gets or sets the product key.Input format xxxxx-xxxxx-xxxxx-xxxxx-xxxxx
runOnceCommands

string

Get or sets the commands to be run once at the time of creation separated by semicolons.
timezone

integer

Gets or sets the index value of the timezone.
workgroup

string

Gets or sets the workgroup.

OsType

Virtual machine operating system type.

Name Type Description
Linux

string

Linux operating system.
Other

string

Other operating system.
Windows

string

Windows operating system.

ProvisioningState

The provisioning state of the resource.

Name Type Description
Accepted

string

The resource has been accepted.
Canceled

string

Resource creation was canceled.
Created

string

The resource was created.
Deleting

string

The resource is being deleted.
Failed

string

Resource creation failed.
Provisioning

string

The resource is provisioning.
Succeeded

string

Resource has been created.
Updating

string

The resource is updating.

StorageProfile

Defines the resource properties.

Name Type Description
disks

VirtualDisk[]

Gets or sets the list of virtual disks associated with the virtual machine.

StorageProfileUpdate

Defines the resource update properties.

Name Type Description
disks

VirtualDiskUpdate[]

Gets or sets the list of virtual disks associated with the virtual machine.

StorageQosPolicyDetails

The StorageQoSPolicyDetails definition.

Name Type Description
id

string

The ID of the QoS policy.
name

string

The name of the policy.

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

The timestamp of resource creation (UTC).
createdBy

string

The identity that created the resource.
createdByType

createdByType

The type of identity that created the resource.
lastModifiedAt

string

The timestamp of resource last modification (UTC)
lastModifiedBy

string

The identity that last modified the resource.
lastModifiedByType

createdByType

The type of identity that last modified the resource.

VirtualDisk

Virtual disk model

Name Type Description
bus

integer

Gets or sets the disk bus.
busType

string

Gets or sets the disk bus type.
createDiffDisk

CreateDiffDisk

Gets or sets a value indicating diff disk.
diskId

string

Gets or sets the disk id.
diskSizeGB

integer

Gets or sets the disk total size.
displayName

string

Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set.
lun

integer

Gets or sets the disk lun.
maxDiskSizeGB

integer

Gets the max disk size.
name

string

Gets or sets the name of the disk.
storageQoSPolicy

StorageQosPolicyDetails

The QoS policy for the disk.
templateDiskId

string

Gets or sets the disk id in the template.
vhdFormatType

string

Gets the disk vhd format type.
vhdType

string

Gets or sets the disk vhd type.
volumeType

string

Gets the disk volume type.

VirtualDiskUpdate

Virtual Disk Update model

Name Type Description
bus

integer

Gets or sets the disk bus.
busType

string

Gets or sets the disk bus type.
diskId

string

Gets or sets the disk id.
diskSizeGB

integer

Gets or sets the disk total size.
lun

integer

Gets or sets the disk lun.
name

string

Gets or sets the name of the disk.
storageQoSPolicy

StorageQosPolicyDetails

The QoS policy for the disk.
vhdType

string

Gets or sets the disk vhd type.

VirtualMachineInstance

Define the virtualMachineInstance.

Name Type Description
extendedLocation

ExtendedLocation

Gets or sets the extended location.
id

string

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

The name of the resource
properties.availabilitySets

AvailabilitySetListItem[]

Availability Sets in vm.
properties.hardwareProfile

HardwareProfile

Hardware properties.
properties.infrastructureProfile

InfrastructureProfile

Gets the infrastructure profile.
properties.networkProfile

NetworkProfile

Network properties.
properties.osProfile

OsProfileForVmInstance

OS properties.
properties.powerState

string

Gets the power state of the virtual machine.
properties.provisioningState

ProvisioningState

Provisioning state of the resource.
properties.storageProfile

StorageProfile

Storage properties.
systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

VirtualMachineInstanceUpdate

The type used for update operations of the VirtualMachineInstance.

Name Type Description
properties.availabilitySets

AvailabilitySetListItem[]

Availability Sets in vm.
properties.hardwareProfile

HardwareProfileUpdate

Hardware properties.
properties.infrastructureProfile

InfrastructureProfileUpdate

Gets the infrastructure profile.
properties.networkProfile

NetworkProfileUpdate

Network properties.
properties.storageProfile

StorageProfileUpdate

Storage properties.