Microsoft.DevTestLab (preview:2015-05-21)

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

Lab_ListBySubscription (new)
Description :  List labs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/labs
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The artifact storage account of the lab. ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts of the lab. ,
Required: False ,
}
[
string ,
]
,
vaultName:
{
Description: The name of the key vault of the lab. ,
Required: False ,
}
string ,
labStorageType:
{
Description: The type of the lab storage. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
defaultVirtualNetworkId:
{
Description: The default virtual network identifier of the lab. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Lab_ListByResourceGroup (new)
Description :  List labs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The artifact storage account of the lab. ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts of the lab. ,
Required: False ,
}
[
string ,
]
,
vaultName:
{
Description: The name of the key vault of the lab. ,
Required: False ,
}
string ,
labStorageType:
{
Description: The type of the lab storage. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
defaultVirtualNetworkId:
{
Description: The default virtual network identifier of the lab. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
ArtifactSource_List (new)
Description :  List artifact sources.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the artifact source. ,
Required: False ,
}
string ,
uri:
{
Description: The URI of the artifact source. ,
Required: False ,
}
string ,
sourceType:
{
Description: The type of the artifact source. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder path of the artifact source. ,
Required: False ,
}
string ,
branchRef:
{
Description: The branch reference of the artifact source. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token of the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: The status of the artifact source. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Artifact_List (new)
Description :  List artifacts.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
artifactSourceName:
{
Description: The name of the artifact source. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
title:
{
Description: The title of the artifact. ,
Required: False ,
}
string ,
description:
{
Description: The description of the artifact. ,
Required: False ,
}
string ,
filePath:
{
Description: The file path of the artifact. ,
Required: False ,
}
string ,
icon:
{
Description: The icon of the artifact. ,
Required: False ,
}
string ,
targetOsType:
{
Description: Gets or sets the type of the target os. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Artifact_GetResource (new)
Description :  Get artifact.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
title:
{
Description: The title of the artifact. ,
Required: False ,
}
string ,
description:
{
Description: The description of the artifact. ,
Required: False ,
}
string ,
filePath:
{
Description: The file path of the artifact. ,
Required: False ,
}
string ,
icon:
{
Description: The icon of the artifact. ,
Required: False ,
}
string ,
targetOsType:
{
Description: Gets or sets the type of the target os. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Artifact_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
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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:
{
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:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
location:
{
Description: The location of the virtual machine. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ 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:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
ArtifactSource_GetResource (new)
Description :  Get artifact source.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the artifact source. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the artifact source. ,
Required: False ,
}
string ,
uri:
{
Description: The URI of the artifact source. ,
Required: False ,
}
string ,
sourceType:
{
Description: The type of the artifact source. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder path of the artifact source. ,
Required: False ,
}
string ,
branchRef:
{
Description: The branch reference of the artifact source. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token of the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: The status of the artifact source. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
ArtifactSource_CreateOrUpdateResource (new)
Description :  Create or replace an existing artifact source.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the artifact source. ,
Required: True ,
}
string ,
artifactSource:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the artifact source. ,
Required: False ,
}
string ,
uri:
{
Description: The URI of the artifact source. ,
Required: False ,
}
string ,
sourceType:
{
Description: The type of the artifact source. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder path of the artifact source. ,
Required: False ,
}
string ,
branchRef:
{
Description: The branch reference of the artifact source. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token of the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: The status of the artifact source. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the artifact source. ,
Required: False ,
}
string ,
uri:
{
Description: The URI of the artifact source. ,
Required: False ,
}
string ,
sourceType:
{
Description: The type of the artifact source. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder path of the artifact source. ,
Required: False ,
}
string ,
branchRef:
{
Description: The branch reference of the artifact source. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token of the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: The status of the artifact source. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the artifact source. ,
Required: False ,
}
string ,
uri:
{
Description: The URI of the artifact source. ,
Required: False ,
}
string ,
sourceType:
{
Description: The type of the artifact source. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder path of the artifact source. ,
Required: False ,
}
string ,
branchRef:
{
Description: The branch reference of the artifact source. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token of the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: The status of the artifact source. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
ArtifactSource_DeleteResource (new)
Description :  Delete artifact source.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the artifact source. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
ArtifactSource_PatchResource (new)
Description :  Modify properties of artifact sources.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the artifact source. ,
Required: True ,
}
string ,
artifactSource:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the artifact source. ,
Required: False ,
}
string ,
uri:
{
Description: The URI of the artifact source. ,
Required: False ,
}
string ,
sourceType:
{
Description: The type of the artifact source. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder path of the artifact source. ,
Required: False ,
}
string ,
branchRef:
{
Description: The branch reference of the artifact source. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token of the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: The status of the artifact source. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the artifact source. ,
Required: False ,
}
string ,
uri:
{
Description: The URI of the artifact source. ,
Required: False ,
}
string ,
sourceType:
{
Description: The type of the artifact source. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder path of the artifact source. ,
Required: False ,
}
string ,
branchRef:
{
Description: The branch reference of the artifact source. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token of the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: The status of the artifact source. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
CostInsight_List (new)
Description :  List cost insights.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/costinsights
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
currencyCode:
{
Required: False ,
}
string ,
vmCosts:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
cost:
{
Format: double ,
Required: False ,
}
number ,
}
,
]
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
CostInsight_GetResource (new)
Description :  Get cost insight.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/costinsights/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the cost insight. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
currencyCode:
{
Required: False ,
}
string ,
vmCosts:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
cost:
{
Format: double ,
Required: False ,
}
number ,
}
,
]
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
CostInsight_RefreshData (new)
Description :  Refresh Lab's Cost Insight Data. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/costinsights/{name}/refreshData
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the cost insight. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Cost_List (new)
Description :  List costs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/costs
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
currencyCode:
{
Description: The currency code of the cost. ,
Required: False ,
}
string ,
costs:
{
Description: The per-day costs items of the cost. ,
Required: False ,
}
[
{
date:
{
Description: The date of the cost item. ,
Format: date-time ,
Required: False ,
}
string ,
cost:
{
Description: The cost 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 ,
}
,
]
,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Cost_GetResource (new)
Description :  Get cost.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/costs/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the cost. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
currencyCode:
{
Description: The currency code of the cost. ,
Required: False ,
}
string ,
costs:
{
Description: The per-day costs items of the cost. ,
Required: False ,
}
[
{
date:
{
Description: The date of the cost item. ,
Format: date-time ,
Required: False ,
}
string ,
cost:
{
Description: The cost 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 ,
}
,
]
,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Cost_RefreshData (new)
Description :  Refresh Lab's Cost Data. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/costs/{name}/refreshData
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the cost. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
CustomImage_List (new)
Description :  List custom images.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
vm:
{
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS. ,
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. ,
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 ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the custom image. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
CustomImage_GetResource (new)
Description :  Get custom image.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the custom image. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
vm:
{
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS. ,
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. ,
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 ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the custom image. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
CustomImage_CreateOrUpdateResource (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}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the custom image. ,
Required: True ,
}
string ,
customImage:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
vm:
{
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS. ,
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. ,
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 ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the custom image. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
vm:
{
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS. ,
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. ,
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 ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the custom image. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
vm:
{
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS. ,
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. ,
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 ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the custom image. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
CustomImage_DeleteResource (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}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the custom image. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Formula_List (new)
Description :  List formulas.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
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 ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Formula_GetResource (new)
Description :  Get formula.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the formula. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
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 ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Formula_CreateOrUpdateResource (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}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the formula. ,
Required: True ,
}
string ,
formula:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
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 ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
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 ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
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 ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Formula_DeleteResource (new)
Description :  Delete formula.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the formula. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
GalleryImage_List (new)
Description :  List gallery images.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/galleryimages
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
PolicySet_EvaluatePolicies (new)
Description :  Evaluates Lab Policy.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{name}/evaluatePolicies
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the policy set. ,
Required: True ,
}
string ,
evaluatePoliciesRequest:
{
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 ,
}
,
]
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
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:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Policy_List (new)
Description :  List policies.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
policySetName:
{
Description: The name of the policy set. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
LabVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy. ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy. ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Policy_GetResource (new)
Description :  Get policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
policySetName:
{
Description: The name of the policy set. ,
Required: True ,
}
string ,
name:
{
Description: The name of the policy. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
LabVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy. ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy. ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Policy_CreateOrUpdateResource (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}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
policySetName:
{
Description: The name of the policy set. ,
Required: True ,
}
string ,
name:
{
Description: The name of the policy. ,
Required: True ,
}
string ,
policy:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
LabVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy. ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy. ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
LabVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy. ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy. ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
LabVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy. ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy. ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Policy_DeleteResource (new)
Description :  Delete policy.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
policySetName:
{
Description: The name of the policy set. ,
Required: True ,
}
string ,
name:
{
Description: The name of the policy. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Policy_PatchResource (new)
Description :  Modify properties of policies.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
policySetName:
{
Description: The name of the policy set. ,
Required: True ,
}
string ,
name:
{
Description: The name of the policy. ,
Required: True ,
}
string ,
policy:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
LabVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy. ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy. ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
LabVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy. ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy. ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Schedule_List (new)
Description :  List schedules.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule. ,
Enum:
{
LabVmsShutdownTask: No description available. ,
LabVmsStartupTask: No description available. ,
LabBillingTask: No description available. ,
}
,
Required: False ,
}
enum ,
weeklyRecurrence:
{
Description: The weekly recurrence of the schedule. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: The daily recurrence of the schedule. ,
Required: False ,
}
{
time:
{
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: The hourly recurrence of the schedule. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Schedule_GetResource (new)
Description :  Get schedule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the schedule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule. ,
Enum:
{
LabVmsShutdownTask: No description available. ,
LabVmsStartupTask: No description available. ,
LabBillingTask: No description available. ,
}
,
Required: False ,
}
enum ,
weeklyRecurrence:
{
Description: The weekly recurrence of the schedule. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: The daily recurrence of the schedule. ,
Required: False ,
}
{
time:
{
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: The hourly recurrence of the schedule. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Schedule_CreateOrUpdateResource (new)
Description :  Create or replace an existing schedule. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the schedule. ,
Required: True ,
}
string ,
schedule:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule. ,
Enum:
{
LabVmsShutdownTask: No description available. ,
LabVmsStartupTask: No description available. ,
LabBillingTask: No description available. ,
}
,
Required: False ,
}
enum ,
weeklyRecurrence:
{
Description: The weekly recurrence of the schedule. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: The daily recurrence of the schedule. ,
Required: False ,
}
{
time:
{
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: The hourly recurrence of the schedule. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule. ,
Enum:
{
LabVmsShutdownTask: No description available. ,
LabVmsStartupTask: No description available. ,
LabBillingTask: No description available. ,
}
,
Required: False ,
}
enum ,
weeklyRecurrence:
{
Description: The weekly recurrence of the schedule. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: The daily recurrence of the schedule. ,
Required: False ,
}
{
time:
{
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: The hourly recurrence of the schedule. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule. ,
Enum:
{
LabVmsShutdownTask: No description available. ,
LabVmsStartupTask: No description available. ,
LabBillingTask: No description available. ,
}
,
Required: False ,
}
enum ,
weeklyRecurrence:
{
Description: The weekly recurrence of the schedule. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: The daily recurrence of the schedule. ,
Required: False ,
}
{
time:
{
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: The hourly recurrence of the schedule. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Schedule_DeleteResource (new)
Description :  Delete schedule. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the schedule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Schedule_PatchResource (new)
Description :  Modify properties of schedules.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the schedule. ,
Required: True ,
}
string ,
schedule:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule. ,
Enum:
{
LabVmsShutdownTask: No description available. ,
LabVmsStartupTask: No description available. ,
LabBillingTask: No description available. ,
}
,
Required: False ,
}
enum ,
weeklyRecurrence:
{
Description: The weekly recurrence of the schedule. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: The daily recurrence of the schedule. ,
Required: False ,
}
{
time:
{
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: The hourly recurrence of the schedule. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule. ,
Enum:
{
LabVmsShutdownTask: No description available. ,
LabVmsStartupTask: No description available. ,
LabBillingTask: No description available. ,
}
,
Required: False ,
}
enum ,
weeklyRecurrence:
{
Description: The weekly recurrence of the schedule. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: The daily recurrence of the schedule. ,
Required: False ,
}
{
time:
{
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: The hourly recurrence of the schedule. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Schedule_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
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the schedule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualMachine_List (new)
Description :  List virtual machines.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualMachine_GetResource (new)
Description :  Get virtual machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual Machine. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualMachine_CreateOrUpdateResource (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}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual Machine. ,
Required: True ,
}
string ,
labVirtualMachine:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualMachine_DeleteResource (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}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual Machine. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualMachine_PatchResource (new)
Description :  Modify properties of virtual machines.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual Machine. ,
Required: True ,
}
string ,
labVirtualMachine:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualMachine_ApplyArtifacts (new)
Description :  Apply artifacts to Lab VM. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/applyArtifacts
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual Machine. ,
Required: True ,
}
string ,
applyArtifactsRequest:
{
Required: True ,
}
{
artifacts:
{
Description: The list of artifacts to apply. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
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 ,
}
,
]
,
}
,
]
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualMachine_Start (new)
Description :  Start a Lab VM. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/start
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual Machine. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualMachine_Stop (new)
Description :  Stop a Lab VM. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/stop
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual Machine. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualNetwork_List (new)
Description :  List virtual networks.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Required: False ,
}
string ,
labSubnetName:
{
Required: False ,
}
string ,
allowPublicIp:
{
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 ,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource identifier 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. ,
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. ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualNetwork_GetResource (new)
Description :  Get virtual network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual network. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Required: False ,
}
string ,
labSubnetName:
{
Required: False ,
}
string ,
allowPublicIp:
{
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 ,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource identifier 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. ,
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. ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualNetwork_CreateOrUpdateResource (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}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual network. ,
Required: True ,
}
string ,
virtualNetwork:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Required: False ,
}
string ,
labSubnetName:
{
Required: False ,
}
string ,
allowPublicIp:
{
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 ,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource identifier 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. ,
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. ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Required: False ,
}
string ,
labSubnetName:
{
Required: False ,
}
string ,
allowPublicIp:
{
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 ,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource identifier 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. ,
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. ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Required: False ,
}
string ,
labSubnetName:
{
Required: False ,
}
string ,
allowPublicIp:
{
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 ,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource identifier 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. ,
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. ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualNetwork_DeleteResource (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}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual network. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualNetwork_PatchResource (new)
Description :  Modify properties of virtual networks.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual network. ,
Required: True ,
}
string ,
virtualNetwork:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Required: False ,
}
string ,
labSubnetName:
{
Required: False ,
}
string ,
allowPublicIp:
{
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 ,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource identifier 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. ,
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. ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Required: False ,
}
string ,
labSubnetName:
{
Required: False ,
}
string ,
allowPublicIp:
{
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 ,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource identifier 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. ,
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. ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Lab_GetResource (new)
Description :  Get lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The artifact storage account of the lab. ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts of the lab. ,
Required: False ,
}
[
string ,
]
,
vaultName:
{
Description: The name of the key vault of the lab. ,
Required: False ,
}
string ,
labStorageType:
{
Description: The type of the lab storage. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
defaultVirtualNetworkId:
{
Description: The default virtual network identifier of the lab. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Lab_CreateOrUpdateResource (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}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
lab:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The artifact storage account of the lab. ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts of the lab. ,
Required: False ,
}
[
string ,
]
,
vaultName:
{
Description: The name of the key vault of the lab. ,
Required: False ,
}
string ,
labStorageType:
{
Description: The type of the lab storage. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
defaultVirtualNetworkId:
{
Description: The default virtual network identifier of the lab. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The artifact storage account of the lab. ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts of the lab. ,
Required: False ,
}
[
string ,
]
,
vaultName:
{
Description: The name of the key vault of the lab. ,
Required: False ,
}
string ,
labStorageType:
{
Description: The type of the lab storage. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
defaultVirtualNetworkId:
{
Description: The default virtual network identifier of the lab. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The artifact storage account of the lab. ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts of the lab. ,
Required: False ,
}
[
string ,
]
,
vaultName:
{
Description: The name of the key vault of the lab. ,
Required: False ,
}
string ,
labStorageType:
{
Description: The type of the lab storage. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
defaultVirtualNetworkId:
{
Description: The default virtual network identifier of the lab. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Lab_DeleteResource (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}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Lab_PatchResource (new)
Description :  Modify properties of labs.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
lab:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The artifact storage account of the lab. ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts of the lab. ,
Required: False ,
}
[
string ,
]
,
vaultName:
{
Description: The name of the key vault of the lab. ,
Required: False ,
}
string ,
labStorageType:
{
Description: The type of the lab storage. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
defaultVirtualNetworkId:
{
Description: The default virtual network identifier of the lab. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The artifact storage account of the lab. ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts of the lab. ,
Required: False ,
}
[
string ,
]
,
vaultName:
{
Description: The name of the key vault of the lab. ,
Required: False ,
}
string ,
labStorageType:
{
Description: The type of the lab storage. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
defaultVirtualNetworkId:
{
Description: The default virtual network identifier of the lab. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Lab_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
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
labVirtualMachine:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Lab_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
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
generateUploadUriParameter:
{
Required: True ,
}
{
blobName:
{
Description: The blob name of the upload URI. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Lab_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
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
id:
{
Description: The absolute URI of the VHD. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Lab_ListBySubscription (removed)
Description :  List labs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/labs
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The artifact storage account of the lab. ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts of the lab. ,
Required: False ,
}
[
string ,
]
,
vaultName:
{
Description: The name of the key vault of the lab. ,
Required: False ,
}
string ,
labStorageType:
{
Description: The type of the lab storage. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
defaultVirtualNetworkId:
{
Description: The default virtual network identifier of the lab. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Lab_ListByResourceGroup (removed)
Description :  List labs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The artifact storage account of the lab. ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts of the lab. ,
Required: False ,
}
[
string ,
]
,
vaultName:
{
Description: The name of the key vault of the lab. ,
Required: False ,
}
string ,
labStorageType:
{
Description: The type of the lab storage. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
defaultVirtualNetworkId:
{
Description: The default virtual network identifier of the lab. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
ArtifactSource_List (removed)
Description :  List artifact sources.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the artifact source. ,
Required: False ,
}
string ,
uri:
{
Description: The URI of the artifact source. ,
Required: False ,
}
string ,
sourceType:
{
Description: The type of the artifact source. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder path of the artifact source. ,
Required: False ,
}
string ,
branchRef:
{
Description: The branch reference of the artifact source. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token of the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: The status of the artifact source. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Artifact_List (removed)
Description :  List artifacts.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
artifactSourceName:
{
Description: The name of the artifact source. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
title:
{
Description: The title of the artifact. ,
Required: False ,
}
string ,
description:
{
Description: The description of the artifact. ,
Required: False ,
}
string ,
filePath:
{
Description: The file path of the artifact. ,
Required: False ,
}
string ,
icon:
{
Description: The icon of the artifact. ,
Required: False ,
}
string ,
targetOsType:
{
Description: Gets or sets the type of the target os. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Artifact_GetResource (removed)
Description :  Get artifact.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
title:
{
Description: The title of the artifact. ,
Required: False ,
}
string ,
description:
{
Description: The description of the artifact. ,
Required: False ,
}
string ,
filePath:
{
Description: The file path of the artifact. ,
Required: False ,
}
string ,
icon:
{
Description: The icon of the artifact. ,
Required: False ,
}
string ,
targetOsType:
{
Description: Gets or sets the type of the target os. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters of the artifact. ,
Required: False ,
}
object ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Artifact_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
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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:
{
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:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
location:
{
Description: The location of the virtual machine. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ 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:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
ArtifactSource_GetResource (removed)
Description :  Get artifact source.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the artifact source. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the artifact source. ,
Required: False ,
}
string ,
uri:
{
Description: The URI of the artifact source. ,
Required: False ,
}
string ,
sourceType:
{
Description: The type of the artifact source. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder path of the artifact source. ,
Required: False ,
}
string ,
branchRef:
{
Description: The branch reference of the artifact source. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token of the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: The status of the artifact source. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
ArtifactSource_CreateOrUpdateResource (removed)
Description :  Create or replace an existing artifact source.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the artifact source. ,
Required: True ,
}
string ,
artifactSource:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the artifact source. ,
Required: False ,
}
string ,
uri:
{
Description: The URI of the artifact source. ,
Required: False ,
}
string ,
sourceType:
{
Description: The type of the artifact source. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder path of the artifact source. ,
Required: False ,
}
string ,
branchRef:
{
Description: The branch reference of the artifact source. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token of the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: The status of the artifact source. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the artifact source. ,
Required: False ,
}
string ,
uri:
{
Description: The URI of the artifact source. ,
Required: False ,
}
string ,
sourceType:
{
Description: The type of the artifact source. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder path of the artifact source. ,
Required: False ,
}
string ,
branchRef:
{
Description: The branch reference of the artifact source. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token of the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: The status of the artifact source. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the artifact source. ,
Required: False ,
}
string ,
uri:
{
Description: The URI of the artifact source. ,
Required: False ,
}
string ,
sourceType:
{
Description: The type of the artifact source. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder path of the artifact source. ,
Required: False ,
}
string ,
branchRef:
{
Description: The branch reference of the artifact source. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token of the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: The status of the artifact source. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
ArtifactSource_DeleteResource (removed)
Description :  Delete artifact source.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the artifact source. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
ArtifactSource_PatchResource (removed)
Description :  Modify properties of artifact sources.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the artifact source. ,
Required: True ,
}
string ,
artifactSource:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the artifact source. ,
Required: False ,
}
string ,
uri:
{
Description: The URI of the artifact source. ,
Required: False ,
}
string ,
sourceType:
{
Description: The type of the artifact source. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder path of the artifact source. ,
Required: False ,
}
string ,
branchRef:
{
Description: The branch reference of the artifact source. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token of the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: The status of the artifact source. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the artifact source. ,
Required: False ,
}
string ,
uri:
{
Description: The URI of the artifact source. ,
Required: False ,
}
string ,
sourceType:
{
Description: The type of the artifact source. ,
Enum:
{
VsoGit: No description available. ,
GitHub: No description available. ,
}
,
Required: False ,
}
enum ,
folderPath:
{
Description: The folder path of the artifact source. ,
Required: False ,
}
string ,
branchRef:
{
Description: The branch reference of the artifact source. ,
Required: False ,
}
string ,
securityToken:
{
Description: The security token of the artifact source. ,
Required: False ,
}
string ,
status:
{
Description: The status of the artifact source. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
CostInsight_List (removed)
Description :  List cost insights.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/costinsights
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
currencyCode:
{
Required: False ,
}
string ,
vmCosts:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
cost:
{
Format: double ,
Required: False ,
}
number ,
}
,
]
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
CostInsight_GetResource (removed)
Description :  Get cost insight.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/costinsights/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the cost insight. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
currencyCode:
{
Required: False ,
}
string ,
vmCosts:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
resourceGroupName:
{
Required: False ,
}
string ,
cost:
{
Format: double ,
Required: False ,
}
number ,
}
,
]
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
CostInsight_RefreshData (removed)
Description :  Refresh Lab's Cost Insight Data. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/costinsights/{name}/refreshData
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the cost insight. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Cost_List (removed)
Description :  List costs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/costs
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
currencyCode:
{
Description: The currency code of the cost. ,
Required: False ,
}
string ,
costs:
{
Description: The per-day costs items of the cost. ,
Required: False ,
}
[
{
date:
{
Description: The date of the cost item. ,
Format: date-time ,
Required: False ,
}
string ,
cost:
{
Description: The cost 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 ,
}
,
]
,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Cost_GetResource (removed)
Description :  Get cost.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/costs/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the cost. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
currencyCode:
{
Description: The currency code of the cost. ,
Required: False ,
}
string ,
costs:
{
Description: The per-day costs items of the cost. ,
Required: False ,
}
[
{
date:
{
Description: The date of the cost item. ,
Format: date-time ,
Required: False ,
}
string ,
cost:
{
Description: The cost 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 ,
}
,
]
,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Cost_RefreshData (removed)
Description :  Refresh Lab's Cost Data. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/costs/{name}/refreshData
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the cost. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
CustomImage_List (removed)
Description :  List custom images.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
vm:
{
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS. ,
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. ,
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 ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the custom image. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
CustomImage_GetResource (removed)
Description :  Get custom image.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the custom image. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
vm:
{
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS. ,
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. ,
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 ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the custom image. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
CustomImage_CreateOrUpdateResource (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}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the custom image. ,
Required: True ,
}
string ,
customImage:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
vm:
{
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS. ,
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. ,
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 ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the custom image. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
vm:
{
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS. ,
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. ,
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 ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the custom image. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
vm:
{
Required: False ,
}
{
sourceVmId:
{
Description: The source vm identifier. ,
Required: False ,
}
string ,
sysPrep:
{
Description: Indicates whether sysprep has been run on the VHD. ,
Required: False ,
}
boolean ,
windowsOsInfo:
{
Description: The Windows OS information of the VM. ,
Required: False ,
}
{
windowsOsState:
{
Description: The state of the Windows OS. ,
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. ,
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 ,
}
,
description:
{
Description: The description of the custom image. ,
Required: False ,
}
string ,
osType:
{
Description: The OS type of the custom image. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
CustomImage_DeleteResource (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}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the custom image. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Formula_List (removed)
Description :  List formulas.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
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 ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Formula_GetResource (removed)
Description :  Get formula.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the formula. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
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 ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Formula_CreateOrUpdateResource (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}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the formula. ,
Required: True ,
}
string ,
formula:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
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 ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
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 ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
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 ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Formula_DeleteResource (removed)
Description :  Delete formula.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the formula. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
GalleryImage_List (removed)
Description :  List gallery images.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/galleryimages
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
PolicySet_EvaluatePolicies (removed)
Description :  Evaluates Lab Policy.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{name}/evaluatePolicies
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the policy set. ,
Required: True ,
}
string ,
evaluatePoliciesRequest:
{
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 ,
}
,
]
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
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:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Policy_List (removed)
Description :  List policies.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
policySetName:
{
Description: The name of the policy set. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
LabVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy. ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy. ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Policy_GetResource (removed)
Description :  Get policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
policySetName:
{
Description: The name of the policy set. ,
Required: True ,
}
string ,
name:
{
Description: The name of the policy. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
LabVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy. ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy. ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Policy_CreateOrUpdateResource (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}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
policySetName:
{
Description: The name of the policy set. ,
Required: True ,
}
string ,
name:
{
Description: The name of the policy. ,
Required: True ,
}
string ,
policy:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
LabVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy. ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy. ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
LabVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy. ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy. ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
LabVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy. ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy. ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Policy_DeleteResource (removed)
Description :  Delete policy.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
policySetName:
{
Description: The name of the policy set. ,
Required: True ,
}
string ,
name:
{
Description: The name of the policy. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Policy_PatchResource (removed)
Description :  Modify properties of policies.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
policySetName:
{
Description: The name of the policy set. ,
Required: True ,
}
string ,
name:
{
Description: The name of the policy. ,
Required: True ,
}
string ,
policy:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
LabVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy. ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy. ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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. ,
Enum:
{
UserOwnedLabVmCount: No description available. ,
LabVmCount: No description available. ,
LabVmSize: No description available. ,
GalleryImage: No description available. ,
UserOwnedLabVmCountInSubnet: No description available. ,
}
,
Required: False ,
}
enum ,
factData:
{
Description: The fact data of the policy. ,
Required: False ,
}
string ,
threshold:
{
Description: The threshold of the policy. ,
Required: False ,
}
string ,
evaluatorType:
{
Description: The evaluator type of the policy. ,
Enum:
{
AllowedValuesPolicy: No description available. ,
MaxValuePolicy: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Schedule_List (removed)
Description :  List schedules.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule. ,
Enum:
{
LabVmsShutdownTask: No description available. ,
LabVmsStartupTask: No description available. ,
LabBillingTask: No description available. ,
}
,
Required: False ,
}
enum ,
weeklyRecurrence:
{
Description: The weekly recurrence of the schedule. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: The daily recurrence of the schedule. ,
Required: False ,
}
{
time:
{
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: The hourly recurrence of the schedule. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Schedule_GetResource (removed)
Description :  Get schedule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the schedule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule. ,
Enum:
{
LabVmsShutdownTask: No description available. ,
LabVmsStartupTask: No description available. ,
LabBillingTask: No description available. ,
}
,
Required: False ,
}
enum ,
weeklyRecurrence:
{
Description: The weekly recurrence of the schedule. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: The daily recurrence of the schedule. ,
Required: False ,
}
{
time:
{
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: The hourly recurrence of the schedule. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Schedule_CreateOrUpdateResource (removed)
Description :  Create or replace an existing schedule. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the schedule. ,
Required: True ,
}
string ,
schedule:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule. ,
Enum:
{
LabVmsShutdownTask: No description available. ,
LabVmsStartupTask: No description available. ,
LabBillingTask: No description available. ,
}
,
Required: False ,
}
enum ,
weeklyRecurrence:
{
Description: The weekly recurrence of the schedule. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: The daily recurrence of the schedule. ,
Required: False ,
}
{
time:
{
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: The hourly recurrence of the schedule. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule. ,
Enum:
{
LabVmsShutdownTask: No description available. ,
LabVmsStartupTask: No description available. ,
LabBillingTask: No description available. ,
}
,
Required: False ,
}
enum ,
weeklyRecurrence:
{
Description: The weekly recurrence of the schedule. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: The daily recurrence of the schedule. ,
Required: False ,
}
{
time:
{
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: The hourly recurrence of the schedule. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule. ,
Enum:
{
LabVmsShutdownTask: No description available. ,
LabVmsStartupTask: No description available. ,
LabBillingTask: No description available. ,
}
,
Required: False ,
}
enum ,
weeklyRecurrence:
{
Description: The weekly recurrence of the schedule. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: The daily recurrence of the schedule. ,
Required: False ,
}
{
time:
{
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: The hourly recurrence of the schedule. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Schedule_DeleteResource (removed)
Description :  Delete schedule. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the schedule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Schedule_PatchResource (removed)
Description :  Modify properties of schedules.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the schedule. ,
Required: True ,
}
string ,
schedule:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule. ,
Enum:
{
LabVmsShutdownTask: No description available. ,
LabVmsStartupTask: No description available. ,
LabBillingTask: No description available. ,
}
,
Required: False ,
}
enum ,
weeklyRecurrence:
{
Description: The weekly recurrence of the schedule. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: The daily recurrence of the schedule. ,
Required: False ,
}
{
time:
{
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: The hourly recurrence of the schedule. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
status:
{
Description: The status of the schedule. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
taskType:
{
Description: The task type of the schedule. ,
Enum:
{
LabVmsShutdownTask: No description available. ,
LabVmsStartupTask: No description available. ,
LabBillingTask: No description available. ,
}
,
Required: False ,
}
enum ,
weeklyRecurrence:
{
Description: The weekly recurrence of the schedule. ,
Required: False ,
}
{
weekdays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
time:
{
Description: The time of the day. ,
Required: False ,
}
string ,
}
,
dailyRecurrence:
{
Description: The daily recurrence of the schedule. ,
Required: False ,
}
{
time:
{
Required: False ,
}
string ,
}
,
hourlyRecurrence:
{
Description: The hourly recurrence of the schedule. ,
Required: False ,
}
{
minute:
{
Description: Minutes of the hour the schedule will run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZoneId:
{
Description: The time zone id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Schedule_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
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the schedule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualMachine_List (removed)
Description :  List virtual machines.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualMachine_GetResource (removed)
Description :  Get virtual machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual Machine. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualMachine_CreateOrUpdateResource (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}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual Machine. ,
Required: True ,
}
string ,
labVirtualMachine:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualMachine_DeleteResource (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}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual Machine. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualMachine_PatchResource (removed)
Description :  Modify properties of virtual machines.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual Machine. ,
Required: True ,
}
string ,
labVirtualMachine:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualMachine_ApplyArtifacts (removed)
Description :  Apply artifacts to Lab VM. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/applyArtifacts
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual Machine. ,
Required: True ,
}
string ,
applyArtifactsRequest:
{
Required: True ,
}
{
artifacts:
{
Description: The list of artifacts to apply. ,
Required: False ,
}
[
{
artifactId:
{
Description: The artifact's identifier. ,
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 ,
}
,
]
,
}
,
]
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualMachine_Start (removed)
Description :  Start a Lab VM. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/start
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual Machine. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualMachine_Stop (removed)
Description :  Stop a Lab VM. This operation can take a while to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/stop
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual Machine. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualNetwork_List (removed)
Description :  List virtual networks.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Format: int32 ,
Required: False ,
}
integer ,
$orderBy:
{
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Required: False ,
}
string ,
labSubnetName:
{
Required: False ,
}
string ,
allowPublicIp:
{
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 ,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource identifier 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. ,
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. ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualNetwork_GetResource (removed)
Description :  Get virtual network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual network. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Required: False ,
}
string ,
labSubnetName:
{
Required: False ,
}
string ,
allowPublicIp:
{
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 ,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource identifier 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. ,
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. ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualNetwork_CreateOrUpdateResource (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}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual network. ,
Required: True ,
}
string ,
virtualNetwork:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Required: False ,
}
string ,
labSubnetName:
{
Required: False ,
}
string ,
allowPublicIp:
{
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 ,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource identifier 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. ,
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. ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Required: False ,
}
string ,
labSubnetName:
{
Required: False ,
}
string ,
allowPublicIp:
{
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 ,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource identifier 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. ,
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. ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Required: False ,
}
string ,
labSubnetName:
{
Required: False ,
}
string ,
allowPublicIp:
{
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 ,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource identifier 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. ,
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. ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualNetwork_DeleteResource (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}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual network. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
VirtualNetwork_PatchResource (removed)
Description :  Modify properties of virtual networks.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
labName:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
name:
{
Description: The name of the virtual network. ,
Required: True ,
}
string ,
virtualNetwork:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Required: False ,
}
string ,
labSubnetName:
{
Required: False ,
}
string ,
allowPublicIp:
{
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 ,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource identifier 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. ,
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. ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed subnets of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Required: False ,
}
string ,
labSubnetName:
{
Required: False ,
}
string ,
allowPublicIp:
{
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 ,
subnetOverrides:
{
Description: The subnet overrides of the virtual network. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource identifier 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. ,
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. ,
Enum:
{
Default: No description available. ,
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Lab_GetResource (removed)
Description :  Get lab.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The artifact storage account of the lab. ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts of the lab. ,
Required: False ,
}
[
string ,
]
,
vaultName:
{
Description: The name of the key vault of the lab. ,
Required: False ,
}
string ,
labStorageType:
{
Description: The type of the lab storage. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
defaultVirtualNetworkId:
{
Description: The default virtual network identifier of the lab. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Lab_CreateOrUpdateResource (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}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
lab:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The artifact storage account of the lab. ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts of the lab. ,
Required: False ,
}
[
string ,
]
,
vaultName:
{
Description: The name of the key vault of the lab. ,
Required: False ,
}
string ,
labStorageType:
{
Description: The type of the lab storage. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
defaultVirtualNetworkId:
{
Description: The default virtual network identifier of the lab. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The artifact storage account of the lab. ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts of the lab. ,
Required: False ,
}
[
string ,
]
,
vaultName:
{
Description: The name of the key vault of the lab. ,
Required: False ,
}
string ,
labStorageType:
{
Description: The type of the lab storage. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
defaultVirtualNetworkId:
{
Description: The default virtual network identifier of the lab. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The artifact storage account of the lab. ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts of the lab. ,
Required: False ,
}
[
string ,
]
,
vaultName:
{
Description: The name of the key vault of the lab. ,
Required: False ,
}
string ,
labStorageType:
{
Description: The type of the lab storage. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
defaultVirtualNetworkId:
{
Description: The default virtual network identifier of the lab. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Lab_DeleteResource (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}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Lab_PatchResource (removed)
Description :  Modify properties of labs.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
lab:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The artifact storage account of the lab. ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts of the lab. ,
Required: False ,
}
[
string ,
]
,
vaultName:
{
Description: The name of the key vault of the lab. ,
Required: False ,
}
string ,
labStorageType:
{
Description: The type of the lab storage. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
defaultVirtualNetworkId:
{
Description: The default virtual network identifier of the lab. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
defaultStorageAccount:
{
Description: The lab's default storage account. ,
Required: False ,
}
string ,
artifactsStorageAccount:
{
Description: The artifact storage account of the lab. ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts of the lab. ,
Required: False ,
}
[
string ,
]
,
vaultName:
{
Description: The name of the key vault of the lab. ,
Required: False ,
}
string ,
labStorageType:
{
Description: The type of the lab storage. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
defaultVirtualNetworkId:
{
Description: The default virtual network identifier of the lab. ,
Required: False ,
}
string ,
createdDate:
{
Description: The creation date of the lab. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Lab_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
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
labVirtualMachine:
{
Required: True ,
}
{
properties:
{
Description: The properties of the resource. ,
Required: False ,
}
{
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 ,
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 ,
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: A value indicating 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 ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
provisioningState:
{
Description: The provisioning status of the resource. ,
Required: False ,
}
string ,
}
,
id:
{
Description: The identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: The tags of the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Lab_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
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
generateUploadUriParameter:
{
Required: True ,
}
{
blobName:
{
Description: The blob name of the upload URI. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}
Lab_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
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the lab. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Results of the list operation. ,
Required: False ,
}
[
{
id:
{
Description: The absolute URI of the VHD. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link for next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
target:
{
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
}
,
}