@azure/arm-devtestlabs package
Classes
Interfaces
Applicable |
Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level. |
Applicable |
Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level. |
Apply |
Request body for applying artifacts to a virtual machine. |
Arm |
An Azure Resource Manager template. |
Arm |
Information about a generated ARM template. |
Arm |
The response of a list operation. |
Arm |
Properties of an Azure Resource Manager template parameter. |
Arm |
Interface representing a ArmTemplates. |
Arm |
Optional parameters. |
Arm |
Optional parameters. |
Arm |
Optional parameters. |
Artifact |
An artifact. |
Artifact |
Properties of an artifact deployment. |
Artifact |
Properties of an artifact. |
Artifact |
The response of a list operation. |
Artifact |
Properties of an artifact parameter. |
Artifact |
Properties of an artifact source. |
Artifact |
Properties of an artifact source. |
Artifact |
The response of a list operation. |
Artifact |
Interface representing a ArtifactSources. |
Artifact |
Optional parameters. |
Artifact |
Optional parameters. |
Artifact |
Optional parameters. |
Artifact |
Optional parameters. |
Artifact |
Optional parameters. |
Artifact |
Optional parameters. |
Artifacts |
Interface representing a Artifacts. |
Artifacts |
Optional parameters. |
Artifacts |
Optional parameters. |
Artifacts |
Optional parameters. |
Artifacts |
Optional parameters. |
Attach |
Properties of the disk to attach. |
Attach |
Properties to attach new disk to the Virtual Machine. |
Bulk |
Parameters for creating multiple virtual machines as a single action. |
Cloud |
Error from a REST request. |
Cloud |
Body of an error from a REST request. |
Compute |
A data disks attached to a virtual machine. |
Compute |
Status information about a virtual machine. |
Compute |
Properties of a virtual machine returned by the Microsoft.Compute API. |
Cost |
Properties of a cost threshold item. |
Costs |
Interface representing a Costs. |
Costs |
Optional parameters. |
Costs |
Optional parameters. |
Custom |
A custom image. |
Custom |
A custom image. |
Custom |
The response of a list operation. |
Custom |
Properties for creating a custom image from a VHD. |
Custom |
Properties for plan on a custom image. |
Custom |
Properties for creating a custom image from a virtual machine. |
Custom |
Interface representing a CustomImages. |
Custom |
Optional parameters. |
Custom |
Optional parameters. |
Custom |
Optional parameters. |
Custom |
Optional parameters. |
Custom |
Optional parameters. |
Custom |
Optional parameters. |
Data |
Request body for adding a new or existing data disk to a virtual machine. |
Data |
Storage information about the data disks present in the custom image |
Day |
Properties of a daily schedule. |
Detach |
Request body for detaching data disk from a virtual machine. |
Detach |
Properties of the disk to detach. |
Dev |
Optional parameters. |
Disk |
A Disk. |
Disk |
A Disk. |
Disk |
The response of a list operation. |
Disks |
Interface representing a Disks. |
Disks |
Optional parameters. |
Disks |
Optional parameters. |
Disks |
Optional parameters. |
Disks |
Optional parameters. |
Disks |
Optional parameters. |
Disks |
Optional parameters. |
Disks |
Optional parameters. |
Disks |
Optional parameters. |
Dtl |
An environment, which is essentially an ARM template deployment. |
Dtl |
An environment, which is essentially an ARM template deployment. |
Dtl |
The response of a list operation. |
Environment |
Properties of an environment deployment. |
Environments |
Interface representing a Environments. |
Environments |
Optional parameters. |
Environments |
Optional parameters. |
Environments |
Optional parameters. |
Environments |
Optional parameters. |
Environments |
Optional parameters. |
Environments |
Optional parameters. |
Evaluate |
Properties for evaluating a policy set. |
Evaluate |
Request body for evaluating a policy set. |
Evaluate |
Response body for evaluating a policy set. |
Event |
An event to be notified for. |
Export |
The parameters of the export operation. |
External |
Subnet information as returned by the Microsoft.Network API. |
Formula |
A formula for creating a VM, specifying an image base and other parameters |
Formula |
A formula for creating a VM, specifying an image base and other parameters |
Formula |
The response of a list operation. |
Formula |
Information about a VM from which a formula is to be created. |
Formulas |
Interface representing a Formulas. |
Formulas |
Optional parameters. |
Formulas |
Optional parameters. |
Formulas |
Optional parameters. |
Formulas |
Optional parameters. |
Formulas |
Optional parameters. |
Formulas |
Optional parameters. |
Gallery |
A gallery image. |
Gallery |
The response of a list operation. |
Gallery |
The reference information for an Azure Marketplace image. |
Gallery |
Interface representing a GalleryImages. |
Gallery |
Optional parameters. |
Gallery |
Optional parameters. |
Generate |
Parameters for generating an ARM template for deploying artifacts. |
Generate |
Properties for generating an upload URI. |
Generate |
Response body for generating an upload URI. |
Global |
Interface representing a GlobalSchedules. |
Global |
Optional parameters. |
Global |
Optional parameters. |
Global |
Optional parameters. |
Global |
Optional parameters. |
Global |
Optional parameters. |
Global |
Optional parameters. |
Global |
Optional parameters. |
Global |
Optional parameters. |
Global |
Optional parameters. |
Global |
Optional parameters. |
Hour |
Properties of an hourly schedule. |
Identity |
Properties of a managed identity |
Import |
This represents the payload required to import a virtual machine from a different lab into the current one |
Inbound |
A rule for NAT - exposing a VM's port (backendPort) on the public IP address using a load balancer. |
Lab |
A lab. |
Lab |
Properties of a lab's announcement banner |
Lab |
A cost item. |
Lab |
The properties of a lab cost item. |
Lab |
The properties of the cost summary. |
Lab |
A lab. |
Lab |
The response of a list operation. |
Lab |
The properties of a resource cost item. |
Lab |
Properties of a lab's support banner |
Lab |
Properties of a VHD in the lab. |
Lab |
The response of a list operation. |
Lab |
A virtual machine. |
Lab |
Properties for creating a virtual machine. |
Lab |
A virtual machine. |
Lab |
The response of a list operation. |
Labs |
Interface representing a Labs. |
Labs |
Optional parameters. |
Labs |
Optional parameters. |
Labs |
Optional parameters. |
Labs |
Optional parameters. |
Labs |
Optional parameters. |
Labs |
Optional parameters. |
Labs |
Optional parameters. |
Labs |
Optional parameters. |
Labs |
Optional parameters. |
Labs |
Optional parameters. |
Labs |
Optional parameters. |
Labs |
Optional parameters. |
Labs |
Optional parameters. |
Labs |
Optional parameters. |
Labs |
Optional parameters. |
Linux |
Information about a Linux OS. |
Network |
Properties of a network interface. |
Notification |
A notification. |
Notification |
A notification. |
Notification |
The response of a list operation. |
Notification |
Interface representing a NotificationChannels. |
Notification |
Optional parameters. |
Notification |
Optional parameters. |
Notification |
Optional parameters. |
Notification |
Optional parameters. |
Notification |
Optional parameters. |
Notification |
Optional parameters. |
Notification |
Optional parameters. |
Notification |
Notification settings for a schedule. |
Notify |
Properties for generating a Notification. |
Operation |
Error details for the operation in case of a failure. |
Operation |
The REST API operation supported by DevTestLab ResourceProvider. |
Operation |
The object that describes the operations |
Operation |
An Operation Result |
Operations |
Interface representing a Operations. |
Operations |
Optional parameters. |
Parameter |
Information about an artifact's parameter. |
Parameters |
A file containing a set of parameter values for an ARM template. |
Percentage |
Properties of a percentage cost threshold. |
Policies |
Interface representing a Policies. |
Policies |
Optional parameters. |
Policies |
Optional parameters. |
Policies |
Optional parameters. |
Policies |
Optional parameters. |
Policies |
Optional parameters. |
Policies |
Optional parameters. |
Policy |
A Policy. |
Policy |
A Policy. |
Policy |
The response of a list operation. |
Policy |
Result of a policy set evaluation. |
Policy |
Interface representing a PolicySets. |
Policy |
Optional parameters. |
Policy |
Policy violation. |
Port |
Properties of a network port. |
Provider |
Result of the request to list REST API operations |
Provider |
Interface representing a ProviderOperations. |
Provider |
Optional parameters. |
Provider |
Optional parameters. |
Rdp |
Represents a .rdp file |
Resize |
Request body for resizing a virtual machine. |
Resource |
An Azure resource. |
Retarget |
Properties for retargeting a virtual machine schedule. |
Schedule |
A schedule. |
Schedule |
Properties for creating a schedule. |
Schedule |
A schedule. |
Schedule |
The response of a list operation. |
Schedules |
Interface representing a Schedules. |
Schedules |
Optional parameters. |
Schedules |
Optional parameters. |
Schedules |
Optional parameters. |
Schedules |
Optional parameters. |
Schedules |
Optional parameters. |
Schedules |
Optional parameters. |
Schedules |
Optional parameters. |
Schedules |
Optional parameters. |
Schedules |
Optional parameters. |
Secret |
A secret. |
Secret |
A secret. |
Secret |
The response of a list operation. |
Secrets |
Interface representing a Secrets. |
Secrets |
Optional parameters. |
Secrets |
Optional parameters. |
Secrets |
Optional parameters. |
Secrets |
Optional parameters. |
Secrets |
Optional parameters. |
Secrets |
Optional parameters. |
Service |
A Service Fabric. |
Service |
A Service Fabric. |
Service |
The response of a list operation. |
Service |
Interface representing a ServiceFabricSchedules. |
Service |
Optional parameters. |
Service |
Optional parameters. |
Service |
Optional parameters. |
Service |
Optional parameters. |
Service |
Optional parameters. |
Service |
Optional parameters. |
Service |
Optional parameters. |
Service |
Interface representing a ServiceFabrics. |
Service |
Optional parameters. |
Service |
Optional parameters. |
Service |
Optional parameters. |
Service |
Optional parameters. |
Service |
Optional parameters. |
Service |
Optional parameters. |
Service |
Optional parameters. |
Service |
Optional parameters. |
Service |
Optional parameters. |
Service |
A container for a managed identity to execute DevTest lab services. |
Service |
The response of a list operation. |
Service |
Interface representing a ServiceRunners. |
Service |
Optional parameters. |
Service |
Optional parameters. |
Service |
Optional parameters. |
Shared |
Properties of a virtual machine that determine how it is connected to a load balancer. |
Shutdown |
The contents of a shutdown notification. Webhooks can use this type to deserialize the request body when they get notified of an imminent shutdown. |
Subnet |
Subnet information. |
Subnet |
Property overrides on a subnet of a virtual network. |
Subnet |
Configuration for public IP address sharing. |
Target |
Properties of a cost target. |
Update |
Represents an update resource |
User |
Profile of a lab user. |
User |
Profile of a lab user. |
User |
Identity attributes of a lab user. |
User |
The response of a list operation. |
User |
Properties of a user's secret store. |
Users |
Interface representing a Users. |
Users |
Optional parameters. |
Users |
Optional parameters. |
Users |
Optional parameters. |
Users |
Optional parameters. |
Users |
Optional parameters. |
Users |
Optional parameters. |
Virtual |
Interface representing a VirtualMachineSchedules. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Interface representing a VirtualMachines. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
A virtual network. |
Virtual |
A virtual network. |
Virtual |
The response of a list operation. |
Virtual |
Interface representing a VirtualNetworks. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Virtual |
Optional parameters. |
Week |
Properties of a weekly schedule. |
Windows |
Information about a Windows OS. |
Type Aliases
Arm |
Contains response data for the get operation. |
Arm |
Contains response data for the listNext operation. |
Arm |
Contains response data for the list operation. |
Artifact |
Contains response data for the createOrUpdate operation. |
Artifact |
Contains response data for the get operation. |
Artifact |
Contains response data for the listNext operation. |
Artifact |
Contains response data for the list operation. |
Artifact |
Contains response data for the update operation. |
Artifacts |
Contains response data for the generateArmTemplate operation. |
Artifacts |
Contains response data for the get operation. |
Artifacts |
Contains response data for the listNext operation. |
Artifacts |
Contains response data for the list operation. |
Cost |
Defines values for CostThresholdStatus. Known values supported by the serviceEnabled |
Cost |
Defines values for CostType. Known values supported by the serviceUnavailable |
Costs |
Contains response data for the createOrUpdate operation. |
Costs |
Contains response data for the get operation. |
Custom |
Defines values for CustomImageOsType. Known values supported by the serviceWindows |
Custom |
Contains response data for the createOrUpdate operation. |
Custom |
Contains response data for the get operation. |
Custom |
Contains response data for the listNext operation. |
Custom |
Contains response data for the list operation. |
Custom |
Contains response data for the update operation. |
Disks |
Contains response data for the createOrUpdate operation. |
Disks |
Contains response data for the get operation. |
Disks |
Contains response data for the listNext operation. |
Disks |
Contains response data for the list operation. |
Disks |
Contains response data for the update operation. |
Enable |
Defines values for EnableStatus. Known values supported by the serviceEnabled |
Environment |
Defines values for EnvironmentPermission. Known values supported by the serviceReader |
Environments |
Contains response data for the createOrUpdate operation. |
Environments |
Contains response data for the get operation. |
Environments |
Contains response data for the listNext operation. |
Environments |
Contains response data for the list operation. |
Environments |
Contains response data for the update operation. |
File |
Defines values for FileUploadOptions. Known values supported by the serviceUploadFilesAndGenerateSasTokens |
Formulas |
Contains response data for the createOrUpdate operation. |
Formulas |
Contains response data for the get operation. |
Formulas |
Contains response data for the listNext operation. |
Formulas |
Contains response data for the list operation. |
Formulas |
Contains response data for the update operation. |
Gallery |
Contains response data for the listNext operation. |
Gallery |
Contains response data for the list operation. |
Global |
Contains response data for the createOrUpdate operation. |
Global |
Contains response data for the get operation. |
Global |
Contains response data for the listByResourceGroupNext operation. |
Global |
Contains response data for the listByResourceGroup operation. |
Global |
Contains response data for the listBySubscriptionNext operation. |
Global |
Contains response data for the listBySubscription operation. |
Global |
Contains response data for the update operation. |
Host |
Defines values for HostCachingOptions. Known values supported by the serviceNone |
Http |
Defines values for HttpStatusCode. Known values supported by the serviceContinue |
Labs |
Contains response data for the createOrUpdate operation. |
Labs |
Contains response data for the generateUploadUri operation. |
Labs |
Contains response data for the get operation. |
Labs |
Contains response data for the listByResourceGroupNext operation. |
Labs |
Contains response data for the listByResourceGroup operation. |
Labs |
Contains response data for the listBySubscriptionNext operation. |
Labs |
Contains response data for the listBySubscription operation. |
Labs |
Contains response data for the listVhdsNext operation. |
Labs |
Contains response data for the listVhds operation. |
Labs |
Contains response data for the update operation. |
Linux |
Defines values for LinuxOsState. Known values supported by the serviceNonDeprovisioned |
Managed |
Defines values for ManagedIdentityType. Known values supported by the serviceNone |
Notification |
Defines values for NotificationChannelEventType. Known values supported by the serviceAutoShutdown |
Notification |
Contains response data for the createOrUpdate operation. |
Notification |
Contains response data for the get operation. |
Notification |
Contains response data for the listNext operation. |
Notification |
Contains response data for the list operation. |
Notification |
Contains response data for the update operation. |
Operations |
Contains response data for the get operation. |
Policies |
Contains response data for the createOrUpdate operation. |
Policies |
Contains response data for the get operation. |
Policies |
Contains response data for the listNext operation. |
Policies |
Contains response data for the list operation. |
Policies |
Contains response data for the update operation. |
Policy |
Defines values for PolicyEvaluatorType. Known values supported by the serviceAllowedValuesPolicy |
Policy |
Defines values for PolicyFactName. Known values supported by the serviceUserOwnedLabVmCount |
Policy |
Contains response data for the evaluatePolicies operation. |
Policy |
Defines values for PolicyStatus. Known values supported by the serviceEnabled |
Premium |
Defines values for PremiumDataDisk. Known values supported by the serviceDisabled |
Provider |
Contains response data for the listNext operation. |
Provider |
Contains response data for the list operation. |
Reporting |
Defines values for ReportingCycleType. Known values supported by the serviceCalendarMonth |
Schedules |
Contains response data for the createOrUpdate operation. |
Schedules |
Contains response data for the get operation. |
Schedules |
Contains response data for the listApplicableNext operation. |
Schedules |
Contains response data for the listApplicable operation. |
Schedules |
Contains response data for the listNext operation. |
Schedules |
Contains response data for the list operation. |
Schedules |
Contains response data for the update operation. |
Secrets |
Contains response data for the createOrUpdate operation. |
Secrets |
Contains response data for the get operation. |
Secrets |
Contains response data for the listNext operation. |
Secrets |
Contains response data for the list operation. |
Secrets |
Contains response data for the update operation. |
Service |
Contains response data for the createOrUpdate operation. |
Service |
Contains response data for the get operation. |
Service |
Contains response data for the listNext operation. |
Service |
Contains response data for the list operation. |
Service |
Contains response data for the update operation. |
Service |
Contains response data for the createOrUpdate operation. |
Service |
Contains response data for the get operation. |
Service |
Contains response data for the listApplicableSchedules operation. |
Service |
Contains response data for the listNext operation. |
Service |
Contains response data for the list operation. |
Service |
Contains response data for the update operation. |
Service |
Contains response data for the createOrUpdate operation. |
Service |
Contains response data for the get operation. |
Source |
Defines values for SourceControlType. Known values supported by the serviceVsoGit |
Storage |
Defines values for StorageType. Known values supported by the serviceStandard |
Target |
Defines values for TargetCostStatus. Known values supported by the serviceEnabled |
Transport |
Defines values for TransportProtocol. Known values supported by the serviceTcp |
Usage |
Defines values for UsagePermissionType. Known values supported by the serviceDefault |
Users |
Contains response data for the createOrUpdate operation. |
Users |
Contains response data for the get operation. |
Users |
Contains response data for the listNext operation. |
Users |
Contains response data for the list operation. |
Users |
Contains response data for the update operation. |
Virtual |
Defines values for VirtualMachineCreationSource. Known values supported by the serviceFromCustomImage |
Virtual |
Contains response data for the createOrUpdate operation. |
Virtual |
Contains response data for the get operation. |
Virtual |
Contains response data for the listNext operation. |
Virtual |
Contains response data for the list operation. |
Virtual |
Contains response data for the update operation. |
Virtual |
Contains response data for the createOrUpdate operation. |
Virtual |
Contains response data for the getRdpFileContents operation. |
Virtual |
Contains response data for the get operation. |
Virtual |
Contains response data for the listApplicableSchedules operation. |
Virtual |
Contains response data for the listNext operation. |
Virtual |
Contains response data for the list operation. |
Virtual |
Contains response data for the update operation. |
Virtual |
Contains response data for the createOrUpdate operation. |
Virtual |
Contains response data for the get operation. |
Virtual |
Contains response data for the listNext operation. |
Virtual |
Contains response data for the list operation. |
Virtual |
Contains response data for the update operation. |
Windows |
Defines values for WindowsOsState. Known values supported by the serviceNonSysprepped |
Enums
Known |
Known values of CostThresholdStatus that the service accepts. |
Known |
Known values of CostType that the service accepts. |
Known |
Known values of CustomImageOsType that the service accepts. |
Known |
Known values of EnableStatus that the service accepts. |
Known |
Known values of EnvironmentPermission that the service accepts. |
Known |
Known values of FileUploadOptions that the service accepts. |
Known |
Known values of HostCachingOptions that the service accepts. |
Known |
Known values of HttpStatusCode that the service accepts. |
Known |
Known values of LinuxOsState that the service accepts. |
Known |
Known values of ManagedIdentityType that the service accepts. |
Known |
Known values of NotificationChannelEventType that the service accepts. |
Known |
Known values of PolicyEvaluatorType that the service accepts. |
Known |
Known values of PolicyFactName that the service accepts. |
Known |
Known values of PolicyStatus that the service accepts. |
Known |
Known values of PremiumDataDisk that the service accepts. |
Known |
Known values of ReportingCycleType that the service accepts. |
Known |
Known values of SourceControlType that the service accepts. |
Known |
Known values of StorageType that the service accepts. |
Known |
Known values of TargetCostStatus that the service accepts. |
Known |
Known values of TransportProtocol that the service accepts. |
Known |
Known values of UsagePermissionType that the service accepts. |
Known |
Known values of VirtualMachineCreationSource that the service accepts. |
Known |
Known values of WindowsOsState that the service accepts. |
Functions
get |
Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later. |
getContinuationToken(unknown)
Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.
function getContinuationToken(page: unknown): string | undefined
Parameters
- page
-
unknown
A result object from calling .byPage() on a paged operation.
Returns
string | undefined
The continuation token that can be passed into byPage().