images

Creates, updates, deletes, gets or lists an images resource.

Overview

Name	images
Type	Resource
Id	azure.devcenter.images

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
description	string	The description of the image.
hibernateSupport	string	Indicates whether this image has hibernate enabled. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate. Known values are: "Disabled" and "Enabled".
offer	string	The name of the image offer.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
publisher	string	The publisher of the image.
recommendedMachineConfiguration	object	The recommended machine configuration to use with the image.
sku	string	The SKU name for the image.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_gallery

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
description	string	The description of the image.
hibernateSupport	string	Indicates whether this image has hibernate enabled. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate. Known values are: "Disabled" and "Enabled".
offer	string	The name of the image offer.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
publisher	string	The publisher of the image.
recommendedMachineConfiguration	object	The recommended machine configuration to use with the image.
sku	string	The SKU name for the image.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_dev_center

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
description	string	The description of the image.
hibernateSupport	string	Indicates whether this image has hibernate enabled. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate. Known values are: "Disabled" and "Enabled".
offer	string	The name of the image offer.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
publisher	string	The publisher of the image.
recommendedMachineConfiguration	object	The recommended machine configuration to use with the image.
sku	string	The SKU name for the image.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, dev_center_name, gallery_name, image_name, subscription_id		Gets a gallery image.
list_by_gallery	select	resource_group_name, dev_center_name, gallery_name, subscription_id	$top	Lists images for a gallery.
list_by_dev_center	select	resource_group_name, dev_center_name, subscription_id	$top	Lists images for a devcenter.

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
dev_center_name	string	The name of the devcenter. Required.
gallery_name	string	The name of the gallery. Required.
image_name	string	The name of the image. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Gets a gallery image.

SELECT
id,
name,
description,
hibernateSupport,
offer,
provisioningState,
publisher,
recommendedMachineConfiguration,
sku,
systemData,
type
FROM azure.devcenter.images
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dev_center_name = '{{ dev_center_name }}' -- required
AND gallery_name = '{{ gallery_name }}' -- required
AND image_name = '{{ image_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_gallery

Lists images for a gallery.

SELECT
id,
name,
description,
hibernateSupport,
offer,
provisioningState,
publisher,
recommendedMachineConfiguration,
sku,
systemData,
type
FROM azure.devcenter.images
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dev_center_name = '{{ dev_center_name }}' -- required
AND gallery_name = '{{ gallery_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

list_by_dev_center

Lists images for a devcenter.

SELECT
id,
name,
description,
hibernateSupport,
offer,
provisioningState,
publisher,
recommendedMachineConfiguration,
sku,
systemData,
type
FROM azure.devcenter.images
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dev_center_name = '{{ dev_center_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;