Microsoft.ConnectedVMwarevSphere virtualMachines 2020-10-01-preview

2024-12-09

Bicep resource definition

The virtualMachines resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ConnectedVMwarevSphere/virtualMachines resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ConnectedVMwarevSphere/virtualMachines@2020-10-01-preview' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  identity: {
    type: 'string'
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    firmwareType: 'string'
    guestAgentProfile: {}
    hardwareProfile: {
      memorySizeMB: int
      numCoresPerSocket: int
      numCPUs: int
    }
    inventoryItemId: 'string'
    moRefId: 'string'
    networkProfile: {
      networkInterfaces: [
        {
          deviceKey: int
          ipSettings: {
            allocationMethod: 'string'
            dnsServers: [
              'string'
            ]
            gateway: [
              'string'
            ]
            ipAddress: 'string'
            subnetMask: 'string'
          }
          name: 'string'
          networkId: 'string'
          nicType: 'string'
          powerOnBoot: 'string'
        }
      ]
    }
    osProfile: {
      adminPassword: 'string'
      adminUsername: 'string'
      computerName: 'string'
      osType: 'string'
    }
    placementProfile: {
      clusterId: 'string'
      datastoreId: 'string'
      hostId: 'string'
      resourcePoolId: 'string'
    }
    resourcePoolId: 'string'
    smbiosUuid: 'string'
    storageProfile: {
      disks: [
        {
          controllerKey: int
          deviceKey: int
          deviceName: 'string'
          diskMode: 'string'
          diskSizeGB: int
          diskType: 'string'
          name: 'string'
          unitNumber: int
        }
      ]
    }
    templateId: 'string'
    vCenterId: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.ConnectedVMwarevSphere/virtualMachines

Name	Description	Value
extendedLocation	Gets or sets the extended location.	ExtendedLocation
identity	The identity of the resource.	Identity
kind	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.	string
location	Gets or sets the location.	string (required)
name	The resource name	string (required)
properties	Resource properties.	VirtualMachineProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

ExtendedLocation

Name	Description	Value
name	The extended location name.	string
type	The extended location type.	string

GuestAgentProfile

Name	Description	Value

HardwareProfile

Name	Description	Value
memorySizeMB	Gets or sets memory size in MBs for the vm.	int
numCoresPerSocket	Gets or sets the number of cores per socket for the vm. Defaults to 1 if unspecified.	int
numCPUs	Gets or sets the number of vCPUs for the vm.	int

Identity

Name	Description	Value
type	The type of managed service identity.	'None' 'SystemAssigned' (required)

NetworkInterface

Name	Description	Value
deviceKey	Gets or sets the device key value.	int
ipSettings	Gets or sets the ipsettings.	NicIPSettings
name	Gets or sets the name of the network interface.	string
networkId	Gets or sets the ARM Id of the network resource to connect the virtual machine.	string
nicType	NIC type	'e1000' 'e1000e' 'pcnet32' 'vmxnet' 'vmxnet2' 'vmxnet3'
powerOnBoot	Gets or sets the power on boot.	'disabled' 'enabled'

NetworkProfile

Name	Description	Value
networkInterfaces	Gets or sets the list of network interfaces associated with the virtual machine.	NetworkInterface[]

NicIPSettings

Name	Description	Value
allocationMethod	Gets or sets the nic allocation method.	'dynamic' 'linklayer' 'other' 'random' 'static' 'unset'
dnsServers	Gets or sets the dns servers.	string[]
gateway	Gets or sets the gateway.	string[]
ipAddress	Gets or sets the ip address for the nic.	string
subnetMask	Gets or sets the mask.	string

OsProfile

Name	Description	Value
adminPassword	Gets or sets administrator password.	string Constraints: Sensitive value. Pass in as a secure parameter.
adminUsername	Gets or sets administrator username.	string
computerName	Gets or sets computer name.	string
osType	Gets or sets the type of the os.	'Linux' 'Other' 'Windows'

PlacementProfile

Name	Description	Value
clusterId	Gets or sets the ARM Id of the cluster resource on which this virtual machine will deploy.	string
datastoreId	Gets or sets the ARM Id of the datastore resource on which the data for the virtual machine will be kept.	string
hostId	Gets or sets the ARM Id of the host resource on which this virtual machine will deploy.	string
resourcePoolId	Gets or sets the ARM Id of the resourcePool resource on which this virtual machine will deploy.	string

StorageProfile

Name	Description	Value
disks	Gets or sets the list of virtual disks associated with the virtual machine.	VirtualDisk[]

VirtualDisk

Name	Description	Value
controllerKey	Gets or sets the controller id.	int
deviceKey	Gets or sets the device key value.	int
deviceName	Gets or sets the device name.	string
diskMode	Gets or sets the disk mode.	'independent_nonpersistent' 'independent_persistent' 'persistent'
diskSizeGB	Gets or sets the disk total size.	int
diskType	Gets or sets the disk backing type.	'flat' 'pmem' 'rawphysical' 'rawvirtual' 'sesparse' 'sparse' 'unknown'
name	Gets or sets the name of the virtual disk.	string
unitNumber	Gets or sets the unit number of the disk on the controller.	int

VirtualMachineProperties

Name	Description	Value
firmwareType	Firmware type	'bios' 'efi'
guestAgentProfile	Guest agent status properties.	GuestAgentProfile
hardwareProfile	Hardware properties.	HardwareProfile
inventoryItemId	Gets or sets the inventory Item ID for the virtual machine.	string
moRefId	Gets or sets the vCenter MoRef (Managed Object Reference) ID for the virtual machine.	string
networkProfile	Network properties.	NetworkProfile
osProfile	OS properties.	OsProfile
placementProfile	Placement properties.	PlacementProfile
resourcePoolId	Gets or sets the ARM Id of the resourcePool resource on which this virtual machine will deploy.	string
smbiosUuid	Gets or sets the SMBIOS UUID of the vm.	string
storageProfile	Storage properties.	StorageProfile
templateId	Gets or sets the ARM Id of the template resource to deploy the virtual machine.	string
vCenterId	Gets or sets the ARM Id of the vCenter resource in which this resource pool resides.	string

VirtualMachineTags

Name	Description	Value

ARM template resource definition

The virtualMachines resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ConnectedVMwarevSphere/virtualMachines resource, add the following JSON to your template.

{
  "type": "Microsoft.ConnectedVMwarevSphere/virtualMachines",
  "apiVersion": "2020-10-01-preview",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "identity": {
    "type": "string"
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "firmwareType": "string",
    "guestAgentProfile": {
    },
    "hardwareProfile": {
      "memorySizeMB": "int",
      "numCoresPerSocket": "int",
      "numCPUs": "int"
    },
    "inventoryItemId": "string",
    "moRefId": "string",
    "networkProfile": {
      "networkInterfaces": [
        {
          "deviceKey": "int",
          "ipSettings": {
            "allocationMethod": "string",
            "dnsServers": [ "string" ],
            "gateway": [ "string" ],
            "ipAddress": "string",
            "subnetMask": "string"
          },
          "name": "string",
          "networkId": "string",
          "nicType": "string",
          "powerOnBoot": "string"
        }
      ]
    },
    "osProfile": {
      "adminPassword": "string",
      "adminUsername": "string",
      "computerName": "string",
      "osType": "string"
    },
    "placementProfile": {
      "clusterId": "string",
      "datastoreId": "string",
      "hostId": "string",
      "resourcePoolId": "string"
    },
    "resourcePoolId": "string",
    "smbiosUuid": "string",
    "storageProfile": {
      "disks": [
        {
          "controllerKey": "int",
          "deviceKey": "int",
          "deviceName": "string",
          "diskMode": "string",
          "diskSizeGB": "int",
          "diskType": "string",
          "name": "string",
          "unitNumber": "int"
        }
      ]
    },
    "templateId": "string",
    "vCenterId": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.ConnectedVMwarevSphere/virtualMachines

Name	Description	Value
apiVersion	The api version	'2020-10-01-preview'
extendedLocation	Gets or sets the extended location.	ExtendedLocation
identity	The identity of the resource.	Identity
kind	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.	string
location	Gets or sets the location.	string (required)
name	The resource name	string (required)
properties	Resource properties.	VirtualMachineProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.ConnectedVMwarevSphere/virtualMachines'

ExtendedLocation

Name	Description	Value
name	The extended location name.	string
type	The extended location type.	string

GuestAgentProfile

Name	Description	Value

HardwareProfile

Name	Description	Value
memorySizeMB	Gets or sets memory size in MBs for the vm.	int
numCoresPerSocket	Gets or sets the number of cores per socket for the vm. Defaults to 1 if unspecified.	int
numCPUs	Gets or sets the number of vCPUs for the vm.	int

Identity

Name	Description	Value
type	The type of managed service identity.	'None' 'SystemAssigned' (required)

NetworkInterface

Name	Description	Value
deviceKey	Gets or sets the device key value.	int
ipSettings	Gets or sets the ipsettings.	NicIPSettings
name	Gets or sets the name of the network interface.	string
networkId	Gets or sets the ARM Id of the network resource to connect the virtual machine.	string
nicType	NIC type	'e1000' 'e1000e' 'pcnet32' 'vmxnet' 'vmxnet2' 'vmxnet3'
powerOnBoot	Gets or sets the power on boot.	'disabled' 'enabled'

NetworkProfile

Name	Description	Value
networkInterfaces	Gets or sets the list of network interfaces associated with the virtual machine.	NetworkInterface[]

NicIPSettings

Name	Description	Value
allocationMethod	Gets or sets the nic allocation method.	'dynamic' 'linklayer' 'other' 'random' 'static' 'unset'
dnsServers	Gets or sets the dns servers.	string[]
gateway	Gets or sets the gateway.	string[]
ipAddress	Gets or sets the ip address for the nic.	string
subnetMask	Gets or sets the mask.	string

OsProfile

Name	Description	Value
adminPassword	Gets or sets administrator password.	string Constraints: Sensitive value. Pass in as a secure parameter.
adminUsername	Gets or sets administrator username.	string
computerName	Gets or sets computer name.	string
osType	Gets or sets the type of the os.	'Linux' 'Other' 'Windows'

PlacementProfile

Name	Description	Value
clusterId	Gets or sets the ARM Id of the cluster resource on which this virtual machine will deploy.	string
datastoreId	Gets or sets the ARM Id of the datastore resource on which the data for the virtual machine will be kept.	string
hostId	Gets or sets the ARM Id of the host resource on which this virtual machine will deploy.	string
resourcePoolId	Gets or sets the ARM Id of the resourcePool resource on which this virtual machine will deploy.	string

StorageProfile

Name	Description	Value
disks	Gets or sets the list of virtual disks associated with the virtual machine.	VirtualDisk[]

VirtualDisk

Name	Description	Value
controllerKey	Gets or sets the controller id.	int
deviceKey	Gets or sets the device key value.	int
deviceName	Gets or sets the device name.	string
diskMode	Gets or sets the disk mode.	'independent_nonpersistent' 'independent_persistent' 'persistent'
diskSizeGB	Gets or sets the disk total size.	int
diskType	Gets or sets the disk backing type.	'flat' 'pmem' 'rawphysical' 'rawvirtual' 'sesparse' 'sparse' 'unknown'
name	Gets or sets the name of the virtual disk.	string
unitNumber	Gets or sets the unit number of the disk on the controller.	int

VirtualMachineProperties

Name	Description	Value
firmwareType	Firmware type	'bios' 'efi'
guestAgentProfile	Guest agent status properties.	GuestAgentProfile
hardwareProfile	Hardware properties.	HardwareProfile
inventoryItemId	Gets or sets the inventory Item ID for the virtual machine.	string
moRefId	Gets or sets the vCenter MoRef (Managed Object Reference) ID for the virtual machine.	string
networkProfile	Network properties.	NetworkProfile
osProfile	OS properties.	OsProfile
placementProfile	Placement properties.	PlacementProfile
resourcePoolId	Gets or sets the ARM Id of the resourcePool resource on which this virtual machine will deploy.	string
smbiosUuid	Gets or sets the SMBIOS UUID of the vm.	string
storageProfile	Storage properties.	StorageProfile
templateId	Gets or sets the ARM Id of the template resource to deploy the virtual machine.	string
vCenterId	Gets or sets the ARM Id of the vCenter resource in which this resource pool resides.	string

VirtualMachineTags

Name	Description	Value

Usage Examples

Terraform (AzAPI provider) resource definition

The virtualMachines resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ConnectedVMwarevSphere/virtualMachines resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ConnectedVMwarevSphere/virtualMachines@2020-10-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    extendedLocation = {
      name = "string"
      type = "string"
    }
    kind = "string"
    properties = {
      firmwareType = "string"
      guestAgentProfile = {
      }
      hardwareProfile = {
        memorySizeMB = int
        numCoresPerSocket = int
        numCPUs = int
      }
      inventoryItemId = "string"
      moRefId = "string"
      networkProfile = {
        networkInterfaces = [
          {
            deviceKey = int
            ipSettings = {
              allocationMethod = "string"
              dnsServers = [
                "string"
              ]
              gateway = [
                "string"
              ]
              ipAddress = "string"
              subnetMask = "string"
            }
            name = "string"
            networkId = "string"
            nicType = "string"
            powerOnBoot = "string"
          }
        ]
      }
      osProfile = {
        adminPassword = "string"
        adminUsername = "string"
        computerName = "string"
        osType = "string"
      }
      placementProfile = {
        clusterId = "string"
        datastoreId = "string"
        hostId = "string"
        resourcePoolId = "string"
      }
      resourcePoolId = "string"
      smbiosUuid = "string"
      storageProfile = {
        disks = [
          {
            controllerKey = int
            deviceKey = int
            deviceName = "string"
            diskMode = "string"
            diskSizeGB = int
            diskType = "string"
            name = "string"
            unitNumber = int
          }
        ]
      }
      templateId = "string"
      vCenterId = "string"
    }
  }
}

Property Values

Microsoft.ConnectedVMwarevSphere/virtualMachines

Name	Description	Value
extendedLocation	Gets or sets the extended location.	ExtendedLocation
identity	The identity of the resource.	Identity
kind	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.	string
location	Gets or sets the location.	string (required)
name	The resource name	string (required)
properties	Resource properties.	VirtualMachineProperties (required)
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.ConnectedVMwarevSphere/virtualMachines@2020-10-01-preview"

ExtendedLocation

Name	Description	Value
name	The extended location name.	string
type	The extended location type.	string

GuestAgentProfile

Name	Description	Value

HardwareProfile

Name	Description	Value
memorySizeMB	Gets or sets memory size in MBs for the vm.	int
numCoresPerSocket	Gets or sets the number of cores per socket for the vm. Defaults to 1 if unspecified.	int
numCPUs	Gets or sets the number of vCPUs for the vm.	int

Identity

Name	Description	Value
type	The type of managed service identity.	'None' 'SystemAssigned' (required)

NetworkInterface

Name	Description	Value
deviceKey	Gets or sets the device key value.	int
ipSettings	Gets or sets the ipsettings.	NicIPSettings
name	Gets or sets the name of the network interface.	string
networkId	Gets or sets the ARM Id of the network resource to connect the virtual machine.	string
nicType	NIC type	'e1000' 'e1000e' 'pcnet32' 'vmxnet' 'vmxnet2' 'vmxnet3'
powerOnBoot	Gets or sets the power on boot.	'disabled' 'enabled'

NetworkProfile

Name	Description	Value
networkInterfaces	Gets or sets the list of network interfaces associated with the virtual machine.	NetworkInterface[]

NicIPSettings

Name	Description	Value
allocationMethod	Gets or sets the nic allocation method.	'dynamic' 'linklayer' 'other' 'random' 'static' 'unset'
dnsServers	Gets or sets the dns servers.	string[]
gateway	Gets or sets the gateway.	string[]
ipAddress	Gets or sets the ip address for the nic.	string
subnetMask	Gets or sets the mask.	string

OsProfile

Name	Description	Value
adminPassword	Gets or sets administrator password.	string Constraints: Sensitive value. Pass in as a secure parameter.
adminUsername	Gets or sets administrator username.	string
computerName	Gets or sets computer name.	string
osType	Gets or sets the type of the os.	'Linux' 'Other' 'Windows'

PlacementProfile

Name	Description	Value
clusterId	Gets or sets the ARM Id of the cluster resource on which this virtual machine will deploy.	string
datastoreId	Gets or sets the ARM Id of the datastore resource on which the data for the virtual machine will be kept.	string
hostId	Gets or sets the ARM Id of the host resource on which this virtual machine will deploy.	string
resourcePoolId	Gets or sets the ARM Id of the resourcePool resource on which this virtual machine will deploy.	string

StorageProfile

Name	Description	Value
disks	Gets or sets the list of virtual disks associated with the virtual machine.	VirtualDisk[]

VirtualDisk

Name	Description	Value
controllerKey	Gets or sets the controller id.	int
deviceKey	Gets or sets the device key value.	int
deviceName	Gets or sets the device name.	string
diskMode	Gets or sets the disk mode.	'independent_nonpersistent' 'independent_persistent' 'persistent'
diskSizeGB	Gets or sets the disk total size.	int
diskType	Gets or sets the disk backing type.	'flat' 'pmem' 'rawphysical' 'rawvirtual' 'sesparse' 'sparse' 'unknown'
name	Gets or sets the name of the virtual disk.	string
unitNumber	Gets or sets the unit number of the disk on the controller.	int

VirtualMachineProperties

Name	Description	Value
firmwareType	Firmware type	'bios' 'efi'
guestAgentProfile	Guest agent status properties.	GuestAgentProfile
hardwareProfile	Hardware properties.	HardwareProfile
inventoryItemId	Gets or sets the inventory Item ID for the virtual machine.	string
moRefId	Gets or sets the vCenter MoRef (Managed Object Reference) ID for the virtual machine.	string
networkProfile	Network properties.	NetworkProfile
osProfile	OS properties.	OsProfile
placementProfile	Placement properties.	PlacementProfile
resourcePoolId	Gets or sets the ARM Id of the resourcePool resource on which this virtual machine will deploy.	string
smbiosUuid	Gets or sets the SMBIOS UUID of the vm.	string
storageProfile	Storage properties.	StorageProfile
templateId	Gets or sets the ARM Id of the template resource to deploy the virtual machine.	string
vCenterId	Gets or sets the ARM Id of the vCenter resource in which this resource pool resides.	string

VirtualMachineTags

Name	Description	Value

Share via

Microsoft.ConnectedVMwarevSphere virtualMachines 2020-10-01-preview

Bicep resource definition

Resource format

Property Values

Microsoft.ConnectedVMwarevSphere/virtualMachines

ExtendedLocation

GuestAgentProfile

HardwareProfile

Identity

NetworkInterface

NetworkProfile

NicIPSettings

OsProfile

PlacementProfile

StorageProfile

VirtualDisk

VirtualMachineProperties

VirtualMachineTags

ARM template resource definition

Resource format

Property Values

Microsoft.ConnectedVMwarevSphere/virtualMachines

ExtendedLocation

GuestAgentProfile

HardwareProfile

Identity

NetworkInterface

NetworkProfile

NicIPSettings

OsProfile

PlacementProfile

StorageProfile

VirtualDisk

VirtualMachineProperties

VirtualMachineTags

Usage Examples

Terraform (AzAPI provider) resource definition

Resource format

Property Values

Microsoft.ConnectedVMwarevSphere/virtualMachines

ExtendedLocation

GuestAgentProfile

HardwareProfile

Identity

NetworkInterface

NetworkProfile

NicIPSettings

OsProfile

PlacementProfile

StorageProfile

VirtualDisk

VirtualMachineProperties

VirtualMachineTags

Feedback

Additional resources