Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. devtestlab
  5. getLab
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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.devtestlab.getLab

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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get lab. Azure REST API version: 2018-09-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,
            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,
            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)
public static Output<GetLabResult> getLab(GetLabArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:devtestlab:getLab
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the lab.
    ResourceGroupName string
    The name of the resource group.
    Expand string
    Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'
    Name string
    The name of the lab.
    ResourceGroupName string
    The name of the resource group.
    Expand string
    Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'
    name String
    The name of the lab.
    resourceGroupName String
    The name of the resource group.
    expand String
    Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'
    name string
    The name of the lab.
    resourceGroupName string
    The name of the resource group.
    expand string
    Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'
    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=defaultStorageAccount)'
    name String
    The name of the lab.
    resourceGroupName String
    The name of the resource group.
    expand String
    Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'

    getLab Result

    The following output properties are available:

    ArtifactsStorageAccount string
    The lab's artifact storage account.
    CreatedDate string
    The creation date of the lab.
    DefaultPremiumStorageAccount string
    The lab's default premium storage account.
    DefaultStorageAccount string
    The lab's default storage account.
    Id string
    The identifier of the resource.
    LoadBalancerId string
    The load balancer used to for lab VMs that use shared IP address.
    Name string
    The name of the resource.
    NetworkSecurityGroupId string
    The Network Security Group attached to the lab VMs Network interfaces to restrict open ports.
    PremiumDataDiskStorageAccount string
    The lab's premium data disk storage account.
    ProvisioningState string
    The provisioning status of the resource.
    PublicIpId string
    The public IP address for the lab's load balancer.
    Type string
    The type of the resource.
    UniqueIdentifier string
    The unique immutable identifier of a resource (Guid).
    VaultName string
    The lab's Key vault.
    VmCreationResourceGroup string
    The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null.
    Announcement Pulumi.AzureNative.DevTestLab.Outputs.LabAnnouncementPropertiesResponse
    The properties of any lab announcement associated with this lab
    EnvironmentPermission string
    The access rights to be granted to the user when provisioning an environment
    ExtendedProperties Dictionary<string, string>
    Extended properties of the lab used for experimental features
    LabStorageType string
    Type of storage used by the lab. It can be either Premium or Standard. Default is Premium.
    Location string
    The location of the resource.
    MandatoryArtifactsResourceIdsLinux List<string>
    The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user.
    MandatoryArtifactsResourceIdsWindows List<string>
    The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user.
    PremiumDataDisks string
    The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed.
    Support Pulumi.AzureNative.DevTestLab.Outputs.LabSupportPropertiesResponse
    The properties of any lab support message associated with this lab
    Tags Dictionary<string, string>
    The tags of the resource.
    ArtifactsStorageAccount string
    The lab's artifact storage account.
    CreatedDate string
    The creation date of the lab.
    DefaultPremiumStorageAccount string
    The lab's default premium storage account.
    DefaultStorageAccount string
    The lab's default storage account.
    Id string
    The identifier of the resource.
    LoadBalancerId string
    The load balancer used to for lab VMs that use shared IP address.
    Name string
    The name of the resource.
    NetworkSecurityGroupId string
    The Network Security Group attached to the lab VMs Network interfaces to restrict open ports.
    PremiumDataDiskStorageAccount string
    The lab's premium data disk storage account.
    ProvisioningState string
    The provisioning status of the resource.
    PublicIpId string
    The public IP address for the lab's load balancer.
    Type string
    The type of the resource.
    UniqueIdentifier string
    The unique immutable identifier of a resource (Guid).
    VaultName string
    The lab's Key vault.
    VmCreationResourceGroup string
    The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null.
    Announcement LabAnnouncementPropertiesResponse
    The properties of any lab announcement associated with this lab
    EnvironmentPermission string
    The access rights to be granted to the user when provisioning an environment
    ExtendedProperties map[string]string
    Extended properties of the lab used for experimental features
    LabStorageType string
    Type of storage used by the lab. It can be either Premium or Standard. Default is Premium.
    Location string
    The location of the resource.
    MandatoryArtifactsResourceIdsLinux []string
    The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user.
    MandatoryArtifactsResourceIdsWindows []string
    The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user.
    PremiumDataDisks string
    The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed.
    Support LabSupportPropertiesResponse
    The properties of any lab support message associated with this lab
    Tags map[string]string
    The tags of the resource.
    artifactsStorageAccount String
    The lab's artifact storage account.
    createdDate String
    The creation date of the lab.
    defaultPremiumStorageAccount String
    The lab's default premium storage account.
    defaultStorageAccount String
    The lab's default storage account.
    id String
    The identifier of the resource.
    loadBalancerId String
    The load balancer used to for lab VMs that use shared IP address.
    name String
    The name of the resource.
    networkSecurityGroupId String
    The Network Security Group attached to the lab VMs Network interfaces to restrict open ports.
    premiumDataDiskStorageAccount String
    The lab's premium data disk storage account.
    provisioningState String
    The provisioning status of the resource.
    publicIpId String
    The public IP address for the lab's load balancer.
    type String
    The type of the resource.
    uniqueIdentifier String
    The unique immutable identifier of a resource (Guid).
    vaultName String
    The lab's Key vault.
    vmCreationResourceGroup String
    The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null.
    announcement LabAnnouncementPropertiesResponse
    The properties of any lab announcement associated with this lab
    environmentPermission String
    The access rights to be granted to the user when provisioning an environment
    extendedProperties Map<String,String>
    Extended properties of the lab used for experimental features
    labStorageType String
    Type of storage used by the lab. It can be either Premium or Standard. Default is Premium.
    location String
    The location of the resource.
    mandatoryArtifactsResourceIdsLinux List<String>
    The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user.
    mandatoryArtifactsResourceIdsWindows List<String>
    The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user.
    premiumDataDisks String
    The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed.
    support LabSupportPropertiesResponse
    The properties of any lab support message associated with this lab
    tags Map<String,String>
    The tags of the resource.
    artifactsStorageAccount string
    The lab's artifact storage account.
    createdDate string
    The creation date of the lab.
    defaultPremiumStorageAccount string
    The lab's default premium storage account.
    defaultStorageAccount string
    The lab's default storage account.
    id string
    The identifier of the resource.
    loadBalancerId string
    The load balancer used to for lab VMs that use shared IP address.
    name string
    The name of the resource.
    networkSecurityGroupId string
    The Network Security Group attached to the lab VMs Network interfaces to restrict open ports.
    premiumDataDiskStorageAccount string
    The lab's premium data disk storage account.
    provisioningState string
    The provisioning status of the resource.
    publicIpId string
    The public IP address for the lab's load balancer.
    type string
    The type of the resource.
    uniqueIdentifier string
    The unique immutable identifier of a resource (Guid).
    vaultName string
    The lab's Key vault.
    vmCreationResourceGroup string
    The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null.
    announcement LabAnnouncementPropertiesResponse
    The properties of any lab announcement associated with this lab
    environmentPermission string
    The access rights to be granted to the user when provisioning an environment
    extendedProperties {[key: string]: string}
    Extended properties of the lab used for experimental features
    labStorageType string
    Type of storage used by the lab. It can be either Premium or Standard. Default is Premium.
    location string
    The location of the resource.
    mandatoryArtifactsResourceIdsLinux string[]
    The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user.
    mandatoryArtifactsResourceIdsWindows string[]
    The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user.
    premiumDataDisks string
    The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed.
    support LabSupportPropertiesResponse
    The properties of any lab support message associated with this lab
    tags {[key: string]: string}
    The tags of the resource.
    artifacts_storage_account str
    The lab's artifact storage account.
    created_date str
    The creation date of the lab.
    default_premium_storage_account str
    The lab's default premium storage account.
    default_storage_account str
    The lab's default storage account.
    id str
    The identifier of the resource.
    load_balancer_id str
    The load balancer used to for lab VMs that use shared IP address.
    name str
    The name of the resource.
    network_security_group_id str
    The Network Security Group attached to the lab VMs Network interfaces to restrict open ports.
    premium_data_disk_storage_account str
    The lab's premium data disk storage account.
    provisioning_state str
    The provisioning status of the resource.
    public_ip_id str
    The public IP address for the lab's load balancer.
    type str
    The type of the resource.
    unique_identifier str
    The unique immutable identifier of a resource (Guid).
    vault_name str
    The lab's Key vault.
    vm_creation_resource_group str
    The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null.
    announcement LabAnnouncementPropertiesResponse
    The properties of any lab announcement associated with this lab
    environment_permission str
    The access rights to be granted to the user when provisioning an environment
    extended_properties Mapping[str, str]
    Extended properties of the lab used for experimental features
    lab_storage_type str
    Type of storage used by the lab. It can be either Premium or Standard. Default is Premium.
    location str
    The location of the resource.
    mandatory_artifacts_resource_ids_linux Sequence[str]
    The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user.
    mandatory_artifacts_resource_ids_windows Sequence[str]
    The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user.
    premium_data_disks str
    The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed.
    support LabSupportPropertiesResponse
    The properties of any lab support message associated with this lab
    tags Mapping[str, str]
    The tags of the resource.
    artifactsStorageAccount String
    The lab's artifact storage account.
    createdDate String
    The creation date of the lab.
    defaultPremiumStorageAccount String
    The lab's default premium storage account.
    defaultStorageAccount String
    The lab's default storage account.
    id String
    The identifier of the resource.
    loadBalancerId String
    The load balancer used to for lab VMs that use shared IP address.
    name String
    The name of the resource.
    networkSecurityGroupId String
    The Network Security Group attached to the lab VMs Network interfaces to restrict open ports.
    premiumDataDiskStorageAccount String
    The lab's premium data disk storage account.
    provisioningState String
    The provisioning status of the resource.
    publicIpId String
    The public IP address for the lab's load balancer.
    type String
    The type of the resource.
    uniqueIdentifier String
    The unique immutable identifier of a resource (Guid).
    vaultName String
    The lab's Key vault.
    vmCreationResourceGroup String
    The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null.
    announcement Property Map
    The properties of any lab announcement associated with this lab
    environmentPermission String
    The access rights to be granted to the user when provisioning an environment
    extendedProperties Map<String>
    Extended properties of the lab used for experimental features
    labStorageType String
    Type of storage used by the lab. It can be either Premium or Standard. Default is Premium.
    location String
    The location of the resource.
    mandatoryArtifactsResourceIdsLinux List<String>
    The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user.
    mandatoryArtifactsResourceIdsWindows List<String>
    The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user.
    premiumDataDisks String
    The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed.
    support Property Map
    The properties of any lab support message associated with this lab
    tags Map<String>
    The tags of the resource.

    Supporting Types

    LabAnnouncementPropertiesResponse

    ProvisioningState string
    The provisioning status of the resource.
    UniqueIdentifier string
    The unique immutable identifier of a resource (Guid).
    Enabled string
    Is the lab announcement active/enabled at this time?
    ExpirationDate string
    The time at which the announcement expires (null for never)
    Expired bool
    Has this announcement expired?
    Markdown string
    The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.
    Title string
    The plain text title for the lab announcement
    ProvisioningState string
    The provisioning status of the resource.
    UniqueIdentifier string
    The unique immutable identifier of a resource (Guid).
    Enabled string
    Is the lab announcement active/enabled at this time?
    ExpirationDate string
    The time at which the announcement expires (null for never)
    Expired bool
    Has this announcement expired?
    Markdown string
    The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.
    Title string
    The plain text title for the lab announcement
    provisioningState String
    The provisioning status of the resource.
    uniqueIdentifier String
    The unique immutable identifier of a resource (Guid).
    enabled String
    Is the lab announcement active/enabled at this time?
    expirationDate String
    The time at which the announcement expires (null for never)
    expired Boolean
    Has this announcement expired?
    markdown String
    The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.
    title String
    The plain text title for the lab announcement
    provisioningState string
    The provisioning status of the resource.
    uniqueIdentifier string
    The unique immutable identifier of a resource (Guid).
    enabled string
    Is the lab announcement active/enabled at this time?
    expirationDate string
    The time at which the announcement expires (null for never)
    expired boolean
    Has this announcement expired?
    markdown string
    The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.
    title string
    The plain text title for the lab announcement
    provisioning_state str
    The provisioning status of the resource.
    unique_identifier str
    The unique immutable identifier of a resource (Guid).
    enabled str
    Is the lab announcement active/enabled at this time?
    expiration_date str
    The time at which the announcement expires (null for never)
    expired bool
    Has this announcement expired?
    markdown str
    The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.
    title str
    The plain text title for the lab announcement
    provisioningState String
    The provisioning status of the resource.
    uniqueIdentifier String
    The unique immutable identifier of a resource (Guid).
    enabled String
    Is the lab announcement active/enabled at this time?
    expirationDate String
    The time at which the announcement expires (null for never)
    expired Boolean
    Has this announcement expired?
    markdown String
    The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.
    title String
    The plain text title for the lab announcement

    LabSupportPropertiesResponse

    Enabled string
    Is the lab support banner active/enabled at this time?
    Markdown string
    The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.
    Enabled string
    Is the lab support banner active/enabled at this time?
    Markdown string
    The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.
    enabled String
    Is the lab support banner active/enabled at this time?
    markdown String
    The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.
    enabled string
    Is the lab support banner active/enabled at this time?
    markdown string
    The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.
    enabled str
    Is the lab support banner active/enabled at this time?
    markdown str
    The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.
    enabled String
    Is the lab support banner active/enabled at this time?
    markdown String
    The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.

    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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native