Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. labservices
  5. Lab
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.labservices.Lab

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

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

    Import

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

    $ pulumi import azure-native:labservices:Lab myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}

    Create Lab Resource

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

    Constructor syntax

    new Lab(name: string, args: LabArgs, opts?: CustomResourceOptions);
    @overload
def Lab(resource_name: str,
        args: LabArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def Lab(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        lab_account_name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        lab_name: Optional[str] = None,
        location: Optional[str] = None,
        max_users_in_lab: Optional[int] = None,
        provisioning_state: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        unique_identifier: Optional[str] = None,
        usage_quota: Optional[str] = None,
        user_access_mode: Optional[Union[str, LabUserAccessMode]] = None)
    func NewLab(ctx *Context, name string, args LabArgs, opts ...ResourceOption) (*Lab, error)
    public Lab(string name, LabArgs args, CustomResourceOptions? opts = null)
    public Lab(String name, LabArgs args)
public Lab(String name, LabArgs args, CustomResourceOptions options)

    type: azure-native:labservices:Lab
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 LabArgs
    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 LabArgs
    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 LabArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LabArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LabArgs
    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 examplelabResourceResourceFromLabservices = new AzureNative.Labservices.Lab("examplelabResourceResourceFromLabservices", new()
{
    LabAccountName = "string",
    ResourceGroupName = "string",
    LabName = "string",
    Location = "string",
    MaxUsersInLab = 0,
    ProvisioningState = "string",
    Tags = 
    {
        { "string", "string" },
    },
    UniqueIdentifier = "string",
    UsageQuota = "string",
    UserAccessMode = "string",
});

    example, err := labservices.NewLab(ctx, "examplelabResourceResourceFromLabservices", &labservices.LabArgs{
	LabAccountName:    "string",
	ResourceGroupName: "string",
	LabName:           "string",
	Location:          "string",
	MaxUsersInLab:     0,
	ProvisioningState: "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
	UniqueIdentifier: "string",
	UsageQuota:       "string",
	UserAccessMode:   "string",
})

    var examplelabResourceResourceFromLabservices = new Lab("examplelabResourceResourceFromLabservices", LabArgs.builder()
    .labAccountName("string")
    .resourceGroupName("string")
    .labName("string")
    .location("string")
    .maxUsersInLab(0)
    .provisioningState("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .uniqueIdentifier("string")
    .usageQuota("string")
    .userAccessMode("string")
    .build());

    examplelab_resource_resource_from_labservices = azure_native.labservices.Lab("examplelabResourceResourceFromLabservices",
    lab_account_name=string,
    resource_group_name=string,
    lab_name=string,
    location=string,
    max_users_in_lab=0,
    provisioning_state=string,
    tags={
        string: string,
    },
    unique_identifier=string,
    usage_quota=string,
    user_access_mode=string)

    const examplelabResourceResourceFromLabservices = new azure_native.labservices.Lab("examplelabResourceResourceFromLabservices", {
    labAccountName: "string",
    resourceGroupName: "string",
    labName: "string",
    location: "string",
    maxUsersInLab: 0,
    provisioningState: "string",
    tags: {
        string: "string",
    },
    uniqueIdentifier: "string",
    usageQuota: "string",
    userAccessMode: "string",
});

    type: azure-native:labservices:Lab
properties:
    labAccountName: string
    labName: string
    location: string
    maxUsersInLab: 0
    provisioningState: string
    resourceGroupName: string
    tags:
        string: string
    uniqueIdentifier: string
    usageQuota: string
    userAccessMode: string

    Lab 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 Lab resource accepts the following input properties:

    LabAccountName string
    The name of the lab Account.
    ResourceGroupName string
    The name of the resource group.
    LabName string
    The name of the lab.
    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 | Pulumi.AzureNative.LabServices.LabUserAccessMode
    Lab user access mode (open to all vs. restricted to those listed on the lab).
    LabAccountName string
    The name of the lab Account.
    ResourceGroupName string
    The name of the resource group.
    LabName string
    The name of the lab.
    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 | LabUserAccessMode
    Lab user access mode (open to all vs. restricted to those listed on the lab).
    labAccountName String
    The name of the lab Account.
    resourceGroupName String
    The name of the resource group.
    labName String
    The name of the lab.
    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 | LabUserAccessMode
    Lab user access mode (open to all vs. restricted to those listed on the lab).
    labAccountName string
    The name of the lab Account.
    resourceGroupName string
    The name of the resource group.
    labName string
    The name of the lab.
    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 | LabUserAccessMode
    Lab user access mode (open to all vs. restricted to those listed on the lab).
    lab_account_name str
    The name of the lab Account.
    resource_group_name str
    The name of the resource group.
    lab_name str
    The name of the lab.
    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 | LabUserAccessMode
    Lab user access mode (open to all vs. restricted to those listed on the lab).
    labAccountName String
    The name of the lab Account.
    resourceGroupName String
    The name of the resource group.
    labName String
    The name of the lab.
    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 | "Restricted" | "Open"
    Lab user access mode (open to all vs. restricted to those listed on the lab).

    Outputs

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

    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 provider-assigned unique ID for this managed 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
    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 provider-assigned unique ID for this managed 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
    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 provider-assigned unique ID for this managed 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
    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 provider-assigned unique ID for this managed 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
    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 provider-assigned unique ID for this managed 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
    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 provider-assigned unique ID for this managed 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

    Supporting Types

    LabUserAccessMode, LabUserAccessModeArgs

    Restricted
    RestrictedOnly users registered with the lab can access VMs.
    Open
    OpenAny user can register with the lab and access its VMs.
    LabUserAccessModeRestricted
    RestrictedOnly users registered with the lab can access VMs.
    LabUserAccessModeOpen
    OpenAny user can register with the lab and access its VMs.
    Restricted
    RestrictedOnly users registered with the lab can access VMs.
    Open
    OpenAny user can register with the lab and access its VMs.
    Restricted
    RestrictedOnly users registered with the lab can access VMs.
    Open
    OpenAny user can register with the lab and access its VMs.
    RESTRICTED
    RestrictedOnly users registered with the lab can access VMs.
    OPEN
    OpenAny user can register with the lab and access its VMs.
    "Restricted"
    RestrictedOnly users registered with the lab can access VMs.
    "Open"
    OpenAny user can register with the lab and access its VMs.

    LatestOperationResultResponse, LatestOperationResultResponseArgs

    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
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native