Azure Native v1.98.1, Mar 24 23

azure-native.labservices.getEnvironment

Get environment API Version: 2018-10-15.

Using getEnvironment

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 getEnvironment(args: GetEnvironmentArgs, opts?: InvokeOptions): Promise<GetEnvironmentResult>
function getEnvironmentOutput(args: GetEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentResult>

def get_environment(environment_name: Optional[str] = None,
                    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) -> GetEnvironmentResult
def get_environment_output(environment_name: Optional[pulumi.Input[str]] = None,
                    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[GetEnvironmentResult]

func LookupEnvironment(ctx *Context, args *LookupEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentResult, error)
func LookupEnvironmentOutput(ctx *Context, args *LookupEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentResultOutput

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

public static class GetEnvironment 
{
    public static Task<GetEnvironmentResult> InvokeAsync(GetEnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetEnvironmentResult> Invoke(GetEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

EnvironmentName string: The name of the environment.
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($expand=networkInterface)'

EnvironmentName string: The name of the environment.
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($expand=networkInterface)'

environmentName String: The name of the environment.
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($expand=networkInterface)'

environmentName string: The name of the environment.
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($expand=networkInterface)'

environment_name str: The name of the environment.
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($expand=networkInterface)'

environmentName String: The name of the environment.
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($expand=networkInterface)'

getEnvironment Result

The following output properties are available:

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 identifier of the 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.
Location string: The location of the resource.
ProvisioningState string: The provisioning status of the resource.
ResourceSets Pulumi.AzureNative.LabServices.Outputs.ResourceSetResponse: 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).

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 identifier of the 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.
Location string: The location of the resource.
ProvisioningState string: The provisioning status of the resource.
ResourceSets ResourceSetResponse: 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).

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 identifier of the 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.
location String: The location of the resource.
provisioningState String: The provisioning status of the resource.
resourceSets ResourceSetResponse: 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).

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 identifier of the 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.
location string: The location of the resource.
provisioningState string: The provisioning status of the resource.
resourceSets ResourceSetResponse: 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).

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 identifier of the 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.
location str: The location of the resource.
provisioning_state str: The provisioning status of the resource.
resource_sets ResourceSetResponse: 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).

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 identifier of the 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.
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).

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

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: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0