Azure Native v1.102.0, May 2 23

azure-native.labservices.getEnvironmentSetting

Explore with Pulumi AI

Get environment setting API Version: 2018-10-15.

Using getEnvironmentSetting

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEnvironmentSetting(args: GetEnvironmentSettingArgs, opts?: InvokeOptions): Promise<GetEnvironmentSettingResult>
function getEnvironmentSettingOutput(args: GetEnvironmentSettingOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentSettingResult>

def get_environment_setting(environment_setting_name: Optional[str] = None,
                            expand: Optional[str] = None,
                            lab_account_name: Optional[str] = None,
                            lab_name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetEnvironmentSettingResult
def get_environment_setting_output(environment_setting_name: Optional[pulumi.Input[str]] = None,
                            expand: Optional[pulumi.Input[str]] = None,
                            lab_account_name: Optional[pulumi.Input[str]] = None,
                            lab_name: Optional[pulumi.Input[str]] = None,
                            resource_group_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetEnvironmentSettingResult]

func LookupEnvironmentSetting(ctx *Context, args *LookupEnvironmentSettingArgs, opts ...InvokeOption) (*LookupEnvironmentSettingResult, error)
func LookupEnvironmentSettingOutput(ctx *Context, args *LookupEnvironmentSettingOutputArgs, opts ...InvokeOption) LookupEnvironmentSettingResultOutput

> Note: This function is named LookupEnvironmentSetting in the Go SDK.

public static class GetEnvironmentSetting 
{
    public static Task<GetEnvironmentSettingResult> InvokeAsync(GetEnvironmentSettingArgs args, InvokeOptions? opts = null)
    public static Output<GetEnvironmentSettingResult> Invoke(GetEnvironmentSettingInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEnvironmentSettingResult> getEnvironmentSetting(GetEnvironmentSettingArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:labservices:getEnvironmentSetting
  arguments:
    # arguments dictionary

The following arguments are supported:

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.
Expand string: Specify the $expand query. Example: 'properties($select=publishingState)'

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.
Expand string: Specify the $expand query. Example: 'properties($select=publishingState)'

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.
expand String: Specify the $expand query. Example: 'properties($select=publishingState)'

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.
expand string: Specify the $expand query. Example: 'properties($select=publishingState)'

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.
expand str: Specify the $expand query. Example: 'properties($select=publishingState)'

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.
expand String: Specify the $expand query. Example: 'properties($select=publishingState)'

getEnvironmentSetting Result

The following output properties are available:

Id string: The identifier of the resource.
LastChanged string: Time when the template VM was last changed.
LastPublished string: Time when the template VM was last sent for publishing.
LatestOperationResult Pulumi.AzureNative.LabServices.Outputs.LatestOperationResultResponse: 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
ResourceSettings Pulumi.AzureNative.LabServices.Outputs.ResourceSettingsResponse: The resource specific settings
Type string: The type of the resource.
ConfigurationState string: Describes the user's progress in configuring their environment setting
Description string: Describes the environment and its resource settings
Location string: The location of the resource.
ProvisioningState string: The provisioning status of the resource.
Tags 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).

Id string: The identifier of the resource.
LastChanged string: Time when the template VM was last changed.
LastPublished string: Time when the template VM was last sent for publishing.
LatestOperationResult LatestOperationResultResponse: 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
ResourceSettings ResourceSettingsResponse: The resource specific settings
Type string: The type of the resource.
ConfigurationState string: Describes the user's progress in configuring their environment setting
Description string: Describes the environment and its resource settings
Location string: The location of the resource.
ProvisioningState string: The provisioning status of the resource.
Tags 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).

id String: The identifier of the resource.
lastChanged String: Time when the template VM was last changed.
lastPublished String: Time when the template VM was last sent for publishing.
latestOperationResult LatestOperationResultResponse: 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
resourceSettings ResourceSettingsResponse: The resource specific settings
type String: The type of the resource.
configurationState String: Describes the user's progress in configuring their environment setting
description String: Describes the environment and its resource settings
location String: The location of the resource.
provisioningState String: The provisioning status of the resource.
tags 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).

id string: The identifier of the resource.
lastChanged string: Time when the template VM was last changed.
lastPublished string: Time when the template VM was last sent for publishing.
latestOperationResult LatestOperationResultResponse: 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
resourceSettings ResourceSettingsResponse: The resource specific settings
type string: The type of the resource.
configurationState string: Describes the user's progress in configuring their environment setting
description string: Describes the environment and its resource settings
location string: The location of the resource.
provisioningState string: The provisioning status of the resource.
tags {[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).

id str: The identifier of the 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_result LatestOperationResultResponse: 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
resource_settings ResourceSettingsResponse: The resource specific settings
type str: The type of the resource.
configuration_state str: Describes the user's progress in configuring their environment setting
description str: Describes the environment and its resource settings
location str: The location of the resource.
provisioning_state str: The provisioning status of the resource.
tags 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).

id String: The identifier of the resource.
lastChanged String: Time when the template VM was last changed.
lastPublished String: Time when the template VM was last sent for publishing.
latestOperationResult Property Map: 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
resourceSettings Property Map: The resource specific settings
type String: The type of the resource.
configurationState String: Describes the user's progress in configuring their environment setting
description String: Describes the environment and its resource settings
location String: The location of the resource.
provisioningState String: The provisioning status of the resource.
tags 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).

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.

ReferenceVmResponse

UserName string: The username of the virtual machine
VmResourceId string: VM resource Id for the environment
VmStateDetails Pulumi.AzureNative.LabServices.Inputs.VmStateDetailsResponse: 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
VmResourceId string: VM resource Id for the environment
VmStateDetails VmStateDetailsResponse: 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
vmResourceId String: VM resource Id for the environment
vmStateDetails VmStateDetailsResponse: 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
vmResourceId string: VM resource Id for the environment
vmStateDetails VmStateDetailsResponse: 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_id str: VM resource Id for the environment
vm_state_details VmStateDetailsResponse: 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
vmResourceId String: VM resource Id for the environment
vmStateDetails Property Map: 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

ResourceSettingsResponse

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.AzureNative.LabServices.Inputs.ReferenceVmResponse: Details specific to Reference Vm
GalleryImageResourceId string: 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 ReferenceVmResponse: Details specific to Reference Vm
GalleryImageResourceId string: 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 ReferenceVmResponse: Details specific to Reference Vm
galleryImageResourceId String: 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 ReferenceVmResponse: Details specific to Reference Vm
galleryImageResourceId string: 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 ReferenceVmResponse: Details specific to Reference Vm
gallery_image_resource_id str: 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
galleryImageResourceId String: The resource id of the gallery image used for creating the virtual machine
size String: The size of the virtual machine

VmStateDetailsResponse

LastKnownPowerState string: Last known compute power state captured in DTL
PowerState string: The power state of the reference virtual machine.
RdpAuthority string: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
SshAuthority string: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.

LastKnownPowerState string: Last known compute power state captured in DTL
PowerState string: The power state of the reference virtual machine.
RdpAuthority string: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
SshAuthority string: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.

lastKnownPowerState String: Last known compute power state captured in DTL
powerState String: The power state of the reference virtual machine.
rdpAuthority String: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
sshAuthority String: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.

lastKnownPowerState string: Last known compute power state captured in DTL
powerState string: The power state of the reference virtual machine.
rdpAuthority string: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
sshAuthority string: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.

last_known_power_state str: Last known compute power state captured in DTL
power_state str: The power state of the reference virtual machine.
rdp_authority str: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
ssh_authority str: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.

lastKnownPowerState String: Last known compute power state captured in DTL
powerState String: The power state of the reference virtual machine.
rdpAuthority String: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
sshAuthority 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