UpdateComputeResourceModel

Details for updating a compute resource.

Properties

NameDescription Additional information
Name

Name.

Type: String

Description

Description.

Type: String

Address

Address. Note that the address must refer to a server with the same management view of the same hypervisor pool. When setting this property, for security you must also set the UserNameOrApiKey and PasswordBase64OrSecretKey properties, even if not changing them.

Type: String

UserNameOrApiKey

Address of the hypervisor, hypervisor pool, or management API. Note that if setting this property, you must also set the PasswordBase64OrSecretKey property.

Type: String

PasswordBase64OrSecretKey

Password for the admin of the hypervisor or hypervisor pool. Must be Base64-encoded.

Type: String

Cluster

Cluster within the hypervisor pool where virtual machines will be provisioned. Only used for compute resources of type 'HyperV' or 'VMWare'.

Note that changing this property will not affect any virtual machines that have already been provisioned, but can affect where machines will be provisioned in the future.

Type: ClusterModel

MaxVirtualMachinesToProvision

The maximum number of virtual machines to provision on the compute resource before considering it to be "full". If setting this below the number of currently-provisioned machines, the compute resource will immediately be considered "full"; however, none of the existing provisioned machines will be moved or affected in any way.

Type: Number

HaServers

Backup servers to contact in case the primary server address cannot be contacted. Only used for compute resources of type 'XenServer'.

Type: Array of String

UseLocalStorage

If true, the operating system disk for virtual machines provisioned on this compute resource will be stored on the local storage of the hypervisor. If false, the operating system disk for virtual machines provisioned on this compute resource will be stored on a storage pool as defined by the VirtualMachineStorage property.

Note that changing this property will not affect any virtual machines that have already been provisioned, but can affect where machines will be provisioned in the future.

Type: Boolean

VirtualMachineStorage

Names(s) of the shared storage pool(s) to use for operating system disks for virtual machines provisioned on the compute resource. Only used if UseLocalStorage is false. If multiple storage pools are specified, virtual machines will be balanced between the specified storage pools.

Note that changing this property will not affect any virtual machines that have already been provisioned, but can affect where machines will be provisioned in the future.

Type: Array of String

PersonalVDiskStorage

Names(s) of the shared storage pool(s) to use for personal virtual disks for virtual machines provisioned on the compute resource. If multiple storage pools are specified, virtual machines will be balanced between the specified storage pools.

Note that changing this property will not affect any virtual machines that have already been provisioned, but can affect where machines will be provisioned in the future.

Type: Array of String

IsEnabled

If true, the compute resource will be used to provision additional virtual machines when necessary, as long as it has not yet reached the MaxVirtualMachinesToProvision limit. If false, the virtual machines currently existing on the compute resource continue to function normally, but no additional virtual machines will be provisioned on the compute resource even if it has not yet reached its provisioning limit.

Note that changing this property will not affect any virtual machines that have already been provisioned, but can affect where machines will be provisioned in the future.

Type: Boolean

Tags

See Tags and Custom Properties.

Type: Array of String

CustomProperties

See Tags and Custom Properties.

Type: Array of CustomPropertyModel

Sample

application/json

Sample:
{
  "Description": "My SCVMM cluster",
  "Address": "https://10.1.1.10",
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ]
}