Package com.azure.resourcemanager.labservices.models

Interface User

public interface User
An immutable client-side representation of User.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    User.Definition
    The entirety of the User definition.
    static interface 
    User.DefinitionStages
    The User definition stages.
    static interface 
    User.Update
    The template for User update.
    static interface 
    User.UpdateStages
    The User update stages.

  • Method Summary

    Modifier and Type
    Method
    Description
    Duration
    additionalUsageQuota()
    Gets the additionalUsageQuota property: The amount of usage quota time the user gets in addition to the lab usage quota.
    String
    displayName()
    Gets the displayName property: Display name of the user, for example user's full name.
    String
    email()
    Gets the email property: Email address of the user.
    String
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    UserInner
    innerModel()
    Gets the inner com.azure.resourcemanager.labservices.fluent.models.UserInner object.
    OffsetDateTime
    invitationSent()
    Gets the invitationSent property: Date and time when the invitation message was sent to the user.
    InvitationState
    invitationState()
    Gets the invitationState property: State of the invitation message for the user.
    void
    invite(InviteBody body)
    Invite a user to a lab.
    void
    invite(InviteBody body, com.azure.core.util.Context context)
    Invite a user to a lab.
    String
    name()
    Gets the name property: The name of the resource.
    ProvisioningState
    provisioningState()
    Gets the provisioningState property: Current provisioning state of the user resource.
    User
    refresh()
    Refreshes the resource to sync with Azure.
    User
    refresh(com.azure.core.util.Context context)
    Refreshes the resource to sync with Azure.
    RegistrationState
    registrationState()
    Gets the registrationState property: State of the user's registration within the lab.
    String
    resourceGroupName()
    Gets the name of the resource group.
    com.azure.core.management.SystemData
    systemData()
    Gets the systemData property: Metadata pertaining to creation and last modification of the user resource.
    Duration
    totalUsage()
    Gets the totalUsage property: How long the user has used their virtual machines in this lab.
    String
    type()
    Gets the type property: The type of the resource.
    User.Update
    update()
    Begins update for the User resource.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Metadata pertaining to creation and last modification of the user resource.
      Returns:
      the systemData value.

    • provisioningState

      ProvisioningState provisioningState()
      Gets the provisioningState property: Current provisioning state of the user resource.
      Returns:
      the provisioningState value.

    • displayName

      String displayName()
      Gets the displayName property: Display name of the user, for example user's full name.
      Returns:
      the displayName value.

    • email

      String email()
      Gets the email property: Email address of the user.
      Returns:
      the email value.

    • registrationState

      RegistrationState registrationState()
      Gets the registrationState property: State of the user's registration within the lab.
      Returns:
      the registrationState value.

    • invitationState

      InvitationState invitationState()
      Gets the invitationState property: State of the invitation message for the user.
      Returns:
      the invitationState value.

    • invitationSent

      OffsetDateTime invitationSent()
      Gets the invitationSent property: Date and time when the invitation message was sent to the user.
      Returns:
      the invitationSent value.

    • totalUsage

      Duration totalUsage()
      Gets the totalUsage property: How long the user has used their virtual machines in this lab.
      Returns:
      the totalUsage value.

    • additionalUsageQuota

      Duration additionalUsageQuota()
      Gets the additionalUsageQuota property: The amount of usage quota time the user gets in addition to the lab usage quota.
      Returns:
      the additionalUsageQuota value.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      UserInner innerModel()
      Gets the inner com.azure.resourcemanager.labservices.fluent.models.UserInner object.
      Returns:
      the inner object.

    • update

      User.Update update()
      Begins update for the User resource.
      Returns:
      the stage of resource update.

    • refresh

      User refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      User refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • invite

      void invite(InviteBody body)
      Invite a user to a lab.

      Operation to invite a user to a lab.

      Parameters:
      body - The request body.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • invite

      void invite(InviteBody body, com.azure.core.util.Context context)
      Invite a user to a lab.

      Operation to invite a user to a lab.

      Parameters:
      body - The request body.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.