---
title: "Implements virtual machine PATCH method"
method: PATCH
path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}"
tags: ["VirtualMachines"]
---

# Implements virtual machine PATCH method

`PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}`

Patch virtual machine properties

## Path parameters

- `subscriptionId` string, required
- `resourceGroupName` string, required
- `virtualMachineName` string, required

## Query parameters

- `api-version` string, required

## Request body

- PatchPayload — General patch payload modal
  - `tags` unknown

## Response `200`

If resource is created or updated successfully, 200 should be returned

- VirtualMachine — Virtual machine model
  - `id` string — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName}
  - `location` string, required — Azure region
  - `name` string — {virtualMachineName}
  - `properties` VirtualMachineProperties — Properties of virtual machine
    - `amountOfRam` integer, required — The amount of memory
    - `controllers` VirtualDiskController[] — The list of Virtual Disks' Controllers
      - `id` string — Controller's id
      - `name` string — The display name of Controller
      - `subType` string — dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS)
      - `type` string — disk controller type (SCSI)
    - `customization` GuestOSCustomization — Guest OS Customization properties
      - `dnsServers` IPV4Address[] — List of dns servers to use
      - `hostName` string — Virtual Machine hostname
      - `password` string — Password for login
      - `policyId` string — id of customization policy
      - `username` string — Username for login
    - `disks` VirtualDisk[] — The list of Virtual Disks
      - `controllerId` string, required — Disk's Controller id
      - `independenceMode` 'persistent' | 'independent_persistent' | 'independent_nonpersistent', required — Disk's independence mode type
      - `totalSize` integer, required — Disk's total size
      - `virtualDiskId` string — Disk's id
      - `virtualDiskName` string — Disk's display name
    - `dnsname` string — The DNS name of Virtual Machine in VCenter
    - `exposeToGuestVM` boolean — Expose Guest OS or not
    - `folder` string — The path to virtual machine folder in VCenter
    - `guestOS` string — The name of Guest OS
    - `guestOSType` 'linux' | 'windows' | 'other' — The Guest OS type
    - `nics` VirtualNic[] — The list of Virtual NICs
      - `customization` GuestOSNICCustomization — Guest OS nic customization
        - `allocation` 'static' | 'dynamic' — IP address allocation method
        - `dnsServers` IPV4Address[] — List of dns servers to use
        - `gateway` IPV4Address[] — Gateway addresses assigned to nic
        - `ipAddress` string
        - `mask` string
        - `primaryWinsServer` string
        - `secondaryWinsServer` string
      - `ipAddresses` string[] — NIC ip address
      - `macAddress` string — NIC MAC address
      - `network` VirtualNetwork, required — Virtual network model
        - `assignable` boolean — can be used in vm creation/deletion
        - `id` string, required — virtual network id (privateCloudId:vsphereId)
        - `location` string — Azure region
        - `name` string — {VirtualNetworkName}
        - `properties` VirtualNetworkProperties — Properties of virtual network
          - `privateCloudId` string — The Private Cloud id
        - `type` string — {resourceProviderNamespace}/{resourceType}
      - `nicType` 'E1000' | 'E1000E' | 'PCNET32' | 'VMXNET' | 'VMXNET2' | 'VMXNET3', required — NIC type
      - `powerOnBoot` boolean — Is NIC powered on/off on boot
      - `virtualNicId` string — NIC id
      - `virtualNicName` string — NIC name
    - `numberOfCores` integer, required — The number of CPU cores
    - `password` string — Password for login. Deprecated - use customization property
    - `privateCloudId` string, required — Private Cloud Id
    - `provisioningState` string — The provisioning status of the resource
    - `publicIP` string — The public ip of Virtual Machine
    - `resourcePool` ResourcePool — Resource pool model
      - `id` string, required — resource pool id (privateCloudId:vsphereId)
      - `location` string — Azure region
      - `name` string — {ResourcePoolName}
      - `privateCloudId` string — The Private Cloud Id
      - `properties` ResourcePoolProperties — Properties of resource pool
        - `fullName` string — Hierarchical resource pool name
      - `type` string — {resourceProviderNamespace}/{resourceType}
    - `status` 'running' | 'suspended' | 'poweredoff' | 'updating' | 'deallocating' | 'deleting' — The status of Virtual machine
    - `templateId` string — Virtual Machine Template Id
    - `username` string — Username for login. Deprecated - use customization property
    - `vSphereNetworks` string[] — The list of Virtual VSphere Networks
    - `vmId` string — The internal id of Virtual Machine in VCenter
    - `vmwaretools` string — VMware tools version
  - `tags` unknown
  - `type` string — {resourceProviderNamespace}/{resourceType}

## Other responses

- `default` — General Error

## Changes

- **2019-10-01** (2019-04-01) `7f9c99d00f07` — 3 info
  - api operation id `virtualMachine_Update` removed and replaced with `VirtualMachines_Update`
  - api tag `VirtualMachines` added
  - api tag `virtualMachine` removed
- **2019-06-20** (2019-04-01) `efec17f26250` — 3 info
  - api operation id `VirtualMachines_Update` removed and replaced with `virtualMachine_Update`
  - api tag `virtualMachine` added
  - api tag `VirtualMachines` removed

[Change history](https://skmtc.dev/azure/apis/vmwarecloudsimple/changes/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.VMwareCloudSimple/virtualMachines/:virtualMachineName/patch.md)

---

[API](https://skmtc.dev/azure/apis/vmwarecloudsimple.md) · [All operations](https://skmtc.dev/azure/apis/vmwarecloudsimple/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/azure/vmwarecloudsimple/revisions/e4f413d50659/schema)
