Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. labservices
  5. getUser
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.labservices.getUser

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Returns the properties of a lab user.

Uses Azure REST API version 2023-06-07.

Other available API versions: 2021-10-01-preview, 2021-11-15-preview, 2022-08-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native labservices [ApiVersion]. See the version guide for details.

Using getUser

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 getUser(args: GetUserArgs, opts?: InvokeOptions): Promise<GetUserResult>
function getUserOutput(args: GetUserOutputArgs, opts?: InvokeOptions): Output<GetUserResult>
Copy
def get_user(lab_name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             user_name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetUserResult
def get_user_output(lab_name: Optional[pulumi.Input[str]] = None,
             resource_group_name: Optional[pulumi.Input[str]] = None,
             user_name: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetUserResult]
Copy
func LookupUser(ctx *Context, args *LookupUserArgs, opts ...InvokeOption) (*LookupUserResult, error)
func LookupUserOutput(ctx *Context, args *LookupUserOutputArgs, opts ...InvokeOption) LookupUserResultOutput
Copy

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

public static class GetUser 
{
    public static Task<GetUserResult> InvokeAsync(GetUserArgs args, InvokeOptions? opts = null)
    public static Output<GetUserResult> Invoke(GetUserInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
public static Output<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:labservices:getUser
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

LabName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
UserName
This property is required.
Changes to this property will trigger replacement.
string
The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
LabName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
UserName
This property is required.
Changes to this property will trigger replacement.
string
The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
labName
This property is required.
Changes to this property will trigger replacement.
String
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
userName
This property is required.
Changes to this property will trigger replacement.
String
The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
labName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
userName
This property is required.
Changes to this property will trigger replacement.
string
The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
lab_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
user_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
labName
This property is required.
Changes to this property will trigger replacement.
String
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
userName
This property is required.
Changes to this property will trigger replacement.
String
The name of the user that uniquely identifies it within containing lab. Used in resource URIs.

getUser Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
DisplayName string
Display name of the user, for example user's full name.
Email string
Email address of the user.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
InvitationSent string
Date and time when the invitation message was sent to the user.
InvitationState string
State of the invitation message for the user.
Name string
The name of the resource
ProvisioningState string
Current provisioning state of the user resource.
RegistrationState string
State of the user's registration within the lab.
ResourceOperationError Pulumi.AzureNative.LabServices.Outputs.ResourceOperationErrorResponse
Error details of last operation done on lab plan.
SystemData Pulumi.AzureNative.LabServices.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the user resource.
TotalUsage string
How long the user has used their virtual machines in this lab.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AdditionalUsageQuota string
The amount of usage quota time the user gets in addition to the lab usage quota.
AzureApiVersion string
The Azure API version of the resource.
DisplayName string
Display name of the user, for example user's full name.
Email string
Email address of the user.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
InvitationSent string
Date and time when the invitation message was sent to the user.
InvitationState string
State of the invitation message for the user.
Name string
The name of the resource
ProvisioningState string
Current provisioning state of the user resource.
RegistrationState string
State of the user's registration within the lab.
ResourceOperationError ResourceOperationErrorResponse
Error details of last operation done on lab plan.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the user resource.
TotalUsage string
How long the user has used their virtual machines in this lab.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AdditionalUsageQuota string
The amount of usage quota time the user gets in addition to the lab usage quota.
azureApiVersion String
The Azure API version of the resource.
displayName String
Display name of the user, for example user's full name.
email String
Email address of the user.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
invitationSent String
Date and time when the invitation message was sent to the user.
invitationState String
State of the invitation message for the user.
name String
The name of the resource
provisioningState String
Current provisioning state of the user resource.
registrationState String
State of the user's registration within the lab.
resourceOperationError ResourceOperationErrorResponse
Error details of last operation done on lab plan.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the user resource.
totalUsage String
How long the user has used their virtual machines in this lab.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
additionalUsageQuota String
The amount of usage quota time the user gets in addition to the lab usage quota.
azureApiVersion string
The Azure API version of the resource.
displayName string
Display name of the user, for example user's full name.
email string
Email address of the user.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
invitationSent string
Date and time when the invitation message was sent to the user.
invitationState string
State of the invitation message for the user.
name string
The name of the resource
provisioningState string
Current provisioning state of the user resource.
registrationState string
State of the user's registration within the lab.
resourceOperationError ResourceOperationErrorResponse
Error details of last operation done on lab plan.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the user resource.
totalUsage string
How long the user has used their virtual machines in this lab.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
additionalUsageQuota string
The amount of usage quota time the user gets in addition to the lab usage quota.
azure_api_version str
The Azure API version of the resource.
display_name str
Display name of the user, for example user's full name.
email str
Email address of the user.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
invitation_sent str
Date and time when the invitation message was sent to the user.
invitation_state str
State of the invitation message for the user.
name str
The name of the resource
provisioning_state str
Current provisioning state of the user resource.
registration_state str
State of the user's registration within the lab.
resource_operation_error ResourceOperationErrorResponse
Error details of last operation done on lab plan.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the user resource.
total_usage str
How long the user has used their virtual machines in this lab.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
additional_usage_quota str
The amount of usage quota time the user gets in addition to the lab usage quota.
azureApiVersion String
The Azure API version of the resource.
displayName String
Display name of the user, for example user's full name.
email String
Email address of the user.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
invitationSent String
Date and time when the invitation message was sent to the user.
invitationState String
State of the invitation message for the user.
name String
The name of the resource
provisioningState String
Current provisioning state of the user resource.
registrationState String
State of the user's registration within the lab.
resourceOperationError Property Map
Error details of last operation done on lab plan.
systemData Property Map
Metadata pertaining to creation and last modification of the user resource.
totalUsage String
How long the user has used their virtual machines in this lab.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
additionalUsageQuota String
The amount of usage quota time the user gets in addition to the lab usage quota.

Supporting Types

ResourceOperationErrorResponse

Action string
The operation action that failed
Code string
The code that corresponds to the type of operation failure
Message string
The operation failure message
Timestamp string
The datetime of when the error occured
Action string
The operation action that failed
Code string
The code that corresponds to the type of operation failure
Message string
The operation failure message
Timestamp string
The datetime of when the error occured
action String
The operation action that failed
code String
The code that corresponds to the type of operation failure
message String
The operation failure message
timestamp String
The datetime of when the error occured
action string
The operation action that failed
code string
The code that corresponds to the type of operation failure
message string
The operation failure message
timestamp string
The datetime of when the error occured
action str
The operation action that failed
code str
The code that corresponds to the type of operation failure
message str
The operation failure message
timestamp str
The datetime of when the error occured
action String
The operation action that failed
code String
The code that corresponds to the type of operation failure
message String
The operation failure message
timestamp String
The datetime of when the error occured

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native