VirtualMachine

Manages a Virtual Machine.

Disclaimers

Note: The azure.compute.VirtualMachine resource has been superseded by the azure.compute.LinuxVirtualMachine and azure.compute.WindowsVirtualMachine resources. The existing azure.compute.VirtualMachine resource will continue to be available throughout the 2.x releases however is in a feature-frozen state to maintain compatibility - new functionality will instead be added to the azure.compute.LinuxVirtualMachine and azure.compute.WindowsVirtualMachine resources.

Note: Data Disks can be attached either directly on the azure.compute.VirtualMachine resource, or using the azure.compute.DataDiskAttachment resource - but the two cannot be used together. If both are used against the same Virtual Machine, spurious changes will occur.

Create a VirtualMachine Resource

def VirtualMachine(resource_name, opts=None, additional_capabilities=None, availability_set_id=None, boot_diagnostics=None, delete_data_disks_on_termination=None, delete_os_disk_on_termination=None, identity=None, license_type=None, location=None, name=None, network_interface_ids=None, os_profile=None, os_profile_linux_config=None, os_profile_secrets=None, os_profile_windows_config=None, plan=None, primary_network_interface_id=None, proximity_placement_group_id=None, resource_group_name=None, storage_data_disks=None, storage_image_reference=None, storage_os_disk=None, tags=None, vm_size=None, zones=None, __props__=None);
name string
The unique name of the resource.
args VirtualMachineArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args VirtualMachineArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args VirtualMachineArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

VirtualMachine Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The VirtualMachine resource accepts the following input properties:

NetworkInterfaceIds List<string>

A list of Network Interface ID’s which should be associated with the Virtual Machine.

ResourceGroupName string

Specifies the name of the Resource Group in which the Virtual Machine should exist. Changing this forces a new resource to be created.

StorageOsDisk VirtualMachineStorageOsDiskArgs

A storage_os_disk block.

VmSize string

Specifies the size of the Virtual Machine.

AdditionalCapabilities VirtualMachineAdditionalCapabilitiesArgs

A additional_capabilities block.

AvailabilitySetId string

The ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.

BootDiagnostics VirtualMachineBootDiagnosticsArgs

A boot_diagnostics block.

DeleteDataDisksOnTermination bool

Should the Data Disks (either the Managed Disks / VHD Blobs) be deleted when the Virtual Machine is destroyed? Defaults to false.

DeleteOsDiskOnTermination bool

Should the OS Disk (either the Managed Disk / VHD Blob) be deleted when the Virtual Machine is destroyed? Defaults to false.

Identity VirtualMachineIdentityArgs

A identity block.

LicenseType string

Specifies the BYOL Type for this Virtual Machine. This is only applicable to Windows Virtual Machines. Possible values are Windows_Client and Windows_Server.

Location string

Specifies the Azure Region where the Virtual Machine exists. Changing this forces a new resource to be created.

Name string

Specifies the name of the Virtual Machine. Changing this forces a new resource to be created.

OsProfile VirtualMachineOsProfileArgs

An os_profile block. Required when create_option in the storage_os_disk block is set to FromImage.

OsProfileLinuxConfig VirtualMachineOsProfileLinuxConfigArgs

A os_profile_linux_config block.

OsProfileSecrets List<VirtualMachineOsProfileSecretArgs>

One or more os_profile_secrets blocks.

OsProfileWindowsConfig VirtualMachineOsProfileWindowsConfigArgs

A os_profile_windows_config block.

Plan VirtualMachinePlanArgs

A plan block.

PrimaryNetworkInterfaceId string

The ID of the Network Interface (which must be attached to the Virtual Machine) which should be the Primary Network Interface for this Virtual Machine.

ProximityPlacementGroupId string

The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created

StorageDataDisks List<VirtualMachineStorageDataDiskArgs>

One or more storage_data_disk blocks.

StorageImageReference VirtualMachineStorageImageReferenceArgs

A storage_image_reference block.

Tags Dictionary<string, string>

A mapping of tags to assign to the Virtual Machine.

Zones string

A list of a single item of the Availability Zone which the Virtual Machine should be allocated in.

NetworkInterfaceIds []string

A list of Network Interface ID’s which should be associated with the Virtual Machine.

ResourceGroupName string

Specifies the name of the Resource Group in which the Virtual Machine should exist. Changing this forces a new resource to be created.

StorageOsDisk VirtualMachineStorageOsDisk

A storage_os_disk block.

VmSize string

Specifies the size of the Virtual Machine.

AdditionalCapabilities VirtualMachineAdditionalCapabilities

A additional_capabilities block.

AvailabilitySetId string

The ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.

BootDiagnostics VirtualMachineBootDiagnostics

A boot_diagnostics block.

DeleteDataDisksOnTermination bool

Should the Data Disks (either the Managed Disks / VHD Blobs) be deleted when the Virtual Machine is destroyed? Defaults to false.

DeleteOsDiskOnTermination bool

Should the OS Disk (either the Managed Disk / VHD Blob) be deleted when the Virtual Machine is destroyed? Defaults to false.

Identity VirtualMachineIdentity

A identity block.

LicenseType string

Specifies the BYOL Type for this Virtual Machine. This is only applicable to Windows Virtual Machines. Possible values are Windows_Client and Windows_Server.

Location string

Specifies the Azure Region where the Virtual Machine exists. Changing this forces a new resource to be created.

Name string

Specifies the name of the Virtual Machine. Changing this forces a new resource to be created.

OsProfile VirtualMachineOsProfile

An os_profile block. Required when create_option in the storage_os_disk block is set to FromImage.

OsProfileLinuxConfig VirtualMachineOsProfileLinuxConfig

A os_profile_linux_config block.

OsProfileSecrets []VirtualMachineOsProfileSecret

One or more os_profile_secrets blocks.

OsProfileWindowsConfig VirtualMachineOsProfileWindowsConfig

A os_profile_windows_config block.

Plan VirtualMachinePlan

A plan block.

PrimaryNetworkInterfaceId string

The ID of the Network Interface (which must be attached to the Virtual Machine) which should be the Primary Network Interface for this Virtual Machine.

ProximityPlacementGroupId string

The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created

StorageDataDisks []VirtualMachineStorageDataDisk

One or more storage_data_disk blocks.

StorageImageReference VirtualMachineStorageImageReference

A storage_image_reference block.

Tags map[string]string

A mapping of tags to assign to the Virtual Machine.

Zones string

A list of a single item of the Availability Zone which the Virtual Machine should be allocated in.

networkInterfaceIds string[]

A list of Network Interface ID’s which should be associated with the Virtual Machine.

resourceGroupName string

Specifies the name of the Resource Group in which the Virtual Machine should exist. Changing this forces a new resource to be created.

storageOsDisk VirtualMachineStorageOsDisk

A storage_os_disk block.

vmSize string

Specifies the size of the Virtual Machine.

additionalCapabilities VirtualMachineAdditionalCapabilities

A additional_capabilities block.

availabilitySetId string

The ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.

bootDiagnostics VirtualMachineBootDiagnostics

A boot_diagnostics block.

deleteDataDisksOnTermination boolean

Should the Data Disks (either the Managed Disks / VHD Blobs) be deleted when the Virtual Machine is destroyed? Defaults to false.

deleteOsDiskOnTermination boolean

Should the OS Disk (either the Managed Disk / VHD Blob) be deleted when the Virtual Machine is destroyed? Defaults to false.

identity VirtualMachineIdentity

A identity block.

licenseType string

Specifies the BYOL Type for this Virtual Machine. This is only applicable to Windows Virtual Machines. Possible values are Windows_Client and Windows_Server.

location string

Specifies the Azure Region where the Virtual Machine exists. Changing this forces a new resource to be created.

name string

Specifies the name of the Virtual Machine. Changing this forces a new resource to be created.

osProfile VirtualMachineOsProfile

An os_profile block. Required when create_option in the storage_os_disk block is set to FromImage.

osProfileLinuxConfig VirtualMachineOsProfileLinuxConfig

A os_profile_linux_config block.

osProfileSecrets VirtualMachineOsProfileSecret[]

One or more os_profile_secrets blocks.

osProfileWindowsConfig VirtualMachineOsProfileWindowsConfig

A os_profile_windows_config block.

plan VirtualMachinePlan

A plan block.

primaryNetworkInterfaceId string

The ID of the Network Interface (which must be attached to the Virtual Machine) which should be the Primary Network Interface for this Virtual Machine.

proximityPlacementGroupId string

The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created

storageDataDisks VirtualMachineStorageDataDisk[]

One or more storage_data_disk blocks.

storageImageReference VirtualMachineStorageImageReference

A storage_image_reference block.

tags {[key: string]: string}

A mapping of tags to assign to the Virtual Machine.

zones string

A list of a single item of the Availability Zone which the Virtual Machine should be allocated in.

network_interface_ids List[str]

A list of Network Interface ID’s which should be associated with the Virtual Machine.

resource_group_name str

Specifies the name of the Resource Group in which the Virtual Machine should exist. Changing this forces a new resource to be created.

storage_os_disk Dict[VirtualMachineStorageOsDisk]

A storage_os_disk block.

vm_size str

Specifies the size of the Virtual Machine.

additional_capabilities Dict[VirtualMachineAdditionalCapabilities]

A additional_capabilities block.

availability_set_id str

The ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.

boot_diagnostics Dict[VirtualMachineBootDiagnostics]

A boot_diagnostics block.

delete_data_disks_on_termination bool

Should the Data Disks (either the Managed Disks / VHD Blobs) be deleted when the Virtual Machine is destroyed? Defaults to false.

delete_os_disk_on_termination bool

Should the OS Disk (either the Managed Disk / VHD Blob) be deleted when the Virtual Machine is destroyed? Defaults to false.

identity Dict[VirtualMachineIdentity]

A identity block.

license_type str

Specifies the BYOL Type for this Virtual Machine. This is only applicable to Windows Virtual Machines. Possible values are Windows_Client and Windows_Server.

location str

Specifies the Azure Region where the Virtual Machine exists. Changing this forces a new resource to be created.

name str

Specifies the name of the Virtual Machine. Changing this forces a new resource to be created.

os_profile Dict[VirtualMachineOsProfile]

An os_profile block. Required when create_option in the storage_os_disk block is set to FromImage.

os_profile_linux_config Dict[VirtualMachineOsProfileLinuxConfig]

A os_profile_linux_config block.

os_profile_secrets List[VirtualMachineOsProfileSecret]

One or more os_profile_secrets blocks.

os_profile_windows_config Dict[VirtualMachineOsProfileWindowsConfig]

A os_profile_windows_config block.

plan Dict[VirtualMachinePlan]

A plan block.

primary_network_interface_id str

The ID of the Network Interface (which must be attached to the Virtual Machine) which should be the Primary Network Interface for this Virtual Machine.

proximity_placement_group_id str

The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created

storage_data_disks List[VirtualMachineStorageDataDisk]

One or more storage_data_disk blocks.

storage_image_reference Dict[VirtualMachineStorageImageReference]

A storage_image_reference block.

tags Dict[str, str]

A mapping of tags to assign to the Virtual Machine.

zones str

A list of a single item of the Availability Zone which the Virtual Machine should be allocated in.

Outputs

All input properties are implicitly available as output properties. Additionally, the VirtualMachine resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing VirtualMachine Resource

Get an existing VirtualMachine resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: VirtualMachineState, opts?: CustomResourceOptions): VirtualMachine
static get(resource_name, id, opts=None, additional_capabilities=None, availability_set_id=None, boot_diagnostics=None, delete_data_disks_on_termination=None, delete_os_disk_on_termination=None, identity=None, license_type=None, location=None, name=None, network_interface_ids=None, os_profile=None, os_profile_linux_config=None, os_profile_secrets=None, os_profile_windows_config=None, plan=None, primary_network_interface_id=None, proximity_placement_group_id=None, resource_group_name=None, storage_data_disks=None, storage_image_reference=None, storage_os_disk=None, tags=None, vm_size=None, zones=None, __props__=None);
func GetVirtualMachine(ctx *Context, name string, id IDInput, state *VirtualMachineState, opts ...ResourceOption) (*VirtualMachine, error)
public static VirtualMachine Get(string name, Input<string> id, VirtualMachineState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

AdditionalCapabilities VirtualMachineAdditionalCapabilitiesArgs

A additional_capabilities block.

AvailabilitySetId string

The ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.

BootDiagnostics VirtualMachineBootDiagnosticsArgs

A boot_diagnostics block.

DeleteDataDisksOnTermination bool

Should the Data Disks (either the Managed Disks / VHD Blobs) be deleted when the Virtual Machine is destroyed? Defaults to false.

DeleteOsDiskOnTermination bool

Should the OS Disk (either the Managed Disk / VHD Blob) be deleted when the Virtual Machine is destroyed? Defaults to false.

Identity VirtualMachineIdentityArgs

A identity block.

LicenseType string

Specifies the BYOL Type for this Virtual Machine. This is only applicable to Windows Virtual Machines. Possible values are Windows_Client and Windows_Server.

Location string

Specifies the Azure Region where the Virtual Machine exists. Changing this forces a new resource to be created.

Name string

Specifies the name of the Virtual Machine. Changing this forces a new resource to be created.

NetworkInterfaceIds List<string>

A list of Network Interface ID’s which should be associated with the Virtual Machine.

OsProfile VirtualMachineOsProfileArgs

An os_profile block. Required when create_option in the storage_os_disk block is set to FromImage.

OsProfileLinuxConfig VirtualMachineOsProfileLinuxConfigArgs

A os_profile_linux_config block.

OsProfileSecrets List<VirtualMachineOsProfileSecretArgs>

One or more os_profile_secrets blocks.

OsProfileWindowsConfig VirtualMachineOsProfileWindowsConfigArgs

A os_profile_windows_config block.

Plan VirtualMachinePlanArgs

A plan block.

PrimaryNetworkInterfaceId string

The ID of the Network Interface (which must be attached to the Virtual Machine) which should be the Primary Network Interface for this Virtual Machine.

ProximityPlacementGroupId string

The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created

ResourceGroupName string

Specifies the name of the Resource Group in which the Virtual Machine should exist. Changing this forces a new resource to be created.

StorageDataDisks List<VirtualMachineStorageDataDiskArgs>

One or more storage_data_disk blocks.

StorageImageReference VirtualMachineStorageImageReferenceArgs

A storage_image_reference block.

StorageOsDisk VirtualMachineStorageOsDiskArgs

A storage_os_disk block.

Tags Dictionary<string, string>

A mapping of tags to assign to the Virtual Machine.

VmSize string

Specifies the size of the Virtual Machine.

Zones string

A list of a single item of the Availability Zone which the Virtual Machine should be allocated in.

AdditionalCapabilities VirtualMachineAdditionalCapabilities

A additional_capabilities block.

AvailabilitySetId string

The ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.

BootDiagnostics VirtualMachineBootDiagnostics

A boot_diagnostics block.

DeleteDataDisksOnTermination bool

Should the Data Disks (either the Managed Disks / VHD Blobs) be deleted when the Virtual Machine is destroyed? Defaults to false.

DeleteOsDiskOnTermination bool

Should the OS Disk (either the Managed Disk / VHD Blob) be deleted when the Virtual Machine is destroyed? Defaults to false.

Identity VirtualMachineIdentity

A identity block.

LicenseType string

Specifies the BYOL Type for this Virtual Machine. This is only applicable to Windows Virtual Machines. Possible values are Windows_Client and Windows_Server.

Location string

Specifies the Azure Region where the Virtual Machine exists. Changing this forces a new resource to be created.

Name string

Specifies the name of the Virtual Machine. Changing this forces a new resource to be created.

NetworkInterfaceIds []string

A list of Network Interface ID’s which should be associated with the Virtual Machine.

OsProfile VirtualMachineOsProfile

An os_profile block. Required when create_option in the storage_os_disk block is set to FromImage.

OsProfileLinuxConfig VirtualMachineOsProfileLinuxConfig

A os_profile_linux_config block.

OsProfileSecrets []VirtualMachineOsProfileSecret

One or more os_profile_secrets blocks.

OsProfileWindowsConfig VirtualMachineOsProfileWindowsConfig

A os_profile_windows_config block.

Plan VirtualMachinePlan

A plan block.

PrimaryNetworkInterfaceId string

The ID of the Network Interface (which must be attached to the Virtual Machine) which should be the Primary Network Interface for this Virtual Machine.

ProximityPlacementGroupId string

The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created

ResourceGroupName string

Specifies the name of the Resource Group in which the Virtual Machine should exist. Changing this forces a new resource to be created.

StorageDataDisks []VirtualMachineStorageDataDisk

One or more storage_data_disk blocks.

StorageImageReference VirtualMachineStorageImageReference

A storage_image_reference block.

StorageOsDisk VirtualMachineStorageOsDisk

A storage_os_disk block.

Tags map[string]string

A mapping of tags to assign to the Virtual Machine.

VmSize string

Specifies the size of the Virtual Machine.

Zones string

A list of a single item of the Availability Zone which the Virtual Machine should be allocated in.

additionalCapabilities VirtualMachineAdditionalCapabilities

A additional_capabilities block.

availabilitySetId string

The ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.

bootDiagnostics VirtualMachineBootDiagnostics

A boot_diagnostics block.

deleteDataDisksOnTermination boolean

Should the Data Disks (either the Managed Disks / VHD Blobs) be deleted when the Virtual Machine is destroyed? Defaults to false.

deleteOsDiskOnTermination boolean

Should the OS Disk (either the Managed Disk / VHD Blob) be deleted when the Virtual Machine is destroyed? Defaults to false.

identity VirtualMachineIdentity

A identity block.

licenseType string

Specifies the BYOL Type for this Virtual Machine. This is only applicable to Windows Virtual Machines. Possible values are Windows_Client and Windows_Server.

location string

Specifies the Azure Region where the Virtual Machine exists. Changing this forces a new resource to be created.

name string

Specifies the name of the Virtual Machine. Changing this forces a new resource to be created.

networkInterfaceIds string[]

A list of Network Interface ID’s which should be associated with the Virtual Machine.

osProfile VirtualMachineOsProfile

An os_profile block. Required when create_option in the storage_os_disk block is set to FromImage.

osProfileLinuxConfig VirtualMachineOsProfileLinuxConfig

A os_profile_linux_config block.

osProfileSecrets VirtualMachineOsProfileSecret[]

One or more os_profile_secrets blocks.

osProfileWindowsConfig VirtualMachineOsProfileWindowsConfig

A os_profile_windows_config block.

plan VirtualMachinePlan

A plan block.

primaryNetworkInterfaceId string

The ID of the Network Interface (which must be attached to the Virtual Machine) which should be the Primary Network Interface for this Virtual Machine.

proximityPlacementGroupId string

The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created

resourceGroupName string

Specifies the name of the Resource Group in which the Virtual Machine should exist. Changing this forces a new resource to be created.

storageDataDisks VirtualMachineStorageDataDisk[]

One or more storage_data_disk blocks.

storageImageReference VirtualMachineStorageImageReference

A storage_image_reference block.

storageOsDisk VirtualMachineStorageOsDisk

A storage_os_disk block.

tags {[key: string]: string}

A mapping of tags to assign to the Virtual Machine.

vmSize string

Specifies the size of the Virtual Machine.

zones string

A list of a single item of the Availability Zone which the Virtual Machine should be allocated in.

additional_capabilities Dict[VirtualMachineAdditionalCapabilities]

A additional_capabilities block.

availability_set_id str

The ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.

boot_diagnostics Dict[VirtualMachineBootDiagnostics]

A boot_diagnostics block.

delete_data_disks_on_termination bool

Should the Data Disks (either the Managed Disks / VHD Blobs) be deleted when the Virtual Machine is destroyed? Defaults to false.

delete_os_disk_on_termination bool

Should the OS Disk (either the Managed Disk / VHD Blob) be deleted when the Virtual Machine is destroyed? Defaults to false.

identity Dict[VirtualMachineIdentity]

A identity block.

license_type str

Specifies the BYOL Type for this Virtual Machine. This is only applicable to Windows Virtual Machines. Possible values are Windows_Client and Windows_Server.

location str

Specifies the Azure Region where the Virtual Machine exists. Changing this forces a new resource to be created.

name str

Specifies the name of the Virtual Machine. Changing this forces a new resource to be created.

network_interface_ids List[str]

A list of Network Interface ID’s which should be associated with the Virtual Machine.

os_profile Dict[VirtualMachineOsProfile]

An os_profile block. Required when create_option in the storage_os_disk block is set to FromImage.

os_profile_linux_config Dict[VirtualMachineOsProfileLinuxConfig]

A os_profile_linux_config block.

os_profile_secrets List[VirtualMachineOsProfileSecret]

One or more os_profile_secrets blocks.

os_profile_windows_config Dict[VirtualMachineOsProfileWindowsConfig]

A os_profile_windows_config block.

plan Dict[VirtualMachinePlan]

A plan block.

primary_network_interface_id str

The ID of the Network Interface (which must be attached to the Virtual Machine) which should be the Primary Network Interface for this Virtual Machine.

proximity_placement_group_id str

The ID of the Proximity Placement Group to which this Virtual Machine should be assigned. Changing this forces a new resource to be created

resource_group_name str

Specifies the name of the Resource Group in which the Virtual Machine should exist. Changing this forces a new resource to be created.

storage_data_disks List[VirtualMachineStorageDataDisk]

One or more storage_data_disk blocks.

storage_image_reference Dict[VirtualMachineStorageImageReference]

A storage_image_reference block.

storage_os_disk Dict[VirtualMachineStorageOsDisk]

A storage_os_disk block.

tags Dict[str, str]

A mapping of tags to assign to the Virtual Machine.

vm_size str

Specifies the size of the Virtual Machine.

zones str

A list of a single item of the Availability Zone which the Virtual Machine should be allocated in.

Supporting Types

VirtualMachineAdditionalCapabilities

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

UltraSsdEnabled bool

Should Ultra SSD disk be enabled for this Virtual Machine?

UltraSsdEnabled bool

Should Ultra SSD disk be enabled for this Virtual Machine?

ultraSsdEnabled boolean

Should Ultra SSD disk be enabled for this Virtual Machine?

ultraSsdEnabled bool

Should Ultra SSD disk be enabled for this Virtual Machine?

VirtualMachineBootDiagnostics

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Enabled bool

Should Boot Diagnostics be enabled for this Virtual Machine?

StorageUri string

The Storage Account’s Blob Endpoint which should hold the virtual machine’s diagnostic files.

Enabled bool

Should Boot Diagnostics be enabled for this Virtual Machine?

StorageUri string

The Storage Account’s Blob Endpoint which should hold the virtual machine’s diagnostic files.

enabled boolean

Should Boot Diagnostics be enabled for this Virtual Machine?

storageUri string

The Storage Account’s Blob Endpoint which should hold the virtual machine’s diagnostic files.

enabled bool

Should Boot Diagnostics be enabled for this Virtual Machine?

storageUri str

The Storage Account’s Blob Endpoint which should hold the virtual machine’s diagnostic files.

VirtualMachineIdentity

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Type string

The Managed Service Identity Type of this Virtual Machine. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned (where you can specify the Service Principal ID’s) to be used by this Virtual Machine using the identity_ids field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities.

IdentityIds List<string>

Specifies a list of user managed identity ids to be assigned to the VM. Required if type is UserAssigned.

PrincipalId string

The Principal ID for the Service Principal associated with the Managed Service Identity of this Virtual Machine.

Type string

The Managed Service Identity Type of this Virtual Machine. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned (where you can specify the Service Principal ID’s) to be used by this Virtual Machine using the identity_ids field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities.

IdentityIds []string

Specifies a list of user managed identity ids to be assigned to the VM. Required if type is UserAssigned.

PrincipalId string

The Principal ID for the Service Principal associated with the Managed Service Identity of this Virtual Machine.

type string

The Managed Service Identity Type of this Virtual Machine. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned (where you can specify the Service Principal ID’s) to be used by this Virtual Machine using the identity_ids field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities.

identityIds string[]

Specifies a list of user managed identity ids to be assigned to the VM. Required if type is UserAssigned.

principalId string

The Principal ID for the Service Principal associated with the Managed Service Identity of this Virtual Machine.

type str

The Managed Service Identity Type of this Virtual Machine. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned (where you can specify the Service Principal ID’s) to be used by this Virtual Machine using the identity_ids field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities.

identityIds List[str]

Specifies a list of user managed identity ids to be assigned to the VM. Required if type is UserAssigned.

principal_id str

The Principal ID for the Service Principal associated with the Managed Service Identity of this Virtual Machine.

VirtualMachineOsProfile

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

AdminUsername string

Specifies the name of the local administrator account.

ComputerName string

Specifies the name of the Virtual Machine.

AdminPassword string

The password associated with the local administrator account.

CustomData string

Specifies custom data to supply to the machine. On Linux-based systems, this can be used as a cloud-init script. On other systems, this will be copied as a file on disk. Internally, this provider will base64 encode this value before sending it to the API. The maximum length of the binary array is 65535 bytes.

AdminUsername string

Specifies the name of the local administrator account.

ComputerName string

Specifies the name of the Virtual Machine.

AdminPassword string

The password associated with the local administrator account.

CustomData string

Specifies custom data to supply to the machine. On Linux-based systems, this can be used as a cloud-init script. On other systems, this will be copied as a file on disk. Internally, this provider will base64 encode this value before sending it to the API. The maximum length of the binary array is 65535 bytes.

adminUsername string

Specifies the name of the local administrator account.

computerName string

Specifies the name of the Virtual Machine.

adminPassword string

The password associated with the local administrator account.

customData string

Specifies custom data to supply to the machine. On Linux-based systems, this can be used as a cloud-init script. On other systems, this will be copied as a file on disk. Internally, this provider will base64 encode this value before sending it to the API. The maximum length of the binary array is 65535 bytes.

admin_username str

Specifies the name of the local administrator account.

computer_name str

Specifies the name of the Virtual Machine.

admin_password str

The password associated with the local administrator account.

custom_data str

Specifies custom data to supply to the machine. On Linux-based systems, this can be used as a cloud-init script. On other systems, this will be copied as a file on disk. Internally, this provider will base64 encode this value before sending it to the API. The maximum length of the binary array is 65535 bytes.

VirtualMachineOsProfileLinuxConfig

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

DisablePasswordAuthentication bool

Specifies whether password authentication should be disabled. If set to false, an admin_password must be specified.

SshKeys List<VirtualMachineOsProfileLinuxConfigSshKeyArgs>

One or more ssh_keys blocks. This field is required if disable_password_authentication is set to true.

DisablePasswordAuthentication bool

Specifies whether password authentication should be disabled. If set to false, an admin_password must be specified.

SshKeys []VirtualMachineOsProfileLinuxConfigSshKey

One or more ssh_keys blocks. This field is required if disable_password_authentication is set to true.

disablePasswordAuthentication boolean

Specifies whether password authentication should be disabled. If set to false, an admin_password must be specified.

sshKeys VirtualMachineOsProfileLinuxConfigSshKey[]

One or more ssh_keys blocks. This field is required if disable_password_authentication is set to true.

disable_password_authentication bool

Specifies whether password authentication should be disabled. If set to false, an admin_password must be specified.

sshKeys List[VirtualMachineOsProfileLinuxConfigSshKey]

One or more ssh_keys blocks. This field is required if disable_password_authentication is set to true.

VirtualMachineOsProfileLinuxConfigSshKey

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

KeyData string

The Public SSH Key which should be written to the path defined above.

Path string

The path of the destination file on the virtual machine

KeyData string

The Public SSH Key which should be written to the path defined above.

Path string

The path of the destination file on the virtual machine

keyData string

The Public SSH Key which should be written to the path defined above.

path string

The path of the destination file on the virtual machine

keyData str

The Public SSH Key which should be written to the path defined above.

path str

The path of the destination file on the virtual machine

VirtualMachineOsProfileSecret

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

SourceVaultId string

Specifies the ID of the Key Vault to use.

VaultCertificates List<VirtualMachineOsProfileSecretVaultCertificateArgs>

One or more vault_certificates blocks.

SourceVaultId string

Specifies the ID of the Key Vault to use.

VaultCertificates []VirtualMachineOsProfileSecretVaultCertificate

One or more vault_certificates blocks.

sourceVaultId string

Specifies the ID of the Key Vault to use.

vaultCertificates VirtualMachineOsProfileSecretVaultCertificate[]

One or more vault_certificates blocks.

sourceVaultId str

Specifies the ID of the Key Vault to use.

vaultCertificates List[VirtualMachineOsProfileSecretVaultCertificate]

One or more vault_certificates blocks.

VirtualMachineOsProfileSecretVaultCertificate

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

CertificateUrl string

The ID of the Key Vault Secret. Stored secret is the Base64 encoding of a JSON Object that which is encoded in UTF-8 of which the contents need to be:

CertificateStore string

Specifies the certificate store on the Virtual Machine where the certificate should be added to, such as My.

CertificateUrl string

The ID of the Key Vault Secret. Stored secret is the Base64 encoding of a JSON Object that which is encoded in UTF-8 of which the contents need to be:

CertificateStore string

Specifies the certificate store on the Virtual Machine where the certificate should be added to, such as My.

certificateUrl string

The ID of the Key Vault Secret. Stored secret is the Base64 encoding of a JSON Object that which is encoded in UTF-8 of which the contents need to be:

certificateStore string

Specifies the certificate store on the Virtual Machine where the certificate should be added to, such as My.

certificateUrl str

The ID of the Key Vault Secret. Stored secret is the Base64 encoding of a JSON Object that which is encoded in UTF-8 of which the contents need to be:

certificateStore str

Specifies the certificate store on the Virtual Machine where the certificate should be added to, such as My.

VirtualMachineOsProfileWindowsConfig

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

AdditionalUnattendConfigs List<VirtualMachineOsProfileWindowsConfigAdditionalUnattendConfigArgs>

A additional_unattend_config block.

EnableAutomaticUpgrades bool

Are automatic updates enabled on this Virtual Machine? Defaults to false.

ProvisionVmAgent bool

Should the Azure Virtual Machine Guest Agent be installed on this Virtual Machine? Defaults to false.

Timezone string

Specifies the time zone of the virtual machine, the possible values are defined here.

Winrms List<VirtualMachineOsProfileWindowsConfigWinrmArgs>

One or more winrm block.

AdditionalUnattendConfigs []VirtualMachineOsProfileWindowsConfigAdditionalUnattendConfig

A additional_unattend_config block.

EnableAutomaticUpgrades bool

Are automatic updates enabled on this Virtual Machine? Defaults to false.

ProvisionVmAgent bool

Should the Azure Virtual Machine Guest Agent be installed on this Virtual Machine? Defaults to false.

Timezone string

Specifies the time zone of the virtual machine, the possible values are defined here.

Winrms []VirtualMachineOsProfileWindowsConfigWinrm

One or more winrm block.

additionalUnattendConfigs VirtualMachineOsProfileWindowsConfigAdditionalUnattendConfig[]

A additional_unattend_config block.

enableAutomaticUpgrades boolean

Are automatic updates enabled on this Virtual Machine? Defaults to false.

provisionVmAgent boolean

Should the Azure Virtual Machine Guest Agent be installed on this Virtual Machine? Defaults to false.

timezone string

Specifies the time zone of the virtual machine, the possible values are defined here.

winrms VirtualMachineOsProfileWindowsConfigWinrm[]

One or more winrm block.

additionalUnattendConfigs List[VirtualMachineOsProfileWindowsConfigAdditionalUnattendConfig]

A additional_unattend_config block.

enableAutomaticUpgrades bool

Are automatic updates enabled on this Virtual Machine? Defaults to false.

provision_vm_agent bool

Should the Azure Virtual Machine Guest Agent be installed on this Virtual Machine? Defaults to false.

timezone str

Specifies the time zone of the virtual machine, the possible values are defined here.

winrms List[VirtualMachineOsProfileWindowsConfigWinrm]

One or more winrm block.

VirtualMachineOsProfileWindowsConfigAdditionalUnattendConfig

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Component string

Specifies the name of the component to configure with the added content. The only allowable value is Microsoft-Windows-Shell-Setup.

Content string

Specifies the base-64 encoded XML formatted content that is added to the unattend.xml file for the specified path and component.

Pass string

Specifies the name of the pass that the content applies to. The only allowable value is oobeSystem.

SettingName string

Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

Component string

Specifies the name of the component to configure with the added content. The only allowable value is Microsoft-Windows-Shell-Setup.

Content string

Specifies the base-64 encoded XML formatted content that is added to the unattend.xml file for the specified path and component.

Pass string

Specifies the name of the pass that the content applies to. The only allowable value is oobeSystem.

SettingName string

Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

component string

Specifies the name of the component to configure with the added content. The only allowable value is Microsoft-Windows-Shell-Setup.

content string

Specifies the base-64 encoded XML formatted content that is added to the unattend.xml file for the specified path and component.

pass string

Specifies the name of the pass that the content applies to. The only allowable value is oobeSystem.

settingName string

Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

component str

Specifies the name of the component to configure with the added content. The only allowable value is Microsoft-Windows-Shell-Setup.

content str

Specifies the base-64 encoded XML formatted content that is added to the unattend.xml file for the specified path and component.

pass str

Specifies the name of the pass that the content applies to. The only allowable value is oobeSystem.

settingName str

Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

VirtualMachineOsProfileWindowsConfigWinrm

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Protocol string

Specifies the protocol of listener. Possible values are HTTP or HTTPS.

CertificateUrl string

The ID of the Key Vault Secret which contains the encrypted Certificate which should be installed on the Virtual Machine. This certificate must also be specified in the vault_certificates block within the os_profile_secrets block.

Protocol string

Specifies the protocol of listener. Possible values are HTTP or HTTPS.

CertificateUrl string

The ID of the Key Vault Secret which contains the encrypted Certificate which should be installed on the Virtual Machine. This certificate must also be specified in the vault_certificates block within the os_profile_secrets block.

protocol string

Specifies the protocol of listener. Possible values are HTTP or HTTPS.

certificateUrl string

The ID of the Key Vault Secret which contains the encrypted Certificate which should be installed on the Virtual Machine. This certificate must also be specified in the vault_certificates block within the os_profile_secrets block.

protocol str

Specifies the protocol of listener. Possible values are HTTP or HTTPS.

certificateUrl str

The ID of the Key Vault Secret which contains the encrypted Certificate which should be installed on the Virtual Machine. This certificate must also be specified in the vault_certificates block within the os_profile_secrets block.

VirtualMachinePlan

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Name string

Specifies the name of the image from the marketplace.

Product string

Specifies the product of the image from the marketplace.

Publisher string

Specifies the publisher of the image.

Name string

Specifies the name of the image from the marketplace.

Product string

Specifies the product of the image from the marketplace.

Publisher string

Specifies the publisher of the image.

name string

Specifies the name of the image from the marketplace.

product string

Specifies the product of the image from the marketplace.

publisher string

Specifies the publisher of the image.

name str

Specifies the name of the image from the marketplace.

product str

Specifies the product of the image from the marketplace.

publisher str

Specifies the publisher of the image.

VirtualMachineStorageDataDisk

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

CreateOption string

Specifies how the data disk should be created. Possible values are Attach, FromImage and Empty.

Lun int

Specifies the logical unit number of the data disk. This needs to be unique within all the Data Disks on the Virtual Machine.

Name string

The name of the Data Disk.

Caching string

Specifies the caching requirements for the Data Disk. Possible values include None, ReadOnly and ReadWrite.

DiskSizeGb int

Specifies the size of the data disk in gigabytes.

ManagedDiskId string

Specifies the ID of an Existing Managed Disk which should be attached to this Virtual Machine. When this field is set create_option must be set to Attach.

ManagedDiskType string

Specifies the type of managed disk to create. Possible values are either Standard_LRS, StandardSSD_LRS, Premium_LRS or UltraSSD_LRS.

VhdUri string

Specifies the URI of the VHD file backing this Unmanaged Data Disk. Changing this forces a new resource to be created.

WriteAcceleratorEnabled bool

Specifies if Write Accelerator is enabled on the disk. This can only be enabled on Premium_LRS managed disks with no caching and M-Series VMs. Defaults to false.

CreateOption string

Specifies how the data disk should be created. Possible values are Attach, FromImage and Empty.

Lun int

Specifies the logical unit number of the data disk. This needs to be unique within all the Data Disks on the Virtual Machine.

Name string

The name of the Data Disk.

Caching string

Specifies the caching requirements for the Data Disk. Possible values include None, ReadOnly and ReadWrite.

DiskSizeGb int

Specifies the size of the data disk in gigabytes.

ManagedDiskId string

Specifies the ID of an Existing Managed Disk which should be attached to this Virtual Machine. When this field is set create_option must be set to Attach.

ManagedDiskType string

Specifies the type of managed disk to create. Possible values are either Standard_LRS, StandardSSD_LRS, Premium_LRS or UltraSSD_LRS.

VhdUri string

Specifies the URI of the VHD file backing this Unmanaged Data Disk. Changing this forces a new resource to be created.

WriteAcceleratorEnabled bool

Specifies if Write Accelerator is enabled on the disk. This can only be enabled on Premium_LRS managed disks with no caching and M-Series VMs. Defaults to false.

createOption string

Specifies how the data disk should be created. Possible values are Attach, FromImage and Empty.

lun number

Specifies the logical unit number of the data disk. This needs to be unique within all the Data Disks on the Virtual Machine.

name string

The name of the Data Disk.

caching string

Specifies the caching requirements for the Data Disk. Possible values include None, ReadOnly and ReadWrite.

diskSizeGb number

Specifies the size of the data disk in gigabytes.

managedDiskId string

Specifies the ID of an Existing Managed Disk which should be attached to this Virtual Machine. When this field is set create_option must be set to Attach.

managedDiskType string

Specifies the type of managed disk to create. Possible values are either Standard_LRS, StandardSSD_LRS, Premium_LRS or UltraSSD_LRS.

vhdUri string

Specifies the URI of the VHD file backing this Unmanaged Data Disk. Changing this forces a new resource to be created.

writeAcceleratorEnabled boolean

Specifies if Write Accelerator is enabled on the disk. This can only be enabled on Premium_LRS managed disks with no caching and M-Series VMs. Defaults to false.

create_option str

Specifies how the data disk should be created. Possible values are Attach, FromImage and Empty.

lun float

Specifies the logical unit number of the data disk. This needs to be unique within all the Data Disks on the Virtual Machine.

name str

The name of the Data Disk.

caching str

Specifies the caching requirements for the Data Disk. Possible values include None, ReadOnly and ReadWrite.

disk_size_gb float

Specifies the size of the data disk in gigabytes.

managedDiskType str

Specifies the type of managed disk to create. Possible values are either Standard_LRS, StandardSSD_LRS, Premium_LRS or UltraSSD_LRS.

managed_disk_id str

Specifies the ID of an Existing Managed Disk which should be attached to this Virtual Machine. When this field is set create_option must be set to Attach.

vhdUri str

Specifies the URI of the VHD file backing this Unmanaged Data Disk. Changing this forces a new resource to be created.

write_accelerator_enabled bool

Specifies if Write Accelerator is enabled on the disk. This can only be enabled on Premium_LRS managed disks with no caching and M-Series VMs. Defaults to false.

VirtualMachineStorageImageReference

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Id string

Specifies the ID of the Custom Image which the Virtual Machine should be created from. Changing this forces a new resource to be created.

Offer string

Specifies the offer of the image used to create the virtual machine. Changing this forces a new resource to be created.

Publisher string

Specifies the publisher of the image used to create the virtual machine. Changing this forces a new resource to be created.

Sku string

Specifies the SKU of the image used to create the virtual machine. Changing this forces a new resource to be created.

Version string

Specifies the version of the image used to create the virtual machine. Changing this forces a new resource to be created.

Id string

Specifies the ID of the Custom Image which the Virtual Machine should be created from. Changing this forces a new resource to be created.

Offer string

Specifies the offer of the image used to create the virtual machine. Changing this forces a new resource to be created.

Publisher string

Specifies the publisher of the image used to create the virtual machine. Changing this forces a new resource to be created.

Sku string

Specifies the SKU of the image used to create the virtual machine. Changing this forces a new resource to be created.

Version string

Specifies the version of the image used to create the virtual machine. Changing this forces a new resource to be created.

id string

Specifies the ID of the Custom Image which the Virtual Machine should be created from. Changing this forces a new resource to be created.

offer string

Specifies the offer of the image used to create the virtual machine. Changing this forces a new resource to be created.

publisher string

Specifies the publisher of the image used to create the virtual machine. Changing this forces a new resource to be created.

sku string

Specifies the SKU of the image used to create the virtual machine. Changing this forces a new resource to be created.

version string

Specifies the version of the image used to create the virtual machine. Changing this forces a new resource to be created.

id str

Specifies the ID of the Custom Image which the Virtual Machine should be created from. Changing this forces a new resource to be created.

offer str

Specifies the offer of the image used to create the virtual machine. Changing this forces a new resource to be created.

publisher str

Specifies the publisher of the image used to create the virtual machine. Changing this forces a new resource to be created.

sku str

Specifies the SKU of the image used to create the virtual machine. Changing this forces a new resource to be created.

version str

Specifies the version of the image used to create the virtual machine. Changing this forces a new resource to be created.

VirtualMachineStorageOsDisk

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

CreateOption string

Specifies how the OS Disk should be created. Possible values are Attach (managed disks only) and FromImage.

Name string

Specifies the name of the OS Disk.

Caching string

Specifies the caching requirements for the OS Disk. Possible values include None, ReadOnly and ReadWrite.

DiskSizeGb int

Specifies the size of the OS Disk in gigabytes.

ImageUri string

Specifies the Image URI in the format publisherName:offer:skus:version. This field can also specify the VHD uri of a custom VM image to clone. When cloning a Custom (Unmanaged) Disk Image the os_type field must be set.

ManagedDiskId string

Specifies the ID of an existing Managed Disk which should be attached as the OS Disk of this Virtual Machine. If this is set then the create_option must be set to Attach.

ManagedDiskType string

Specifies the type of Managed Disk which should be created. Possible values are Standard_LRS, StandardSSD_LRS or Premium_LRS.

OsType string

Specifies the Operating System on the OS Disk. Possible values are Linux and Windows.

VhdUri string

Specifies the URI of the VHD file backing this Unmanaged OS Disk. Changing this forces a new resource to be created.

WriteAcceleratorEnabled bool

Specifies if Write Accelerator is enabled on the disk. This can only be enabled on Premium_LRS managed disks with no caching and M-Series VMs. Defaults to false.

CreateOption string

Specifies how the OS Disk should be created. Possible values are Attach (managed disks only) and FromImage.

Name string

Specifies the name of the OS Disk.

Caching string

Specifies the caching requirements for the OS Disk. Possible values include None, ReadOnly and ReadWrite.

DiskSizeGb int

Specifies the size of the OS Disk in gigabytes.

ImageUri string

Specifies the Image URI in the format publisherName:offer:skus:version. This field can also specify the VHD uri of a custom VM image to clone. When cloning a Custom (Unmanaged) Disk Image the os_type field must be set.

ManagedDiskId string

Specifies the ID of an existing Managed Disk which should be attached as the OS Disk of this Virtual Machine. If this is set then the create_option must be set to Attach.

ManagedDiskType string

Specifies the type of Managed Disk which should be created. Possible values are Standard_LRS, StandardSSD_LRS or Premium_LRS.

OsType string

Specifies the Operating System on the OS Disk. Possible values are Linux and Windows.

VhdUri string

Specifies the URI of the VHD file backing this Unmanaged OS Disk. Changing this forces a new resource to be created.

WriteAcceleratorEnabled bool

Specifies if Write Accelerator is enabled on the disk. This can only be enabled on Premium_LRS managed disks with no caching and M-Series VMs. Defaults to false.

createOption string

Specifies how the OS Disk should be created. Possible values are Attach (managed disks only) and FromImage.

name string

Specifies the name of the OS Disk.

caching string

Specifies the caching requirements for the OS Disk. Possible values include None, ReadOnly and ReadWrite.

diskSizeGb number

Specifies the size of the OS Disk in gigabytes.

imageUri string

Specifies the Image URI in the format publisherName:offer:skus:version. This field can also specify the VHD uri of a custom VM image to clone. When cloning a Custom (Unmanaged) Disk Image the os_type field must be set.

managedDiskId string

Specifies the ID of an existing Managed Disk which should be attached as the OS Disk of this Virtual Machine. If this is set then the create_option must be set to Attach.

managedDiskType string

Specifies the type of Managed Disk which should be created. Possible values are Standard_LRS, StandardSSD_LRS or Premium_LRS.

osType string

Specifies the Operating System on the OS Disk. Possible values are Linux and Windows.

vhdUri string

Specifies the URI of the VHD file backing this Unmanaged OS Disk. Changing this forces a new resource to be created.

writeAcceleratorEnabled boolean

Specifies if Write Accelerator is enabled on the disk. This can only be enabled on Premium_LRS managed disks with no caching and M-Series VMs. Defaults to false.

create_option str

Specifies how the OS Disk should be created. Possible values are Attach (managed disks only) and FromImage.

name str

Specifies the name of the OS Disk.

caching str

Specifies the caching requirements for the OS Disk. Possible values include None, ReadOnly and ReadWrite.

disk_size_gb float

Specifies the size of the OS Disk in gigabytes.

imageUri str

Specifies the Image URI in the format publisherName:offer:skus:version. This field can also specify the VHD uri of a custom VM image to clone. When cloning a Custom (Unmanaged) Disk Image the os_type field must be set.

managedDiskType str

Specifies the type of Managed Disk which should be created. Possible values are Standard_LRS, StandardSSD_LRS or Premium_LRS.

managed_disk_id str

Specifies the ID of an existing Managed Disk which should be attached as the OS Disk of this Virtual Machine. If this is set then the create_option must be set to Attach.

os_type str

Specifies the Operating System on the OS Disk. Possible values are Linux and Windows.

vhdUri str

Specifies the URI of the VHD file backing this Unmanaged OS Disk. Changing this forces a new resource to be created.

write_accelerator_enabled bool

Specifies if Write Accelerator is enabled on the disk. This can only be enabled on Premium_LRS managed disks with no caching and M-Series VMs. Defaults to false.

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.