Struct WindowsVirtualMachineArgs

pub struct WindowsVirtualMachineArgs {

    pub additional_capabilities: Output<Option<WindowsVirtualMachineAdditionalCapabilities>>,
    pub additional_unattend_contents: Output<Option<Vec<WindowsVirtualMachineAdditionalUnattendContent>>>,
    pub admin_password: Output<String>,
    pub admin_username: Output<String>,
    pub allow_extension_operations: Output<Option<bool>>,
    pub availability_set_id: Output<Option<String>>,
    pub boot_diagnostics: Output<Option<WindowsVirtualMachineBootDiagnostics>>,
    pub bypass_platform_safety_checks_on_user_schedule_enabled: Output<Option<bool>>,
    pub capacity_reservation_group_id: Output<Option<String>>,
    pub computer_name: Output<Option<String>>,
    pub custom_data: Output<Option<String>>,
    pub dedicated_host_group_id: Output<Option<String>>,
    pub dedicated_host_id: Output<Option<String>>,
    pub disk_controller_type: Output<Option<String>>,
    pub edge_zone: Output<Option<String>>,
    pub enable_automatic_updates: Output<Option<bool>>,
    pub encryption_at_host_enabled: Output<Option<bool>>,
    pub eviction_policy: Output<Option<String>>,
    pub extensions_time_budget: Output<Option<String>>,
    pub gallery_applications: Output<Option<Vec<WindowsVirtualMachineGalleryApplication>>>,
    pub hotpatching_enabled: Output<Option<bool>>,
    pub identity: Output<Option<WindowsVirtualMachineIdentity>>,
    pub license_type: Output<Option<String>>,
    pub location: Output<Option<String>>,
    pub max_bid_price: Output<Option<f64>>,
    pub name: Output<Option<String>>,
    pub network_interface_ids: Output<Vec<String>>,
    pub os_disk: Output<WindowsVirtualMachineOsDisk>,
    pub os_image_notification: Output<Option<WindowsVirtualMachineOsImageNotification>>,
    pub patch_assessment_mode: Output<Option<String>>,
    pub patch_mode: Output<Option<String>>,
    pub plan: Output<Option<WindowsVirtualMachinePlan>>,
    pub platform_fault_domain: Output<Option<i32>>,
    pub priority: Output<Option<String>>,
    pub provision_vm_agent: Output<Option<bool>>,
    pub proximity_placement_group_id: Output<Option<String>>,
    pub reboot_setting: Output<Option<String>>,
    pub resource_group_name: Output<String>,
    pub secrets: Output<Option<Vec<WindowsVirtualMachineSecret>>>,
    pub secure_boot_enabled: Output<Option<bool>>,
    pub size: Output<String>,
    pub source_image_id: Output<Option<String>>,
    pub source_image_reference: Output<Option<WindowsVirtualMachineSourceImageReference>>,
    pub tags: Output<Option<HashMap<String, String>>>,
    pub termination_notification: Output<Option<WindowsVirtualMachineTerminationNotification>>,
    pub timezone: Output<Option<String>>,
    pub user_data: Output<Option<String>>,
    pub virtual_machine_scale_set_id: Output<Option<String>>,
    pub vm_agent_platform_updates_enabled: Output<Option<bool>>,
    pub vtpm_enabled: Output<Option<bool>>,
    pub winrm_listeners: Output<Option<Vec<WindowsVirtualMachineWinrmListener>>>,
    pub zone: Output<Option<String>>,
}

Fields

additional_capabilities: Output<Option<WindowsVirtualMachineAdditionalCapabilities>>

A additional_capabilities block as defined below.

additional_unattend_contents: Output<Option<Vec<WindowsVirtualMachineAdditionalUnattendContent>>>

One or more additional_unattend_content blocks as defined below. Changing this forces a new resource to be created.

admin_password: Output<String>

The Password which should be used for the local-administrator on this Virtual Machine. Changing this forces a new resource to be created.

admin_username: Output<String>

The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.

allow_extension_operations: Output<Option<bool>>

Should Extension Operations be allowed on this Virtual Machine? Defaults to true.

availability_set_id: Output<Option<String>>

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

boot_diagnostics: Output<Option<WindowsVirtualMachineBootDiagnostics>>

A boot_diagnostics block as defined below.

bypass_platform_safety_checks_on_user_schedule_enabled: Output<Option<bool>>

Specifies whether to skip platform scheduled patching when a user schedule is associated with the VM. Defaults to false.

NOTE: bypass_platform_safety_checks_on_user_schedule_enabled can only be set to true when patch_mode is set to AutomaticByPlatform.

capacity_reservation_group_id: Output<Option<String>>

Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.

NOTE: capacity_reservation_group_id cannot be used with availability_set_id or proximity_placement_group_id

computer_name: Output<Option<String>>

Specifies the Hostname which should be used for this Virtual Machine. If unspecified this defaults to the value for the name field. If the value of the name field is not a valid computer_name, then you must specify computer_name. Changing this forces a new resource to be created.

custom_data: Output<Option<String>>

The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.

dedicated_host_group_id: Output<Option<String>>

The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with dedicated_host_id.

dedicated_host_id: Output<Option<String>>

The ID of a Dedicated Host where this machine should be run on. Conflicts with dedicated_host_group_id.

disk_controller_type: Output<Option<String>>

Specifies the Disk Controller Type used for this Virtual Machine. Possible values are SCSI and NVMe.

edge_zone: Output<Option<String>>

Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine should exist. Changing this forces a new Windows Virtual Machine to be created.

enable_automatic_updates: Output<Option<bool>>

Specifies if Automatic Updates are Enabled for the Windows Virtual Machine. Changing this forces a new resource to be created. Defaults to true.

encryption_at_host_enabled: Output<Option<bool>>

Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?

eviction_policy: Output<Option<String>>

Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

NOTE: This can only be configured when priority is set to Spot.

extensions_time_budget: Output<Option<String>>

Specifies the duration allocated for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. Defaults to PT1H30M.

gallery_applications: Output<Option<Vec<WindowsVirtualMachineGalleryApplication>>>

One or more gallery_application blocks as defined below.

Note Gallery Application Assignments can be defined either directly on azure.compute.WindowsVirtualMachine resource, or using the azure.compute.GalleryApplicationAssignment resource - but the two approaches cannot be used together. If both are used with the same Virtual Machine, spurious changes will occur. If azure.compute.GalleryApplicationAssignment is used, it’s recommended to use ignore_changes for the gallery_application block on the corresponding azure.compute.WindowsVirtualMachine resource, to avoid a persistent diff when using this resource.

hotpatching_enabled: Output<Option<bool>>

Should the VM be patched without requiring a reboot? Possible values are true or false. Defaults to false. For more information about hot patching please see the product documentation.

NOTE: Hotpatching can only be enabled if the patch_mode is set to AutomaticByPlatform, the provision_vm_agent is set to true, your source_image_reference references a hotpatching enabled image, and the VM’s size is set to a Azure generation 2 VM. An example of how to correctly configure a Windows Virtual Machine to use the hotpatching_enabled field can be found in the ./examples/virtual-machines/windows/hotpatching-enabled directory within the GitHub Repository.

identity: Output<Option<WindowsVirtualMachineIdentity>>

An identity block as defined below.

license_type: Output<Option<String>>

Specifies the type of on-premise license (also known as Azure Hybrid Use Benefit) which should be used for this Virtual Machine. Possible values are None, Windows_Client and Windows_Server.

location: Output<Option<String>>

The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.

max_bid_price: Output<Option<f64>>

The maximum price you’re willing to pay for this Virtual Machine, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machine will be evicted using the eviction_policy. Defaults to -1, which means that the Virtual Machine should not be evicted for price reasons.

NOTE: This can only be configured when priority is set to Spot.

name: Output<Option<String>>

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

network_interface_ids: Output<Vec<String>>

. A list of Network Interface IDs which should be attached to this Virtual Machine. The first Network Interface ID in this list will be the Primary Network Interface on the Virtual Machine.

os_disk: Output<WindowsVirtualMachineOsDisk>

A os_disk block as defined below.

os_image_notification: Output<Option<WindowsVirtualMachineOsImageNotification>>

A os_image_notification block as defined below.

patch_assessment_mode: Output<Option<String>>

Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are AutomaticByPlatform or ImageDefault. Defaults to ImageDefault.

NOTE: If the patch_assessment_mode is set to AutomaticByPlatform then the provision_vm_agent field must be set to true.

patch_mode: Output<Option<String>>

Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are Manual, AutomaticByOS and AutomaticByPlatform. Defaults to AutomaticByOS. For more information on patch modes please see the product documentation.

NOTE: If patch_mode is set to AutomaticByPlatform then provision_vm_agent must also be set to true. If the Virtual Machine is using a hotpatching enabled image the patch_mode must always be set to AutomaticByPlatform.

plan: Output<Option<WindowsVirtualMachinePlan>>

A plan block as defined below. Changing this forces a new resource to be created.

platform_fault_domain: Output<Option<i32>>

Specifies the Platform Fault Domain in which this Windows Virtual Machine should be created. Defaults to -1, which means this will be automatically assigned to a fault domain that best maintains balance across the available fault domains. Changing this forces a new Windows Virtual Machine to be created.

priority: Output<Option<String>>

Specifies the priority of this Virtual Machine. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.

provision_vm_agent: Output<Option<bool>>

Should the Azure VM Agent be provisioned on this Virtual Machine? Defaults to true. Changing this forces a new resource to be created.

NOTE: If provision_vm_agent is set to false then allow_extension_operations must also be set to false.

proximity_placement_group_id: Output<Option<String>>

The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.

reboot_setting: Output<Option<String>>

Specifies the reboot setting for platform scheduled patching. Possible values are Always, IfRequired and Never.

NOTE: reboot_setting can only be set when patch_mode is set to AutomaticByPlatform.

resource_group_name: Output<String>

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

secrets: Output<Option<Vec<WindowsVirtualMachineSecret>>>

One or more secret blocks as defined below.

secure_boot_enabled: Output<Option<bool>>

Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.

size: Output<String>

The SKU which should be used for this Virtual Machine, such as Standard_F2.

source_image_id: Output<Option<String>>

The ID of the Image which this Virtual Machine should be created from. Changing this forces a new resource to be created. Possible Image ID types include Image IDs, Shared Image IDs, Shared Image Version IDs, Community Gallery Image IDs, Community Gallery Image Version IDs, Shared Gallery Image IDs and Shared Gallery Image Version IDs.

NOTE: One of either source_image_id or source_image_reference must be set.

source_image_reference: Output<Option<WindowsVirtualMachineSourceImageReference>>

A source_image_reference block as defined below. Changing this forces a new resource to be created.

NOTE: One of either source_image_id or source_image_reference must be set.

tags: Output<Option<HashMap<String, String>>>

A mapping of tags which should be assigned to this Virtual Machine.

termination_notification: Output<Option<WindowsVirtualMachineTerminationNotification>>

A termination_notification block as defined below.

timezone: Output<Option<String>>

Specifies the Time Zone which should be used by the Virtual Machine, the possible values are defined here. Changing this forces a new resource to be created.

user_data: Output<Option<String>>

The Base64-Encoded User Data which should be used for this Virtual Machine.

virtual_machine_scale_set_id: Output<Option<String>>

Specifies the Orchestrated Virtual Machine Scale Set that this Virtual Machine should be created within.

NOTE: To update virtual_machine_scale_set_id the Preview Feature Microsoft.Compute/SingleFDAttachDetachVMToVmss needs to be enabled, see the documentation for more information.

NOTE: Orchestrated Virtual Machine Scale Sets can be provisioned using the azure.compute.OrchestratedVirtualMachineScaleSet resource.

NOTE: To attach an existing VM to a Virtual Machine Scale Set, the scale set must have single_placement_group set to false, see the documentation for more information.

vm_agent_platform_updates_enabled: Output<Option<bool>>

Specifies whether VMAgent Platform Updates is enabled. Defaults to false.

vtpm_enabled: Output<Option<bool>>

Specifies if vTPM (virtual Trusted Platform Module) and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.

winrm_listeners: Output<Option<Vec<WindowsVirtualMachineWinrmListener>>>

One or more winrm_listener blocks as defined below. Changing this forces a new resource to be created.

zone: Output<Option<String>>

• zones - (Optional) Specifies the Availability Zone in which this Windows Virtual Machine should be located. Changing this forces a new Windows Virtual Machine to be created.

Implementations

impl WindowsVirtualMachineArgs

pub fn builder() -> WindowsVirtualMachineArgsBuilder

Create an instance of WindowsVirtualMachineArgs using the builder syntax

Trait Implementations

impl Clone for WindowsVirtualMachineArgs

fn clone(&self) -> WindowsVirtualMachineArgs

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.