We recommend using Azure Native.
azure.compute.WindowsVirtualMachine
Explore with Pulumi AI
Manages a Windows Virtual Machine.
Disclaimers
Note This provider will automatically remove the OS Disk by default - this behaviour can be configured using the
features
setting within the Provider block.
Note All arguments including the administrator login and password will be stored in the raw state as plain-text.
Note This resource does not support Unmanaged Disks. If you need to use Unmanaged Disks you can continue to use the
azure.compute.VirtualMachine
resource instead.
Note This resource does not support attaching existing OS Disks. You can instead capture an image of the OS Disk or continue to use the
azure.compute.VirtualMachine
resource instead.
In this release there’s a known issue where the
public_ip_address
andpublic_ip_addresses
fields may not be fully populated for Dynamic Public IP’s.
Example Usage
This example provisions a basic Windows Virtual Machine on an internal network.
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("example", {
name: "example-network",
addressSpaces: ["10.0.0.0/16"],
location: example.location,
resourceGroupName: example.name,
});
const exampleSubnet = new azure.network.Subnet("example", {
name: "internal",
resourceGroupName: example.name,
virtualNetworkName: exampleVirtualNetwork.name,
addressPrefixes: ["10.0.2.0/24"],
});
const exampleNetworkInterface = new azure.network.NetworkInterface("example", {
name: "example-nic",
location: example.location,
resourceGroupName: example.name,
ipConfigurations: [{
name: "internal",
subnetId: exampleSubnet.id,
privateIpAddressAllocation: "Dynamic",
}],
});
const exampleWindowsVirtualMachine = new azure.compute.WindowsVirtualMachine("example", {
name: "example-machine",
resourceGroupName: example.name,
location: example.location,
size: "Standard_F2",
adminUsername: "adminuser",
adminPassword: "P@$$w0rd1234!",
networkInterfaceIds: [exampleNetworkInterface.id],
osDisk: {
caching: "ReadWrite",
storageAccountType: "Standard_LRS",
},
sourceImageReference: {
publisher: "MicrosoftWindowsServer",
offer: "WindowsServer",
sku: "2016-Datacenter",
version: "latest",
},
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("example",
name="example-network",
address_spaces=["10.0.0.0/16"],
location=example.location,
resource_group_name=example.name)
example_subnet = azure.network.Subnet("example",
name="internal",
resource_group_name=example.name,
virtual_network_name=example_virtual_network.name,
address_prefixes=["10.0.2.0/24"])
example_network_interface = azure.network.NetworkInterface("example",
name="example-nic",
location=example.location,
resource_group_name=example.name,
ip_configurations=[azure.network.NetworkInterfaceIpConfigurationArgs(
name="internal",
subnet_id=example_subnet.id,
private_ip_address_allocation="Dynamic",
)])
example_windows_virtual_machine = azure.compute.WindowsVirtualMachine("example",
name="example-machine",
resource_group_name=example.name,
location=example.location,
size="Standard_F2",
admin_username="adminuser",
admin_password="P@$$w0rd1234!",
network_interface_ids=[example_network_interface.id],
os_disk=azure.compute.WindowsVirtualMachineOsDiskArgs(
caching="ReadWrite",
storage_account_type="Standard_LRS",
),
source_image_reference=azure.compute.WindowsVirtualMachineSourceImageReferenceArgs(
publisher="MicrosoftWindowsServer",
offer="WindowsServer",
sku="2016-Datacenter",
version="latest",
))
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/compute"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "example", &network.VirtualNetworkArgs{
Name: pulumi.String("example-network"),
AddressSpaces: pulumi.StringArray{
pulumi.String("10.0.0.0/16"),
},
Location: example.Location,
ResourceGroupName: example.Name,
})
if err != nil {
return err
}
exampleSubnet, err := network.NewSubnet(ctx, "example", &network.SubnetArgs{
Name: pulumi.String("internal"),
ResourceGroupName: example.Name,
VirtualNetworkName: exampleVirtualNetwork.Name,
AddressPrefixes: pulumi.StringArray{
pulumi.String("10.0.2.0/24"),
},
})
if err != nil {
return err
}
exampleNetworkInterface, err := network.NewNetworkInterface(ctx, "example", &network.NetworkInterfaceArgs{
Name: pulumi.String("example-nic"),
Location: example.Location,
ResourceGroupName: example.Name,
IpConfigurations: network.NetworkInterfaceIpConfigurationArray{
&network.NetworkInterfaceIpConfigurationArgs{
Name: pulumi.String("internal"),
SubnetId: exampleSubnet.ID(),
PrivateIpAddressAllocation: pulumi.String("Dynamic"),
},
},
})
if err != nil {
return err
}
_, err = compute.NewWindowsVirtualMachine(ctx, "example", &compute.WindowsVirtualMachineArgs{
Name: pulumi.String("example-machine"),
ResourceGroupName: example.Name,
Location: example.Location,
Size: pulumi.String("Standard_F2"),
AdminUsername: pulumi.String("adminuser"),
AdminPassword: pulumi.String("P@$$w0rd1234!"),
NetworkInterfaceIds: pulumi.StringArray{
exampleNetworkInterface.ID(),
},
OsDisk: &compute.WindowsVirtualMachineOsDiskArgs{
Caching: pulumi.String("ReadWrite"),
StorageAccountType: pulumi.String("Standard_LRS"),
},
SourceImageReference: &compute.WindowsVirtualMachineSourceImageReferenceArgs{
Publisher: pulumi.String("MicrosoftWindowsServer"),
Offer: pulumi.String("WindowsServer"),
Sku: pulumi.String("2016-Datacenter"),
Version: pulumi.String("latest"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("example", new()
{
Name = "example-network",
AddressSpaces = new[]
{
"10.0.0.0/16",
},
Location = example.Location,
ResourceGroupName = example.Name,
});
var exampleSubnet = new Azure.Network.Subnet("example", new()
{
Name = "internal",
ResourceGroupName = example.Name,
VirtualNetworkName = exampleVirtualNetwork.Name,
AddressPrefixes = new[]
{
"10.0.2.0/24",
},
});
var exampleNetworkInterface = new Azure.Network.NetworkInterface("example", new()
{
Name = "example-nic",
Location = example.Location,
ResourceGroupName = example.Name,
IpConfigurations = new[]
{
new Azure.Network.Inputs.NetworkInterfaceIpConfigurationArgs
{
Name = "internal",
SubnetId = exampleSubnet.Id,
PrivateIpAddressAllocation = "Dynamic",
},
},
});
var exampleWindowsVirtualMachine = new Azure.Compute.WindowsVirtualMachine("example", new()
{
Name = "example-machine",
ResourceGroupName = example.Name,
Location = example.Location,
Size = "Standard_F2",
AdminUsername = "adminuser",
AdminPassword = "P@$$w0rd1234!",
NetworkInterfaceIds = new[]
{
exampleNetworkInterface.Id,
},
OsDisk = new Azure.Compute.Inputs.WindowsVirtualMachineOsDiskArgs
{
Caching = "ReadWrite",
StorageAccountType = "Standard_LRS",
},
SourceImageReference = new Azure.Compute.Inputs.WindowsVirtualMachineSourceImageReferenceArgs
{
Publisher = "MicrosoftWindowsServer",
Offer = "WindowsServer",
Sku = "2016-Datacenter",
Version = "latest",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.Subnet;
import com.pulumi.azure.network.SubnetArgs;
import com.pulumi.azure.network.NetworkInterface;
import com.pulumi.azure.network.NetworkInterfaceArgs;
import com.pulumi.azure.network.inputs.NetworkInterfaceIpConfigurationArgs;
import com.pulumi.azure.compute.WindowsVirtualMachine;
import com.pulumi.azure.compute.WindowsVirtualMachineArgs;
import com.pulumi.azure.compute.inputs.WindowsVirtualMachineOsDiskArgs;
import com.pulumi.azure.compute.inputs.WindowsVirtualMachineSourceImageReferenceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
.name("example-network")
.addressSpaces("10.0.0.0/16")
.location(example.location())
.resourceGroupName(example.name())
.build());
var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
.name("internal")
.resourceGroupName(example.name())
.virtualNetworkName(exampleVirtualNetwork.name())
.addressPrefixes("10.0.2.0/24")
.build());
var exampleNetworkInterface = new NetworkInterface("exampleNetworkInterface", NetworkInterfaceArgs.builder()
.name("example-nic")
.location(example.location())
.resourceGroupName(example.name())
.ipConfigurations(NetworkInterfaceIpConfigurationArgs.builder()
.name("internal")
.subnetId(exampleSubnet.id())
.privateIpAddressAllocation("Dynamic")
.build())
.build());
var exampleWindowsVirtualMachine = new WindowsVirtualMachine("exampleWindowsVirtualMachine", WindowsVirtualMachineArgs.builder()
.name("example-machine")
.resourceGroupName(example.name())
.location(example.location())
.size("Standard_F2")
.adminUsername("adminuser")
.adminPassword("P@$$w0rd1234!")
.networkInterfaceIds(exampleNetworkInterface.id())
.osDisk(WindowsVirtualMachineOsDiskArgs.builder()
.caching("ReadWrite")
.storageAccountType("Standard_LRS")
.build())
.sourceImageReference(WindowsVirtualMachineSourceImageReferenceArgs.builder()
.publisher("MicrosoftWindowsServer")
.offer("WindowsServer")
.sku("2016-Datacenter")
.version("latest")
.build())
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleVirtualNetwork:
type: azure:network:VirtualNetwork
name: example
properties:
name: example-network
addressSpaces:
- 10.0.0.0/16
location: ${example.location}
resourceGroupName: ${example.name}
exampleSubnet:
type: azure:network:Subnet
name: example
properties:
name: internal
resourceGroupName: ${example.name}
virtualNetworkName: ${exampleVirtualNetwork.name}
addressPrefixes:
- 10.0.2.0/24
exampleNetworkInterface:
type: azure:network:NetworkInterface
name: example
properties:
name: example-nic
location: ${example.location}
resourceGroupName: ${example.name}
ipConfigurations:
- name: internal
subnetId: ${exampleSubnet.id}
privateIpAddressAllocation: Dynamic
exampleWindowsVirtualMachine:
type: azure:compute:WindowsVirtualMachine
name: example
properties:
name: example-machine
resourceGroupName: ${example.name}
location: ${example.location}
size: Standard_F2
adminUsername: adminuser
adminPassword: P@$$w0rd1234!
networkInterfaceIds:
- ${exampleNetworkInterface.id}
osDisk:
caching: ReadWrite
storageAccountType: Standard_LRS
sourceImageReference:
publisher: MicrosoftWindowsServer
offer: WindowsServer
sku: 2016-Datacenter
version: latest
Create WindowsVirtualMachine Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new WindowsVirtualMachine(name: string, args: WindowsVirtualMachineArgs, opts?: CustomResourceOptions);
@overload
def WindowsVirtualMachine(resource_name: str,
args: WindowsVirtualMachineArgs,
opts: Optional[ResourceOptions] = None)
@overload
def WindowsVirtualMachine(resource_name: str,
opts: Optional[ResourceOptions] = None,
network_interface_ids: Optional[Sequence[str]] = None,
size: Optional[str] = None,
admin_password: Optional[str] = None,
admin_username: Optional[str] = None,
resource_group_name: Optional[str] = None,
os_disk: Optional[WindowsVirtualMachineOsDiskArgs] = None,
disk_controller_type: Optional[str] = None,
patch_assessment_mode: Optional[str] = None,
capacity_reservation_group_id: Optional[str] = None,
computer_name: Optional[str] = None,
custom_data: Optional[str] = None,
dedicated_host_group_id: Optional[str] = None,
dedicated_host_id: Optional[str] = None,
additional_capabilities: Optional[WindowsVirtualMachineAdditionalCapabilitiesArgs] = None,
edge_zone: Optional[str] = None,
enable_automatic_updates: Optional[bool] = None,
encryption_at_host_enabled: Optional[bool] = None,
eviction_policy: Optional[str] = None,
extensions_time_budget: Optional[str] = None,
gallery_applications: Optional[Sequence[WindowsVirtualMachineGalleryApplicationArgs]] = None,
hotpatching_enabled: Optional[bool] = None,
identity: Optional[WindowsVirtualMachineIdentityArgs] = None,
license_type: Optional[str] = None,
location: Optional[str] = None,
max_bid_price: Optional[float] = None,
name: Optional[str] = None,
boot_diagnostics: Optional[WindowsVirtualMachineBootDiagnosticsArgs] = None,
availability_set_id: Optional[str] = None,
os_image_notification: Optional[WindowsVirtualMachineOsImageNotificationArgs] = None,
bypass_platform_safety_checks_on_user_schedule_enabled: Optional[bool] = None,
patch_mode: Optional[str] = None,
plan: Optional[WindowsVirtualMachinePlanArgs] = None,
platform_fault_domain: Optional[int] = None,
priority: Optional[str] = None,
provision_vm_agent: Optional[bool] = None,
proximity_placement_group_id: Optional[str] = None,
reboot_setting: Optional[str] = None,
allow_extension_operations: Optional[bool] = None,
secrets: Optional[Sequence[WindowsVirtualMachineSecretArgs]] = None,
secure_boot_enabled: Optional[bool] = None,
additional_unattend_contents: Optional[Sequence[WindowsVirtualMachineAdditionalUnattendContentArgs]] = None,
source_image_id: Optional[str] = None,
source_image_reference: Optional[WindowsVirtualMachineSourceImageReferenceArgs] = None,
tags: Optional[Mapping[str, str]] = None,
termination_notification: Optional[WindowsVirtualMachineTerminationNotificationArgs] = None,
timezone: Optional[str] = None,
user_data: Optional[str] = None,
virtual_machine_scale_set_id: Optional[str] = None,
vm_agent_platform_updates_enabled: Optional[bool] = None,
vtpm_enabled: Optional[bool] = None,
winrm_listeners: Optional[Sequence[WindowsVirtualMachineWinrmListenerArgs]] = None,
zone: Optional[str] = None)
func NewWindowsVirtualMachine(ctx *Context, name string, args WindowsVirtualMachineArgs, opts ...ResourceOption) (*WindowsVirtualMachine, error)
public WindowsVirtualMachine(string name, WindowsVirtualMachineArgs args, CustomResourceOptions? opts = null)
public WindowsVirtualMachine(String name, WindowsVirtualMachineArgs args)
public WindowsVirtualMachine(String name, WindowsVirtualMachineArgs args, CustomResourceOptions options)
type: azure:compute:WindowsVirtualMachine
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args WindowsVirtualMachineArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args WindowsVirtualMachineArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args WindowsVirtualMachineArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WindowsVirtualMachineArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WindowsVirtualMachineArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var windowsVirtualMachineResource = new Azure.Compute.WindowsVirtualMachine("windowsVirtualMachineResource", new()
{
NetworkInterfaceIds = new[]
{
"string",
},
Size = "string",
AdminPassword = "string",
AdminUsername = "string",
ResourceGroupName = "string",
OsDisk = new Azure.Compute.Inputs.WindowsVirtualMachineOsDiskArgs
{
Caching = "string",
StorageAccountType = "string",
DiffDiskSettings = new Azure.Compute.Inputs.WindowsVirtualMachineOsDiskDiffDiskSettingsArgs
{
Option = "string",
Placement = "string",
},
DiskEncryptionSetId = "string",
DiskSizeGb = 0,
Name = "string",
SecureVmDiskEncryptionSetId = "string",
SecurityEncryptionType = "string",
WriteAcceleratorEnabled = false,
},
DiskControllerType = "string",
PatchAssessmentMode = "string",
CapacityReservationGroupId = "string",
ComputerName = "string",
CustomData = "string",
DedicatedHostGroupId = "string",
DedicatedHostId = "string",
AdditionalCapabilities = new Azure.Compute.Inputs.WindowsVirtualMachineAdditionalCapabilitiesArgs
{
HibernationEnabled = false,
UltraSsdEnabled = false,
},
EdgeZone = "string",
EnableAutomaticUpdates = false,
EncryptionAtHostEnabled = false,
EvictionPolicy = "string",
ExtensionsTimeBudget = "string",
GalleryApplications = new[]
{
new Azure.Compute.Inputs.WindowsVirtualMachineGalleryApplicationArgs
{
VersionId = "string",
AutomaticUpgradeEnabled = false,
ConfigurationBlobUri = "string",
Order = 0,
Tag = "string",
TreatFailureAsDeploymentFailureEnabled = false,
},
},
HotpatchingEnabled = false,
Identity = new Azure.Compute.Inputs.WindowsVirtualMachineIdentityArgs
{
Type = "string",
IdentityIds = new[]
{
"string",
},
PrincipalId = "string",
TenantId = "string",
},
LicenseType = "string",
Location = "string",
MaxBidPrice = 0,
Name = "string",
BootDiagnostics = new Azure.Compute.Inputs.WindowsVirtualMachineBootDiagnosticsArgs
{
StorageAccountUri = "string",
},
AvailabilitySetId = "string",
OsImageNotification = new Azure.Compute.Inputs.WindowsVirtualMachineOsImageNotificationArgs
{
Timeout = "string",
},
BypassPlatformSafetyChecksOnUserScheduleEnabled = false,
PatchMode = "string",
Plan = new Azure.Compute.Inputs.WindowsVirtualMachinePlanArgs
{
Name = "string",
Product = "string",
Publisher = "string",
},
PlatformFaultDomain = 0,
Priority = "string",
ProvisionVmAgent = false,
ProximityPlacementGroupId = "string",
RebootSetting = "string",
AllowExtensionOperations = false,
Secrets = new[]
{
new Azure.Compute.Inputs.WindowsVirtualMachineSecretArgs
{
Certificates = new[]
{
new Azure.Compute.Inputs.WindowsVirtualMachineSecretCertificateArgs
{
Store = "string",
Url = "string",
},
},
KeyVaultId = "string",
},
},
SecureBootEnabled = false,
AdditionalUnattendContents = new[]
{
new Azure.Compute.Inputs.WindowsVirtualMachineAdditionalUnattendContentArgs
{
Content = "string",
Setting = "string",
},
},
SourceImageId = "string",
SourceImageReference = new Azure.Compute.Inputs.WindowsVirtualMachineSourceImageReferenceArgs
{
Offer = "string",
Publisher = "string",
Sku = "string",
Version = "string",
},
Tags =
{
{ "string", "string" },
},
TerminationNotification = new Azure.Compute.Inputs.WindowsVirtualMachineTerminationNotificationArgs
{
Enabled = false,
Timeout = "string",
},
Timezone = "string",
UserData = "string",
VirtualMachineScaleSetId = "string",
VmAgentPlatformUpdatesEnabled = false,
VtpmEnabled = false,
WinrmListeners = new[]
{
new Azure.Compute.Inputs.WindowsVirtualMachineWinrmListenerArgs
{
Protocol = "string",
CertificateUrl = "string",
},
},
Zone = "string",
});
example, err := compute.NewWindowsVirtualMachine(ctx, "windowsVirtualMachineResource", &compute.WindowsVirtualMachineArgs{
NetworkInterfaceIds: pulumi.StringArray{
pulumi.String("string"),
},
Size: pulumi.String("string"),
AdminPassword: pulumi.String("string"),
AdminUsername: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
OsDisk: &compute.WindowsVirtualMachineOsDiskArgs{
Caching: pulumi.String("string"),
StorageAccountType: pulumi.String("string"),
DiffDiskSettings: &compute.WindowsVirtualMachineOsDiskDiffDiskSettingsArgs{
Option: pulumi.String("string"),
Placement: pulumi.String("string"),
},
DiskEncryptionSetId: pulumi.String("string"),
DiskSizeGb: pulumi.Int(0),
Name: pulumi.String("string"),
SecureVmDiskEncryptionSetId: pulumi.String("string"),
SecurityEncryptionType: pulumi.String("string"),
WriteAcceleratorEnabled: pulumi.Bool(false),
},
DiskControllerType: pulumi.String("string"),
PatchAssessmentMode: pulumi.String("string"),
CapacityReservationGroupId: pulumi.String("string"),
ComputerName: pulumi.String("string"),
CustomData: pulumi.String("string"),
DedicatedHostGroupId: pulumi.String("string"),
DedicatedHostId: pulumi.String("string"),
AdditionalCapabilities: &compute.WindowsVirtualMachineAdditionalCapabilitiesArgs{
HibernationEnabled: pulumi.Bool(false),
UltraSsdEnabled: pulumi.Bool(false),
},
EdgeZone: pulumi.String("string"),
EnableAutomaticUpdates: pulumi.Bool(false),
EncryptionAtHostEnabled: pulumi.Bool(false),
EvictionPolicy: pulumi.String("string"),
ExtensionsTimeBudget: pulumi.String("string"),
GalleryApplications: compute.WindowsVirtualMachineGalleryApplicationArray{
&compute.WindowsVirtualMachineGalleryApplicationArgs{
VersionId: pulumi.String("string"),
AutomaticUpgradeEnabled: pulumi.Bool(false),
ConfigurationBlobUri: pulumi.String("string"),
Order: pulumi.Int(0),
Tag: pulumi.String("string"),
TreatFailureAsDeploymentFailureEnabled: pulumi.Bool(false),
},
},
HotpatchingEnabled: pulumi.Bool(false),
Identity: &compute.WindowsVirtualMachineIdentityArgs{
Type: pulumi.String("string"),
IdentityIds: pulumi.StringArray{
pulumi.String("string"),
},
PrincipalId: pulumi.String("string"),
TenantId: pulumi.String("string"),
},
LicenseType: pulumi.String("string"),
Location: pulumi.String("string"),
MaxBidPrice: pulumi.Float64(0),
Name: pulumi.String("string"),
BootDiagnostics: &compute.WindowsVirtualMachineBootDiagnosticsArgs{
StorageAccountUri: pulumi.String("string"),
},
AvailabilitySetId: pulumi.String("string"),
OsImageNotification: &compute.WindowsVirtualMachineOsImageNotificationArgs{
Timeout: pulumi.String("string"),
},
BypassPlatformSafetyChecksOnUserScheduleEnabled: pulumi.Bool(false),
PatchMode: pulumi.String("string"),
Plan: &compute.WindowsVirtualMachinePlanArgs{
Name: pulumi.String("string"),
Product: pulumi.String("string"),
Publisher: pulumi.String("string"),
},
PlatformFaultDomain: pulumi.Int(0),
Priority: pulumi.String("string"),
ProvisionVmAgent: pulumi.Bool(false),
ProximityPlacementGroupId: pulumi.String("string"),
RebootSetting: pulumi.String("string"),
AllowExtensionOperations: pulumi.Bool(false),
Secrets: compute.WindowsVirtualMachineSecretArray{
&compute.WindowsVirtualMachineSecretArgs{
Certificates: compute.WindowsVirtualMachineSecretCertificateArray{
&compute.WindowsVirtualMachineSecretCertificateArgs{
Store: pulumi.String("string"),
Url: pulumi.String("string"),
},
},
KeyVaultId: pulumi.String("string"),
},
},
SecureBootEnabled: pulumi.Bool(false),
AdditionalUnattendContents: compute.WindowsVirtualMachineAdditionalUnattendContentArray{
&compute.WindowsVirtualMachineAdditionalUnattendContentArgs{
Content: pulumi.String("string"),
Setting: pulumi.String("string"),
},
},
SourceImageId: pulumi.String("string"),
SourceImageReference: &compute.WindowsVirtualMachineSourceImageReferenceArgs{
Offer: pulumi.String("string"),
Publisher: pulumi.String("string"),
Sku: pulumi.String("string"),
Version: pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
TerminationNotification: &compute.WindowsVirtualMachineTerminationNotificationArgs{
Enabled: pulumi.Bool(false),
Timeout: pulumi.String("string"),
},
Timezone: pulumi.String("string"),
UserData: pulumi.String("string"),
VirtualMachineScaleSetId: pulumi.String("string"),
VmAgentPlatformUpdatesEnabled: pulumi.Bool(false),
VtpmEnabled: pulumi.Bool(false),
WinrmListeners: compute.WindowsVirtualMachineWinrmListenerArray{
&compute.WindowsVirtualMachineWinrmListenerArgs{
Protocol: pulumi.String("string"),
CertificateUrl: pulumi.String("string"),
},
},
Zone: pulumi.String("string"),
})
var windowsVirtualMachineResource = new WindowsVirtualMachine("windowsVirtualMachineResource", WindowsVirtualMachineArgs.builder()
.networkInterfaceIds("string")
.size("string")
.adminPassword("string")
.adminUsername("string")
.resourceGroupName("string")
.osDisk(WindowsVirtualMachineOsDiskArgs.builder()
.caching("string")
.storageAccountType("string")
.diffDiskSettings(WindowsVirtualMachineOsDiskDiffDiskSettingsArgs.builder()
.option("string")
.placement("string")
.build())
.diskEncryptionSetId("string")
.diskSizeGb(0)
.name("string")
.secureVmDiskEncryptionSetId("string")
.securityEncryptionType("string")
.writeAcceleratorEnabled(false)
.build())
.diskControllerType("string")
.patchAssessmentMode("string")
.capacityReservationGroupId("string")
.computerName("string")
.customData("string")
.dedicatedHostGroupId("string")
.dedicatedHostId("string")
.additionalCapabilities(WindowsVirtualMachineAdditionalCapabilitiesArgs.builder()
.hibernationEnabled(false)
.ultraSsdEnabled(false)
.build())
.edgeZone("string")
.enableAutomaticUpdates(false)
.encryptionAtHostEnabled(false)
.evictionPolicy("string")
.extensionsTimeBudget("string")
.galleryApplications(WindowsVirtualMachineGalleryApplicationArgs.builder()
.versionId("string")
.automaticUpgradeEnabled(false)
.configurationBlobUri("string")
.order(0)
.tag("string")
.treatFailureAsDeploymentFailureEnabled(false)
.build())
.hotpatchingEnabled(false)
.identity(WindowsVirtualMachineIdentityArgs.builder()
.type("string")
.identityIds("string")
.principalId("string")
.tenantId("string")
.build())
.licenseType("string")
.location("string")
.maxBidPrice(0)
.name("string")
.bootDiagnostics(WindowsVirtualMachineBootDiagnosticsArgs.builder()
.storageAccountUri("string")
.build())
.availabilitySetId("string")
.osImageNotification(WindowsVirtualMachineOsImageNotificationArgs.builder()
.timeout("string")
.build())
.bypassPlatformSafetyChecksOnUserScheduleEnabled(false)
.patchMode("string")
.plan(WindowsVirtualMachinePlanArgs.builder()
.name("string")
.product("string")
.publisher("string")
.build())
.platformFaultDomain(0)
.priority("string")
.provisionVmAgent(false)
.proximityPlacementGroupId("string")
.rebootSetting("string")
.allowExtensionOperations(false)
.secrets(WindowsVirtualMachineSecretArgs.builder()
.certificates(WindowsVirtualMachineSecretCertificateArgs.builder()
.store("string")
.url("string")
.build())
.keyVaultId("string")
.build())
.secureBootEnabled(false)
.additionalUnattendContents(WindowsVirtualMachineAdditionalUnattendContentArgs.builder()
.content("string")
.setting("string")
.build())
.sourceImageId("string")
.sourceImageReference(WindowsVirtualMachineSourceImageReferenceArgs.builder()
.offer("string")
.publisher("string")
.sku("string")
.version("string")
.build())
.tags(Map.of("string", "string"))
.terminationNotification(WindowsVirtualMachineTerminationNotificationArgs.builder()
.enabled(false)
.timeout("string")
.build())
.timezone("string")
.userData("string")
.virtualMachineScaleSetId("string")
.vmAgentPlatformUpdatesEnabled(false)
.vtpmEnabled(false)
.winrmListeners(WindowsVirtualMachineWinrmListenerArgs.builder()
.protocol("string")
.certificateUrl("string")
.build())
.zone("string")
.build());
windows_virtual_machine_resource = azure.compute.WindowsVirtualMachine("windowsVirtualMachineResource",
network_interface_ids=["string"],
size="string",
admin_password="string",
admin_username="string",
resource_group_name="string",
os_disk=azure.compute.WindowsVirtualMachineOsDiskArgs(
caching="string",
storage_account_type="string",
diff_disk_settings=azure.compute.WindowsVirtualMachineOsDiskDiffDiskSettingsArgs(
option="string",
placement="string",
),
disk_encryption_set_id="string",
disk_size_gb=0,
name="string",
secure_vm_disk_encryption_set_id="string",
security_encryption_type="string",
write_accelerator_enabled=False,
),
disk_controller_type="string",
patch_assessment_mode="string",
capacity_reservation_group_id="string",
computer_name="string",
custom_data="string",
dedicated_host_group_id="string",
dedicated_host_id="string",
additional_capabilities=azure.compute.WindowsVirtualMachineAdditionalCapabilitiesArgs(
hibernation_enabled=False,
ultra_ssd_enabled=False,
),
edge_zone="string",
enable_automatic_updates=False,
encryption_at_host_enabled=False,
eviction_policy="string",
extensions_time_budget="string",
gallery_applications=[azure.compute.WindowsVirtualMachineGalleryApplicationArgs(
version_id="string",
automatic_upgrade_enabled=False,
configuration_blob_uri="string",
order=0,
tag="string",
treat_failure_as_deployment_failure_enabled=False,
)],
hotpatching_enabled=False,
identity=azure.compute.WindowsVirtualMachineIdentityArgs(
type="string",
identity_ids=["string"],
principal_id="string",
tenant_id="string",
),
license_type="string",
location="string",
max_bid_price=0,
name="string",
boot_diagnostics=azure.compute.WindowsVirtualMachineBootDiagnosticsArgs(
storage_account_uri="string",
),
availability_set_id="string",
os_image_notification=azure.compute.WindowsVirtualMachineOsImageNotificationArgs(
timeout="string",
),
bypass_platform_safety_checks_on_user_schedule_enabled=False,
patch_mode="string",
plan=azure.compute.WindowsVirtualMachinePlanArgs(
name="string",
product="string",
publisher="string",
),
platform_fault_domain=0,
priority="string",
provision_vm_agent=False,
proximity_placement_group_id="string",
reboot_setting="string",
allow_extension_operations=False,
secrets=[azure.compute.WindowsVirtualMachineSecretArgs(
certificates=[azure.compute.WindowsVirtualMachineSecretCertificateArgs(
store="string",
url="string",
)],
key_vault_id="string",
)],
secure_boot_enabled=False,
additional_unattend_contents=[azure.compute.WindowsVirtualMachineAdditionalUnattendContentArgs(
content="string",
setting="string",
)],
source_image_id="string",
source_image_reference=azure.compute.WindowsVirtualMachineSourceImageReferenceArgs(
offer="string",
publisher="string",
sku="string",
version="string",
),
tags={
"string": "string",
},
termination_notification=azure.compute.WindowsVirtualMachineTerminationNotificationArgs(
enabled=False,
timeout="string",
),
timezone="string",
user_data="string",
virtual_machine_scale_set_id="string",
vm_agent_platform_updates_enabled=False,
vtpm_enabled=False,
winrm_listeners=[azure.compute.WindowsVirtualMachineWinrmListenerArgs(
protocol="string",
certificate_url="string",
)],
zone="string")
const windowsVirtualMachineResource = new azure.compute.WindowsVirtualMachine("windowsVirtualMachineResource", {
networkInterfaceIds: ["string"],
size: "string",
adminPassword: "string",
adminUsername: "string",
resourceGroupName: "string",
osDisk: {
caching: "string",
storageAccountType: "string",
diffDiskSettings: {
option: "string",
placement: "string",
},
diskEncryptionSetId: "string",
diskSizeGb: 0,
name: "string",
secureVmDiskEncryptionSetId: "string",
securityEncryptionType: "string",
writeAcceleratorEnabled: false,
},
diskControllerType: "string",
patchAssessmentMode: "string",
capacityReservationGroupId: "string",
computerName: "string",
customData: "string",
dedicatedHostGroupId: "string",
dedicatedHostId: "string",
additionalCapabilities: {
hibernationEnabled: false,
ultraSsdEnabled: false,
},
edgeZone: "string",
enableAutomaticUpdates: false,
encryptionAtHostEnabled: false,
evictionPolicy: "string",
extensionsTimeBudget: "string",
galleryApplications: [{
versionId: "string",
automaticUpgradeEnabled: false,
configurationBlobUri: "string",
order: 0,
tag: "string",
treatFailureAsDeploymentFailureEnabled: false,
}],
hotpatchingEnabled: false,
identity: {
type: "string",
identityIds: ["string"],
principalId: "string",
tenantId: "string",
},
licenseType: "string",
location: "string",
maxBidPrice: 0,
name: "string",
bootDiagnostics: {
storageAccountUri: "string",
},
availabilitySetId: "string",
osImageNotification: {
timeout: "string",
},
bypassPlatformSafetyChecksOnUserScheduleEnabled: false,
patchMode: "string",
plan: {
name: "string",
product: "string",
publisher: "string",
},
platformFaultDomain: 0,
priority: "string",
provisionVmAgent: false,
proximityPlacementGroupId: "string",
rebootSetting: "string",
allowExtensionOperations: false,
secrets: [{
certificates: [{
store: "string",
url: "string",
}],
keyVaultId: "string",
}],
secureBootEnabled: false,
additionalUnattendContents: [{
content: "string",
setting: "string",
}],
sourceImageId: "string",
sourceImageReference: {
offer: "string",
publisher: "string",
sku: "string",
version: "string",
},
tags: {
string: "string",
},
terminationNotification: {
enabled: false,
timeout: "string",
},
timezone: "string",
userData: "string",
virtualMachineScaleSetId: "string",
vmAgentPlatformUpdatesEnabled: false,
vtpmEnabled: false,
winrmListeners: [{
protocol: "string",
certificateUrl: "string",
}],
zone: "string",
});
type: azure:compute:WindowsVirtualMachine
properties:
additionalCapabilities:
hibernationEnabled: false
ultraSsdEnabled: false
additionalUnattendContents:
- content: string
setting: string
adminPassword: string
adminUsername: string
allowExtensionOperations: false
availabilitySetId: string
bootDiagnostics:
storageAccountUri: string
bypassPlatformSafetyChecksOnUserScheduleEnabled: false
capacityReservationGroupId: string
computerName: string
customData: string
dedicatedHostGroupId: string
dedicatedHostId: string
diskControllerType: string
edgeZone: string
enableAutomaticUpdates: false
encryptionAtHostEnabled: false
evictionPolicy: string
extensionsTimeBudget: string
galleryApplications:
- automaticUpgradeEnabled: false
configurationBlobUri: string
order: 0
tag: string
treatFailureAsDeploymentFailureEnabled: false
versionId: string
hotpatchingEnabled: false
identity:
identityIds:
- string
principalId: string
tenantId: string
type: string
licenseType: string
location: string
maxBidPrice: 0
name: string
networkInterfaceIds:
- string
osDisk:
caching: string
diffDiskSettings:
option: string
placement: string
diskEncryptionSetId: string
diskSizeGb: 0
name: string
secureVmDiskEncryptionSetId: string
securityEncryptionType: string
storageAccountType: string
writeAcceleratorEnabled: false
osImageNotification:
timeout: string
patchAssessmentMode: string
patchMode: string
plan:
name: string
product: string
publisher: string
platformFaultDomain: 0
priority: string
provisionVmAgent: false
proximityPlacementGroupId: string
rebootSetting: string
resourceGroupName: string
secrets:
- certificates:
- store: string
url: string
keyVaultId: string
secureBootEnabled: false
size: string
sourceImageId: string
sourceImageReference:
offer: string
publisher: string
sku: string
version: string
tags:
string: string
terminationNotification:
enabled: false
timeout: string
timezone: string
userData: string
virtualMachineScaleSetId: string
vmAgentPlatformUpdatesEnabled: false
vtpmEnabled: false
winrmListeners:
- certificateUrl: string
protocol: string
zone: string
WindowsVirtualMachine Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The WindowsVirtualMachine resource accepts the following input properties:
- Admin
Password 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 string - The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- Network
Interface List<string>Ids - . 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 WindowsVirtual Machine Os Disk - A
os_disk
block as defined below. - Resource
Group stringName - The name of the Resource Group in which the Windows Virtual Machine should be exist. Changing this forces a new resource to be created.
- Size string
- The SKU which should be used for this Virtual Machine, such as
Standard_F2
. - Additional
Capabilities WindowsVirtual Machine Additional Capabilities - A
additional_capabilities
block as defined below. - Additional
Unattend List<WindowsContents Virtual Machine Additional Unattend Content> - One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created. - Allow
Extension boolOperations - Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
. - Availability
Set stringId - 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 WindowsVirtual Machine Boot Diagnostics - A
boot_diagnostics
block as defined below. - Bypass
Platform boolSafety Checks On User Schedule Enabled 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 totrue
whenpatch_mode
is set toAutomaticByPlatform
.- Capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
NOTE:
capacity_reservation_group_id
cannot be used withavailability_set_id
orproximity_placement_group_id
- Computer
Name 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created. - Custom
Data 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 stringGroup Id - The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
. - Dedicated
Host stringId - The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
. - Disk
Controller stringType - Specifies the Disk Controller Type used for this Virtual Machine. Possible values are
SCSI
andNVMe
. - Edge
Zone 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 boolUpdates - 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 boolHost Enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- Eviction
Policy string Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.NOTE: This can only be configured when
priority
is set toSpot
.- Extensions
Time stringBudget - 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 List<WindowsVirtual Machine Gallery Application> 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 theazure.compute.GalleryApplicationAssignment
resource - but the two approaches cannot be used together. If both are used with the same Virtual Machine, spurious changes will occur. Ifazure.compute.GalleryApplicationAssignment
is used, it's recommended to useignore_changes
for thegallery_application
block on the correspondingazure.compute.WindowsVirtualMachine
resource, to avoid a persistent diff when using this resource.- Hotpatching
Enabled bool Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.NOTE: Hotpatching can only be enabled if the
patch_mode
is set toAutomaticByPlatform
, theprovision_vm_agent
is set totrue
, yoursource_image_reference
references a hotpatching enabled image, and the VM'ssize
is set to a Azure generation 2 directory within the GitHub Repository.- Identity
Windows
Virtual Machine Identity - An
identity
block as defined below. - License
Type 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
andWindows_Server
. - Location string
- The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- Max
Bid doublePrice 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 toSpot
.- Name string
- The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- Os
Image WindowsNotification Virtual Machine Os Image Notification - A
os_image_notification
block as defined below. - Patch
Assessment stringMode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.NOTE: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- Patch
Mode string Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.NOTE: If
patch_mode
is set toAutomaticByPlatform
thenprovision_vm_agent
must also be set totrue
. If the Virtual Machine is using a hotpatching enabled image thepatch_mode
must always be set toAutomaticByPlatform
.- Plan
Windows
Virtual Machine Plan - A
plan
block as defined below. Changing this forces a new resource to be created. - Platform
Fault intDomain - 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 string
- Specifies the priority of this Virtual Machine. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created. - Provision
Vm boolAgent 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 tofalse
thenallow_extension_operations
must also be set tofalse
.- Proximity
Placement stringGroup Id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- Reboot
Setting string Specifies the reboot setting for platform scheduled patching. Possible values are
Always
,IfRequired
andNever
.NOTE:
reboot_setting
can only be set whenpatch_mode
is set toAutomaticByPlatform
.- Secrets
List<Windows
Virtual Machine Secret> - One or more
secret
blocks as defined below. - Secure
Boot boolEnabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- Source
Image stringId 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- Source
Image WindowsReference Virtual Machine Source Image Reference A
source_image_reference
block as defined below. Changing this forces a new resource to be created.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- Dictionary<string, string>
- A mapping of tags which should be assigned to this Virtual Machine.
- Termination
Notification WindowsVirtual Machine Termination Notification - A
termination_notification
block as defined below. - Timezone 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 string - The Base64-Encoded User Data which should be used for this Virtual Machine.
- Virtual
Machine stringScale Set Id 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 FeatureMicrosoft.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 tofalse
, see the documentation for more information.- Vm
Agent boolPlatform Updates Enabled - Specifies whether VMAgent Platform Updates is enabled. Defaults to
false
. - Vtpm
Enabled 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 List<WindowsVirtual Machine Winrm Listener> - One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created. - Zone 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.
- Admin
Password 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 string - The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- Network
Interface []stringIds - . 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 WindowsVirtual Machine Os Disk Args - A
os_disk
block as defined below. - Resource
Group stringName - The name of the Resource Group in which the Windows Virtual Machine should be exist. Changing this forces a new resource to be created.
- Size string
- The SKU which should be used for this Virtual Machine, such as
Standard_F2
. - Additional
Capabilities WindowsVirtual Machine Additional Capabilities Args - A
additional_capabilities
block as defined below. - Additional
Unattend []WindowsContents Virtual Machine Additional Unattend Content Args - One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created. - Allow
Extension boolOperations - Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
. - Availability
Set stringId - 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 WindowsVirtual Machine Boot Diagnostics Args - A
boot_diagnostics
block as defined below. - Bypass
Platform boolSafety Checks On User Schedule Enabled 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 totrue
whenpatch_mode
is set toAutomaticByPlatform
.- Capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
NOTE:
capacity_reservation_group_id
cannot be used withavailability_set_id
orproximity_placement_group_id
- Computer
Name 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created. - Custom
Data 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 stringGroup Id - The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
. - Dedicated
Host stringId - The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
. - Disk
Controller stringType - Specifies the Disk Controller Type used for this Virtual Machine. Possible values are
SCSI
andNVMe
. - Edge
Zone 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 boolUpdates - 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 boolHost Enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- Eviction
Policy string Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.NOTE: This can only be configured when
priority
is set toSpot
.- Extensions
Time stringBudget - 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 []WindowsVirtual Machine Gallery Application Args 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 theazure.compute.GalleryApplicationAssignment
resource - but the two approaches cannot be used together. If both are used with the same Virtual Machine, spurious changes will occur. Ifazure.compute.GalleryApplicationAssignment
is used, it's recommended to useignore_changes
for thegallery_application
block on the correspondingazure.compute.WindowsVirtualMachine
resource, to avoid a persistent diff when using this resource.- Hotpatching
Enabled bool Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.NOTE: Hotpatching can only be enabled if the
patch_mode
is set toAutomaticByPlatform
, theprovision_vm_agent
is set totrue
, yoursource_image_reference
references a hotpatching enabled image, and the VM'ssize
is set to a Azure generation 2 directory within the GitHub Repository.- Identity
Windows
Virtual Machine Identity Args - An
identity
block as defined below. - License
Type 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
andWindows_Server
. - Location string
- The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- Max
Bid float64Price 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 toSpot
.- Name string
- The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- Os
Image WindowsNotification Virtual Machine Os Image Notification Args - A
os_image_notification
block as defined below. - Patch
Assessment stringMode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.NOTE: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- Patch
Mode string Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.NOTE: If
patch_mode
is set toAutomaticByPlatform
thenprovision_vm_agent
must also be set totrue
. If the Virtual Machine is using a hotpatching enabled image thepatch_mode
must always be set toAutomaticByPlatform
.- Plan
Windows
Virtual Machine Plan Args - A
plan
block as defined below. Changing this forces a new resource to be created. - Platform
Fault intDomain - 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 string
- Specifies the priority of this Virtual Machine. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created. - Provision
Vm boolAgent 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 tofalse
thenallow_extension_operations
must also be set tofalse
.- Proximity
Placement stringGroup Id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- Reboot
Setting string Specifies the reboot setting for platform scheduled patching. Possible values are
Always
,IfRequired
andNever
.NOTE:
reboot_setting
can only be set whenpatch_mode
is set toAutomaticByPlatform
.- Secrets
[]Windows
Virtual Machine Secret Args - One or more
secret
blocks as defined below. - Secure
Boot boolEnabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- Source
Image stringId 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- Source
Image WindowsReference Virtual Machine Source Image Reference Args A
source_image_reference
block as defined below. Changing this forces a new resource to be created.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- map[string]string
- A mapping of tags which should be assigned to this Virtual Machine.
- Termination
Notification WindowsVirtual Machine Termination Notification Args - A
termination_notification
block as defined below. - Timezone 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 string - The Base64-Encoded User Data which should be used for this Virtual Machine.
- Virtual
Machine stringScale Set Id 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 FeatureMicrosoft.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 tofalse
, see the documentation for more information.- Vm
Agent boolPlatform Updates Enabled - Specifies whether VMAgent Platform Updates is enabled. Defaults to
false
. - Vtpm
Enabled 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 []WindowsVirtual Machine Winrm Listener Args - One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created. - Zone 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.
- admin
Password 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 String - The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- network
Interface List<String>Ids - . 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 WindowsVirtual Machine Os Disk - A
os_disk
block as defined below. - resource
Group StringName - The name of the Resource Group in which the Windows Virtual Machine should be exist. Changing this forces a new resource to be created.
- size String
- The SKU which should be used for this Virtual Machine, such as
Standard_F2
. - additional
Capabilities WindowsVirtual Machine Additional Capabilities - A
additional_capabilities
block as defined below. - additional
Unattend List<WindowsContents Virtual Machine Additional Unattend Content> - One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created. - allow
Extension BooleanOperations - Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
. - availability
Set StringId - 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 WindowsVirtual Machine Boot Diagnostics - A
boot_diagnostics
block as defined below. - bypass
Platform BooleanSafety Checks On User Schedule Enabled 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 totrue
whenpatch_mode
is set toAutomaticByPlatform
.- capacity
Reservation StringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
NOTE:
capacity_reservation_group_id
cannot be used withavailability_set_id
orproximity_placement_group_id
- computer
Name 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created. - custom
Data 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 StringGroup Id - The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
. - dedicated
Host StringId - The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
. - disk
Controller StringType - Specifies the Disk Controller Type used for this Virtual Machine. Possible values are
SCSI
andNVMe
. - edge
Zone 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 BooleanUpdates - 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 BooleanHost Enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction
Policy String Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.NOTE: This can only be configured when
priority
is set toSpot
.- extensions
Time StringBudget - 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 List<WindowsVirtual Machine Gallery Application> 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 theazure.compute.GalleryApplicationAssignment
resource - but the two approaches cannot be used together. If both are used with the same Virtual Machine, spurious changes will occur. Ifazure.compute.GalleryApplicationAssignment
is used, it's recommended to useignore_changes
for thegallery_application
block on the correspondingazure.compute.WindowsVirtualMachine
resource, to avoid a persistent diff when using this resource.- hotpatching
Enabled Boolean Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.NOTE: Hotpatching can only be enabled if the
patch_mode
is set toAutomaticByPlatform
, theprovision_vm_agent
is set totrue
, yoursource_image_reference
references a hotpatching enabled image, and the VM'ssize
is set to a Azure generation 2 directory within the GitHub Repository.- identity
Windows
Virtual Machine Identity - An
identity
block as defined below. - license
Type 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
andWindows_Server
. - location String
- The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- max
Bid DoublePrice 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 toSpot
.- name String
- The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- os
Image WindowsNotification Virtual Machine Os Image Notification - A
os_image_notification
block as defined below. - patch
Assessment StringMode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.NOTE: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- patch
Mode String Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.NOTE: If
patch_mode
is set toAutomaticByPlatform
thenprovision_vm_agent
must also be set totrue
. If the Virtual Machine is using a hotpatching enabled image thepatch_mode
must always be set toAutomaticByPlatform
.- plan
Windows
Virtual Machine Plan - A
plan
block as defined below. Changing this forces a new resource to be created. - platform
Fault IntegerDomain - 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 String
- Specifies the priority of this Virtual Machine. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created. - provision
Vm BooleanAgent 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 tofalse
thenallow_extension_operations
must also be set tofalse
.- proximity
Placement StringGroup Id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- reboot
Setting String Specifies the reboot setting for platform scheduled patching. Possible values are
Always
,IfRequired
andNever
.NOTE:
reboot_setting
can only be set whenpatch_mode
is set toAutomaticByPlatform
.- secrets
List<Windows
Virtual Machine Secret> - One or more
secret
blocks as defined below. - secure
Boot BooleanEnabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- source
Image StringId 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- source
Image WindowsReference Virtual Machine Source Image Reference A
source_image_reference
block as defined below. Changing this forces a new resource to be created.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- Map<String,String>
- A mapping of tags which should be assigned to this Virtual Machine.
- termination
Notification WindowsVirtual Machine Termination Notification - A
termination_notification
block as defined below. - timezone 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 String - The Base64-Encoded User Data which should be used for this Virtual Machine.
- virtual
Machine StringScale Set Id 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 FeatureMicrosoft.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 tofalse
, see the documentation for more information.- vm
Agent BooleanPlatform Updates Enabled - Specifies whether VMAgent Platform Updates is enabled. Defaults to
false
. - vtpm
Enabled Boolean - 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 List<WindowsVirtual Machine Winrm Listener> - One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created. - zone 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.
- admin
Password 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 string - The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- network
Interface string[]Ids - . 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 WindowsVirtual Machine Os Disk - A
os_disk
block as defined below. - resource
Group stringName - The name of the Resource Group in which the Windows Virtual Machine should be exist. Changing this forces a new resource to be created.
- size string
- The SKU which should be used for this Virtual Machine, such as
Standard_F2
. - additional
Capabilities WindowsVirtual Machine Additional Capabilities - A
additional_capabilities
block as defined below. - additional
Unattend WindowsContents Virtual Machine Additional Unattend Content[] - One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created. - allow
Extension booleanOperations - Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
. - availability
Set stringId - 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 WindowsVirtual Machine Boot Diagnostics - A
boot_diagnostics
block as defined below. - bypass
Platform booleanSafety Checks On User Schedule Enabled 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 totrue
whenpatch_mode
is set toAutomaticByPlatform
.- capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
NOTE:
capacity_reservation_group_id
cannot be used withavailability_set_id
orproximity_placement_group_id
- computer
Name 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created. - custom
Data 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 stringGroup Id - The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
. - dedicated
Host stringId - The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
. - disk
Controller stringType - Specifies the Disk Controller Type used for this Virtual Machine. Possible values are
SCSI
andNVMe
. - edge
Zone 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 booleanUpdates - 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 booleanHost Enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction
Policy string Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.NOTE: This can only be configured when
priority
is set toSpot
.- extensions
Time stringBudget - 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 WindowsVirtual Machine Gallery Application[] 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 theazure.compute.GalleryApplicationAssignment
resource - but the two approaches cannot be used together. If both are used with the same Virtual Machine, spurious changes will occur. Ifazure.compute.GalleryApplicationAssignment
is used, it's recommended to useignore_changes
for thegallery_application
block on the correspondingazure.compute.WindowsVirtualMachine
resource, to avoid a persistent diff when using this resource.- hotpatching
Enabled boolean Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.NOTE: Hotpatching can only be enabled if the
patch_mode
is set toAutomaticByPlatform
, theprovision_vm_agent
is set totrue
, yoursource_image_reference
references a hotpatching enabled image, and the VM'ssize
is set to a Azure generation 2 directory within the GitHub Repository.- identity
Windows
Virtual Machine Identity - An
identity
block as defined below. - license
Type 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
andWindows_Server
. - location string
- The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- max
Bid numberPrice 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 toSpot
.- name string
- The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- os
Image WindowsNotification Virtual Machine Os Image Notification - A
os_image_notification
block as defined below. - patch
Assessment stringMode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.NOTE: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- patch
Mode string Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.NOTE: If
patch_mode
is set toAutomaticByPlatform
thenprovision_vm_agent
must also be set totrue
. If the Virtual Machine is using a hotpatching enabled image thepatch_mode
must always be set toAutomaticByPlatform
.- plan
Windows
Virtual Machine Plan - A
plan
block as defined below. Changing this forces a new resource to be created. - platform
Fault numberDomain - 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 string
- Specifies the priority of this Virtual Machine. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created. - provision
Vm booleanAgent 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 tofalse
thenallow_extension_operations
must also be set tofalse
.- proximity
Placement stringGroup Id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- reboot
Setting string Specifies the reboot setting for platform scheduled patching. Possible values are
Always
,IfRequired
andNever
.NOTE:
reboot_setting
can only be set whenpatch_mode
is set toAutomaticByPlatform
.- secrets
Windows
Virtual Machine Secret[] - One or more
secret
blocks as defined below. - secure
Boot booleanEnabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- source
Image stringId 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- source
Image WindowsReference Virtual Machine Source Image Reference A
source_image_reference
block as defined below. Changing this forces a new resource to be created.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- {[key: string]: string}
- A mapping of tags which should be assigned to this Virtual Machine.
- termination
Notification WindowsVirtual Machine Termination Notification - A
termination_notification
block as defined below. - timezone 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 string - The Base64-Encoded User Data which should be used for this Virtual Machine.
- virtual
Machine stringScale Set Id 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 FeatureMicrosoft.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 tofalse
, see the documentation for more information.- vm
Agent booleanPlatform Updates Enabled - Specifies whether VMAgent Platform Updates is enabled. Defaults to
false
. - vtpm
Enabled boolean - 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 WindowsVirtual Machine Winrm Listener[] - One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created. - zone 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.
- admin_
password str - 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 str - The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- network_
interface_ Sequence[str]ids - . 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 WindowsVirtual Machine Os Disk Args - A
os_disk
block as defined below. - resource_
group_ strname - The name of the Resource Group in which the Windows Virtual Machine should be exist. Changing this forces a new resource to be created.
- size str
- The SKU which should be used for this Virtual Machine, such as
Standard_F2
. - additional_
capabilities WindowsVirtual Machine Additional Capabilities Args - A
additional_capabilities
block as defined below. - additional_
unattend_ Sequence[Windowscontents Virtual Machine Additional Unattend Content Args] - One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created. - allow_
extension_ booloperations - Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
. - availability_
set_ strid - 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 WindowsVirtual Machine Boot Diagnostics Args - A
boot_diagnostics
block as defined below. - bypass_
platform_ boolsafety_ checks_ on_ user_ schedule_ enabled 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 totrue
whenpatch_mode
is set toAutomaticByPlatform
.- capacity_
reservation_ strgroup_ id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
NOTE:
capacity_reservation_group_id
cannot be used withavailability_set_id
orproximity_placement_group_id
- computer_
name str - 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created. - custom_
data str - The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
- dedicated_
host_ strgroup_ id - The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
. - dedicated_
host_ strid - The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
. - disk_
controller_ strtype - Specifies the Disk Controller Type used for this Virtual Machine. Possible values are
SCSI
andNVMe
. - edge_
zone str - 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_ boolupdates - 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_ boolhost_ enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction_
policy str Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.NOTE: This can only be configured when
priority
is set toSpot
.- extensions_
time_ strbudget - 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 Sequence[WindowsVirtual Machine Gallery Application Args] 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 theazure.compute.GalleryApplicationAssignment
resource - but the two approaches cannot be used together. If both are used with the same Virtual Machine, spurious changes will occur. Ifazure.compute.GalleryApplicationAssignment
is used, it's recommended to useignore_changes
for thegallery_application
block on the correspondingazure.compute.WindowsVirtualMachine
resource, to avoid a persistent diff when using this resource.- hotpatching_
enabled bool Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.NOTE: Hotpatching can only be enabled if the
patch_mode
is set toAutomaticByPlatform
, theprovision_vm_agent
is set totrue
, yoursource_image_reference
references a hotpatching enabled image, and the VM'ssize
is set to a Azure generation 2 directory within the GitHub Repository.- identity
Windows
Virtual Machine Identity Args - An
identity
block as defined below. - license_
type str - 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
andWindows_Server
. - location str
- The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- max_
bid_ floatprice 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 toSpot
.- name str
- The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- os_
image_ Windowsnotification Virtual Machine Os Image Notification Args - A
os_image_notification
block as defined below. - patch_
assessment_ strmode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.NOTE: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- patch_
mode str Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.NOTE: If
patch_mode
is set toAutomaticByPlatform
thenprovision_vm_agent
must also be set totrue
. If the Virtual Machine is using a hotpatching enabled image thepatch_mode
must always be set toAutomaticByPlatform
.- plan
Windows
Virtual Machine Plan Args - A
plan
block as defined below. Changing this forces a new resource to be created. - platform_
fault_ intdomain - 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 str
- Specifies the priority of this Virtual Machine. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created. - provision_
vm_ boolagent 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 tofalse
thenallow_extension_operations
must also be set tofalse
.- proximity_
placement_ strgroup_ id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- reboot_
setting str Specifies the reboot setting for platform scheduled patching. Possible values are
Always
,IfRequired
andNever
.NOTE:
reboot_setting
can only be set whenpatch_mode
is set toAutomaticByPlatform
.- secrets
Sequence[Windows
Virtual Machine Secret Args] - One or more
secret
blocks as defined below. - secure_
boot_ boolenabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- source_
image_ strid 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- source_
image_ Windowsreference Virtual Machine Source Image Reference Args A
source_image_reference
block as defined below. Changing this forces a new resource to be created.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- Mapping[str, str]
- A mapping of tags which should be assigned to this Virtual Machine.
- termination_
notification WindowsVirtual Machine Termination Notification Args - A
termination_notification
block as defined below. - timezone str
- 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 str - The Base64-Encoded User Data which should be used for this Virtual Machine.
- virtual_
machine_ strscale_ set_ id 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 FeatureMicrosoft.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 tofalse
, see the documentation for more information.- vm_
agent_ boolplatform_ updates_ enabled - Specifies whether VMAgent Platform Updates is enabled. Defaults to
false
. - vtpm_
enabled 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 Sequence[WindowsVirtual Machine Winrm Listener Args] - One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created. - zone str
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.
- admin
Password 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 String - The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- network
Interface List<String>Ids - . 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 Property Map - A
os_disk
block as defined below. - resource
Group StringName - The name of the Resource Group in which the Windows Virtual Machine should be exist. Changing this forces a new resource to be created.
- size String
- The SKU which should be used for this Virtual Machine, such as
Standard_F2
. - additional
Capabilities Property Map - A
additional_capabilities
block as defined below. - additional
Unattend List<Property Map>Contents - One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created. - allow
Extension BooleanOperations - Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
. - availability
Set StringId - 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 Property Map - A
boot_diagnostics
block as defined below. - bypass
Platform BooleanSafety Checks On User Schedule Enabled 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 totrue
whenpatch_mode
is set toAutomaticByPlatform
.- capacity
Reservation StringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
NOTE:
capacity_reservation_group_id
cannot be used withavailability_set_id
orproximity_placement_group_id
- computer
Name 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created. - custom
Data 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 StringGroup Id - The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
. - dedicated
Host StringId - The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
. - disk
Controller StringType - Specifies the Disk Controller Type used for this Virtual Machine. Possible values are
SCSI
andNVMe
. - edge
Zone 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 BooleanUpdates - 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 BooleanHost Enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction
Policy String Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.NOTE: This can only be configured when
priority
is set toSpot
.- extensions
Time StringBudget - 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 List<Property Map> 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 theazure.compute.GalleryApplicationAssignment
resource - but the two approaches cannot be used together. If both are used with the same Virtual Machine, spurious changes will occur. Ifazure.compute.GalleryApplicationAssignment
is used, it's recommended to useignore_changes
for thegallery_application
block on the correspondingazure.compute.WindowsVirtualMachine
resource, to avoid a persistent diff when using this resource.- hotpatching
Enabled Boolean Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.NOTE: Hotpatching can only be enabled if the
patch_mode
is set toAutomaticByPlatform
, theprovision_vm_agent
is set totrue
, yoursource_image_reference
references a hotpatching enabled image, and the VM'ssize
is set to a Azure generation 2 directory within the GitHub Repository.- identity Property Map
- An
identity
block as defined below. - license
Type 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
andWindows_Server
. - location String
- The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- max
Bid NumberPrice 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 toSpot
.- name String
- The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- os
Image Property MapNotification - A
os_image_notification
block as defined below. - patch
Assessment StringMode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.NOTE: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- patch
Mode String Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.NOTE: If
patch_mode
is set toAutomaticByPlatform
thenprovision_vm_agent
must also be set totrue
. If the Virtual Machine is using a hotpatching enabled image thepatch_mode
must always be set toAutomaticByPlatform
.- plan Property Map
- A
plan
block as defined below. Changing this forces a new resource to be created. - platform
Fault NumberDomain - 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 String
- Specifies the priority of this Virtual Machine. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created. - provision
Vm BooleanAgent 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 tofalse
thenallow_extension_operations
must also be set tofalse
.- proximity
Placement StringGroup Id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- reboot
Setting String Specifies the reboot setting for platform scheduled patching. Possible values are
Always
,IfRequired
andNever
.NOTE:
reboot_setting
can only be set whenpatch_mode
is set toAutomaticByPlatform
.- secrets List<Property Map>
- One or more
secret
blocks as defined below. - secure
Boot BooleanEnabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- source
Image StringId 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- source
Image Property MapReference A
source_image_reference
block as defined below. Changing this forces a new resource to be created.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- Map<String>
- A mapping of tags which should be assigned to this Virtual Machine.
- termination
Notification Property Map - A
termination_notification
block as defined below. - timezone 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 String - The Base64-Encoded User Data which should be used for this Virtual Machine.
- virtual
Machine StringScale Set Id 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 FeatureMicrosoft.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 tofalse
, see the documentation for more information.- vm
Agent BooleanPlatform Updates Enabled - Specifies whether VMAgent Platform Updates is enabled. Defaults to
false
. - vtpm
Enabled Boolean - 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 List<Property Map> - One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created. - zone 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the WindowsVirtualMachine resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Private
Ip stringAddress - The Primary Private IP Address assigned to this Virtual Machine.
- Private
Ip List<string>Addresses - A list of Private IP Addresses assigned to this Virtual Machine.
- Public
Ip stringAddress - The Primary Public IP Address assigned to this Virtual Machine.
- Public
Ip List<string>Addresses - A list of the Public IP Addresses assigned to this Virtual Machine.
- Virtual
Machine stringId - A 128-bit identifier which uniquely identifies this Virtual Machine.
- Id string
- The provider-assigned unique ID for this managed resource.
- Private
Ip stringAddress - The Primary Private IP Address assigned to this Virtual Machine.
- Private
Ip []stringAddresses - A list of Private IP Addresses assigned to this Virtual Machine.
- Public
Ip stringAddress - The Primary Public IP Address assigned to this Virtual Machine.
- Public
Ip []stringAddresses - A list of the Public IP Addresses assigned to this Virtual Machine.
- Virtual
Machine stringId - A 128-bit identifier which uniquely identifies this Virtual Machine.
- id String
- The provider-assigned unique ID for this managed resource.
- private
Ip StringAddress - The Primary Private IP Address assigned to this Virtual Machine.
- private
Ip List<String>Addresses - A list of Private IP Addresses assigned to this Virtual Machine.
- public
Ip StringAddress - The Primary Public IP Address assigned to this Virtual Machine.
- public
Ip List<String>Addresses - A list of the Public IP Addresses assigned to this Virtual Machine.
- virtual
Machine StringId - A 128-bit identifier which uniquely identifies this Virtual Machine.
- id string
- The provider-assigned unique ID for this managed resource.
- private
Ip stringAddress - The Primary Private IP Address assigned to this Virtual Machine.
- private
Ip string[]Addresses - A list of Private IP Addresses assigned to this Virtual Machine.
- public
Ip stringAddress - The Primary Public IP Address assigned to this Virtual Machine.
- public
Ip string[]Addresses - A list of the Public IP Addresses assigned to this Virtual Machine.
- virtual
Machine stringId - A 128-bit identifier which uniquely identifies this Virtual Machine.
- id str
- The provider-assigned unique ID for this managed resource.
- private_
ip_ straddress - The Primary Private IP Address assigned to this Virtual Machine.
- private_
ip_ Sequence[str]addresses - A list of Private IP Addresses assigned to this Virtual Machine.
- public_
ip_ straddress - The Primary Public IP Address assigned to this Virtual Machine.
- public_
ip_ Sequence[str]addresses - A list of the Public IP Addresses assigned to this Virtual Machine.
- virtual_
machine_ strid - A 128-bit identifier which uniquely identifies this Virtual Machine.
- id String
- The provider-assigned unique ID for this managed resource.
- private
Ip StringAddress - The Primary Private IP Address assigned to this Virtual Machine.
- private
Ip List<String>Addresses - A list of Private IP Addresses assigned to this Virtual Machine.
- public
Ip StringAddress - The Primary Public IP Address assigned to this Virtual Machine.
- public
Ip List<String>Addresses - A list of the Public IP Addresses assigned to this Virtual Machine.
- virtual
Machine StringId - A 128-bit identifier which uniquely identifies this Virtual Machine.
Look up Existing WindowsVirtualMachine Resource
Get an existing WindowsVirtualMachine 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?: WindowsVirtualMachineState, opts?: CustomResourceOptions): WindowsVirtualMachine
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
additional_capabilities: Optional[WindowsVirtualMachineAdditionalCapabilitiesArgs] = None,
additional_unattend_contents: Optional[Sequence[WindowsVirtualMachineAdditionalUnattendContentArgs]] = None,
admin_password: Optional[str] = None,
admin_username: Optional[str] = None,
allow_extension_operations: Optional[bool] = None,
availability_set_id: Optional[str] = None,
boot_diagnostics: Optional[WindowsVirtualMachineBootDiagnosticsArgs] = None,
bypass_platform_safety_checks_on_user_schedule_enabled: Optional[bool] = None,
capacity_reservation_group_id: Optional[str] = None,
computer_name: Optional[str] = None,
custom_data: Optional[str] = None,
dedicated_host_group_id: Optional[str] = None,
dedicated_host_id: Optional[str] = None,
disk_controller_type: Optional[str] = None,
edge_zone: Optional[str] = None,
enable_automatic_updates: Optional[bool] = None,
encryption_at_host_enabled: Optional[bool] = None,
eviction_policy: Optional[str] = None,
extensions_time_budget: Optional[str] = None,
gallery_applications: Optional[Sequence[WindowsVirtualMachineGalleryApplicationArgs]] = None,
hotpatching_enabled: Optional[bool] = None,
identity: Optional[WindowsVirtualMachineIdentityArgs] = None,
license_type: Optional[str] = None,
location: Optional[str] = None,
max_bid_price: Optional[float] = None,
name: Optional[str] = None,
network_interface_ids: Optional[Sequence[str]] = None,
os_disk: Optional[WindowsVirtualMachineOsDiskArgs] = None,
os_image_notification: Optional[WindowsVirtualMachineOsImageNotificationArgs] = None,
patch_assessment_mode: Optional[str] = None,
patch_mode: Optional[str] = None,
plan: Optional[WindowsVirtualMachinePlanArgs] = None,
platform_fault_domain: Optional[int] = None,
priority: Optional[str] = None,
private_ip_address: Optional[str] = None,
private_ip_addresses: Optional[Sequence[str]] = None,
provision_vm_agent: Optional[bool] = None,
proximity_placement_group_id: Optional[str] = None,
public_ip_address: Optional[str] = None,
public_ip_addresses: Optional[Sequence[str]] = None,
reboot_setting: Optional[str] = None,
resource_group_name: Optional[str] = None,
secrets: Optional[Sequence[WindowsVirtualMachineSecretArgs]] = None,
secure_boot_enabled: Optional[bool] = None,
size: Optional[str] = None,
source_image_id: Optional[str] = None,
source_image_reference: Optional[WindowsVirtualMachineSourceImageReferenceArgs] = None,
tags: Optional[Mapping[str, str]] = None,
termination_notification: Optional[WindowsVirtualMachineTerminationNotificationArgs] = None,
timezone: Optional[str] = None,
user_data: Optional[str] = None,
virtual_machine_id: Optional[str] = None,
virtual_machine_scale_set_id: Optional[str] = None,
vm_agent_platform_updates_enabled: Optional[bool] = None,
vtpm_enabled: Optional[bool] = None,
winrm_listeners: Optional[Sequence[WindowsVirtualMachineWinrmListenerArgs]] = None,
zone: Optional[str] = None) -> WindowsVirtualMachine
func GetWindowsVirtualMachine(ctx *Context, name string, id IDInput, state *WindowsVirtualMachineState, opts ...ResourceOption) (*WindowsVirtualMachine, error)
public static WindowsVirtualMachine Get(string name, Input<string> id, WindowsVirtualMachineState? state, CustomResourceOptions? opts = null)
public static WindowsVirtualMachine get(String name, Output<String> id, WindowsVirtualMachineState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- 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.
- Additional
Capabilities WindowsVirtual Machine Additional Capabilities - A
additional_capabilities
block as defined below. - Additional
Unattend List<WindowsContents Virtual Machine Additional Unattend Content> - One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created. - Admin
Password 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 string - The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- Allow
Extension boolOperations - Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
. - Availability
Set stringId - 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 WindowsVirtual Machine Boot Diagnostics - A
boot_diagnostics
block as defined below. - Bypass
Platform boolSafety Checks On User Schedule Enabled 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 totrue
whenpatch_mode
is set toAutomaticByPlatform
.- Capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
NOTE:
capacity_reservation_group_id
cannot be used withavailability_set_id
orproximity_placement_group_id
- Computer
Name 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created. - Custom
Data 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 stringGroup Id - The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
. - Dedicated
Host stringId - The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
. - Disk
Controller stringType - Specifies the Disk Controller Type used for this Virtual Machine. Possible values are
SCSI
andNVMe
. - Edge
Zone 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 boolUpdates - 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 boolHost Enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- Eviction
Policy string Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.NOTE: This can only be configured when
priority
is set toSpot
.- Extensions
Time stringBudget - 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 List<WindowsVirtual Machine Gallery Application> 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 theazure.compute.GalleryApplicationAssignment
resource - but the two approaches cannot be used together. If both are used with the same Virtual Machine, spurious changes will occur. Ifazure.compute.GalleryApplicationAssignment
is used, it's recommended to useignore_changes
for thegallery_application
block on the correspondingazure.compute.WindowsVirtualMachine
resource, to avoid a persistent diff when using this resource.- Hotpatching
Enabled bool Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.NOTE: Hotpatching can only be enabled if the
patch_mode
is set toAutomaticByPlatform
, theprovision_vm_agent
is set totrue
, yoursource_image_reference
references a hotpatching enabled image, and the VM'ssize
is set to a Azure generation 2 directory within the GitHub Repository.- Identity
Windows
Virtual Machine Identity - An
identity
block as defined below. - License
Type 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
andWindows_Server
. - Location string
- The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- Max
Bid doublePrice 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 toSpot
.- Name string
- The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- Network
Interface List<string>Ids - . 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 WindowsVirtual Machine Os Disk - A
os_disk
block as defined below. - Os
Image WindowsNotification Virtual Machine Os Image Notification - A
os_image_notification
block as defined below. - Patch
Assessment stringMode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.NOTE: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- Patch
Mode string Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.NOTE: If
patch_mode
is set toAutomaticByPlatform
thenprovision_vm_agent
must also be set totrue
. If the Virtual Machine is using a hotpatching enabled image thepatch_mode
must always be set toAutomaticByPlatform
.- Plan
Windows
Virtual Machine Plan - A
plan
block as defined below. Changing this forces a new resource to be created. - Platform
Fault intDomain - 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 string
- Specifies the priority of this Virtual Machine. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created. - Private
Ip stringAddress - The Primary Private IP Address assigned to this Virtual Machine.
- Private
Ip List<string>Addresses - A list of Private IP Addresses assigned to this Virtual Machine.
- Provision
Vm boolAgent 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 tofalse
thenallow_extension_operations
must also be set tofalse
.- Proximity
Placement stringGroup Id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- Public
Ip stringAddress - The Primary Public IP Address assigned to this Virtual Machine.
- Public
Ip List<string>Addresses - A list of the Public IP Addresses assigned to this Virtual Machine.
- Reboot
Setting string Specifies the reboot setting for platform scheduled patching. Possible values are
Always
,IfRequired
andNever
.NOTE:
reboot_setting
can only be set whenpatch_mode
is set toAutomaticByPlatform
.- Resource
Group stringName - 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
List<Windows
Virtual Machine Secret> - One or more
secret
blocks as defined below. - Secure
Boot boolEnabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- Size string
- The SKU which should be used for this Virtual Machine, such as
Standard_F2
. - Source
Image stringId 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- Source
Image WindowsReference Virtual Machine Source Image Reference A
source_image_reference
block as defined below. Changing this forces a new resource to be created.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- Dictionary<string, string>
- A mapping of tags which should be assigned to this Virtual Machine.
- Termination
Notification WindowsVirtual Machine Termination Notification - A
termination_notification
block as defined below. - Timezone 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 string - The Base64-Encoded User Data which should be used for this Virtual Machine.
- Virtual
Machine stringId - A 128-bit identifier which uniquely identifies this Virtual Machine.
- Virtual
Machine stringScale Set Id 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 FeatureMicrosoft.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 tofalse
, see the documentation for more information.- Vm
Agent boolPlatform Updates Enabled - Specifies whether VMAgent Platform Updates is enabled. Defaults to
false
. - Vtpm
Enabled 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 List<WindowsVirtual Machine Winrm Listener> - One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created. - Zone 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.
- Additional
Capabilities WindowsVirtual Machine Additional Capabilities Args - A
additional_capabilities
block as defined below. - Additional
Unattend []WindowsContents Virtual Machine Additional Unattend Content Args - One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created. - Admin
Password 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 string - The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- Allow
Extension boolOperations - Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
. - Availability
Set stringId - 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 WindowsVirtual Machine Boot Diagnostics Args - A
boot_diagnostics
block as defined below. - Bypass
Platform boolSafety Checks On User Schedule Enabled 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 totrue
whenpatch_mode
is set toAutomaticByPlatform
.- Capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
NOTE:
capacity_reservation_group_id
cannot be used withavailability_set_id
orproximity_placement_group_id
- Computer
Name 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created. - Custom
Data 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 stringGroup Id - The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
. - Dedicated
Host stringId - The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
. - Disk
Controller stringType - Specifies the Disk Controller Type used for this Virtual Machine. Possible values are
SCSI
andNVMe
. - Edge
Zone 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 boolUpdates - 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 boolHost Enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- Eviction
Policy string Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.NOTE: This can only be configured when
priority
is set toSpot
.- Extensions
Time stringBudget - 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 []WindowsVirtual Machine Gallery Application Args 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 theazure.compute.GalleryApplicationAssignment
resource - but the two approaches cannot be used together. If both are used with the same Virtual Machine, spurious changes will occur. Ifazure.compute.GalleryApplicationAssignment
is used, it's recommended to useignore_changes
for thegallery_application
block on the correspondingazure.compute.WindowsVirtualMachine
resource, to avoid a persistent diff when using this resource.- Hotpatching
Enabled bool Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.NOTE: Hotpatching can only be enabled if the
patch_mode
is set toAutomaticByPlatform
, theprovision_vm_agent
is set totrue
, yoursource_image_reference
references a hotpatching enabled image, and the VM'ssize
is set to a Azure generation 2 directory within the GitHub Repository.- Identity
Windows
Virtual Machine Identity Args - An
identity
block as defined below. - License
Type 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
andWindows_Server
. - Location string
- The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- Max
Bid float64Price 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 toSpot
.- Name string
- The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- Network
Interface []stringIds - . 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 WindowsVirtual Machine Os Disk Args - A
os_disk
block as defined below. - Os
Image WindowsNotification Virtual Machine Os Image Notification Args - A
os_image_notification
block as defined below. - Patch
Assessment stringMode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.NOTE: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- Patch
Mode string Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.NOTE: If
patch_mode
is set toAutomaticByPlatform
thenprovision_vm_agent
must also be set totrue
. If the Virtual Machine is using a hotpatching enabled image thepatch_mode
must always be set toAutomaticByPlatform
.- Plan
Windows
Virtual Machine Plan Args - A
plan
block as defined below. Changing this forces a new resource to be created. - Platform
Fault intDomain - 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 string
- Specifies the priority of this Virtual Machine. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created. - Private
Ip stringAddress - The Primary Private IP Address assigned to this Virtual Machine.
- Private
Ip []stringAddresses - A list of Private IP Addresses assigned to this Virtual Machine.
- Provision
Vm boolAgent 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 tofalse
thenallow_extension_operations
must also be set tofalse
.- Proximity
Placement stringGroup Id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- Public
Ip stringAddress - The Primary Public IP Address assigned to this Virtual Machine.
- Public
Ip []stringAddresses - A list of the Public IP Addresses assigned to this Virtual Machine.
- Reboot
Setting string Specifies the reboot setting for platform scheduled patching. Possible values are
Always
,IfRequired
andNever
.NOTE:
reboot_setting
can only be set whenpatch_mode
is set toAutomaticByPlatform
.- Resource
Group stringName - 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
[]Windows
Virtual Machine Secret Args - One or more
secret
blocks as defined below. - Secure
Boot boolEnabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- Size string
- The SKU which should be used for this Virtual Machine, such as
Standard_F2
. - Source
Image stringId 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- Source
Image WindowsReference Virtual Machine Source Image Reference Args A
source_image_reference
block as defined below. Changing this forces a new resource to be created.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- map[string]string
- A mapping of tags which should be assigned to this Virtual Machine.
- Termination
Notification WindowsVirtual Machine Termination Notification Args - A
termination_notification
block as defined below. - Timezone 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 string - The Base64-Encoded User Data which should be used for this Virtual Machine.
- Virtual
Machine stringId - A 128-bit identifier which uniquely identifies this Virtual Machine.
- Virtual
Machine stringScale Set Id 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 FeatureMicrosoft.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 tofalse
, see the documentation for more information.- Vm
Agent boolPlatform Updates Enabled - Specifies whether VMAgent Platform Updates is enabled. Defaults to
false
. - Vtpm
Enabled 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 []WindowsVirtual Machine Winrm Listener Args - One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created. - Zone 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.
- additional
Capabilities WindowsVirtual Machine Additional Capabilities - A
additional_capabilities
block as defined below. - additional
Unattend List<WindowsContents Virtual Machine Additional Unattend Content> - One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created. - admin
Password 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 String - The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- allow
Extension BooleanOperations - Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
. - availability
Set StringId - 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 WindowsVirtual Machine Boot Diagnostics - A
boot_diagnostics
block as defined below. - bypass
Platform BooleanSafety Checks On User Schedule Enabled 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 totrue
whenpatch_mode
is set toAutomaticByPlatform
.- capacity
Reservation StringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
NOTE:
capacity_reservation_group_id
cannot be used withavailability_set_id
orproximity_placement_group_id
- computer
Name 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created. - custom
Data 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 StringGroup Id - The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
. - dedicated
Host StringId - The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
. - disk
Controller StringType - Specifies the Disk Controller Type used for this Virtual Machine. Possible values are
SCSI
andNVMe
. - edge
Zone 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 BooleanUpdates - 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 BooleanHost Enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction
Policy String Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.NOTE: This can only be configured when
priority
is set toSpot
.- extensions
Time StringBudget - 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 List<WindowsVirtual Machine Gallery Application> 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 theazure.compute.GalleryApplicationAssignment
resource - but the two approaches cannot be used together. If both are used with the same Virtual Machine, spurious changes will occur. Ifazure.compute.GalleryApplicationAssignment
is used, it's recommended to useignore_changes
for thegallery_application
block on the correspondingazure.compute.WindowsVirtualMachine
resource, to avoid a persistent diff when using this resource.- hotpatching
Enabled Boolean Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.NOTE: Hotpatching can only be enabled if the
patch_mode
is set toAutomaticByPlatform
, theprovision_vm_agent
is set totrue
, yoursource_image_reference
references a hotpatching enabled image, and the VM'ssize
is set to a Azure generation 2 directory within the GitHub Repository.- identity
Windows
Virtual Machine Identity - An
identity
block as defined below. - license
Type 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
andWindows_Server
. - location String
- The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- max
Bid DoublePrice 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 toSpot
.- name String
- The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- network
Interface List<String>Ids - . 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 WindowsVirtual Machine Os Disk - A
os_disk
block as defined below. - os
Image WindowsNotification Virtual Machine Os Image Notification - A
os_image_notification
block as defined below. - patch
Assessment StringMode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.NOTE: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- patch
Mode String Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.NOTE: If
patch_mode
is set toAutomaticByPlatform
thenprovision_vm_agent
must also be set totrue
. If the Virtual Machine is using a hotpatching enabled image thepatch_mode
must always be set toAutomaticByPlatform
.- plan
Windows
Virtual Machine Plan - A
plan
block as defined below. Changing this forces a new resource to be created. - platform
Fault IntegerDomain - 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 String
- Specifies the priority of this Virtual Machine. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created. - private
Ip StringAddress - The Primary Private IP Address assigned to this Virtual Machine.
- private
Ip List<String>Addresses - A list of Private IP Addresses assigned to this Virtual Machine.
- provision
Vm BooleanAgent 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 tofalse
thenallow_extension_operations
must also be set tofalse
.- proximity
Placement StringGroup Id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- public
Ip StringAddress - The Primary Public IP Address assigned to this Virtual Machine.
- public
Ip List<String>Addresses - A list of the Public IP Addresses assigned to this Virtual Machine.
- reboot
Setting String Specifies the reboot setting for platform scheduled patching. Possible values are
Always
,IfRequired
andNever
.NOTE:
reboot_setting
can only be set whenpatch_mode
is set toAutomaticByPlatform
.- resource
Group StringName - 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
List<Windows
Virtual Machine Secret> - One or more
secret
blocks as defined below. - secure
Boot BooleanEnabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- size String
- The SKU which should be used for this Virtual Machine, such as
Standard_F2
. - source
Image StringId 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- source
Image WindowsReference Virtual Machine Source Image Reference A
source_image_reference
block as defined below. Changing this forces a new resource to be created.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- Map<String,String>
- A mapping of tags which should be assigned to this Virtual Machine.
- termination
Notification WindowsVirtual Machine Termination Notification - A
termination_notification
block as defined below. - timezone 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 String - The Base64-Encoded User Data which should be used for this Virtual Machine.
- virtual
Machine StringId - A 128-bit identifier which uniquely identifies this Virtual Machine.
- virtual
Machine StringScale Set Id 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 FeatureMicrosoft.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 tofalse
, see the documentation for more information.- vm
Agent BooleanPlatform Updates Enabled - Specifies whether VMAgent Platform Updates is enabled. Defaults to
false
. - vtpm
Enabled Boolean - 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 List<WindowsVirtual Machine Winrm Listener> - One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created. - zone 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.
- additional
Capabilities WindowsVirtual Machine Additional Capabilities - A
additional_capabilities
block as defined below. - additional
Unattend WindowsContents Virtual Machine Additional Unattend Content[] - One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created. - admin
Password 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 string - The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- allow
Extension booleanOperations - Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
. - availability
Set stringId - 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 WindowsVirtual Machine Boot Diagnostics - A
boot_diagnostics
block as defined below. - bypass
Platform booleanSafety Checks On User Schedule Enabled 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 totrue
whenpatch_mode
is set toAutomaticByPlatform
.- capacity
Reservation stringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
NOTE:
capacity_reservation_group_id
cannot be used withavailability_set_id
orproximity_placement_group_id
- computer
Name 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created. - custom
Data 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 stringGroup Id - The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
. - dedicated
Host stringId - The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
. - disk
Controller stringType - Specifies the Disk Controller Type used for this Virtual Machine. Possible values are
SCSI
andNVMe
. - edge
Zone 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 booleanUpdates - 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 booleanHost Enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction
Policy string Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.NOTE: This can only be configured when
priority
is set toSpot
.- extensions
Time stringBudget - 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 WindowsVirtual Machine Gallery Application[] 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 theazure.compute.GalleryApplicationAssignment
resource - but the two approaches cannot be used together. If both are used with the same Virtual Machine, spurious changes will occur. Ifazure.compute.GalleryApplicationAssignment
is used, it's recommended to useignore_changes
for thegallery_application
block on the correspondingazure.compute.WindowsVirtualMachine
resource, to avoid a persistent diff when using this resource.- hotpatching
Enabled boolean Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.NOTE: Hotpatching can only be enabled if the
patch_mode
is set toAutomaticByPlatform
, theprovision_vm_agent
is set totrue
, yoursource_image_reference
references a hotpatching enabled image, and the VM'ssize
is set to a Azure generation 2 directory within the GitHub Repository.- identity
Windows
Virtual Machine Identity - An
identity
block as defined below. - license
Type 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
andWindows_Server
. - location string
- The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- max
Bid numberPrice 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 toSpot
.- name string
- The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- network
Interface string[]Ids - . 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 WindowsVirtual Machine Os Disk - A
os_disk
block as defined below. - os
Image WindowsNotification Virtual Machine Os Image Notification - A
os_image_notification
block as defined below. - patch
Assessment stringMode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.NOTE: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- patch
Mode string Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.NOTE: If
patch_mode
is set toAutomaticByPlatform
thenprovision_vm_agent
must also be set totrue
. If the Virtual Machine is using a hotpatching enabled image thepatch_mode
must always be set toAutomaticByPlatform
.- plan
Windows
Virtual Machine Plan - A
plan
block as defined below. Changing this forces a new resource to be created. - platform
Fault numberDomain - 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 string
- Specifies the priority of this Virtual Machine. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created. - private
Ip stringAddress - The Primary Private IP Address assigned to this Virtual Machine.
- private
Ip string[]Addresses - A list of Private IP Addresses assigned to this Virtual Machine.
- provision
Vm booleanAgent 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 tofalse
thenallow_extension_operations
must also be set tofalse
.- proximity
Placement stringGroup Id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- public
Ip stringAddress - The Primary Public IP Address assigned to this Virtual Machine.
- public
Ip string[]Addresses - A list of the Public IP Addresses assigned to this Virtual Machine.
- reboot
Setting string Specifies the reboot setting for platform scheduled patching. Possible values are
Always
,IfRequired
andNever
.NOTE:
reboot_setting
can only be set whenpatch_mode
is set toAutomaticByPlatform
.- resource
Group stringName - 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
Windows
Virtual Machine Secret[] - One or more
secret
blocks as defined below. - secure
Boot booleanEnabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- size string
- The SKU which should be used for this Virtual Machine, such as
Standard_F2
. - source
Image stringId 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- source
Image WindowsReference Virtual Machine Source Image Reference A
source_image_reference
block as defined below. Changing this forces a new resource to be created.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- {[key: string]: string}
- A mapping of tags which should be assigned to this Virtual Machine.
- termination
Notification WindowsVirtual Machine Termination Notification - A
termination_notification
block as defined below. - timezone 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 string - The Base64-Encoded User Data which should be used for this Virtual Machine.
- virtual
Machine stringId - A 128-bit identifier which uniquely identifies this Virtual Machine.
- virtual
Machine stringScale Set Id 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 FeatureMicrosoft.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 tofalse
, see the documentation for more information.- vm
Agent booleanPlatform Updates Enabled - Specifies whether VMAgent Platform Updates is enabled. Defaults to
false
. - vtpm
Enabled boolean - 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 WindowsVirtual Machine Winrm Listener[] - One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created. - zone 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.
- additional_
capabilities WindowsVirtual Machine Additional Capabilities Args - A
additional_capabilities
block as defined below. - additional_
unattend_ Sequence[Windowscontents Virtual Machine Additional Unattend Content Args] - One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created. - admin_
password str - 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 str - The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- allow_
extension_ booloperations - Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
. - availability_
set_ strid - 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 WindowsVirtual Machine Boot Diagnostics Args - A
boot_diagnostics
block as defined below. - bypass_
platform_ boolsafety_ checks_ on_ user_ schedule_ enabled 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 totrue
whenpatch_mode
is set toAutomaticByPlatform
.- capacity_
reservation_ strgroup_ id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
NOTE:
capacity_reservation_group_id
cannot be used withavailability_set_id
orproximity_placement_group_id
- computer_
name str - 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created. - custom_
data str - The Base64-Encoded Custom Data which should be used for this Virtual Machine. Changing this forces a new resource to be created.
- dedicated_
host_ strgroup_ id - The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
. - dedicated_
host_ strid - The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
. - disk_
controller_ strtype - Specifies the Disk Controller Type used for this Virtual Machine. Possible values are
SCSI
andNVMe
. - edge_
zone str - 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_ boolupdates - 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_ boolhost_ enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction_
policy str Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.NOTE: This can only be configured when
priority
is set toSpot
.- extensions_
time_ strbudget - 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 Sequence[WindowsVirtual Machine Gallery Application Args] 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 theazure.compute.GalleryApplicationAssignment
resource - but the two approaches cannot be used together. If both are used with the same Virtual Machine, spurious changes will occur. Ifazure.compute.GalleryApplicationAssignment
is used, it's recommended to useignore_changes
for thegallery_application
block on the correspondingazure.compute.WindowsVirtualMachine
resource, to avoid a persistent diff when using this resource.- hotpatching_
enabled bool Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.NOTE: Hotpatching can only be enabled if the
patch_mode
is set toAutomaticByPlatform
, theprovision_vm_agent
is set totrue
, yoursource_image_reference
references a hotpatching enabled image, and the VM'ssize
is set to a Azure generation 2 directory within the GitHub Repository.- identity
Windows
Virtual Machine Identity Args - An
identity
block as defined below. - license_
type str - 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
andWindows_Server
. - location str
- The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- max_
bid_ floatprice 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 toSpot
.- name str
- The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- network_
interface_ Sequence[str]ids - . 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 WindowsVirtual Machine Os Disk Args - A
os_disk
block as defined below. - os_
image_ Windowsnotification Virtual Machine Os Image Notification Args - A
os_image_notification
block as defined below. - patch_
assessment_ strmode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.NOTE: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- patch_
mode str Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.NOTE: If
patch_mode
is set toAutomaticByPlatform
thenprovision_vm_agent
must also be set totrue
. If the Virtual Machine is using a hotpatching enabled image thepatch_mode
must always be set toAutomaticByPlatform
.- plan
Windows
Virtual Machine Plan Args - A
plan
block as defined below. Changing this forces a new resource to be created. - platform_
fault_ intdomain - 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 str
- Specifies the priority of this Virtual Machine. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created. - private_
ip_ straddress - The Primary Private IP Address assigned to this Virtual Machine.
- private_
ip_ Sequence[str]addresses - A list of Private IP Addresses assigned to this Virtual Machine.
- provision_
vm_ boolagent 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 tofalse
thenallow_extension_operations
must also be set tofalse
.- proximity_
placement_ strgroup_ id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- public_
ip_ straddress - The Primary Public IP Address assigned to this Virtual Machine.
- public_
ip_ Sequence[str]addresses - A list of the Public IP Addresses assigned to this Virtual Machine.
- reboot_
setting str Specifies the reboot setting for platform scheduled patching. Possible values are
Always
,IfRequired
andNever
.NOTE:
reboot_setting
can only be set whenpatch_mode
is set toAutomaticByPlatform
.- resource_
group_ strname - 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
Sequence[Windows
Virtual Machine Secret Args] - One or more
secret
blocks as defined below. - secure_
boot_ boolenabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- size str
- The SKU which should be used for this Virtual Machine, such as
Standard_F2
. - source_
image_ strid 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- source_
image_ Windowsreference Virtual Machine Source Image Reference Args A
source_image_reference
block as defined below. Changing this forces a new resource to be created.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- Mapping[str, str]
- A mapping of tags which should be assigned to this Virtual Machine.
- termination_
notification WindowsVirtual Machine Termination Notification Args - A
termination_notification
block as defined below. - timezone str
- 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 str - The Base64-Encoded User Data which should be used for this Virtual Machine.
- virtual_
machine_ strid - A 128-bit identifier which uniquely identifies this Virtual Machine.
- virtual_
machine_ strscale_ set_ id 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 FeatureMicrosoft.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 tofalse
, see the documentation for more information.- vm_
agent_ boolplatform_ updates_ enabled - Specifies whether VMAgent Platform Updates is enabled. Defaults to
false
. - vtpm_
enabled 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 Sequence[WindowsVirtual Machine Winrm Listener Args] - One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created. - zone str
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.
- additional
Capabilities Property Map - A
additional_capabilities
block as defined below. - additional
Unattend List<Property Map>Contents - One or more
additional_unattend_content
blocks as defined below. Changing this forces a new resource to be created. - admin
Password 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 String - The username of the local administrator used for the Virtual Machine. Changing this forces a new resource to be created.
- allow
Extension BooleanOperations - Should Extension Operations be allowed on this Virtual Machine? Defaults to
true
. - availability
Set StringId - 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 Property Map - A
boot_diagnostics
block as defined below. - bypass
Platform BooleanSafety Checks On User Schedule Enabled 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 totrue
whenpatch_mode
is set toAutomaticByPlatform
.- capacity
Reservation StringGroup Id Specifies the ID of the Capacity Reservation Group which the Virtual Machine should be allocated to.
NOTE:
capacity_reservation_group_id
cannot be used withavailability_set_id
orproximity_placement_group_id
- computer
Name 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 thename
field is not a validcomputer_name
, then you must specifycomputer_name
. Changing this forces a new resource to be created. - custom
Data 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 StringGroup Id - The ID of a Dedicated Host Group that this Windows Virtual Machine should be run within. Conflicts with
dedicated_host_id
. - dedicated
Host StringId - The ID of a Dedicated Host where this machine should be run on. Conflicts with
dedicated_host_group_id
. - disk
Controller StringType - Specifies the Disk Controller Type used for this Virtual Machine. Possible values are
SCSI
andNVMe
. - edge
Zone 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 BooleanUpdates - 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 BooleanHost Enabled - Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host?
- eviction
Policy String Specifies what should happen when the Virtual Machine is evicted for price reasons when using a Spot instance. Possible values are
Deallocate
andDelete
. Changing this forces a new resource to be created.NOTE: This can only be configured when
priority
is set toSpot
.- extensions
Time StringBudget - 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 List<Property Map> 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 theazure.compute.GalleryApplicationAssignment
resource - but the two approaches cannot be used together. If both are used with the same Virtual Machine, spurious changes will occur. Ifazure.compute.GalleryApplicationAssignment
is used, it's recommended to useignore_changes
for thegallery_application
block on the correspondingazure.compute.WindowsVirtualMachine
resource, to avoid a persistent diff when using this resource.- hotpatching
Enabled Boolean Should the VM be patched without requiring a reboot? Possible values are
true
orfalse
. Defaults tofalse
. For more information about hot patching please see the product documentation.NOTE: Hotpatching can only be enabled if the
patch_mode
is set toAutomaticByPlatform
, theprovision_vm_agent
is set totrue
, yoursource_image_reference
references a hotpatching enabled image, and the VM'ssize
is set to a Azure generation 2 directory within the GitHub Repository.- identity Property Map
- An
identity
block as defined below. - license
Type 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
andWindows_Server
. - location String
- The Azure location where the Windows Virtual Machine should exist. Changing this forces a new resource to be created.
- max
Bid NumberPrice 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 toSpot
.- name String
- The name of the Windows Virtual Machine. Changing this forces a new resource to be created.
- network
Interface List<String>Ids - . 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 Property Map - A
os_disk
block as defined below. - os
Image Property MapNotification - A
os_image_notification
block as defined below. - patch
Assessment StringMode Specifies the mode of VM Guest Patching for the Virtual Machine. Possible values are
AutomaticByPlatform
orImageDefault
. Defaults toImageDefault
.NOTE: If the
patch_assessment_mode
is set toAutomaticByPlatform
then theprovision_vm_agent
field must be set totrue
.- patch
Mode String Specifies the mode of in-guest patching to this Windows Virtual Machine. Possible values are
Manual
,AutomaticByOS
andAutomaticByPlatform
. Defaults toAutomaticByOS
. For more information on patch modes please see the product documentation.NOTE: If
patch_mode
is set toAutomaticByPlatform
thenprovision_vm_agent
must also be set totrue
. If the Virtual Machine is using a hotpatching enabled image thepatch_mode
must always be set toAutomaticByPlatform
.- plan Property Map
- A
plan
block as defined below. Changing this forces a new resource to be created. - platform
Fault NumberDomain - 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 String
- Specifies the priority of this Virtual Machine. Possible values are
Regular
andSpot
. Defaults toRegular
. Changing this forces a new resource to be created. - private
Ip StringAddress - The Primary Private IP Address assigned to this Virtual Machine.
- private
Ip List<String>Addresses - A list of Private IP Addresses assigned to this Virtual Machine.
- provision
Vm BooleanAgent 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 tofalse
thenallow_extension_operations
must also be set tofalse
.- proximity
Placement StringGroup Id - The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.
- public
Ip StringAddress - The Primary Public IP Address assigned to this Virtual Machine.
- public
Ip List<String>Addresses - A list of the Public IP Addresses assigned to this Virtual Machine.
- reboot
Setting String Specifies the reboot setting for platform scheduled patching. Possible values are
Always
,IfRequired
andNever
.NOTE:
reboot_setting
can only be set whenpatch_mode
is set toAutomaticByPlatform
.- resource
Group StringName - 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 List<Property Map>
- One or more
secret
blocks as defined below. - secure
Boot BooleanEnabled - Specifies if Secure Boot and Trusted Launch is enabled for the Virtual Machine. Changing this forces a new resource to be created.
- size String
- The SKU which should be used for this Virtual Machine, such as
Standard_F2
. - source
Image StringId 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 ID
s,Shared Image ID
s,Shared Image Version ID
s,Community Gallery Image ID
s,Community Gallery Image Version ID
s,Shared Gallery Image ID
s andShared Gallery Image Version ID
s.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- source
Image Property MapReference A
source_image_reference
block as defined below. Changing this forces a new resource to be created.NOTE: One of either
source_image_id
orsource_image_reference
must be set.- Map<String>
- A mapping of tags which should be assigned to this Virtual Machine.
- termination
Notification Property Map - A
termination_notification
block as defined below. - timezone 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 String - The Base64-Encoded User Data which should be used for this Virtual Machine.
- virtual
Machine StringId - A 128-bit identifier which uniquely identifies this Virtual Machine.
- virtual
Machine StringScale Set Id 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 FeatureMicrosoft.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 tofalse
, see the documentation for more information.- vm
Agent BooleanPlatform Updates Enabled - Specifies whether VMAgent Platform Updates is enabled. Defaults to
false
. - vtpm
Enabled Boolean - 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 List<Property Map> - One or more
winrm_listener
blocks as defined below. Changing this forces a new resource to be created. - zone 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.
Supporting Types
WindowsVirtualMachineAdditionalCapabilities, WindowsVirtualMachineAdditionalCapabilitiesArgs
- Hibernation
Enabled bool - Whether to enable the hibernation capability or not.
- Ultra
Ssd boolEnabled - Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine? Defaults tofalse
.
- Hibernation
Enabled bool - Whether to enable the hibernation capability or not.
- Ultra
Ssd boolEnabled - Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine? Defaults tofalse
.
- hibernation
Enabled Boolean - Whether to enable the hibernation capability or not.
- ultra
Ssd BooleanEnabled - Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine? Defaults tofalse
.
- hibernation
Enabled boolean - Whether to enable the hibernation capability or not.
- ultra
Ssd booleanEnabled - Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine? Defaults tofalse
.
- hibernation_
enabled bool - Whether to enable the hibernation capability or not.
- ultra_
ssd_ boolenabled - Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine? Defaults tofalse
.
- hibernation
Enabled Boolean - Whether to enable the hibernation capability or not.
- ultra
Ssd BooleanEnabled - Should the capacity to enable Data Disks of the
UltraSSD_LRS
storage account type be supported on this Virtual Machine? Defaults tofalse
.
WindowsVirtualMachineAdditionalUnattendContent, WindowsVirtualMachineAdditionalUnattendContentArgs
- Content string
- The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- Setting string
- The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
- Content string
- The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- Setting string
- The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
- content String
- The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- setting String
- The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
- content string
- The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- setting string
- The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
- content str
- The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- setting str
- The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
- content String
- The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.
- setting String
- The name of the setting to which the content applies. Possible values are
AutoLogon
andFirstLogonCommands
. Changing this forces a new resource to be created.
WindowsVirtualMachineBootDiagnostics, WindowsVirtualMachineBootDiagnosticsArgs
- Storage
Account stringUri The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.
NOTE: Passing a null value will utilize a Managed Storage Account to store Boot Diagnostics.
- Storage
Account stringUri The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.
NOTE: Passing a null value will utilize a Managed Storage Account to store Boot Diagnostics.
- storage
Account StringUri The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.
NOTE: Passing a null value will utilize a Managed Storage Account to store Boot Diagnostics.
- storage
Account stringUri The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.
NOTE: Passing a null value will utilize a Managed Storage Account to store Boot Diagnostics.
- storage_
account_ struri The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.
NOTE: Passing a null value will utilize a Managed Storage Account to store Boot Diagnostics.
- storage
Account StringUri The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.
NOTE: Passing a null value will utilize a Managed Storage Account to store Boot Diagnostics.
WindowsVirtualMachineGalleryApplication, WindowsVirtualMachineGalleryApplicationArgs
- Version
Id string - Specifies the Gallery Application Version resource ID.
- Automatic
Upgrade boolEnabled - Specifies whether the version will be automatically updated for the VM when a new Gallery Application version is available in PIR/SIG. Defaults to
false
. - Configuration
Blob stringUri - Specifies the URI to an Azure Blob that will replace the default configuration for the package if provided.
- Order int
- Specifies the order in which the packages have to be installed. Possible values are between
0
and2147483647
. Defaults to0
. - Tag string
- Specifies a passthrough value for more generic context. This field can be any valid
string
value. - Treat
Failure boolAs Deployment Failure Enabled - Specifies whether any failure for any operation in the VmApplication will fail the deployment of the VM. Defaults to
false
.
- Version
Id string - Specifies the Gallery Application Version resource ID.
- Automatic
Upgrade boolEnabled - Specifies whether the version will be automatically updated for the VM when a new Gallery Application version is available in PIR/SIG. Defaults to
false
. - Configuration
Blob stringUri - Specifies the URI to an Azure Blob that will replace the default configuration for the package if provided.
- Order int
- Specifies the order in which the packages have to be installed. Possible values are between
0
and2147483647
. Defaults to0
. - Tag string
- Specifies a passthrough value for more generic context. This field can be any valid
string
value. - Treat
Failure boolAs Deployment Failure Enabled - Specifies whether any failure for any operation in the VmApplication will fail the deployment of the VM. Defaults to
false
.
- version
Id String - Specifies the Gallery Application Version resource ID.
- automatic
Upgrade BooleanEnabled - Specifies whether the version will be automatically updated for the VM when a new Gallery Application version is available in PIR/SIG. Defaults to
false
. - configuration
Blob StringUri - Specifies the URI to an Azure Blob that will replace the default configuration for the package if provided.
- order Integer
- Specifies the order in which the packages have to be installed. Possible values are between
0
and2147483647
. Defaults to0
. - tag String
- Specifies a passthrough value for more generic context. This field can be any valid
string
value. - treat
Failure BooleanAs Deployment Failure Enabled - Specifies whether any failure for any operation in the VmApplication will fail the deployment of the VM. Defaults to
false
.
- version
Id string - Specifies the Gallery Application Version resource ID.
- automatic
Upgrade booleanEnabled - Specifies whether the version will be automatically updated for the VM when a new Gallery Application version is available in PIR/SIG. Defaults to
false
. - configuration
Blob stringUri - Specifies the URI to an Azure Blob that will replace the default configuration for the package if provided.
- order number
- Specifies the order in which the packages have to be installed. Possible values are between
0
and2147483647
. Defaults to0
. - tag string
- Specifies a passthrough value for more generic context. This field can be any valid
string
value. - treat
Failure booleanAs Deployment Failure Enabled - Specifies whether any failure for any operation in the VmApplication will fail the deployment of the VM. Defaults to
false
.
- version_
id str - Specifies the Gallery Application Version resource ID.
- automatic_
upgrade_ boolenabled - Specifies whether the version will be automatically updated for the VM when a new Gallery Application version is available in PIR/SIG. Defaults to
false
. - configuration_
blob_ struri - Specifies the URI to an Azure Blob that will replace the default configuration for the package if provided.
- order int
- Specifies the order in which the packages have to be installed. Possible values are between
0
and2147483647
. Defaults to0
. - tag str
- Specifies a passthrough value for more generic context. This field can be any valid
string
value. - treat_
failure_ boolas_ deployment_ failure_ enabled - Specifies whether any failure for any operation in the VmApplication will fail the deployment of the VM. Defaults to
false
.
- version
Id String - Specifies the Gallery Application Version resource ID.
- automatic
Upgrade BooleanEnabled - Specifies whether the version will be automatically updated for the VM when a new Gallery Application version is available in PIR/SIG. Defaults to
false
. - configuration
Blob StringUri - Specifies the URI to an Azure Blob that will replace the default configuration for the package if provided.
- order Number
- Specifies the order in which the packages have to be installed. Possible values are between
0
and2147483647
. Defaults to0
. - tag String
- Specifies a passthrough value for more generic context. This field can be any valid
string
value. - treat
Failure BooleanAs Deployment Failure Enabled - Specifies whether any failure for any operation in the VmApplication will fail the deployment of the VM. Defaults to
false
.
WindowsVirtualMachineIdentity, WindowsVirtualMachineIdentityArgs
- Type string
- Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both). - Identity
Ids List<string> Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine.
NOTE: This is required when
type
is set toUserAssigned
orSystemAssigned, UserAssigned
.- Principal
Id string - The Principal ID associated with this Managed Service Identity.
- Tenant
Id string - The Tenant ID associated with this Managed Service Identity.
- Type string
- Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both). - Identity
Ids []string Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine.
NOTE: This is required when
type
is set toUserAssigned
orSystemAssigned, UserAssigned
.- Principal
Id string - The Principal ID associated with this Managed Service Identity.
- Tenant
Id string - The Tenant ID associated with this Managed Service Identity.
- type String
- Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both). - identity
Ids List<String> Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine.
NOTE: This is required when
type
is set toUserAssigned
orSystemAssigned, UserAssigned
.- principal
Id String - The Principal ID associated with this Managed Service Identity.
- tenant
Id String - The Tenant ID associated with this Managed Service Identity.
- type string
- Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both). - identity
Ids string[] Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine.
NOTE: This is required when
type
is set toUserAssigned
orSystemAssigned, UserAssigned
.- principal
Id string - The Principal ID associated with this Managed Service Identity.
- tenant
Id string - The Tenant ID associated with this Managed Service Identity.
- type str
- Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both). - identity_
ids Sequence[str] Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine.
NOTE: This is required when
type
is set toUserAssigned
orSystemAssigned, UserAssigned
.- principal_
id str - The Principal ID associated with this Managed Service Identity.
- tenant_
id str - The Tenant ID associated with this Managed Service Identity.
- type String
- Specifies the type of Managed Service Identity that should be configured on this Windows Virtual Machine. Possible values are
SystemAssigned
,UserAssigned
,SystemAssigned, UserAssigned
(to enable both). - identity
Ids List<String> Specifies a list of User Assigned Managed Identity IDs to be assigned to this Windows Virtual Machine.
NOTE: This is required when
type
is set toUserAssigned
orSystemAssigned, UserAssigned
.- principal
Id String - The Principal ID associated with this Managed Service Identity.
- tenant
Id String - The Tenant ID associated with this Managed Service Identity.
WindowsVirtualMachineOsDisk, WindowsVirtualMachineOsDiskArgs
- Caching string
- The Type of Caching which should be used for the Internal OS Disk. Possible values are
None
,ReadOnly
andReadWrite
. - Storage
Account stringType - The Type of Storage Account which should back this the Internal OS Disk. Possible values are
Standard_LRS
,StandardSSD_LRS
,Premium_LRS
,StandardSSD_ZRS
andPremium_ZRS
. Changing this forces a new resource to be created. - Diff
Disk WindowsSettings Virtual Machine Os Disk Diff Disk Settings A
diff_disk_settings
block as defined above. Changing this forces a new resource to be created.NOTE:
diff_disk_settings
can only be set whencaching
is set toReadOnly
. More information can be found here- Disk
Encryption stringSet Id The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. Conflicts with
secure_vm_disk_encryption_set_id
.NOTE: The Disk Encryption Set must have the
Reader
Role Assignment scoped on the Key Vault - in addition to an Access Policy to the Key Vault- Disk
Size intGb The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from.
NOTE: If specified this must be equal to or larger than the size of the Image the Virtual Machine is based on. When creating a larger disk than exists in the image you'll need to repartition the disk to use the remaining space.
- Name string
- The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.
- Secure
Vm stringDisk Encryption Set Id The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk when the Virtual Machine is a Confidential VM. Conflicts with
disk_encryption_set_id
. Changing this forces a new resource to be created.NOTE:
secure_vm_disk_encryption_set_id
can only be specified whensecurity_encryption_type
is set toDiskWithVMGuestState
.- Security
Encryption stringType Encryption Type when the Virtual Machine is a Confidential VM. Possible values are
VMGuestStateOnly
andDiskWithVMGuestState
. Changing this forces a new resource to be created.NOTE:
vtpm_enabled
must be set totrue
whensecurity_encryption_type
is specified.NOTE:
encryption_at_host_enabled
cannot be set totrue
whensecurity_encryption_type
is set toDiskWithVMGuestState
.- Write
Accelerator boolEnabled Should Write Accelerator be Enabled for this OS Disk? Defaults to
false
.NOTE: This requires that the
storage_account_type
is set toPremium_LRS
and thatcaching
is set toNone
.
- Caching string
- The Type of Caching which should be used for the Internal OS Disk. Possible values are
None
,ReadOnly
andReadWrite
. - Storage
Account stringType - The Type of Storage Account which should back this the Internal OS Disk. Possible values are
Standard_LRS
,StandardSSD_LRS
,Premium_LRS
,StandardSSD_ZRS
andPremium_ZRS
. Changing this forces a new resource to be created. - Diff
Disk WindowsSettings Virtual Machine Os Disk Diff Disk Settings A
diff_disk_settings
block as defined above. Changing this forces a new resource to be created.NOTE:
diff_disk_settings
can only be set whencaching
is set toReadOnly
. More information can be found here- Disk
Encryption stringSet Id The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. Conflicts with
secure_vm_disk_encryption_set_id
.NOTE: The Disk Encryption Set must have the
Reader
Role Assignment scoped on the Key Vault - in addition to an Access Policy to the Key Vault- Disk
Size intGb The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from.
NOTE: If specified this must be equal to or larger than the size of the Image the Virtual Machine is based on. When creating a larger disk than exists in the image you'll need to repartition the disk to use the remaining space.
- Name string
- The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.
- Secure
Vm stringDisk Encryption Set Id The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk when the Virtual Machine is a Confidential VM. Conflicts with
disk_encryption_set_id
. Changing this forces a new resource to be created.NOTE:
secure_vm_disk_encryption_set_id
can only be specified whensecurity_encryption_type
is set toDiskWithVMGuestState
.- Security
Encryption stringType Encryption Type when the Virtual Machine is a Confidential VM. Possible values are
VMGuestStateOnly
andDiskWithVMGuestState
. Changing this forces a new resource to be created.NOTE:
vtpm_enabled
must be set totrue
whensecurity_encryption_type
is specified.NOTE:
encryption_at_host_enabled
cannot be set totrue
whensecurity_encryption_type
is set toDiskWithVMGuestState
.- Write
Accelerator boolEnabled Should Write Accelerator be Enabled for this OS Disk? Defaults to
false
.NOTE: This requires that the
storage_account_type
is set toPremium_LRS
and thatcaching
is set toNone
.
- caching String
- The Type of Caching which should be used for the Internal OS Disk. Possible values are
None
,ReadOnly
andReadWrite
. - storage
Account StringType - The Type of Storage Account which should back this the Internal OS Disk. Possible values are
Standard_LRS
,StandardSSD_LRS
,Premium_LRS
,StandardSSD_ZRS
andPremium_ZRS
. Changing this forces a new resource to be created. - diff
Disk WindowsSettings Virtual Machine Os Disk Diff Disk Settings A
diff_disk_settings
block as defined above. Changing this forces a new resource to be created.NOTE:
diff_disk_settings
can only be set whencaching
is set toReadOnly
. More information can be found here- disk
Encryption StringSet Id The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. Conflicts with
secure_vm_disk_encryption_set_id
.NOTE: The Disk Encryption Set must have the
Reader
Role Assignment scoped on the Key Vault - in addition to an Access Policy to the Key Vault- disk
Size IntegerGb The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from.
NOTE: If specified this must be equal to or larger than the size of the Image the Virtual Machine is based on. When creating a larger disk than exists in the image you'll need to repartition the disk to use the remaining space.
- name String
- The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.
- secure
Vm StringDisk Encryption Set Id The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk when the Virtual Machine is a Confidential VM. Conflicts with
disk_encryption_set_id
. Changing this forces a new resource to be created.NOTE:
secure_vm_disk_encryption_set_id
can only be specified whensecurity_encryption_type
is set toDiskWithVMGuestState
.- security
Encryption StringType Encryption Type when the Virtual Machine is a Confidential VM. Possible values are
VMGuestStateOnly
andDiskWithVMGuestState
. Changing this forces a new resource to be created.NOTE:
vtpm_enabled
must be set totrue
whensecurity_encryption_type
is specified.NOTE:
encryption_at_host_enabled
cannot be set totrue
whensecurity_encryption_type
is set toDiskWithVMGuestState
.- write
Accelerator BooleanEnabled Should Write Accelerator be Enabled for this OS Disk? Defaults to
false
.NOTE: This requires that the
storage_account_type
is set toPremium_LRS
and thatcaching
is set toNone
.
- caching string
- The Type of Caching which should be used for the Internal OS Disk. Possible values are
None
,ReadOnly
andReadWrite
. - storage
Account stringType - The Type of Storage Account which should back this the Internal OS Disk. Possible values are
Standard_LRS
,StandardSSD_LRS
,Premium_LRS
,StandardSSD_ZRS
andPremium_ZRS
. Changing this forces a new resource to be created. - diff
Disk WindowsSettings Virtual Machine Os Disk Diff Disk Settings A
diff_disk_settings
block as defined above. Changing this forces a new resource to be created.NOTE:
diff_disk_settings
can only be set whencaching
is set toReadOnly
. More information can be found here- disk
Encryption stringSet Id The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. Conflicts with
secure_vm_disk_encryption_set_id
.NOTE: The Disk Encryption Set must have the
Reader
Role Assignment scoped on the Key Vault - in addition to an Access Policy to the Key Vault- disk
Size numberGb The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from.
NOTE: If specified this must be equal to or larger than the size of the Image the Virtual Machine is based on. When creating a larger disk than exists in the image you'll need to repartition the disk to use the remaining space.
- name string
- The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.
- secure
Vm stringDisk Encryption Set Id The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk when the Virtual Machine is a Confidential VM. Conflicts with
disk_encryption_set_id
. Changing this forces a new resource to be created.NOTE:
secure_vm_disk_encryption_set_id
can only be specified whensecurity_encryption_type
is set toDiskWithVMGuestState
.- security
Encryption stringType Encryption Type when the Virtual Machine is a Confidential VM. Possible values are
VMGuestStateOnly
andDiskWithVMGuestState
. Changing this forces a new resource to be created.NOTE:
vtpm_enabled
must be set totrue
whensecurity_encryption_type
is specified.NOTE:
encryption_at_host_enabled
cannot be set totrue
whensecurity_encryption_type
is set toDiskWithVMGuestState
.- write
Accelerator booleanEnabled Should Write Accelerator be Enabled for this OS Disk? Defaults to
false
.NOTE: This requires that the
storage_account_type
is set toPremium_LRS
and thatcaching
is set toNone
.
- caching str
- The Type of Caching which should be used for the Internal OS Disk. Possible values are
None
,ReadOnly
andReadWrite
. - storage_
account_ strtype - The Type of Storage Account which should back this the Internal OS Disk. Possible values are
Standard_LRS
,StandardSSD_LRS
,Premium_LRS
,StandardSSD_ZRS
andPremium_ZRS
. Changing this forces a new resource to be created. - diff_
disk_ Windowssettings Virtual Machine Os Disk Diff Disk Settings A
diff_disk_settings
block as defined above. Changing this forces a new resource to be created.NOTE:
diff_disk_settings
can only be set whencaching
is set toReadOnly
. More information can be found here- disk_
encryption_ strset_ id The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. Conflicts with
secure_vm_disk_encryption_set_id
.NOTE: The Disk Encryption Set must have the
Reader
Role Assignment scoped on the Key Vault - in addition to an Access Policy to the Key Vault- disk_
size_ intgb The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from.
NOTE: If specified this must be equal to or larger than the size of the Image the Virtual Machine is based on. When creating a larger disk than exists in the image you'll need to repartition the disk to use the remaining space.
- name str
- The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.
- secure_
vm_ strdisk_ encryption_ set_ id The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk when the Virtual Machine is a Confidential VM. Conflicts with
disk_encryption_set_id
. Changing this forces a new resource to be created.NOTE:
secure_vm_disk_encryption_set_id
can only be specified whensecurity_encryption_type
is set toDiskWithVMGuestState
.- security_
encryption_ strtype Encryption Type when the Virtual Machine is a Confidential VM. Possible values are
VMGuestStateOnly
andDiskWithVMGuestState
. Changing this forces a new resource to be created.NOTE:
vtpm_enabled
must be set totrue
whensecurity_encryption_type
is specified.NOTE:
encryption_at_host_enabled
cannot be set totrue
whensecurity_encryption_type
is set toDiskWithVMGuestState
.- write_
accelerator_ boolenabled Should Write Accelerator be Enabled for this OS Disk? Defaults to
false
.NOTE: This requires that the
storage_account_type
is set toPremium_LRS
and thatcaching
is set toNone
.
- caching String
- The Type of Caching which should be used for the Internal OS Disk. Possible values are
None
,ReadOnly
andReadWrite
. - storage
Account StringType - The Type of Storage Account which should back this the Internal OS Disk. Possible values are
Standard_LRS
,StandardSSD_LRS
,Premium_LRS
,StandardSSD_ZRS
andPremium_ZRS
. Changing this forces a new resource to be created. - diff
Disk Property MapSettings A
diff_disk_settings
block as defined above. Changing this forces a new resource to be created.NOTE:
diff_disk_settings
can only be set whencaching
is set toReadOnly
. More information can be found here- disk
Encryption StringSet Id The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk. Conflicts with
secure_vm_disk_encryption_set_id
.NOTE: The Disk Encryption Set must have the
Reader
Role Assignment scoped on the Key Vault - in addition to an Access Policy to the Key Vault- disk
Size NumberGb The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from.
NOTE: If specified this must be equal to or larger than the size of the Image the Virtual Machine is based on. When creating a larger disk than exists in the image you'll need to repartition the disk to use the remaining space.
- name String
- The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.
- secure
Vm StringDisk Encryption Set Id The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk when the Virtual Machine is a Confidential VM. Conflicts with
disk_encryption_set_id
. Changing this forces a new resource to be created.NOTE:
secure_vm_disk_encryption_set_id
can only be specified whensecurity_encryption_type
is set toDiskWithVMGuestState
.- security
Encryption StringType Encryption Type when the Virtual Machine is a Confidential VM. Possible values are
VMGuestStateOnly
andDiskWithVMGuestState
. Changing this forces a new resource to be created.NOTE:
vtpm_enabled
must be set totrue
whensecurity_encryption_type
is specified.NOTE:
encryption_at_host_enabled
cannot be set totrue
whensecurity_encryption_type
is set toDiskWithVMGuestState
.- write
Accelerator BooleanEnabled Should Write Accelerator be Enabled for this OS Disk? Defaults to
false
.NOTE: This requires that the
storage_account_type
is set toPremium_LRS
and thatcaching
is set toNone
.
WindowsVirtualMachineOsDiskDiffDiskSettings, WindowsVirtualMachineOsDiskDiffDiskSettingsArgs
- Option string
- Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created. - Placement string
- Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
- Option string
- Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created. - Placement string
- Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
- option String
- Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created. - placement String
- Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
- option string
- Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created. - placement string
- Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
- option str
- Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created. - placement str
- Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
- option String
- Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is
Local
. Changing this forces a new resource to be created. - placement String
- Specifies where to store the Ephemeral Disk. Possible values are
CacheDisk
andResourceDisk
. Defaults toCacheDisk
. Changing this forces a new resource to be created.
WindowsVirtualMachineOsImageNotification, WindowsVirtualMachineOsImageNotificationArgs
- Timeout string
- Length of time a notification to be sent to the VM on the instance metadata server till the VM gets OS upgraded. The only possible value is
PT15M
. Defaults toPT15M
.
- Timeout string
- Length of time a notification to be sent to the VM on the instance metadata server till the VM gets OS upgraded. The only possible value is
PT15M
. Defaults toPT15M
.
- timeout String
- Length of time a notification to be sent to the VM on the instance metadata server till the VM gets OS upgraded. The only possible value is
PT15M
. Defaults toPT15M
.
- timeout string
- Length of time a notification to be sent to the VM on the instance metadata server till the VM gets OS upgraded. The only possible value is
PT15M
. Defaults toPT15M
.
- timeout str
- Length of time a notification to be sent to the VM on the instance metadata server till the VM gets OS upgraded. The only possible value is
PT15M
. Defaults toPT15M
.
- timeout String
- Length of time a notification to be sent to the VM on the instance metadata server till the VM gets OS upgraded. The only possible value is
PT15M
. Defaults toPT15M
.
WindowsVirtualMachinePlan, WindowsVirtualMachinePlanArgs
- Name string
- Specifies the Name of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
- Product string
- Specifies the Product of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
- Publisher string
Specifies the Publisher of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
NOTE: If you use the
plan
block with one of Microsoft's marketplace images (e.g.publisher = "MicrosoftWindowsServer"
). This may prevent the purchase of the offer. An example Azure API error:The Offer: 'WindowsServer' cannot be purchased by subscription: '12345678-12234-5678-9012-123456789012' as it is not to be sold in market: 'US'. Please choose a subscription which is associated with a different market.
- Name string
- Specifies the Name of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
- Product string
- Specifies the Product of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
- Publisher string
Specifies the Publisher of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
NOTE: If you use the
plan
block with one of Microsoft's marketplace images (e.g.publisher = "MicrosoftWindowsServer"
). This may prevent the purchase of the offer. An example Azure API error:The Offer: 'WindowsServer' cannot be purchased by subscription: '12345678-12234-5678-9012-123456789012' as it is not to be sold in market: 'US'. Please choose a subscription which is associated with a different market.
- name String
- Specifies the Name of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
- product String
- Specifies the Product of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
- publisher String
Specifies the Publisher of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
NOTE: If you use the
plan
block with one of Microsoft's marketplace images (e.g.publisher = "MicrosoftWindowsServer"
). This may prevent the purchase of the offer. An example Azure API error:The Offer: 'WindowsServer' cannot be purchased by subscription: '12345678-12234-5678-9012-123456789012' as it is not to be sold in market: 'US'. Please choose a subscription which is associated with a different market.
- name string
- Specifies the Name of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
- product string
- Specifies the Product of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
- publisher string
Specifies the Publisher of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
NOTE: If you use the
plan
block with one of Microsoft's marketplace images (e.g.publisher = "MicrosoftWindowsServer"
). This may prevent the purchase of the offer. An example Azure API error:The Offer: 'WindowsServer' cannot be purchased by subscription: '12345678-12234-5678-9012-123456789012' as it is not to be sold in market: 'US'. Please choose a subscription which is associated with a different market.
- name str
- Specifies the Name of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
- product str
- Specifies the Product of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
- publisher str
Specifies the Publisher of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
NOTE: If you use the
plan
block with one of Microsoft's marketplace images (e.g.publisher = "MicrosoftWindowsServer"
). This may prevent the purchase of the offer. An example Azure API error:The Offer: 'WindowsServer' cannot be purchased by subscription: '12345678-12234-5678-9012-123456789012' as it is not to be sold in market: 'US'. Please choose a subscription which is associated with a different market.
- name String
- Specifies the Name of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
- product String
- Specifies the Product of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
- publisher String
Specifies the Publisher of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.
NOTE: If you use the
plan
block with one of Microsoft's marketplace images (e.g.publisher = "MicrosoftWindowsServer"
). This may prevent the purchase of the offer. An example Azure API error:The Offer: 'WindowsServer' cannot be purchased by subscription: '12345678-12234-5678-9012-123456789012' as it is not to be sold in market: 'US'. Please choose a subscription which is associated with a different market.
WindowsVirtualMachineSecret, WindowsVirtualMachineSecretArgs
- Certificates
List<Windows
Virtual Machine Secret Certificate> - One or more
certificate
blocks as defined above. - Key
Vault stringId - The ID of the Key Vault from which all Secrets should be sourced.
- Certificates
[]Windows
Virtual Machine Secret Certificate - One or more
certificate
blocks as defined above. - Key
Vault stringId - The ID of the Key Vault from which all Secrets should be sourced.
- certificates
List<Windows
Virtual Machine Secret Certificate> - One or more
certificate
blocks as defined above. - key
Vault StringId - The ID of the Key Vault from which all Secrets should be sourced.
- certificates
Windows
Virtual Machine Secret Certificate[] - One or more
certificate
blocks as defined above. - key
Vault stringId - The ID of the Key Vault from which all Secrets should be sourced.
- certificates
Sequence[Windows
Virtual Machine Secret Certificate] - One or more
certificate
blocks as defined above. - key_
vault_ strid - The ID of the Key Vault from which all Secrets should be sourced.
- certificates List<Property Map>
- One or more
certificate
blocks as defined above. - key
Vault StringId - The ID of the Key Vault from which all Secrets should be sourced.
WindowsVirtualMachineSecretCertificate, WindowsVirtualMachineSecretCertificateArgs
WindowsVirtualMachineSourceImageReference, WindowsVirtualMachineSourceImageReferenceArgs
- Offer string
- Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
- Publisher string
- Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
- Sku string
- Specifies the SKU of the image used to create the virtual machines. Changing this forces a new resource to be created.
- Version string
- Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.
- Offer string
- Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
- Publisher string
- Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
- Sku string
- Specifies the SKU of the image used to create the virtual machines. Changing this forces a new resource to be created.
- Version string
- Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.
- offer String
- Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
- publisher String
- Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
- sku String
- Specifies the SKU of the image used to create the virtual machines. Changing this forces a new resource to be created.
- version String
- Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.
- offer string
- Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
- publisher string
- Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
- sku string
- Specifies the SKU of the image used to create the virtual machines. Changing this forces a new resource to be created.
- version string
- Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.
- offer str
- Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
- publisher str
- Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
- sku str
- Specifies the SKU of the image used to create the virtual machines. Changing this forces a new resource to be created.
- version str
- Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.
- offer String
- Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.
- publisher String
- Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.
- sku String
- Specifies the SKU of the image used to create the virtual machines. Changing this forces a new resource to be created.
- version String
- Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.
WindowsVirtualMachineTerminationNotification, WindowsVirtualMachineTerminationNotificationArgs
- Enabled bool
- Should the termination notification be enabled on this Virtual Machine?
- Timeout string
Length of time (in minutes, between
5
and15
) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults toPT5M
.NOTE: For more information about the termination notification, please refer to this doc.
- Enabled bool
- Should the termination notification be enabled on this Virtual Machine?
- Timeout string
Length of time (in minutes, between
5
and15
) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults toPT5M
.NOTE: For more information about the termination notification, please refer to this doc.
- enabled Boolean
- Should the termination notification be enabled on this Virtual Machine?
- timeout String
Length of time (in minutes, between
5
and15
) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults toPT5M
.NOTE: For more information about the termination notification, please refer to this doc.
- enabled boolean
- Should the termination notification be enabled on this Virtual Machine?
- timeout string
Length of time (in minutes, between
5
and15
) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults toPT5M
.NOTE: For more information about the termination notification, please refer to this doc.
- enabled bool
- Should the termination notification be enabled on this Virtual Machine?
- timeout str
Length of time (in minutes, between
5
and15
) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults toPT5M
.NOTE: For more information about the termination notification, please refer to this doc.
- enabled Boolean
- Should the termination notification be enabled on this Virtual Machine?
- timeout String
Length of time (in minutes, between
5
and15
) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults toPT5M
.NOTE: For more information about the termination notification, please refer to this doc.
WindowsVirtualMachineWinrmListener, WindowsVirtualMachineWinrmListenerArgs
- Protocol string
- Specifies the protocol of listener. Possible values are
Http
orHttps
. Changing this forces a new resource to be created. - Certificate
Url string - The Secret URL of a Key Vault Certificate, which must be specified when
protocol
is set toHttps
. Changing this forces a new resource to be created.
- Protocol string
- Specifies the protocol of listener. Possible values are
Http
orHttps
. Changing this forces a new resource to be created. - Certificate
Url string - The Secret URL of a Key Vault Certificate, which must be specified when
protocol
is set toHttps
. Changing this forces a new resource to be created.
- protocol String
- Specifies the protocol of listener. Possible values are
Http
orHttps
. Changing this forces a new resource to be created. - certificate
Url String - The Secret URL of a Key Vault Certificate, which must be specified when
protocol
is set toHttps
. Changing this forces a new resource to be created.
- protocol string
- Specifies the protocol of listener. Possible values are
Http
orHttps
. Changing this forces a new resource to be created. - certificate
Url string - The Secret URL of a Key Vault Certificate, which must be specified when
protocol
is set toHttps
. Changing this forces a new resource to be created.
- protocol str
- Specifies the protocol of listener. Possible values are
Http
orHttps
. Changing this forces a new resource to be created. - certificate_
url str - The Secret URL of a Key Vault Certificate, which must be specified when
protocol
is set toHttps
. Changing this forces a new resource to be created.
- protocol String
- Specifies the protocol of listener. Possible values are
Http
orHttps
. Changing this forces a new resource to be created. - certificate
Url String - The Secret URL of a Key Vault Certificate, which must be specified when
protocol
is set toHttps
. Changing this forces a new resource to be created.
Import
Windows Virtual Machines can be imported using the resource id
, e.g.
$ pulumi import azure:compute/windowsVirtualMachine:WindowsVirtualMachine example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Compute/virtualMachines/machine1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.