This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

devtest¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.devtest.AwaitableGetLabResult(artifacts_storage_account_id=None, default_premium_storage_account_id=None, default_storage_account_id=None, id=None, key_vault_id=None, location=None, name=None, premium_data_disk_storage_account_id=None, resource_group_name=None, storage_type=None, tags=None, unique_identifier=None)¶

class pulumi_azure.devtest.AwaitableGetVirtualNetworkResult(allowed_subnets=None, id=None, lab_name=None, name=None, resource_group_name=None, subnet_overrides=None, unique_identifier=None)¶

class pulumi_azure.devtest.GetLabResult(artifacts_storage_account_id=None, default_premium_storage_account_id=None, default_storage_account_id=None, id=None, key_vault_id=None, location=None, name=None, premium_data_disk_storage_account_id=None, resource_group_name=None, storage_type=None, tags=None, unique_identifier=None)¶

A collection of values returned by getLab.

artifacts_storage_account_id = None¶: The ID of the Storage Account used for Artifact Storage.

default_premium_storage_account_id = None¶: The ID of the Default Premium Storage Account for this Dev Test Lab.

default_storage_account_id = None¶: The ID of the Default Storage Account for this Dev Test Lab.

id = None¶: The provider-assigned unique ID for this managed resource.

key_vault_id = None¶: The ID of the Key used for this Dev Test Lab.

location = None¶: The Azure location where the Dev Test Lab exists.

premium_data_disk_storage_account_id = None¶: The ID of the Storage Account used for Storage of Premium Data Disk.

storage_type = None¶: The type of storage used by the Dev Test Lab.

tags = None¶: A mapping of tags to assign to the resource.

unique_identifier = None¶: The unique immutable identifier of the Dev Test Lab.

class pulumi_azure.devtest.GetVirtualNetworkResult(allowed_subnets=None, id=None, lab_name=None, name=None, resource_group_name=None, subnet_overrides=None, unique_identifier=None)¶

A collection of values returned by getVirtualNetwork.

allowed_subnets = None¶: The list of subnets enabled for the virtual network as defined below.

id = None¶: The provider-assigned unique ID for this managed resource.

subnet_overrides = None¶: The list of permission overrides for the subnets as defined below.

unique_identifier = None¶: The unique immutable identifier of the virtual network.

class pulumi_azure.devtest.GlobalVMShutdownSchedule(resource_name, opts=None, daily_recurrence_time=None, enabled=None, location=None, notification_settings=None, tags=None, timezone=None, virtual_machine_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages automated shutdown schedules for Azure VMs that are not within an Azure DevTest Lab. While this is part of the DevTest Labs service in Azure, this resource applies only to standard VMs, not DevTest Lab VMs. To manage automated shutdown schedules for DevTest Lab VMs, reference the devtest.Schedule resource

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="eastus")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.2.0/24")
example_network_interface = azure.network.NetworkInterface("exampleNetworkInterface",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    ip_configuration=[{
        "name": "testconfiguration1",
        "subnet_id": example_subnet.id,
        "privateIpAddressAllocation": "Dynamic",
    }])
example_linux_virtual_machine = azure.compute.LinuxVirtualMachine("exampleLinuxVirtualMachine",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    network_interface_ids=[example_network_interface.id],
    size="Standard_B2s",
    source_image_reference={
        "publisher": "Canonical",
        "offer": "UbuntuServer",
        "sku": "16.04-LTS",
        "version": "latest",
    },
    os_disk={
        "name": "myosdisk-%d",
        "caching": "ReadWrite",
        "managedDiskType": "Standard_LRS",
    },
    admin_username="testadmin",
    admin_password="Password1234!",
    disable_password_authentication=False)
example_global_vm_shutdown_schedule = azure.devtest.GlobalVMShutdownSchedule("exampleGlobalVMShutdownSchedule",
    virtual_machine_id=azurerm_virtual_machine["example"]["id"],
    location=example_resource_group.location,
    enabled=True,
    daily_recurrence_time="1100",
    time_zone="Pacific Standard Time",
    notification_settings={
        "enabled": True,
        "timeInMinutes": "60",
        "webhookUrl": "https://sample-webhook-url.example.com",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
daily_recurrence_time (pulumi.Input[str]) – The time each day when the schedule takes effect. Must match the format HHmm where HH is 00-23 and mm is 00-59 (e.g. 0930, 2300, etc.)
enabled (pulumi.Input[bool]) – Whether to enable the schedule. Possible values are true and false. Defaults to true.
location (pulumi.Input[str]) – The location where the schedule is created. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
timezone (pulumi.Input[str]) – The time zone ID (e.g. Pacific Standard time). Refer to this guide for a full list of accepted time zone names.
virtual_machine_id (pulumi.Input[str]) – The resource ID of the target ARM-based Virtual Machine. Changing this forces a new resource to be created.

The notification_settings object supports the following:

enabled (pulumi.Input[bool]) - Whether to enable pre-shutdown notifications. Possible values are true and false. Defaults to false
timeInMinutes (pulumi.Input[float]) - Time in minutes between 15 and 120 before a shutdown event at which a notification will be sent. Defaults to 30.
webhookUrl (pulumi.Input[str]) - The webhook URL to which the notification will be sent. Required if enabled is true. Optional otherwise.

daily_recurrence_time: pulumi.Output[str] = None¶: The time each day when the schedule takes effect. Must match the format HHmm where HH is 00-23 and mm is 00-59 (e.g. 0930, 2300, etc.)

enabled: pulumi.Output[bool] = None¶: Whether to enable the schedule. Possible values are true and false. Defaults to true.

location: pulumi.Output[str] = None¶: The location where the schedule is created. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

timezone: pulumi.Output[str] = None¶: The time zone ID (e.g. Pacific Standard time). Refer to this guide for a full list of accepted time zone names.

virtual_machine_id: pulumi.Output[str] = None¶: The resource ID of the target ARM-based Virtual Machine. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, daily_recurrence_time=None, enabled=None, location=None, notification_settings=None, tags=None, timezone=None, virtual_machine_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
daily_recurrence_time (pulumi.Input[str]) – The time each day when the schedule takes effect. Must match the format HHmm where HH is 00-23 and mm is 00-59 (e.g. 0930, 2300, etc.)
enabled (pulumi.Input[bool]) – Whether to enable the schedule. Possible values are true and false. Defaults to true.
location (pulumi.Input[str]) – The location where the schedule is created. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
timezone (pulumi.Input[str]) –
The time zone ID (e.g. Pacific Standard time). Refer to this guide for a full list of accepted time zone names.
virtual_machine_id (pulumi.Input[str]) – The resource ID of the target ARM-based Virtual Machine. Changing this forces a new resource to be created.

The notification_settings object supports the following:

enabled (pulumi.Input[bool]) - Whether to enable pre-shutdown notifications. Possible values are true and false. Defaults to false
timeInMinutes (pulumi.Input[float]) - Time in minutes between 15 and 120 before a shutdown event at which a notification will be sent. Defaults to 30.
webhookUrl (pulumi.Input[str]) - The webhook URL to which the notification will be sent. Required if enabled is true. Optional otherwise.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.devtest.Lab(resource_name, opts=None, location=None, name=None, resource_group_name=None, storage_type=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Dev Test Lab.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_lab = azure.devtest.Lab("exampleLab",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    tags={
        "Sydney": "Australia",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
location (pulumi.Input[str]) – Specifies the supported Azure location where the Dev Test Lab should exist. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Dev Test Lab. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group under which the Dev Test Lab resource has to be created. Changing this forces a new resource to be created.
storage_type (pulumi.Input[str]) – The type of storage used by the Dev Test Lab. Possible values are Standard and Premium. Defaults to Premium. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

artifacts_storage_account_id: pulumi.Output[str] = None¶: The ID of the Storage Account used for Artifact Storage.

default_premium_storage_account_id: pulumi.Output[str] = None¶: The ID of the Default Premium Storage Account for this Dev Test Lab.

default_storage_account_id: pulumi.Output[str] = None¶: The ID of the Default Storage Account for this Dev Test Lab.

key_vault_id: pulumi.Output[str] = None¶: The ID of the Key used for this Dev Test Lab.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the Dev Test Lab should exist. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Dev Test Lab. Changing this forces a new resource to be created.

premium_data_disk_storage_account_id: pulumi.Output[str] = None¶: The ID of the Storage Account used for Storage of Premium Data Disk.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group under which the Dev Test Lab resource has to be created. Changing this forces a new resource to be created.

storage_type: pulumi.Output[str] = None¶: The type of storage used by the Dev Test Lab. Possible values are Standard and Premium. Defaults to Premium. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

unique_identifier: pulumi.Output[str] = None¶: The unique immutable identifier of the Dev Test Lab.

static get(resource_name, id, opts=None, artifacts_storage_account_id=None, default_premium_storage_account_id=None, default_storage_account_id=None, key_vault_id=None, location=None, name=None, premium_data_disk_storage_account_id=None, resource_group_name=None, storage_type=None, tags=None, unique_identifier=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
artifacts_storage_account_id (pulumi.Input[str]) – The ID of the Storage Account used for Artifact Storage.
default_premium_storage_account_id (pulumi.Input[str]) – The ID of the Default Premium Storage Account for this Dev Test Lab.
default_storage_account_id (pulumi.Input[str]) – The ID of the Default Storage Account for this Dev Test Lab.
key_vault_id (pulumi.Input[str]) – The ID of the Key used for this Dev Test Lab.
location (pulumi.Input[str]) – Specifies the supported Azure location where the Dev Test Lab should exist. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Dev Test Lab. Changing this forces a new resource to be created.
premium_data_disk_storage_account_id (pulumi.Input[str]) – The ID of the Storage Account used for Storage of Premium Data Disk.
resource_group_name (pulumi.Input[str]) – The name of the resource group under which the Dev Test Lab resource has to be created. Changing this forces a new resource to be created.
storage_type (pulumi.Input[str]) – The type of storage used by the Dev Test Lab. Possible values are Standard and Premium. Defaults to Premium. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
unique_identifier (pulumi.Input[str]) – The unique immutable identifier of the Dev Test Lab.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.devtest.LinuxVirtualMachine(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, ssh_key=None, storage_type=None, tags=None, username=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Linux Virtual Machine within a Dev Test Lab.

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
allow_claim (pulumi.Input[bool]) – Can this Virtual Machine be claimed by users? Defaults to true.
disallow_public_ip_address (pulumi.Input[bool]) – Should the Virtual Machine be created without a Public IP Address? Changing this forces a new resource to be created.
gallery_image_reference (pulumi.Input[dict]) – A gallery_image_reference block as defined below.
inbound_nat_rules (pulumi.Input[list]) – One or more inbound_nat_rule blocks as defined below. Changing this forces a new resource to be created.
lab_name (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[str]) – Specifies the supported Azure location where the Dev Test Lab exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Dev Test Machine. Changing this forces a new resource to be created.
notes (pulumi.Input[str]) – Any notes about the Virtual Machine.
password (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[str]) – The Machine Size to use for this Virtual Machine, such as Standard_F2. Changing this forces a new resource to be created.
ssh_key (pulumi.Input[str]) – The SSH Key associated with the username used to login to this Virtual Machine. Changing this forces a new resource to be created.
storage_type (pulumi.Input[str]) – The type of Storage to use on this Virtual Machine. Possible values are Standard and Premium.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
username (pulumi.Input[str]) – The Username associated with the local administrator on this Virtual Machine. Changing this forces a new resource to be created.

The gallery_image_reference object supports the following:

offer (pulumi.Input[str]) - The Offer of the Gallery Image. Changing this forces a new resource to be created.
publisher (pulumi.Input[str]) - The Publisher of the Gallery Image. Changing this forces a new resource to be created.
sku (pulumi.Input[str]) - The SKU of the Gallery Image. Changing this forces a new resource to be created.
version (pulumi.Input[str]) - The Version of the Gallery Image. Changing this forces a new resource to be created.

The inbound_nat_rules object supports the following:

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

allow_claim: pulumi.Output[bool] = None¶: Can this Virtual Machine be claimed by users? Defaults to true.

disallow_public_ip_address: pulumi.Output[bool] = None¶: Should the Virtual Machine be created without a Public IP Address? Changing this forces a new resource to be created.

fqdn: pulumi.Output[str] = None¶: The FQDN of the Virtual Machine.

gallery_image_reference: pulumi.Output[dict] = None¶

A gallery_image_reference block as defined below.

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.

inbound_nat_rules: pulumi.Output[list] = None¶

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

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

lab_name: pulumi.Output[str] = None¶: 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: pulumi.Output[str] = None¶: 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: pulumi.Output[str] = None¶: 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: pulumi.Output[str] = None¶: Specifies the supported Azure location where the Dev Test Lab exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Dev Test Machine. Changing this forces a new resource to be created.

notes: pulumi.Output[str] = None¶: Any notes about the Virtual Machine.

password: pulumi.Output[str] = None¶: 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: pulumi.Output[str] = None¶: The name of the resource group in which the Dev Test Lab resource exists. Changing this forces a new resource to be created.

size: pulumi.Output[str] = None¶: The Machine Size to use for this Virtual Machine, such as Standard_F2. Changing this forces a new resource to be created.

ssh_key: pulumi.Output[str] = None¶: The SSH Key associated with the username used to login to this Virtual Machine. Changing this forces a new resource to be created.

storage_type: pulumi.Output[str] = None¶: The type of Storage to use on this Virtual Machine. Possible values are Standard and Premium.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

unique_identifier: pulumi.Output[str] = None¶: The unique immutable identifier of the Virtual Machine.

username: pulumi.Output[str] = None¶: The Username associated with the local administrator on this Virtual Machine. Changing this forces a new resource to be created.

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, ssh_key=None, storage_type=None, tags=None, unique_identifier=None, username=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
allow_claim (pulumi.Input[bool]) – Can this Virtual Machine be claimed by users? Defaults to true.
disallow_public_ip_address (pulumi.Input[bool]) – Should the Virtual Machine be created without a Public IP Address? Changing this forces a new resource to be created.
fqdn (pulumi.Input[str]) – The FQDN of the Virtual Machine.
gallery_image_reference (pulumi.Input[dict]) – A gallery_image_reference block as defined below.
inbound_nat_rules (pulumi.Input[list]) – One or more inbound_nat_rule blocks as defined below. Changing this forces a new resource to be created.
lab_name (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[str]) – Specifies the supported Azure location where the Dev Test Lab exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Dev Test Machine. Changing this forces a new resource to be created.
notes (pulumi.Input[str]) – Any notes about the Virtual Machine.
password (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[str]) – The Machine Size to use for this Virtual Machine, such as Standard_F2. Changing this forces a new resource to be created.
ssh_key (pulumi.Input[str]) – The SSH Key associated with the username used to login to this Virtual Machine. Changing this forces a new resource to be created.
storage_type (pulumi.Input[str]) – The type of Storage to use on this Virtual Machine. Possible values are Standard and Premium.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
unique_identifier (pulumi.Input[str]) – The unique immutable identifier of the Virtual Machine.
username (pulumi.Input[str]) – The Username associated with the local administrator on this Virtual Machine. Changing this forces a new resource to be created.

The gallery_image_reference object supports the following:

offer (pulumi.Input[str]) - The Offer of the Gallery Image. Changing this forces a new resource to be created.
publisher (pulumi.Input[str]) - The Publisher of the Gallery Image. Changing this forces a new resource to be created.
sku (pulumi.Input[str]) - The SKU of the Gallery Image. Changing this forces a new resource to be created.
version (pulumi.Input[str]) - The Version of the Gallery Image. Changing this forces a new resource to be created.

The inbound_nat_rules object supports the following:

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

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.devtest.Policy(resource_name, opts=None, description=None, evaluator_type=None, fact_data=None, lab_name=None, name=None, policy_set_name=None, resource_group_name=None, tags=None, threshold=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Policy within a Dev Test Policy Set.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_lab = azure.devtest.Lab("exampleLab",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    tags={
        "Sydney": "Australia",
    })
example_policy = azure.devtest.Policy("examplePolicy",
    policy_set_name="default",
    lab_name=example_lab.name,
    resource_group_name=example_resource_group.name,
    fact_data="",
    threshold="999",
    evaluator_type="MaxValuePolicy",
    tags={
        "Acceptance": "Test",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – A description for the Policy.
evaluator_type (pulumi.Input[str]) – The Evaluation Type used for this Policy. Possible values include: ‘AllowedValuesPolicy’, ‘MaxValuePolicy’. Changing this forces a new resource to be created.
fact_data (pulumi.Input[str]) – The Fact Data for this Policy.
lab_name (pulumi.Input[str]) – Specifies the name of the Dev Test Lab in which the Policy should be created. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Dev Test Policy. Possible values are GalleryImage, LabPremiumVmCount, LabTargetCost, LabVmCount, LabVmSize, UserOwnedLabPremiumVmCount, UserOwnedLabVmCount and UserOwnedLabVmCountInSubnet. Changing this forces a new resource to be created.
policy_set_name (pulumi.Input[str]) – Specifies the name of the Policy Set within the Dev Test Lab where this policy should be created. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which the Dev Test Lab resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
threshold (pulumi.Input[str]) – The Threshold for this Policy.

description: pulumi.Output[str] = None¶: A description for the Policy.

evaluator_type: pulumi.Output[str] = None¶: The Evaluation Type used for this Policy. Possible values include: ‘AllowedValuesPolicy’, ‘MaxValuePolicy’. Changing this forces a new resource to be created.

fact_data: pulumi.Output[str] = None¶: The Fact Data for this Policy.

lab_name: pulumi.Output[str] = None¶: Specifies the name of the Dev Test Lab in which the Policy should be created. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Dev Test Policy. Possible values are GalleryImage, LabPremiumVmCount, LabTargetCost, LabVmCount, LabVmSize, UserOwnedLabPremiumVmCount, UserOwnedLabVmCount and UserOwnedLabVmCountInSubnet. Changing this forces a new resource to be created.

policy_set_name: pulumi.Output[str] = None¶: Specifies the name of the Policy Set within the Dev Test Lab where this policy should be created. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which the Dev Test Lab resource exists. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

threshold: pulumi.Output[str] = None¶: The Threshold for this Policy.

static get(resource_name, id, opts=None, description=None, evaluator_type=None, fact_data=None, lab_name=None, name=None, policy_set_name=None, resource_group_name=None, tags=None, threshold=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – A description for the Policy.
evaluator_type (pulumi.Input[str]) – The Evaluation Type used for this Policy. Possible values include: ‘AllowedValuesPolicy’, ‘MaxValuePolicy’. Changing this forces a new resource to be created.
fact_data (pulumi.Input[str]) – The Fact Data for this Policy.
lab_name (pulumi.Input[str]) – Specifies the name of the Dev Test Lab in which the Policy should be created. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Dev Test Policy. Possible values are GalleryImage, LabPremiumVmCount, LabTargetCost, LabVmCount, LabVmSize, UserOwnedLabPremiumVmCount, UserOwnedLabVmCount and UserOwnedLabVmCountInSubnet. Changing this forces a new resource to be created.
policy_set_name (pulumi.Input[str]) – Specifies the name of the Policy Set within the Dev Test Lab where this policy should be created. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which the Dev Test Lab resource exists. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
threshold (pulumi.Input[str]) – The Threshold for this Policy.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.devtest.Schedule(resource_name, opts=None, daily_recurrence=None, hourly_recurrence=None, lab_name=None, location=None, name=None, notification_settings=None, resource_group_name=None, status=None, tags=None, task_type=None, time_zone_id=None, weekly_recurrence=None, __props__=None, __name__=None, __opts__=None)¶

Manages automated startup and shutdown schedules for Azure Dev Test Lab.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_lab = azure.devtest.Lab("exampleLab",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_schedule = azure.devtest.Schedule("exampleSchedule",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    lab_name=example_lab.name,
    weekly_recurrence={
        "time": "1100",
        "week_days": [
            "Monday",
            "Tuesday",
        ],
    },
    time_zone_id="Pacific Standard Time",
    task_type="LabVmsStartupTask",
    notification_settings={},
    tags={
        "environment": "Production",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
lab_name (pulumi.Input[str]) – The name of the dev test lab. Changing this forces a new resource to be created.
location (pulumi.Input[str]) – The location where the schedule is created. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – The name of the dev test lab schedule. Valid value for name depends on the task_type. For instance for task_type LabVmsStartupTask the name needs to be LabVmAutoStart.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the dev test lab schedule. Changing this forces a new resource to be created.
status (pulumi.Input[str]) – The status of this schedule. Possible values are Enabled and Disabled. Defaults to Disabled.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
task_type (pulumi.Input[str]) – The task type of the schedule. Possible values include LabVmsShutdownTask and LabVmAutoStart.
time_zone_id (pulumi.Input[str]) – The time zone ID (e.g. Pacific Standard time).

The daily_recurrence object supports the following:

time (pulumi.Input[str]) - The time each day when the schedule takes effect.

The hourly_recurrence object supports the following:

minute (pulumi.Input[float])

The notification_settings object supports the following:

status (pulumi.Input[str]) - The status of the notification. Possible values are Enabled and Disabled. Defaults to Disabled
timeInMinutes (pulumi.Input[float]) - Time in minutes before event at which notification will be sent.
webhookUrl (pulumi.Input[str]) - The webhook URL to which the notification will be sent.

The weekly_recurrence object supports the following:

time (pulumi.Input[str]) - The time when the schedule takes effect.
week_days (pulumi.Input[list]) - A list of days that this schedule takes effect . Possible values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.

lab_name: pulumi.Output[str] = None¶: The name of the dev test lab. Changing this forces a new resource to be created.

location: pulumi.Output[str] = None¶: The location where the schedule is created. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: The name of the dev test lab schedule. Valid value for name depends on the task_type. For instance for task_type LabVmsStartupTask the name needs to be LabVmAutoStart.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the dev test lab schedule. Changing this forces a new resource to be created.

status: pulumi.Output[str] = None¶: The status of this schedule. Possible values are Enabled and Disabled. Defaults to Disabled.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

task_type: pulumi.Output[str] = None¶: The task type of the schedule. Possible values include LabVmsShutdownTask and LabVmAutoStart.

time_zone_id: pulumi.Output[str] = None¶: The time zone ID (e.g. Pacific Standard time).

static get(resource_name, id, opts=None, daily_recurrence=None, hourly_recurrence=None, lab_name=None, location=None, name=None, notification_settings=None, resource_group_name=None, status=None, tags=None, task_type=None, time_zone_id=None, weekly_recurrence=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
lab_name (pulumi.Input[str]) – The name of the dev test lab. Changing this forces a new resource to be created.
location (pulumi.Input[str]) – The location where the schedule is created. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – The name of the dev test lab schedule. Valid value for name depends on the task_type. For instance for task_type LabVmsStartupTask the name needs to be LabVmAutoStart.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the dev test lab schedule. Changing this forces a new resource to be created.
status (pulumi.Input[str]) – The status of this schedule. Possible values are Enabled and Disabled. Defaults to Disabled.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
task_type (pulumi.Input[str]) – The task type of the schedule. Possible values include LabVmsShutdownTask and LabVmAutoStart.
time_zone_id (pulumi.Input[str]) – The time zone ID (e.g. Pacific Standard time).

The daily_recurrence object supports the following:

time (pulumi.Input[str]) - The time each day when the schedule takes effect.

The hourly_recurrence object supports the following:

minute (pulumi.Input[float])

The notification_settings object supports the following:

status (pulumi.Input[str]) - The status of the notification. Possible values are Enabled and Disabled. Defaults to Disabled
timeInMinutes (pulumi.Input[float]) - Time in minutes before event at which notification will be sent.
webhookUrl (pulumi.Input[str]) - The webhook URL to which the notification will be sent.

The weekly_recurrence object supports the following:

time (pulumi.Input[str]) - The time when the schedule takes effect.
week_days (pulumi.Input[list]) - A list of days that this schedule takes effect . Possible values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.devtest.VirtualNetwork(resource_name, opts=None, description=None, lab_name=None, name=None, resource_group_name=None, subnet=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Virtual Network within a DevTest Lab.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_lab = azure.devtest.Lab("exampleLab",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    tags={
        "Sydney": "Australia",
    })
example_virtual_network = azure.devtest.VirtualNetwork("exampleVirtualNetwork",
    lab_name=example_lab.name,
    resource_group_name=example_resource_group.name,
    subnet={
        "usePublicIpAddress": "Allow",
        "useInVirtualMachineCreation": "Allow",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – A description for the Virtual Network.
lab_name (pulumi.Input[str]) – Specifies the name of the Dev Test Lab in which the Virtual Network should be created. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Dev Test Virtual Network. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which the Dev Test Lab resource exists. Changing this forces a new resource to be created.
subnet (pulumi.Input[dict]) – A subnet block as defined below.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The subnet object supports the following:

name (pulumi.Input[str]) - Specifies the name of the Dev Test Virtual Network. Changing this forces a new resource to be created.
useInVirtualMachineCreation (pulumi.Input[str]) - Can this subnet be used for creating Virtual Machines? Possible values are Allow, Default and Deny.
usePublicIpAddress (pulumi.Input[str]) - Can Virtual Machines in this Subnet use Public IP Addresses? Possible values are Allow, Default and Deny.

description: pulumi.Output[str] = None¶: A description for the Virtual Network.

lab_name: pulumi.Output[str] = None¶: Specifies the name of the Dev Test Lab in which the Virtual Network should be created. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Dev Test Virtual Network. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which the Dev Test Lab resource exists. Changing this forces a new resource to be created.

subnet: pulumi.Output[dict] = None¶

A subnet block as defined below.

name (str) - Specifies the name of the Dev Test Virtual Network. Changing this forces a new resource to be created.
useInVirtualMachineCreation (str) - Can this subnet be used for creating Virtual Machines? Possible values are Allow, Default and Deny.
usePublicIpAddress (str) - Can Virtual Machines in this Subnet use Public IP Addresses? Possible values are Allow, Default and Deny.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

unique_identifier: pulumi.Output[str] = None¶: The unique immutable identifier of the Dev Test Virtual Network.

static get(resource_name, id, opts=None, description=None, lab_name=None, name=None, resource_group_name=None, subnet=None, tags=None, unique_identifier=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – A description for the Virtual Network.
lab_name (pulumi.Input[str]) – Specifies the name of the Dev Test Lab in which the Virtual Network should be created. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Dev Test Virtual Network. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which the Dev Test Lab resource exists. Changing this forces a new resource to be created.
subnet (pulumi.Input[dict]) – A subnet block as defined below.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
unique_identifier (pulumi.Input[str]) – The unique immutable identifier of the Dev Test Virtual Network.

The subnet object supports the following:

name (pulumi.Input[str]) - Specifies the name of the Dev Test Virtual Network. Changing this forces a new resource to be created.
useInVirtualMachineCreation (pulumi.Input[str]) - Can this subnet be used for creating Virtual Machines? Possible values are Allow, Default and Deny.
usePublicIpAddress (pulumi.Input[str]) - Can Virtual Machines in this Subnet use Public IP Addresses? Possible values are Allow, Default and Deny.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.devtest.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, __name__=None, __opts__=None)¶

Manages a Windows Virtual Machine within a Dev Test Lab.

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
allow_claim (pulumi.Input[bool]) – Can this Virtual Machine be claimed by users? Defaults to true.
disallow_public_ip_address (pulumi.Input[bool]) – Should the Virtual Machine be created without a Public IP Address? Changing this forces a new resource to be created.
gallery_image_reference (pulumi.Input[dict]) – A gallery_image_reference block as defined below.
inbound_nat_rules (pulumi.Input[list]) – One or more inbound_nat_rule blocks as defined below. Changing this forces a new resource to be created.
lab_name (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[str]) – Specifies the supported Azure location where the Dev Test Lab exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Dev Test Machine. Changing this forces a new resource to be created.
notes (pulumi.Input[str]) – Any notes about the Virtual Machine.
password (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[str]) – The type of Storage to use on this Virtual Machine. Possible values are Standard and Premium.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
username (pulumi.Input[str]) – The Username associated with the local administrator on this Virtual Machine. Changing this forces a new resource to be created.

The gallery_image_reference object supports the following:

offer (pulumi.Input[str]) - The Offer of the Gallery Image. Changing this forces a new resource to be created.
publisher (pulumi.Input[str]) - The Publisher of the Gallery Image. Changing this forces a new resource to be created.
sku (pulumi.Input[str]) - The SKU of the Gallery Image. Changing this forces a new resource to be created.
version (pulumi.Input[str]) - The Version of the Gallery Image. Changing this forces a new resource to be created.

The inbound_nat_rules object supports the following:

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

allow_claim: pulumi.Output[bool] = None¶: Can this Virtual Machine be claimed by users? Defaults to true.

disallow_public_ip_address: pulumi.Output[bool] = None¶: Should the Virtual Machine be created without a Public IP Address? Changing this forces a new resource to be created.

fqdn: pulumi.Output[str] = None¶: The FQDN of the Virtual Machine.

gallery_image_reference: pulumi.Output[dict] = None¶

A gallery_image_reference block as defined below.

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.

inbound_nat_rules: pulumi.Output[list] = None¶

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

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

lab_name: pulumi.Output[str] = None¶: 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: pulumi.Output[str] = None¶: 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: pulumi.Output[str] = None¶: 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: pulumi.Output[str] = None¶: Specifies the supported Azure location where the Dev Test Lab exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Dev Test Machine. Changing this forces a new resource to be created.

notes: pulumi.Output[str] = None¶: Any notes about the Virtual Machine.

password: pulumi.Output[str] = None¶: 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: pulumi.Output[str] = None¶: The name of the resource group in which the Dev Test Lab resource exists. Changing this forces a new resource to be created.

size: pulumi.Output[str] = None¶: The Machine Size to use for this Virtual Machine, such as Standard_F2. Changing this forces a new resource to be created.

storage_type: pulumi.Output[str] = None¶: The type of Storage to use on this Virtual Machine. Possible values are Standard and Premium.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

unique_identifier: pulumi.Output[str] = None¶: The unique immutable identifier of the Virtual Machine.

username: pulumi.Output[str] = None¶: The Username associated with the local administrator on this Virtual Machine. Changing this forces a new resource to be created.

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)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
allow_claim (pulumi.Input[bool]) – Can this Virtual Machine be claimed by users? Defaults to true.
disallow_public_ip_address (pulumi.Input[bool]) – Should the Virtual Machine be created without a Public IP Address? Changing this forces a new resource to be created.
fqdn (pulumi.Input[str]) – The FQDN of the Virtual Machine.
gallery_image_reference (pulumi.Input[dict]) – A gallery_image_reference block as defined below.
inbound_nat_rules (pulumi.Input[list]) – One or more inbound_nat_rule blocks as defined below. Changing this forces a new resource to be created.
lab_name (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[str]) – Specifies the supported Azure location where the Dev Test Lab exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the Dev Test Machine. Changing this forces a new resource to be created.
notes (pulumi.Input[str]) – Any notes about the Virtual Machine.
password (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[str]) – The type of Storage to use on this Virtual Machine. Possible values are Standard and Premium.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
unique_identifier (pulumi.Input[str]) – The unique immutable identifier of the Virtual Machine.
username (pulumi.Input[str]) – The Username associated with the local administrator on this Virtual Machine. Changing this forces a new resource to be created.

The gallery_image_reference object supports the following:

offer (pulumi.Input[str]) - The Offer of the Gallery Image. Changing this forces a new resource to be created.
publisher (pulumi.Input[str]) - The Publisher of the Gallery Image. Changing this forces a new resource to be created.
sku (pulumi.Input[str]) - The SKU of the Gallery Image. Changing this forces a new resource to be created.
version (pulumi.Input[str]) - The Version of the Gallery Image. Changing this forces a new resource to be created.

The inbound_nat_rules object supports the following:

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

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_azure.devtest.get_lab(name=None, resource_group_name=None, opts=None)¶

Use this data source to access information about an existing Dev Test Lab.

import pulumi
import pulumi_azure as azure

example = azure.devtest.get_lab(name="example-lab",
    resource_group_name="example-resources")
pulumi.export("uniqueIdentifier", example.unique_identifier)

Parameters

name (str) – The name of the Dev Test Lab.
resource_group_name (str) – The Name of the Resource Group where the Dev Test Lab exists.

pulumi_azure.devtest.get_virtual_network(lab_name=None, name=None, resource_group_name=None, opts=None)¶

Use this data source to access information about an existing Dev Test Lab Virtual Network.

import pulumi
import pulumi_azure as azure

example = azure.devtest.get_virtual_network(name="example-network",
    lab_name="examplelab",
    resource_group_name="example-resource")
pulumi.export("labSubnetName", example.allowed_subnets[0]["lab_subnet_name"])

Parameters

lab_name (str) – Specifies the name of the Dev Test Lab.
name (str) – Specifies the name of the Virtual Network.
resource_group_name (str) – Specifies the name of the resource group that contains the Virtual Network.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

devtest¶

On This Page