Azure Native

Pulumi Official
Package maintained by Pulumi
v1.68.2 published on Tuesday, Aug 16, 2022 by Pulumi

Environment

Represents an environment instance API Version: 2018-10-15.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:labservices:Environment myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName} 

Create a Environment Resource

new Environment(name: string, args: EnvironmentArgs, opts?: CustomResourceOptions);
@overload
def Environment(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                environment_name: Optional[str] = None,
                environment_setting_name: Optional[str] = None,
                lab_account_name: Optional[str] = None,
                lab_name: Optional[str] = None,
                location: Optional[str] = None,
                provisioning_state: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                resource_sets: Optional[ResourceSetArgs] = None,
                tags: Optional[Mapping[str, str]] = None,
                unique_identifier: Optional[str] = None)
@overload
def Environment(resource_name: str,
                args: EnvironmentArgs,
                opts: Optional[ResourceOptions] = None)
func NewEnvironment(ctx *Context, name string, args EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
public Environment(string name, EnvironmentArgs args, CustomResourceOptions? opts = null)
public Environment(String name, EnvironmentArgs args)
public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)
type: azure-native:labservices:Environment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args EnvironmentArgs
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 EnvironmentArgs
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 EnvironmentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EnvironmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args EnvironmentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Environment 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 Environment resource accepts the following input properties:

EnvironmentSettingName string

The name of the environment Setting.

LabAccountName string

The name of the lab Account.

LabName string

The name of the lab.

ResourceGroupName string

The name of the resource group.

EnvironmentName string

The name of the environment.

Location string

The location of the resource.

ProvisioningState string

The provisioning status of the resource.

ResourceSets Pulumi.AzureNative.LabServices.Inputs.ResourceSetArgs

The set of a VM and the setting id it was created for

Tags Dictionary<string, string>

The tags of the resource.

UniqueIdentifier string

The unique immutable identifier of a resource (Guid).

EnvironmentSettingName string

The name of the environment Setting.

LabAccountName string

The name of the lab Account.

LabName string

The name of the lab.

ResourceGroupName string

The name of the resource group.

EnvironmentName string

The name of the environment.

Location string

The location of the resource.

ProvisioningState string

The provisioning status of the resource.

ResourceSets ResourceSetArgs

The set of a VM and the setting id it was created for

Tags map[string]string

The tags of the resource.

UniqueIdentifier string

The unique immutable identifier of a resource (Guid).

environmentSettingName String

The name of the environment Setting.

labAccountName String

The name of the lab Account.

labName String

The name of the lab.

resourceGroupName String

The name of the resource group.

environmentName String

The name of the environment.

location String

The location of the resource.

provisioningState String

The provisioning status of the resource.

resourceSets ResourceSetArgs

The set of a VM and the setting id it was created for

tags Map<String,String>

The tags of the resource.

uniqueIdentifier String

The unique immutable identifier of a resource (Guid).

environmentSettingName string

The name of the environment Setting.

labAccountName string

The name of the lab Account.

labName string

The name of the lab.

resourceGroupName string

The name of the resource group.

environmentName string

The name of the environment.

location string

The location of the resource.

provisioningState string

The provisioning status of the resource.

resourceSets ResourceSetArgs

The set of a VM and the setting id it was created for

tags {[key: string]: string}

The tags of the resource.

uniqueIdentifier string

The unique immutable identifier of a resource (Guid).

environment_setting_name str

The name of the environment Setting.

lab_account_name str

The name of the lab Account.

lab_name str

The name of the lab.

resource_group_name str

The name of the resource group.

environment_name str

The name of the environment.

location str

The location of the resource.

provisioning_state str

The provisioning status of the resource.

resource_sets ResourceSetArgs

The set of a VM and the setting id it was created for

tags Mapping[str, str]

The tags of the resource.

unique_identifier str

The unique immutable identifier of a resource (Guid).

environmentSettingName String

The name of the environment Setting.

labAccountName String

The name of the lab Account.

labName String

The name of the lab.

resourceGroupName String

The name of the resource group.

environmentName String

The name of the environment.

location String

The location of the resource.

provisioningState String

The provisioning status of the resource.

resourceSets Property Map

The set of a VM and the setting id it was created for

tags Map<String>

The tags of the resource.

uniqueIdentifier String

The unique immutable identifier of a resource (Guid).

Outputs

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

ClaimedByUserName string

The name or email address of the user who has claimed the environment

ClaimedByUserObjectId string

The AAD object Id of the user who has claimed the environment

ClaimedByUserPrincipalId string

The user principal Id of the user who has claimed the environment

Id string

The provider-assigned unique ID for this managed resource.

IsClaimed bool

Is the environment claimed or not

LastKnownPowerState string

Last known power state of the environment

LatestOperationResult Pulumi.AzureNative.LabServices.Outputs.LatestOperationResultResponse

The details of the latest operation. ex: status, error

Name string

The name of the resource.

NetworkInterface Pulumi.AzureNative.LabServices.Outputs.NetworkInterfaceResponse

Network details of the environment

PasswordLastReset string

When the password was last reset on the environment.

TotalUsage string

How long the environment has been used by a lab user

Type string

The type of the resource.

ClaimedByUserName string

The name or email address of the user who has claimed the environment

ClaimedByUserObjectId string

The AAD object Id of the user who has claimed the environment

ClaimedByUserPrincipalId string

The user principal Id of the user who has claimed the environment

Id string

The provider-assigned unique ID for this managed resource.

IsClaimed bool

Is the environment claimed or not

LastKnownPowerState string

Last known power state of the environment

LatestOperationResult LatestOperationResultResponse

The details of the latest operation. ex: status, error

Name string

The name of the resource.

NetworkInterface NetworkInterfaceResponse

Network details of the environment

PasswordLastReset string

When the password was last reset on the environment.

TotalUsage string

How long the environment has been used by a lab user

Type string

The type of the resource.

claimedByUserName String

The name or email address of the user who has claimed the environment

claimedByUserObjectId String

The AAD object Id of the user who has claimed the environment

claimedByUserPrincipalId String

The user principal Id of the user who has claimed the environment

id String

The provider-assigned unique ID for this managed resource.

isClaimed Boolean

Is the environment claimed or not

lastKnownPowerState String

Last known power state of the environment

latestOperationResult LatestOperationResultResponse

The details of the latest operation. ex: status, error

name String

The name of the resource.

networkInterface NetworkInterfaceResponse

Network details of the environment

passwordLastReset String

When the password was last reset on the environment.

totalUsage String

How long the environment has been used by a lab user

type String

The type of the resource.

claimedByUserName string

The name or email address of the user who has claimed the environment

claimedByUserObjectId string

The AAD object Id of the user who has claimed the environment

claimedByUserPrincipalId string

The user principal Id of the user who has claimed the environment

id string

The provider-assigned unique ID for this managed resource.

isClaimed boolean

Is the environment claimed or not

lastKnownPowerState string

Last known power state of the environment

latestOperationResult LatestOperationResultResponse

The details of the latest operation. ex: status, error

name string

The name of the resource.

networkInterface NetworkInterfaceResponse

Network details of the environment

passwordLastReset string

When the password was last reset on the environment.

totalUsage string

How long the environment has been used by a lab user

type string

The type of the resource.

claimed_by_user_name str

The name or email address of the user who has claimed the environment

claimed_by_user_object_id str

The AAD object Id of the user who has claimed the environment

claimed_by_user_principal_id str

The user principal Id of the user who has claimed the environment

id str

The provider-assigned unique ID for this managed resource.

is_claimed bool

Is the environment claimed or not

last_known_power_state str

Last known power state of the environment

latest_operation_result LatestOperationResultResponse

The details of the latest operation. ex: status, error

name str

The name of the resource.

network_interface NetworkInterfaceResponse

Network details of the environment

password_last_reset str

When the password was last reset on the environment.

total_usage str

How long the environment has been used by a lab user

type str

The type of the resource.

claimedByUserName String

The name or email address of the user who has claimed the environment

claimedByUserObjectId String

The AAD object Id of the user who has claimed the environment

claimedByUserPrincipalId String

The user principal Id of the user who has claimed the environment

id String

The provider-assigned unique ID for this managed resource.

isClaimed Boolean

Is the environment claimed or not

lastKnownPowerState String

Last known power state of the environment

latestOperationResult Property Map

The details of the latest operation. ex: status, error

name String

The name of the resource.

networkInterface Property Map

Network details of the environment

passwordLastReset String

When the password was last reset on the environment.

totalUsage String

How long the environment has been used by a lab user

type String

The type of the resource.

Supporting Types

LatestOperationResultResponse

ErrorCode string

Error code on failure.

ErrorMessage string

The error message.

HttpMethod string

The HttpMethod - PUT/POST/DELETE for the operation.

OperationUrl string

The URL to use to check long-running operation status

RequestUri string

Request URI of the operation.

Status string

The current status of the operation.

ErrorCode string

Error code on failure.

ErrorMessage string

The error message.

HttpMethod string

The HttpMethod - PUT/POST/DELETE for the operation.

OperationUrl string

The URL to use to check long-running operation status

RequestUri string

Request URI of the operation.

Status string

The current status of the operation.

errorCode String

Error code on failure.

errorMessage String

The error message.

httpMethod String

The HttpMethod - PUT/POST/DELETE for the operation.

operationUrl String

The URL to use to check long-running operation status

requestUri String

Request URI of the operation.

status String

The current status of the operation.

errorCode string

Error code on failure.

errorMessage string

The error message.

httpMethod string

The HttpMethod - PUT/POST/DELETE for the operation.

operationUrl string

The URL to use to check long-running operation status

requestUri string

Request URI of the operation.

status string

The current status of the operation.

error_code str

Error code on failure.

error_message str

The error message.

http_method str

The HttpMethod - PUT/POST/DELETE for the operation.

operation_url str

The URL to use to check long-running operation status

request_uri str

Request URI of the operation.

status str

The current status of the operation.

errorCode String

Error code on failure.

errorMessage String

The error message.

httpMethod String

The HttpMethod - PUT/POST/DELETE for the operation.

operationUrl String

The URL to use to check long-running operation status

requestUri String

Request URI of the operation.

status String

The current status of the operation.

NetworkInterfaceResponse

PrivateIpAddress string

PrivateIp address of the Compute VM

RdpAuthority string

Connection information for Windows

SshAuthority string

Connection information for Linux

Username string

Username of the VM

PrivateIpAddress string

PrivateIp address of the Compute VM

RdpAuthority string

Connection information for Windows

SshAuthority string

Connection information for Linux

Username string

Username of the VM

privateIpAddress String

PrivateIp address of the Compute VM

rdpAuthority String

Connection information for Windows

sshAuthority String

Connection information for Linux

username String

Username of the VM

privateIpAddress string

PrivateIp address of the Compute VM

rdpAuthority string

Connection information for Windows

sshAuthority string

Connection information for Linux

username string

Username of the VM

private_ip_address str

PrivateIp address of the Compute VM

rdp_authority str

Connection information for Windows

ssh_authority str

Connection information for Linux

username str

Username of the VM

privateIpAddress String

PrivateIp address of the Compute VM

rdpAuthority String

Connection information for Windows

sshAuthority String

Connection information for Linux

username String

Username of the VM

ResourceSet

ResourceSettingId string

resourceSettingId for the environment

VmResourceId string

VM resource Id for the environment

ResourceSettingId string

resourceSettingId for the environment

VmResourceId string

VM resource Id for the environment

resourceSettingId String

resourceSettingId for the environment

vmResourceId String

VM resource Id for the environment

resourceSettingId string

resourceSettingId for the environment

vmResourceId string

VM resource Id for the environment

resource_setting_id str

resourceSettingId for the environment

vm_resource_id str

VM resource Id for the environment

resourceSettingId String

resourceSettingId for the environment

vmResourceId String

VM resource Id for the environment

ResourceSetResponse

ResourceSettingId string

resourceSettingId for the environment

VmResourceId string

VM resource Id for the environment

ResourceSettingId string

resourceSettingId for the environment

VmResourceId string

VM resource Id for the environment

resourceSettingId String

resourceSettingId for the environment

vmResourceId String

VM resource Id for the environment

resourceSettingId string

resourceSettingId for the environment

vmResourceId string

VM resource Id for the environment

resource_setting_id str

resourceSettingId for the environment

vm_resource_id str

VM resource Id for the environment

resourceSettingId String

resourceSettingId for the environment

vmResourceId String

VM resource Id for the environment

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0