Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. education
  5. getLab
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.education.getLab

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.

Uses Azure REST API version 2021-12-01-preview.

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>
Copy
def get_lab(billing_account_name: Optional[str] = None,
            billing_profile_name: Optional[str] = None,
            include_budget: Optional[bool] = None,
            invoice_section_name: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetLabResult
def get_lab_output(billing_account_name: Optional[pulumi.Input[str]] = None,
            billing_profile_name: Optional[pulumi.Input[str]] = None,
            include_budget: Optional[pulumi.Input[bool]] = None,
            invoice_section_name: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetLabResult]
Copy
func LookupLab(ctx *Context, args *LookupLabArgs, opts ...InvokeOption) (*LookupLabResult, error)
func LookupLabOutput(ctx *Context, args *LookupLabOutputArgs, opts ...InvokeOption) LookupLabResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetLabResult> getLab(GetLabArgs args, InvokeOptions options)
public static Output<GetLabResult> getLab(GetLabArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:education:getLab
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BillingAccountName
This property is required.
Changes to this property will trigger replacement.
string
The ID that uniquely identifies a billing account.
BillingProfileName
This property is required.
Changes to this property will trigger replacement.
string
The ID that uniquely identifies a billing profile.
InvoiceSectionName
This property is required.
Changes to this property will trigger replacement.
string
The ID that uniquely identifies an invoice section.
IncludeBudget bool
May be used to include budget information.
BillingAccountName
This property is required.
Changes to this property will trigger replacement.
string
The ID that uniquely identifies a billing account.
BillingProfileName
This property is required.
Changes to this property will trigger replacement.
string
The ID that uniquely identifies a billing profile.
InvoiceSectionName
This property is required.
Changes to this property will trigger replacement.
string
The ID that uniquely identifies an invoice section.
IncludeBudget bool
May be used to include budget information.
billingAccountName
This property is required.
Changes to this property will trigger replacement.
String
The ID that uniquely identifies a billing account.
billingProfileName
This property is required.
Changes to this property will trigger replacement.
String
The ID that uniquely identifies a billing profile.
invoiceSectionName
This property is required.
Changes to this property will trigger replacement.
String
The ID that uniquely identifies an invoice section.
includeBudget Boolean
May be used to include budget information.
billingAccountName
This property is required.
Changes to this property will trigger replacement.
string
The ID that uniquely identifies a billing account.
billingProfileName
This property is required.
Changes to this property will trigger replacement.
string
The ID that uniquely identifies a billing profile.
invoiceSectionName
This property is required.
Changes to this property will trigger replacement.
string
The ID that uniquely identifies an invoice section.
includeBudget boolean
May be used to include budget information.
billing_account_name
This property is required.
Changes to this property will trigger replacement.
str
The ID that uniquely identifies a billing account.
billing_profile_name
This property is required.
Changes to this property will trigger replacement.
str
The ID that uniquely identifies a billing profile.
invoice_section_name
This property is required.
Changes to this property will trigger replacement.
str
The ID that uniquely identifies an invoice section.
include_budget bool
May be used to include budget information.
billingAccountName
This property is required.
Changes to this property will trigger replacement.
String
The ID that uniquely identifies a billing account.
billingProfileName
This property is required.
Changes to this property will trigger replacement.
String
The ID that uniquely identifies a billing profile.
invoiceSectionName
This property is required.
Changes to this property will trigger replacement.
String
The ID that uniquely identifies an invoice section.
includeBudget Boolean
May be used to include budget information.

getLab Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
BudgetPerStudent Pulumi.AzureNative.Education.Outputs.AmountResponse
Default monetary cap for each student in this lab
Description string
Detail description of this lab
DisplayName string
Lab Display Name
EffectiveDate string
Lab creation date
ExpirationDate string
Default expiration date for each student in this lab
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
InvitationCode string
invitation code for redeemable lab
MaxStudentCount double
the total number of students that can be accepted to the lab.
Name string
The name of the resource
Status string
The status of this lab
SystemData Pulumi.AzureNative.Education.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TotalBudget Pulumi.AzureNative.Education.Outputs.AmountResponse
Total budget
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Currency string
The type of currency being used for the value.
Value double
Amount value.
AzureApiVersion string
The Azure API version of the resource.
BudgetPerStudent AmountResponse
Default monetary cap for each student in this lab
Description string
Detail description of this lab
DisplayName string
Lab Display Name
EffectiveDate string
Lab creation date
ExpirationDate string
Default expiration date for each student in this lab
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
InvitationCode string
invitation code for redeemable lab
MaxStudentCount float64
the total number of students that can be accepted to the lab.
Name string
The name of the resource
Status string
The status of this lab
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TotalBudget AmountResponse
Total budget
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Currency string
The type of currency being used for the value.
Value float64
Amount value.
azureApiVersion String
The Azure API version of the resource.
budgetPerStudent AmountResponse
Default monetary cap for each student in this lab
description String
Detail description of this lab
displayName String
Lab Display Name
effectiveDate String
Lab creation date
expirationDate String
Default expiration date for each student in this lab
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
invitationCode String
invitation code for redeemable lab
maxStudentCount Double
the total number of students that can be accepted to the lab.
name String
The name of the resource
status String
The status of this lab
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
totalBudget AmountResponse
Total budget
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
currency String
The type of currency being used for the value.
value Double
Amount value.
azureApiVersion string
The Azure API version of the resource.
budgetPerStudent AmountResponse
Default monetary cap for each student in this lab
description string
Detail description of this lab
displayName string
Lab Display Name
effectiveDate string
Lab creation date
expirationDate string
Default expiration date for each student in this lab
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
invitationCode string
invitation code for redeemable lab
maxStudentCount number
the total number of students that can be accepted to the lab.
name string
The name of the resource
status string
The status of this lab
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
totalBudget AmountResponse
Total budget
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
currency string
The type of currency being used for the value.
value number
Amount value.
azure_api_version str
The Azure API version of the resource.
budget_per_student AmountResponse
Default monetary cap for each student in this lab
description str
Detail description of this lab
display_name str
Lab Display Name
effective_date str
Lab creation date
expiration_date str
Default expiration date for each student in this lab
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
invitation_code str
invitation code for redeemable lab
max_student_count float
the total number of students that can be accepted to the lab.
name str
The name of the resource
status str
The status of this lab
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
total_budget AmountResponse
Total budget
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
currency str
The type of currency being used for the value.
value float
Amount value.
azureApiVersion String
The Azure API version of the resource.
budgetPerStudent Property Map
Default monetary cap for each student in this lab
description String
Detail description of this lab
displayName String
Lab Display Name
effectiveDate String
Lab creation date
expirationDate String
Default expiration date for each student in this lab
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
invitationCode String
invitation code for redeemable lab
maxStudentCount Number
the total number of students that can be accepted to the lab.
name String
The name of the resource
status String
The status of this lab
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
totalBudget Property Map
Total budget
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
currency String
The type of currency being used for the value.
value Number
Amount value.

Supporting Types

AmountResponse

Currency string
The type of currency being used for the value.
Value double
Amount value.
Currency string
The type of currency being used for the value.
Value float64
Amount value.
currency String
The type of currency being used for the value.
value Double
Amount value.
currency string
The type of currency being used for the value.
value number
Amount value.
currency str
The type of currency being used for the value.
value float
Amount value.
currency String
The type of currency being used for the value.
value Number
Amount value.

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
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native