Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The labs/users/disks resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DevTestLab/labs/users/disks resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DevTestLab/labs/users/disks@2018-09-15' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
diskBlobName: 'string'
diskSizeGiB: int
diskType: 'string'
diskUri: 'string'
hostCaching: 'string'
leasedByLabVmId: 'string'
managedDiskId: 'string'
storageAccountId: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.DevTestLab/labs/users/disks
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string |
| name | The resource name | string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: labs/users |
| properties | The properties of the disk. | DiskProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
DiskProperties
| Name | Description | Value |
|---|---|---|
| diskBlobName | When backed by a blob, the name of the VHD blob without extension. | string |
| diskSizeGiB | The size of the disk in Gibibytes. | int |
| diskType | The storage type for the disk (i.e. Standard, Premium). | 'Premium' 'Standard' 'StandardSSD' |
| diskUri | When backed by a blob, the URI of underlying blob. | string |
| hostCaching | The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite). | string |
| leasedByLabVmId | The resource ID of the VM to which this disk is leased. | string |
| managedDiskId | When backed by managed disk, this is the ID of the compute disk resource. | string |
| storageAccountId | When backed by a blob, the storage account where the blob is. | string |
DiskTags
| Name | Description | Value |
|---|
ARM template resource definition
The labs/users/disks resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DevTestLab/labs/users/disks resource, add the following JSON to your template.
{
"type": "Microsoft.DevTestLab/labs/users/disks",
"apiVersion": "2018-09-15",
"name": "string",
"location": "string",
"properties": {
"diskBlobName": "string",
"diskSizeGiB": "int",
"diskType": "string",
"diskUri": "string",
"hostCaching": "string",
"leasedByLabVmId": "string",
"managedDiskId": "string",
"storageAccountId": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.DevTestLab/labs/users/disks
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2018-09-15' |
| location | The geo-location where the resource lives | string |
| name | The resource name | string (required) |
| properties | The properties of the disk. | DiskProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.DevTestLab/labs/users/disks' |
DiskProperties
| Name | Description | Value |
|---|---|---|
| diskBlobName | When backed by a blob, the name of the VHD blob without extension. | string |
| diskSizeGiB | The size of the disk in Gibibytes. | int |
| diskType | The storage type for the disk (i.e. Standard, Premium). | 'Premium' 'Standard' 'StandardSSD' |
| diskUri | When backed by a blob, the URI of underlying blob. | string |
| hostCaching | The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite). | string |
| leasedByLabVmId | The resource ID of the VM to which this disk is leased. | string |
| managedDiskId | When backed by managed disk, this is the ID of the compute disk resource. | string |
| storageAccountId | When backed by a blob, the storage account where the blob is. | string |
DiskTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The labs/users/disks resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DevTestLab/labs/users/disks resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DevTestLab/labs/users/disks@2018-09-15"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
diskBlobName = "string"
diskSizeGiB = int
diskType = "string"
diskUri = "string"
hostCaching = "string"
leasedByLabVmId = "string"
managedDiskId = "string"
storageAccountId = "string"
}
}
}
Property Values
Microsoft.DevTestLab/labs/users/disks
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: labs/users |
| properties | The properties of the disk. | DiskProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.DevTestLab/labs/users/disks@2018-09-15" |
DiskProperties
| Name | Description | Value |
|---|---|---|
| diskBlobName | When backed by a blob, the name of the VHD blob without extension. | string |
| diskSizeGiB | The size of the disk in Gibibytes. | int |
| diskType | The storage type for the disk (i.e. Standard, Premium). | 'Premium' 'Standard' 'StandardSSD' |
| diskUri | When backed by a blob, the URI of underlying blob. | string |
| hostCaching | The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite). | string |
| leasedByLabVmId | The resource ID of the VM to which this disk is leased. | string |
| managedDiskId | When backed by managed disk, this is the ID of the compute disk resource. | string |
| storageAccountId | When backed by a blob, the storage account where the blob is. | string |
DiskTags
| Name | Description | Value |
|---|