Microsoft.DevTestLab labs/customimages

• Latest
• 2018-09-15
• 2016-05-15
• 2015-05-21-preview

Bicep resource definition

The labs/customimages 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/customimages resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DevTestLab/labs/customimages@2018-09-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    author: 'string'
    customImagePlan: {
      id: 'string'
      offer: 'string'
      publisher: 'string'
    }
    dataDiskStorageInfo: [
      {
        lun: 'string'
        storageType: 'string'
      }
    ]
    description: 'string'
    isPlanAuthorized: bool
    managedImageId: 'string'
    managedSnapshotId: 'string'
    vhd: {
      imageName: 'string'
      osType: 'string'
      sysPrep: bool
    }
    vm: {
      linuxOsInfo: {
        linuxOsState: 'string'
      }
      sourceVmId: 'string'
      windowsOsInfo: {
        windowsOsState: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.DevTestLab/labs/customimages

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
properties	The properties of the resource.	CustomImageProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

CustomImageProperties

Name	Description	Value
author	The author of the custom image.	string
customImagePlan	Storage information about the plan related to this custom image	CustomImagePropertiesFromPlan
dataDiskStorageInfo	Storage information about the data disks present in the custom image	DataDiskStorageTypeInfo[]
description	The description of the custom image.	string
isPlanAuthorized	Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment	bool
managedImageId	The Managed Image Id backing the custom image.	string
managedSnapshotId	The Managed Snapshot Id backing the custom image.	string
vhd	The VHD from which the image is to be created.	CustomImagePropertiesCustom
vm	The virtual machine from which the image is to be created.	CustomImagePropertiesFromVm

CustomImagePropertiesCustom

Name	Description	Value
imageName	The image name.	string
osType	The OS type of the custom image (i.e. Windows, Linux)	'Linux' 'None' 'Windows' (required)
sysPrep	Indicates whether sysprep has been run on the VHD.	bool

CustomImagePropertiesFromPlan

Name	Description	Value
id	The id of the plan, equivalent to name of the plan	string
offer	The offer for the plan from the marketplace image the custom image is derived from	string
publisher	The publisher for the plan from the marketplace image the custom image is derived from	string

CustomImagePropertiesFromVm

Name	Description	Value
linuxOsInfo	The Linux OS information of the VM.	LinuxOsInfo
sourceVmId	The source vm identifier.	string
windowsOsInfo	The Windows OS information of the VM.	WindowsOsInfo

CustomImageTags

Name	Description	Value

DataDiskStorageTypeInfo

Name	Description	Value
lun	Disk Lun	string
storageType	Disk Storage Type	'Premium' 'Standard' 'StandardSSD'

LinuxOsInfo

Name	Description	Value
linuxOsState	The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied).	'DeprovisionApplied' 'DeprovisionRequested' 'NonDeprovisioned'

WindowsOsInfo

Name	Description	Value
windowsOsState	The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied).	'NonSysprepped' 'SysprepApplied' 'SysprepRequested'

ARM template resource definition

The labs/customimages 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/customimages resource, add the following JSON to your template.

{
  "type": "Microsoft.DevTestLab/labs/customimages",
  "apiVersion": "2018-09-15",
  "name": "string",
  "location": "string",
  "properties": {
    "author": "string",
    "customImagePlan": {
      "id": "string",
      "offer": "string",
      "publisher": "string"
    },
    "dataDiskStorageInfo": [
      {
        "lun": "string",
        "storageType": "string"
      }
    ],
    "description": "string",
    "isPlanAuthorized": "bool",
    "managedImageId": "string",
    "managedSnapshotId": "string",
    "vhd": {
      "imageName": "string",
      "osType": "string",
      "sysPrep": "bool"
    },
    "vm": {
      "linuxOsInfo": {
        "linuxOsState": "string"
      },
      "sourceVmId": "string",
      "windowsOsInfo": {
        "windowsOsState": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.DevTestLab/labs/customimages

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 resource.	CustomImageProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.DevTestLab/labs/customimages'

CustomImageProperties

Name	Description	Value
author	The author of the custom image.	string
customImagePlan	Storage information about the plan related to this custom image	CustomImagePropertiesFromPlan
dataDiskStorageInfo	Storage information about the data disks present in the custom image	DataDiskStorageTypeInfo[]
description	The description of the custom image.	string
isPlanAuthorized	Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment	bool
managedImageId	The Managed Image Id backing the custom image.	string
managedSnapshotId	The Managed Snapshot Id backing the custom image.	string
vhd	The VHD from which the image is to be created.	CustomImagePropertiesCustom
vm	The virtual machine from which the image is to be created.	CustomImagePropertiesFromVm

CustomImagePropertiesCustom

Name	Description	Value
imageName	The image name.	string
osType	The OS type of the custom image (i.e. Windows, Linux)	'Linux' 'None' 'Windows' (required)
sysPrep	Indicates whether sysprep has been run on the VHD.	bool

CustomImagePropertiesFromPlan

Name	Description	Value
id	The id of the plan, equivalent to name of the plan	string
offer	The offer for the plan from the marketplace image the custom image is derived from	string
publisher	The publisher for the plan from the marketplace image the custom image is derived from	string

CustomImagePropertiesFromVm

Name	Description	Value
linuxOsInfo	The Linux OS information of the VM.	LinuxOsInfo
sourceVmId	The source vm identifier.	string
windowsOsInfo	The Windows OS information of the VM.	WindowsOsInfo

CustomImageTags

Name	Description	Value

DataDiskStorageTypeInfo

Name	Description	Value
lun	Disk Lun	string
storageType	Disk Storage Type	'Premium' 'Standard' 'StandardSSD'

LinuxOsInfo

Name	Description	Value
linuxOsState	The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied).	'DeprovisionApplied' 'DeprovisionRequested' 'NonDeprovisioned'

WindowsOsInfo

Name	Description	Value
windowsOsState	The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied).	'NonSysprepped' 'SysprepApplied' 'SysprepRequested'

Usage Examples

Terraform (AzAPI provider) resource definition

The labs/customimages 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/customimages resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DevTestLab/labs/customimages@2018-09-15"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      author = "string"
      customImagePlan = {
        id = "string"
        offer = "string"
        publisher = "string"
      }
      dataDiskStorageInfo = [
        {
          lun = "string"
          storageType = "string"
        }
      ]
      description = "string"
      isPlanAuthorized = bool
      managedImageId = "string"
      managedSnapshotId = "string"
      vhd = {
        imageName = "string"
        osType = "string"
        sysPrep = bool
      }
      vm = {
        linuxOsInfo = {
          linuxOsState = "string"
        }
        sourceVmId = "string"
        windowsOsInfo = {
          windowsOsState = "string"
        }
      }
    }
  }
}

Property Values

Microsoft.DevTestLab/labs/customimages

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
properties	The properties of the resource.	CustomImageProperties (required)
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.DevTestLab/labs/customimages@2018-09-15"

CustomImageProperties

Name	Description	Value
author	The author of the custom image.	string
customImagePlan	Storage information about the plan related to this custom image	CustomImagePropertiesFromPlan
dataDiskStorageInfo	Storage information about the data disks present in the custom image	DataDiskStorageTypeInfo[]
description	The description of the custom image.	string
isPlanAuthorized	Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment	bool
managedImageId	The Managed Image Id backing the custom image.	string
managedSnapshotId	The Managed Snapshot Id backing the custom image.	string
vhd	The VHD from which the image is to be created.	CustomImagePropertiesCustom
vm	The virtual machine from which the image is to be created.	CustomImagePropertiesFromVm

CustomImagePropertiesCustom

Name	Description	Value
imageName	The image name.	string
osType	The OS type of the custom image (i.e. Windows, Linux)	'Linux' 'None' 'Windows' (required)
sysPrep	Indicates whether sysprep has been run on the VHD.	bool

CustomImagePropertiesFromPlan

Name	Description	Value
id	The id of the plan, equivalent to name of the plan	string
offer	The offer for the plan from the marketplace image the custom image is derived from	string
publisher	The publisher for the plan from the marketplace image the custom image is derived from	string

CustomImagePropertiesFromVm

Name	Description	Value
linuxOsInfo	The Linux OS information of the VM.	LinuxOsInfo
sourceVmId	The source vm identifier.	string
windowsOsInfo	The Windows OS information of the VM.	WindowsOsInfo

CustomImageTags

Name	Description	Value

DataDiskStorageTypeInfo

Name	Description	Value
lun	Disk Lun	string
storageType	Disk Storage Type	'Premium' 'Standard' 'StandardSSD'

LinuxOsInfo

Name	Description	Value
linuxOsState	The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied).	'DeprovisionApplied' 'DeprovisionRequested' 'NonDeprovisioned'

WindowsOsInfo

Name	Description	Value
windowsOsState	The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied).	'NonSysprepped' 'SysprepApplied' 'SysprepRequested'