← All packages

Azure Native

Pulumi Official

Package maintained by Pulumi

v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

Source code

getLab

Represents a lab. API Version: 2018-10-15.

Using getLab

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 getLab(args: GetLabArgs, opts?: InvokeOptions): Promise<GetLabResult>
function getLabOutput(args: GetLabOutputArgs, opts?: InvokeOptions): Output<GetLabResult>

def get_lab(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) -> GetLabResult
def get_lab_output(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[GetLabResult]

func LookupLab(ctx *Context, args *LookupLabArgs, opts ...InvokeOption) (*LookupLabResult, error)
func LookupLabOutput(ctx *Context, args *LookupLabOutputArgs, opts ...InvokeOption) LookupLabResultOutput

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

public static class GetLab 
{
    public static Task<GetLabResult> InvokeAsync(GetLabArgs args, InvokeOptions? opts = null)
    public static Output<GetLabResult> Invoke(GetLabInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetLabResult> getLab(GetLabArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

Fn::Invoke:
  Function: azure-native:labservices:getLab
  Arguments:
    # Arguments dictionary

The following arguments are supported:

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=maxUsersInLab)'

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=maxUsersInLab)'

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=maxUsersInLab)'

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=maxUsersInLab)'

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=maxUsersInLab)'

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=maxUsersInLab)'

getLab Result

The following output properties are available:

CreatedByObjectId string: Object id of the user that created the lab.
CreatedByUserPrincipalName string: Lab creator name
CreatedDate string: Creation date for the lab
Id string: The identifier of the resource.
InvitationCode string: Invitation code that users can use to join a lab.
LatestOperationResult Pulumi.AzureNative.LabServices.Outputs.LatestOperationResultResponse: The details of the latest operation. ex: status, error
Name string: The name of the resource.
Type string: The type of the resource.
UserQuota int: Maximum value MaxUsersInLab can be set to, as specified by the service
Location string: The location of the resource.
MaxUsersInLab int: Maximum number of users allowed in the lab.
ProvisioningState string: The provisioning status of the resource.
Tags Dictionary<string, string>: The tags of the resource.
UniqueIdentifier string: The unique immutable identifier of a resource (Guid).
UsageQuota string: Maximum duration a user can use an environment for in the lab.
UserAccessMode string: Lab user access mode (open to all vs. restricted to those listed on the lab).

CreatedByObjectId string: Object id of the user that created the lab.
CreatedByUserPrincipalName string: Lab creator name
CreatedDate string: Creation date for the lab
Id string: The identifier of the resource.
InvitationCode string: Invitation code that users can use to join a lab.
LatestOperationResult LatestOperationResultResponse: The details of the latest operation. ex: status, error
Name string: The name of the resource.
Type string: The type of the resource.
UserQuota int: Maximum value MaxUsersInLab can be set to, as specified by the service
Location string: The location of the resource.
MaxUsersInLab int: Maximum number of users allowed in the lab.
ProvisioningState string: The provisioning status of the resource.
Tags map[string]string: The tags of the resource.
UniqueIdentifier string: The unique immutable identifier of a resource (Guid).
UsageQuota string: Maximum duration a user can use an environment for in the lab.
UserAccessMode string: Lab user access mode (open to all vs. restricted to those listed on the lab).

createdByObjectId String: Object id of the user that created the lab.
createdByUserPrincipalName String: Lab creator name
createdDate String: Creation date for the lab
id String: The identifier of the resource.
invitationCode String: Invitation code that users can use to join a lab.
latestOperationResult LatestOperationResultResponse: The details of the latest operation. ex: status, error
name String: The name of the resource.
type String: The type of the resource.
userQuota Integer: Maximum value MaxUsersInLab can be set to, as specified by the service
location String: The location of the resource.
maxUsersInLab Integer: Maximum number of users allowed in the lab.
provisioningState String: The provisioning status of the resource.
tags Map<String,String>: The tags of the resource.
uniqueIdentifier String: The unique immutable identifier of a resource (Guid).
usageQuota String: Maximum duration a user can use an environment for in the lab.
userAccessMode String: Lab user access mode (open to all vs. restricted to those listed on the lab).

createdByObjectId string: Object id of the user that created the lab.
createdByUserPrincipalName string: Lab creator name
createdDate string: Creation date for the lab
id string: The identifier of the resource.
invitationCode string: Invitation code that users can use to join a lab.
latestOperationResult LatestOperationResultResponse: The details of the latest operation. ex: status, error
name string: The name of the resource.
type string: The type of the resource.
userQuota number: Maximum value MaxUsersInLab can be set to, as specified by the service
location string: The location of the resource.
maxUsersInLab number: Maximum number of users allowed in the lab.
provisioningState string: The provisioning status of the resource.
tags {[key: string]: string}: The tags of the resource.
uniqueIdentifier string: The unique immutable identifier of a resource (Guid).
usageQuota string: Maximum duration a user can use an environment for in the lab.
userAccessMode string: Lab user access mode (open to all vs. restricted to those listed on the lab).

created_by_object_id str: Object id of the user that created the lab.
created_by_user_principal_name str: Lab creator name
created_date str: Creation date for the lab
id str: The identifier of the resource.
invitation_code str: Invitation code that users can use to join a lab.
latest_operation_result LatestOperationResultResponse: The details of the latest operation. ex: status, error
name str: The name of the resource.
type str: The type of the resource.
user_quota int: Maximum value MaxUsersInLab can be set to, as specified by the service
location str: The location of the resource.
max_users_in_lab int: Maximum number of users allowed in the lab.
provisioning_state str: The provisioning status of the resource.
tags Mapping[str, str]: The tags of the resource.
unique_identifier str: The unique immutable identifier of a resource (Guid).
usage_quota str: Maximum duration a user can use an environment for in the lab.
user_access_mode str: Lab user access mode (open to all vs. restricted to those listed on the lab).

createdByObjectId String: Object id of the user that created the lab.
createdByUserPrincipalName String: Lab creator name
createdDate String: Creation date for the lab
id String: The identifier of the resource.
invitationCode String: Invitation code that users can use to join a lab.
latestOperationResult Property Map: The details of the latest operation. ex: status, error
name String: The name of the resource.
type String: The type of the resource.
userQuota Number: Maximum value MaxUsersInLab can be set to, as specified by the service
location String: The location of the resource.
maxUsersInLab Number: Maximum number of users allowed in the lab.
provisioningState String: The provisioning status of the resource.
tags Map<String>: The tags of the resource.
uniqueIdentifier String: The unique immutable identifier of a resource (Guid).
usageQuota String: Maximum duration a user can use an environment for in the lab.
userAccessMode String: Lab user access mode (open to all vs. restricted to those listed on the lab).

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.

Package Details

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