1. Packages
  2. Azure Native
  3. API Docs
  4. labservices
  5. getLabPlan
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.49.1 published on Tuesday, Jul 9, 2024 by Pulumi

azure-native.labservices.getLabPlan

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.49.1 published on Tuesday, Jul 9, 2024 by Pulumi

    Retrieves the properties of a Lab Plan. Azure REST API version: 2022-08-01.

    Other available API versions: 2023-06-07.

    Using getLabPlan

    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 getLabPlan(args: GetLabPlanArgs, opts?: InvokeOptions): Promise<GetLabPlanResult>
    function getLabPlanOutput(args: GetLabPlanOutputArgs, opts?: InvokeOptions): Output<GetLabPlanResult>
    def get_lab_plan(lab_plan_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetLabPlanResult
    def get_lab_plan_output(lab_plan_name: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetLabPlanResult]
    func LookupLabPlan(ctx *Context, args *LookupLabPlanArgs, opts ...InvokeOption) (*LookupLabPlanResult, error)
    func LookupLabPlanOutput(ctx *Context, args *LookupLabPlanOutputArgs, opts ...InvokeOption) LookupLabPlanResultOutput

    > Note: This function is named LookupLabPlan in the Go SDK.

    public static class GetLabPlan 
    {
        public static Task<GetLabPlanResult> InvokeAsync(GetLabPlanArgs args, InvokeOptions? opts = null)
        public static Output<GetLabPlanResult> Invoke(GetLabPlanInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetLabPlanResult> getLabPlan(GetLabPlanArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:labservices:getLabPlan
      arguments:
        # arguments dictionary

    The following arguments are supported:

    LabPlanName string
    The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    LabPlanName string
    The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    labPlanName String
    The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    labPlanName string
    The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    lab_plan_name str
    The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    labPlanName String
    The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getLabPlan Result

    The following output properties are available:

    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    Current provisioning state of the lab plan.
    SystemData Pulumi.AzureNative.LabServices.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the lab plan.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AllowedRegions List<string>
    The allowed regions for the lab creator to use when creating labs using this lab plan.
    DefaultAutoShutdownProfile Pulumi.AzureNative.LabServices.Outputs.AutoShutdownProfileResponse
    The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile.
    DefaultConnectionProfile Pulumi.AzureNative.LabServices.Outputs.ConnectionProfileResponse
    The default lab connection profile. This can be changed on a lab resource and only provides a default profile.
    DefaultNetworkProfile Pulumi.AzureNative.LabServices.Outputs.LabPlanNetworkProfileResponse
    The lab plan network profile. To enforce lab network policies they must be defined here and cannot be changed when there are existing labs associated with this lab plan.
    Identity Pulumi.AzureNative.LabServices.Outputs.IdentityResponse
    Managed Identity Information
    LinkedLmsInstance string
    Base Url of the lms instance this lab plan can link lab rosters against.
    SharedGalleryId string
    Resource ID of the Shared Image Gallery attached to this lab plan. When saving a lab template virtual machine image it will be persisted in this gallery. Shared images from the gallery can be made available to use when creating new labs.
    SupportInfo Pulumi.AzureNative.LabServices.Outputs.SupportInfoResponse
    Support contact information and instructions for users of the lab plan. This information is displayed to lab owners and virtual machine users for all labs in the lab plan.
    Tags Dictionary<string, string>
    Resource tags.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    Current provisioning state of the lab plan.
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the lab plan.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AllowedRegions []string
    The allowed regions for the lab creator to use when creating labs using this lab plan.
    DefaultAutoShutdownProfile AutoShutdownProfileResponse
    The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile.
    DefaultConnectionProfile ConnectionProfileResponse
    The default lab connection profile. This can be changed on a lab resource and only provides a default profile.
    DefaultNetworkProfile LabPlanNetworkProfileResponse
    The lab plan network profile. To enforce lab network policies they must be defined here and cannot be changed when there are existing labs associated with this lab plan.
    Identity IdentityResponse
    Managed Identity Information
    LinkedLmsInstance string
    Base Url of the lms instance this lab plan can link lab rosters against.
    SharedGalleryId string
    Resource ID of the Shared Image Gallery attached to this lab plan. When saving a lab template virtual machine image it will be persisted in this gallery. Shared images from the gallery can be made available to use when creating new labs.
    SupportInfo SupportInfoResponse
    Support contact information and instructions for users of the lab plan. This information is displayed to lab owners and virtual machine users for all labs in the lab plan.
    Tags map[string]string
    Resource tags.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    Current provisioning state of the lab plan.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the lab plan.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    allowedRegions List<String>
    The allowed regions for the lab creator to use when creating labs using this lab plan.
    defaultAutoShutdownProfile AutoShutdownProfileResponse
    The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile.
    defaultConnectionProfile ConnectionProfileResponse
    The default lab connection profile. This can be changed on a lab resource and only provides a default profile.
    defaultNetworkProfile LabPlanNetworkProfileResponse
    The lab plan network profile. To enforce lab network policies they must be defined here and cannot be changed when there are existing labs associated with this lab plan.
    identity IdentityResponse
    Managed Identity Information
    linkedLmsInstance String
    Base Url of the lms instance this lab plan can link lab rosters against.
    sharedGalleryId String
    Resource ID of the Shared Image Gallery attached to this lab plan. When saving a lab template virtual machine image it will be persisted in this gallery. Shared images from the gallery can be made available to use when creating new labs.
    supportInfo SupportInfoResponse
    Support contact information and instructions for users of the lab plan. This information is displayed to lab owners and virtual machine users for all labs in the lab plan.
    tags Map<String,String>
    Resource tags.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    provisioningState string
    Current provisioning state of the lab plan.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the lab plan.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    allowedRegions string[]
    The allowed regions for the lab creator to use when creating labs using this lab plan.
    defaultAutoShutdownProfile AutoShutdownProfileResponse
    The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile.
    defaultConnectionProfile ConnectionProfileResponse
    The default lab connection profile. This can be changed on a lab resource and only provides a default profile.
    defaultNetworkProfile LabPlanNetworkProfileResponse
    The lab plan network profile. To enforce lab network policies they must be defined here and cannot be changed when there are existing labs associated with this lab plan.
    identity IdentityResponse
    Managed Identity Information
    linkedLmsInstance string
    Base Url of the lms instance this lab plan can link lab rosters against.
    sharedGalleryId string
    Resource ID of the Shared Image Gallery attached to this lab plan. When saving a lab template virtual machine image it will be persisted in this gallery. Shared images from the gallery can be made available to use when creating new labs.
    supportInfo SupportInfoResponse
    Support contact information and instructions for users of the lab plan. This information is displayed to lab owners and virtual machine users for all labs in the lab plan.
    tags {[key: string]: string}
    Resource tags.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    provisioning_state str
    Current provisioning state of the lab plan.
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the lab plan.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    allowed_regions Sequence[str]
    The allowed regions for the lab creator to use when creating labs using this lab plan.
    default_auto_shutdown_profile AutoShutdownProfileResponse
    The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile.
    default_connection_profile ConnectionProfileResponse
    The default lab connection profile. This can be changed on a lab resource and only provides a default profile.
    default_network_profile LabPlanNetworkProfileResponse
    The lab plan network profile. To enforce lab network policies they must be defined here and cannot be changed when there are existing labs associated with this lab plan.
    identity IdentityResponse
    Managed Identity Information
    linked_lms_instance str
    Base Url of the lms instance this lab plan can link lab rosters against.
    shared_gallery_id str
    Resource ID of the Shared Image Gallery attached to this lab plan. When saving a lab template virtual machine image it will be persisted in this gallery. Shared images from the gallery can be made available to use when creating new labs.
    support_info SupportInfoResponse
    Support contact information and instructions for users of the lab plan. This information is displayed to lab owners and virtual machine users for all labs in the lab plan.
    tags Mapping[str, str]
    Resource tags.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    Current provisioning state of the lab plan.
    systemData Property Map
    Metadata pertaining to creation and last modification of the lab plan.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    allowedRegions List<String>
    The allowed regions for the lab creator to use when creating labs using this lab plan.
    defaultAutoShutdownProfile Property Map
    The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile.
    defaultConnectionProfile Property Map
    The default lab connection profile. This can be changed on a lab resource and only provides a default profile.
    defaultNetworkProfile Property Map
    The lab plan network profile. To enforce lab network policies they must be defined here and cannot be changed when there are existing labs associated with this lab plan.
    identity Property Map
    Managed Identity Information
    linkedLmsInstance String
    Base Url of the lms instance this lab plan can link lab rosters against.
    sharedGalleryId String
    Resource ID of the Shared Image Gallery attached to this lab plan. When saving a lab template virtual machine image it will be persisted in this gallery. Shared images from the gallery can be made available to use when creating new labs.
    supportInfo Property Map
    Support contact information and instructions for users of the lab plan. This information is displayed to lab owners and virtual machine users for all labs in the lab plan.
    tags Map<String>
    Resource tags.

    Supporting Types

    AutoShutdownProfileResponse

    DisconnectDelay string
    The amount of time a VM will stay running after a user disconnects if this behavior is enabled.
    IdleDelay string
    The amount of time a VM will idle before it is shutdown if this behavior is enabled.
    NoConnectDelay string
    The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled.
    ShutdownOnDisconnect string
    Whether shutdown on disconnect is enabled
    ShutdownOnIdle string
    Whether a VM will get shutdown when it has idled for a period of time.
    ShutdownWhenNotConnected string
    Whether a VM will get shutdown when it hasn't been connected to after a period of time.
    DisconnectDelay string
    The amount of time a VM will stay running after a user disconnects if this behavior is enabled.
    IdleDelay string
    The amount of time a VM will idle before it is shutdown if this behavior is enabled.
    NoConnectDelay string
    The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled.
    ShutdownOnDisconnect string
    Whether shutdown on disconnect is enabled
    ShutdownOnIdle string
    Whether a VM will get shutdown when it has idled for a period of time.
    ShutdownWhenNotConnected string
    Whether a VM will get shutdown when it hasn't been connected to after a period of time.
    disconnectDelay String
    The amount of time a VM will stay running after a user disconnects if this behavior is enabled.
    idleDelay String
    The amount of time a VM will idle before it is shutdown if this behavior is enabled.
    noConnectDelay String
    The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled.
    shutdownOnDisconnect String
    Whether shutdown on disconnect is enabled
    shutdownOnIdle String
    Whether a VM will get shutdown when it has idled for a period of time.
    shutdownWhenNotConnected String
    Whether a VM will get shutdown when it hasn't been connected to after a period of time.
    disconnectDelay string
    The amount of time a VM will stay running after a user disconnects if this behavior is enabled.
    idleDelay string
    The amount of time a VM will idle before it is shutdown if this behavior is enabled.
    noConnectDelay string
    The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled.
    shutdownOnDisconnect string
    Whether shutdown on disconnect is enabled
    shutdownOnIdle string
    Whether a VM will get shutdown when it has idled for a period of time.
    shutdownWhenNotConnected string
    Whether a VM will get shutdown when it hasn't been connected to after a period of time.
    disconnect_delay str
    The amount of time a VM will stay running after a user disconnects if this behavior is enabled.
    idle_delay str
    The amount of time a VM will idle before it is shutdown if this behavior is enabled.
    no_connect_delay str
    The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled.
    shutdown_on_disconnect str
    Whether shutdown on disconnect is enabled
    shutdown_on_idle str
    Whether a VM will get shutdown when it has idled for a period of time.
    shutdown_when_not_connected str
    Whether a VM will get shutdown when it hasn't been connected to after a period of time.
    disconnectDelay String
    The amount of time a VM will stay running after a user disconnects if this behavior is enabled.
    idleDelay String
    The amount of time a VM will idle before it is shutdown if this behavior is enabled.
    noConnectDelay String
    The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled.
    shutdownOnDisconnect String
    Whether shutdown on disconnect is enabled
    shutdownOnIdle String
    Whether a VM will get shutdown when it has idled for a period of time.
    shutdownWhenNotConnected String
    Whether a VM will get shutdown when it hasn't been connected to after a period of time.

    ConnectionProfileResponse

    ClientRdpAccess string
    The enabled access level for Client Access over RDP.
    ClientSshAccess string
    The enabled access level for Client Access over SSH.
    WebRdpAccess string
    The enabled access level for Web Access over RDP.
    WebSshAccess string
    The enabled access level for Web Access over SSH.
    ClientRdpAccess string
    The enabled access level for Client Access over RDP.
    ClientSshAccess string
    The enabled access level for Client Access over SSH.
    WebRdpAccess string
    The enabled access level for Web Access over RDP.
    WebSshAccess string
    The enabled access level for Web Access over SSH.
    clientRdpAccess String
    The enabled access level for Client Access over RDP.
    clientSshAccess String
    The enabled access level for Client Access over SSH.
    webRdpAccess String
    The enabled access level for Web Access over RDP.
    webSshAccess String
    The enabled access level for Web Access over SSH.
    clientRdpAccess string
    The enabled access level for Client Access over RDP.
    clientSshAccess string
    The enabled access level for Client Access over SSH.
    webRdpAccess string
    The enabled access level for Web Access over RDP.
    webSshAccess string
    The enabled access level for Web Access over SSH.
    client_rdp_access str
    The enabled access level for Client Access over RDP.
    client_ssh_access str
    The enabled access level for Client Access over SSH.
    web_rdp_access str
    The enabled access level for Web Access over RDP.
    web_ssh_access str
    The enabled access level for Web Access over SSH.
    clientRdpAccess String
    The enabled access level for Client Access over RDP.
    clientSshAccess String
    The enabled access level for Client Access over SSH.
    webRdpAccess String
    The enabled access level for Web Access over RDP.
    webSshAccess String
    The enabled access level for Web Access over SSH.

    IdentityResponse

    PrincipalId string
    The principal ID of resource identity.
    TenantId string
    The tenant ID of resource.
    Type string
    The identity type.
    PrincipalId string
    The principal ID of resource identity.
    TenantId string
    The tenant ID of resource.
    Type string
    The identity type.
    principalId String
    The principal ID of resource identity.
    tenantId String
    The tenant ID of resource.
    type String
    The identity type.
    principalId string
    The principal ID of resource identity.
    tenantId string
    The tenant ID of resource.
    type string
    The identity type.
    principal_id str
    The principal ID of resource identity.
    tenant_id str
    The tenant ID of resource.
    type str
    The identity type.
    principalId String
    The principal ID of resource identity.
    tenantId String
    The tenant ID of resource.
    type String
    The identity type.

    LabPlanNetworkProfileResponse

    SubnetId string
    The external subnet resource id
    SubnetId string
    The external subnet resource id
    subnetId String
    The external subnet resource id
    subnetId string
    The external subnet resource id
    subnet_id str
    The external subnet resource id
    subnetId String
    The external subnet resource id

    SupportInfoResponse

    Email string
    Support contact email address.
    Instructions string
    Support instructions.
    Phone string
    Support contact phone number.
    Url string
    Support web address.
    Email string
    Support contact email address.
    Instructions string
    Support instructions.
    Phone string
    Support contact phone number.
    Url string
    Support web address.
    email String
    Support contact email address.
    instructions String
    Support instructions.
    phone String
    Support contact phone number.
    url String
    Support web address.
    email string
    Support contact email address.
    instructions string
    Support instructions.
    phone string
    Support contact phone number.
    url string
    Support web address.
    email str
    Support contact email address.
    instructions str
    Support instructions.
    phone str
    Support contact phone number.
    url str
    Support web address.
    email String
    Support contact email address.
    instructions String
    Support instructions.
    phone String
    Support contact phone number.
    url String
    Support web address.

    SystemDataResponse

    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.

    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.49.1 published on Tuesday, Jul 9, 2024 by Pulumi