1. Packages
  2. Azure Native
  3. API Docs
  4. education
  5. Student
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.75.0 published on Saturday, Nov 30, 2024 by Pulumi

azure-native.education.Student

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.75.0 published on Saturday, Nov 30, 2024 by Pulumi

    Student details. Azure REST API version: 2021-12-01-preview. Prior API version in Azure Native 1.x: 2021-12-01-preview.

    Example Usage

    Student

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var student = new AzureNative.Education.Student("student", new()
        {
            BillingAccountName = "{billingAccountName}",
            BillingProfileName = "{billingProfileName}",
            Budget = new AzureNative.Education.Inputs.AmountArgs
            {
                Currency = "USD",
                Value = 100,
            },
            Email = "test@contoso.com",
            ExpirationDate = "2021-11-09T22:13:21.795Z",
            FirstName = "test",
            InvoiceSectionName = "{invoiceSectionName}",
            LastName = "user",
            Role = AzureNative.Education.StudentRole.Student,
            StudentAlias = "{studentAlias}",
        });
    
    });
    
    package main
    
    import (
    	education "github.com/pulumi/pulumi-azure-native-sdk/education/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := education.NewStudent(ctx, "student", &education.StudentArgs{
    			BillingAccountName: pulumi.String("{billingAccountName}"),
    			BillingProfileName: pulumi.String("{billingProfileName}"),
    			Budget: &education.AmountArgs{
    				Currency: pulumi.String("USD"),
    				Value:    pulumi.Float64(100),
    			},
    			Email:              pulumi.String("test@contoso.com"),
    			ExpirationDate:     pulumi.String("2021-11-09T22:13:21.795Z"),
    			FirstName:          pulumi.String("test"),
    			InvoiceSectionName: pulumi.String("{invoiceSectionName}"),
    			LastName:           pulumi.String("user"),
    			Role:               pulumi.String(education.StudentRoleStudent),
    			StudentAlias:       pulumi.String("{studentAlias}"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.education.Student;
    import com.pulumi.azurenative.education.StudentArgs;
    import com.pulumi.azurenative.education.inputs.AmountArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var student = new Student("student", StudentArgs.builder()
                .billingAccountName("{billingAccountName}")
                .billingProfileName("{billingProfileName}")
                .budget(AmountArgs.builder()
                    .currency("USD")
                    .value(100)
                    .build())
                .email("test@contoso.com")
                .expirationDate("2021-11-09T22:13:21.795Z")
                .firstName("test")
                .invoiceSectionName("{invoiceSectionName}")
                .lastName("user")
                .role("Student")
                .studentAlias("{studentAlias}")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    student = azure_native.education.Student("student",
        billing_account_name="{billingAccountName}",
        billing_profile_name="{billingProfileName}",
        budget={
            "currency": "USD",
            "value": 100,
        },
        email="test@contoso.com",
        expiration_date="2021-11-09T22:13:21.795Z",
        first_name="test",
        invoice_section_name="{invoiceSectionName}",
        last_name="user",
        role=azure_native.education.StudentRole.STUDENT,
        student_alias="{studentAlias}")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const student = new azure_native.education.Student("student", {
        billingAccountName: "{billingAccountName}",
        billingProfileName: "{billingProfileName}",
        budget: {
            currency: "USD",
            value: 100,
        },
        email: "test@contoso.com",
        expirationDate: "2021-11-09T22:13:21.795Z",
        firstName: "test",
        invoiceSectionName: "{invoiceSectionName}",
        lastName: "user",
        role: azure_native.education.StudentRole.Student,
        studentAlias: "{studentAlias}",
    });
    
    resources:
      student:
        type: azure-native:education:Student
        properties:
          billingAccountName: '{billingAccountName}'
          billingProfileName: '{billingProfileName}'
          budget:
            currency: USD
            value: 100
          email: test@contoso.com
          expirationDate: 2021-11-09T22:13:21.795Z
          firstName: test
          invoiceSectionName: '{invoiceSectionName}'
          lastName: user
          role: Student
          studentAlias: '{studentAlias}'
    

    Create Student Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Student(name: string, args: StudentArgs, opts?: CustomResourceOptions);
    @overload
    def Student(resource_name: str,
                args: StudentArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Student(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                billing_account_name: Optional[str] = None,
                billing_profile_name: Optional[str] = None,
                budget: Optional[AmountArgs] = None,
                email: Optional[str] = None,
                expiration_date: Optional[str] = None,
                first_name: Optional[str] = None,
                invoice_section_name: Optional[str] = None,
                last_name: Optional[str] = None,
                role: Optional[Union[str, StudentRole]] = None,
                student_alias: Optional[str] = None,
                subscription_alias: Optional[str] = None,
                subscription_invite_last_sent_date: Optional[str] = None)
    func NewStudent(ctx *Context, name string, args StudentArgs, opts ...ResourceOption) (*Student, error)
    public Student(string name, StudentArgs args, CustomResourceOptions? opts = null)
    public Student(String name, StudentArgs args)
    public Student(String name, StudentArgs args, CustomResourceOptions options)
    
    type: azure-native:education:Student
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args StudentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StudentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StudentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StudentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StudentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var studentResource = new AzureNative.Education.Student("studentResource", new()
    {
        BillingAccountName = "string",
        BillingProfileName = "string",
        Budget = new AzureNative.Education.Inputs.AmountArgs
        {
            Currency = "string",
            Value = 0,
        },
        Email = "string",
        ExpirationDate = "string",
        FirstName = "string",
        InvoiceSectionName = "string",
        LastName = "string",
        Role = "string",
        StudentAlias = "string",
        SubscriptionAlias = "string",
        SubscriptionInviteLastSentDate = "string",
    });
    
    example, err := education.NewStudent(ctx, "studentResource", &education.StudentArgs{
    	BillingAccountName: pulumi.String("string"),
    	BillingProfileName: pulumi.String("string"),
    	Budget: &education.AmountArgs{
    		Currency: pulumi.String("string"),
    		Value:    pulumi.Float64(0),
    	},
    	Email:                          pulumi.String("string"),
    	ExpirationDate:                 pulumi.String("string"),
    	FirstName:                      pulumi.String("string"),
    	InvoiceSectionName:             pulumi.String("string"),
    	LastName:                       pulumi.String("string"),
    	Role:                           pulumi.String("string"),
    	StudentAlias:                   pulumi.String("string"),
    	SubscriptionAlias:              pulumi.String("string"),
    	SubscriptionInviteLastSentDate: pulumi.String("string"),
    })
    
    var studentResource = new Student("studentResource", StudentArgs.builder()
        .billingAccountName("string")
        .billingProfileName("string")
        .budget(AmountArgs.builder()
            .currency("string")
            .value(0)
            .build())
        .email("string")
        .expirationDate("string")
        .firstName("string")
        .invoiceSectionName("string")
        .lastName("string")
        .role("string")
        .studentAlias("string")
        .subscriptionAlias("string")
        .subscriptionInviteLastSentDate("string")
        .build());
    
    student_resource = azure_native.education.Student("studentResource",
        billing_account_name="string",
        billing_profile_name="string",
        budget={
            "currency": "string",
            "value": 0,
        },
        email="string",
        expiration_date="string",
        first_name="string",
        invoice_section_name="string",
        last_name="string",
        role="string",
        student_alias="string",
        subscription_alias="string",
        subscription_invite_last_sent_date="string")
    
    const studentResource = new azure_native.education.Student("studentResource", {
        billingAccountName: "string",
        billingProfileName: "string",
        budget: {
            currency: "string",
            value: 0,
        },
        email: "string",
        expirationDate: "string",
        firstName: "string",
        invoiceSectionName: "string",
        lastName: "string",
        role: "string",
        studentAlias: "string",
        subscriptionAlias: "string",
        subscriptionInviteLastSentDate: "string",
    });
    
    type: azure-native:education:Student
    properties:
        billingAccountName: string
        billingProfileName: string
        budget:
            currency: string
            value: 0
        email: string
        expirationDate: string
        firstName: string
        invoiceSectionName: string
        lastName: string
        role: string
        studentAlias: string
        subscriptionAlias: string
        subscriptionInviteLastSentDate: string
    

    Student Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Student resource accepts the following input properties:

    BillingAccountName string
    The ID that uniquely identifies a billing account.
    BillingProfileName string
    The ID that uniquely identifies a billing profile.
    Budget Pulumi.AzureNative.Education.Inputs.Amount
    Student Budget
    Email string
    Student Email
    ExpirationDate string
    Date this student is set to expire from the lab.
    FirstName string
    First Name
    InvoiceSectionName string
    The ID that uniquely identifies an invoice section.
    LastName string
    Last Name
    Role string | Pulumi.AzureNative.Education.StudentRole
    Student Role
    StudentAlias string
    Student alias.
    SubscriptionAlias string
    Subscription alias
    SubscriptionInviteLastSentDate string
    subscription invite last sent date
    BillingAccountName string
    The ID that uniquely identifies a billing account.
    BillingProfileName string
    The ID that uniquely identifies a billing profile.
    Budget AmountArgs
    Student Budget
    Email string
    Student Email
    ExpirationDate string
    Date this student is set to expire from the lab.
    FirstName string
    First Name
    InvoiceSectionName string
    The ID that uniquely identifies an invoice section.
    LastName string
    Last Name
    Role string | StudentRole
    Student Role
    StudentAlias string
    Student alias.
    SubscriptionAlias string
    Subscription alias
    SubscriptionInviteLastSentDate string
    subscription invite last sent date
    billingAccountName String
    The ID that uniquely identifies a billing account.
    billingProfileName String
    The ID that uniquely identifies a billing profile.
    budget Amount
    Student Budget
    email String
    Student Email
    expirationDate String
    Date this student is set to expire from the lab.
    firstName String
    First Name
    invoiceSectionName String
    The ID that uniquely identifies an invoice section.
    lastName String
    Last Name
    role String | StudentRole
    Student Role
    studentAlias String
    Student alias.
    subscriptionAlias String
    Subscription alias
    subscriptionInviteLastSentDate String
    subscription invite last sent date
    billingAccountName string
    The ID that uniquely identifies a billing account.
    billingProfileName string
    The ID that uniquely identifies a billing profile.
    budget Amount
    Student Budget
    email string
    Student Email
    expirationDate string
    Date this student is set to expire from the lab.
    firstName string
    First Name
    invoiceSectionName string
    The ID that uniquely identifies an invoice section.
    lastName string
    Last Name
    role string | StudentRole
    Student Role
    studentAlias string
    Student alias.
    subscriptionAlias string
    Subscription alias
    subscriptionInviteLastSentDate string
    subscription invite last sent date
    billing_account_name str
    The ID that uniquely identifies a billing account.
    billing_profile_name str
    The ID that uniquely identifies a billing profile.
    budget AmountArgs
    Student Budget
    email str
    Student Email
    expiration_date str
    Date this student is set to expire from the lab.
    first_name str
    First Name
    invoice_section_name str
    The ID that uniquely identifies an invoice section.
    last_name str
    Last Name
    role str | StudentRole
    Student Role
    student_alias str
    Student alias.
    subscription_alias str
    Subscription alias
    subscription_invite_last_sent_date str
    subscription invite last sent date
    billingAccountName String
    The ID that uniquely identifies a billing account.
    billingProfileName String
    The ID that uniquely identifies a billing profile.
    budget Property Map
    Student Budget
    email String
    Student Email
    expirationDate String
    Date this student is set to expire from the lab.
    firstName String
    First Name
    invoiceSectionName String
    The ID that uniquely identifies an invoice section.
    lastName String
    Last Name
    role String | "Student" | "Admin"
    Student Role
    studentAlias String
    Student alias.
    subscriptionAlias String
    Subscription alias
    subscriptionInviteLastSentDate String
    subscription invite last sent date

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Student resource produces the following output properties:

    EffectiveDate string
    Date student was added to the lab
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    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"
    EffectiveDate string
    Date student was added to the lab
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    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"
    effectiveDate String
    Date student was added to the lab
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    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"
    effectiveDate string
    Date student was added to the lab
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    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"
    effective_date str
    Date student was added to the lab
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    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"
    effectiveDate String
    Date student was added to the lab
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    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"

    Supporting Types

    Amount, AmountArgs

    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.

    AmountResponse, AmountResponseArgs

    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.

    StudentRole, StudentRoleArgs

    Student
    Student
    Admin
    Admin
    StudentRoleStudent
    Student
    StudentRoleAdmin
    Admin
    Student
    Student
    Admin
    Admin
    Student
    Student
    Admin
    Admin
    STUDENT
    Student
    ADMIN
    Admin
    "Student"
    Student
    "Admin"
    Admin

    SystemDataResponse, SystemDataResponseArgs

    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.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:education:Student {studentAlias} /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students/{studentAlias} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    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.75.0 published on Saturday, Nov 30, 2024 by Pulumi