WindowsVirtualMachine

Manages a Windows Virtual Machine within a Dev Test Lab.

Create a WindowsVirtualMachine Resource

new WindowsVirtualMachine(name: string, args: WindowsVirtualMachineArgs, opts?: CustomResourceOptions);

def WindowsVirtualMachine(resource_name, opts=None, allow_claim=None, disallow_public_ip_address=None, gallery_image_reference=None, inbound_nat_rules=None, lab_name=None, lab_subnet_name=None, lab_virtual_network_id=None, location=None, name=None, notes=None, password=None, resource_group_name=None, size=None, storage_type=None, tags=None, username=None, __props__=None);

func NewWindowsVirtualMachine(ctx *Context, name string, args WindowsVirtualMachineArgs, opts ...ResourceOption) (*WindowsVirtualMachine, error)

public WindowsVirtualMachine(string name, WindowsVirtualMachineArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args 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.

WindowsVirtualMachine Resource Properties

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

Inputs

The WindowsVirtualMachine resource accepts the following input properties:

GalleryImageReference WindowsVirtualMachineGalleryImageReferenceArgs: A gallery_image_reference block as defined below.
LabName string: Specifies the name of the Dev Test Lab in which the Virtual Machine should be created. Changing this forces a new resource to be created.
LabSubnetName string: The name of a Subnet within the Dev Test Virtual Network where this machine should exist. Changing this forces a new resource to be created.
LabVirtualNetworkId string: The ID of the Dev Test Virtual Network where this Virtual Machine should be created. Changing this forces a new resource to be created.
Password string: The Password associated with the username used to login to this Virtual Machine. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Dev Test Lab resource exists. Changing this forces a new resource to be created.
Size string: The Machine Size to use for this Virtual Machine, such as Standard_F2. Changing this forces a new resource to be created.
StorageType string: The type of Storage to use on this Virtual Machine. Possible values are Standard and Premium.
Username string: The Username associated with the local administrator on this Virtual Machine. Changing this forces a new resource to be created.
AllowClaim bool: Can this Virtual Machine be claimed by users? Defaults to true.
DisallowPublicIpAddress bool: Should the Virtual Machine be created without a Public IP Address? Changing this forces a new resource to be created.
InboundNatRules List<WindowsVirtualMachineInboundNatRuleArgs>: One or more inbound_nat_rule blocks as defined below. Changing this forces a new resource to be created.
Location string: Specifies the supported Azure location where the Dev Test Lab exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Dev Test Machine. Changing this forces a new resource to be created.
Notes string: Any notes about the Virtual Machine.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

GalleryImageReference WindowsVirtualMachineGalleryImageReference: A gallery_image_reference block as defined below.
LabName string: Specifies the name of the Dev Test Lab in which the Virtual Machine should be created. Changing this forces a new resource to be created.
LabSubnetName string: The name of a Subnet within the Dev Test Virtual Network where this machine should exist. Changing this forces a new resource to be created.
LabVirtualNetworkId string: The ID of the Dev Test Virtual Network where this Virtual Machine should be created. Changing this forces a new resource to be created.
Password string: The Password associated with the username used to login to this Virtual Machine. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Dev Test Lab resource exists. Changing this forces a new resource to be created.
Size string: The Machine Size to use for this Virtual Machine, such as Standard_F2. Changing this forces a new resource to be created.
StorageType string: The type of Storage to use on this Virtual Machine. Possible values are Standard and Premium.
Username string: The Username associated with the local administrator on this Virtual Machine. Changing this forces a new resource to be created.
AllowClaim bool: Can this Virtual Machine be claimed by users? Defaults to true.
DisallowPublicIpAddress bool: Should the Virtual Machine be created without a Public IP Address? Changing this forces a new resource to be created.
InboundNatRules []WindowsVirtualMachineInboundNatRule: One or more inbound_nat_rule blocks as defined below. Changing this forces a new resource to be created.
Location string: Specifies the supported Azure location where the Dev Test Lab exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Dev Test Machine. Changing this forces a new resource to be created.
Notes string: Any notes about the Virtual Machine.
Tags map[string]string: A mapping of tags to assign to the resource.

galleryImageReference WindowsVirtualMachineGalleryImageReference: A gallery_image_reference block as defined below.
labName string: Specifies the name of the Dev Test Lab in which the Virtual Machine should be created. Changing this forces a new resource to be created.
labSubnetName string: The name of a Subnet within the Dev Test Virtual Network where this machine should exist. Changing this forces a new resource to be created.
labVirtualNetworkId string: The ID of the Dev Test Virtual Network where this Virtual Machine should be created. Changing this forces a new resource to be created.
password string: The Password associated with the username used to login to this Virtual Machine. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which the Dev Test Lab resource exists. Changing this forces a new resource to be created.
size string: The Machine Size to use for this Virtual Machine, such as Standard_F2. Changing this forces a new resource to be created.
storageType string: The type of Storage to use on this Virtual Machine. Possible values are Standard and Premium.
username string: The Username associated with the local administrator on this Virtual Machine. Changing this forces a new resource to be created.
allowClaim boolean: Can this Virtual Machine be claimed by users? Defaults to true.
disallowPublicIpAddress boolean: Should the Virtual Machine be created without a Public IP Address? Changing this forces a new resource to be created.
inboundNatRules WindowsVirtualMachineInboundNatRule[]: One or more inbound_nat_rule blocks as defined below. Changing this forces a new resource to be created.
location string: Specifies the supported Azure location where the Dev Test Lab exists. Changing this forces a new resource to be created.
name string: Specifies the name of the Dev Test Machine. Changing this forces a new resource to be created.
notes string: Any notes about the Virtual Machine.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

gallery_image_reference Dict[WindowsVirtualMachineGalleryImageReference]: A gallery_image_reference block as defined below.
lab_name str: Specifies the name of the Dev Test Lab in which the Virtual Machine should be created. Changing this forces a new resource to be created.
lab_subnet_name str: The name of a Subnet within the Dev Test Virtual Network where this machine should exist. Changing this forces a new resource to be created.
lab_virtual_network_id str: The ID of the Dev Test Virtual Network where this Virtual Machine should be created. Changing this forces a new resource to be created.
password str: The Password associated with the username used to login to this Virtual Machine. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which the Dev Test Lab resource exists. Changing this forces a new resource to be created.
size str: The Machine Size to use for this Virtual Machine, such as Standard_F2. Changing this forces a new resource to be created.
storage_type str: The type of Storage to use on this Virtual Machine. Possible values are Standard and Premium.
username str: The Username associated with the local administrator on this Virtual Machine. Changing this forces a new resource to be created.
allow_claim bool: Can this Virtual Machine be claimed by users? Defaults to true.
disallow_public_ip_address bool: Should the Virtual Machine be created without a Public IP Address? Changing this forces a new resource to be created.
inbound_nat_rules List[WindowsVirtualMachineInboundNatRule]: One or more inbound_nat_rule blocks as defined below. Changing this forces a new resource to be created.
location str: Specifies the supported Azure location where the Dev Test Lab exists. Changing this forces a new resource to be created.
name str: Specifies the name of the Dev Test Machine. Changing this forces a new resource to be created.
notes str: Any notes about the Virtual Machine.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

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

Fqdn string: The FQDN of the Virtual Machine.
Id string: The provider-assigned unique ID for this managed resource.
UniqueIdentifier string: The unique immutable identifier of the Virtual Machine.

Fqdn string: The FQDN of the Virtual Machine.
Id string: The provider-assigned unique ID for this managed resource.
UniqueIdentifier string: The unique immutable identifier of the Virtual Machine.

fqdn string: The FQDN of the Virtual Machine.
id string: The provider-assigned unique ID for this managed resource.
uniqueIdentifier string: The unique immutable identifier of the Virtual Machine.

fqdn str: The FQDN of the Virtual Machine.
id str: The provider-assigned unique ID for this managed resource.
unique_identifier str: The unique immutable identifier of the Virtual Machine.

Look up an 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

static get(resource_name, id, opts=None, allow_claim=None, disallow_public_ip_address=None, fqdn=None, gallery_image_reference=None, inbound_nat_rules=None, lab_name=None, lab_subnet_name=None, lab_virtual_network_id=None, location=None, name=None, notes=None, password=None, resource_group_name=None, size=None, storage_type=None, tags=None, unique_identifier=None, username=None, __props__=None);

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)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AllowClaim bool: Can this Virtual Machine be claimed by users? Defaults to true.
DisallowPublicIpAddress bool: Should the Virtual Machine be created without a Public IP Address? Changing this forces a new resource to be created.
Fqdn string: The FQDN of the Virtual Machine.
GalleryImageReference WindowsVirtualMachineGalleryImageReferenceArgs: A gallery_image_reference block as defined below.
InboundNatRules List<WindowsVirtualMachineInboundNatRuleArgs>: One or more inbound_nat_rule blocks as defined below. Changing this forces a new resource to be created.
LabName string: Specifies the name of the Dev Test Lab in which the Virtual Machine should be created. Changing this forces a new resource to be created.
LabSubnetName string: The name of a Subnet within the Dev Test Virtual Network where this machine should exist. Changing this forces a new resource to be created.
LabVirtualNetworkId string: The ID of the Dev Test Virtual Network where this Virtual Machine should be created. Changing this forces a new resource to be created.
Location string: Specifies the supported Azure location where the Dev Test Lab exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Dev Test Machine. Changing this forces a new resource to be created.
Notes string: Any notes about the Virtual Machine.
Password string: The Password associated with the username used to login to this Virtual Machine. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Dev Test Lab resource exists. Changing this forces a new resource to be created.
Size string: The Machine Size to use for this Virtual Machine, such as Standard_F2. Changing this forces a new resource to be created.
StorageType string: The type of Storage to use on this Virtual Machine. Possible values are Standard and Premium.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
UniqueIdentifier string: The unique immutable identifier of the Virtual Machine.
Username string: The Username associated with the local administrator on this Virtual Machine. Changing this forces a new resource to be created.

AllowClaim bool: Can this Virtual Machine be claimed by users? Defaults to true.
DisallowPublicIpAddress bool: Should the Virtual Machine be created without a Public IP Address? Changing this forces a new resource to be created.
Fqdn string: The FQDN of the Virtual Machine.
GalleryImageReference WindowsVirtualMachineGalleryImageReference: A gallery_image_reference block as defined below.
InboundNatRules []WindowsVirtualMachineInboundNatRule: One or more inbound_nat_rule blocks as defined below. Changing this forces a new resource to be created.
LabName string: Specifies the name of the Dev Test Lab in which the Virtual Machine should be created. Changing this forces a new resource to be created.
LabSubnetName string: The name of a Subnet within the Dev Test Virtual Network where this machine should exist. Changing this forces a new resource to be created.
LabVirtualNetworkId string: The ID of the Dev Test Virtual Network where this Virtual Machine should be created. Changing this forces a new resource to be created.
Location string: Specifies the supported Azure location where the Dev Test Lab exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Dev Test Machine. Changing this forces a new resource to be created.
Notes string: Any notes about the Virtual Machine.
Password string: The Password associated with the username used to login to this Virtual Machine. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Dev Test Lab resource exists. Changing this forces a new resource to be created.
Size string: The Machine Size to use for this Virtual Machine, such as Standard_F2. Changing this forces a new resource to be created.
StorageType string: The type of Storage to use on this Virtual Machine. Possible values are Standard and Premium.
Tags map[string]string: A mapping of tags to assign to the resource.
UniqueIdentifier string: The unique immutable identifier of the Virtual Machine.
Username string: The Username associated with the local administrator on this Virtual Machine. Changing this forces a new resource to be created.

allowClaim boolean: Can this Virtual Machine be claimed by users? Defaults to true.
disallowPublicIpAddress boolean: Should the Virtual Machine be created without a Public IP Address? Changing this forces a new resource to be created.
fqdn string: The FQDN of the Virtual Machine.
galleryImageReference WindowsVirtualMachineGalleryImageReference: A gallery_image_reference block as defined below.
inboundNatRules WindowsVirtualMachineInboundNatRule[]: One or more inbound_nat_rule blocks as defined below. Changing this forces a new resource to be created.
labName string: Specifies the name of the Dev Test Lab in which the Virtual Machine should be created. Changing this forces a new resource to be created.
labSubnetName string: The name of a Subnet within the Dev Test Virtual Network where this machine should exist. Changing this forces a new resource to be created.
labVirtualNetworkId string: The ID of the Dev Test Virtual Network where this Virtual Machine should be created. Changing this forces a new resource to be created.
location string: Specifies the supported Azure location where the Dev Test Lab exists. Changing this forces a new resource to be created.
name string: Specifies the name of the Dev Test Machine. Changing this forces a new resource to be created.
notes string: Any notes about the Virtual Machine.
password string: The Password associated with the username used to login to this Virtual Machine. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which the Dev Test Lab resource exists. Changing this forces a new resource to be created.
size string: The Machine Size to use for this Virtual Machine, such as Standard_F2. Changing this forces a new resource to be created.
storageType string: The type of Storage to use on this Virtual Machine. Possible values are Standard and Premium.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
uniqueIdentifier string: The unique immutable identifier of the Virtual Machine.
username string: The Username associated with the local administrator on this Virtual Machine. Changing this forces a new resource to be created.

allow_claim bool: Can this Virtual Machine be claimed by users? Defaults to true.
disallow_public_ip_address bool: Should the Virtual Machine be created without a Public IP Address? Changing this forces a new resource to be created.
fqdn str: The FQDN of the Virtual Machine.
gallery_image_reference Dict[WindowsVirtualMachineGalleryImageReference]: A gallery_image_reference block as defined below.
inbound_nat_rules List[WindowsVirtualMachineInboundNatRule]: One or more inbound_nat_rule blocks as defined below. Changing this forces a new resource to be created.
lab_name str: Specifies the name of the Dev Test Lab in which the Virtual Machine should be created. Changing this forces a new resource to be created.
lab_subnet_name str: The name of a Subnet within the Dev Test Virtual Network where this machine should exist. Changing this forces a new resource to be created.
lab_virtual_network_id str: The ID of the Dev Test Virtual Network where this Virtual Machine should be created. Changing this forces a new resource to be created.
location str: Specifies the supported Azure location where the Dev Test Lab exists. Changing this forces a new resource to be created.
name str: Specifies the name of the Dev Test Machine. Changing this forces a new resource to be created.
notes str: Any notes about the Virtual Machine.
password str: The Password associated with the username used to login to this Virtual Machine. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which the Dev Test Lab resource exists. Changing this forces a new resource to be created.
size str: The Machine Size to use for this Virtual Machine, such as Standard_F2. Changing this forces a new resource to be created.
storage_type str: The type of Storage to use on this Virtual Machine. Possible values are Standard and Premium.
tags Dict[str, str]: A mapping of tags to assign to the resource.
unique_identifier str: The unique immutable identifier of the Virtual Machine.
username str: The Username associated with the local administrator on this Virtual Machine. Changing this forces a new resource to be created.

Supporting Types

WindowsVirtualMachineGalleryImageReference

See the input and output API doc for this type.

Offer string: The Offer of the Gallery Image. Changing this forces a new resource to be created.
Publisher string: The Publisher of the Gallery Image. Changing this forces a new resource to be created.
Sku string: The SKU of the Gallery Image. Changing this forces a new resource to be created.
Version string: The Version of the Gallery Image. Changing this forces a new resource to be created.

Offer string: The Offer of the Gallery Image. Changing this forces a new resource to be created.
Publisher string: The Publisher of the Gallery Image. Changing this forces a new resource to be created.
Sku string: The SKU of the Gallery Image. Changing this forces a new resource to be created.
Version string: The Version of the Gallery Image. Changing this forces a new resource to be created.

offer string: The Offer of the Gallery Image. Changing this forces a new resource to be created.
publisher string: The Publisher of the Gallery Image. Changing this forces a new resource to be created.
sku string: The SKU of the Gallery Image. Changing this forces a new resource to be created.
version string: The Version of the Gallery Image. Changing this forces a new resource to be created.

offer str: The Offer of the Gallery Image. Changing this forces a new resource to be created.
publisher str: The Publisher of the Gallery Image. Changing this forces a new resource to be created.
sku str: The SKU of the Gallery Image. Changing this forces a new resource to be created.
version str: The Version of the Gallery Image. Changing this forces a new resource to be created.

WindowsVirtualMachineInboundNatRule

See the input and output API doc for this type.

BackendPort int: The Backend Port associated with this NAT Rule. Changing this forces a new resource to be created.
Protocol string: The Protocol used for this NAT Rule. Possible values are Tcp and Udp. Changing this forces a new resource to be created.
FrontendPort int: The frontend port associated with this Inbound NAT Rule.

BackendPort int: The Backend Port associated with this NAT Rule. Changing this forces a new resource to be created.
Protocol string: The Protocol used for this NAT Rule. Possible values are Tcp and Udp. Changing this forces a new resource to be created.
FrontendPort int: The frontend port associated with this Inbound NAT Rule.

backendPort number: The Backend Port associated with this NAT Rule. Changing this forces a new resource to be created.
protocol string: The Protocol used for this NAT Rule. Possible values are Tcp and Udp. Changing this forces a new resource to be created.
frontendPort number: The frontend port associated with this Inbound NAT Rule.

backend_port float: The Backend Port associated with this NAT Rule. Changing this forces a new resource to be created.
protocol str: The Protocol used for this NAT Rule. Possible values are Tcp and Udp. Changing this forces a new resource to be created.
frontend_port float: The frontend port associated with this Inbound NAT Rule.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud