@azure/arm-labservices package

Classes

LabServicesClient

Interfaces

AutoShutdownProfile	Profile for how to handle shutting down virtual machines.
ConnectionProfile	Connection profile for how users connect to lab virtual machines.
Credentials	Credentials for a user on a lab VM.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
Identity	Identity for the resource.
Image	Lab services virtual machine image
ImageProperties	Properties of an image resource.
ImageReference	Image reference information. Used in the virtual machine profile.
ImageUpdate	Lab services virtual machine image for updates.
ImageUpdateProperties	Properties of an image resource update
Images	Interface representing a Images.
ImagesCreateOrUpdateOptionalParams	Optional parameters.
ImagesGetOptionalParams	Optional parameters.
ImagesListByLabPlanNextOptionalParams	Optional parameters.
ImagesListByLabPlanOptionalParams	Optional parameters.
ImagesUpdateOptionalParams	Optional parameters.
InviteBody	Body for a user invite request
Lab	The lab resource.
LabNetworkProfile	Profile for how to handle networking for Labs.
LabPlan	Lab Plans act as a permission container for creating labs via labs.azure.com. Additionally, they can provide a set of default configurations that will apply at the time of creating a lab, but these defaults can still be overwritten.
LabPlanNetworkProfile	Profile for how to handle networking for Lab Plans.
LabPlanProperties	Lab plan resource properties
LabPlanUpdate	Contains lab configuration and default settings. This variant is used for PATCH.
LabPlanUpdateProperties	Lab plan resource properties for updates
LabPlans	Interface representing a LabPlans.
LabPlansCreateOrUpdateOptionalParams	Optional parameters.
LabPlansDeleteOptionalParams	Optional parameters.
LabPlansGetOptionalParams	Optional parameters.
LabPlansListByResourceGroupNextOptionalParams	Optional parameters.
LabPlansListByResourceGroupOptionalParams	Optional parameters.
LabPlansListBySubscriptionNextOptionalParams	Optional parameters.
LabPlansListBySubscriptionOptionalParams	Optional parameters.
LabPlansSaveImageOptionalParams	Optional parameters.
LabPlansUpdateOptionalParams	Optional parameters.
LabProperties	Properties of a lab resource.
LabServicesClientOptionalParams	Optional parameters.
LabServicesSku	Azure Lab Services resource SKUs
LabServicesSkuCapabilities	The array of capabilities of a lab services SKU.
LabServicesSkuCapacity	The scale out/in options of the SKU.
LabServicesSkuCost	The array of costs of a lab services SKU.
LabServicesSkuRestrictions	The restriction details.
LabUpdate	The lab resource for updates.
LabUpdateProperties	Properties of a lab resource used for updates.
Labs	Interface representing a Labs.
LabsCreateOrUpdateOptionalParams	Optional parameters.
LabsDeleteOptionalParams	Optional parameters.
LabsGetOptionalParams	Optional parameters.
LabsListByResourceGroupNextOptionalParams	Optional parameters.
LabsListByResourceGroupOptionalParams	Optional parameters.
LabsListBySubscriptionNextOptionalParams	Optional parameters.
LabsListBySubscriptionOptionalParams	Optional parameters.
LabsPublishOptionalParams	Optional parameters.
LabsSyncGroupOptionalParams	Optional parameters.
LabsUpdateOptionalParams	Optional parameters.
ListUsagesResult	List of Core Usages.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for this particular operation.
OperationListResult	A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
OperationResult	A long running operation result
OperationResults	Interface representing a OperationResults.
OperationResultsGetOptionalParams	Optional parameters.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
PagedImages	Paged list of Lab services virtual machine images.
PagedLabPlans	Paged list of lab plans.
PagedLabServicesSkus	Paged list of lab services skus.
PagedLabs	Paged list of labs.
PagedSchedules	Paged list of schedules.
PagedUsers	Paged list of users.
PagedVirtualMachines	Paged list of lab services virtual machines.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RecurrencePattern	Recurrence pattern of a lab schedule.
ResetPasswordBody	Body of a reset password request.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RosterProfile	The lab user list management profile.
SaveImageBody	Body for the save image POST
Schedule	Schedule for automatically turning virtual machines in a lab on and off at specified times.
ScheduleProperties	Schedule resource properties
ScheduleUpdate	Schedule for automatically turning virtual machines in a lab on and off at specified times. Used for updates.
ScheduleUpdateProperties	Schedule resource properties used for updates.
Schedules	Interface representing a Schedules.
SchedulesCreateOrUpdateOptionalParams	Optional parameters.
SchedulesDeleteOptionalParams	Optional parameters.
SchedulesGetOptionalParams	Optional parameters.
SchedulesListByLabNextOptionalParams	Optional parameters.
SchedulesListByLabOptionalParams	Optional parameters.
SchedulesUpdateOptionalParams	Optional parameters.
SecurityProfile	The lab security profile.
Sku	The resource model definition representing SKU
Skus	Interface representing a Skus.
SkusListNextOptionalParams	Optional parameters.
SkusListOptionalParams	Optional parameters.
SupportInfo	Support contact information and instructions.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
TrackedResourceUpdate	Base tracked resource type for all PATCH updates.
Usage	The core usage details.
UsageName	The Usage Names.
Usages	Interface representing a Usages.
UsagesListByLocationNextOptionalParams	Optional parameters.
UsagesListByLocationOptionalParams	Optional parameters.
User	User of a lab that can register for and use virtual machines within the lab.
UserProperties	User resource properties
UserUpdate	User of a lab that can register for and use virtual machines within the lab. Used for updates.
UserUpdateProperties	User resource properties used for updates.
Users	Interface representing a Users.
UsersCreateOrUpdateOptionalParams	Optional parameters.
UsersDeleteOptionalParams	Optional parameters.
UsersGetOptionalParams	Optional parameters.
UsersInviteOptionalParams	Optional parameters.
UsersListByLabNextOptionalParams	Optional parameters.
UsersListByLabOptionalParams	Optional parameters.
UsersUpdateOptionalParams	Optional parameters.
VirtualMachine	A lab virtual machine resource.
VirtualMachineAdditionalCapabilities	The additional capabilities for a lab VM.
VirtualMachineConnectionProfile	The connection information for the virtual machine
VirtualMachineProfile	The base virtual machine configuration for a lab.
VirtualMachines	Interface representing a VirtualMachines.
VirtualMachinesGetOptionalParams	Optional parameters.
VirtualMachinesListByLabNextOptionalParams	Optional parameters.
VirtualMachinesListByLabOptionalParams	Optional parameters.
VirtualMachinesRedeployOptionalParams	Optional parameters.
VirtualMachinesReimageOptionalParams	Optional parameters.
VirtualMachinesResetPasswordOptionalParams	Optional parameters.
VirtualMachinesStartOptionalParams	Optional parameters.
VirtualMachinesStopOptionalParams	Optional parameters.

Type Aliases

ActionType	Defines values for ActionType. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal
ConnectionType	Defines values for ConnectionType.
CreateOption	Defines values for CreateOption.
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
EnableState	Defines values for EnableState.
ImagesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ImagesGetResponse	Contains response data for the get operation.
ImagesListByLabPlanNextResponse	Contains response data for the listByLabPlanNext operation.
ImagesListByLabPlanResponse	Contains response data for the listByLabPlan operation.
ImagesUpdateResponse	Contains response data for the update operation.
InvitationState	Defines values for InvitationState.
LabPlansCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
LabPlansGetResponse	Contains response data for the get operation.
LabPlansListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
LabPlansListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
LabPlansListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
LabPlansListBySubscriptionResponse	Contains response data for the listBySubscription operation.
LabPlansUpdateResponse	Contains response data for the update operation.
LabServicesSkuTier	Defines values for LabServicesSkuTier. KnownLabServicesSkuTier can be used interchangeably with LabServicesSkuTier, this enum contains the known values that the service supports. Known values supported by the service Standard Premium
LabState	Defines values for LabState.
LabsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
LabsGetResponse	Contains response data for the get operation.
LabsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
LabsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
LabsListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
LabsListBySubscriptionResponse	Contains response data for the listBySubscription operation.
LabsUpdateResponse	Contains response data for the update operation.
OperationResultsGetResponse	Contains response data for the get operation.
OperationStatus	Defines values for OperationStatus.
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
Origin	Defines values for Origin. KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user system user,system
OsState	Defines values for OsState.
OsType	Defines values for OsType.
ProvisioningState	Defines values for ProvisioningState.
RecurrenceFrequency	Defines values for RecurrenceFrequency.
RegistrationState	Defines values for RegistrationState.
RestrictionReasonCode	Defines values for RestrictionReasonCode. KnownRestrictionReasonCode can be used interchangeably with RestrictionReasonCode, this enum contains the known values that the service supports. Known values supported by the service QuotaId NotAvailableForSubscription
RestrictionType	Defines values for RestrictionType. KnownRestrictionType can be used interchangeably with RestrictionType, this enum contains the known values that the service supports. Known values supported by the service Location
ScaleType	Defines values for ScaleType. KnownScaleType can be used interchangeably with ScaleType, this enum contains the known values that the service supports. Known values supported by the service None: The capacity is not adjustable in any way. Manual: The user must manually scale this SKU in and out. Automatic: The user is permitted to scale this SKU in and out.
SchedulesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
SchedulesGetResponse	Contains response data for the get operation.
SchedulesListByLabNextResponse	Contains response data for the listByLabNext operation.
SchedulesListByLabResponse	Contains response data for the listByLab operation.
SchedulesUpdateResponse	Contains response data for the update operation.
ShutdownOnIdleMode	Defines values for ShutdownOnIdleMode.
SkuTier	Defines values for SkuTier.
SkusListNextResponse	Contains response data for the listNext operation.
SkusListResponse	Contains response data for the list operation.
UsageUnit	Defines values for UsageUnit. KnownUsageUnit can be used interchangeably with UsageUnit, this enum contains the known values that the service supports. Known values supported by the service Count
UsagesListByLocationNextResponse	Contains response data for the listByLocationNext operation.
UsagesListByLocationResponse	Contains response data for the listByLocation operation.
UsersCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
UsersGetResponse	Contains response data for the get operation.
UsersListByLabNextResponse	Contains response data for the listByLabNext operation.
UsersListByLabResponse	Contains response data for the listByLab operation.
UsersUpdateResponse	Contains response data for the update operation.
VirtualMachineState	Defines values for VirtualMachineState.
VirtualMachineType	Defines values for VirtualMachineType.
VirtualMachinesGetResponse	Contains response data for the get operation.
VirtualMachinesListByLabNextResponse	Contains response data for the listByLabNext operation.
VirtualMachinesListByLabResponse	Contains response data for the listByLab operation.
WeekDay	Defines values for WeekDay.

Enums

KnownActionType	Known values of ActionType that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownLabServicesSkuTier	Known values of LabServicesSkuTier that the service accepts.
KnownOrigin	Known values of Origin that the service accepts.
KnownRestrictionReasonCode	Known values of RestrictionReasonCode that the service accepts.
KnownRestrictionType	Known values of RestrictionType that the service accepts.
KnownScaleType	Known values of ScaleType that the service accepts.
KnownUsageUnit	Known values of UsageUnit that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.