azure-native.labservices.EnvironmentSetting
Explore with Pulumi AI
Represents settings of an environment, from which environment instances would be created 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: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 = 
    {
        { "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",
});
example, err := labservices.NewEnvironmentSetting(ctx, "environmentSettingResource", &labservices.EnvironmentSettingArgs{
	LabAccountName:    "string",
	LabName:           "string",
	ResourceGroupName: "string",
	ResourceSettings: map[string]interface{}{
		"referenceVm": map[string]interface{}{
			"userName": "string",
			"password": "string",
		},
		"galleryImageResourceId": "string",
		"size":                   "string",
	},
	ConfigurationState:     "string",
	Description:            "string",
	EnvironmentSettingName: "string",
	Location:               "string",
	ProvisioningState:      "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
	Title:            "string",
	UniqueIdentifier: "string",
})
var environmentSettingResource = new EnvironmentSetting("environmentSettingResource", EnvironmentSettingArgs.builder()
    .labAccountName("string")
    .labName("string")
    .resourceGroupName("string")
    .resourceSettings(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .configurationState("string")
    .description("string")
    .environmentSettingName("string")
    .location("string")
    .provisioningState("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .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={
        referenceVm: {
            userName: string,
            password: string,
        },
        galleryImageResourceId: 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The EnvironmentSetting resource accepts the following input properties:
- LabAccount stringName 
- The name of the lab Account.
- LabName string
- The name of the lab.
- ResourceGroup stringName 
- The name of the resource group.
- ResourceSettings Pulumi.Azure Native. Lab Services. Inputs. Resource Settings 
- The resource specific settings
- ConfigurationState 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
- EnvironmentSetting stringName 
- The name of the environment Setting.
- Location string
- The location of the resource.
- ProvisioningState 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
- UniqueIdentifier string
- The unique immutable identifier of a resource (Guid).
- LabAccount stringName 
- The name of the lab Account.
- LabName string
- The name of the lab.
- ResourceGroup stringName 
- The name of the resource group.
- ResourceSettings ResourceSettings Args 
- The resource specific settings
- ConfigurationState string | ConfigurationState 
- Describes the user's progress in configuring their environment setting
- Description string
- Describes the environment and its resource settings
- EnvironmentSetting stringName 
- The name of the environment Setting.
- Location string
- The location of the resource.
- ProvisioningState 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
- UniqueIdentifier string
- The unique immutable identifier of a resource (Guid).
- labAccount StringName 
- The name of the lab Account.
- labName String
- The name of the lab.
- resourceGroup StringName 
- The name of the resource group.
- resourceSettings ResourceSettings 
- The resource specific settings
- configurationState String | ConfigurationState 
- Describes the user's progress in configuring their environment setting
- description String
- Describes the environment and its resource settings
- environmentSetting StringName 
- The name of the environment Setting.
- location String
- The location of the resource.
- provisioningState 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
- uniqueIdentifier String
- The unique immutable identifier of a resource (Guid).
- labAccount stringName 
- The name of the lab Account.
- labName string
- The name of the lab.
- resourceGroup stringName 
- The name of the resource group.
- resourceSettings ResourceSettings 
- The resource specific settings
- configurationState string | ConfigurationState 
- Describes the user's progress in configuring their environment setting
- description string
- Describes the environment and its resource settings
- environmentSetting stringName 
- The name of the environment Setting.
- location string
- The location of the resource.
- provisioningState 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
- uniqueIdentifier 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).
- labAccount StringName 
- The name of the lab Account.
- labName String
- The name of the lab.
- resourceGroup StringName 
- The name of the resource group.
- resourceSettings Property Map
- The resource specific settings
- configurationState String | "NotApplicable" | "Completed" 
- Describes the user's progress in configuring their environment setting
- description String
- Describes the environment and its resource settings
- environmentSetting StringName 
- The name of the environment Setting.
- location String
- The location of the resource.
- provisioningState 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
- uniqueIdentifier 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.
- LastChanged string
- Time when the template VM was last changed.
- LastPublished string
- Time when the template VM was last sent for publishing.
- LatestOperation 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.
- PublishingState 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.
- LastChanged string
- Time when the template VM was last changed.
- LastPublished string
- Time when the template VM was last sent for publishing.
- LatestOperation LatestResult Operation Result Response 
- The details of the latest operation. ex: status, error
- Name string
- The name of the resource.
- PublishingState 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.
- lastChanged String
- Time when the template VM was last changed.
- lastPublished String
- Time when the template VM was last sent for publishing.
- latestOperation LatestResult Operation Result Response 
- The details of the latest operation. ex: status, error
- name String
- The name of the resource.
- publishingState 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.
- lastChanged string
- Time when the template VM was last changed.
- lastPublished string
- Time when the template VM was last sent for publishing.
- latestOperation LatestResult Operation Result Response 
- The details of the latest operation. ex: status, error
- name string
- The name of the resource.
- publishingState 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.
- lastChanged String
- Time when the template VM was last changed.
- lastPublished String
- Time when the template VM was last sent for publishing.
- latestOperation Property MapResult 
- The details of the latest operation. ex: status, error
- name String
- The name of the resource.
- publishingState String
- Describes the readiness of this environment setting
- type String
- The type of the resource.
Supporting Types
ConfigurationState, ConfigurationStateArgs    
- NotApplicable 
- NotApplicableUser either hasn't started configuring their template or they haven't started the configuration process.
- Completed
- CompletedUser is finished modifying the template.
- ConfigurationState Not Applicable 
- NotApplicableUser either hasn't started configuring their template or they haven't started the configuration process.
- ConfigurationState Completed 
- CompletedUser is finished modifying the template.
- NotApplicable 
- NotApplicableUser either hasn't started configuring their template or they haven't started the configuration process.
- Completed
- CompletedUser is finished modifying the template.
- NotApplicable 
- 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.
- "NotApplicable" 
- 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        
- 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.
ManagedLabVmSize, ManagedLabVmSizeArgs        
- Basic
- BasicThe base VM size
- Standard
- StandardThe standard or default VM size
- Performance
- PerformanceThe most performant VM size
- ManagedLab Vm Size Basic 
- BasicThe base VM size
- ManagedLab Vm Size Standard 
- StandardThe standard or default VM size
- ManagedLab 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      
- UserName string
- The username of the virtual machine
- VmResource stringId 
- VM resource Id for the environment
- VmState 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
- UserName string
- The username of the virtual machine
- VmResource stringId 
- VM resource Id for the environment
- VmState 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
- userName String
- The username of the virtual machine
- vmResource StringId 
- VM resource Id for the environment
- vmState 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
- userName string
- The username of the virtual machine
- vmResource stringId 
- VM resource Id for the environment
- vmState 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
- userName String
- The username of the virtual machine
- vmResource StringId 
- VM resource Id for the environment
- vmState 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    
- ReferenceVm Pulumi.Azure Native. Lab Services. Inputs. Reference Vm 
- Details specific to Reference Vm
- GalleryImage 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
- ReferenceVm ReferenceVm 
- Details specific to Reference Vm
- GalleryImage stringResource Id 
- The resource id of the gallery image used for creating the virtual machine
- Size
string | ManagedLab Vm Size 
- The size of the virtual machine
- referenceVm ReferenceVm 
- Details specific to Reference Vm
- galleryImage StringResource Id 
- The resource id of the gallery image used for creating the virtual machine
- size
String | ManagedLab Vm Size 
- The size of the virtual machine
- referenceVm ReferenceVm 
- Details specific to Reference Vm
- galleryImage stringResource Id 
- The resource id of the gallery image used for creating the virtual machine
- size
string | ManagedLab 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 | ManagedLab Vm Size 
- The size of the virtual machine
- referenceVm Property Map
- Details specific to Reference Vm
- galleryImage 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
- ImageName string
- The name of the image used to created the environment setting
- ReferenceVm Pulumi.Azure Native. Lab Services. Inputs. Reference Vm Response 
- Details specific to Reference Vm
- GalleryImage 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
- ImageName string
- The name of the image used to created the environment setting
- ReferenceVm ReferenceVm Response 
- Details specific to Reference Vm
- GalleryImage 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
- imageName String
- The name of the image used to created the environment setting
- referenceVm ReferenceVm Response 
- Details specific to Reference Vm
- galleryImage 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
- imageName string
- The name of the image used to created the environment setting
- referenceVm ReferenceVm Response 
- Details specific to Reference Vm
- galleryImage 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
- imageName String
- The name of the image used to created the environment setting
- referenceVm Property Map
- Details specific to Reference Vm
- galleryImage 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        
- LastKnown stringPower State 
- Last known compute power state captured in DTL
- PowerState 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.
- LastKnown stringPower State 
- Last known compute power state captured in DTL
- PowerState 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.
- lastKnown StringPower State 
- Last known compute power state captured in DTL
- powerState 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.
- lastKnown stringPower State 
- Last known compute power state captured in DTL
- powerState 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.
- lastKnown StringPower State 
- Last known compute power state captured in DTL
- powerState 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-v1 pulumi/pulumi-azure-native
- License
- Apache-2.0