Microsoft.DevTestLab (stable:2018-09-15)

2025/08/29 • 132 new, 132 deleted methods

ProviderOperations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DevTestLab/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_ListBySubscription (new)
Description :  List labs in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/labs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=defaultStorageAccount)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Lab items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
defaultPremiumStorageAccount:
{
Description: The lab's default premium storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The lab's artifact storage account. ,
Required: False ,
}
string ,
premiumDataDiskStorageAccount:
{
Description: The lab's premium data disk storage account. ,
Required: False ,
}
string ,
vaultName:
{
Description: The lab's Key vault. ,
Required: False ,
}
string ,
labStorageType:
{
Description: Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
mandatoryArtifactsResourceIdsLinux:
{
Description: The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
mandatoryArtifactsResourceIdsWindows:
{
Description: The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
premiumDataDisks:
{
Description: The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
environmentPermission:
{
Description: The access rights to be granted to the user when provisioning an environment ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
}
,
Required: False ,
}
enum ,
announcement:
{
Description: The properties of any lab announcement associated with this lab ,
Required: False ,
}
{
title:
{
Description: The plain text title for the lab announcement ,
Required: False ,
}
string ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
enabled:
{
Description: Is the lab announcement active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
expirationDate:
{
Description: The time at which the announcement expires (null for never) ,
Format: date-time ,
Required: False ,
}
string ,
expired:
{
Description: Has this announcement expired? ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
support:
{
Description: The properties of any lab support message associated with this lab ,
Required: False ,
}
{
enabled:
{
Description: Is the lab support banner active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
}
,
vmCreationResourceGroup:
{
Description: The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null. ,
Required: False ,
}
string ,
publicIpId:
{
Description: The public IP address for the lab's load balancer. ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The load balancer used to for lab VMs that use shared IP address. ,
Required: False ,
}
string ,
networkSecurityGroupId:
{
Description: The Network Security Group attached to the lab VMs Network interfaces to restrict open ports. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: Extended properties of the lab used for experimental features ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_Get (new)
Description :  Get operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/locations/{locationName}/operations/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the location. ,
Required: True ,
}
string ,
name:
{
Description: The name of the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The operation status. ,
Required: False ,
}
string ,
statusCode:
{
Description: The status code for the operation. ,
Enum:
{
Continue: No description available. ,
SwitchingProtocols: No description available. ,
OK: No description available. ,
Created: No description available. ,
Accepted: No description available. ,
NonAuthoritativeInformation: No description available. ,
NoContent: No description available. ,
ResetContent: No description available. ,
PartialContent: No description available. ,
MultipleChoices: No description available. ,
Ambiguous: No description available. ,
MovedPermanently: No description available. ,
Moved: No description available. ,
Found: No description available. ,
Redirect: No description available. ,
SeeOther: No description available. ,
RedirectMethod: No description available. ,
NotModified: No description available. ,
UseProxy: No description available. ,
Unused: No description available. ,
TemporaryRedirect: No description available. ,
RedirectKeepVerb: No description available. ,
BadRequest: No description available. ,
Unauthorized: No description available. ,
PaymentRequired: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
MethodNotAllowed: No description available. ,
NotAcceptable: No description available. ,
ProxyAuthenticationRequired: No description available. ,
RequestTimeout: No description available. ,
Conflict: No description available. ,
Gone: No description available. ,
LengthRequired: No description available. ,
PreconditionFailed: No description available. ,
RequestEntityTooLarge: No description available. ,
RequestUriTooLong: No description available. ,
UnsupportedMediaType: No description available. ,
RequestedRangeNotSatisfiable: No description available. ,
ExpectationFailed: No description available. ,
UpgradeRequired: No description available. ,
InternalServerError: No description available. ,
NotImplemented: No description available. ,
BadGateway: No description available. ,
ServiceUnavailable: No description available. ,
GatewayTimeout: No description available. ,
HttpVersionNotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error details for the operation in case of a failure. ,
Required: False ,
}
{
code:
{
Description: The error code of the operation error. ,
Required: False ,
}
string ,
message:
{
Description: The error message of the operation error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
status:
{
Description: The operation status. ,
Required: False ,
}
string ,
statusCode:
{
Description: The status code for the operation. ,
Enum:
{
Continue: No description available. ,
SwitchingProtocols: No description available. ,
OK: No description available. ,
Created: No description available. ,
Accepted: No description available. ,
NonAuthoritativeInformation: No description available. ,
NoContent: No description available. ,
ResetContent: No description available. ,
PartialContent: No description available. ,
MultipleChoices: No description available. ,
Ambiguous: No description available. ,
MovedPermanently: No description available. ,
Moved: No description available. ,
Found: No description available. ,
Redirect: No description available. ,
SeeOther: No description available. ,
RedirectMethod: No description available. ,
NotModified: No description available. ,
UseProxy: No description available. ,
Unused: No description available. ,
TemporaryRedirect: No description available. ,
RedirectKeepVerb: No description available. ,
BadRequest: No description available. ,
Unauthorized: No description available. ,
PaymentRequired: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
MethodNotAllowed: No description available. ,
NotAcceptable: No description available. ,
ProxyAuthenticationRequired: No description available. ,
RequestTimeout: No description available. ,
Conflict: No description available. ,
Gone: No description available. ,
LengthRequired: No description available. ,
PreconditionFailed: No description available. ,
RequestEntityTooLarge: No description available. ,
RequestUriTooLong: No description available. ,
UnsupportedMediaType: No description available. ,
RequestedRangeNotSatisfiable: No description available. ,
ExpectationFailed: No description available. ,
UpgradeRequired: No description available. ,
InternalServerError: No description available. ,
NotImplemented: No description available. ,
BadGateway: No description available. ,
ServiceUnavailable: No description available. ,
GatewayTimeout: No description available. ,
HttpVersionNotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error details for the operation in case of a failure. ,
Required: False ,
}
{
code:
{
Description: The error code of the operation error. ,
Required: False ,
}
string ,
message:
{
Description: The error message of the operation error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchedules_ListBySubscription (new)
Description :  List schedules in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/schedules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=status)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Schedule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_ListByResourceGroup (new)
Description :  List labs in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=defaultStorageAccount)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Lab items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
defaultPremiumStorageAccount:
{
Description: The lab's default premium storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The lab's artifact storage account. ,
Required: False ,
}
string ,
premiumDataDiskStorageAccount:
{
Description: The lab's premium data disk storage account. ,
Required: False ,
}
string ,
vaultName:
{
Description: The lab's Key vault. ,
Required: False ,
}
string ,
labStorageType:
{
Description: Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
mandatoryArtifactsResourceIdsLinux:
{
Description: The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
mandatoryArtifactsResourceIdsWindows:
{
Description: The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
premiumDataDisks:
{
Description: The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
environmentPermission:
{
Description: The access rights to be granted to the user when provisioning an environment ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
}
,
Required: False ,
}
enum ,
announcement:
{
Description: The properties of any lab announcement associated with this lab ,
Required: False ,
}
{
title:
{
Description: The plain text title for the lab announcement ,
Required: False ,
}
string ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
enabled:
{
Description: Is the lab announcement active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
expirationDate:
{
Description: The time at which the announcement expires (null for never) ,
Format: date-time ,
Required: False ,
}
string ,
expired:
{
Description: Has this announcement expired? ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
support:
{
Description: The properties of any lab support message associated with this lab ,
Required: False ,
}
{
enabled:
{
Description: Is the lab support banner active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
}
,
vmCreationResourceGroup:
{
Description: The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null. ,
Required: False ,
}
string ,
publicIpId:
{
Description: The public IP address for the lab's load balancer. ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The load balancer used to for lab VMs that use shared IP address. ,
Required: False ,
}
string ,
networkSecurityGroupId:
{
Description: The Network Security Group attached to the lab VMs Network interfaces to restrict open ports. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: Extended properties of the lab used for experimental features ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_Get (new)
Description :  Get lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=defaultStorageAccount)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
defaultPremiumStorageAccount:
{
Description: The lab's default premium storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The lab's artifact storage account. ,
Required: False ,
}
string ,
premiumDataDiskStorageAccount:
{
Description: The lab's premium data disk storage account. ,
Required: False ,
}
string ,
vaultName:
{
Description: The lab's Key vault. ,
Required: False ,
}
string ,
labStorageType:
{
Description: Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
mandatoryArtifactsResourceIdsLinux:
{
Description: The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
mandatoryArtifactsResourceIdsWindows:
{
Description: The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
premiumDataDisks:
{
Description: The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
environmentPermission:
{
Description: The access rights to be granted to the user when provisioning an environment ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
}
,
Required: False ,
}
enum ,
announcement:
{
Description: The properties of any lab announcement associated with this lab ,
Required: False ,
}
{
title:
{
Description: The plain text title for the lab announcement ,
Required: False ,
}
string ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
enabled:
{
Description: Is the lab announcement active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
expirationDate:
{
Description: The time at which the announcement expires (null for never) ,
Format: date-time ,
Required: False ,
}
string ,
expired:
{
Description: Has this announcement expired? ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
support:
{
Description: The properties of any lab support message associated with this lab ,
Required: False ,
}
{
enabled:
{
Description: Is the lab support banner active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
}
,
vmCreationResourceGroup:
{
Description: The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null. ,
Required: False ,
}
string ,
publicIpId:
{
Description: The public IP address for the lab's load balancer. ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The load balancer used to for lab VMs that use shared IP address. ,
Required: False ,
}
string ,
networkSecurityGroupId:
{
Description: The Network Security Group attached to the lab VMs Network interfaces to restrict open ports. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: Extended properties of the lab used for experimental features ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_CreateOrUpdate (new)
Description :  Create or replace an existing lab. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
lab:
{
Description: A lab. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
defaultPremiumStorageAccount:
{
Description: The lab's default premium storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The lab's artifact storage account. ,
Required: False ,
}
string ,
premiumDataDiskStorageAccount:
{
Description: The lab's premium data disk storage account. ,
Required: False ,
}
string ,
vaultName:
{
Description: The lab's Key vault. ,
Required: False ,
}
string ,
labStorageType:
{
Description: Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
mandatoryArtifactsResourceIdsLinux:
{
Description: The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
mandatoryArtifactsResourceIdsWindows:
{
Description: The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
premiumDataDisks:
{
Description: The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
environmentPermission:
{
Description: The access rights to be granted to the user when provisioning an environment ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
}
,
Required: False ,
}
enum ,
announcement:
{
Description: The properties of any lab announcement associated with this lab ,
Required: False ,
}
{
title:
{
Description: The plain text title for the lab announcement ,
Required: False ,
}
string ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
enabled:
{
Description: Is the lab announcement active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
expirationDate:
{
Description: The time at which the announcement expires (null for never) ,
Format: date-time ,
Required: False ,
}
string ,
expired:
{
Description: Has this announcement expired? ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
support:
{
Description: The properties of any lab support message associated with this lab ,
Required: False ,
}
{
enabled:
{
Description: Is the lab support banner active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
}
,
vmCreationResourceGroup:
{
Description: The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null. ,
Required: False ,
}
string ,
publicIpId:
{
Description: The public IP address for the lab's load balancer. ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The load balancer used to for lab VMs that use shared IP address. ,
Required: False ,
}
string ,
networkSecurityGroupId:
{
Description: The Network Security Group attached to the lab VMs Network interfaces to restrict open ports. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: Extended properties of the lab used for experimental features ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
defaultPremiumStorageAccount:
{
Description: The lab's default premium storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The lab's artifact storage account. ,
Required: False ,
}
string ,
premiumDataDiskStorageAccount:
{
Description: The lab's premium data disk storage account. ,
Required: False ,
}
string ,
vaultName:
{
Description: The lab's Key vault. ,
Required: False ,
}
string ,
labStorageType:
{
Description: Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
mandatoryArtifactsResourceIdsLinux:
{
Description: The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
mandatoryArtifactsResourceIdsWindows:
{
Description: The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
premiumDataDisks:
{
Description: The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
environmentPermission:
{
Description: The access rights to be granted to the user when provisioning an environment ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
}
,
Required: False ,
}
enum ,
announcement:
{
Description: The properties of any lab announcement associated with this lab ,
Required: False ,
}
{
title:
{
Description: The plain text title for the lab announcement ,
Required: False ,
}
string ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
enabled:
{
Description: Is the lab announcement active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
expirationDate:
{
Description: The time at which the announcement expires (null for never) ,
Format: date-time ,
Required: False ,
}
string ,
expired:
{
Description: Has this announcement expired? ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
support:
{
Description: The properties of any lab support message associated with this lab ,
Required: False ,
}
{
enabled:
{
Description: Is the lab support banner active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
}
,
vmCreationResourceGroup:
{
Description: The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null. ,
Required: False ,
}
string ,
publicIpId:
{
Description: The public IP address for the lab's load balancer. ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The load balancer used to for lab VMs that use shared IP address. ,
Required: False ,
}
string ,
networkSecurityGroupId:
{
Description: The Network Security Group attached to the lab VMs Network interfaces to restrict open ports. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: Extended properties of the lab used for experimental features ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A lab. ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
defaultPremiumStorageAccount:
{
Description: The lab's default premium storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The lab's artifact storage account. ,
Required: False ,
}
string ,
premiumDataDiskStorageAccount:
{
Description: The lab's premium data disk storage account. ,
Required: False ,
}
string ,
vaultName:
{
Description: The lab's Key vault. ,
Required: False ,
}
string ,
labStorageType:
{
Description: Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
mandatoryArtifactsResourceIdsLinux:
{
Description: The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
mandatoryArtifactsResourceIdsWindows:
{
Description: The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
premiumDataDisks:
{
Description: The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
environmentPermission:
{
Description: The access rights to be granted to the user when provisioning an environment ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
}
,
Required: False ,
}
enum ,
announcement:
{
Description: The properties of any lab announcement associated with this lab ,
Required: False ,
}
{
title:
{
Description: The plain text title for the lab announcement ,
Required: False ,
}
string ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
enabled:
{
Description: Is the lab announcement active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
expirationDate:
{
Description: The time at which the announcement expires (null for never) ,
Format: date-time ,
Required: False ,
}
string ,
expired:
{
Description: Has this announcement expired? ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
support:
{
Description: The properties of any lab support message associated with this lab ,
Required: False ,
}
{
enabled:
{
Description: Is the lab support banner active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
}
,
vmCreationResourceGroup:
{
Description: The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null. ,
Required: False ,
}
string ,
publicIpId:
{
Description: The public IP address for the lab's load balancer. ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The load balancer used to for lab VMs that use shared IP address. ,
Required: False ,
}
string ,
networkSecurityGroupId:
{
Description: The Network Security Group attached to the lab VMs Network interfaces to restrict open ports. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: Extended properties of the lab used for experimental features ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_Update (new)
Description :  Allows modifying tags of labs. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
lab:
{
Description: A lab. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
defaultPremiumStorageAccount:
{
Description: The lab's default premium storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The lab's artifact storage account. ,
Required: False ,
}
string ,
premiumDataDiskStorageAccount:
{
Description: The lab's premium data disk storage account. ,
Required: False ,
}
string ,
vaultName:
{
Description: The lab's Key vault. ,
Required: False ,
}
string ,
labStorageType:
{
Description: Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
mandatoryArtifactsResourceIdsLinux:
{
Description: The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
mandatoryArtifactsResourceIdsWindows:
{
Description: The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
premiumDataDisks:
{
Description: The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
environmentPermission:
{
Description: The access rights to be granted to the user when provisioning an environment ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
}
,
Required: False ,
}
enum ,
announcement:
{
Description: The properties of any lab announcement associated with this lab ,
Required: False ,
}
{
title:
{
Description: The plain text title for the lab announcement ,
Required: False ,
}
string ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
enabled:
{
Description: Is the lab announcement active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
expirationDate:
{
Description: The time at which the announcement expires (null for never) ,
Format: date-time ,
Required: False ,
}
string ,
expired:
{
Description: Has this announcement expired? ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
support:
{
Description: The properties of any lab support message associated with this lab ,
Required: False ,
}
{
enabled:
{
Description: Is the lab support banner active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
}
,
vmCreationResourceGroup:
{
Description: The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null. ,
Required: False ,
}
string ,
publicIpId:
{
Description: The public IP address for the lab's load balancer. ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The load balancer used to for lab VMs that use shared IP address. ,
Required: False ,
}
string ,
networkSecurityGroupId:
{
Description: The Network Security Group attached to the lab VMs Network interfaces to restrict open ports. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: Extended properties of the lab used for experimental features ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_Delete (new)
Description :  Delete lab. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArtifactSources_List (new)
Description :  List artifact sources in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=displayName)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ArtifactSource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
displayName:
{
Description: The artifact source's display name. ,
Required: False ,
}
string ,
uri:
{
Description: The artifact source's URI. ,
Required: False ,
}
string ,
sourceType:
{
Description: The artifact source's type. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
StorageAccount: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder containing artifacts. ,
Required: False ,
}
string ,
armTemplateFolderPath:
{
Description: The folder containing Azure Resource Manager templates. ,
Required: False ,
}
string ,
branchRef:
{
Description: The artifact source's branch reference. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token to authenticate to the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the artifact source is enabled (values: Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The artifact source's creation date. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArtifactSources_Get (new)
Description :  Get artifact source.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ArtifactSource ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=displayName)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
displayName:
{
Description: The artifact source's display name. ,
Required: False ,
}
string ,
uri:
{
Description: The artifact source's URI. ,
Required: False ,
}
string ,
sourceType:
{
Description: The artifact source's type. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
StorageAccount: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder containing artifacts. ,
Required: False ,
}
string ,
armTemplateFolderPath:
{
Description: The folder containing Azure Resource Manager templates. ,
Required: False ,
}
string ,
branchRef:
{
Description: The artifact source's branch reference. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token to authenticate to the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the artifact source is enabled (values: Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The artifact source's creation date. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArtifactSources_CreateOrUpdate (new)
Description :  Create or replace an existing artifact source.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ArtifactSource ,
Required: True ,
}
string ,
artifactSource:
{
Description: Properties of an artifact source. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
displayName:
{
Description: The artifact source's display name. ,
Required: False ,
}
string ,
uri:
{
Description: The artifact source's URI. ,
Required: False ,
}
string ,
sourceType:
{
Description: The artifact source's type. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
StorageAccount: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder containing artifacts. ,
Required: False ,
}
string ,
armTemplateFolderPath:
{
Description: The folder containing Azure Resource Manager templates. ,
Required: False ,
}
string ,
branchRef:
{
Description: The artifact source's branch reference. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token to authenticate to the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the artifact source is enabled (values: Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The artifact source's creation date. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
displayName:
{
Description: The artifact source's display name. ,
Required: False ,
}
string ,
uri:
{
Description: The artifact source's URI. ,
Required: False ,
}
string ,
sourceType:
{
Description: The artifact source's type. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
StorageAccount: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder containing artifacts. ,
Required: False ,
}
string ,
armTemplateFolderPath:
{
Description: The folder containing Azure Resource Manager templates. ,
Required: False ,
}
string ,
branchRef:
{
Description: The artifact source's branch reference. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token to authenticate to the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the artifact source is enabled (values: Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The artifact source's creation date. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
displayName:
{
Description: The artifact source's display name. ,
Required: False ,
}
string ,
uri:
{
Description: The artifact source's URI. ,
Required: False ,
}
string ,
sourceType:
{
Description: The artifact source's type. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
StorageAccount: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder containing artifacts. ,
Required: False ,
}
string ,
armTemplateFolderPath:
{
Description: The folder containing Azure Resource Manager templates. ,
Required: False ,
}
string ,
branchRef:
{
Description: The artifact source's branch reference. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token to authenticate to the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the artifact source is enabled (values: Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The artifact source's creation date. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArtifactSources_Update (new)
Description :  Allows modifying tags of artifact sources. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ArtifactSource ,
Required: True ,
}
string ,
artifactSource:
{
Description: Properties of an artifact source. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
displayName:
{
Description: The artifact source's display name. ,
Required: False ,
}
string ,
uri:
{
Description: The artifact source's URI. ,
Required: False ,
}
string ,
sourceType:
{
Description: The artifact source's type. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
StorageAccount: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder containing artifacts. ,
Required: False ,
}
string ,
armTemplateFolderPath:
{
Description: The folder containing Azure Resource Manager templates. ,
Required: False ,
}
string ,
branchRef:
{
Description: The artifact source's branch reference. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token to authenticate to the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the artifact source is enabled (values: Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The artifact source's creation date. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArtifactSources_Delete (new)
Description :  Delete artifact source.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ArtifactSource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArmTemplates_List (new)
Description :  List azure resource manager templates in a given artifact source.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/armtemplates
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
artifactSourceName:
{
Description: The name of the artifact source. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=displayName)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ArmTemplate items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
displayName:
{
Description: The display name of the ARM template. ,
Required: False ,
}
string ,
description:
{
Description: The description of the ARM template. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the ARM template. ,
Required: False ,
}
string ,
icon:
{
Description: The URI to the icon of the ARM template. ,
Required: False ,
}
string ,
contents:
{
Description: The contents of the ARM template. ,
Required: False ,
}
object ,
createdDate:
{
Description: The creation date of the armTemplate. ,
Format: date-time ,
Required: False ,
}
string ,
parametersValueFilesInfo:
{
Description: File name and parameter values information from all azuredeploy.*.parameters.json for the ARM template. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
parametersValueInfo:
{
Description: Contents of the file. ,
Required: False ,
}
object ,
}
,
]
,
enabled:
{
Description: Whether or not ARM template is enabled for use by lab user. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArmTemplates_Get (new)
Description :  Get azure resource manager template.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/armtemplates/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
artifactSourceName:
{
Description: The name of the artifact source. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ArmTemplate ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=displayName)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
displayName:
{
Description: The display name of the ARM template. ,
Required: False ,
}
string ,
description:
{
Description: The description of the ARM template. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the ARM template. ,
Required: False ,
}
string ,
icon:
{
Description: The URI to the icon of the ARM template. ,
Required: False ,
}
string ,
contents:
{
Description: The contents of the ARM template. ,
Required: False ,
}
object ,
createdDate:
{
Description: The creation date of the armTemplate. ,
Format: date-time ,
Required: False ,
}
string ,
parametersValueFilesInfo:
{
Description: File name and parameter values information from all azuredeploy.*.parameters.json for the ARM template. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
parametersValueInfo:
{
Description: Contents of the file. ,
Required: False ,
}
object ,
}
,
]
,
enabled:
{
Description: Whether or not ARM template is enabled for use by lab user. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Artifacts_List (new)
Description :  List artifacts in a given artifact source.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
artifactSourceName:
{
Description: The name of the artifact source. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=title)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Artifact items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
title:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
description:
{
Description: The artifact's description. ,
Required: False ,
}
string ,
publisher:
{
Description: The artifact's publisher. ,
Required: False ,
}
string ,
filePath:
{
Description: The file path to the artifact. ,
Required: False ,
}
string ,
icon:
{
Description: The URI to the artifact icon. ,
Required: False ,
}
string ,
targetOsType:
{
Description: The artifact's target OS. ,
Required: False ,
}
string ,
parameters:
{
Description: The artifact's parameters. ,
Required: False ,
}
object ,
createdDate:
{
Description: The artifact's creation date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Artifacts_Get (new)
Description :  Get artifact.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
artifactSourceName:
{
Description: The name of the artifact source. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Artifact ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=title)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
title:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
description:
{
Description: The artifact's description. ,
Required: False ,
}
string ,
publisher:
{
Description: The artifact's publisher. ,
Required: False ,
}
string ,
filePath:
{
Description: The file path to the artifact. ,
Required: False ,
}
string ,
icon:
{
Description: The URI to the artifact icon. ,
Required: False ,
}
string ,
targetOsType:
{
Description: The artifact's target OS. ,
Required: False ,
}
string ,
parameters:
{
Description: The artifact's parameters. ,
Required: False ,
}
object ,
createdDate:
{
Description: The artifact's creation date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Artifacts_GenerateArmTemplate (new)
Description :  Generates an ARM template for the given artifact, uploads the required files to a storage account, and validates the generated artifact.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts/{name}/generateArmTemplate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
artifactSourceName:
{
Description: The name of the artifact source. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Artifact ,
Required: True ,
}
string ,
generateArmTemplateRequest:
{
Description: Parameters for generating an ARM template for deploying artifacts. ,
Required: True ,
}
{
virtualMachineName:
{
Description: The resource name of the virtual machine. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the ARM template. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
location:
{
Description: The location of the virtual machine. ,
Required: False ,
}
string ,
fileUploadOptions:
{
Description: Options for uploading the files for the artifact. UploadFilesAndGenerateSasTokens is the default value. ,
Enum:
{
UploadFilesAndGenerateSasTokens: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
template:
{
Description: The template's contents. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters of the ARM template. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_ClaimAnyVm (new)
Description :  Claim a random claimable virtual machine in the lab. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/claimAnyVm
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Costs_Get (new)
Description :  Get cost.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/costs/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabCost ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=labCostDetails)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
targetCost:
{
Description: The target cost properties ,
Required: False ,
}
{
status:
{
Description: Target cost status ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Lab target cost ,
Format: int32 ,
Required: False ,
}
integer ,
costThresholds:
{
Description: Cost thresholds. ,
Required: False ,
}
[
{
thresholdId:
{
Description: The ID of the cost threshold item. ,
Required: False ,
}
string ,
percentageThreshold:
{
Description: The value of the percentage cost threshold. ,
Required: False ,
}
{
thresholdValue:
{
Description: The cost threshold value. ,
Format: double ,
Required: False ,
}
number ,
}
,
displayOnChart:
{
Description: Indicates whether this threshold will be displayed on cost charts. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
sendNotificationWhenExceeded:
{
Description: Indicates whether notifications will be sent when this threshold is exceeded. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notificationSent:
{
Description: Indicates the datetime when notifications were last sent for this threshold. ,
Required: False ,
}
string ,
}
,
]
,
cycleStartDateTime:
{
Description: Reporting cycle start date. ,
Format: date-time ,
Required: False ,
}
string ,
cycleEndDateTime:
{
Description: Reporting cycle end date. ,
Format: date-time ,
Required: False ,
}
string ,
cycleType:
{
Description: Reporting cycle type. ,
Enum:
{
CalendarMonth: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
labCostSummary:
{
Description: The lab cost summary component of the cost data. ,
Required: False ,
}
{
estimatedLabCost:
{
Description: The cost component of the cost item. ,
Format: double ,
Required: False ,
}
number ,
}
,
labCostDetails:
{
Description: The lab cost details component of the cost data. ,
Required: False ,
}
[
{
date:
{
Description: The date of the cost item. ,
Format: date-time ,
Required: False ,
}
string ,
cost:
{
Description: The cost component of the cost item. ,
Format: double ,
Required: False ,
}
number ,
costType:
{
Description: The type of the cost. ,
Enum:
{
Unavailable: No description available. ,
Reported: No description available. ,
Projected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceCosts:
{
Description: The resource cost component of the cost data. ,
Required: False ,
}
[
{
resourcename:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
resourceUId:
{
Description: The unique identifier of the resource. ,
Required: False ,
}
string ,
resourceCost:
{
Description: The cost component of the resource cost item. ,
Format: double ,
Required: False ,
}
number ,
resourceType:
{
Description: The logical resource type (ex. virtualmachine, storageaccount) ,
Required: False ,
}
string ,
resourceOwner:
{
Description: The owner of the resource (ex. janedoe@microsoft.com) ,
Required: False ,
}
string ,
resourcePricingTier:
{
Description: The category of the resource (ex. Premium_LRS, Standard_DS1) ,
Required: False ,
}
string ,
resourceStatus:
{
Description: The status of the resource (ex. Active) ,
Required: False ,
}
string ,
resourceId:
{
Description: The ID of the resource ,
Required: False ,
}
string ,
externalResourceId:
{
Description: The ID of the external resource ,
Required: False ,
}
string ,
}
,
]
,
currencyCode:
{
Description: The currency code of the cost. ,
Required: False ,
}
string ,
startDateTime:
{
Description: The start time of the cost data. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The end time of the cost data. ,
Format: date-time ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the cost. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Costs_CreateOrUpdate (new)
Description :  Create or replace an existing cost.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/costs/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabCost ,
Required: True ,
}
string ,
labCost:
{
Description: A cost item. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
targetCost:
{
Description: The target cost properties ,
Required: False ,
}
{
status:
{
Description: Target cost status ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Lab target cost ,
Format: int32 ,
Required: False ,
}
integer ,
costThresholds:
{
Description: Cost thresholds. ,
Required: False ,
}
[
{
thresholdId:
{
Description: The ID of the cost threshold item. ,
Required: False ,
}
string ,
percentageThreshold:
{
Description: The value of the percentage cost threshold. ,
Required: False ,
}
{
thresholdValue:
{
Description: The cost threshold value. ,
Format: double ,
Required: False ,
}
number ,
}
,
displayOnChart:
{
Description: Indicates whether this threshold will be displayed on cost charts. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
sendNotificationWhenExceeded:
{
Description: Indicates whether notifications will be sent when this threshold is exceeded. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notificationSent:
{
Description: Indicates the datetime when notifications were last sent for this threshold. ,
Required: False ,
}
string ,
}
,
]
,
cycleStartDateTime:
{
Description: Reporting cycle start date. ,
Format: date-time ,
Required: False ,
}
string ,
cycleEndDateTime:
{
Description: Reporting cycle end date. ,
Format: date-time ,
Required: False ,
}
string ,
cycleType:
{
Description: Reporting cycle type. ,
Enum:
{
CalendarMonth: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
labCostSummary:
{
Description: The lab cost summary component of the cost data. ,
Required: False ,
}
{
estimatedLabCost:
{
Description: The cost component of the cost item. ,
Format: double ,
Required: False ,
}
number ,
}
,
labCostDetails:
{
Description: The lab cost details component of the cost data. ,
Required: False ,
}
[
{
date:
{
Description: The date of the cost item. ,
Format: date-time ,
Required: False ,
}
string ,
cost:
{
Description: The cost component of the cost item. ,
Format: double ,
Required: False ,
}
number ,
costType:
{
Description: The type of the cost. ,
Enum:
{
Unavailable: No description available. ,
Reported: No description available. ,
Projected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceCosts:
{
Description: The resource cost component of the cost data. ,
Required: False ,
}
[
{
resourcename:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
resourceUId:
{
Description: The unique identifier of the resource. ,
Required: False ,
}
string ,
resourceCost:
{
Description: The cost component of the resource cost item. ,
Format: double ,
Required: False ,
}
number ,
resourceType:
{
Description: The logical resource type (ex. virtualmachine, storageaccount) ,
Required: False ,
}
string ,
resourceOwner:
{
Description: The owner of the resource (ex. janedoe@microsoft.com) ,
Required: False ,
}
string ,
resourcePricingTier:
{
Description: The category of the resource (ex. Premium_LRS, Standard_DS1) ,
Required: False ,
}
string ,
resourceStatus:
{
Description: The status of the resource (ex. Active) ,
Required: False ,
}
string ,
resourceId:
{
Description: The ID of the resource ,
Required: False ,
}
string ,
externalResourceId:
{
Description: The ID of the external resource ,
Required: False ,
}
string ,
}
,
]
,
currencyCode:
{
Description: The currency code of the cost. ,
Required: False ,
}
string ,
startDateTime:
{
Description: The start time of the cost data. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The end time of the cost data. ,
Format: date-time ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the cost. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
targetCost:
{
Description: The target cost properties ,
Required: False ,
}
{
status:
{
Description: Target cost status ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Lab target cost ,
Format: int32 ,
Required: False ,
}
integer ,
costThresholds:
{
Description: Cost thresholds. ,
Required: False ,
}
[
{
thresholdId:
{
Description: The ID of the cost threshold item. ,
Required: False ,
}
string ,
percentageThreshold:
{
Description: The value of the percentage cost threshold. ,
Required: False ,
}
{
thresholdValue:
{
Description: The cost threshold value. ,
Format: double ,
Required: False ,
}
number ,
}
,
displayOnChart:
{
Description: Indicates whether this threshold will be displayed on cost charts. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
sendNotificationWhenExceeded:
{
Description: Indicates whether notifications will be sent when this threshold is exceeded. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notificationSent:
{
Description: Indicates the datetime when notifications were last sent for this threshold. ,
Required: False ,
}
string ,
}
,
]
,
cycleStartDateTime:
{
Description: Reporting cycle start date. ,
Format: date-time ,
Required: False ,
}
string ,
cycleEndDateTime:
{
Description: Reporting cycle end date. ,
Format: date-time ,
Required: False ,
}
string ,
cycleType:
{
Description: Reporting cycle type. ,
Enum:
{
CalendarMonth: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
labCostSummary:
{
Description: The lab cost summary component of the cost data. ,
Required: False ,
}
{
estimatedLabCost:
{
Description: The cost component of the cost item. ,
Format: double ,
Required: False ,
}
number ,
}
,
labCostDetails:
{
Description: The lab cost details component of the cost data. ,
Required: False ,
}
[
{
date:
{
Description: The date of the cost item. ,
Format: date-time ,
Required: False ,
}
string ,
cost:
{
Description: The cost component of the cost item. ,
Format: double ,
Required: False ,
}
number ,
costType:
{
Description: The type of the cost. ,
Enum:
{
Unavailable: No description available. ,
Reported: No description available. ,
Projected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceCosts:
{
Description: The resource cost component of the cost data. ,
Required: False ,
}
[
{
resourcename:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
resourceUId:
{
Description: The unique identifier of the resource. ,
Required: False ,
}
string ,
resourceCost:
{
Description: The cost component of the resource cost item. ,
Format: double ,
Required: False ,
}
number ,
resourceType:
{
Description: The logical resource type (ex. virtualmachine, storageaccount) ,
Required: False ,
}
string ,
resourceOwner:
{
Description: The owner of the resource (ex. janedoe@microsoft.com) ,
Required: False ,
}
string ,
resourcePricingTier:
{
Description: The category of the resource (ex. Premium_LRS, Standard_DS1) ,
Required: False ,
}
string ,
resourceStatus:
{
Description: The status of the resource (ex. Active) ,
Required: False ,
}
string ,
resourceId:
{
Description: The ID of the resource ,
Required: False ,
}
string ,
externalResourceId:
{
Description: The ID of the external resource ,
Required: False ,
}
string ,
}
,
]
,
currencyCode:
{
Description: The currency code of the cost. ,
Required: False ,
}
string ,
startDateTime:
{
Description: The start time of the cost data. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The end time of the cost data. ,
Format: date-time ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the cost. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
targetCost:
{
Description: The target cost properties ,
Required: False ,
}
{
status:
{
Description: Target cost status ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Lab target cost ,
Format: int32 ,
Required: False ,
}
integer ,
costThresholds:
{
Description: Cost thresholds. ,
Required: False ,
}
[
{
thresholdId:
{
Description: The ID of the cost threshold item. ,
Required: False ,
}
string ,
percentageThreshold:
{
Description: The value of the percentage cost threshold. ,
Required: False ,
}
{
thresholdValue:
{
Description: The cost threshold value. ,
Format: double ,
Required: False ,
}
number ,
}
,
displayOnChart:
{
Description: Indicates whether this threshold will be displayed on cost charts. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
sendNotificationWhenExceeded:
{
Description: Indicates whether notifications will be sent when this threshold is exceeded. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notificationSent:
{
Description: Indicates the datetime when notifications were last sent for this threshold. ,
Required: False ,
}
string ,
}
,
]
,
cycleStartDateTime:
{
Description: Reporting cycle start date. ,
Format: date-time ,
Required: False ,
}
string ,
cycleEndDateTime:
{
Description: Reporting cycle end date. ,
Format: date-time ,
Required: False ,
}
string ,
cycleType:
{
Description: Reporting cycle type. ,
Enum:
{
CalendarMonth: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
labCostSummary:
{
Description: The lab cost summary component of the cost data. ,
Required: False ,
}
{
estimatedLabCost:
{
Description: The cost component of the cost item. ,
Format: double ,
Required: False ,
}
number ,
}
,
labCostDetails:
{
Description: The lab cost details component of the cost data. ,
Required: False ,
}
[
{
date:
{
Description: The date of the cost item. ,
Format: date-time ,
Required: False ,
}
string ,
cost:
{
Description: The cost component of the cost item. ,
Format: double ,
Required: False ,
}
number ,
costType:
{
Description: The type of the cost. ,
Enum:
{
Unavailable: No description available. ,
Reported: No description available. ,
Projected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceCosts:
{
Description: The resource cost component of the cost data. ,
Required: False ,
}
[
{
resourcename:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
resourceUId:
{
Description: The unique identifier of the resource. ,
Required: False ,
}
string ,
resourceCost:
{
Description: The cost component of the resource cost item. ,
Format: double ,
Required: False ,
}
number ,
resourceType:
{
Description: The logical resource type (ex. virtualmachine, storageaccount) ,
Required: False ,
}
string ,
resourceOwner:
{
Description: The owner of the resource (ex. janedoe@microsoft.com) ,
Required: False ,
}
string ,
resourcePricingTier:
{
Description: The category of the resource (ex. Premium_LRS, Standard_DS1) ,
Required: False ,
}
string ,
resourceStatus:
{
Description: The status of the resource (ex. Active) ,
Required: False ,
}
string ,
resourceId:
{
Description: The ID of the resource ,
Required: False ,
}
string ,
externalResourceId:
{
Description: The ID of the external resource ,
Required: False ,
}
string ,
}
,
]
,
currencyCode:
{
Description: The currency code of the cost. ,
Required: False ,
}
string ,
startDateTime:
{
Description: The start time of the cost data. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The end time of the cost data. ,
Format: date-time ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the cost. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_CreateEnvironment (new)
Description :  Create virtual machines in a lab. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/createEnvironment
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
labVirtualMachineCreationParameter:
{
Description: Properties for creating a virtual machine. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
bulkCreationParameters:
{
Description: The number of virtual machine instances to create. ,
Required: False ,
}
{
instanceCount:
{
Description: The number of virtual machine instances to create. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomImages_List (new)
Description :  List custom images in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=vm)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The CustomImage items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
vm:
{
Description: The virtual machine from which the image is to be created. ,
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). ,
Enum:
{
NonSysprepped: No description available. ,
SysprepRequested: No description available. ,
SysprepApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
linuxOsInfo:
{
Description: The Linux OS information of the VM. ,
Required: False ,
}
{
linuxOsState:
{
Description: The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). ,
Enum:
{
NonDeprovisioned: No description available. ,
DeprovisionRequested: No description available. ,
DeprovisionApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
vhd:
{
Description: The VHD from which the image is to be created. ,
Required: False ,
}
{
imageName:
{
Description: The image name. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
osType:
{
Description: The OS type of the custom image (i.e. Windows, Linux) ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
author:
{
Description: The author of the custom image. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the custom image. ,
Format: date-time ,
Required: False ,
}
string ,
managedImageId:
{
Description: The Managed Image Id backing the custom image. ,
Required: False ,
}
string ,
managedSnapshotId:
{
Description: The Managed Snapshot Id backing the custom image. ,
Required: False ,
}
string ,
dataDiskStorageInfo:
{
Description: Storage information about the data disks present in the custom image ,
Required: False ,
}
[
{
lun:
{
Description: Disk Lun ,
Required: False ,
}
string ,
storageType:
{
Description: Disk Storage Type ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
customImagePlan:
{
Description: Storage information about the plan related to this custom image ,
Required: False ,
}
{
id:
{
Description: The id of the plan, equivalent to name of the plan ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
offer:
{
Description: The offer for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
}
,
isPlanAuthorized:
{
Description: Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomImages_Get (new)
Description :  Get custom image.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the CustomImage ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=vm)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
vm:
{
Description: The virtual machine from which the image is to be created. ,
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). ,
Enum:
{
NonSysprepped: No description available. ,
SysprepRequested: No description available. ,
SysprepApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
linuxOsInfo:
{
Description: The Linux OS information of the VM. ,
Required: False ,
}
{
linuxOsState:
{
Description: The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). ,
Enum:
{
NonDeprovisioned: No description available. ,
DeprovisionRequested: No description available. ,
DeprovisionApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
vhd:
{
Description: The VHD from which the image is to be created. ,
Required: False ,
}
{
imageName:
{
Description: The image name. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
osType:
{
Description: The OS type of the custom image (i.e. Windows, Linux) ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
author:
{
Description: The author of the custom image. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the custom image. ,
Format: date-time ,
Required: False ,
}
string ,
managedImageId:
{
Description: The Managed Image Id backing the custom image. ,
Required: False ,
}
string ,
managedSnapshotId:
{
Description: The Managed Snapshot Id backing the custom image. ,
Required: False ,
}
string ,
dataDiskStorageInfo:
{
Description: Storage information about the data disks present in the custom image ,
Required: False ,
}
[
{
lun:
{
Description: Disk Lun ,
Required: False ,
}
string ,
storageType:
{
Description: Disk Storage Type ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
customImagePlan:
{
Description: Storage information about the plan related to this custom image ,
Required: False ,
}
{
id:
{
Description: The id of the plan, equivalent to name of the plan ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
offer:
{
Description: The offer for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
}
,
isPlanAuthorized:
{
Description: Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomImages_CreateOrUpdate (new)
Description :  Create or replace an existing custom image. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the CustomImage ,
Required: True ,
}
string ,
customImage:
{
Description: A custom image. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
vm:
{
Description: The virtual machine from which the image is to be created. ,
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). ,
Enum:
{
NonSysprepped: No description available. ,
SysprepRequested: No description available. ,
SysprepApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
linuxOsInfo:
{
Description: The Linux OS information of the VM. ,
Required: False ,
}
{
linuxOsState:
{
Description: The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). ,
Enum:
{
NonDeprovisioned: No description available. ,
DeprovisionRequested: No description available. ,
DeprovisionApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
vhd:
{
Description: The VHD from which the image is to be created. ,
Required: False ,
}
{
imageName:
{
Description: The image name. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
osType:
{
Description: The OS type of the custom image (i.e. Windows, Linux) ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
author:
{
Description: The author of the custom image. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the custom image. ,
Format: date-time ,
Required: False ,
}
string ,
managedImageId:
{
Description: The Managed Image Id backing the custom image. ,
Required: False ,
}
string ,
managedSnapshotId:
{
Description: The Managed Snapshot Id backing the custom image. ,
Required: False ,
}
string ,
dataDiskStorageInfo:
{
Description: Storage information about the data disks present in the custom image ,
Required: False ,
}
[
{
lun:
{
Description: Disk Lun ,
Required: False ,
}
string ,
storageType:
{
Description: Disk Storage Type ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
customImagePlan:
{
Description: Storage information about the plan related to this custom image ,
Required: False ,
}
{
id:
{
Description: The id of the plan, equivalent to name of the plan ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
offer:
{
Description: The offer for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
}
,
isPlanAuthorized:
{
Description: Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
vm:
{
Description: The virtual machine from which the image is to be created. ,
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). ,
Enum:
{
NonSysprepped: No description available. ,
SysprepRequested: No description available. ,
SysprepApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
linuxOsInfo:
{
Description: The Linux OS information of the VM. ,
Required: False ,
}
{
linuxOsState:
{
Description: The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). ,
Enum:
{
NonDeprovisioned: No description available. ,
DeprovisionRequested: No description available. ,
DeprovisionApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
vhd:
{
Description: The VHD from which the image is to be created. ,
Required: False ,
}
{
imageName:
{
Description: The image name. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
osType:
{
Description: The OS type of the custom image (i.e. Windows, Linux) ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
author:
{
Description: The author of the custom image. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the custom image. ,
Format: date-time ,
Required: False ,
}
string ,
managedImageId:
{
Description: The Managed Image Id backing the custom image. ,
Required: False ,
}
string ,
managedSnapshotId:
{
Description: The Managed Snapshot Id backing the custom image. ,
Required: False ,
}
string ,
dataDiskStorageInfo:
{
Description: Storage information about the data disks present in the custom image ,
Required: False ,
}
[
{
lun:
{
Description: Disk Lun ,
Required: False ,
}
string ,
storageType:
{
Description: Disk Storage Type ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
customImagePlan:
{
Description: Storage information about the plan related to this custom image ,
Required: False ,
}
{
id:
{
Description: The id of the plan, equivalent to name of the plan ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
offer:
{
Description: The offer for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
}
,
isPlanAuthorized:
{
Description: Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A custom image. ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
vm:
{
Description: The virtual machine from which the image is to be created. ,
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). ,
Enum:
{
NonSysprepped: No description available. ,
SysprepRequested: No description available. ,
SysprepApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
linuxOsInfo:
{
Description: The Linux OS information of the VM. ,
Required: False ,
}
{
linuxOsState:
{
Description: The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). ,
Enum:
{
NonDeprovisioned: No description available. ,
DeprovisionRequested: No description available. ,
DeprovisionApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
vhd:
{
Description: The VHD from which the image is to be created. ,
Required: False ,
}
{
imageName:
{
Description: The image name. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
osType:
{
Description: The OS type of the custom image (i.e. Windows, Linux) ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
author:
{
Description: The author of the custom image. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the custom image. ,
Format: date-time ,
Required: False ,
}
string ,
managedImageId:
{
Description: The Managed Image Id backing the custom image. ,
Required: False ,
}
string ,
managedSnapshotId:
{
Description: The Managed Snapshot Id backing the custom image. ,
Required: False ,
}
string ,
dataDiskStorageInfo:
{
Description: Storage information about the data disks present in the custom image ,
Required: False ,
}
[
{
lun:
{
Description: Disk Lun ,
Required: False ,
}
string ,
storageType:
{
Description: Disk Storage Type ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
customImagePlan:
{
Description: Storage information about the plan related to this custom image ,
Required: False ,
}
{
id:
{
Description: The id of the plan, equivalent to name of the plan ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
offer:
{
Description: The offer for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
}
,
isPlanAuthorized:
{
Description: Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomImages_Update (new)
Description :  Allows modifying tags of custom images. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the CustomImage ,
Required: True ,
}
string ,
customImage:
{
Description: A custom image. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
vm:
{
Description: The virtual machine from which the image is to be created. ,
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). ,
Enum:
{
NonSysprepped: No description available. ,
SysprepRequested: No description available. ,
SysprepApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
linuxOsInfo:
{
Description: The Linux OS information of the VM. ,
Required: False ,
}
{
linuxOsState:
{
Description: The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). ,
Enum:
{
NonDeprovisioned: No description available. ,
DeprovisionRequested: No description available. ,
DeprovisionApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
vhd:
{
Description: The VHD from which the image is to be created. ,
Required: False ,
}
{
imageName:
{
Description: The image name. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
osType:
{
Description: The OS type of the custom image (i.e. Windows, Linux) ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
author:
{
Description: The author of the custom image. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the custom image. ,
Format: date-time ,
Required: False ,
}
string ,
managedImageId:
{
Description: The Managed Image Id backing the custom image. ,
Required: False ,
}
string ,
managedSnapshotId:
{
Description: The Managed Snapshot Id backing the custom image. ,
Required: False ,
}
string ,
dataDiskStorageInfo:
{
Description: Storage information about the data disks present in the custom image ,
Required: False ,
}
[
{
lun:
{
Description: Disk Lun ,
Required: False ,
}
string ,
storageType:
{
Description: Disk Storage Type ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
customImagePlan:
{
Description: Storage information about the plan related to this custom image ,
Required: False ,
}
{
id:
{
Description: The id of the plan, equivalent to name of the plan ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
offer:
{
Description: The offer for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
}
,
isPlanAuthorized:
{
Description: Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomImages_Delete (new)
Description :  Delete custom image. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the CustomImage ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_ExportResourceUsage (new)
Description :  Exports the lab resource usage into a storage account This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/exportResourceUsage
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
exportResourceUsageParameters:
{
Description: The parameters of the export operation. ,
Required: True ,
}
{
blobStorageAbsoluteSasUri:
{
Description: The blob storage absolute sas uri with write permission to the container which the usage data needs to be uploaded to. ,
Required: False ,
}
string ,
usageStartDate:
{
Description: The start time of the usage. If not provided, usage will be reported since the beginning of data collection. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Formulas_List (new)
Description :  List formulas in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=description)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Formula items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the formula. ,
Required: True ,
}
{
description:
{
Description: The description of the formula. ,
Required: False ,
}
string ,
author:
{
Description: The author of the formula. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the formula. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the formula. ,
Format: date-time ,
Required: False ,
}
string ,
formulaContent:
{
Description: The content of the formula. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
bulkCreationParameters:
{
Description: The number of virtual machine instances to create. ,
Required: False ,
}
{
instanceCount:
{
Description: The number of virtual machine instances to create. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
vm:
{
Description: Information about a VM from which a formula is to be created. ,
Required: False ,
}
{
labVmId:
{
Description: The identifier of the VM from which a formula is to be created. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Formulas_Get (new)
Description :  Get formula.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Formula ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=description)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the formula. ,
Required: True ,
}
{
description:
{
Description: The description of the formula. ,
Required: False ,
}
string ,
author:
{
Description: The author of the formula. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the formula. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the formula. ,
Format: date-time ,
Required: False ,
}
string ,
formulaContent:
{
Description: The content of the formula. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
bulkCreationParameters:
{
Description: The number of virtual machine instances to create. ,
Required: False ,
}
{
instanceCount:
{
Description: The number of virtual machine instances to create. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
vm:
{
Description: Information about a VM from which a formula is to be created. ,
Required: False ,
}
{
labVmId:
{
Description: The identifier of the VM from which a formula is to be created. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Formulas_CreateOrUpdate (new)
Description :  Create or replace an existing formula. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Formula ,
Required: True ,
}
string ,
formula:
{
Description: A formula for creating a VM, specifying an image base and other parameters ,
Required: True ,
}
{
properties:
{
Description: The properties of the formula. ,
Required: True ,
}
{
description:
{
Description: The description of the formula. ,
Required: False ,
}
string ,
author:
{
Description: The author of the formula. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the formula. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the formula. ,
Format: date-time ,
Required: False ,
}
string ,
formulaContent:
{
Description: The content of the formula. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
bulkCreationParameters:
{
Description: The number of virtual machine instances to create. ,
Required: False ,
}
{
instanceCount:
{
Description: The number of virtual machine instances to create. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
vm:
{
Description: Information about a VM from which a formula is to be created. ,
Required: False ,
}
{
labVmId:
{
Description: The identifier of the VM from which a formula is to be created. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the formula. ,
Required: True ,
}
{
description:
{
Description: The description of the formula. ,
Required: False ,
}
string ,
author:
{
Description: The author of the formula. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the formula. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the formula. ,
Format: date-time ,
Required: False ,
}
string ,
formulaContent:
{
Description: The content of the formula. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
bulkCreationParameters:
{
Description: The number of virtual machine instances to create. ,
Required: False ,
}
{
instanceCount:
{
Description: The number of virtual machine instances to create. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
vm:
{
Description: Information about a VM from which a formula is to be created. ,
Required: False ,
}
{
labVmId:
{
Description: The identifier of the VM from which a formula is to be created. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A formula for creating a VM, specifying an image base and other parameters ,
}
{
properties:
{
Description: The properties of the formula. ,
Required: True ,
}
{
description:
{
Description: The description of the formula. ,
Required: False ,
}
string ,
author:
{
Description: The author of the formula. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the formula. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the formula. ,
Format: date-time ,
Required: False ,
}
string ,
formulaContent:
{
Description: The content of the formula. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
bulkCreationParameters:
{
Description: The number of virtual machine instances to create. ,
Required: False ,
}
{
instanceCount:
{
Description: The number of virtual machine instances to create. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
vm:
{
Description: Information about a VM from which a formula is to be created. ,
Required: False ,
}
{
labVmId:
{
Description: The identifier of the VM from which a formula is to be created. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Formulas_Update (new)
Description :  Allows modifying tags of formulas. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Formula ,
Required: True ,
}
string ,
formula:
{
Description: A formula for creating a VM, specifying an image base and other parameters ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the formula. ,
Required: True ,
}
{
description:
{
Description: The description of the formula. ,
Required: False ,
}
string ,
author:
{
Description: The author of the formula. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the formula. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the formula. ,
Format: date-time ,
Required: False ,
}
string ,
formulaContent:
{
Description: The content of the formula. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
bulkCreationParameters:
{
Description: The number of virtual machine instances to create. ,
Required: False ,
}
{
instanceCount:
{
Description: The number of virtual machine instances to create. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
vm:
{
Description: Information about a VM from which a formula is to be created. ,
Required: False ,
}
{
labVmId:
{
Description: The identifier of the VM from which a formula is to be created. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Formulas_Delete (new)
Description :  Delete formula.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Formula ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GalleryImages_List (new)
Description :  List gallery images in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/galleryimages
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=displayName)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The GalleryImage items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the gallery image. ,
Required: True ,
}
{
author:
{
Description: The author of the gallery image. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the gallery image. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The description of the gallery image. ,
Required: False ,
}
string ,
imageReference:
{
Description: The image reference of the gallery image. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
icon:
{
Description: The icon of the gallery image. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether this gallery image is enabled. ,
Required: False ,
}
boolean ,
planId:
{
Description: The third party plan that applies to this image ,
Required: False ,
}
string ,
isPlanAuthorized:
{
Description: Indicates if the plan has been authorized for programmatic deployment. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_GenerateUploadUri (new)
Description :  Generate a URI for uploading custom disk images to a Lab.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/generateUploadUri
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
generateUploadUriParameter:
{
Description: Properties for generating an upload URI. ,
Required: True ,
}
{
blobName:
{
Description: The blob name of the upload URI. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
uploadUri:
{
Description: The upload URI for the VHD. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_ImportVirtualMachine (new)
Description :  Import a virtual machine into a different lab. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/importVirtualMachine
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
importLabVirtualMachineRequest:
{
Description: This represents the payload required to import a virtual machine from a different lab into the current one ,
Required: True ,
}
{
sourceVirtualMachineResourceId:
{
Description: The full resource ID of the virtual machine to be imported. ,
Required: False ,
}
string ,
destinationVirtualMachineName:
{
Description: The name of the virtual machine in the destination lab ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_ListVhds (new)
Description :  List disk images available for custom image creation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/listVhds
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The LabVhd items on this page ,
Required: True ,
}
[
{
id:
{
Description: The URI to the VHD. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationChannels_List (new)
Description :  List notification channels in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=webHookUrl)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NotificationChannel items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
webHookUrl:
{
Description: The webhook URL to send notifications to. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
description:
{
Description: Description of notification. ,
Required: False ,
}
string ,
events:
{
Description: The list of event for which this notification is enabled. ,
Required: False ,
}
[
{
eventName:
{
Description: The event type for which this notification is enabled (i.e. AutoShutdown, Cost) ,
Enum:
{
AutoShutdown: No description available. ,
Cost: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
createdDate:
{
Description: The creation date of the notification channel. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationChannels_Get (new)
Description :  Get notification channel.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the NotificationChannel ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=webHookUrl)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
webHookUrl:
{
Description: The webhook URL to send notifications to. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
description:
{
Description: Description of notification. ,
Required: False ,
}
string ,
events:
{
Description: The list of event for which this notification is enabled. ,
Required: False ,
}
[
{
eventName:
{
Description: The event type for which this notification is enabled (i.e. AutoShutdown, Cost) ,
Enum:
{
AutoShutdown: No description available. ,
Cost: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
createdDate:
{
Description: The creation date of the notification channel. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationChannels_CreateOrUpdate (new)
Description :  Create or replace an existing notification channel.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the NotificationChannel ,
Required: True ,
}
string ,
notificationChannel:
{
Description: A notification. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
webHookUrl:
{
Description: The webhook URL to send notifications to. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
description:
{
Description: Description of notification. ,
Required: False ,
}
string ,
events:
{
Description: The list of event for which this notification is enabled. ,
Required: False ,
}
[
{
eventName:
{
Description: The event type for which this notification is enabled (i.e. AutoShutdown, Cost) ,
Enum:
{
AutoShutdown: No description available. ,
Cost: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
createdDate:
{
Description: The creation date of the notification channel. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
webHookUrl:
{
Description: The webhook URL to send notifications to. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
description:
{
Description: Description of notification. ,
Required: False ,
}
string ,
events:
{
Description: The list of event for which this notification is enabled. ,
Required: False ,
}
[
{
eventName:
{
Description: The event type for which this notification is enabled (i.e. AutoShutdown, Cost) ,
Enum:
{
AutoShutdown: No description available. ,
Cost: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
createdDate:
{
Description: The creation date of the notification channel. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
webHookUrl:
{
Description: The webhook URL to send notifications to. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
description:
{
Description: Description of notification. ,
Required: False ,
}
string ,
events:
{
Description: The list of event for which this notification is enabled. ,
Required: False ,
}
[
{
eventName:
{
Description: The event type for which this notification is enabled (i.e. AutoShutdown, Cost) ,
Enum:
{
AutoShutdown: No description available. ,
Cost: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
createdDate:
{
Description: The creation date of the notification channel. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationChannels_Update (new)
Description :  Allows modifying tags of notification channels. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the NotificationChannel ,
Required: True ,
}
string ,
notificationChannel:
{
Description: A notification. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
webHookUrl:
{
Description: The webhook URL to send notifications to. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
description:
{
Description: Description of notification. ,
Required: False ,
}
string ,
events:
{
Description: The list of event for which this notification is enabled. ,
Required: False ,
}
[
{
eventName:
{
Description: The event type for which this notification is enabled (i.e. AutoShutdown, Cost) ,
Enum:
{
AutoShutdown: No description available. ,
Cost: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
createdDate:
{
Description: The creation date of the notification channel. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationChannels_Delete (new)
Description :  Delete notification channel.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the NotificationChannel ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationChannels_Notify (new)
Description :  Send notification to provided channel.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}/notify
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the NotificationChannel ,
Required: True ,
}
string ,
notifyParameters:
{
Description: Properties for generating a Notification. ,
Required: True ,
}
{
eventName:
{
Description: The type of event (i.e. AutoShutdown, Cost) ,
Enum:
{
AutoShutdown: No description available. ,
Cost: No description available. ,
}
,
Required: False ,
}
enum ,
jsonPayload:
{
Description: Properties for the notification in json format. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySets_EvaluatePolicies (new)
Description :  Evaluates lab policy.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{name}/evaluatePolicies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the PolicySet ,
Required: True ,
}
string ,
evaluatePoliciesRequest:
{
Description: Request body for evaluating a policy set. ,
Required: True ,
}
{
policies:
{
Description: Policies to evaluate. ,
Required: False ,
}
[
{
factName:
{
Description: The fact name. ,
Required: False ,
}
string ,
factData:
{
Description: The fact data. ,
Required: False ,
}
string ,
valueOffset:
{
Description: The value offset. ,
Required: False ,
}
string ,
userObjectId:
{
Description: The user for which policies will be evaluated ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
results:
{
Description: Results of evaluating a policy set. ,
Required: False ,
}
[
{
hasError:
{
Description: A value indicating whether this policy set evaluation has discovered violations. ,
Required: False ,
}
boolean ,
policyViolations:
{
Description: The list of policy violations. ,
Required: False ,
}
[
{
code:
{
Description: The code of the policy violation. ,
Required: False ,
}
string ,
message:
{
Description: The message of the policy violation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_List (new)
Description :  List policies in a given policy set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
policySetName:
{
Description: policysets ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=description)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Policy items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
description:
{
Description: The description of the policy. ,
Required: False ,
}
string ,
status:
{
Description: The status of the policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
factName:
{
Description: The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
UserOwnedLabPremiumVmCount: No description available. ,
LabVmCount: No description available. ,
LabPremiumVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
LabTargetCost: No description available. ,
EnvironmentTemplate: No description available. ,
ScheduleEditPermission: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy). ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy). ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The creation date of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_Get (new)
Description :  Get policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
policySetName:
{
Description: policysets ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=description)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
description:
{
Description: The description of the policy. ,
Required: False ,
}
string ,
status:
{
Description: The status of the policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
factName:
{
Description: The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
UserOwnedLabPremiumVmCount: No description available. ,
LabVmCount: No description available. ,
LabPremiumVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
LabTargetCost: No description available. ,
EnvironmentTemplate: No description available. ,
ScheduleEditPermission: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy). ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy). ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The creation date of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_CreateOrUpdate (new)
Description :  Create or replace an existing policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
policySetName:
{
Description: policysets ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
policy:
{
Description: A Policy. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
description:
{
Description: The description of the policy. ,
Required: False ,
}
string ,
status:
{
Description: The status of the policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
factName:
{
Description: The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
UserOwnedLabPremiumVmCount: No description available. ,
LabVmCount: No description available. ,
LabPremiumVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
LabTargetCost: No description available. ,
EnvironmentTemplate: No description available. ,
ScheduleEditPermission: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy). ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy). ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The creation date of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
description:
{
Description: The description of the policy. ,
Required: False ,
}
string ,
status:
{
Description: The status of the policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
factName:
{
Description: The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
UserOwnedLabPremiumVmCount: No description available. ,
LabVmCount: No description available. ,
LabPremiumVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
LabTargetCost: No description available. ,
EnvironmentTemplate: No description available. ,
ScheduleEditPermission: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy). ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy). ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The creation date of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
description:
{
Description: The description of the policy. ,
Required: False ,
}
string ,
status:
{
Description: The status of the policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
factName:
{
Description: The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
UserOwnedLabPremiumVmCount: No description available. ,
LabVmCount: No description available. ,
LabPremiumVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
LabTargetCost: No description available. ,
EnvironmentTemplate: No description available. ,
ScheduleEditPermission: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy). ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy). ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The creation date of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_Update (new)
Description :  Allows modifying tags of policies. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
policySetName:
{
Description: policysets ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
policy:
{
Description: A Policy. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
description:
{
Description: The description of the policy. ,
Required: False ,
}
string ,
status:
{
Description: The status of the policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
factName:
{
Description: The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
UserOwnedLabPremiumVmCount: No description available. ,
LabVmCount: No description available. ,
LabPremiumVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
LabTargetCost: No description available. ,
EnvironmentTemplate: No description available. ,
ScheduleEditPermission: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy). ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy). ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The creation date of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_Delete (new)
Description :  Delete policy.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
policySetName:
{
Description: policysets ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_List (new)
Description :  List schedules in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=status)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Schedule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_Get (new)
Description :  Get schedule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=status)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_CreateOrUpdate (new)
Description :  Create or replace an existing schedule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
schedule:
{
Description: A schedule. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_Update (new)
Description :  Allows modifying tags of schedules. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
schedule:
{
Description: A schedule. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_Delete (new)
Description :  Delete schedule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_Execute (new)
Description :  Execute a schedule. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}/execute
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_ListApplicable (new)
Description :  Lists all applicable schedules
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}/listApplicable
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Schedule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceRunners_Get (new)
Description :  Get service runner.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/servicerunners/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ServiceRunner ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
type:
{
Description: Managed identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal id of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier of resource. ,
Required: False ,
}
string ,
clientSecretUrl:
{
Description: The client secret URL of the identity. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceRunners_CreateOrUpdate (new)
Description :  Create or replace an existing service runner.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/servicerunners/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ServiceRunner ,
Required: True ,
}
string ,
serviceRunner:
{
Description: A container for a managed identity to execute DevTest lab services. ,
Required: True ,
}
{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
type:
{
Description: Managed identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal id of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier of resource. ,
Required: False ,
}
string ,
clientSecretUrl:
{
Description: The client secret URL of the identity. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
type:
{
Description: Managed identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal id of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier of resource. ,
Required: False ,
}
string ,
clientSecretUrl:
{
Description: The client secret URL of the identity. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
type:
{
Description: Managed identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal id of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier of resource. ,
Required: False ,
}
string ,
clientSecretUrl:
{
Description: The client secret URL of the identity. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceRunners_Delete (new)
Description :  Delete service runner.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/servicerunners/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ServiceRunner ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_List (new)
Description :  List user profiles in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=identity)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The User items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
identity:
{
Description: The identity of the user. ,
Required: False ,
}
{
principalName:
{
Description: Set to the principal name / UPN of the client JWT making the request. ,
Required: False ,
}
string ,
principalId:
{
Description: Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Set to the tenant ID of the client JWT making the request. ,
Required: False ,
}
string ,
objectId:
{
Description: Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available. ,
Required: False ,
}
string ,
appId:
{
Description: Set to the app Id of the client JWT making the request. ,
Required: False ,
}
string ,
}
,
secretStore:
{
Description: The secret store of the user. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The URI of the user's Key vault. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The ID of the user's Key vault. ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the user profile. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_Get (new)
Description :  Get user profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the User ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=identity)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
identity:
{
Description: The identity of the user. ,
Required: False ,
}
{
principalName:
{
Description: Set to the principal name / UPN of the client JWT making the request. ,
Required: False ,
}
string ,
principalId:
{
Description: Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Set to the tenant ID of the client JWT making the request. ,
Required: False ,
}
string ,
objectId:
{
Description: Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available. ,
Required: False ,
}
string ,
appId:
{
Description: Set to the app Id of the client JWT making the request. ,
Required: False ,
}
string ,
}
,
secretStore:
{
Description: The secret store of the user. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The URI of the user's Key vault. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The ID of the user's Key vault. ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the user profile. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_CreateOrUpdate (new)
Description :  Create or replace an existing user profile. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the User ,
Required: True ,
}
string ,
user:
{
Description: Profile of a lab user. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
identity:
{
Description: The identity of the user. ,
Required: False ,
}
{
principalName:
{
Description: Set to the principal name / UPN of the client JWT making the request. ,
Required: False ,
}
string ,
principalId:
{
Description: Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Set to the tenant ID of the client JWT making the request. ,
Required: False ,
}
string ,
objectId:
{
Description: Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available. ,
Required: False ,
}
string ,
appId:
{
Description: Set to the app Id of the client JWT making the request. ,
Required: False ,
}
string ,
}
,
secretStore:
{
Description: The secret store of the user. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The URI of the user's Key vault. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The ID of the user's Key vault. ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the user profile. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
identity:
{
Description: The identity of the user. ,
Required: False ,
}
{
principalName:
{
Description: Set to the principal name / UPN of the client JWT making the request. ,
Required: False ,
}
string ,
principalId:
{
Description: Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Set to the tenant ID of the client JWT making the request. ,
Required: False ,
}
string ,
objectId:
{
Description: Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available. ,
Required: False ,
}
string ,
appId:
{
Description: Set to the app Id of the client JWT making the request. ,
Required: False ,
}
string ,
}
,
secretStore:
{
Description: The secret store of the user. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The URI of the user's Key vault. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The ID of the user's Key vault. ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the user profile. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Profile of a lab user. ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
identity:
{
Description: The identity of the user. ,
Required: False ,
}
{
principalName:
{
Description: Set to the principal name / UPN of the client JWT making the request. ,
Required: False ,
}
string ,
principalId:
{
Description: Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Set to the tenant ID of the client JWT making the request. ,
Required: False ,
}
string ,
objectId:
{
Description: Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available. ,
Required: False ,
}
string ,
appId:
{
Description: Set to the app Id of the client JWT making the request. ,
Required: False ,
}
string ,
}
,
secretStore:
{
Description: The secret store of the user. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The URI of the user's Key vault. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The ID of the user's Key vault. ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the user profile. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_Update (new)
Description :  Allows modifying tags of user profiles. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the User ,
Required: True ,
}
string ,
user:
{
Description: Profile of a lab user. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
identity:
{
Description: The identity of the user. ,
Required: False ,
}
{
principalName:
{
Description: Set to the principal name / UPN of the client JWT making the request. ,
Required: False ,
}
string ,
principalId:
{
Description: Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Set to the tenant ID of the client JWT making the request. ,
Required: False ,
}
string ,
objectId:
{
Description: Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available. ,
Required: False ,
}
string ,
appId:
{
Description: Set to the app Id of the client JWT making the request. ,
Required: False ,
}
string ,
}
,
secretStore:
{
Description: The secret store of the user. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The URI of the user's Key vault. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The ID of the user's Key vault. ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the user profile. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_Delete (new)
Description :  Delete user profile. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the User ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Disks_List (new)
Description :  List disks in a given user profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=diskType)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Disk items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the disk. ,
Required: True ,
}
{
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGiB:
{
Description: The size of the disk in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
leasedByLabVmId:
{
Description: The resource ID of the VM to which this disk is leased. ,
Required: False ,
}
string ,
diskBlobName:
{
Description: When backed by a blob, the name of the VHD blob without extension. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
storageAccountId:
{
Description: When backed by a blob, the storage account where the blob is. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the disk. ,
Format: date-time ,
Required: False ,
}
string ,
hostCaching:
{
Description: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite). ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Disks_Get (new)
Description :  Get disk.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Disk ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=diskType)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the disk. ,
Required: True ,
}
{
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGiB:
{
Description: The size of the disk in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
leasedByLabVmId:
{
Description: The resource ID of the VM to which this disk is leased. ,
Required: False ,
}
string ,
diskBlobName:
{
Description: When backed by a blob, the name of the VHD blob without extension. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
storageAccountId:
{
Description: When backed by a blob, the storage account where the blob is. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the disk. ,
Format: date-time ,
Required: False ,
}
string ,
hostCaching:
{
Description: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite). ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Disks_CreateOrUpdate (new)
Description :  Create or replace an existing disk. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Disk ,
Required: True ,
}
string ,
disk:
{
Description: A Disk. ,
Required: True ,
}
{
properties:
{
Description: The properties of the disk. ,
Required: True ,
}
{
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGiB:
{
Description: The size of the disk in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
leasedByLabVmId:
{
Description: The resource ID of the VM to which this disk is leased. ,
Required: False ,
}
string ,
diskBlobName:
{
Description: When backed by a blob, the name of the VHD blob without extension. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
storageAccountId:
{
Description: When backed by a blob, the storage account where the blob is. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the disk. ,
Format: date-time ,
Required: False ,
}
string ,
hostCaching:
{
Description: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite). ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the disk. ,
Required: True ,
}
{
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGiB:
{
Description: The size of the disk in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
leasedByLabVmId:
{
Description: The resource ID of the VM to which this disk is leased. ,
Required: False ,
}
string ,
diskBlobName:
{
Description: When backed by a blob, the name of the VHD blob without extension. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
storageAccountId:
{
Description: When backed by a blob, the storage account where the blob is. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the disk. ,
Format: date-time ,
Required: False ,
}
string ,
hostCaching:
{
Description: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite). ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A Disk. ,
}
{
properties:
{
Description: The properties of the disk. ,
Required: True ,
}
{
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGiB:
{
Description: The size of the disk in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
leasedByLabVmId:
{
Description: The resource ID of the VM to which this disk is leased. ,
Required: False ,
}
string ,
diskBlobName:
{
Description: When backed by a blob, the name of the VHD blob without extension. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
storageAccountId:
{
Description: When backed by a blob, the storage account where the blob is. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the disk. ,
Format: date-time ,
Required: False ,
}
string ,
hostCaching:
{
Description: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite). ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Disks_Update (new)
Description :  Allows modifying tags of disks. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Disk ,
Required: True ,
}
string ,
disk:
{
Description: A Disk. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the disk. ,
Required: True ,
}
{
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGiB:
{
Description: The size of the disk in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
leasedByLabVmId:
{
Description: The resource ID of the VM to which this disk is leased. ,
Required: False ,
}
string ,
diskBlobName:
{
Description: When backed by a blob, the name of the VHD blob without extension. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
storageAccountId:
{
Description: When backed by a blob, the storage account where the blob is. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the disk. ,
Format: date-time ,
Required: False ,
}
string ,
hostCaching:
{
Description: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite). ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Disks_Delete (new)
Description :  Delete disk. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Disk ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Disks_Attach (new)
Description :  Attach and create the lease of the disk to the virtual machine. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}/attach
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Disk ,
Required: True ,
}
string ,
attachDiskProperties:
{
Description: Properties of the disk to attach. ,
Required: True ,
}
{
leasedByLabVmId:
{
Description: The resource ID of the Lab virtual machine to which the disk is attached. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Disks_Detach (new)
Description :  Detach and break the lease of the disk attached to the virtual machine. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}/detach
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Disk ,
Required: True ,
}
string ,
detachDiskProperties:
{
Description: Properties of the disk to detach. ,
Required: True ,
}
{
leasedByLabVmId:
{
Description: The resource ID of the Lab VM to which the disk is attached. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Environments_List (new)
Description :  List environments in a given user profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=deploymentProperties)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DtlEnvironment items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the environment. ,
Required: True ,
}
{
deploymentProperties:
{
Description: The deployment properties of the environment. ,
Required: False ,
}
{
armTemplateId:
{
Description: The Azure Resource Manager template's identifier. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the Azure Resource Manager template. ,
Required: False ,
}
[
{
name:
{
Description: The name of the template parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the template parameter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
armTemplateDisplayName:
{
Description: The display name of the Azure Resource Manager template that produced the environment. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The identifier of the resource group containing the environment's resources. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The creator of the environment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Environments_Get (new)
Description :  Get environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the DtlEnvironment ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=deploymentProperties)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the environment. ,
Required: True ,
}
{
deploymentProperties:
{
Description: The deployment properties of the environment. ,
Required: False ,
}
{
armTemplateId:
{
Description: The Azure Resource Manager template's identifier. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the Azure Resource Manager template. ,
Required: False ,
}
[
{
name:
{
Description: The name of the template parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the template parameter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
armTemplateDisplayName:
{
Description: The display name of the Azure Resource Manager template that produced the environment. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The identifier of the resource group containing the environment's resources. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The creator of the environment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Environments_CreateOrUpdate (new)
Description :  Create or replace an existing environment. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the DtlEnvironment ,
Required: True ,
}
string ,
dtlEnvironment:
{
Description: An environment, which is essentially an ARM template deployment. ,
Required: True ,
}
{
properties:
{
Description: The properties of the environment. ,
Required: True ,
}
{
deploymentProperties:
{
Description: The deployment properties of the environment. ,
Required: False ,
}
{
armTemplateId:
{
Description: The Azure Resource Manager template's identifier. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the Azure Resource Manager template. ,
Required: False ,
}
[
{
name:
{
Description: The name of the template parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the template parameter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
armTemplateDisplayName:
{
Description: The display name of the Azure Resource Manager template that produced the environment. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The identifier of the resource group containing the environment's resources. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The creator of the environment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the environment. ,
Required: True ,
}
{
deploymentProperties:
{
Description: The deployment properties of the environment. ,
Required: False ,
}
{
armTemplateId:
{
Description: The Azure Resource Manager template's identifier. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the Azure Resource Manager template. ,
Required: False ,
}
[
{
name:
{
Description: The name of the template parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the template parameter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
armTemplateDisplayName:
{
Description: The display name of the Azure Resource Manager template that produced the environment. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The identifier of the resource group containing the environment's resources. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The creator of the environment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An environment, which is essentially an ARM template deployment. ,
}
{
properties:
{
Description: The properties of the environment. ,
Required: True ,
}
{
deploymentProperties:
{
Description: The deployment properties of the environment. ,
Required: False ,
}
{
armTemplateId:
{
Description: The Azure Resource Manager template's identifier. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the Azure Resource Manager template. ,
Required: False ,
}
[
{
name:
{
Description: The name of the template parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the template parameter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
armTemplateDisplayName:
{
Description: The display name of the Azure Resource Manager template that produced the environment. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The identifier of the resource group containing the environment's resources. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The creator of the environment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Environments_Update (new)
Description :  Allows modifying tags of environments. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the DtlEnvironment ,
Required: True ,
}
string ,
dtlEnvironment:
{
Description: An environment, which is essentially an ARM template deployment. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the environment. ,
Required: True ,
}
{
deploymentProperties:
{
Description: The deployment properties of the environment. ,
Required: False ,
}
{
armTemplateId:
{
Description: The Azure Resource Manager template's identifier. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the Azure Resource Manager template. ,
Required: False ,
}
[
{
name:
{
Description: The name of the template parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the template parameter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
armTemplateDisplayName:
{
Description: The display name of the Azure Resource Manager template that produced the environment. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The identifier of the resource group containing the environment's resources. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The creator of the environment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Environments_Delete (new)
Description :  Delete environment. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the DtlEnvironment ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Secrets_List (new)
Description :  List secrets in a given user profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=value)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Secret items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
value:
{
Description: The value of the secret for secret creation. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Secrets_Get (new)
Description :  Get secret.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Secret ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=value)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
value:
{
Description: The value of the secret for secret creation. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Secrets_CreateOrUpdate (new)
Description :  Create or replace an existing secret. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Secret ,
Required: True ,
}
string ,
secret:
{
Description: A secret. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
value:
{
Description: The value of the secret for secret creation. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
value:
{
Description: The value of the secret for secret creation. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A secret. ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
value:
{
Description: The value of the secret for secret creation. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Secrets_Update (new)
Description :  Allows modifying tags of secrets. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Secret ,
Required: True ,
}
string ,
secret:
{
Description: A secret. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
value:
{
Description: The value of the secret for secret creation. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Secrets_Delete (new)
Description :  Delete secret.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Secret ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabrics_List (new)
Description :  List service fabrics in a given user profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=applicableSchedule)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ServiceFabric items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
externalServiceFabricId:
{
Description: The backing service fabric resource's id ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource id of the environment under which the service fabric resource is present ,
Required: False ,
}
string ,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabrics_Get (new)
Description :  Get service fabric.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ServiceFabric ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=applicableSchedule)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
externalServiceFabricId:
{
Description: The backing service fabric resource's id ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource id of the environment under which the service fabric resource is present ,
Required: False ,
}
string ,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabrics_CreateOrUpdate (new)
Description :  Create or replace an existing service fabric. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ServiceFabric ,
Required: True ,
}
string ,
serviceFabric:
{
Description: A Service Fabric. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
externalServiceFabricId:
{
Description: The backing service fabric resource's id ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource id of the environment under which the service fabric resource is present ,
Required: False ,
}
string ,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
externalServiceFabricId:
{
Description: The backing service fabric resource's id ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource id of the environment under which the service fabric resource is present ,
Required: False ,
}
string ,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A Service Fabric. ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
externalServiceFabricId:
{
Description: The backing service fabric resource's id ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource id of the environment under which the service fabric resource is present ,
Required: False ,
}
string ,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabrics_Update (new)
Description :  Allows modifying tags of service fabrics. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ServiceFabric ,
Required: True ,
}
string ,
serviceFabric:
{
Description: A Service Fabric. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
externalServiceFabricId:
{
Description: The backing service fabric resource's id ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource id of the environment under which the service fabric resource is present ,
Required: False ,
}
string ,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabrics_Delete (new)
Description :  Delete service fabric. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ServiceFabric ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabrics_ListApplicableSchedules (new)
Description :  Lists the applicable start/stop schedules, if any.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{name}/listApplicableSchedules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ServiceFabric ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabricSchedules_List (new)
Description :  List schedules in a given service fabric.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{serviceFabricName}/schedules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
userName:
{
Description: users ,
Required: True ,
}
string ,
serviceFabricName:
{
Description: servicefabrics ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=status)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Schedule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabricSchedules_Get (new)
Description :  Get schedule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{serviceFabricName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
userName:
{
Description: users ,
Required: True ,
}
string ,
serviceFabricName:
{
Description: servicefabrics ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=status)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabricSchedules_CreateOrUpdate (new)
Description :  Create or replace an existing schedule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{serviceFabricName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
userName:
{
Description: users ,
Required: True ,
}
string ,
serviceFabricName:
{
Description: servicefabrics ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
schedule:
{
Description: A schedule. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabricSchedules_Update (new)
Description :  Allows modifying tags of schedules. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{serviceFabricName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
userName:
{
Description: users ,
Required: True ,
}
string ,
serviceFabricName:
{
Description: servicefabrics ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
schedule:
{
Description: A schedule. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabricSchedules_Delete (new)
Description :  Delete schedule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{serviceFabricName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
userName:
{
Description: users ,
Required: True ,
}
string ,
serviceFabricName:
{
Description: servicefabrics ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabricSchedules_Execute (new)
Description :  Execute a schedule. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{serviceFabricName}/schedules/{name}/execute
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
userName:
{
Description: users ,
Required: True ,
}
string ,
serviceFabricName:
{
Description: servicefabrics ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabrics_Start (new)
Description :  Start a service fabric. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{name}/start
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ServiceFabric ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabrics_Stop (new)
Description :  Stop a service fabric This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{name}/stop
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ServiceFabric ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_List (new)
Description :  List virtual machines in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The LabVirtualMachine items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdByUserId:
{
Description: The object identifier of the creator of the virtual machine. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The email address of creator of the virtual machine. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
computeId:
{
Description: The resource identifier (Microsoft.Compute) of the virtual machine. ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
fqdn:
{
Description: The fully-qualified domain name of the virtual machine. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
artifactDeploymentStatus:
{
Description: The artifact deployment status for the virtual machine. ,
Required: False ,
}
{
deploymentStatus:
{
Description: The deployment status of the artifact. ,
Required: False ,
}
string ,
artifactsApplied:
{
Description: The total count of the artifacts that were successfully applied. ,
Format: int32 ,
Required: False ,
}
integer ,
totalArtifacts:
{
Description: The total count of the artifacts that were tentatively applied. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
computeVm:
{
Description: The compute virtual machine properties. ,
Required: False ,
}
{
statuses:
{
Description: Gets the statuses of the virtual machine. ,
Required: False ,
}
[
{
code:
{
Description: Gets the status Code. ,
Required: False ,
}
string ,
displayStatus:
{
Description: Gets the short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: Gets the message associated with the status. ,
Required: False ,
}
string ,
}
,
]
,
osType:
{
Description: Gets the OS type of the virtual machine. ,
Required: False ,
}
string ,
vmSize:
{
Description: Gets the size of the virtual machine. ,
Required: False ,
}
string ,
networkInterfaceId:
{
Description: Gets the network interface ID of the virtual machine. ,
Required: False ,
}
string ,
osDiskId:
{
Description: Gets OS disk blob uri for the virtual machine. ,
Required: False ,
}
string ,
dataDiskIds:
{
Description: Gets data disks blob uri for the virtual machine. ,
Required: False ,
}
[
string ,
]
,
dataDisks:
{
Description: Gets all data disks attached to the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets data disk name. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
diskSizeGiB:
{
Description: Gets data disk size in GiB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
virtualMachineCreationSource:
{
Description: Tells source of creation of lab virtual machine. Output property only. ,
Enum:
{
FromCustomImage: No description available. ,
FromGalleryImage: No description available. ,
FromSharedGalleryImage: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Get (new)
Description :  Get virtual machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdByUserId:
{
Description: The object identifier of the creator of the virtual machine. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The email address of creator of the virtual machine. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
computeId:
{
Description: The resource identifier (Microsoft.Compute) of the virtual machine. ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
fqdn:
{
Description: The fully-qualified domain name of the virtual machine. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
artifactDeploymentStatus:
{
Description: The artifact deployment status for the virtual machine. ,
Required: False ,
}
{
deploymentStatus:
{
Description: The deployment status of the artifact. ,
Required: False ,
}
string ,
artifactsApplied:
{
Description: The total count of the artifacts that were successfully applied. ,
Format: int32 ,
Required: False ,
}
integer ,
totalArtifacts:
{
Description: The total count of the artifacts that were tentatively applied. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
computeVm:
{
Description: The compute virtual machine properties. ,
Required: False ,
}
{
statuses:
{
Description: Gets the statuses of the virtual machine. ,
Required: False ,
}
[
{
code:
{
Description: Gets the status Code. ,
Required: False ,
}
string ,
displayStatus:
{
Description: Gets the short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: Gets the message associated with the status. ,
Required: False ,
}
string ,
}
,
]
,
osType:
{
Description: Gets the OS type of the virtual machine. ,
Required: False ,
}
string ,
vmSize:
{
Description: Gets the size of the virtual machine. ,
Required: False ,
}
string ,
networkInterfaceId:
{
Description: Gets the network interface ID of the virtual machine. ,
Required: False ,
}
string ,
osDiskId:
{
Description: Gets OS disk blob uri for the virtual machine. ,
Required: False ,
}
string ,
dataDiskIds:
{
Description: Gets data disks blob uri for the virtual machine. ,
Required: False ,
}
[
string ,
]
,
dataDisks:
{
Description: Gets all data disks attached to the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets data disk name. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
diskSizeGiB:
{
Description: Gets data disk size in GiB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
virtualMachineCreationSource:
{
Description: Tells source of creation of lab virtual machine. Output property only. ,
Enum:
{
FromCustomImage: No description available. ,
FromGalleryImage: No description available. ,
FromSharedGalleryImage: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_CreateOrUpdate (new)
Description :  Create or replace an existing virtual machine. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
labVirtualMachine:
{
Description: A virtual machine. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdByUserId:
{
Description: The object identifier of the creator of the virtual machine. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The email address of creator of the virtual machine. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
computeId:
{
Description: The resource identifier (Microsoft.Compute) of the virtual machine. ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
fqdn:
{
Description: The fully-qualified domain name of the virtual machine. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
artifactDeploymentStatus:
{
Description: The artifact deployment status for the virtual machine. ,
Required: False ,
}
{
deploymentStatus:
{
Description: The deployment status of the artifact. ,
Required: False ,
}
string ,
artifactsApplied:
{
Description: The total count of the artifacts that were successfully applied. ,
Format: int32 ,
Required: False ,
}
integer ,
totalArtifacts:
{
Description: The total count of the artifacts that were tentatively applied. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
computeVm:
{
Description: The compute virtual machine properties. ,
Required: False ,
}
{
statuses:
{
Description: Gets the statuses of the virtual machine. ,
Required: False ,
}
[
{
code:
{
Description: Gets the status Code. ,
Required: False ,
}
string ,
displayStatus:
{
Description: Gets the short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: Gets the message associated with the status. ,
Required: False ,
}
string ,
}
,
]
,
osType:
{
Description: Gets the OS type of the virtual machine. ,
Required: False ,
}
string ,
vmSize:
{
Description: Gets the size of the virtual machine. ,
Required: False ,
}
string ,
networkInterfaceId:
{
Description: Gets the network interface ID of the virtual machine. ,
Required: False ,
}
string ,
osDiskId:
{
Description: Gets OS disk blob uri for the virtual machine. ,
Required: False ,
}
string ,
dataDiskIds:
{
Description: Gets data disks blob uri for the virtual machine. ,
Required: False ,
}
[
string ,
]
,
dataDisks:
{
Description: Gets all data disks attached to the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets data disk name. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
diskSizeGiB:
{
Description: Gets data disk size in GiB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
virtualMachineCreationSource:
{
Description: Tells source of creation of lab virtual machine. Output property only. ,
Enum:
{
FromCustomImage: No description available. ,
FromGalleryImage: No description available. ,
FromSharedGalleryImage: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdByUserId:
{
Description: The object identifier of the creator of the virtual machine. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The email address of creator of the virtual machine. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
computeId:
{
Description: The resource identifier (Microsoft.Compute) of the virtual machine. ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
fqdn:
{
Description: The fully-qualified domain name of the virtual machine. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
artifactDeploymentStatus:
{
Description: The artifact deployment status for the virtual machine. ,
Required: False ,
}
{
deploymentStatus:
{
Description: The deployment status of the artifact. ,
Required: False ,
}
string ,
artifactsApplied:
{
Description: The total count of the artifacts that were successfully applied. ,
Format: int32 ,
Required: False ,
}
integer ,
totalArtifacts:
{
Description: The total count of the artifacts that were tentatively applied. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
computeVm:
{
Description: The compute virtual machine properties. ,
Required: False ,
}
{
statuses:
{
Description: Gets the statuses of the virtual machine. ,
Required: False ,
}
[
{
code:
{
Description: Gets the status Code. ,
Required: False ,
}
string ,
displayStatus:
{
Description: Gets the short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: Gets the message associated with the status. ,
Required: False ,
}
string ,
}
,
]
,
osType:
{
Description: Gets the OS type of the virtual machine. ,
Required: False ,
}
string ,
vmSize:
{
Description: Gets the size of the virtual machine. ,
Required: False ,
}
string ,
networkInterfaceId:
{
Description: Gets the network interface ID of the virtual machine. ,
Required: False ,
}
string ,
osDiskId:
{
Description: Gets OS disk blob uri for the virtual machine. ,
Required: False ,
}
string ,
dataDiskIds:
{
Description: Gets data disks blob uri for the virtual machine. ,
Required: False ,
}
[
string ,
]
,
dataDisks:
{
Description: Gets all data disks attached to the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets data disk name. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
diskSizeGiB:
{
Description: Gets data disk size in GiB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
virtualMachineCreationSource:
{
Description: Tells source of creation of lab virtual machine. Output property only. ,
Enum:
{
FromCustomImage: No description available. ,
FromGalleryImage: No description available. ,
FromSharedGalleryImage: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A virtual machine. ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdByUserId:
{
Description: The object identifier of the creator of the virtual machine. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The email address of creator of the virtual machine. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
computeId:
{
Description: The resource identifier (Microsoft.Compute) of the virtual machine. ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
fqdn:
{
Description: The fully-qualified domain name of the virtual machine. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
artifactDeploymentStatus:
{
Description: The artifact deployment status for the virtual machine. ,
Required: False ,
}
{
deploymentStatus:
{
Description: The deployment status of the artifact. ,
Required: False ,
}
string ,
artifactsApplied:
{
Description: The total count of the artifacts that were successfully applied. ,
Format: int32 ,
Required: False ,
}
integer ,
totalArtifacts:
{
Description: The total count of the artifacts that were tentatively applied. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
computeVm:
{
Description: The compute virtual machine properties. ,
Required: False ,
}
{
statuses:
{
Description: Gets the statuses of the virtual machine. ,
Required: False ,
}
[
{
code:
{
Description: Gets the status Code. ,
Required: False ,
}
string ,
displayStatus:
{
Description: Gets the short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: Gets the message associated with the status. ,
Required: False ,
}
string ,
}
,
]
,
osType:
{
Description: Gets the OS type of the virtual machine. ,
Required: False ,
}
string ,
vmSize:
{
Description: Gets the size of the virtual machine. ,
Required: False ,
}
string ,
networkInterfaceId:
{
Description: Gets the network interface ID of the virtual machine. ,
Required: False ,
}
string ,
osDiskId:
{
Description: Gets OS disk blob uri for the virtual machine. ,
Required: False ,
}
string ,
dataDiskIds:
{
Description: Gets data disks blob uri for the virtual machine. ,
Required: False ,
}
[
string ,
]
,
dataDisks:
{
Description: Gets all data disks attached to the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets data disk name. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
diskSizeGiB:
{
Description: Gets data disk size in GiB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
virtualMachineCreationSource:
{
Description: Tells source of creation of lab virtual machine. Output property only. ,
Enum:
{
FromCustomImage: No description available. ,
FromGalleryImage: No description available. ,
FromSharedGalleryImage: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Update (new)
Description :  Allows modifying tags of virtual machines. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
labVirtualMachine:
{
Description: A virtual machine. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdByUserId:
{
Description: The object identifier of the creator of the virtual machine. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The email address of creator of the virtual machine. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
computeId:
{
Description: The resource identifier (Microsoft.Compute) of the virtual machine. ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
fqdn:
{
Description: The fully-qualified domain name of the virtual machine. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
artifactDeploymentStatus:
{
Description: The artifact deployment status for the virtual machine. ,
Required: False ,
}
{
deploymentStatus:
{
Description: The deployment status of the artifact. ,
Required: False ,
}
string ,
artifactsApplied:
{
Description: The total count of the artifacts that were successfully applied. ,
Format: int32 ,
Required: False ,
}
integer ,
totalArtifacts:
{
Description: The total count of the artifacts that were tentatively applied. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
computeVm:
{
Description: The compute virtual machine properties. ,
Required: False ,
}
{
statuses:
{
Description: Gets the statuses of the virtual machine. ,
Required: False ,
}
[
{
code:
{
Description: Gets the status Code. ,
Required: False ,
}
string ,
displayStatus:
{
Description: Gets the short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: Gets the message associated with the status. ,
Required: False ,
}
string ,
}
,
]
,
osType:
{
Description: Gets the OS type of the virtual machine. ,
Required: False ,
}
string ,
vmSize:
{
Description: Gets the size of the virtual machine. ,
Required: False ,
}
string ,
networkInterfaceId:
{
Description: Gets the network interface ID of the virtual machine. ,
Required: False ,
}
string ,
osDiskId:
{
Description: Gets OS disk blob uri for the virtual machine. ,
Required: False ,
}
string ,
dataDiskIds:
{
Description: Gets data disks blob uri for the virtual machine. ,
Required: False ,
}
[
string ,
]
,
dataDisks:
{
Description: Gets all data disks attached to the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets data disk name. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
diskSizeGiB:
{
Description: Gets data disk size in GiB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
virtualMachineCreationSource:
{
Description: Tells source of creation of lab virtual machine. Output property only. ,
Enum:
{
FromCustomImage: No description available. ,
FromGalleryImage: No description available. ,
FromSharedGalleryImage: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Delete (new)
Description :  Delete virtual machine. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_AddDataDisk (new)
Description :  Attach a new or existing data disk to virtual machine. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/addDataDisk
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
dataDiskProperties:
{
Description: Request body for adding a new or existing data disk to a virtual machine. ,
Required: True ,
}
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_ApplyArtifacts (new)
Description :  Apply artifacts to virtual machine. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/applyArtifacts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
applyArtifactsRequest:
{
Description: Request body for applying artifacts to a virtual machine. ,
Required: True ,
}
{
artifacts:
{
Description: The list of artifacts to apply. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Claim (new)
Description :  Take ownership of an existing virtual machine This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/claim
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_DetachDataDisk (new)
Description :  Detach the specified disk from the virtual machine. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/detachDataDisk
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
detachDataDiskProperties:
{
Description: Request body for detaching data disk from a virtual machine. ,
Required: True ,
}
{
existingLabDiskId:
{
Description: Specifies the disk resource ID to detach from virtual machine. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_GetRdpFileContents (new)
Description :  Gets a string that represents the contents of the RDP file for the virtual machine
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/getRdpFileContents
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
contents:
{
Description: The contents of the .rdp file ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_ListApplicableSchedules (new)
Description :  Lists the applicable start/stop schedules, if any.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/listApplicableSchedules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Redeploy (new)
Description :  Redeploy a virtual machine This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/redeploy
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Resize (new)
Description :  Resize Virtual Machine. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/resize
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
resizeLabVirtualMachineProperties:
{
Description: Request body for resizing a virtual machine. ,
Required: True ,
}
{
size:
{
Description: Specifies the size of the virtual machine. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Restart (new)
Description :  Restart a virtual machine. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/restart
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineSchedules_List (new)
Description :  List schedules in a given virtual machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtualmachines ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=status)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Schedule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineSchedules_Get (new)
Description :  Get schedule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtualmachines ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=status)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineSchedules_CreateOrUpdate (new)
Description :  Create or replace an existing schedule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtualmachines ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
schedule:
{
Description: A schedule. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineSchedules_Update (new)
Description :  Allows modifying tags of schedules. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtualmachines ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
schedule:
{
Description: A schedule. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineSchedules_Delete (new)
Description :  Delete schedule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtualmachines ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineSchedules_Execute (new)
Description :  Execute a schedule. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules/{name}/execute
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtualmachines ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Start (new)
Description :  Start a virtual machine. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/start
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Stop (new)
Description :  Stop a virtual machine This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/stop
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_TransferDisks (new)
Description :  Transfers all data disks attached to the virtual machine to be owned by the current user. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/transferDisks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_UnClaim (new)
Description :  Release ownership of an existing virtual machine This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/unClaim
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworks_List (new)
Description :  List virtual networks in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=externalSubnets)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The VirtualNetwork items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name of the subnet as seen in the lab. ,
Required: False ,
}
string ,
allowPublicIp:
{
Description: The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The description of the virtual network. ,
Required: False ,
}
string ,
externalProviderResourceId:
{
Description: The Microsoft.Network resource identifier of the virtual network. ,
Required: False ,
}
string ,
externalSubnets:
{
Description: The external subnet properties. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the identifier. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name. ,
Required: False ,
}
string ,
}
,
]
,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name given to the subnet within the lab. ,
Required: False ,
}
string ,
useInVmCreationPermission:
{
Description: Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
usePublicIpAddressPermission:
{
Description: Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
sharedPublicIpAddressConfiguration:
{
Description: Properties that virtual machines on this subnet will share. ,
Required: False ,
}
{
allowedPorts:
{
Description: Backend ports that virtual machines on this subnet are allowed to expose ,
Required: False ,
}
[
{
transportProtocol:
{
Description: Protocol type of the port. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
backendPort:
{
Description: Backend port of the target virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
virtualNetworkPoolName:
{
Description: The virtual network pool associated with this subnet. ,
Required: False ,
}
string ,
}
,
]
,
createdDate:
{
Description: The creation date of the virtual network. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworks_Get (new)
Description :  Get virtual network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the VirtualNetwork ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=externalSubnets)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name of the subnet as seen in the lab. ,
Required: False ,
}
string ,
allowPublicIp:
{
Description: The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The description of the virtual network. ,
Required: False ,
}
string ,
externalProviderResourceId:
{
Description: The Microsoft.Network resource identifier of the virtual network. ,
Required: False ,
}
string ,
externalSubnets:
{
Description: The external subnet properties. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the identifier. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name. ,
Required: False ,
}
string ,
}
,
]
,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name given to the subnet within the lab. ,
Required: False ,
}
string ,
useInVmCreationPermission:
{
Description: Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
usePublicIpAddressPermission:
{
Description: Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
sharedPublicIpAddressConfiguration:
{
Description: Properties that virtual machines on this subnet will share. ,
Required: False ,
}
{
allowedPorts:
{
Description: Backend ports that virtual machines on this subnet are allowed to expose ,
Required: False ,
}
[
{
transportProtocol:
{
Description: Protocol type of the port. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
backendPort:
{
Description: Backend port of the target virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
virtualNetworkPoolName:
{
Description: The virtual network pool associated with this subnet. ,
Required: False ,
}
string ,
}
,
]
,
createdDate:
{
Description: The creation date of the virtual network. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworks_CreateOrUpdate (new)
Description :  Create or replace an existing virtual network. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the VirtualNetwork ,
Required: True ,
}
string ,
virtualNetwork:
{
Description: A virtual network. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name of the subnet as seen in the lab. ,
Required: False ,
}
string ,
allowPublicIp:
{
Description: The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The description of the virtual network. ,
Required: False ,
}
string ,
externalProviderResourceId:
{
Description: The Microsoft.Network resource identifier of the virtual network. ,
Required: False ,
}
string ,
externalSubnets:
{
Description: The external subnet properties. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the identifier. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name. ,
Required: False ,
}
string ,
}
,
]
,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name given to the subnet within the lab. ,
Required: False ,
}
string ,
useInVmCreationPermission:
{
Description: Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
usePublicIpAddressPermission:
{
Description: Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
sharedPublicIpAddressConfiguration:
{
Description: Properties that virtual machines on this subnet will share. ,
Required: False ,
}
{
allowedPorts:
{
Description: Backend ports that virtual machines on this subnet are allowed to expose ,
Required: False ,
}
[
{
transportProtocol:
{
Description: Protocol type of the port. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
backendPort:
{
Description: Backend port of the target virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
virtualNetworkPoolName:
{
Description: The virtual network pool associated with this subnet. ,
Required: False ,
}
string ,
}
,
]
,
createdDate:
{
Description: The creation date of the virtual network. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name of the subnet as seen in the lab. ,
Required: False ,
}
string ,
allowPublicIp:
{
Description: The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The description of the virtual network. ,
Required: False ,
}
string ,
externalProviderResourceId:
{
Description: The Microsoft.Network resource identifier of the virtual network. ,
Required: False ,
}
string ,
externalSubnets:
{
Description: The external subnet properties. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the identifier. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name. ,
Required: False ,
}
string ,
}
,
]
,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name given to the subnet within the lab. ,
Required: False ,
}
string ,
useInVmCreationPermission:
{
Description: Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
usePublicIpAddressPermission:
{
Description: Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
sharedPublicIpAddressConfiguration:
{
Description: Properties that virtual machines on this subnet will share. ,
Required: False ,
}
{
allowedPorts:
{
Description: Backend ports that virtual machines on this subnet are allowed to expose ,
Required: False ,
}
[
{
transportProtocol:
{
Description: Protocol type of the port. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
backendPort:
{
Description: Backend port of the target virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
virtualNetworkPoolName:
{
Description: The virtual network pool associated with this subnet. ,
Required: False ,
}
string ,
}
,
]
,
createdDate:
{
Description: The creation date of the virtual network. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A virtual network. ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name of the subnet as seen in the lab. ,
Required: False ,
}
string ,
allowPublicIp:
{
Description: The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The description of the virtual network. ,
Required: False ,
}
string ,
externalProviderResourceId:
{
Description: The Microsoft.Network resource identifier of the virtual network. ,
Required: False ,
}
string ,
externalSubnets:
{
Description: The external subnet properties. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the identifier. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name. ,
Required: False ,
}
string ,
}
,
]
,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name given to the subnet within the lab. ,
Required: False ,
}
string ,
useInVmCreationPermission:
{
Description: Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
usePublicIpAddressPermission:
{
Description: Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
sharedPublicIpAddressConfiguration:
{
Description: Properties that virtual machines on this subnet will share. ,
Required: False ,
}
{
allowedPorts:
{
Description: Backend ports that virtual machines on this subnet are allowed to expose ,
Required: False ,
}
[
{
transportProtocol:
{
Description: Protocol type of the port. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
backendPort:
{
Description: Backend port of the target virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
virtualNetworkPoolName:
{
Description: The virtual network pool associated with this subnet. ,
Required: False ,
}
string ,
}
,
]
,
createdDate:
{
Description: The creation date of the virtual network. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworks_Update (new)
Description :  Allows modifying tags of virtual networks. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the VirtualNetwork ,
Required: True ,
}
string ,
virtualNetwork:
{
Description: A virtual network. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name of the subnet as seen in the lab. ,
Required: False ,
}
string ,
allowPublicIp:
{
Description: The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The description of the virtual network. ,
Required: False ,
}
string ,
externalProviderResourceId:
{
Description: The Microsoft.Network resource identifier of the virtual network. ,
Required: False ,
}
string ,
externalSubnets:
{
Description: The external subnet properties. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the identifier. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name. ,
Required: False ,
}
string ,
}
,
]
,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name given to the subnet within the lab. ,
Required: False ,
}
string ,
useInVmCreationPermission:
{
Description: Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
usePublicIpAddressPermission:
{
Description: Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
sharedPublicIpAddressConfiguration:
{
Description: Properties that virtual machines on this subnet will share. ,
Required: False ,
}
{
allowedPorts:
{
Description: Backend ports that virtual machines on this subnet are allowed to expose ,
Required: False ,
}
[
{
transportProtocol:
{
Description: Protocol type of the port. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
backendPort:
{
Description: Backend port of the target virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
virtualNetworkPoolName:
{
Description: The virtual network pool associated with this subnet. ,
Required: False ,
}
string ,
}
,
]
,
createdDate:
{
Description: The creation date of the virtual network. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworks_Delete (new)
Description :  Delete virtual network. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the VirtualNetwork ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchedules_ListByResourceGroup (new)
Description :  List schedules in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=status)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Schedule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchedules_Get (new)
Description :  Get schedule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=status)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchedules_CreateOrUpdate (new)
Description :  Create or replace an existing schedule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
schedule:
{
Description: A schedule. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchedules_Update (new)
Description :  Allows modifying tags of schedules. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
schedule:
{
Description: A schedule. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchedules_Delete (new)
Description :  Delete schedule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchedules_Execute (new)
Description :  Execute a schedule. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}/execute
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchedules_Retarget (new)
Description :  Updates a schedule's target resource Id. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}/retarget
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
retargetScheduleProperties:
{
Description: Properties for retargeting a virtual machine schedule. ,
Required: True ,
}
{
currentResourceId:
{
Description: The resource Id of the virtual machine on which the schedule operates ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource Id of the virtual machine that the schedule should be retargeted to ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProviderOperations_List (removed)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DevTestLab/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_ListBySubscription (removed)
Description :  List labs in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/labs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=defaultStorageAccount)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Lab items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
defaultPremiumStorageAccount:
{
Description: The lab's default premium storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The lab's artifact storage account. ,
Required: False ,
}
string ,
premiumDataDiskStorageAccount:
{
Description: The lab's premium data disk storage account. ,
Required: False ,
}
string ,
vaultName:
{
Description: The lab's Key vault. ,
Required: False ,
}
string ,
labStorageType:
{
Description: Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
mandatoryArtifactsResourceIdsLinux:
{
Description: The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
mandatoryArtifactsResourceIdsWindows:
{
Description: The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
premiumDataDisks:
{
Description: The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
environmentPermission:
{
Description: The access rights to be granted to the user when provisioning an environment ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
}
,
Required: False ,
}
enum ,
announcement:
{
Description: The properties of any lab announcement associated with this lab ,
Required: False ,
}
{
title:
{
Description: The plain text title for the lab announcement ,
Required: False ,
}
string ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
enabled:
{
Description: Is the lab announcement active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
expirationDate:
{
Description: The time at which the announcement expires (null for never) ,
Format: date-time ,
Required: False ,
}
string ,
expired:
{
Description: Has this announcement expired? ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
support:
{
Description: The properties of any lab support message associated with this lab ,
Required: False ,
}
{
enabled:
{
Description: Is the lab support banner active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
}
,
vmCreationResourceGroup:
{
Description: The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null. ,
Required: False ,
}
string ,
publicIpId:
{
Description: The public IP address for the lab's load balancer. ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The load balancer used to for lab VMs that use shared IP address. ,
Required: False ,
}
string ,
networkSecurityGroupId:
{
Description: The Network Security Group attached to the lab VMs Network interfaces to restrict open ports. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: Extended properties of the lab used for experimental features ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_Get (removed)
Description :  Get operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/locations/{locationName}/operations/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the location. ,
Required: True ,
}
string ,
name:
{
Description: The name of the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The operation status. ,
Required: False ,
}
string ,
statusCode:
{
Description: The status code for the operation. ,
Enum:
{
Continue: No description available. ,
SwitchingProtocols: No description available. ,
OK: No description available. ,
Created: No description available. ,
Accepted: No description available. ,
NonAuthoritativeInformation: No description available. ,
NoContent: No description available. ,
ResetContent: No description available. ,
PartialContent: No description available. ,
MultipleChoices: No description available. ,
Ambiguous: No description available. ,
MovedPermanently: No description available. ,
Moved: No description available. ,
Found: No description available. ,
Redirect: No description available. ,
SeeOther: No description available. ,
RedirectMethod: No description available. ,
NotModified: No description available. ,
UseProxy: No description available. ,
Unused: No description available. ,
TemporaryRedirect: No description available. ,
RedirectKeepVerb: No description available. ,
BadRequest: No description available. ,
Unauthorized: No description available. ,
PaymentRequired: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
MethodNotAllowed: No description available. ,
NotAcceptable: No description available. ,
ProxyAuthenticationRequired: No description available. ,
RequestTimeout: No description available. ,
Conflict: No description available. ,
Gone: No description available. ,
LengthRequired: No description available. ,
PreconditionFailed: No description available. ,
RequestEntityTooLarge: No description available. ,
RequestUriTooLong: No description available. ,
UnsupportedMediaType: No description available. ,
RequestedRangeNotSatisfiable: No description available. ,
ExpectationFailed: No description available. ,
UpgradeRequired: No description available. ,
InternalServerError: No description available. ,
NotImplemented: No description available. ,
BadGateway: No description available. ,
ServiceUnavailable: No description available. ,
GatewayTimeout: No description available. ,
HttpVersionNotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error details for the operation in case of a failure. ,
Required: False ,
}
{
code:
{
Description: The error code of the operation error. ,
Required: False ,
}
string ,
message:
{
Description: The error message of the operation error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
status:
{
Description: The operation status. ,
Required: False ,
}
string ,
statusCode:
{
Description: The status code for the operation. ,
Enum:
{
Continue: No description available. ,
SwitchingProtocols: No description available. ,
OK: No description available. ,
Created: No description available. ,
Accepted: No description available. ,
NonAuthoritativeInformation: No description available. ,
NoContent: No description available. ,
ResetContent: No description available. ,
PartialContent: No description available. ,
MultipleChoices: No description available. ,
Ambiguous: No description available. ,
MovedPermanently: No description available. ,
Moved: No description available. ,
Found: No description available. ,
Redirect: No description available. ,
SeeOther: No description available. ,
RedirectMethod: No description available. ,
NotModified: No description available. ,
UseProxy: No description available. ,
Unused: No description available. ,
TemporaryRedirect: No description available. ,
RedirectKeepVerb: No description available. ,
BadRequest: No description available. ,
Unauthorized: No description available. ,
PaymentRequired: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
MethodNotAllowed: No description available. ,
NotAcceptable: No description available. ,
ProxyAuthenticationRequired: No description available. ,
RequestTimeout: No description available. ,
Conflict: No description available. ,
Gone: No description available. ,
LengthRequired: No description available. ,
PreconditionFailed: No description available. ,
RequestEntityTooLarge: No description available. ,
RequestUriTooLong: No description available. ,
UnsupportedMediaType: No description available. ,
RequestedRangeNotSatisfiable: No description available. ,
ExpectationFailed: No description available. ,
UpgradeRequired: No description available. ,
InternalServerError: No description available. ,
NotImplemented: No description available. ,
BadGateway: No description available. ,
ServiceUnavailable: No description available. ,
GatewayTimeout: No description available. ,
HttpVersionNotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Error details for the operation in case of a failure. ,
Required: False ,
}
{
code:
{
Description: The error code of the operation error. ,
Required: False ,
}
string ,
message:
{
Description: The error message of the operation error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchedules_ListBySubscription (removed)
Description :  List schedules in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/schedules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=status)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Schedule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_ListByResourceGroup (removed)
Description :  List labs in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=defaultStorageAccount)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Lab items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
defaultPremiumStorageAccount:
{
Description: The lab's default premium storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The lab's artifact storage account. ,
Required: False ,
}
string ,
premiumDataDiskStorageAccount:
{
Description: The lab's premium data disk storage account. ,
Required: False ,
}
string ,
vaultName:
{
Description: The lab's Key vault. ,
Required: False ,
}
string ,
labStorageType:
{
Description: Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
mandatoryArtifactsResourceIdsLinux:
{
Description: The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
mandatoryArtifactsResourceIdsWindows:
{
Description: The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
premiumDataDisks:
{
Description: The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
environmentPermission:
{
Description: The access rights to be granted to the user when provisioning an environment ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
}
,
Required: False ,
}
enum ,
announcement:
{
Description: The properties of any lab announcement associated with this lab ,
Required: False ,
}
{
title:
{
Description: The plain text title for the lab announcement ,
Required: False ,
}
string ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
enabled:
{
Description: Is the lab announcement active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
expirationDate:
{
Description: The time at which the announcement expires (null for never) ,
Format: date-time ,
Required: False ,
}
string ,
expired:
{
Description: Has this announcement expired? ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
support:
{
Description: The properties of any lab support message associated with this lab ,
Required: False ,
}
{
enabled:
{
Description: Is the lab support banner active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
}
,
vmCreationResourceGroup:
{
Description: The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null. ,
Required: False ,
}
string ,
publicIpId:
{
Description: The public IP address for the lab's load balancer. ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The load balancer used to for lab VMs that use shared IP address. ,
Required: False ,
}
string ,
networkSecurityGroupId:
{
Description: The Network Security Group attached to the lab VMs Network interfaces to restrict open ports. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: Extended properties of the lab used for experimental features ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_Get (removed)
Description :  Get lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=defaultStorageAccount)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
defaultPremiumStorageAccount:
{
Description: The lab's default premium storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The lab's artifact storage account. ,
Required: False ,
}
string ,
premiumDataDiskStorageAccount:
{
Description: The lab's premium data disk storage account. ,
Required: False ,
}
string ,
vaultName:
{
Description: The lab's Key vault. ,
Required: False ,
}
string ,
labStorageType:
{
Description: Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
mandatoryArtifactsResourceIdsLinux:
{
Description: The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
mandatoryArtifactsResourceIdsWindows:
{
Description: The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
premiumDataDisks:
{
Description: The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
environmentPermission:
{
Description: The access rights to be granted to the user when provisioning an environment ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
}
,
Required: False ,
}
enum ,
announcement:
{
Description: The properties of any lab announcement associated with this lab ,
Required: False ,
}
{
title:
{
Description: The plain text title for the lab announcement ,
Required: False ,
}
string ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
enabled:
{
Description: Is the lab announcement active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
expirationDate:
{
Description: The time at which the announcement expires (null for never) ,
Format: date-time ,
Required: False ,
}
string ,
expired:
{
Description: Has this announcement expired? ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
support:
{
Description: The properties of any lab support message associated with this lab ,
Required: False ,
}
{
enabled:
{
Description: Is the lab support banner active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
}
,
vmCreationResourceGroup:
{
Description: The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null. ,
Required: False ,
}
string ,
publicIpId:
{
Description: The public IP address for the lab's load balancer. ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The load balancer used to for lab VMs that use shared IP address. ,
Required: False ,
}
string ,
networkSecurityGroupId:
{
Description: The Network Security Group attached to the lab VMs Network interfaces to restrict open ports. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: Extended properties of the lab used for experimental features ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_CreateOrUpdate (removed)
Description :  Create or replace an existing lab. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
lab:
{
Description: A lab. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
defaultPremiumStorageAccount:
{
Description: The lab's default premium storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The lab's artifact storage account. ,
Required: False ,
}
string ,
premiumDataDiskStorageAccount:
{
Description: The lab's premium data disk storage account. ,
Required: False ,
}
string ,
vaultName:
{
Description: The lab's Key vault. ,
Required: False ,
}
string ,
labStorageType:
{
Description: Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
mandatoryArtifactsResourceIdsLinux:
{
Description: The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
mandatoryArtifactsResourceIdsWindows:
{
Description: The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
premiumDataDisks:
{
Description: The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
environmentPermission:
{
Description: The access rights to be granted to the user when provisioning an environment ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
}
,
Required: False ,
}
enum ,
announcement:
{
Description: The properties of any lab announcement associated with this lab ,
Required: False ,
}
{
title:
{
Description: The plain text title for the lab announcement ,
Required: False ,
}
string ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
enabled:
{
Description: Is the lab announcement active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
expirationDate:
{
Description: The time at which the announcement expires (null for never) ,
Format: date-time ,
Required: False ,
}
string ,
expired:
{
Description: Has this announcement expired? ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
support:
{
Description: The properties of any lab support message associated with this lab ,
Required: False ,
}
{
enabled:
{
Description: Is the lab support banner active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
}
,
vmCreationResourceGroup:
{
Description: The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null. ,
Required: False ,
}
string ,
publicIpId:
{
Description: The public IP address for the lab's load balancer. ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The load balancer used to for lab VMs that use shared IP address. ,
Required: False ,
}
string ,
networkSecurityGroupId:
{
Description: The Network Security Group attached to the lab VMs Network interfaces to restrict open ports. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: Extended properties of the lab used for experimental features ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
defaultPremiumStorageAccount:
{
Description: The lab's default premium storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The lab's artifact storage account. ,
Required: False ,
}
string ,
premiumDataDiskStorageAccount:
{
Description: The lab's premium data disk storage account. ,
Required: False ,
}
string ,
vaultName:
{
Description: The lab's Key vault. ,
Required: False ,
}
string ,
labStorageType:
{
Description: Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
mandatoryArtifactsResourceIdsLinux:
{
Description: The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
mandatoryArtifactsResourceIdsWindows:
{
Description: The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
premiumDataDisks:
{
Description: The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
environmentPermission:
{
Description: The access rights to be granted to the user when provisioning an environment ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
}
,
Required: False ,
}
enum ,
announcement:
{
Description: The properties of any lab announcement associated with this lab ,
Required: False ,
}
{
title:
{
Description: The plain text title for the lab announcement ,
Required: False ,
}
string ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
enabled:
{
Description: Is the lab announcement active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
expirationDate:
{
Description: The time at which the announcement expires (null for never) ,
Format: date-time ,
Required: False ,
}
string ,
expired:
{
Description: Has this announcement expired? ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
support:
{
Description: The properties of any lab support message associated with this lab ,
Required: False ,
}
{
enabled:
{
Description: Is the lab support banner active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
}
,
vmCreationResourceGroup:
{
Description: The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null. ,
Required: False ,
}
string ,
publicIpId:
{
Description: The public IP address for the lab's load balancer. ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The load balancer used to for lab VMs that use shared IP address. ,
Required: False ,
}
string ,
networkSecurityGroupId:
{
Description: The Network Security Group attached to the lab VMs Network interfaces to restrict open ports. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: Extended properties of the lab used for experimental features ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A lab. ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
defaultPremiumStorageAccount:
{
Description: The lab's default premium storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The lab's artifact storage account. ,
Required: False ,
}
string ,
premiumDataDiskStorageAccount:
{
Description: The lab's premium data disk storage account. ,
Required: False ,
}
string ,
vaultName:
{
Description: The lab's Key vault. ,
Required: False ,
}
string ,
labStorageType:
{
Description: Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
mandatoryArtifactsResourceIdsLinux:
{
Description: The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
mandatoryArtifactsResourceIdsWindows:
{
Description: The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
premiumDataDisks:
{
Description: The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
environmentPermission:
{
Description: The access rights to be granted to the user when provisioning an environment ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
}
,
Required: False ,
}
enum ,
announcement:
{
Description: The properties of any lab announcement associated with this lab ,
Required: False ,
}
{
title:
{
Description: The plain text title for the lab announcement ,
Required: False ,
}
string ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
enabled:
{
Description: Is the lab announcement active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
expirationDate:
{
Description: The time at which the announcement expires (null for never) ,
Format: date-time ,
Required: False ,
}
string ,
expired:
{
Description: Has this announcement expired? ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
support:
{
Description: The properties of any lab support message associated with this lab ,
Required: False ,
}
{
enabled:
{
Description: Is the lab support banner active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
}
,
vmCreationResourceGroup:
{
Description: The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null. ,
Required: False ,
}
string ,
publicIpId:
{
Description: The public IP address for the lab's load balancer. ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The load balancer used to for lab VMs that use shared IP address. ,
Required: False ,
}
string ,
networkSecurityGroupId:
{
Description: The Network Security Group attached to the lab VMs Network interfaces to restrict open ports. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: Extended properties of the lab used for experimental features ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_Update (removed)
Description :  Allows modifying tags of labs. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
lab:
{
Description: A lab. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
defaultPremiumStorageAccount:
{
Description: The lab's default premium storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The lab's artifact storage account. ,
Required: False ,
}
string ,
premiumDataDiskStorageAccount:
{
Description: The lab's premium data disk storage account. ,
Required: False ,
}
string ,
vaultName:
{
Description: The lab's Key vault. ,
Required: False ,
}
string ,
labStorageType:
{
Description: Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
mandatoryArtifactsResourceIdsLinux:
{
Description: The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
mandatoryArtifactsResourceIdsWindows:
{
Description: The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user. ,
Required: False ,
}
[
string ,
]
,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
premiumDataDisks:
{
Description: The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
environmentPermission:
{
Description: The access rights to be granted to the user when provisioning an environment ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
}
,
Required: False ,
}
enum ,
announcement:
{
Description: The properties of any lab announcement associated with this lab ,
Required: False ,
}
{
title:
{
Description: The plain text title for the lab announcement ,
Required: False ,
}
string ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
enabled:
{
Description: Is the lab announcement active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
expirationDate:
{
Description: The time at which the announcement expires (null for never) ,
Format: date-time ,
Required: False ,
}
string ,
expired:
{
Description: Has this announcement expired? ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
support:
{
Description: The properties of any lab support message associated with this lab ,
Required: False ,
}
{
enabled:
{
Description: Is the lab support banner active/enabled at this time? ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
markdown:
{
Description: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. ,
Required: False ,
}
string ,
}
,
vmCreationResourceGroup:
{
Description: The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null. ,
Required: False ,
}
string ,
publicIpId:
{
Description: The public IP address for the lab's load balancer. ,
Required: False ,
}
string ,
loadBalancerId:
{
Description: The load balancer used to for lab VMs that use shared IP address. ,
Required: False ,
}
string ,
networkSecurityGroupId:
{
Description: The Network Security Group attached to the lab VMs Network interfaces to restrict open ports. ,
Required: False ,
}
string ,
extendedProperties:
{
Description: Extended properties of the lab used for experimental features ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_Delete (removed)
Description :  Delete lab. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArtifactSources_List (removed)
Description :  List artifact sources in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=displayName)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ArtifactSource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
displayName:
{
Description: The artifact source's display name. ,
Required: False ,
}
string ,
uri:
{
Description: The artifact source's URI. ,
Required: False ,
}
string ,
sourceType:
{
Description: The artifact source's type. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
StorageAccount: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder containing artifacts. ,
Required: False ,
}
string ,
armTemplateFolderPath:
{
Description: The folder containing Azure Resource Manager templates. ,
Required: False ,
}
string ,
branchRef:
{
Description: The artifact source's branch reference. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token to authenticate to the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the artifact source is enabled (values: Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The artifact source's creation date. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArtifactSources_Get (removed)
Description :  Get artifact source.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ArtifactSource ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=displayName)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
displayName:
{
Description: The artifact source's display name. ,
Required: False ,
}
string ,
uri:
{
Description: The artifact source's URI. ,
Required: False ,
}
string ,
sourceType:
{
Description: The artifact source's type. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
StorageAccount: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder containing artifacts. ,
Required: False ,
}
string ,
armTemplateFolderPath:
{
Description: The folder containing Azure Resource Manager templates. ,
Required: False ,
}
string ,
branchRef:
{
Description: The artifact source's branch reference. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token to authenticate to the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the artifact source is enabled (values: Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The artifact source's creation date. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArtifactSources_CreateOrUpdate (removed)
Description :  Create or replace an existing artifact source.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ArtifactSource ,
Required: True ,
}
string ,
artifactSource:
{
Description: Properties of an artifact source. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
displayName:
{
Description: The artifact source's display name. ,
Required: False ,
}
string ,
uri:
{
Description: The artifact source's URI. ,
Required: False ,
}
string ,
sourceType:
{
Description: The artifact source's type. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
StorageAccount: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder containing artifacts. ,
Required: False ,
}
string ,
armTemplateFolderPath:
{
Description: The folder containing Azure Resource Manager templates. ,
Required: False ,
}
string ,
branchRef:
{
Description: The artifact source's branch reference. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token to authenticate to the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the artifact source is enabled (values: Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The artifact source's creation date. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
displayName:
{
Description: The artifact source's display name. ,
Required: False ,
}
string ,
uri:
{
Description: The artifact source's URI. ,
Required: False ,
}
string ,
sourceType:
{
Description: The artifact source's type. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
StorageAccount: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder containing artifacts. ,
Required: False ,
}
string ,
armTemplateFolderPath:
{
Description: The folder containing Azure Resource Manager templates. ,
Required: False ,
}
string ,
branchRef:
{
Description: The artifact source's branch reference. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token to authenticate to the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the artifact source is enabled (values: Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The artifact source's creation date. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
displayName:
{
Description: The artifact source's display name. ,
Required: False ,
}
string ,
uri:
{
Description: The artifact source's URI. ,
Required: False ,
}
string ,
sourceType:
{
Description: The artifact source's type. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
StorageAccount: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder containing artifacts. ,
Required: False ,
}
string ,
armTemplateFolderPath:
{
Description: The folder containing Azure Resource Manager templates. ,
Required: False ,
}
string ,
branchRef:
{
Description: The artifact source's branch reference. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token to authenticate to the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the artifact source is enabled (values: Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The artifact source's creation date. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArtifactSources_Update (removed)
Description :  Allows modifying tags of artifact sources. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ArtifactSource ,
Required: True ,
}
string ,
artifactSource:
{
Description: Properties of an artifact source. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
displayName:
{
Description: The artifact source's display name. ,
Required: False ,
}
string ,
uri:
{
Description: The artifact source's URI. ,
Required: False ,
}
string ,
sourceType:
{
Description: The artifact source's type. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
StorageAccount: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder containing artifacts. ,
Required: False ,
}
string ,
armTemplateFolderPath:
{
Description: The folder containing Azure Resource Manager templates. ,
Required: False ,
}
string ,
branchRef:
{
Description: The artifact source's branch reference. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token to authenticate to the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the artifact source is enabled (values: Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The artifact source's creation date. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArtifactSources_Delete (removed)
Description :  Delete artifact source.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ArtifactSource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArmTemplates_List (removed)
Description :  List azure resource manager templates in a given artifact source.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/armtemplates
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
artifactSourceName:
{
Description: The name of the artifact source. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=displayName)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ArmTemplate items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
displayName:
{
Description: The display name of the ARM template. ,
Required: False ,
}
string ,
description:
{
Description: The description of the ARM template. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the ARM template. ,
Required: False ,
}
string ,
icon:
{
Description: The URI to the icon of the ARM template. ,
Required: False ,
}
string ,
contents:
{
Description: The contents of the ARM template. ,
Required: False ,
}
object ,
createdDate:
{
Description: The creation date of the armTemplate. ,
Format: date-time ,
Required: False ,
}
string ,
parametersValueFilesInfo:
{
Description: File name and parameter values information from all azuredeploy.*.parameters.json for the ARM template. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
parametersValueInfo:
{
Description: Contents of the file. ,
Required: False ,
}
object ,
}
,
]
,
enabled:
{
Description: Whether or not ARM template is enabled for use by lab user. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArmTemplates_Get (removed)
Description :  Get azure resource manager template.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/armtemplates/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
artifactSourceName:
{
Description: The name of the artifact source. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ArmTemplate ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=displayName)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
displayName:
{
Description: The display name of the ARM template. ,
Required: False ,
}
string ,
description:
{
Description: The description of the ARM template. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the ARM template. ,
Required: False ,
}
string ,
icon:
{
Description: The URI to the icon of the ARM template. ,
Required: False ,
}
string ,
contents:
{
Description: The contents of the ARM template. ,
Required: False ,
}
object ,
createdDate:
{
Description: The creation date of the armTemplate. ,
Format: date-time ,
Required: False ,
}
string ,
parametersValueFilesInfo:
{
Description: File name and parameter values information from all azuredeploy.*.parameters.json for the ARM template. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. ,
Required: False ,
}
string ,
parametersValueInfo:
{
Description: Contents of the file. ,
Required: False ,
}
object ,
}
,
]
,
enabled:
{
Description: Whether or not ARM template is enabled for use by lab user. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Artifacts_List (removed)
Description :  List artifacts in a given artifact source.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
artifactSourceName:
{
Description: The name of the artifact source. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=title)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Artifact items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
title:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
description:
{
Description: The artifact's description. ,
Required: False ,
}
string ,
publisher:
{
Description: The artifact's publisher. ,
Required: False ,
}
string ,
filePath:
{
Description: The file path to the artifact. ,
Required: False ,
}
string ,
icon:
{
Description: The URI to the artifact icon. ,
Required: False ,
}
string ,
targetOsType:
{
Description: The artifact's target OS. ,
Required: False ,
}
string ,
parameters:
{
Description: The artifact's parameters. ,
Required: False ,
}
object ,
createdDate:
{
Description: The artifact's creation date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Artifacts_Get (removed)
Description :  Get artifact.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
artifactSourceName:
{
Description: The name of the artifact source. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Artifact ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=title)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
title:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
description:
{
Description: The artifact's description. ,
Required: False ,
}
string ,
publisher:
{
Description: The artifact's publisher. ,
Required: False ,
}
string ,
filePath:
{
Description: The file path to the artifact. ,
Required: False ,
}
string ,
icon:
{
Description: The URI to the artifact icon. ,
Required: False ,
}
string ,
targetOsType:
{
Description: The artifact's target OS. ,
Required: False ,
}
string ,
parameters:
{
Description: The artifact's parameters. ,
Required: False ,
}
object ,
createdDate:
{
Description: The artifact's creation date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Artifacts_GenerateArmTemplate (removed)
Description :  Generates an ARM template for the given artifact, uploads the required files to a storage account, and validates the generated artifact.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts/{name}/generateArmTemplate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
artifactSourceName:
{
Description: The name of the artifact source. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Artifact ,
Required: True ,
}
string ,
generateArmTemplateRequest:
{
Description: Parameters for generating an ARM template for deploying artifacts. ,
Required: True ,
}
{
virtualMachineName:
{
Description: The resource name of the virtual machine. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the ARM template. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
location:
{
Description: The location of the virtual machine. ,
Required: False ,
}
string ,
fileUploadOptions:
{
Description: Options for uploading the files for the artifact. UploadFilesAndGenerateSasTokens is the default value. ,
Enum:
{
UploadFilesAndGenerateSasTokens: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
template:
{
Description: The template's contents. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters of the ARM template. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_ClaimAnyVm (removed)
Description :  Claim a random claimable virtual machine in the lab. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/claimAnyVm
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Costs_Get (removed)
Description :  Get cost.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/costs/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabCost ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=labCostDetails)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
targetCost:
{
Description: The target cost properties ,
Required: False ,
}
{
status:
{
Description: Target cost status ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Lab target cost ,
Format: int32 ,
Required: False ,
}
integer ,
costThresholds:
{
Description: Cost thresholds. ,
Required: False ,
}
[
{
thresholdId:
{
Description: The ID of the cost threshold item. ,
Required: False ,
}
string ,
percentageThreshold:
{
Description: The value of the percentage cost threshold. ,
Required: False ,
}
{
thresholdValue:
{
Description: The cost threshold value. ,
Format: double ,
Required: False ,
}
number ,
}
,
displayOnChart:
{
Description: Indicates whether this threshold will be displayed on cost charts. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
sendNotificationWhenExceeded:
{
Description: Indicates whether notifications will be sent when this threshold is exceeded. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notificationSent:
{
Description: Indicates the datetime when notifications were last sent for this threshold. ,
Required: False ,
}
string ,
}
,
]
,
cycleStartDateTime:
{
Description: Reporting cycle start date. ,
Format: date-time ,
Required: False ,
}
string ,
cycleEndDateTime:
{
Description: Reporting cycle end date. ,
Format: date-time ,
Required: False ,
}
string ,
cycleType:
{
Description: Reporting cycle type. ,
Enum:
{
CalendarMonth: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
labCostSummary:
{
Description: The lab cost summary component of the cost data. ,
Required: False ,
}
{
estimatedLabCost:
{
Description: The cost component of the cost item. ,
Format: double ,
Required: False ,
}
number ,
}
,
labCostDetails:
{
Description: The lab cost details component of the cost data. ,
Required: False ,
}
[
{
date:
{
Description: The date of the cost item. ,
Format: date-time ,
Required: False ,
}
string ,
cost:
{
Description: The cost component of the cost item. ,
Format: double ,
Required: False ,
}
number ,
costType:
{
Description: The type of the cost. ,
Enum:
{
Unavailable: No description available. ,
Reported: No description available. ,
Projected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceCosts:
{
Description: The resource cost component of the cost data. ,
Required: False ,
}
[
{
resourcename:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
resourceUId:
{
Description: The unique identifier of the resource. ,
Required: False ,
}
string ,
resourceCost:
{
Description: The cost component of the resource cost item. ,
Format: double ,
Required: False ,
}
number ,
resourceType:
{
Description: The logical resource type (ex. virtualmachine, storageaccount) ,
Required: False ,
}
string ,
resourceOwner:
{
Description: The owner of the resource (ex. janedoe@microsoft.com) ,
Required: False ,
}
string ,
resourcePricingTier:
{
Description: The category of the resource (ex. Premium_LRS, Standard_DS1) ,
Required: False ,
}
string ,
resourceStatus:
{
Description: The status of the resource (ex. Active) ,
Required: False ,
}
string ,
resourceId:
{
Description: The ID of the resource ,
Required: False ,
}
string ,
externalResourceId:
{
Description: The ID of the external resource ,
Required: False ,
}
string ,
}
,
]
,
currencyCode:
{
Description: The currency code of the cost. ,
Required: False ,
}
string ,
startDateTime:
{
Description: The start time of the cost data. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The end time of the cost data. ,
Format: date-time ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the cost. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Costs_CreateOrUpdate (removed)
Description :  Create or replace an existing cost.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/costs/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabCost ,
Required: True ,
}
string ,
labCost:
{
Description: A cost item. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
targetCost:
{
Description: The target cost properties ,
Required: False ,
}
{
status:
{
Description: Target cost status ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Lab target cost ,
Format: int32 ,
Required: False ,
}
integer ,
costThresholds:
{
Description: Cost thresholds. ,
Required: False ,
}
[
{
thresholdId:
{
Description: The ID of the cost threshold item. ,
Required: False ,
}
string ,
percentageThreshold:
{
Description: The value of the percentage cost threshold. ,
Required: False ,
}
{
thresholdValue:
{
Description: The cost threshold value. ,
Format: double ,
Required: False ,
}
number ,
}
,
displayOnChart:
{
Description: Indicates whether this threshold will be displayed on cost charts. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
sendNotificationWhenExceeded:
{
Description: Indicates whether notifications will be sent when this threshold is exceeded. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notificationSent:
{
Description: Indicates the datetime when notifications were last sent for this threshold. ,
Required: False ,
}
string ,
}
,
]
,
cycleStartDateTime:
{
Description: Reporting cycle start date. ,
Format: date-time ,
Required: False ,
}
string ,
cycleEndDateTime:
{
Description: Reporting cycle end date. ,
Format: date-time ,
Required: False ,
}
string ,
cycleType:
{
Description: Reporting cycle type. ,
Enum:
{
CalendarMonth: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
labCostSummary:
{
Description: The lab cost summary component of the cost data. ,
Required: False ,
}
{
estimatedLabCost:
{
Description: The cost component of the cost item. ,
Format: double ,
Required: False ,
}
number ,
}
,
labCostDetails:
{
Description: The lab cost details component of the cost data. ,
Required: False ,
}
[
{
date:
{
Description: The date of the cost item. ,
Format: date-time ,
Required: False ,
}
string ,
cost:
{
Description: The cost component of the cost item. ,
Format: double ,
Required: False ,
}
number ,
costType:
{
Description: The type of the cost. ,
Enum:
{
Unavailable: No description available. ,
Reported: No description available. ,
Projected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceCosts:
{
Description: The resource cost component of the cost data. ,
Required: False ,
}
[
{
resourcename:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
resourceUId:
{
Description: The unique identifier of the resource. ,
Required: False ,
}
string ,
resourceCost:
{
Description: The cost component of the resource cost item. ,
Format: double ,
Required: False ,
}
number ,
resourceType:
{
Description: The logical resource type (ex. virtualmachine, storageaccount) ,
Required: False ,
}
string ,
resourceOwner:
{
Description: The owner of the resource (ex. janedoe@microsoft.com) ,
Required: False ,
}
string ,
resourcePricingTier:
{
Description: The category of the resource (ex. Premium_LRS, Standard_DS1) ,
Required: False ,
}
string ,
resourceStatus:
{
Description: The status of the resource (ex. Active) ,
Required: False ,
}
string ,
resourceId:
{
Description: The ID of the resource ,
Required: False ,
}
string ,
externalResourceId:
{
Description: The ID of the external resource ,
Required: False ,
}
string ,
}
,
]
,
currencyCode:
{
Description: The currency code of the cost. ,
Required: False ,
}
string ,
startDateTime:
{
Description: The start time of the cost data. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The end time of the cost data. ,
Format: date-time ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the cost. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
targetCost:
{
Description: The target cost properties ,
Required: False ,
}
{
status:
{
Description: Target cost status ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Lab target cost ,
Format: int32 ,
Required: False ,
}
integer ,
costThresholds:
{
Description: Cost thresholds. ,
Required: False ,
}
[
{
thresholdId:
{
Description: The ID of the cost threshold item. ,
Required: False ,
}
string ,
percentageThreshold:
{
Description: The value of the percentage cost threshold. ,
Required: False ,
}
{
thresholdValue:
{
Description: The cost threshold value. ,
Format: double ,
Required: False ,
}
number ,
}
,
displayOnChart:
{
Description: Indicates whether this threshold will be displayed on cost charts. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
sendNotificationWhenExceeded:
{
Description: Indicates whether notifications will be sent when this threshold is exceeded. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notificationSent:
{
Description: Indicates the datetime when notifications were last sent for this threshold. ,
Required: False ,
}
string ,
}
,
]
,
cycleStartDateTime:
{
Description: Reporting cycle start date. ,
Format: date-time ,
Required: False ,
}
string ,
cycleEndDateTime:
{
Description: Reporting cycle end date. ,
Format: date-time ,
Required: False ,
}
string ,
cycleType:
{
Description: Reporting cycle type. ,
Enum:
{
CalendarMonth: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
labCostSummary:
{
Description: The lab cost summary component of the cost data. ,
Required: False ,
}
{
estimatedLabCost:
{
Description: The cost component of the cost item. ,
Format: double ,
Required: False ,
}
number ,
}
,
labCostDetails:
{
Description: The lab cost details component of the cost data. ,
Required: False ,
}
[
{
date:
{
Description: The date of the cost item. ,
Format: date-time ,
Required: False ,
}
string ,
cost:
{
Description: The cost component of the cost item. ,
Format: double ,
Required: False ,
}
number ,
costType:
{
Description: The type of the cost. ,
Enum:
{
Unavailable: No description available. ,
Reported: No description available. ,
Projected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceCosts:
{
Description: The resource cost component of the cost data. ,
Required: False ,
}
[
{
resourcename:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
resourceUId:
{
Description: The unique identifier of the resource. ,
Required: False ,
}
string ,
resourceCost:
{
Description: The cost component of the resource cost item. ,
Format: double ,
Required: False ,
}
number ,
resourceType:
{
Description: The logical resource type (ex. virtualmachine, storageaccount) ,
Required: False ,
}
string ,
resourceOwner:
{
Description: The owner of the resource (ex. janedoe@microsoft.com) ,
Required: False ,
}
string ,
resourcePricingTier:
{
Description: The category of the resource (ex. Premium_LRS, Standard_DS1) ,
Required: False ,
}
string ,
resourceStatus:
{
Description: The status of the resource (ex. Active) ,
Required: False ,
}
string ,
resourceId:
{
Description: The ID of the resource ,
Required: False ,
}
string ,
externalResourceId:
{
Description: The ID of the external resource ,
Required: False ,
}
string ,
}
,
]
,
currencyCode:
{
Description: The currency code of the cost. ,
Required: False ,
}
string ,
startDateTime:
{
Description: The start time of the cost data. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The end time of the cost data. ,
Format: date-time ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the cost. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
targetCost:
{
Description: The target cost properties ,
Required: False ,
}
{
status:
{
Description: Target cost status ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
target:
{
Description: Lab target cost ,
Format: int32 ,
Required: False ,
}
integer ,
costThresholds:
{
Description: Cost thresholds. ,
Required: False ,
}
[
{
thresholdId:
{
Description: The ID of the cost threshold item. ,
Required: False ,
}
string ,
percentageThreshold:
{
Description: The value of the percentage cost threshold. ,
Required: False ,
}
{
thresholdValue:
{
Description: The cost threshold value. ,
Format: double ,
Required: False ,
}
number ,
}
,
displayOnChart:
{
Description: Indicates whether this threshold will be displayed on cost charts. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
sendNotificationWhenExceeded:
{
Description: Indicates whether notifications will be sent when this threshold is exceeded. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
notificationSent:
{
Description: Indicates the datetime when notifications were last sent for this threshold. ,
Required: False ,
}
string ,
}
,
]
,
cycleStartDateTime:
{
Description: Reporting cycle start date. ,
Format: date-time ,
Required: False ,
}
string ,
cycleEndDateTime:
{
Description: Reporting cycle end date. ,
Format: date-time ,
Required: False ,
}
string ,
cycleType:
{
Description: Reporting cycle type. ,
Enum:
{
CalendarMonth: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
labCostSummary:
{
Description: The lab cost summary component of the cost data. ,
Required: False ,
}
{
estimatedLabCost:
{
Description: The cost component of the cost item. ,
Format: double ,
Required: False ,
}
number ,
}
,
labCostDetails:
{
Description: The lab cost details component of the cost data. ,
Required: False ,
}
[
{
date:
{
Description: The date of the cost item. ,
Format: date-time ,
Required: False ,
}
string ,
cost:
{
Description: The cost component of the cost item. ,
Format: double ,
Required: False ,
}
number ,
costType:
{
Description: The type of the cost. ,
Enum:
{
Unavailable: No description available. ,
Reported: No description available. ,
Projected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceCosts:
{
Description: The resource cost component of the cost data. ,
Required: False ,
}
[
{
resourcename:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
resourceUId:
{
Description: The unique identifier of the resource. ,
Required: False ,
}
string ,
resourceCost:
{
Description: The cost component of the resource cost item. ,
Format: double ,
Required: False ,
}
number ,
resourceType:
{
Description: The logical resource type (ex. virtualmachine, storageaccount) ,
Required: False ,
}
string ,
resourceOwner:
{
Description: The owner of the resource (ex. janedoe@microsoft.com) ,
Required: False ,
}
string ,
resourcePricingTier:
{
Description: The category of the resource (ex. Premium_LRS, Standard_DS1) ,
Required: False ,
}
string ,
resourceStatus:
{
Description: The status of the resource (ex. Active) ,
Required: False ,
}
string ,
resourceId:
{
Description: The ID of the resource ,
Required: False ,
}
string ,
externalResourceId:
{
Description: The ID of the external resource ,
Required: False ,
}
string ,
}
,
]
,
currencyCode:
{
Description: The currency code of the cost. ,
Required: False ,
}
string ,
startDateTime:
{
Description: The start time of the cost data. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The end time of the cost data. ,
Format: date-time ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the cost. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_CreateEnvironment (removed)
Description :  Create virtual machines in a lab. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/createEnvironment
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
labVirtualMachineCreationParameter:
{
Description: Properties for creating a virtual machine. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
bulkCreationParameters:
{
Description: The number of virtual machine instances to create. ,
Required: False ,
}
{
instanceCount:
{
Description: The number of virtual machine instances to create. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomImages_List (removed)
Description :  List custom images in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=vm)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The CustomImage items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
vm:
{
Description: The virtual machine from which the image is to be created. ,
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). ,
Enum:
{
NonSysprepped: No description available. ,
SysprepRequested: No description available. ,
SysprepApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
linuxOsInfo:
{
Description: The Linux OS information of the VM. ,
Required: False ,
}
{
linuxOsState:
{
Description: The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). ,
Enum:
{
NonDeprovisioned: No description available. ,
DeprovisionRequested: No description available. ,
DeprovisionApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
vhd:
{
Description: The VHD from which the image is to be created. ,
Required: False ,
}
{
imageName:
{
Description: The image name. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
osType:
{
Description: The OS type of the custom image (i.e. Windows, Linux) ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
author:
{
Description: The author of the custom image. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the custom image. ,
Format: date-time ,
Required: False ,
}
string ,
managedImageId:
{
Description: The Managed Image Id backing the custom image. ,
Required: False ,
}
string ,
managedSnapshotId:
{
Description: The Managed Snapshot Id backing the custom image. ,
Required: False ,
}
string ,
dataDiskStorageInfo:
{
Description: Storage information about the data disks present in the custom image ,
Required: False ,
}
[
{
lun:
{
Description: Disk Lun ,
Required: False ,
}
string ,
storageType:
{
Description: Disk Storage Type ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
customImagePlan:
{
Description: Storage information about the plan related to this custom image ,
Required: False ,
}
{
id:
{
Description: The id of the plan, equivalent to name of the plan ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
offer:
{
Description: The offer for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
}
,
isPlanAuthorized:
{
Description: Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomImages_Get (removed)
Description :  Get custom image.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the CustomImage ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=vm)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
vm:
{
Description: The virtual machine from which the image is to be created. ,
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). ,
Enum:
{
NonSysprepped: No description available. ,
SysprepRequested: No description available. ,
SysprepApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
linuxOsInfo:
{
Description: The Linux OS information of the VM. ,
Required: False ,
}
{
linuxOsState:
{
Description: The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). ,
Enum:
{
NonDeprovisioned: No description available. ,
DeprovisionRequested: No description available. ,
DeprovisionApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
vhd:
{
Description: The VHD from which the image is to be created. ,
Required: False ,
}
{
imageName:
{
Description: The image name. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
osType:
{
Description: The OS type of the custom image (i.e. Windows, Linux) ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
author:
{
Description: The author of the custom image. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the custom image. ,
Format: date-time ,
Required: False ,
}
string ,
managedImageId:
{
Description: The Managed Image Id backing the custom image. ,
Required: False ,
}
string ,
managedSnapshotId:
{
Description: The Managed Snapshot Id backing the custom image. ,
Required: False ,
}
string ,
dataDiskStorageInfo:
{
Description: Storage information about the data disks present in the custom image ,
Required: False ,
}
[
{
lun:
{
Description: Disk Lun ,
Required: False ,
}
string ,
storageType:
{
Description: Disk Storage Type ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
customImagePlan:
{
Description: Storage information about the plan related to this custom image ,
Required: False ,
}
{
id:
{
Description: The id of the plan, equivalent to name of the plan ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
offer:
{
Description: The offer for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
}
,
isPlanAuthorized:
{
Description: Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomImages_CreateOrUpdate (removed)
Description :  Create or replace an existing custom image. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the CustomImage ,
Required: True ,
}
string ,
customImage:
{
Description: A custom image. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
vm:
{
Description: The virtual machine from which the image is to be created. ,
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). ,
Enum:
{
NonSysprepped: No description available. ,
SysprepRequested: No description available. ,
SysprepApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
linuxOsInfo:
{
Description: The Linux OS information of the VM. ,
Required: False ,
}
{
linuxOsState:
{
Description: The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). ,
Enum:
{
NonDeprovisioned: No description available. ,
DeprovisionRequested: No description available. ,
DeprovisionApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
vhd:
{
Description: The VHD from which the image is to be created. ,
Required: False ,
}
{
imageName:
{
Description: The image name. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
osType:
{
Description: The OS type of the custom image (i.e. Windows, Linux) ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
author:
{
Description: The author of the custom image. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the custom image. ,
Format: date-time ,
Required: False ,
}
string ,
managedImageId:
{
Description: The Managed Image Id backing the custom image. ,
Required: False ,
}
string ,
managedSnapshotId:
{
Description: The Managed Snapshot Id backing the custom image. ,
Required: False ,
}
string ,
dataDiskStorageInfo:
{
Description: Storage information about the data disks present in the custom image ,
Required: False ,
}
[
{
lun:
{
Description: Disk Lun ,
Required: False ,
}
string ,
storageType:
{
Description: Disk Storage Type ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
customImagePlan:
{
Description: Storage information about the plan related to this custom image ,
Required: False ,
}
{
id:
{
Description: The id of the plan, equivalent to name of the plan ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
offer:
{
Description: The offer for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
}
,
isPlanAuthorized:
{
Description: Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
vm:
{
Description: The virtual machine from which the image is to be created. ,
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). ,
Enum:
{
NonSysprepped: No description available. ,
SysprepRequested: No description available. ,
SysprepApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
linuxOsInfo:
{
Description: The Linux OS information of the VM. ,
Required: False ,
}
{
linuxOsState:
{
Description: The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). ,
Enum:
{
NonDeprovisioned: No description available. ,
DeprovisionRequested: No description available. ,
DeprovisionApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
vhd:
{
Description: The VHD from which the image is to be created. ,
Required: False ,
}
{
imageName:
{
Description: The image name. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
osType:
{
Description: The OS type of the custom image (i.e. Windows, Linux) ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
author:
{
Description: The author of the custom image. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the custom image. ,
Format: date-time ,
Required: False ,
}
string ,
managedImageId:
{
Description: The Managed Image Id backing the custom image. ,
Required: False ,
}
string ,
managedSnapshotId:
{
Description: The Managed Snapshot Id backing the custom image. ,
Required: False ,
}
string ,
dataDiskStorageInfo:
{
Description: Storage information about the data disks present in the custom image ,
Required: False ,
}
[
{
lun:
{
Description: Disk Lun ,
Required: False ,
}
string ,
storageType:
{
Description: Disk Storage Type ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
customImagePlan:
{
Description: Storage information about the plan related to this custom image ,
Required: False ,
}
{
id:
{
Description: The id of the plan, equivalent to name of the plan ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
offer:
{
Description: The offer for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
}
,
isPlanAuthorized:
{
Description: Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A custom image. ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
vm:
{
Description: The virtual machine from which the image is to be created. ,
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). ,
Enum:
{
NonSysprepped: No description available. ,
SysprepRequested: No description available. ,
SysprepApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
linuxOsInfo:
{
Description: The Linux OS information of the VM. ,
Required: False ,
}
{
linuxOsState:
{
Description: The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). ,
Enum:
{
NonDeprovisioned: No description available. ,
DeprovisionRequested: No description available. ,
DeprovisionApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
vhd:
{
Description: The VHD from which the image is to be created. ,
Required: False ,
}
{
imageName:
{
Description: The image name. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
osType:
{
Description: The OS type of the custom image (i.e. Windows, Linux) ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
author:
{
Description: The author of the custom image. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the custom image. ,
Format: date-time ,
Required: False ,
}
string ,
managedImageId:
{
Description: The Managed Image Id backing the custom image. ,
Required: False ,
}
string ,
managedSnapshotId:
{
Description: The Managed Snapshot Id backing the custom image. ,
Required: False ,
}
string ,
dataDiskStorageInfo:
{
Description: Storage information about the data disks present in the custom image ,
Required: False ,
}
[
{
lun:
{
Description: Disk Lun ,
Required: False ,
}
string ,
storageType:
{
Description: Disk Storage Type ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
customImagePlan:
{
Description: Storage information about the plan related to this custom image ,
Required: False ,
}
{
id:
{
Description: The id of the plan, equivalent to name of the plan ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
offer:
{
Description: The offer for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
}
,
isPlanAuthorized:
{
Description: Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomImages_Update (removed)
Description :  Allows modifying tags of custom images. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the CustomImage ,
Required: True ,
}
string ,
customImage:
{
Description: A custom image. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
vm:
{
Description: The virtual machine from which the image is to be created. ,
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). ,
Enum:
{
NonSysprepped: No description available. ,
SysprepRequested: No description available. ,
SysprepApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
linuxOsInfo:
{
Description: The Linux OS information of the VM. ,
Required: False ,
}
{
linuxOsState:
{
Description: The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). ,
Enum:
{
NonDeprovisioned: No description available. ,
DeprovisionRequested: No description available. ,
DeprovisionApplied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
vhd:
{
Description: The VHD from which the image is to be created. ,
Required: False ,
}
{
imageName:
{
Description: The image name. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
osType:
{
Description: The OS type of the custom image (i.e. Windows, Linux) ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
author:
{
Description: The author of the custom image. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the custom image. ,
Format: date-time ,
Required: False ,
}
string ,
managedImageId:
{
Description: The Managed Image Id backing the custom image. ,
Required: False ,
}
string ,
managedSnapshotId:
{
Description: The Managed Snapshot Id backing the custom image. ,
Required: False ,
}
string ,
dataDiskStorageInfo:
{
Description: Storage information about the data disks present in the custom image ,
Required: False ,
}
[
{
lun:
{
Description: Disk Lun ,
Required: False ,
}
string ,
storageType:
{
Description: Disk Storage Type ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
customImagePlan:
{
Description: Storage information about the plan related to this custom image ,
Required: False ,
}
{
id:
{
Description: The id of the plan, equivalent to name of the plan ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
offer:
{
Description: The offer for the plan from the marketplace image the custom image is derived from ,
Required: False ,
}
string ,
}
,
isPlanAuthorized:
{
Description: Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomImages_Delete (removed)
Description :  Delete custom image. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the CustomImage ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_ExportResourceUsage (removed)
Description :  Exports the lab resource usage into a storage account This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/exportResourceUsage
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
exportResourceUsageParameters:
{
Description: The parameters of the export operation. ,
Required: True ,
}
{
blobStorageAbsoluteSasUri:
{
Description: The blob storage absolute sas uri with write permission to the container which the usage data needs to be uploaded to. ,
Required: False ,
}
string ,
usageStartDate:
{
Description: The start time of the usage. If not provided, usage will be reported since the beginning of data collection. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Formulas_List (removed)
Description :  List formulas in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=description)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Formula items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the formula. ,
Required: True ,
}
{
description:
{
Description: The description of the formula. ,
Required: False ,
}
string ,
author:
{
Description: The author of the formula. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the formula. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the formula. ,
Format: date-time ,
Required: False ,
}
string ,
formulaContent:
{
Description: The content of the formula. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
bulkCreationParameters:
{
Description: The number of virtual machine instances to create. ,
Required: False ,
}
{
instanceCount:
{
Description: The number of virtual machine instances to create. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
vm:
{
Description: Information about a VM from which a formula is to be created. ,
Required: False ,
}
{
labVmId:
{
Description: The identifier of the VM from which a formula is to be created. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Formulas_Get (removed)
Description :  Get formula.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Formula ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=description)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the formula. ,
Required: True ,
}
{
description:
{
Description: The description of the formula. ,
Required: False ,
}
string ,
author:
{
Description: The author of the formula. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the formula. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the formula. ,
Format: date-time ,
Required: False ,
}
string ,
formulaContent:
{
Description: The content of the formula. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
bulkCreationParameters:
{
Description: The number of virtual machine instances to create. ,
Required: False ,
}
{
instanceCount:
{
Description: The number of virtual machine instances to create. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
vm:
{
Description: Information about a VM from which a formula is to be created. ,
Required: False ,
}
{
labVmId:
{
Description: The identifier of the VM from which a formula is to be created. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Formulas_CreateOrUpdate (removed)
Description :  Create or replace an existing formula. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Formula ,
Required: True ,
}
string ,
formula:
{
Description: A formula for creating a VM, specifying an image base and other parameters ,
Required: True ,
}
{
properties:
{
Description: The properties of the formula. ,
Required: True ,
}
{
description:
{
Description: The description of the formula. ,
Required: False ,
}
string ,
author:
{
Description: The author of the formula. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the formula. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the formula. ,
Format: date-time ,
Required: False ,
}
string ,
formulaContent:
{
Description: The content of the formula. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
bulkCreationParameters:
{
Description: The number of virtual machine instances to create. ,
Required: False ,
}
{
instanceCount:
{
Description: The number of virtual machine instances to create. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
vm:
{
Description: Information about a VM from which a formula is to be created. ,
Required: False ,
}
{
labVmId:
{
Description: The identifier of the VM from which a formula is to be created. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the formula. ,
Required: True ,
}
{
description:
{
Description: The description of the formula. ,
Required: False ,
}
string ,
author:
{
Description: The author of the formula. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the formula. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the formula. ,
Format: date-time ,
Required: False ,
}
string ,
formulaContent:
{
Description: The content of the formula. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
bulkCreationParameters:
{
Description: The number of virtual machine instances to create. ,
Required: False ,
}
{
instanceCount:
{
Description: The number of virtual machine instances to create. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
vm:
{
Description: Information about a VM from which a formula is to be created. ,
Required: False ,
}
{
labVmId:
{
Description: The identifier of the VM from which a formula is to be created. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A formula for creating a VM, specifying an image base and other parameters ,
}
{
properties:
{
Description: The properties of the formula. ,
Required: True ,
}
{
description:
{
Description: The description of the formula. ,
Required: False ,
}
string ,
author:
{
Description: The author of the formula. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the formula. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the formula. ,
Format: date-time ,
Required: False ,
}
string ,
formulaContent:
{
Description: The content of the formula. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
bulkCreationParameters:
{
Description: The number of virtual machine instances to create. ,
Required: False ,
}
{
instanceCount:
{
Description: The number of virtual machine instances to create. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
vm:
{
Description: Information about a VM from which a formula is to be created. ,
Required: False ,
}
{
labVmId:
{
Description: The identifier of the VM from which a formula is to be created. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Formulas_Update (removed)
Description :  Allows modifying tags of formulas. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Formula ,
Required: True ,
}
string ,
formula:
{
Description: A formula for creating a VM, specifying an image base and other parameters ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the formula. ,
Required: True ,
}
{
description:
{
Description: The description of the formula. ,
Required: False ,
}
string ,
author:
{
Description: The author of the formula. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the formula. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the formula. ,
Format: date-time ,
Required: False ,
}
string ,
formulaContent:
{
Description: The content of the formula. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
bulkCreationParameters:
{
Description: The number of virtual machine instances to create. ,
Required: False ,
}
{
instanceCount:
{
Description: The number of virtual machine instances to create. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
vm:
{
Description: Information about a VM from which a formula is to be created. ,
Required: False ,
}
{
labVmId:
{
Description: The identifier of the VM from which a formula is to be created. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Formulas_Delete (removed)
Description :  Delete formula.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Formula ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GalleryImages_List (removed)
Description :  List gallery images in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/galleryimages
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=displayName)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The GalleryImage items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the gallery image. ,
Required: True ,
}
{
author:
{
Description: The author of the gallery image. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the gallery image. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The description of the gallery image. ,
Required: False ,
}
string ,
imageReference:
{
Description: The image reference of the gallery image. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
icon:
{
Description: The icon of the gallery image. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates whether this gallery image is enabled. ,
Required: False ,
}
boolean ,
planId:
{
Description: The third party plan that applies to this image ,
Required: False ,
}
string ,
isPlanAuthorized:
{
Description: Indicates if the plan has been authorized for programmatic deployment. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_GenerateUploadUri (removed)
Description :  Generate a URI for uploading custom disk images to a Lab.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/generateUploadUri
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
generateUploadUriParameter:
{
Description: Properties for generating an upload URI. ,
Required: True ,
}
{
blobName:
{
Description: The blob name of the upload URI. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
uploadUri:
{
Description: The upload URI for the VHD. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_ImportVirtualMachine (removed)
Description :  Import a virtual machine into a different lab. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/importVirtualMachine
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
importLabVirtualMachineRequest:
{
Description: This represents the payload required to import a virtual machine from a different lab into the current one ,
Required: True ,
}
{
sourceVirtualMachineResourceId:
{
Description: The full resource ID of the virtual machine to be imported. ,
Required: False ,
}
string ,
destinationVirtualMachineName:
{
Description: The name of the virtual machine in the destination lab ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Labs_ListVhds (removed)
Description :  List disk images available for custom image creation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/listVhds
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The LabVhd items on this page ,
Required: True ,
}
[
{
id:
{
Description: The URI to the VHD. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationChannels_List (removed)
Description :  List notification channels in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=webHookUrl)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NotificationChannel items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
webHookUrl:
{
Description: The webhook URL to send notifications to. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
description:
{
Description: Description of notification. ,
Required: False ,
}
string ,
events:
{
Description: The list of event for which this notification is enabled. ,
Required: False ,
}
[
{
eventName:
{
Description: The event type for which this notification is enabled (i.e. AutoShutdown, Cost) ,
Enum:
{
AutoShutdown: No description available. ,
Cost: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
createdDate:
{
Description: The creation date of the notification channel. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationChannels_Get (removed)
Description :  Get notification channel.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the NotificationChannel ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=webHookUrl)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
webHookUrl:
{
Description: The webhook URL to send notifications to. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
description:
{
Description: Description of notification. ,
Required: False ,
}
string ,
events:
{
Description: The list of event for which this notification is enabled. ,
Required: False ,
}
[
{
eventName:
{
Description: The event type for which this notification is enabled (i.e. AutoShutdown, Cost) ,
Enum:
{
AutoShutdown: No description available. ,
Cost: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
createdDate:
{
Description: The creation date of the notification channel. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationChannels_CreateOrUpdate (removed)
Description :  Create or replace an existing notification channel.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the NotificationChannel ,
Required: True ,
}
string ,
notificationChannel:
{
Description: A notification. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
webHookUrl:
{
Description: The webhook URL to send notifications to. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
description:
{
Description: Description of notification. ,
Required: False ,
}
string ,
events:
{
Description: The list of event for which this notification is enabled. ,
Required: False ,
}
[
{
eventName:
{
Description: The event type for which this notification is enabled (i.e. AutoShutdown, Cost) ,
Enum:
{
AutoShutdown: No description available. ,
Cost: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
createdDate:
{
Description: The creation date of the notification channel. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
webHookUrl:
{
Description: The webhook URL to send notifications to. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
description:
{
Description: Description of notification. ,
Required: False ,
}
string ,
events:
{
Description: The list of event for which this notification is enabled. ,
Required: False ,
}
[
{
eventName:
{
Description: The event type for which this notification is enabled (i.e. AutoShutdown, Cost) ,
Enum:
{
AutoShutdown: No description available. ,
Cost: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
createdDate:
{
Description: The creation date of the notification channel. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
webHookUrl:
{
Description: The webhook URL to send notifications to. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
description:
{
Description: Description of notification. ,
Required: False ,
}
string ,
events:
{
Description: The list of event for which this notification is enabled. ,
Required: False ,
}
[
{
eventName:
{
Description: The event type for which this notification is enabled (i.e. AutoShutdown, Cost) ,
Enum:
{
AutoShutdown: No description available. ,
Cost: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
createdDate:
{
Description: The creation date of the notification channel. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationChannels_Update (removed)
Description :  Allows modifying tags of notification channels. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the NotificationChannel ,
Required: True ,
}
string ,
notificationChannel:
{
Description: A notification. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
webHookUrl:
{
Description: The webhook URL to send notifications to. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
description:
{
Description: Description of notification. ,
Required: False ,
}
string ,
events:
{
Description: The list of event for which this notification is enabled. ,
Required: False ,
}
[
{
eventName:
{
Description: The event type for which this notification is enabled (i.e. AutoShutdown, Cost) ,
Enum:
{
AutoShutdown: No description available. ,
Cost: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
createdDate:
{
Description: The creation date of the notification channel. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationChannels_Delete (removed)
Description :  Delete notification channel.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the NotificationChannel ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationChannels_Notify (removed)
Description :  Send notification to provided channel.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}/notify
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the NotificationChannel ,
Required: True ,
}
string ,
notifyParameters:
{
Description: Properties for generating a Notification. ,
Required: True ,
}
{
eventName:
{
Description: The type of event (i.e. AutoShutdown, Cost) ,
Enum:
{
AutoShutdown: No description available. ,
Cost: No description available. ,
}
,
Required: False ,
}
enum ,
jsonPayload:
{
Description: Properties for the notification in json format. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PolicySets_EvaluatePolicies (removed)
Description :  Evaluates lab policy.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{name}/evaluatePolicies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the PolicySet ,
Required: True ,
}
string ,
evaluatePoliciesRequest:
{
Description: Request body for evaluating a policy set. ,
Required: True ,
}
{
policies:
{
Description: Policies to evaluate. ,
Required: False ,
}
[
{
factName:
{
Description: The fact name. ,
Required: False ,
}
string ,
factData:
{
Description: The fact data. ,
Required: False ,
}
string ,
valueOffset:
{
Description: The value offset. ,
Required: False ,
}
string ,
userObjectId:
{
Description: The user for which policies will be evaluated ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
results:
{
Description: Results of evaluating a policy set. ,
Required: False ,
}
[
{
hasError:
{
Description: A value indicating whether this policy set evaluation has discovered violations. ,
Required: False ,
}
boolean ,
policyViolations:
{
Description: The list of policy violations. ,
Required: False ,
}
[
{
code:
{
Description: The code of the policy violation. ,
Required: False ,
}
string ,
message:
{
Description: The message of the policy violation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_List (removed)
Description :  List policies in a given policy set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
policySetName:
{
Description: policysets ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=description)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Policy items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
description:
{
Description: The description of the policy. ,
Required: False ,
}
string ,
status:
{
Description: The status of the policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
factName:
{
Description: The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
UserOwnedLabPremiumVmCount: No description available. ,
LabVmCount: No description available. ,
LabPremiumVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
LabTargetCost: No description available. ,
EnvironmentTemplate: No description available. ,
ScheduleEditPermission: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy). ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy). ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The creation date of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_Get (removed)
Description :  Get policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
policySetName:
{
Description: policysets ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=description)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
description:
{
Description: The description of the policy. ,
Required: False ,
}
string ,
status:
{
Description: The status of the policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
factName:
{
Description: The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
UserOwnedLabPremiumVmCount: No description available. ,
LabVmCount: No description available. ,
LabPremiumVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
LabTargetCost: No description available. ,
EnvironmentTemplate: No description available. ,
ScheduleEditPermission: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy). ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy). ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The creation date of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_CreateOrUpdate (removed)
Description :  Create or replace an existing policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
policySetName:
{
Description: policysets ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
policy:
{
Description: A Policy. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
description:
{
Description: The description of the policy. ,
Required: False ,
}
string ,
status:
{
Description: The status of the policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
factName:
{
Description: The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
UserOwnedLabPremiumVmCount: No description available. ,
LabVmCount: No description available. ,
LabPremiumVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
LabTargetCost: No description available. ,
EnvironmentTemplate: No description available. ,
ScheduleEditPermission: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy). ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy). ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The creation date of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
description:
{
Description: The description of the policy. ,
Required: False ,
}
string ,
status:
{
Description: The status of the policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
factName:
{
Description: The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
UserOwnedLabPremiumVmCount: No description available. ,
LabVmCount: No description available. ,
LabPremiumVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
LabTargetCost: No description available. ,
EnvironmentTemplate: No description available. ,
ScheduleEditPermission: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy). ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy). ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The creation date of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
description:
{
Description: The description of the policy. ,
Required: False ,
}
string ,
status:
{
Description: The status of the policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
factName:
{
Description: The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
UserOwnedLabPremiumVmCount: No description available. ,
LabVmCount: No description available. ,
LabPremiumVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
LabTargetCost: No description available. ,
EnvironmentTemplate: No description available. ,
ScheduleEditPermission: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy). ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy). ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The creation date of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_Update (removed)
Description :  Allows modifying tags of policies. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
policySetName:
{
Description: policysets ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
policy:
{
Description: A Policy. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
description:
{
Description: The description of the policy. ,
Required: False ,
}
string ,
status:
{
Description: The status of the policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
factName:
{
Description: The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
UserOwnedLabPremiumVmCount: No description available. ,
LabVmCount: No description available. ,
LabPremiumVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
LabTargetCost: No description available. ,
EnvironmentTemplate: No description available. ,
ScheduleEditPermission: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy). ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy). ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
createdDate:
{
Description: The creation date of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_Delete (removed)
Description :  Delete policy.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
policySetName:
{
Description: policysets ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_List (removed)
Description :  List schedules in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=status)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Schedule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_Get (removed)
Description :  Get schedule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=status)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_CreateOrUpdate (removed)
Description :  Create or replace an existing schedule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
schedule:
{
Description: A schedule. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_Update (removed)
Description :  Allows modifying tags of schedules. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
schedule:
{
Description: A schedule. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_Delete (removed)
Description :  Delete schedule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_Execute (removed)
Description :  Execute a schedule. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}/execute
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schedules_ListApplicable (removed)
Description :  Lists all applicable schedules
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}/listApplicable
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Schedule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceRunners_Get (removed)
Description :  Get service runner.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/servicerunners/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ServiceRunner ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
type:
{
Description: Managed identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal id of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier of resource. ,
Required: False ,
}
string ,
clientSecretUrl:
{
Description: The client secret URL of the identity. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceRunners_CreateOrUpdate (removed)
Description :  Create or replace an existing service runner.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/servicerunners/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ServiceRunner ,
Required: True ,
}
string ,
serviceRunner:
{
Description: A container for a managed identity to execute DevTest lab services. ,
Required: True ,
}
{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
type:
{
Description: Managed identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal id of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier of resource. ,
Required: False ,
}
string ,
clientSecretUrl:
{
Description: The client secret URL of the identity. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
type:
{
Description: Managed identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal id of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier of resource. ,
Required: False ,
}
string ,
clientSecretUrl:
{
Description: The client secret URL of the identity. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
type:
{
Description: Managed identity. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: The principal id of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant identifier of resource. ,
Required: False ,
}
string ,
clientSecretUrl:
{
Description: The client secret URL of the identity. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceRunners_Delete (removed)
Description :  Delete service runner.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/servicerunners/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ServiceRunner ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_List (removed)
Description :  List user profiles in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=identity)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The User items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
identity:
{
Description: The identity of the user. ,
Required: False ,
}
{
principalName:
{
Description: Set to the principal name / UPN of the client JWT making the request. ,
Required: False ,
}
string ,
principalId:
{
Description: Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Set to the tenant ID of the client JWT making the request. ,
Required: False ,
}
string ,
objectId:
{
Description: Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available. ,
Required: False ,
}
string ,
appId:
{
Description: Set to the app Id of the client JWT making the request. ,
Required: False ,
}
string ,
}
,
secretStore:
{
Description: The secret store of the user. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The URI of the user's Key vault. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The ID of the user's Key vault. ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the user profile. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_Get (removed)
Description :  Get user profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the User ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=identity)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
identity:
{
Description: The identity of the user. ,
Required: False ,
}
{
principalName:
{
Description: Set to the principal name / UPN of the client JWT making the request. ,
Required: False ,
}
string ,
principalId:
{
Description: Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Set to the tenant ID of the client JWT making the request. ,
Required: False ,
}
string ,
objectId:
{
Description: Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available. ,
Required: False ,
}
string ,
appId:
{
Description: Set to the app Id of the client JWT making the request. ,
Required: False ,
}
string ,
}
,
secretStore:
{
Description: The secret store of the user. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The URI of the user's Key vault. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The ID of the user's Key vault. ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the user profile. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_CreateOrUpdate (removed)
Description :  Create or replace an existing user profile. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the User ,
Required: True ,
}
string ,
user:
{
Description: Profile of a lab user. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
identity:
{
Description: The identity of the user. ,
Required: False ,
}
{
principalName:
{
Description: Set to the principal name / UPN of the client JWT making the request. ,
Required: False ,
}
string ,
principalId:
{
Description: Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Set to the tenant ID of the client JWT making the request. ,
Required: False ,
}
string ,
objectId:
{
Description: Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available. ,
Required: False ,
}
string ,
appId:
{
Description: Set to the app Id of the client JWT making the request. ,
Required: False ,
}
string ,
}
,
secretStore:
{
Description: The secret store of the user. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The URI of the user's Key vault. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The ID of the user's Key vault. ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the user profile. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
identity:
{
Description: The identity of the user. ,
Required: False ,
}
{
principalName:
{
Description: Set to the principal name / UPN of the client JWT making the request. ,
Required: False ,
}
string ,
principalId:
{
Description: Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Set to the tenant ID of the client JWT making the request. ,
Required: False ,
}
string ,
objectId:
{
Description: Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available. ,
Required: False ,
}
string ,
appId:
{
Description: Set to the app Id of the client JWT making the request. ,
Required: False ,
}
string ,
}
,
secretStore:
{
Description: The secret store of the user. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The URI of the user's Key vault. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The ID of the user's Key vault. ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the user profile. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Profile of a lab user. ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
identity:
{
Description: The identity of the user. ,
Required: False ,
}
{
principalName:
{
Description: Set to the principal name / UPN of the client JWT making the request. ,
Required: False ,
}
string ,
principalId:
{
Description: Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Set to the tenant ID of the client JWT making the request. ,
Required: False ,
}
string ,
objectId:
{
Description: Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available. ,
Required: False ,
}
string ,
appId:
{
Description: Set to the app Id of the client JWT making the request. ,
Required: False ,
}
string ,
}
,
secretStore:
{
Description: The secret store of the user. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The URI of the user's Key vault. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The ID of the user's Key vault. ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the user profile. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_Update (removed)
Description :  Allows modifying tags of user profiles. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the User ,
Required: True ,
}
string ,
user:
{
Description: Profile of a lab user. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
identity:
{
Description: The identity of the user. ,
Required: False ,
}
{
principalName:
{
Description: Set to the principal name / UPN of the client JWT making the request. ,
Required: False ,
}
string ,
principalId:
{
Description: Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Set to the tenant ID of the client JWT making the request. ,
Required: False ,
}
string ,
objectId:
{
Description: Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available. ,
Required: False ,
}
string ,
appId:
{
Description: Set to the app Id of the client JWT making the request. ,
Required: False ,
}
string ,
}
,
secretStore:
{
Description: The secret store of the user. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The URI of the user's Key vault. ,
Required: False ,
}
string ,
keyVaultId:
{
Description: The ID of the user's Key vault. ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the user profile. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Users_Delete (removed)
Description :  Delete user profile. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the User ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Disks_List (removed)
Description :  List disks in a given user profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=diskType)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Disk items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the disk. ,
Required: True ,
}
{
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGiB:
{
Description: The size of the disk in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
leasedByLabVmId:
{
Description: The resource ID of the VM to which this disk is leased. ,
Required: False ,
}
string ,
diskBlobName:
{
Description: When backed by a blob, the name of the VHD blob without extension. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
storageAccountId:
{
Description: When backed by a blob, the storage account where the blob is. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the disk. ,
Format: date-time ,
Required: False ,
}
string ,
hostCaching:
{
Description: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite). ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Disks_Get (removed)
Description :  Get disk.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Disk ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=diskType)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the disk. ,
Required: True ,
}
{
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGiB:
{
Description: The size of the disk in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
leasedByLabVmId:
{
Description: The resource ID of the VM to which this disk is leased. ,
Required: False ,
}
string ,
diskBlobName:
{
Description: When backed by a blob, the name of the VHD blob without extension. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
storageAccountId:
{
Description: When backed by a blob, the storage account where the blob is. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the disk. ,
Format: date-time ,
Required: False ,
}
string ,
hostCaching:
{
Description: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite). ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Disks_CreateOrUpdate (removed)
Description :  Create or replace an existing disk. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Disk ,
Required: True ,
}
string ,
disk:
{
Description: A Disk. ,
Required: True ,
}
{
properties:
{
Description: The properties of the disk. ,
Required: True ,
}
{
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGiB:
{
Description: The size of the disk in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
leasedByLabVmId:
{
Description: The resource ID of the VM to which this disk is leased. ,
Required: False ,
}
string ,
diskBlobName:
{
Description: When backed by a blob, the name of the VHD blob without extension. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
storageAccountId:
{
Description: When backed by a blob, the storage account where the blob is. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the disk. ,
Format: date-time ,
Required: False ,
}
string ,
hostCaching:
{
Description: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite). ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the disk. ,
Required: True ,
}
{
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGiB:
{
Description: The size of the disk in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
leasedByLabVmId:
{
Description: The resource ID of the VM to which this disk is leased. ,
Required: False ,
}
string ,
diskBlobName:
{
Description: When backed by a blob, the name of the VHD blob without extension. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
storageAccountId:
{
Description: When backed by a blob, the storage account where the blob is. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the disk. ,
Format: date-time ,
Required: False ,
}
string ,
hostCaching:
{
Description: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite). ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A Disk. ,
}
{
properties:
{
Description: The properties of the disk. ,
Required: True ,
}
{
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGiB:
{
Description: The size of the disk in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
leasedByLabVmId:
{
Description: The resource ID of the VM to which this disk is leased. ,
Required: False ,
}
string ,
diskBlobName:
{
Description: When backed by a blob, the name of the VHD blob without extension. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
storageAccountId:
{
Description: When backed by a blob, the storage account where the blob is. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the disk. ,
Format: date-time ,
Required: False ,
}
string ,
hostCaching:
{
Description: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite). ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Disks_Update (removed)
Description :  Allows modifying tags of disks. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Disk ,
Required: True ,
}
string ,
disk:
{
Description: A Disk. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the disk. ,
Required: True ,
}
{
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGiB:
{
Description: The size of the disk in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
leasedByLabVmId:
{
Description: The resource ID of the VM to which this disk is leased. ,
Required: False ,
}
string ,
diskBlobName:
{
Description: When backed by a blob, the name of the VHD blob without extension. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
storageAccountId:
{
Description: When backed by a blob, the storage account where the blob is. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the disk. ,
Format: date-time ,
Required: False ,
}
string ,
hostCaching:
{
Description: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite). ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Disks_Delete (removed)
Description :  Delete disk. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Disk ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Disks_Attach (removed)
Description :  Attach and create the lease of the disk to the virtual machine. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}/attach
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Disk ,
Required: True ,
}
string ,
attachDiskProperties:
{
Description: Properties of the disk to attach. ,
Required: True ,
}
{
leasedByLabVmId:
{
Description: The resource ID of the Lab virtual machine to which the disk is attached. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Disks_Detach (removed)
Description :  Detach and break the lease of the disk attached to the virtual machine. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}/detach
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Disk ,
Required: True ,
}
string ,
detachDiskProperties:
{
Description: Properties of the disk to detach. ,
Required: True ,
}
{
leasedByLabVmId:
{
Description: The resource ID of the Lab VM to which the disk is attached. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Environments_List (removed)
Description :  List environments in a given user profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=deploymentProperties)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DtlEnvironment items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the environment. ,
Required: True ,
}
{
deploymentProperties:
{
Description: The deployment properties of the environment. ,
Required: False ,
}
{
armTemplateId:
{
Description: The Azure Resource Manager template's identifier. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the Azure Resource Manager template. ,
Required: False ,
}
[
{
name:
{
Description: The name of the template parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the template parameter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
armTemplateDisplayName:
{
Description: The display name of the Azure Resource Manager template that produced the environment. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The identifier of the resource group containing the environment's resources. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The creator of the environment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Environments_Get (removed)
Description :  Get environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the DtlEnvironment ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=deploymentProperties)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the environment. ,
Required: True ,
}
{
deploymentProperties:
{
Description: The deployment properties of the environment. ,
Required: False ,
}
{
armTemplateId:
{
Description: The Azure Resource Manager template's identifier. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the Azure Resource Manager template. ,
Required: False ,
}
[
{
name:
{
Description: The name of the template parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the template parameter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
armTemplateDisplayName:
{
Description: The display name of the Azure Resource Manager template that produced the environment. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The identifier of the resource group containing the environment's resources. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The creator of the environment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Environments_CreateOrUpdate (removed)
Description :  Create or replace an existing environment. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the DtlEnvironment ,
Required: True ,
}
string ,
dtlEnvironment:
{
Description: An environment, which is essentially an ARM template deployment. ,
Required: True ,
}
{
properties:
{
Description: The properties of the environment. ,
Required: True ,
}
{
deploymentProperties:
{
Description: The deployment properties of the environment. ,
Required: False ,
}
{
armTemplateId:
{
Description: The Azure Resource Manager template's identifier. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the Azure Resource Manager template. ,
Required: False ,
}
[
{
name:
{
Description: The name of the template parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the template parameter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
armTemplateDisplayName:
{
Description: The display name of the Azure Resource Manager template that produced the environment. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The identifier of the resource group containing the environment's resources. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The creator of the environment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the environment. ,
Required: True ,
}
{
deploymentProperties:
{
Description: The deployment properties of the environment. ,
Required: False ,
}
{
armTemplateId:
{
Description: The Azure Resource Manager template's identifier. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the Azure Resource Manager template. ,
Required: False ,
}
[
{
name:
{
Description: The name of the template parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the template parameter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
armTemplateDisplayName:
{
Description: The display name of the Azure Resource Manager template that produced the environment. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The identifier of the resource group containing the environment's resources. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The creator of the environment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An environment, which is essentially an ARM template deployment. ,
}
{
properties:
{
Description: The properties of the environment. ,
Required: True ,
}
{
deploymentProperties:
{
Description: The deployment properties of the environment. ,
Required: False ,
}
{
armTemplateId:
{
Description: The Azure Resource Manager template's identifier. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the Azure Resource Manager template. ,
Required: False ,
}
[
{
name:
{
Description: The name of the template parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the template parameter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
armTemplateDisplayName:
{
Description: The display name of the Azure Resource Manager template that produced the environment. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The identifier of the resource group containing the environment's resources. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The creator of the environment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Environments_Update (removed)
Description :  Allows modifying tags of environments. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the DtlEnvironment ,
Required: True ,
}
string ,
dtlEnvironment:
{
Description: An environment, which is essentially an ARM template deployment. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the environment. ,
Required: True ,
}
{
deploymentProperties:
{
Description: The deployment properties of the environment. ,
Required: False ,
}
{
armTemplateId:
{
Description: The Azure Resource Manager template's identifier. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the Azure Resource Manager template. ,
Required: False ,
}
[
{
name:
{
Description: The name of the template parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the template parameter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
armTemplateDisplayName:
{
Description: The display name of the Azure Resource Manager template that produced the environment. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: The identifier of the resource group containing the environment's resources. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The creator of the environment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Environments_Delete (removed)
Description :  Delete environment. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the DtlEnvironment ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Secrets_List (removed)
Description :  List secrets in a given user profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=value)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Secret items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
value:
{
Description: The value of the secret for secret creation. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Secrets_Get (removed)
Description :  Get secret.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Secret ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=value)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
value:
{
Description: The value of the secret for secret creation. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Secrets_CreateOrUpdate (removed)
Description :  Create or replace an existing secret. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Secret ,
Required: True ,
}
string ,
secret:
{
Description: A secret. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
value:
{
Description: The value of the secret for secret creation. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
value:
{
Description: The value of the secret for secret creation. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A secret. ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
value:
{
Description: The value of the secret for secret creation. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Secrets_Update (removed)
Description :  Allows modifying tags of secrets. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Secret ,
Required: True ,
}
string ,
secret:
{
Description: A secret. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
value:
{
Description: The value of the secret for secret creation. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Secrets_Delete (removed)
Description :  Delete secret.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Secret ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabrics_List (removed)
Description :  List service fabrics in a given user profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=applicableSchedule)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ServiceFabric items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
externalServiceFabricId:
{
Description: The backing service fabric resource's id ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource id of the environment under which the service fabric resource is present ,
Required: False ,
}
string ,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabrics_Get (removed)
Description :  Get service fabric.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ServiceFabric ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=applicableSchedule)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
externalServiceFabricId:
{
Description: The backing service fabric resource's id ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource id of the environment under which the service fabric resource is present ,
Required: False ,
}
string ,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabrics_CreateOrUpdate (removed)
Description :  Create or replace an existing service fabric. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ServiceFabric ,
Required: True ,
}
string ,
serviceFabric:
{
Description: A Service Fabric. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
externalServiceFabricId:
{
Description: The backing service fabric resource's id ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource id of the environment under which the service fabric resource is present ,
Required: False ,
}
string ,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
externalServiceFabricId:
{
Description: The backing service fabric resource's id ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource id of the environment under which the service fabric resource is present ,
Required: False ,
}
string ,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A Service Fabric. ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
externalServiceFabricId:
{
Description: The backing service fabric resource's id ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource id of the environment under which the service fabric resource is present ,
Required: False ,
}
string ,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabrics_Update (removed)
Description :  Allows modifying tags of service fabrics. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ServiceFabric ,
Required: True ,
}
string ,
serviceFabric:
{
Description: A Service Fabric. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
externalServiceFabricId:
{
Description: The backing service fabric resource's id ,
Required: False ,
}
string ,
environmentId:
{
Description: The resource id of the environment under which the service fabric resource is present ,
Required: False ,
}
string ,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabrics_Delete (removed)
Description :  Delete service fabric. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ServiceFabric ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabrics_ListApplicableSchedules (removed)
Description :  Lists the applicable start/stop schedules, if any.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{name}/listApplicableSchedules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ServiceFabric ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabricSchedules_List (removed)
Description :  List schedules in a given service fabric.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{serviceFabricName}/schedules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
userName:
{
Description: users ,
Required: True ,
}
string ,
serviceFabricName:
{
Description: servicefabrics ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=status)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Schedule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabricSchedules_Get (removed)
Description :  Get schedule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{serviceFabricName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
userName:
{
Description: users ,
Required: True ,
}
string ,
serviceFabricName:
{
Description: servicefabrics ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=status)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabricSchedules_CreateOrUpdate (removed)
Description :  Create or replace an existing schedule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{serviceFabricName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
userName:
{
Description: users ,
Required: True ,
}
string ,
serviceFabricName:
{
Description: servicefabrics ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
schedule:
{
Description: A schedule. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabricSchedules_Update (removed)
Description :  Allows modifying tags of schedules. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{serviceFabricName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
userName:
{
Description: users ,
Required: True ,
}
string ,
serviceFabricName:
{
Description: servicefabrics ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
schedule:
{
Description: A schedule. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabricSchedules_Delete (removed)
Description :  Delete schedule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{serviceFabricName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
userName:
{
Description: users ,
Required: True ,
}
string ,
serviceFabricName:
{
Description: servicefabrics ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabricSchedules_Execute (removed)
Description :  Execute a schedule. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{serviceFabricName}/schedules/{name}/execute
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
userName:
{
Description: users ,
Required: True ,
}
string ,
serviceFabricName:
{
Description: servicefabrics ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabrics_Start (removed)
Description :  Start a service fabric. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{name}/start
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ServiceFabric ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceFabrics_Stop (removed)
Description :  Stop a service fabric This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{name}/stop
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
userName:
{
Description: The name of the user profile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the ServiceFabric ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_List (removed)
Description :  List virtual machines in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The LabVirtualMachine items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdByUserId:
{
Description: The object identifier of the creator of the virtual machine. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The email address of creator of the virtual machine. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
computeId:
{
Description: The resource identifier (Microsoft.Compute) of the virtual machine. ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
fqdn:
{
Description: The fully-qualified domain name of the virtual machine. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
artifactDeploymentStatus:
{
Description: The artifact deployment status for the virtual machine. ,
Required: False ,
}
{
deploymentStatus:
{
Description: The deployment status of the artifact. ,
Required: False ,
}
string ,
artifactsApplied:
{
Description: The total count of the artifacts that were successfully applied. ,
Format: int32 ,
Required: False ,
}
integer ,
totalArtifacts:
{
Description: The total count of the artifacts that were tentatively applied. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
computeVm:
{
Description: The compute virtual machine properties. ,
Required: False ,
}
{
statuses:
{
Description: Gets the statuses of the virtual machine. ,
Required: False ,
}
[
{
code:
{
Description: Gets the status Code. ,
Required: False ,
}
string ,
displayStatus:
{
Description: Gets the short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: Gets the message associated with the status. ,
Required: False ,
}
string ,
}
,
]
,
osType:
{
Description: Gets the OS type of the virtual machine. ,
Required: False ,
}
string ,
vmSize:
{
Description: Gets the size of the virtual machine. ,
Required: False ,
}
string ,
networkInterfaceId:
{
Description: Gets the network interface ID of the virtual machine. ,
Required: False ,
}
string ,
osDiskId:
{
Description: Gets OS disk blob uri for the virtual machine. ,
Required: False ,
}
string ,
dataDiskIds:
{
Description: Gets data disks blob uri for the virtual machine. ,
Required: False ,
}
[
string ,
]
,
dataDisks:
{
Description: Gets all data disks attached to the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets data disk name. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
diskSizeGiB:
{
Description: Gets data disk size in GiB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
virtualMachineCreationSource:
{
Description: Tells source of creation of lab virtual machine. Output property only. ,
Enum:
{
FromCustomImage: No description available. ,
FromGalleryImage: No description available. ,
FromSharedGalleryImage: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Get (removed)
Description :  Get virtual machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdByUserId:
{
Description: The object identifier of the creator of the virtual machine. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The email address of creator of the virtual machine. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
computeId:
{
Description: The resource identifier (Microsoft.Compute) of the virtual machine. ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
fqdn:
{
Description: The fully-qualified domain name of the virtual machine. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
artifactDeploymentStatus:
{
Description: The artifact deployment status for the virtual machine. ,
Required: False ,
}
{
deploymentStatus:
{
Description: The deployment status of the artifact. ,
Required: False ,
}
string ,
artifactsApplied:
{
Description: The total count of the artifacts that were successfully applied. ,
Format: int32 ,
Required: False ,
}
integer ,
totalArtifacts:
{
Description: The total count of the artifacts that were tentatively applied. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
computeVm:
{
Description: The compute virtual machine properties. ,
Required: False ,
}
{
statuses:
{
Description: Gets the statuses of the virtual machine. ,
Required: False ,
}
[
{
code:
{
Description: Gets the status Code. ,
Required: False ,
}
string ,
displayStatus:
{
Description: Gets the short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: Gets the message associated with the status. ,
Required: False ,
}
string ,
}
,
]
,
osType:
{
Description: Gets the OS type of the virtual machine. ,
Required: False ,
}
string ,
vmSize:
{
Description: Gets the size of the virtual machine. ,
Required: False ,
}
string ,
networkInterfaceId:
{
Description: Gets the network interface ID of the virtual machine. ,
Required: False ,
}
string ,
osDiskId:
{
Description: Gets OS disk blob uri for the virtual machine. ,
Required: False ,
}
string ,
dataDiskIds:
{
Description: Gets data disks blob uri for the virtual machine. ,
Required: False ,
}
[
string ,
]
,
dataDisks:
{
Description: Gets all data disks attached to the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets data disk name. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
diskSizeGiB:
{
Description: Gets data disk size in GiB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
virtualMachineCreationSource:
{
Description: Tells source of creation of lab virtual machine. Output property only. ,
Enum:
{
FromCustomImage: No description available. ,
FromGalleryImage: No description available. ,
FromSharedGalleryImage: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_CreateOrUpdate (removed)
Description :  Create or replace an existing virtual machine. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
labVirtualMachine:
{
Description: A virtual machine. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdByUserId:
{
Description: The object identifier of the creator of the virtual machine. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The email address of creator of the virtual machine. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
computeId:
{
Description: The resource identifier (Microsoft.Compute) of the virtual machine. ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
fqdn:
{
Description: The fully-qualified domain name of the virtual machine. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
artifactDeploymentStatus:
{
Description: The artifact deployment status for the virtual machine. ,
Required: False ,
}
{
deploymentStatus:
{
Description: The deployment status of the artifact. ,
Required: False ,
}
string ,
artifactsApplied:
{
Description: The total count of the artifacts that were successfully applied. ,
Format: int32 ,
Required: False ,
}
integer ,
totalArtifacts:
{
Description: The total count of the artifacts that were tentatively applied. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
computeVm:
{
Description: The compute virtual machine properties. ,
Required: False ,
}
{
statuses:
{
Description: Gets the statuses of the virtual machine. ,
Required: False ,
}
[
{
code:
{
Description: Gets the status Code. ,
Required: False ,
}
string ,
displayStatus:
{
Description: Gets the short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: Gets the message associated with the status. ,
Required: False ,
}
string ,
}
,
]
,
osType:
{
Description: Gets the OS type of the virtual machine. ,
Required: False ,
}
string ,
vmSize:
{
Description: Gets the size of the virtual machine. ,
Required: False ,
}
string ,
networkInterfaceId:
{
Description: Gets the network interface ID of the virtual machine. ,
Required: False ,
}
string ,
osDiskId:
{
Description: Gets OS disk blob uri for the virtual machine. ,
Required: False ,
}
string ,
dataDiskIds:
{
Description: Gets data disks blob uri for the virtual machine. ,
Required: False ,
}
[
string ,
]
,
dataDisks:
{
Description: Gets all data disks attached to the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets data disk name. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
diskSizeGiB:
{
Description: Gets data disk size in GiB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
virtualMachineCreationSource:
{
Description: Tells source of creation of lab virtual machine. Output property only. ,
Enum:
{
FromCustomImage: No description available. ,
FromGalleryImage: No description available. ,
FromSharedGalleryImage: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdByUserId:
{
Description: The object identifier of the creator of the virtual machine. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The email address of creator of the virtual machine. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
computeId:
{
Description: The resource identifier (Microsoft.Compute) of the virtual machine. ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
fqdn:
{
Description: The fully-qualified domain name of the virtual machine. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
artifactDeploymentStatus:
{
Description: The artifact deployment status for the virtual machine. ,
Required: False ,
}
{
deploymentStatus:
{
Description: The deployment status of the artifact. ,
Required: False ,
}
string ,
artifactsApplied:
{
Description: The total count of the artifacts that were successfully applied. ,
Format: int32 ,
Required: False ,
}
integer ,
totalArtifacts:
{
Description: The total count of the artifacts that were tentatively applied. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
computeVm:
{
Description: The compute virtual machine properties. ,
Required: False ,
}
{
statuses:
{
Description: Gets the statuses of the virtual machine. ,
Required: False ,
}
[
{
code:
{
Description: Gets the status Code. ,
Required: False ,
}
string ,
displayStatus:
{
Description: Gets the short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: Gets the message associated with the status. ,
Required: False ,
}
string ,
}
,
]
,
osType:
{
Description: Gets the OS type of the virtual machine. ,
Required: False ,
}
string ,
vmSize:
{
Description: Gets the size of the virtual machine. ,
Required: False ,
}
string ,
networkInterfaceId:
{
Description: Gets the network interface ID of the virtual machine. ,
Required: False ,
}
string ,
osDiskId:
{
Description: Gets OS disk blob uri for the virtual machine. ,
Required: False ,
}
string ,
dataDiskIds:
{
Description: Gets data disks blob uri for the virtual machine. ,
Required: False ,
}
[
string ,
]
,
dataDisks:
{
Description: Gets all data disks attached to the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets data disk name. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
diskSizeGiB:
{
Description: Gets data disk size in GiB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
virtualMachineCreationSource:
{
Description: Tells source of creation of lab virtual machine. Output property only. ,
Enum:
{
FromCustomImage: No description available. ,
FromGalleryImage: No description available. ,
FromSharedGalleryImage: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A virtual machine. ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdByUserId:
{
Description: The object identifier of the creator of the virtual machine. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The email address of creator of the virtual machine. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
computeId:
{
Description: The resource identifier (Microsoft.Compute) of the virtual machine. ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
fqdn:
{
Description: The fully-qualified domain name of the virtual machine. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
artifactDeploymentStatus:
{
Description: The artifact deployment status for the virtual machine. ,
Required: False ,
}
{
deploymentStatus:
{
Description: The deployment status of the artifact. ,
Required: False ,
}
string ,
artifactsApplied:
{
Description: The total count of the artifacts that were successfully applied. ,
Format: int32 ,
Required: False ,
}
integer ,
totalArtifacts:
{
Description: The total count of the artifacts that were tentatively applied. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
computeVm:
{
Description: The compute virtual machine properties. ,
Required: False ,
}
{
statuses:
{
Description: Gets the statuses of the virtual machine. ,
Required: False ,
}
[
{
code:
{
Description: Gets the status Code. ,
Required: False ,
}
string ,
displayStatus:
{
Description: Gets the short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: Gets the message associated with the status. ,
Required: False ,
}
string ,
}
,
]
,
osType:
{
Description: Gets the OS type of the virtual machine. ,
Required: False ,
}
string ,
vmSize:
{
Description: Gets the size of the virtual machine. ,
Required: False ,
}
string ,
networkInterfaceId:
{
Description: Gets the network interface ID of the virtual machine. ,
Required: False ,
}
string ,
osDiskId:
{
Description: Gets OS disk blob uri for the virtual machine. ,
Required: False ,
}
string ,
dataDiskIds:
{
Description: Gets data disks blob uri for the virtual machine. ,
Required: False ,
}
[
string ,
]
,
dataDisks:
{
Description: Gets all data disks attached to the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets data disk name. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
diskSizeGiB:
{
Description: Gets data disk size in GiB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
virtualMachineCreationSource:
{
Description: Tells source of creation of lab virtual machine. Output property only. ,
Enum:
{
FromCustomImage: No description available. ,
FromGalleryImage: No description available. ,
FromSharedGalleryImage: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Update (removed)
Description :  Allows modifying tags of virtual machines. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
labVirtualMachine:
{
Description: A virtual machine. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
notes:
{
Description: The notes of the virtual machine. ,
Required: False ,
}
string ,
ownerObjectId:
{
Description: The object identifier of the owner of the virtual machine. ,
Required: False ,
}
string ,
ownerUserPrincipalName:
{
Description: The user principal name of the virtual machine owner. ,
Required: False ,
}
string ,
createdByUserId:
{
Description: The object identifier of the creator of the virtual machine. ,
Required: False ,
}
string ,
createdByUser:
{
Description: The email address of creator of the virtual machine. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
computeId:
{
Description: The resource identifier (Microsoft.Compute) of the virtual machine. ,
Required: False ,
}
string ,
customImageId:
{
Description: The custom image identifier of the virtual machine. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the virtual machine. ,
Required: False ,
}
string ,
size:
{
Description: The size of the virtual machine. ,
Required: False ,
}
string ,
userName:
{
Description: The user name of the virtual machine. ,
Required: False ,
}
string ,
password:
{
Description: The password of the virtual machine administrator. ,
Required: False ,
}
string ,
sshKey:
{
Description: The SSH key of the virtual machine administrator. ,
Required: False ,
}
string ,
isAuthenticationWithSshKey:
{
Description: Indicates whether this virtual machine uses an SSH key for authentication. ,
Required: False ,
}
boolean ,
fqdn:
{
Description: The fully-qualified domain name of the virtual machine. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The lab subnet name of the virtual machine. ,
Required: False ,
}
string ,
labVirtualNetworkId:
{
Description: The lab virtual network identifier of the virtual machine. ,
Required: False ,
}
string ,
disallowPublicIpAddress:
{
Description: Indicates whether the virtual machine is to be created without a public IP address. ,
Required: False ,
}
boolean ,
artifacts:
{
Description: The artifacts to be installed on the virtual machine. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
artifactDeploymentStatus:
{
Description: The artifact deployment status for the virtual machine. ,
Required: False ,
}
{
deploymentStatus:
{
Description: The deployment status of the artifact. ,
Required: False ,
}
string ,
artifactsApplied:
{
Description: The total count of the artifacts that were successfully applied. ,
Format: int32 ,
Required: False ,
}
integer ,
totalArtifacts:
{
Description: The total count of the artifacts that were tentatively applied. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
galleryImageReference:
{
Description: The Microsoft Azure Marketplace image reference of the virtual machine. ,
Required: False ,
}
{
offer:
{
Description: The offer of the gallery image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the gallery image. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the gallery image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the gallery image. ,
Required: False ,
}
string ,
version:
{
Description: The version of the gallery image. ,
Required: False ,
}
string ,
}
,
planId:
{
Description: The id of the plan associated with the virtual machine image ,
Required: False ,
}
string ,
computeVm:
{
Description: The compute virtual machine properties. ,
Required: False ,
}
{
statuses:
{
Description: Gets the statuses of the virtual machine. ,
Required: False ,
}
[
{
code:
{
Description: Gets the status Code. ,
Required: False ,
}
string ,
displayStatus:
{
Description: Gets the short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: Gets the message associated with the status. ,
Required: False ,
}
string ,
}
,
]
,
osType:
{
Description: Gets the OS type of the virtual machine. ,
Required: False ,
}
string ,
vmSize:
{
Description: Gets the size of the virtual machine. ,
Required: False ,
}
string ,
networkInterfaceId:
{
Description: Gets the network interface ID of the virtual machine. ,
Required: False ,
}
string ,
osDiskId:
{
Description: Gets OS disk blob uri for the virtual machine. ,
Required: False ,
}
string ,
dataDiskIds:
{
Description: Gets data disks blob uri for the virtual machine. ,
Required: False ,
}
[
string ,
]
,
dataDisks:
{
Description: Gets all data disks attached to the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets data disk name. ,
Required: False ,
}
string ,
diskUri:
{
Description: When backed by a blob, the URI of underlying blob. ,
Required: False ,
}
string ,
managedDiskId:
{
Description: When backed by managed disk, this is the ID of the compute disk resource. ,
Required: False ,
}
string ,
diskSizeGiB:
{
Description: Gets data disk size in GiB. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
networkInterface:
{
Description: The network interface properties. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: The resource ID of the virtual network. ,
Required: False ,
}
string ,
subnetId:
{
Description: The resource ID of the sub net. ,
Required: False ,
}
string ,
publicIpAddressId:
{
Description: The resource ID of the public IP address. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: The public IP address. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private IP address. ,
Required: False ,
}
string ,
dnsName:
{
Description: The DNS name. ,
Required: False ,
}
string ,
rdpAuthority:
{
Description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). ,
Required: False ,
}
string ,
sshAuthority:
{
Description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. ,
Required: False ,
}
string ,
sharedPublicIpAddressConfiguration:
{
Description: The configuration for sharing a public IP address across multiple virtual machines. ,
Required: False ,
}
{
inboundNatRules:
{
Description: The incoming NAT rules ,
Required: False ,
}
[
{
transportProtocol:
{
Description: The transport protocol for the endpoint. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
frontendPort:
{
Description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. ,
Format: int32 ,
Required: False ,
}
integer ,
backendPort:
{
Description: The port to which the external traffic will be redirected. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
applicableSchedule:
{
Description: The applicable schedule for the virtual machine. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
expirationDate:
{
Description: The expiration date for VM. ,
Format: date-time ,
Required: False ,
}
string ,
allowClaim:
{
Description: Indicates whether another user can take ownership of the virtual machine ,
Required: False ,
}
boolean ,
storageType:
{
Description: Storage type to use for virtual machine (i.e. Standard, Premium). ,
Required: False ,
}
string ,
virtualMachineCreationSource:
{
Description: Tells source of creation of lab virtual machine. Output property only. ,
Enum:
{
FromCustomImage: No description available. ,
FromGalleryImage: No description available. ,
FromSharedGalleryImage: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: The resource ID of the environment that contains this virtual machine, if any. ,
Required: False ,
}
string ,
dataDiskParameters:
{
Description: New or existing data disks to attach to the virtual machine after creation ,
Required: False ,
}
[
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
scheduleParameters:
{
Description: Virtual Machine schedules to be created ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the schedule. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the virtual machine or environment ,
Required: False ,
}
string ,
location:
{
Description: The location of the new virtual machine or environment ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
lastKnownPowerState:
{
Description: Last known compute power state captured in DTL ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Delete (removed)
Description :  Delete virtual machine. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_AddDataDisk (removed)
Description :  Attach a new or existing data disk to virtual machine. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/addDataDisk
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
dataDiskProperties:
{
Description: Request body for adding a new or existing data disk to a virtual machine. ,
Required: True ,
}
{
attachNewDataDiskOptions:
{
Description: Specifies options to attach a new disk to the virtual machine. ,
Required: False ,
}
{
diskSizeGiB:
{
Description: Size of the disk to be attached in Gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
diskName:
{
Description: The name of the disk to be attached. ,
Required: False ,
}
string ,
diskType:
{
Description: The storage type for the disk (i.e. Standard, Premium). ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
StandardSSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
existingLabDiskId:
{
Description: Specifies the existing lab disk id to attach to virtual machine. ,
Required: False ,
}
string ,
hostCaching:
{
Description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). ,
Enum:
{
None: No description available. ,
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_ApplyArtifacts (removed)
Description :  Apply artifacts to virtual machine. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/applyArtifacts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
applyArtifactsRequest:
{
Description: Request body for applying artifacts to a virtual machine. ,
Required: True ,
}
{
artifacts:
{
Description: The list of artifacts to apply. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
Required: False ,
}
string ,
artifactTitle:
{
Description: The artifact's title. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
[
{
name:
{
Description: The name of the artifact parameter. ,
Required: False ,
}
string ,
value:
{
Description: The value of the artifact parameter. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the artifact. ,
Required: False ,
}
string ,
deploymentStatusMessage:
{
Description: The status message from the deployment. ,
Required: False ,
}
string ,
vmExtensionStatusMessage:
{
Description: The status message from the virtual machine extension. ,
Required: False ,
}
string ,
installTime:
{
Description: The time that the artifact starts to install on the virtual machine. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Claim (removed)
Description :  Take ownership of an existing virtual machine This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/claim
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_DetachDataDisk (removed)
Description :  Detach the specified disk from the virtual machine. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/detachDataDisk
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
detachDataDiskProperties:
{
Description: Request body for detaching data disk from a virtual machine. ,
Required: True ,
}
{
existingLabDiskId:
{
Description: Specifies the disk resource ID to detach from virtual machine. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_GetRdpFileContents (removed)
Description :  Gets a string that represents the contents of the RDP file for the virtual machine
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/getRdpFileContents
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
contents:
{
Description: The contents of the .rdp file ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_ListApplicableSchedules (removed)
Description :  Lists the applicable start/stop schedules, if any.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/listApplicableSchedules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
labVmsShutdown:
{
Description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
labVmsStartup:
{
Description: The auto-startup schedule, if one has been set at the lab or lab resource level. ,
Required: False ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Redeploy (removed)
Description :  Redeploy a virtual machine This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/redeploy
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Resize (removed)
Description :  Resize Virtual Machine. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/resize
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
resizeLabVirtualMachineProperties:
{
Description: Request body for resizing a virtual machine. ,
Required: True ,
}
{
size:
{
Description: Specifies the size of the virtual machine. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Restart (removed)
Description :  Restart a virtual machine. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/restart
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineSchedules_List (removed)
Description :  List schedules in a given virtual machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtualmachines ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=status)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Schedule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineSchedules_Get (removed)
Description :  Get schedule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtualmachines ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=status)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineSchedules_CreateOrUpdate (removed)
Description :  Create or replace an existing schedule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtualmachines ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
schedule:
{
Description: A schedule. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineSchedules_Update (removed)
Description :  Allows modifying tags of schedules. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtualmachines ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
schedule:
{
Description: A schedule. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineSchedules_Delete (removed)
Description :  Delete schedule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtualmachines ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineSchedules_Execute (removed)
Description :  Execute a schedule. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules/{name}/execute
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: labs ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtualmachines ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Start (removed)
Description :  Start a virtual machine. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/start
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Stop (removed)
Description :  Stop a virtual machine This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/stop
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_TransferDisks (removed)
Description :  Transfers all data disks attached to the virtual machine to be owned by the current user. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/transferDisks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_UnClaim (removed)
Description :  Release ownership of an existing virtual machine This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/unClaim
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the LabVirtualMachine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworks_List (removed)
Description :  List virtual networks in a given lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=externalSubnets)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The VirtualNetwork items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name of the subnet as seen in the lab. ,
Required: False ,
}
string ,
allowPublicIp:
{
Description: The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The description of the virtual network. ,
Required: False ,
}
string ,
externalProviderResourceId:
{
Description: The Microsoft.Network resource identifier of the virtual network. ,
Required: False ,
}
string ,
externalSubnets:
{
Description: The external subnet properties. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the identifier. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name. ,
Required: False ,
}
string ,
}
,
]
,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name given to the subnet within the lab. ,
Required: False ,
}
string ,
useInVmCreationPermission:
{
Description: Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
usePublicIpAddressPermission:
{
Description: Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
sharedPublicIpAddressConfiguration:
{
Description: Properties that virtual machines on this subnet will share. ,
Required: False ,
}
{
allowedPorts:
{
Description: Backend ports that virtual machines on this subnet are allowed to expose ,
Required: False ,
}
[
{
transportProtocol:
{
Description: Protocol type of the port. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
backendPort:
{
Description: Backend port of the target virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
virtualNetworkPoolName:
{
Description: The virtual network pool associated with this subnet. ,
Required: False ,
}
string ,
}
,
]
,
createdDate:
{
Description: The creation date of the virtual network. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworks_Get (removed)
Description :  Get virtual network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the VirtualNetwork ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($expand=externalSubnets)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name of the subnet as seen in the lab. ,
Required: False ,
}
string ,
allowPublicIp:
{
Description: The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The description of the virtual network. ,
Required: False ,
}
string ,
externalProviderResourceId:
{
Description: The Microsoft.Network resource identifier of the virtual network. ,
Required: False ,
}
string ,
externalSubnets:
{
Description: The external subnet properties. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the identifier. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name. ,
Required: False ,
}
string ,
}
,
]
,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name given to the subnet within the lab. ,
Required: False ,
}
string ,
useInVmCreationPermission:
{
Description: Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
usePublicIpAddressPermission:
{
Description: Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
sharedPublicIpAddressConfiguration:
{
Description: Properties that virtual machines on this subnet will share. ,
Required: False ,
}
{
allowedPorts:
{
Description: Backend ports that virtual machines on this subnet are allowed to expose ,
Required: False ,
}
[
{
transportProtocol:
{
Description: Protocol type of the port. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
backendPort:
{
Description: Backend port of the target virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
virtualNetworkPoolName:
{
Description: The virtual network pool associated with this subnet. ,
Required: False ,
}
string ,
}
,
]
,
createdDate:
{
Description: The creation date of the virtual network. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworks_CreateOrUpdate (removed)
Description :  Create or replace an existing virtual network. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the VirtualNetwork ,
Required: True ,
}
string ,
virtualNetwork:
{
Description: A virtual network. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name of the subnet as seen in the lab. ,
Required: False ,
}
string ,
allowPublicIp:
{
Description: The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The description of the virtual network. ,
Required: False ,
}
string ,
externalProviderResourceId:
{
Description: The Microsoft.Network resource identifier of the virtual network. ,
Required: False ,
}
string ,
externalSubnets:
{
Description: The external subnet properties. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the identifier. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name. ,
Required: False ,
}
string ,
}
,
]
,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name given to the subnet within the lab. ,
Required: False ,
}
string ,
useInVmCreationPermission:
{
Description: Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
usePublicIpAddressPermission:
{
Description: Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
sharedPublicIpAddressConfiguration:
{
Description: Properties that virtual machines on this subnet will share. ,
Required: False ,
}
{
allowedPorts:
{
Description: Backend ports that virtual machines on this subnet are allowed to expose ,
Required: False ,
}
[
{
transportProtocol:
{
Description: Protocol type of the port. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
backendPort:
{
Description: Backend port of the target virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
virtualNetworkPoolName:
{
Description: The virtual network pool associated with this subnet. ,
Required: False ,
}
string ,
}
,
]
,
createdDate:
{
Description: The creation date of the virtual network. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name of the subnet as seen in the lab. ,
Required: False ,
}
string ,
allowPublicIp:
{
Description: The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The description of the virtual network. ,
Required: False ,
}
string ,
externalProviderResourceId:
{
Description: The Microsoft.Network resource identifier of the virtual network. ,
Required: False ,
}
string ,
externalSubnets:
{
Description: The external subnet properties. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the identifier. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name. ,
Required: False ,
}
string ,
}
,
]
,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name given to the subnet within the lab. ,
Required: False ,
}
string ,
useInVmCreationPermission:
{
Description: Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
usePublicIpAddressPermission:
{
Description: Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
sharedPublicIpAddressConfiguration:
{
Description: Properties that virtual machines on this subnet will share. ,
Required: False ,
}
{
allowedPorts:
{
Description: Backend ports that virtual machines on this subnet are allowed to expose ,
Required: False ,
}
[
{
transportProtocol:
{
Description: Protocol type of the port. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
backendPort:
{
Description: Backend port of the target virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
virtualNetworkPoolName:
{
Description: The virtual network pool associated with this subnet. ,
Required: False ,
}
string ,
}
,
]
,
createdDate:
{
Description: The creation date of the virtual network. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A virtual network. ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name of the subnet as seen in the lab. ,
Required: False ,
}
string ,
allowPublicIp:
{
Description: The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The description of the virtual network. ,
Required: False ,
}
string ,
externalProviderResourceId:
{
Description: The Microsoft.Network resource identifier of the virtual network. ,
Required: False ,
}
string ,
externalSubnets:
{
Description: The external subnet properties. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the identifier. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name. ,
Required: False ,
}
string ,
}
,
]
,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name given to the subnet within the lab. ,
Required: False ,
}
string ,
useInVmCreationPermission:
{
Description: Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
usePublicIpAddressPermission:
{
Description: Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
sharedPublicIpAddressConfiguration:
{
Description: Properties that virtual machines on this subnet will share. ,
Required: False ,
}
{
allowedPorts:
{
Description: Backend ports that virtual machines on this subnet are allowed to expose ,
Required: False ,
}
[
{
transportProtocol:
{
Description: Protocol type of the port. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
backendPort:
{
Description: Backend port of the target virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
virtualNetworkPoolName:
{
Description: The virtual network pool associated with this subnet. ,
Required: False ,
}
string ,
}
,
]
,
createdDate:
{
Description: The creation date of the virtual network. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworks_Update (removed)
Description :  Allows modifying tags of virtual networks. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the VirtualNetwork ,
Required: True ,
}
string ,
virtualNetwork:
{
Description: A virtual network. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name of the subnet as seen in the lab. ,
Required: False ,
}
string ,
allowPublicIp:
{
Description: The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The description of the virtual network. ,
Required: False ,
}
string ,
externalProviderResourceId:
{
Description: The Microsoft.Network resource identifier of the virtual network. ,
Required: False ,
}
string ,
externalSubnets:
{
Description: The external subnet properties. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the identifier. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name. ,
Required: False ,
}
string ,
}
,
]
,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the subnet. ,
Required: False ,
}
string ,
labSubnetName:
{
Description: The name given to the subnet within the lab. ,
Required: False ,
}
string ,
useInVmCreationPermission:
{
Description: Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
usePublicIpAddressPermission:
{
Description: Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny). ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
sharedPublicIpAddressConfiguration:
{
Description: Properties that virtual machines on this subnet will share. ,
Required: False ,
}
{
allowedPorts:
{
Description: Backend ports that virtual machines on this subnet are allowed to expose ,
Required: False ,
}
[
{
transportProtocol:
{
Description: Protocol type of the port. ,
Enum:
{
Tcp: No description available. ,
Udp: No description available. ,
}
,
Required: False ,
}
enum ,
backendPort:
{
Description: Backend port of the target virtual machine. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
virtualNetworkPoolName:
{
Description: The virtual network pool associated with this subnet. ,
Required: False ,
}
string ,
}
,
]
,
createdDate:
{
Description: The creation date of the virtual network. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworks_Delete (removed)
Description :  Delete virtual network. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the VirtualNetwork ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchedules_ListByResourceGroup (removed)
Description :  List schedules in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=status)' ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply to the operation. Example: '$filter=contains(name,'myName') ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of resources to return from the operation. Example: '$top=10' ,
Format: int32 ,
Required: False ,
}
integer ,
$orderby:
{
Description: The ordering expression for the results, using OData notation. Example: '$orderby=name desc' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Schedule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchedules_Get (removed)
Description :  Get schedule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
$expand:
{
Description: Specify the $expand query. Example: 'properties($select=status)' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchedules_CreateOrUpdate (removed)
Description :  Create or replace an existing schedule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
schedule:
{
Description: A schedule. ,
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchedules_Update (removed)
Description :  Allows modifying tags of schedules. All other properties will be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
schedule:
{
Description: A schedule. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: True ,
}
{
status:
{
Description: The status of the schedule (i.e. Enabled, Disabled) ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). ,
Required: False ,
}
string ,
weeklyRecurrence:
{
Description: If the schedule will occur only some days of the week, specify the weekly recurrence. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day the schedule will occur. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: If the schedule will occur once each day of the week, specify the daily recurrence. ,
Required: False ,
}
{
time:
{
Description: The time of day the schedule will occur. ,
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: If the schedule will occur multiple times a day, specify the hourly recurrence. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) ,
Required: False ,
}
string ,
notificationSettings:
{
Description: Notification settings. ,
Required: False ,
}
{
status:
{
Description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
timeInMinutes:
{
Description: Time in minutes before event at which notification will be sent. ,
Format: int32 ,
Required: False ,
}
integer ,
webhookUrl:
{
Description: The webhook URL to which the notification will be sent. ,
Required: False ,
}
string ,
emailRecipient:
{
Description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). ,
Required: False ,
}
string ,
notificationLocale:
{
Description: The locale to use when sending a notification (fallback for unsupported languages is EN). ,
Required: False ,
}
string ,
}
,
createdDate:
{
Description: The creation date of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource ID to which the schedule belongs ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
uniqueIdentifier:
{
Description: The unique immutable identifier of a resource (Guid). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchedules_Delete (removed)
Description :  Delete schedule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchedules_Execute (removed)
Description :  Execute a schedule. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}/execute
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalSchedules_Retarget (removed)
Description :  Updates a schedule's target resource Id. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}/retarget
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
name:
{
Description: The name of the Schedule ,
Required: True ,
}
string ,
retargetScheduleProperties:
{
Description: Properties for retargeting a virtual machine schedule. ,
Required: True ,
}
{
currentResourceId:
{
Description: The resource Id of the virtual machine on which the schedule operates ,
Required: False ,
}
string ,
targetResourceId:
{
Description: The resource Id of the virtual machine that the schedule should be retargeted to ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}