VirtualMachine
Manages a Virtual Machine.
Disclaimers
Note: The
azure.compute.VirtualMachineresource has been superseded by theazure.compute.LinuxVirtualMachineandazure.compute.WindowsVirtualMachineresources. The existingazure.compute.VirtualMachineresource 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 theazure.compute.LinuxVirtualMachineandazure.compute.WindowsVirtualMachineresources.Note: Data Disks can be attached either directly on the
azure.compute.VirtualMachineresource, or using theazure.compute.DataDiskAttachmentresource - but the two cannot be used together. If both are used against the same Virtual Machine, spurious changes will occur.
Create a VirtualMachine Resource
new VirtualMachine(name: string, args: VirtualMachineArgs, opts?: CustomResourceOptions);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);func NewVirtualMachine(ctx *Context, name string, args VirtualMachineArgs, opts ...ResourceOption) (*VirtualMachine, error)public VirtualMachine(string name, VirtualMachineArgs args, CustomResourceOptions? opts = null)- 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:
- Network
Interface List<string>Ids A list of Network Interface ID’s which should be associated with the Virtual Machine.
- Resource
Group stringName 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 VirtualDisk Machine Storage Os Disk Args A
storage_os_diskblock.- Vm
Size string Specifies the size of the Virtual Machine.
- Additional
Capabilities VirtualMachine Additional Capabilities Args A
additional_capabilitiesblock.- Availability
Set stringId The ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.
- Boot
Diagnostics VirtualMachine Boot Diagnostics Args A
boot_diagnosticsblock.- Delete
Data boolDisks On Termination Should the Data Disks (either the Managed Disks / VHD Blobs) be deleted when the Virtual Machine is destroyed? Defaults to
false.- Delete
Os boolDisk On Termination Should the OS Disk (either the Managed Disk / VHD Blob) be deleted when the Virtual Machine is destroyed? Defaults to
false.- Identity
Virtual
Machine Identity Args A
identityblock.- License
Type string Specifies the BYOL Type for this Virtual Machine. This is only applicable to Windows Virtual Machines. Possible values are
Windows_ClientandWindows_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.
- Os
Profile VirtualMachine Os Profile Args An
os_profileblock. Required whencreate_optionin thestorage_os_diskblock is set toFromImage.- Os
Profile VirtualLinux Config Machine Os Profile Linux Config Args A
os_profile_linux_configblock.- Os
Profile List<VirtualSecrets Machine Os Profile Secret Args> One or more
os_profile_secretsblocks.- Os
Profile VirtualWindows Config Machine Os Profile Windows Config Args A
os_profile_windows_configblock.- Plan
Virtual
Machine Plan Args A
planblock.- Primary
Network stringInterface Id 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 stringGroup Id 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 List<VirtualDisks Machine Storage Data Disk Args> One or more
storage_data_diskblocks.- Storage
Image VirtualReference Machine Storage Image Reference Args A
storage_image_referenceblock.- 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.
- Network
Interface []stringIds A list of Network Interface ID’s which should be associated with the Virtual Machine.
- Resource
Group stringName 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 VirtualDisk Machine Storage Os Disk A
storage_os_diskblock.- Vm
Size string Specifies the size of the Virtual Machine.
- Additional
Capabilities VirtualMachine Additional Capabilities A
additional_capabilitiesblock.- Availability
Set stringId The ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.
- Boot
Diagnostics VirtualMachine Boot Diagnostics A
boot_diagnosticsblock.- Delete
Data boolDisks On Termination Should the Data Disks (either the Managed Disks / VHD Blobs) be deleted when the Virtual Machine is destroyed? Defaults to
false.- Delete
Os boolDisk On Termination Should the OS Disk (either the Managed Disk / VHD Blob) be deleted when the Virtual Machine is destroyed? Defaults to
false.- Identity
Virtual
Machine Identity A
identityblock.- License
Type string Specifies the BYOL Type for this Virtual Machine. This is only applicable to Windows Virtual Machines. Possible values are
Windows_ClientandWindows_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.
- Os
Profile VirtualMachine Os Profile An
os_profileblock. Required whencreate_optionin thestorage_os_diskblock is set toFromImage.- Os
Profile VirtualLinux Config Machine Os Profile Linux Config A
os_profile_linux_configblock.- Os
Profile []VirtualSecrets Machine Os Profile Secret One or more
os_profile_secretsblocks.- Os
Profile VirtualWindows Config Machine Os Profile Windows Config A
os_profile_windows_configblock.- Plan
Virtual
Machine Plan A
planblock.- Primary
Network stringInterface Id 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 stringGroup Id 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 []VirtualDisks Machine Storage Data Disk One or more
storage_data_diskblocks.- Storage
Image VirtualReference Machine Storage Image Reference A
storage_image_referenceblock.- 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.
- network
Interface string[]Ids A list of Network Interface ID’s which should be associated with the Virtual Machine.
- resource
Group stringName 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 VirtualDisk Machine Storage Os Disk A
storage_os_diskblock.- vm
Size string Specifies the size of the Virtual Machine.
- additional
Capabilities VirtualMachine Additional Capabilities A
additional_capabilitiesblock.- availability
Set stringId The ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.
- boot
Diagnostics VirtualMachine Boot Diagnostics A
boot_diagnosticsblock.- delete
Data booleanDisks On Termination Should the Data Disks (either the Managed Disks / VHD Blobs) be deleted when the Virtual Machine is destroyed? Defaults to
false.- delete
Os booleanDisk On Termination Should the OS Disk (either the Managed Disk / VHD Blob) be deleted when the Virtual Machine is destroyed? Defaults to
false.- identity
Virtual
Machine Identity A
identityblock.- license
Type string Specifies the BYOL Type for this Virtual Machine. This is only applicable to Windows Virtual Machines. Possible values are
Windows_ClientandWindows_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.
- os
Profile VirtualMachine Os Profile An
os_profileblock. Required whencreate_optionin thestorage_os_diskblock is set toFromImage.- os
Profile VirtualLinux Config Machine Os Profile Linux Config A
os_profile_linux_configblock.- os
Profile VirtualSecrets Machine Os Profile Secret[] One or more
os_profile_secretsblocks.- os
Profile VirtualWindows Config Machine Os Profile Windows Config A
os_profile_windows_configblock.- plan
Virtual
Machine Plan A
planblock.- primary
Network stringInterface Id 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 stringGroup Id 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 VirtualDisks Machine Storage Data Disk[] One or more
storage_data_diskblocks.- storage
Image VirtualReference Machine Storage Image Reference A
storage_image_referenceblock.- {[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_ List[str]ids A list of Network Interface ID’s which should be associated with the Virtual Machine.
- resource_
group_ strname 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_ Dict[Virtualdisk Machine Storage Os Disk] A
storage_os_diskblock.- vm_
size str Specifies the size of the Virtual Machine.
- additional_
capabilities Dict[VirtualMachine Additional Capabilities] A
additional_capabilitiesblock.- availability_
set_ strid 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[VirtualMachine Boot Diagnostics] A
boot_diagnosticsblock.- delete_
data_ booldisks_ on_ termination Should the Data Disks (either the Managed Disks / VHD Blobs) be deleted when the Virtual Machine is destroyed? Defaults to
false.- delete_
os_ booldisk_ on_ termination Should the OS Disk (either the Managed Disk / VHD Blob) be deleted when the Virtual Machine is destroyed? Defaults to
false.- identity
Dict[Virtual
Machine Identity] A
identityblock.- license_
type str Specifies the BYOL Type for this Virtual Machine. This is only applicable to Windows Virtual Machines. Possible values are
Windows_ClientandWindows_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[VirtualMachine Os Profile] An
os_profileblock. Required whencreate_optionin thestorage_os_diskblock is set toFromImage.- os_
profile_ Dict[Virtuallinux_ config Machine Os Profile Linux Config] A
os_profile_linux_configblock.- os_
profile_ List[Virtualsecrets Machine Os Profile Secret] One or more
os_profile_secretsblocks.- os_
profile_ Dict[Virtualwindows_ config Machine Os Profile Windows Config] A
os_profile_windows_configblock.- plan
Dict[Virtual
Machine Plan] A
planblock.- primary_
network_ strinterface_ id 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_ strgroup_ id 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_ List[Virtualdisks Machine Storage Data Disk] One or more
storage_data_diskblocks.- storage_
image_ Dict[Virtualreference Machine Storage Image Reference] A
storage_image_referenceblock.- 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:
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): VirtualMachinestatic 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:
- Additional
Capabilities VirtualMachine Additional Capabilities Args A
additional_capabilitiesblock.- Availability
Set stringId The ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.
- Boot
Diagnostics VirtualMachine Boot Diagnostics Args A
boot_diagnosticsblock.- Delete
Data boolDisks On Termination Should the Data Disks (either the Managed Disks / VHD Blobs) be deleted when the Virtual Machine is destroyed? Defaults to
false.- Delete
Os boolDisk On Termination Should the OS Disk (either the Managed Disk / VHD Blob) be deleted when the Virtual Machine is destroyed? Defaults to
false.- Identity
Virtual
Machine Identity Args A
identityblock.- License
Type string Specifies the BYOL Type for this Virtual Machine. This is only applicable to Windows Virtual Machines. Possible values are
Windows_ClientandWindows_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.
- Network
Interface List<string>Ids A list of Network Interface ID’s which should be associated with the Virtual Machine.
- Os
Profile VirtualMachine Os Profile Args An
os_profileblock. Required whencreate_optionin thestorage_os_diskblock is set toFromImage.- Os
Profile VirtualLinux Config Machine Os Profile Linux Config Args A
os_profile_linux_configblock.- Os
Profile List<VirtualSecrets Machine Os Profile Secret Args> One or more
os_profile_secretsblocks.- Os
Profile VirtualWindows Config Machine Os Profile Windows Config Args A
os_profile_windows_configblock.- Plan
Virtual
Machine Plan Args A
planblock.- Primary
Network stringInterface Id 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 stringGroup Id 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 stringName 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 List<VirtualDisks Machine Storage Data Disk Args> One or more
storage_data_diskblocks.- Storage
Image VirtualReference Machine Storage Image Reference Args A
storage_image_referenceblock.- Storage
Os VirtualDisk Machine Storage Os Disk Args A
storage_os_diskblock.- Dictionary<string, string>
A mapping of tags to assign to the Virtual Machine.
- Vm
Size 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 VirtualMachine Additional Capabilities A
additional_capabilitiesblock.- Availability
Set stringId The ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.
- Boot
Diagnostics VirtualMachine Boot Diagnostics A
boot_diagnosticsblock.- Delete
Data boolDisks On Termination Should the Data Disks (either the Managed Disks / VHD Blobs) be deleted when the Virtual Machine is destroyed? Defaults to
false.- Delete
Os boolDisk On Termination Should the OS Disk (either the Managed Disk / VHD Blob) be deleted when the Virtual Machine is destroyed? Defaults to
false.- Identity
Virtual
Machine Identity A
identityblock.- License
Type string Specifies the BYOL Type for this Virtual Machine. This is only applicable to Windows Virtual Machines. Possible values are
Windows_ClientandWindows_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.
- Network
Interface []stringIds A list of Network Interface ID’s which should be associated with the Virtual Machine.
- Os
Profile VirtualMachine Os Profile An
os_profileblock. Required whencreate_optionin thestorage_os_diskblock is set toFromImage.- Os
Profile VirtualLinux Config Machine Os Profile Linux Config A
os_profile_linux_configblock.- Os
Profile []VirtualSecrets Machine Os Profile Secret One or more
os_profile_secretsblocks.- Os
Profile VirtualWindows Config Machine Os Profile Windows Config A
os_profile_windows_configblock.- Plan
Virtual
Machine Plan A
planblock.- Primary
Network stringInterface Id 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 stringGroup Id 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 stringName 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 []VirtualDisks Machine Storage Data Disk One or more
storage_data_diskblocks.- Storage
Image VirtualReference Machine Storage Image Reference A
storage_image_referenceblock.- Storage
Os VirtualDisk Machine Storage Os Disk A
storage_os_diskblock.- map[string]string
A mapping of tags to assign to the Virtual Machine.
- Vm
Size 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 VirtualMachine Additional Capabilities A
additional_capabilitiesblock.- availability
Set stringId The ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.
- boot
Diagnostics VirtualMachine Boot Diagnostics A
boot_diagnosticsblock.- delete
Data booleanDisks On Termination Should the Data Disks (either the Managed Disks / VHD Blobs) be deleted when the Virtual Machine is destroyed? Defaults to
false.- delete
Os booleanDisk On Termination Should the OS Disk (either the Managed Disk / VHD Blob) be deleted when the Virtual Machine is destroyed? Defaults to
false.- identity
Virtual
Machine Identity A
identityblock.- license
Type string Specifies the BYOL Type for this Virtual Machine. This is only applicable to Windows Virtual Machines. Possible values are
Windows_ClientandWindows_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.
- network
Interface string[]Ids A list of Network Interface ID’s which should be associated with the Virtual Machine.
- os
Profile VirtualMachine Os Profile An
os_profileblock. Required whencreate_optionin thestorage_os_diskblock is set toFromImage.- os
Profile VirtualLinux Config Machine Os Profile Linux Config A
os_profile_linux_configblock.- os
Profile VirtualSecrets Machine Os Profile Secret[] One or more
os_profile_secretsblocks.- os
Profile VirtualWindows Config Machine Os Profile Windows Config A
os_profile_windows_configblock.- plan
Virtual
Machine Plan A
planblock.- primary
Network stringInterface Id 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 stringGroup Id 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 stringName 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 VirtualDisks Machine Storage Data Disk[] One or more
storage_data_diskblocks.- storage
Image VirtualReference Machine Storage Image Reference A
storage_image_referenceblock.- storage
Os VirtualDisk Machine Storage Os Disk A
storage_os_diskblock.- {[key: string]: string}
A mapping of tags to assign to the Virtual Machine.
- vm
Size 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[VirtualMachine Additional Capabilities] A
additional_capabilitiesblock.- availability_
set_ strid 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[VirtualMachine Boot Diagnostics] A
boot_diagnosticsblock.- delete_
data_ booldisks_ on_ termination Should the Data Disks (either the Managed Disks / VHD Blobs) be deleted when the Virtual Machine is destroyed? Defaults to
false.- delete_
os_ booldisk_ on_ termination Should the OS Disk (either the Managed Disk / VHD Blob) be deleted when the Virtual Machine is destroyed? Defaults to
false.- identity
Dict[Virtual
Machine Identity] A
identityblock.- license_
type str Specifies the BYOL Type for this Virtual Machine. This is only applicable to Windows Virtual Machines. Possible values are
Windows_ClientandWindows_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_ List[str]ids A list of Network Interface ID’s which should be associated with the Virtual Machine.
- os_
profile Dict[VirtualMachine Os Profile] An
os_profileblock. Required whencreate_optionin thestorage_os_diskblock is set toFromImage.- os_
profile_ Dict[Virtuallinux_ config Machine Os Profile Linux Config] A
os_profile_linux_configblock.- os_
profile_ List[Virtualsecrets Machine Os Profile Secret] One or more
os_profile_secretsblocks.- os_
profile_ Dict[Virtualwindows_ config Machine Os Profile Windows Config] A
os_profile_windows_configblock.- plan
Dict[Virtual
Machine Plan] A
planblock.- primary_
network_ strinterface_ id 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_ strgroup_ id 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_ strname 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_ List[Virtualdisks Machine Storage Data Disk] One or more
storage_data_diskblocks.- storage_
image_ Dict[Virtualreference Machine Storage Image Reference] A
storage_image_referenceblock.- storage_
os_ Dict[Virtualdisk Machine Storage Os Disk] A
storage_os_diskblock.- 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
- Ultra
Ssd boolEnabled Should Ultra SSD disk be enabled for this Virtual Machine?
- Ultra
Ssd boolEnabled Should Ultra SSD disk be enabled for this Virtual Machine?
- ultra
Ssd booleanEnabled Should Ultra SSD disk be enabled for this Virtual Machine?
- ultra
Ssd boolEnabled Should Ultra SSD disk be enabled for this Virtual Machine?
VirtualMachineBootDiagnostics
- Enabled bool
Should Boot Diagnostics be enabled for this Virtual Machine?
- Storage
Uri 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?
- Storage
Uri 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?
- storage
Uri 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?
- storage
Uri str The Storage Account’s Blob Endpoint which should hold the virtual machine’s diagnostic files.
VirtualMachineIdentity
- 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 theidentity_idsfield, andSystemAssigned, UserAssignedwhich assigns both a system managed identity as well as the specified user assigned identities.- Identity
Ids List<string> Specifies a list of user managed identity ids to be assigned to the VM. Required if
typeisUserAssigned.- Principal
Id 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 theidentity_idsfield, andSystemAssigned, UserAssignedwhich assigns both a system managed identity as well as the specified user assigned identities.- Identity
Ids []string Specifies a list of user managed identity ids to be assigned to the VM. Required if
typeisUserAssigned.- Principal
Id 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 theidentity_idsfield, andSystemAssigned, UserAssignedwhich assigns both a system managed identity as well as the specified user assigned identities.- identity
Ids string[] Specifies a list of user managed identity ids to be assigned to the VM. Required if
typeisUserAssigned.- principal
Id 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 theidentity_idsfield, andSystemAssigned, UserAssignedwhich assigns both a system managed identity as well as the specified user assigned identities.- identity
Ids List[str] Specifies a list of user managed identity ids to be assigned to the VM. Required if
typeisUserAssigned.- principal_
id str The Principal ID for the Service Principal associated with the Managed Service Identity of this Virtual Machine.
VirtualMachineOsProfile
- Admin
Username string Specifies the name of the local administrator account.
- Computer
Name string Specifies the name of the Virtual Machine.
- Admin
Password string The password associated with the local administrator account.
- Custom
Data 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 string Specifies the name of the local administrator account.
- Computer
Name string Specifies the name of the Virtual Machine.
- Admin
Password string The password associated with the local administrator account.
- Custom
Data 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 string Specifies the name of the local administrator account.
- computer
Name string Specifies the name of the Virtual Machine.
- admin
Password string The password associated with the local administrator account.
- custom
Data 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
- Disable
Password boolAuthentication Specifies whether password authentication should be disabled. If set to
false, anadmin_passwordmust be specified.- Ssh
Keys List<VirtualMachine Os Profile Linux Config Ssh Key Args> One or more
ssh_keysblocks. This field is required ifdisable_password_authenticationis set totrue.
- Disable
Password boolAuthentication Specifies whether password authentication should be disabled. If set to
false, anadmin_passwordmust be specified.- Ssh
Keys []VirtualMachine Os Profile Linux Config Ssh Key One or more
ssh_keysblocks. This field is required ifdisable_password_authenticationis set totrue.
- disable
Password booleanAuthentication Specifies whether password authentication should be disabled. If set to
false, anadmin_passwordmust be specified.- ssh
Keys VirtualMachine Os Profile Linux Config Ssh Key[] One or more
ssh_keysblocks. This field is required ifdisable_password_authenticationis set totrue.
- disable_
password_ boolauthentication Specifies whether password authentication should be disabled. If set to
false, anadmin_passwordmust be specified.- ssh
Keys List[VirtualMachine Os Profile Linux Config Ssh Key] One or more
ssh_keysblocks. This field is required ifdisable_password_authenticationis set totrue.
VirtualMachineOsProfileLinuxConfigSshKey
VirtualMachineOsProfileSecret
- Source
Vault stringId Specifies the ID of the Key Vault to use.
- Vault
Certificates List<VirtualMachine Os Profile Secret Vault Certificate Args> One or more
vault_certificatesblocks.
- Source
Vault stringId Specifies the ID of the Key Vault to use.
- Vault
Certificates []VirtualMachine Os Profile Secret Vault Certificate One or more
vault_certificatesblocks.
- source
Vault stringId Specifies the ID of the Key Vault to use.
- vault
Certificates VirtualMachine Os Profile Secret Vault Certificate[] One or more
vault_certificatesblocks.
- source
Vault strId Specifies the ID of the Key Vault to use.
- vault
Certificates List[VirtualMachine Os Profile Secret Vault Certificate] One or more
vault_certificatesblocks.
VirtualMachineOsProfileSecretVaultCertificate
- Certificate
Url 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:
- Certificate
Store string Specifies the certificate store on the Virtual Machine where the certificate should be added to, such as
My.
- Certificate
Url 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:
- Certificate
Store string Specifies the certificate store on the Virtual Machine where the certificate should be added to, such as
My.
- certificate
Url 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:
- certificate
Store string Specifies the certificate store on the Virtual Machine where the certificate should be added to, such as
My.
- certificate
Url 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:
- certificate
Store str Specifies the certificate store on the Virtual Machine where the certificate should be added to, such as
My.
VirtualMachineOsProfileWindowsConfig
- Additional
Unattend List<VirtualConfigs Machine Os Profile Windows Config Additional Unattend Config Args> A
additional_unattend_configblock.- Enable
Automatic boolUpgrades Are automatic updates enabled on this Virtual Machine? Defaults to
false.- Provision
Vm boolAgent 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<Virtual
Machine Os Profile Windows Config Winrm Args> One or more
winrmblock.
- Additional
Unattend []VirtualConfigs Machine Os Profile Windows Config Additional Unattend Config A
additional_unattend_configblock.- Enable
Automatic boolUpgrades Are automatic updates enabled on this Virtual Machine? Defaults to
false.- Provision
Vm boolAgent 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
[]Virtual
Machine Os Profile Windows Config Winrm One or more
winrmblock.
- additional
Unattend VirtualConfigs Machine Os Profile Windows Config Additional Unattend Config[] A
additional_unattend_configblock.- enable
Automatic booleanUpgrades Are automatic updates enabled on this Virtual Machine? Defaults to
false.- provision
Vm booleanAgent 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
Virtual
Machine Os Profile Windows Config Winrm[] One or more
winrmblock.
- additional
Unattend List[VirtualConfigs Machine Os Profile Windows Config Additional Unattend Config] A
additional_unattend_configblock.- enable
Automatic boolUpgrades Are automatic updates enabled on this Virtual Machine? Defaults to
false.- provision_
vm_ boolagent 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[Virtual
Machine Os Profile Windows Config Winrm] One or more
winrmblock.
VirtualMachineOsProfileWindowsConfigAdditionalUnattendConfig
- 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.- Setting
Name string Specifies the name of the setting to which the content applies. Possible values are:
FirstLogonCommandsandAutoLogon.
- 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.- Setting
Name string Specifies the name of the setting to which the content applies. Possible values are:
FirstLogonCommandsandAutoLogon.
- 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.- setting
Name string Specifies the name of the setting to which the content applies. Possible values are:
FirstLogonCommandsandAutoLogon.
- 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.- setting
Name str Specifies the name of the setting to which the content applies. Possible values are:
FirstLogonCommandsandAutoLogon.
VirtualMachineOsProfileWindowsConfigWinrm
- Protocol string
Specifies the protocol of listener. Possible values are
HTTPorHTTPS.- Certificate
Url 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_certificatesblock within theos_profile_secretsblock.
- Protocol string
Specifies the protocol of listener. Possible values are
HTTPorHTTPS.- Certificate
Url 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_certificatesblock within theos_profile_secretsblock.
- protocol string
Specifies the protocol of listener. Possible values are
HTTPorHTTPS.- certificate
Url 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_certificatesblock within theos_profile_secretsblock.
- protocol str
Specifies the protocol of listener. Possible values are
HTTPorHTTPS.- certificate
Url 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_certificatesblock within theos_profile_secretsblock.
VirtualMachinePlan
VirtualMachineStorageDataDisk
- Create
Option string Specifies how the data disk should be created. Possible values are
Attach,FromImageandEmpty.- 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,ReadOnlyandReadWrite.- Disk
Size intGb Specifies the size of the data disk in gigabytes.
- Managed
Disk stringId Specifies the ID of an Existing Managed Disk which should be attached to this Virtual Machine. When this field is set
create_optionmust be set toAttach.- Managed
Disk stringType Specifies the type of managed disk to create. Possible values are either
Standard_LRS,StandardSSD_LRS,Premium_LRSorUltraSSD_LRS.- Vhd
Uri string Specifies the URI of the VHD file backing this Unmanaged Data Disk. Changing this forces a new resource to be created.
- Write
Accelerator boolEnabled Specifies if Write Accelerator is enabled on the disk. This can only be enabled on
Premium_LRSmanaged disks with no caching and M-Series VMs. Defaults tofalse.
- Create
Option string Specifies how the data disk should be created. Possible values are
Attach,FromImageandEmpty.- 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,ReadOnlyandReadWrite.- Disk
Size intGb Specifies the size of the data disk in gigabytes.
- Managed
Disk stringId Specifies the ID of an Existing Managed Disk which should be attached to this Virtual Machine. When this field is set
create_optionmust be set toAttach.- Managed
Disk stringType Specifies the type of managed disk to create. Possible values are either
Standard_LRS,StandardSSD_LRS,Premium_LRSorUltraSSD_LRS.- Vhd
Uri string Specifies the URI of the VHD file backing this Unmanaged Data Disk. Changing this forces a new resource to be created.
- Write
Accelerator boolEnabled Specifies if Write Accelerator is enabled on the disk. This can only be enabled on
Premium_LRSmanaged disks with no caching and M-Series VMs. Defaults tofalse.
- create
Option string Specifies how the data disk should be created. Possible values are
Attach,FromImageandEmpty.- 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,ReadOnlyandReadWrite.- disk
Size numberGb Specifies the size of the data disk in gigabytes.
- managed
Disk stringId Specifies the ID of an Existing Managed Disk which should be attached to this Virtual Machine. When this field is set
create_optionmust be set toAttach.- managed
Disk stringType Specifies the type of managed disk to create. Possible values are either
Standard_LRS,StandardSSD_LRS,Premium_LRSorUltraSSD_LRS.- vhd
Uri string Specifies the URI of the VHD file backing this Unmanaged Data Disk. Changing this forces a new resource to be created.
- write
Accelerator booleanEnabled Specifies if Write Accelerator is enabled on the disk. This can only be enabled on
Premium_LRSmanaged disks with no caching and M-Series VMs. Defaults tofalse.
- create_
option str Specifies how the data disk should be created. Possible values are
Attach,FromImageandEmpty.- 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,ReadOnlyandReadWrite.- disk_
size_ floatgb Specifies the size of the data disk in gigabytes.
- managed
Disk strType Specifies the type of managed disk to create. Possible values are either
Standard_LRS,StandardSSD_LRS,Premium_LRSorUltraSSD_LRS.- managed_
disk_ strid Specifies the ID of an Existing Managed Disk which should be attached to this Virtual Machine. When this field is set
create_optionmust be set toAttach.- vhd
Uri str Specifies the URI of the VHD file backing this Unmanaged Data Disk. Changing this forces a new resource to be created.
- write_
accelerator_ boolenabled Specifies if Write Accelerator is enabled on the disk. This can only be enabled on
Premium_LRSmanaged disks with no caching and M-Series VMs. Defaults tofalse.
VirtualMachineStorageImageReference
- 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
- Create
Option string Specifies how the OS Disk should be created. Possible values are
Attach(managed disks only) andFromImage.- Name string
Specifies the name of the OS Disk.
- Caching string
Specifies the caching requirements for the OS Disk. Possible values include
None,ReadOnlyandReadWrite.- Disk
Size intGb Specifies the size of the OS Disk in gigabytes.
- Image
Uri 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 theos_typefield must be set.- Managed
Disk stringId 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_optionmust be set toAttach.- Managed
Disk stringType Specifies the type of Managed Disk which should be created. Possible values are
Standard_LRS,StandardSSD_LRSorPremium_LRS.- Os
Type string Specifies the Operating System on the OS Disk. Possible values are
LinuxandWindows.- Vhd
Uri string Specifies the URI of the VHD file backing this Unmanaged OS Disk. Changing this forces a new resource to be created.
- Write
Accelerator boolEnabled Specifies if Write Accelerator is enabled on the disk. This can only be enabled on
Premium_LRSmanaged disks with no caching and M-Series VMs. Defaults tofalse.
- Create
Option string Specifies how the OS Disk should be created. Possible values are
Attach(managed disks only) andFromImage.- Name string
Specifies the name of the OS Disk.
- Caching string
Specifies the caching requirements for the OS Disk. Possible values include
None,ReadOnlyandReadWrite.- Disk
Size intGb Specifies the size of the OS Disk in gigabytes.
- Image
Uri 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 theos_typefield must be set.- Managed
Disk stringId 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_optionmust be set toAttach.- Managed
Disk stringType Specifies the type of Managed Disk which should be created. Possible values are
Standard_LRS,StandardSSD_LRSorPremium_LRS.- Os
Type string Specifies the Operating System on the OS Disk. Possible values are
LinuxandWindows.- Vhd
Uri string Specifies the URI of the VHD file backing this Unmanaged OS Disk. Changing this forces a new resource to be created.
- Write
Accelerator boolEnabled Specifies if Write Accelerator is enabled on the disk. This can only be enabled on
Premium_LRSmanaged disks with no caching and M-Series VMs. Defaults tofalse.
- create
Option string Specifies how the OS Disk should be created. Possible values are
Attach(managed disks only) andFromImage.- name string
Specifies the name of the OS Disk.
- caching string
Specifies the caching requirements for the OS Disk. Possible values include
None,ReadOnlyandReadWrite.- disk
Size numberGb Specifies the size of the OS Disk in gigabytes.
- image
Uri 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 theos_typefield must be set.- managed
Disk stringId 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_optionmust be set toAttach.- managed
Disk stringType Specifies the type of Managed Disk which should be created. Possible values are
Standard_LRS,StandardSSD_LRSorPremium_LRS.- os
Type string Specifies the Operating System on the OS Disk. Possible values are
LinuxandWindows.- vhd
Uri string Specifies the URI of the VHD file backing this Unmanaged OS Disk. Changing this forces a new resource to be created.
- write
Accelerator booleanEnabled Specifies if Write Accelerator is enabled on the disk. This can only be enabled on
Premium_LRSmanaged disks with no caching and M-Series VMs. Defaults tofalse.
- create_
option str Specifies how the OS Disk should be created. Possible values are
Attach(managed disks only) andFromImage.- name str
Specifies the name of the OS Disk.
- caching str
Specifies the caching requirements for the OS Disk. Possible values include
None,ReadOnlyandReadWrite.- disk_
size_ floatgb Specifies the size of the OS Disk in gigabytes.
- image
Uri 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 theos_typefield must be set.- managed
Disk strType Specifies the type of Managed Disk which should be created. Possible values are
Standard_LRS,StandardSSD_LRSorPremium_LRS.- managed_
disk_ strid 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_optionmust be set toAttach.- os_
type str Specifies the Operating System on the OS Disk. Possible values are
LinuxandWindows.- vhd
Uri str Specifies the URI of the VHD file backing this Unmanaged OS Disk. Changing this forces a new resource to be created.
- write_
accelerator_ boolenabled Specifies if Write Accelerator is enabled on the disk. This can only be enabled on
Premium_LRSmanaged disks with no caching and M-Series VMs. Defaults tofalse.
Package Details
- Repository
- https://github.com/pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.