@pulumi/azure-native/labservices/getLab.d.ts

[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [![Python version](https://badge.fury.io/py/pu

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Returns the properties of a lab resource.
 *
 * 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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
 */
export declare function getLab(args: GetLabArgs, opts?: pulumi.InvokeOptions): Promise<GetLabResult>;
export interface GetLabArgs {
    /**
     * The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
     */
    labName: string;
    /**
     * The name of the resource group. The name is case insensitive.
     */
    resourceGroupName: string;
}
/**
 * The lab resource.
 */
export interface GetLabResult {
    /**
     * The resource auto shutdown configuration for the lab. This controls whether actions are taken on resources that are sitting idle.
     */
    readonly autoShutdownProfile: outputs.labservices.AutoShutdownProfileResponse;
    /**
     * The Azure API version of the resource.
     */
    readonly azureApiVersion: string;
    /**
     * The connection profile for the lab. This controls settings such as web access to lab resources or whether RDP or SSH ports are open.
     */
    readonly connectionProfile: outputs.labservices.ConnectionProfileResponse;
    /**
     * The description of the lab.
     */
    readonly description?: string;
    /**
     * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
     */
    readonly id: string;
    /**
     * The ID of the lab plan. Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. Setting a labPlanId on an existing lab provides organization..
     */
    readonly labPlanId?: string;
    /**
     * The geo-location where the resource lives
     */
    readonly location: string;
    /**
     * The name of the resource
     */
    readonly name: string;
    /**
     * The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created.
     */
    readonly networkProfile?: outputs.labservices.LabNetworkProfileResponse;
    /**
     * Current provisioning state of the lab.
     */
    readonly provisioningState: string;
    /**
     * Error details of last operation done on lab.
     */
    readonly resourceOperationError: outputs.labservices.ResourceOperationErrorResponse;
    /**
     * The lab user list management profile.
     */
    readonly rosterProfile?: outputs.labservices.RosterProfileResponse;
    /**
     * The lab security profile.
     */
    readonly securityProfile: outputs.labservices.SecurityProfileResponse;
    /**
     * The lab state.
     */
    readonly state: string;
    /**
     * Metadata pertaining to creation and last modification of the lab.
     */
    readonly systemData: outputs.labservices.SystemDataResponse;
    /**
     * Resource tags.
     */
    readonly tags?: {
        [key: string]: string;
    };
    /**
     * The title of the lab.
     */
    readonly title?: string;
    /**
     * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
     */
    readonly type: string;
    /**
     * The profile used for creating lab virtual machines.
     */
    readonly virtualMachineProfile: outputs.labservices.VirtualMachineProfileResponse;
}
/**
 * Returns the properties of a lab resource.
 *
 * 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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
 */
export declare function getLabOutput(args: GetLabOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetLabResult>;
export interface GetLabOutputArgs {
    /**
     * The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
     */
    labName: pulumi.Input<string>;
    /**
     * The name of the resource group. The name is case insensitive.
     */
    resourceGroupName: pulumi.Input<string>;
}