azure-native.labservices.EnvironmentSetting
Explore with Pulumi AI
Represents settings of an environment, from which environment instances would be created Azure REST API version: 2018-10-15. Prior API version in Azure Native 1.x: 2018-10-15.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:labservices:EnvironmentSetting myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}
Create EnvironmentSetting Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new EnvironmentSetting(name: string, args: EnvironmentSettingArgs, opts?: CustomResourceOptions);
@overload
def EnvironmentSetting(resource_name: str,
args: EnvironmentSettingArgs,
opts: Optional[ResourceOptions] = None)
@overload
def EnvironmentSetting(resource_name: str,
opts: Optional[ResourceOptions] = None,
lab_account_name: Optional[str] = None,
lab_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
resource_settings: Optional[ResourceSettingsArgs] = None,
configuration_state: Optional[Union[str, ConfigurationState]] = None,
description: Optional[str] = None,
environment_setting_name: Optional[str] = None,
location: Optional[str] = None,
provisioning_state: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
title: Optional[str] = None,
unique_identifier: Optional[str] = None)
func NewEnvironmentSetting(ctx *Context, name string, args EnvironmentSettingArgs, opts ...ResourceOption) (*EnvironmentSetting, error)
public EnvironmentSetting(string name, EnvironmentSettingArgs args, CustomResourceOptions? opts = null)
public EnvironmentSetting(String name, EnvironmentSettingArgs args)
public EnvironmentSetting(String name, EnvironmentSettingArgs args, CustomResourceOptions options)
type: azure-native:labservices:EnvironmentSetting
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args EnvironmentSettingArgs
- 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 EnvironmentSettingArgs
- 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 EnvironmentSettingArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EnvironmentSettingArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EnvironmentSettingArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var environmentSettingResource = new AzureNative.LabServices.EnvironmentSetting("environmentSettingResource", new()
{
LabAccountName = "string",
LabName = "string",
ResourceGroupName = "string",
ResourceSettings = new AzureNative.LabServices.Inputs.ResourceSettingsArgs
{
ReferenceVm = new AzureNative.LabServices.Inputs.ReferenceVmArgs
{
UserName = "string",
Password = "string",
},
GalleryImageResourceId = "string",
Size = "string",
},
ConfigurationState = "string",
Description = "string",
EnvironmentSettingName = "string",
Location = "string",
ProvisioningState = "string",
Tags =
{
{ "string", "string" },
},
Title = "string",
UniqueIdentifier = "string",
});
example, err := labservices.NewEnvironmentSetting(ctx, "environmentSettingResource", &labservices.EnvironmentSettingArgs{
LabAccountName: pulumi.String("string"),
LabName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
ResourceSettings: &labservices.ResourceSettingsArgs{
ReferenceVm: &labservices.ReferenceVmArgs{
UserName: pulumi.String("string"),
Password: pulumi.String("string"),
},
GalleryImageResourceId: pulumi.String("string"),
Size: pulumi.String("string"),
},
ConfigurationState: pulumi.String("string"),
Description: pulumi.String("string"),
EnvironmentSettingName: pulumi.String("string"),
Location: pulumi.String("string"),
ProvisioningState: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Title: pulumi.String("string"),
UniqueIdentifier: pulumi.String("string"),
})
var environmentSettingResource = new EnvironmentSetting("environmentSettingResource", EnvironmentSettingArgs.builder()
.labAccountName("string")
.labName("string")
.resourceGroupName("string")
.resourceSettings(ResourceSettingsArgs.builder()
.referenceVm(ReferenceVmArgs.builder()
.userName("string")
.password("string")
.build())
.galleryImageResourceId("string")
.size("string")
.build())
.configurationState("string")
.description("string")
.environmentSettingName("string")
.location("string")
.provisioningState("string")
.tags(Map.of("string", "string"))
.title("string")
.uniqueIdentifier("string")
.build());
environment_setting_resource = azure_native.labservices.EnvironmentSetting("environmentSettingResource",
lab_account_name="string",
lab_name="string",
resource_group_name="string",
resource_settings=azure_native.labservices.ResourceSettingsArgs(
reference_vm=azure_native.labservices.ReferenceVmArgs(
user_name="string",
password="string",
),
gallery_image_resource_id="string",
size="string",
),
configuration_state="string",
description="string",
environment_setting_name="string",
location="string",
provisioning_state="string",
tags={
"string": "string",
},
title="string",
unique_identifier="string")
const environmentSettingResource = new azure_native.labservices.EnvironmentSetting("environmentSettingResource", {
labAccountName: "string",
labName: "string",
resourceGroupName: "string",
resourceSettings: {
referenceVm: {
userName: "string",
password: "string",
},
galleryImageResourceId: "string",
size: "string",
},
configurationState: "string",
description: "string",
environmentSettingName: "string",
location: "string",
provisioningState: "string",
tags: {
string: "string",
},
title: "string",
uniqueIdentifier: "string",
});
type: azure-native:labservices:EnvironmentSetting
properties:
configurationState: string
description: string
environmentSettingName: string
labAccountName: string
labName: string
location: string
provisioningState: string
resourceGroupName: string
resourceSettings:
galleryImageResourceId: string
referenceVm:
password: string
userName: string
size: string
tags:
string: string
title: string
uniqueIdentifier: string
EnvironmentSetting 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 EnvironmentSetting resource accepts the following input properties:
- Lab
Account stringName - The name of the lab Account.
- Lab
Name string - The name of the lab.
- Resource
Group stringName - The name of the resource group.
- Resource
Settings Pulumi.Azure Native. Lab Services. Inputs. Resource Settings - The resource specific settings
- Configuration
State string | Pulumi.Azure Native. Lab Services. Configuration State - Describes the user's progress in configuring their environment setting
- Description string
- Describes the environment and its resource settings
- Environment
Setting stringName - The name of the environment Setting.
- Location string
- The location of the resource.
- Provisioning
State string - The provisioning status of the resource.
- Dictionary<string, string>
- The tags of the resource.
- Title string
- Brief title describing the environment and its resource settings
- Unique
Identifier string - The unique immutable identifier of a resource (Guid).
- Lab
Account stringName - The name of the lab Account.
- Lab
Name string - The name of the lab.
- Resource
Group stringName - The name of the resource group.
- Resource
Settings ResourceSettings Args - The resource specific settings
- Configuration
State string | ConfigurationState - Describes the user's progress in configuring their environment setting
- Description string
- Describes the environment and its resource settings
- Environment
Setting stringName - The name of the environment Setting.
- Location string
- The location of the resource.
- Provisioning
State string - The provisioning status of the resource.
- map[string]string
- The tags of the resource.
- Title string
- Brief title describing the environment and its resource settings
- Unique
Identifier string - The unique immutable identifier of a resource (Guid).
- lab
Account StringName - The name of the lab Account.
- lab
Name String - The name of the lab.
- resource
Group StringName - The name of the resource group.
- resource
Settings ResourceSettings - The resource specific settings
- configuration
State String | ConfigurationState - Describes the user's progress in configuring their environment setting
- description String
- Describes the environment and its resource settings
- environment
Setting StringName - The name of the environment Setting.
- location String
- The location of the resource.
- provisioning
State String - The provisioning status of the resource.
- Map<String,String>
- The tags of the resource.
- title String
- Brief title describing the environment and its resource settings
- unique
Identifier String - The unique immutable identifier of a resource (Guid).
- lab
Account stringName - The name of the lab Account.
- lab
Name string - The name of the lab.
- resource
Group stringName - The name of the resource group.
- resource
Settings ResourceSettings - The resource specific settings
- configuration
State string | ConfigurationState - Describes the user's progress in configuring their environment setting
- description string
- Describes the environment and its resource settings
- environment
Setting stringName - The name of the environment Setting.
- location string
- The location of the resource.
- provisioning
State string - The provisioning status of the resource.
- {[key: string]: string}
- The tags of the resource.
- title string
- Brief title describing the environment and its resource settings
- unique
Identifier string - The unique immutable identifier of a resource (Guid).
- lab_
account_ strname - The name of the lab Account.
- lab_
name str - The name of the lab.
- resource_
group_ strname - The name of the resource group.
- resource_
settings ResourceSettings Args - The resource specific settings
- configuration_
state str | ConfigurationState - Describes the user's progress in configuring their environment setting
- description str
- Describes the environment and its resource settings
- environment_
setting_ strname - The name of the environment Setting.
- location str
- The location of the resource.
- provisioning_
state str - The provisioning status of the resource.
- Mapping[str, str]
- The tags of the resource.
- title str
- Brief title describing the environment and its resource settings
- unique_
identifier str - The unique immutable identifier of a resource (Guid).
- lab
Account StringName - The name of the lab Account.
- lab
Name String - The name of the lab.
- resource
Group StringName - The name of the resource group.
- resource
Settings Property Map - The resource specific settings
- configuration
State String | "NotApplicable" | "Completed" - Describes the user's progress in configuring their environment setting
- description String
- Describes the environment and its resource settings
- environment
Setting StringName - The name of the environment Setting.
- location String
- The location of the resource.
- provisioning
State String - The provisioning status of the resource.
- Map<String>
- The tags of the resource.
- title String
- Brief title describing the environment and its resource settings
- unique
Identifier String - The unique immutable identifier of a resource (Guid).
Outputs
All input properties are implicitly available as output properties. Additionally, the EnvironmentSetting resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Changed string - Time when the template VM was last changed.
- Last
Published string - Time when the template VM was last sent for publishing.
- Latest
Operation Pulumi.Result Azure Native. Lab Services. Outputs. Latest Operation Result Response - The details of the latest operation. ex: status, error
- Name string
- The name of the resource.
- Publishing
State string - Describes the readiness of this environment setting
- Type string
- The type of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Changed string - Time when the template VM was last changed.
- Last
Published string - Time when the template VM was last sent for publishing.
- Latest
Operation LatestResult Operation Result Response - The details of the latest operation. ex: status, error
- Name string
- The name of the resource.
- Publishing
State string - Describes the readiness of this environment setting
- Type string
- The type of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Changed String - Time when the template VM was last changed.
- last
Published String - Time when the template VM was last sent for publishing.
- latest
Operation LatestResult Operation Result Response - The details of the latest operation. ex: status, error
- name String
- The name of the resource.
- publishing
State String - Describes the readiness of this environment setting
- type String
- The type of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Changed string - Time when the template VM was last changed.
- last
Published string - Time when the template VM was last sent for publishing.
- latest
Operation LatestResult Operation Result Response - The details of the latest operation. ex: status, error
- name string
- The name of the resource.
- publishing
State string - Describes the readiness of this environment setting
- type string
- The type of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
changed str - Time when the template VM was last changed.
- last_
published str - Time when the template VM was last sent for publishing.
- latest_
operation_ Latestresult Operation Result Response - The details of the latest operation. ex: status, error
- name str
- The name of the resource.
- publishing_
state str - Describes the readiness of this environment setting
- type str
- The type of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Changed String - Time when the template VM was last changed.
- last
Published String - Time when the template VM was last sent for publishing.
- latest
Operation Property MapResult - The details of the latest operation. ex: status, error
- name String
- The name of the resource.
- publishing
State String - Describes the readiness of this environment setting
- type String
- The type of the resource.
Supporting Types
ConfigurationState, ConfigurationStateArgs
- Not
Applicable - NotApplicableUser either hasn't started configuring their template or they haven't started the configuration process.
- Completed
- CompletedUser is finished modifying the template.
- Configuration
State Not Applicable - NotApplicableUser either hasn't started configuring their template or they haven't started the configuration process.
- Configuration
State Completed - CompletedUser is finished modifying the template.
- Not
Applicable - NotApplicableUser either hasn't started configuring their template or they haven't started the configuration process.
- Completed
- CompletedUser is finished modifying the template.
- Not
Applicable - NotApplicableUser either hasn't started configuring their template or they haven't started the configuration process.
- Completed
- CompletedUser is finished modifying the template.
- NOT_APPLICABLE
- NotApplicableUser either hasn't started configuring their template or they haven't started the configuration process.
- COMPLETED
- CompletedUser is finished modifying the template.
- "Not
Applicable" - NotApplicableUser either hasn't started configuring their template or they haven't started the configuration process.
- "Completed"
- CompletedUser is finished modifying the template.
LatestOperationResultResponse, LatestOperationResultResponseArgs
- Error
Code string - Error code on failure.
- Error
Message string - The error message.
- Http
Method string - The HttpMethod - PUT/POST/DELETE for the operation.
- Operation
Url string - The URL to use to check long-running operation status
- Request
Uri string - Request URI of the operation.
- Status string
- The current status of the operation.
- Error
Code string - Error code on failure.
- Error
Message string - The error message.
- Http
Method string - The HttpMethod - PUT/POST/DELETE for the operation.
- Operation
Url string - The URL to use to check long-running operation status
- Request
Uri string - Request URI of the operation.
- Status string
- The current status of the operation.
- error
Code String - Error code on failure.
- error
Message String - The error message.
- http
Method String - The HttpMethod - PUT/POST/DELETE for the operation.
- operation
Url String - The URL to use to check long-running operation status
- request
Uri String - Request URI of the operation.
- status String
- The current status of the operation.
- error
Code string - Error code on failure.
- error
Message string - The error message.
- http
Method string - The HttpMethod - PUT/POST/DELETE for the operation.
- operation
Url string - The URL to use to check long-running operation status
- request
Uri 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.
- error
Code String - Error code on failure.
- error
Message String - The error message.
- http
Method String - The HttpMethod - PUT/POST/DELETE for the operation.
- operation
Url String - The URL to use to check long-running operation status
- request
Uri String - Request URI of the operation.
- status String
- The current status of the operation.
ManagedLabVmSize, ManagedLabVmSizeArgs
- Basic
- BasicThe base VM size
- Standard
- StandardThe standard or default VM size
- Performance
- PerformanceThe most performant VM size
- Managed
Lab Vm Size Basic - BasicThe base VM size
- Managed
Lab Vm Size Standard - StandardThe standard or default VM size
- Managed
Lab Vm Size Performance - PerformanceThe most performant VM size
- Basic
- BasicThe base VM size
- Standard
- StandardThe standard or default VM size
- Performance
- PerformanceThe most performant VM size
- Basic
- BasicThe base VM size
- Standard
- StandardThe standard or default VM size
- Performance
- PerformanceThe most performant VM size
- BASIC
- BasicThe base VM size
- STANDARD
- StandardThe standard or default VM size
- PERFORMANCE
- PerformanceThe most performant VM size
- "Basic"
- BasicThe base VM size
- "Standard"
- StandardThe standard or default VM size
- "Performance"
- PerformanceThe most performant VM size
ReferenceVm, ReferenceVmArgs
ReferenceVmResponse, ReferenceVmResponseArgs
- User
Name string - The username of the virtual machine
- Vm
Resource stringId - VM resource Id for the environment
- Vm
State Pulumi.Details Azure Native. Lab Services. Inputs. Vm State Details Response - The state details for the reference virtual machine.
- Password string
- The password of the virtual machine. This will be set to null in GET resource API
- User
Name string - The username of the virtual machine
- Vm
Resource stringId - VM resource Id for the environment
- Vm
State VmDetails State Details Response - The state details for the reference virtual machine.
- Password string
- The password of the virtual machine. This will be set to null in GET resource API
- user
Name String - The username of the virtual machine
- vm
Resource StringId - VM resource Id for the environment
- vm
State VmDetails State Details Response - The state details for the reference virtual machine.
- password String
- The password of the virtual machine. This will be set to null in GET resource API
- user
Name string - The username of the virtual machine
- vm
Resource stringId - VM resource Id for the environment
- vm
State VmDetails State Details Response - The state details for the reference virtual machine.
- password string
- The password of the virtual machine. This will be set to null in GET resource API
- user_
name str - The username of the virtual machine
- vm_
resource_ strid - VM resource Id for the environment
- vm_
state_ Vmdetails State Details Response - The state details for the reference virtual machine.
- password str
- The password of the virtual machine. This will be set to null in GET resource API
- user
Name String - The username of the virtual machine
- vm
Resource StringId - VM resource Id for the environment
- vm
State Property MapDetails - The state details for the reference virtual machine.
- password String
- The password of the virtual machine. This will be set to null in GET resource API
ResourceSettings, ResourceSettingsArgs
- Reference
Vm Pulumi.Azure Native. Lab Services. Inputs. Reference Vm - Details specific to Reference Vm
- Gallery
Image stringResource Id - The resource id of the gallery image used for creating the virtual machine
- Size
string | Pulumi.
Azure Native. Lab Services. Managed Lab Vm Size - The size of the virtual machine
- Reference
Vm ReferenceVm - Details specific to Reference Vm
- Gallery
Image stringResource Id - The resource id of the gallery image used for creating the virtual machine
- Size
string | Managed
Lab Vm Size - The size of the virtual machine
- reference
Vm ReferenceVm - Details specific to Reference Vm
- gallery
Image StringResource Id - The resource id of the gallery image used for creating the virtual machine
- size
String | Managed
Lab Vm Size - The size of the virtual machine
- reference
Vm ReferenceVm - Details specific to Reference Vm
- gallery
Image stringResource Id - The resource id of the gallery image used for creating the virtual machine
- size
string | Managed
Lab Vm Size - The size of the virtual machine
- reference_
vm ReferenceVm - Details specific to Reference Vm
- gallery_
image_ strresource_ id - The resource id of the gallery image used for creating the virtual machine
- size
str | Managed
Lab Vm Size - The size of the virtual machine
- reference
Vm Property Map - Details specific to Reference Vm
- gallery
Image StringResource Id - The resource id of the gallery image used for creating the virtual machine
- size String | "Basic" | "Standard" | "Performance"
- The size of the virtual machine
ResourceSettingsResponse, ResourceSettingsResponseArgs
- Cores int
- The translated compute cores of the virtual machine
- Id string
- The unique id of the resource setting
- Image
Name string - The name of the image used to created the environment setting
- Reference
Vm Pulumi.Azure Native. Lab Services. Inputs. Reference Vm Response - Details specific to Reference Vm
- Gallery
Image stringResource Id - The resource id of the gallery image used for creating the virtual machine
- Size string
- The size of the virtual machine
- Cores int
- The translated compute cores of the virtual machine
- Id string
- The unique id of the resource setting
- Image
Name string - The name of the image used to created the environment setting
- Reference
Vm ReferenceVm Response - Details specific to Reference Vm
- Gallery
Image stringResource Id - The resource id of the gallery image used for creating the virtual machine
- Size string
- The size of the virtual machine
- cores Integer
- The translated compute cores of the virtual machine
- id String
- The unique id of the resource setting
- image
Name String - The name of the image used to created the environment setting
- reference
Vm ReferenceVm Response - Details specific to Reference Vm
- gallery
Image StringResource Id - The resource id of the gallery image used for creating the virtual machine
- size String
- The size of the virtual machine
- cores number
- The translated compute cores of the virtual machine
- id string
- The unique id of the resource setting
- image
Name string - The name of the image used to created the environment setting
- reference
Vm ReferenceVm Response - Details specific to Reference Vm
- gallery
Image stringResource Id - The resource id of the gallery image used for creating the virtual machine
- size string
- The size of the virtual machine
- cores int
- The translated compute cores of the virtual machine
- id str
- The unique id of the resource setting
- image_
name str - The name of the image used to created the environment setting
- reference_
vm ReferenceVm Response - Details specific to Reference Vm
- gallery_
image_ strresource_ id - The resource id of the gallery image used for creating the virtual machine
- size str
- The size of the virtual machine
- cores Number
- The translated compute cores of the virtual machine
- id String
- The unique id of the resource setting
- image
Name String - The name of the image used to created the environment setting
- reference
Vm Property Map - Details specific to Reference Vm
- gallery
Image StringResource Id - The resource id of the gallery image used for creating the virtual machine
- size String
- The size of the virtual machine
VmStateDetailsResponse, VmStateDetailsResponseArgs
- Last
Known stringPower State - Last known compute power state captured in DTL
- Power
State string - The power state of the reference virtual machine.
- string
- The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
- string
- The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.
- Last
Known stringPower State - Last known compute power state captured in DTL
- Power
State string - The power state of the reference virtual machine.
- string
- The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
- string
- The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.
- last
Known StringPower State - Last known compute power state captured in DTL
- power
State String - The power state of the reference virtual machine.
- String
- The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
- String
- The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.
- last
Known stringPower State - Last known compute power state captured in DTL
- power
State string - The power state of the reference virtual machine.
- string
- The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
- string
- The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.
- last_
known_ strpower_ state - Last known compute power state captured in DTL
- power_
state str - The power state of the reference virtual machine.
- str
- The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
- str
- The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.
- last
Known StringPower State - Last known compute power state captured in DTL
- power
State String - The power state of the reference virtual machine.
- String
- The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
- String
- The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0