Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. education
  5. getStudent
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.getStudent

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 student in the specified lab by student alias

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

Using getStudent

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 getStudent(args: GetStudentArgs, opts?: InvokeOptions): Promise<GetStudentResult>
function getStudentOutput(args: GetStudentOutputArgs, opts?: InvokeOptions): Output<GetStudentResult>
Copy
def get_student(billing_account_name: Optional[str] = None,
                billing_profile_name: Optional[str] = None,
                invoice_section_name: Optional[str] = None,
                student_alias: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetStudentResult
def get_student_output(billing_account_name: Optional[pulumi.Input[str]] = None,
                billing_profile_name: Optional[pulumi.Input[str]] = None,
                invoice_section_name: Optional[pulumi.Input[str]] = None,
                student_alias: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetStudentResult]
Copy
func LookupStudent(ctx *Context, args *LookupStudentArgs, opts ...InvokeOption) (*LookupStudentResult, error)
func LookupStudentOutput(ctx *Context, args *LookupStudentOutputArgs, opts ...InvokeOption) LookupStudentResultOutput
Copy

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

public static class GetStudent 
{
    public static Task<GetStudentResult> InvokeAsync(GetStudentArgs args, InvokeOptions? opts = null)
    public static Output<GetStudentResult> Invoke(GetStudentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetStudentResult> getStudent(GetStudentArgs args, InvokeOptions options)
public static Output<GetStudentResult> getStudent(GetStudentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:education:getStudent
  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.
StudentAlias
This property is required.
Changes to this property will trigger replacement.
string
Student alias.
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.
StudentAlias
This property is required.
Changes to this property will trigger replacement.
string
Student alias.
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.
studentAlias
This property is required.
Changes to this property will trigger replacement.
String
Student alias.
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.
studentAlias
This property is required.
Changes to this property will trigger replacement.
string
Student alias.
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.
student_alias
This property is required.
Changes to this property will trigger replacement.
str
Student alias.
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.
studentAlias
This property is required.
Changes to this property will trigger replacement.
String
Student alias.

getStudent Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Budget Pulumi.AzureNative.Education.Outputs.AmountResponse
Student Budget
EffectiveDate string
Date student was added to the lab
Email string
Student Email
ExpirationDate string
Date this student is set to expire from the lab.
FirstName string
First Name
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LastName string
Last Name
Name string
The name of the resource
Role string
Student Role
Status string
Student Lab Status
SubscriptionId string
Subscription Id
SystemData Pulumi.AzureNative.Education.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
SubscriptionAlias string
Subscription alias
SubscriptionInviteLastSentDate string
subscription invite last sent date
AzureApiVersion string
The Azure API version of the resource.
Budget AmountResponse
Student Budget
EffectiveDate string
Date student was added to the lab
Email string
Student Email
ExpirationDate string
Date this student is set to expire from the lab.
FirstName string
First Name
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LastName string
Last Name
Name string
The name of the resource
Role string
Student Role
Status string
Student Lab Status
SubscriptionId string
Subscription Id
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
SubscriptionAlias string
Subscription alias
SubscriptionInviteLastSentDate string
subscription invite last sent date
azureApiVersion String
The Azure API version of the resource.
budget AmountResponse
Student Budget
effectiveDate String
Date student was added to the lab
email String
Student Email
expirationDate String
Date this student is set to expire from the lab.
firstName String
First Name
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
lastName String
Last Name
name String
The name of the resource
role String
Student Role
status String
Student Lab Status
subscriptionId String
Subscription Id
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
subscriptionAlias String
Subscription alias
subscriptionInviteLastSentDate String
subscription invite last sent date
azureApiVersion string
The Azure API version of the resource.
budget AmountResponse
Student Budget
effectiveDate string
Date student was added to the lab
email string
Student Email
expirationDate string
Date this student is set to expire from the lab.
firstName string
First Name
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
lastName string
Last Name
name string
The name of the resource
role string
Student Role
status string
Student Lab Status
subscriptionId string
Subscription Id
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
subscriptionAlias string
Subscription alias
subscriptionInviteLastSentDate string
subscription invite last sent date
azure_api_version str
The Azure API version of the resource.
budget AmountResponse
Student Budget
effective_date str
Date student was added to the lab
email str
Student Email
expiration_date str
Date this student is set to expire from the lab.
first_name str
First Name
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
last_name str
Last Name
name str
The name of the resource
role str
Student Role
status str
Student Lab Status
subscription_id str
Subscription Id
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
subscription_alias str
Subscription alias
subscription_invite_last_sent_date str
subscription invite last sent date
azureApiVersion String
The Azure API version of the resource.
budget Property Map
Student Budget
effectiveDate String
Date student was added to the lab
email String
Student Email
expirationDate String
Date this student is set to expire from the lab.
firstName String
First Name
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
lastName String
Last Name
name String
The name of the resource
role String
Student Role
status String
Student Lab Status
subscriptionId String
Subscription Id
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
subscriptionAlias String
Subscription alias
subscriptionInviteLastSentDate String
subscription invite last sent date

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