custom_images

Creates, updates, deletes, gets or lists a custom_images resource.

Overview

Name	custom_images
Type	Resource
Id	azure.dev_test_labs.custom_images

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The identifier of the resource.
name	string	The name of the resource.
author	string	The author of the custom image.
creationDate	string (date-time)	The creation date of the custom image.
customImagePlan	object	Storage information about the plan related to this custom image.
dataDiskStorageInfo	array	Storage information about the data disks present in the custom image.
description	string	The description of the custom image.
isPlanAuthorized	boolean	Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment.
location	string	The location of the resource.
managedImageId	string	The Managed Image Id backing the custom image.
managedSnapshotId	string	The Managed Snapshot Id backing the custom image.
provisioningState	string	The provisioning status of the resource.
tags	object	The tags of the resource.
type	string	The type of the resource.
uniqueIdentifier	string	The unique immutable identifier of a resource (Guid).
vhd	object	The VHD from which the image is to be created.
vm	object	The virtual machine from which the image is to be created.

list

Name	Datatype	Description
id	string	The identifier of the resource.
name	string	The name of the resource.
author	string	The author of the custom image.
creationDate	string (date-time)	The creation date of the custom image.
customImagePlan	object	Storage information about the plan related to this custom image.
dataDiskStorageInfo	array	Storage information about the data disks present in the custom image.
description	string	The description of the custom image.
isPlanAuthorized	boolean	Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment.
location	string	The location of the resource.
managedImageId	string	The Managed Image Id backing the custom image.
managedSnapshotId	string	The Managed Snapshot Id backing the custom image.
provisioningState	string	The provisioning status of the resource.
tags	object	The tags of the resource.
type	string	The type of the resource.
uniqueIdentifier	string	The unique immutable identifier of a resource (Guid).
vhd	object	The VHD from which the image is to be created.
vm	object	The virtual machine from which the image is to be created.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, lab_name, name, subscription_id	$expand	Get custom image.
list	select	resource_group_name, lab_name, subscription_id	$expand, $filter, $top, $orderby	List custom images in a given lab.
create_or_update	insert	resource_group_name, lab_name, name, subscription_id		Create or replace an existing custom image. This operation can take a while to complete.
update	update	resource_group_name, lab_name, name, subscription_id		Allows modifying tags of custom images. All other properties will be ignored.
create_or_update	replace	resource_group_name, lab_name, name, subscription_id		Create or replace an existing custom image. This operation can take a while to complete.
delete	delete	resource_group_name, lab_name, name, subscription_id		Delete custom image. This operation can take a while to complete.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
lab_name	string	The name of the lab. Required.
name	string	The name of the custom image. Required.
resource_group_name	string	The name of the resource group. Required.
subscription_id	string
$expand	string	Specify the $expand query. Example: 'properties($select=vm)'. Default value is None.
$filter	string	The filter to apply to the operation. Example: '$filter=contains(name,'myName'). Default value is None.
$orderby	string	The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. Default value is None.
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Get custom image.

SELECT
id,
name,
author,
creationDate,
customImagePlan,
dataDiskStorageInfo,
description,
isPlanAuthorized,
location,
managedImageId,
managedSnapshotId,
provisioningState,
tags,
type,
uniqueIdentifier,
vhd,
vm
FROM azure.dev_test_labs.custom_images
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list

List custom images in a given lab.

SELECT
id,
name,
author,
creationDate,
customImagePlan,
dataDiskStorageInfo,
description,
isPlanAuthorized,
location,
managedImageId,
managedSnapshotId,
provisioningState,
tags,
type,
uniqueIdentifier,
vhd,
vm
FROM azure.dev_test_labs.custom_images
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
;

INSERT examples

create_or_update

Create or replace an existing custom image. This operation can take a while to complete.

INSERT INTO azure.dev_test_labs.custom_images (
location,
tags,
properties,
resource_group_name,
lab_name,
name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ lab_name }}',
'{{ name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: custom_images
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the custom_images resource.
  - name: lab_name
    value: "{{ lab_name }}"
    description: Required parameter for the custom_images resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the custom_images resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the custom_images resource.
  - name: location
    value: "{{ location }}"
    description: |
      The location of the resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      The tags of the resource.
  - name: properties
    value:
      vm:
        sourceVmId: "{{ sourceVmId }}"
        windowsOsInfo:
          windowsOsState: "{{ windowsOsState }}"
        linuxOsInfo:
          linuxOsState: "{{ linuxOsState }}"
      vhd:
        imageName: "{{ imageName }}"
        sysPrep: {{ sysPrep }}
        osType: "{{ osType }}"
      description: "{{ description }}"
      author: "{{ author }}"
      managedImageId: "{{ managedImageId }}"
      managedSnapshotId: "{{ managedSnapshotId }}"
      dataDiskStorageInfo:
        - lun: "{{ lun }}"
          storageType: "{{ storageType }}"
      customImagePlan:
        id: "{{ id }}"
        publisher: "{{ publisher }}"
        offer: "{{ offer }}"
      isPlanAuthorized: {{ isPlanAuthorized }}

UPDATE examples

update

Allows modifying tags of custom images. All other properties will be ignored.

UPDATE azure.dev_test_labs.custom_images
SET 
-- No updatable properties
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Create or replace an existing custom image. This operation can take a while to complete.

REPLACE azure.dev_test_labs.custom_images
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Delete custom image. This operation can take a while to complete.

DELETE FROM azure.dev_test_labs.custom_images
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;