1. Packages
  2. Azure Native
  3. API Docs
  4. labservices
  5. User
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.labservices.User

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    User of a lab that can register for and use virtual machines within the lab. Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2018-10-15.

    Other available API versions: 2018-10-15, 2023-06-07.

    Example Usage

    putUser

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var user = new AzureNative.LabServices.User("user", new()
        {
            AdditionalUsageQuota = "PT10H",
            Email = "testuser@contoso.com",
            LabName = "testlab",
            ResourceGroupName = "testrg123",
            UserName = "testuser",
        });
    
    });
    
    package main
    
    import (
    	labservices "github.com/pulumi/pulumi-azure-native-sdk/labservices/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := labservices.NewUser(ctx, "user", &labservices.UserArgs{
    			AdditionalUsageQuota: pulumi.String("PT10H"),
    			Email:                pulumi.String("testuser@contoso.com"),
    			LabName:              pulumi.String("testlab"),
    			ResourceGroupName:    pulumi.String("testrg123"),
    			UserName:             pulumi.String("testuser"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.labservices.User;
    import com.pulumi.azurenative.labservices.UserArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var user = new User("user", UserArgs.builder()
                .additionalUsageQuota("PT10H")
                .email("testuser@contoso.com")
                .labName("testlab")
                .resourceGroupName("testrg123")
                .userName("testuser")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    user = azure_native.labservices.User("user",
        additional_usage_quota="PT10H",
        email="testuser@contoso.com",
        lab_name="testlab",
        resource_group_name="testrg123",
        user_name="testuser")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const user = new azure_native.labservices.User("user", {
        additionalUsageQuota: "PT10H",
        email: "testuser@contoso.com",
        labName: "testlab",
        resourceGroupName: "testrg123",
        userName: "testuser",
    });
    
    resources:
      user:
        type: azure-native:labservices:User
        properties:
          additionalUsageQuota: PT10H
          email: testuser@contoso.com
          labName: testlab
          resourceGroupName: testrg123
          userName: testuser
    

    Create User Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
    @overload
    def User(resource_name: str,
             args: UserArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def User(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             email: Optional[str] = None,
             lab_name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             additional_usage_quota: Optional[str] = None,
             user_name: Optional[str] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
    public User(String name, UserArgs args, CustomResourceOptions options)
    
    type: azure-native:labservices:User
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleuserResourceResourceFromLabservices = new AzureNative.LabServices.User("exampleuserResourceResourceFromLabservices", new()
    {
        Email = "string",
        LabName = "string",
        ResourceGroupName = "string",
        AdditionalUsageQuota = "string",
        UserName = "string",
    });
    
    example, err := labservices.NewUser(ctx, "exampleuserResourceResourceFromLabservices", &labservices.UserArgs{
    	Email:                pulumi.String("string"),
    	LabName:              pulumi.String("string"),
    	ResourceGroupName:    pulumi.String("string"),
    	AdditionalUsageQuota: pulumi.String("string"),
    	UserName:             pulumi.String("string"),
    })
    
    var exampleuserResourceResourceFromLabservices = new User("exampleuserResourceResourceFromLabservices", UserArgs.builder()
        .email("string")
        .labName("string")
        .resourceGroupName("string")
        .additionalUsageQuota("string")
        .userName("string")
        .build());
    
    exampleuser_resource_resource_from_labservices = azure_native.labservices.User("exampleuserResourceResourceFromLabservices",
        email="string",
        lab_name="string",
        resource_group_name="string",
        additional_usage_quota="string",
        user_name="string")
    
    const exampleuserResourceResourceFromLabservices = new azure_native.labservices.User("exampleuserResourceResourceFromLabservices", {
        email: "string",
        labName: "string",
        resourceGroupName: "string",
        additionalUsageQuota: "string",
        userName: "string",
    });
    
    type: azure-native:labservices:User
    properties:
        additionalUsageQuota: string
        email: string
        labName: string
        resourceGroupName: string
        userName: string
    

    User Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The User resource accepts the following input properties:

    Email string
    Email address of the user.
    LabName string
    The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AdditionalUsageQuota string
    The amount of usage quota time the user gets in addition to the lab usage quota.
    UserName string
    The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
    Email string
    Email address of the user.
    LabName string
    The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AdditionalUsageQuota string
    The amount of usage quota time the user gets in addition to the lab usage quota.
    UserName string
    The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
    email String
    Email address of the user.
    labName String
    The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    additionalUsageQuota String
    The amount of usage quota time the user gets in addition to the lab usage quota.
    userName String
    The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
    email string
    Email address of the user.
    labName string
    The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    additionalUsageQuota string
    The amount of usage quota time the user gets in addition to the lab usage quota.
    userName string
    The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
    email str
    Email address of the user.
    lab_name str
    The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    additional_usage_quota str
    The amount of usage quota time the user gets in addition to the lab usage quota.
    user_name str
    The name of the user that uniquely identifies it within containing lab. Used in resource URIs.
    email String
    Email address of the user.
    labName String
    The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    additionalUsageQuota String
    The amount of usage quota time the user gets in addition to the lab usage quota.
    userName String
    The name of the user that uniquely identifies it within containing lab. Used in resource URIs.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

    DisplayName string
    Display name of the user, for example user's full name.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    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"
    DisplayName string
    Display name of the user, for example user's full name.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    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"
    displayName String
    Display name of the user, for example user's full name.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    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"
    displayName string
    Display name of the user, for example user's full name.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    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"
    display_name str
    Display name of the user, for example user's full name.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    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"
    displayName String
    Display name of the user, for example user's full name.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    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"

    Supporting Types

    SystemDataResponse, SystemDataResponseArgs

    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.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:labservices:User default /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/users/{userName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi