1. Packages
  2. Azure Native
  3. API Docs
  4. devtestlab
  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

azure-native.devtestlab.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

Get user profile.

Uses Azure REST API version 2018-09-15.

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(expand: Optional[str] = None,
             lab_name: Optional[str] = None,
             name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetUserResult
def get_user_output(expand: Optional[pulumi.Input[str]] = None,
             lab_name: Optional[pulumi.Input[str]] = None,
             name: Optional[pulumi.Input[str]] = None,
             resource_group_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:devtestlab: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.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the user profile.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Expand string
Specify the $expand query. Example: 'properties($select=identity)'
LabName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the user profile.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Expand string
Specify the $expand query. Example: 'properties($select=identity)'
labName
This property is required.
Changes to this property will trigger replacement.
String
The name of the lab.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the user profile.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
expand String
Specify the $expand query. Example: 'properties($select=identity)'
labName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab.
name
This property is required.
Changes to this property will trigger replacement.
string
The name of the user profile.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
expand string
Specify the $expand query. Example: 'properties($select=identity)'
lab_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the lab.
name
This property is required.
Changes to this property will trigger replacement.
str
The name of the user profile.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
expand str
Specify the $expand query. Example: 'properties($select=identity)'
labName
This property is required.
Changes to this property will trigger replacement.
String
The name of the lab.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the user profile.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
expand String
Specify the $expand query. Example: 'properties($select=identity)'

getUser Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
CreatedDate string
The creation date of the user profile.
Id string
The identifier of the resource.
Name string
The name of the resource.
ProvisioningState string
The provisioning status of the resource.
Type string
The type of the resource.
UniqueIdentifier string
The unique immutable identifier of a resource (Guid).
Identity Pulumi.AzureNative.DevTestLab.Outputs.UserIdentityResponse
The identity of the user.
Location string
The location of the resource.
SecretStore Pulumi.AzureNative.DevTestLab.Outputs.UserSecretStoreResponse
The secret store of the user.
Tags Dictionary<string, string>
The tags of the resource.
AzureApiVersion string
The Azure API version of the resource.
CreatedDate string
The creation date of the user profile.
Id string
The identifier of the resource.
Name string
The name of the resource.
ProvisioningState string
The provisioning status of the resource.
Type string
The type of the resource.
UniqueIdentifier string
The unique immutable identifier of a resource (Guid).
Identity UserIdentityResponse
The identity of the user.
Location string
The location of the resource.
SecretStore UserSecretStoreResponse
The secret store of the user.
Tags map[string]string
The tags of the resource.
azureApiVersion String
The Azure API version of the resource.
createdDate String
The creation date of the user profile.
id String
The identifier of the resource.
name String
The name of the resource.
provisioningState String
The provisioning status of the resource.
type String
The type of the resource.
uniqueIdentifier String
The unique immutable identifier of a resource (Guid).
identity UserIdentityResponse
The identity of the user.
location String
The location of the resource.
secretStore UserSecretStoreResponse
The secret store of the user.
tags Map<String,String>
The tags of the resource.
azureApiVersion string
The Azure API version of the resource.
createdDate string
The creation date of the user profile.
id string
The identifier of the resource.
name string
The name of the resource.
provisioningState string
The provisioning status of the resource.
type string
The type of the resource.
uniqueIdentifier string
The unique immutable identifier of a resource (Guid).
identity UserIdentityResponse
The identity of the user.
location string
The location of the resource.
secretStore UserSecretStoreResponse
The secret store of the user.
tags {[key: string]: string}
The tags of the resource.
azure_api_version str
The Azure API version of the resource.
created_date str
The creation date of the user profile.
id str
The identifier of the resource.
name str
The name of the resource.
provisioning_state str
The provisioning status of the resource.
type str
The type of the resource.
unique_identifier str
The unique immutable identifier of a resource (Guid).
identity UserIdentityResponse
The identity of the user.
location str
The location of the resource.
secret_store UserSecretStoreResponse
The secret store of the user.
tags Mapping[str, str]
The tags of the resource.
azureApiVersion String
The Azure API version of the resource.
createdDate String
The creation date of the user profile.
id String
The identifier of the resource.
name String
The name of the resource.
provisioningState String
The provisioning status of the resource.
type String
The type of the resource.
uniqueIdentifier String
The unique immutable identifier of a resource (Guid).
identity Property Map
The identity of the user.
location String
The location of the resource.
secretStore Property Map
The secret store of the user.
tags Map<String>
The tags of the resource.

Supporting Types

UserIdentityResponse

AppId string
Set to the app Id of the client JWT making the request.
ObjectId string
Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.
PrincipalId string
Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.
PrincipalName string
Set to the principal name / UPN of the client JWT making the request.
TenantId string
Set to the tenant ID of the client JWT making the request.
AppId string
Set to the app Id of the client JWT making the request.
ObjectId string
Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.
PrincipalId string
Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.
PrincipalName string
Set to the principal name / UPN of the client JWT making the request.
TenantId string
Set to the tenant ID of the client JWT making the request.
appId String
Set to the app Id of the client JWT making the request.
objectId String
Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.
principalId String
Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.
principalName String
Set to the principal name / UPN of the client JWT making the request.
tenantId String
Set to the tenant ID of the client JWT making the request.
appId string
Set to the app Id of the client JWT making the request.
objectId string
Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.
principalId string
Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.
principalName string
Set to the principal name / UPN of the client JWT making the request.
tenantId string
Set to the tenant ID of the client JWT making the request.
app_id str
Set to the app Id of the client JWT making the request.
object_id str
Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.
principal_id str
Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.
principal_name str
Set to the principal name / UPN of the client JWT making the request.
tenant_id str
Set to the tenant ID of the client JWT making the request.
appId String
Set to the app Id of the client JWT making the request.
objectId String
Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.
principalId String
Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.
principalName String
Set to the principal name / UPN of the client JWT making the request.
tenantId String
Set to the tenant ID of the client JWT making the request.

UserSecretStoreResponse

KeyVaultId string
The ID of the user's Key vault.
KeyVaultUri string
The URI of the user's Key vault.
KeyVaultId string
The ID of the user's Key vault.
KeyVaultUri string
The URI of the user's Key vault.
keyVaultId String
The ID of the user's Key vault.
keyVaultUri String
The URI of the user's Key vault.
keyVaultId string
The ID of the user's Key vault.
keyVaultUri string
The URI of the user's Key vault.
key_vault_id str
The ID of the user's Key vault.
key_vault_uri str
The URI of the user's Key vault.
keyVaultId String
The ID of the user's Key vault.
keyVaultUri String
The URI of the user's Key vault.

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