images

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

Overview

Name	images
Type	Resource
Id	azure.compute.images

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
extendedLocation	object	The extended location of the Image.
location	string	Resource location
properties	object	Describes the properties of an Image.
tags	object	Resource tags
type	string	Resource type

list_by_resource_group

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
extendedLocation	object	The extended location of the Image.
location	string	Resource location
properties	object	Describes the properties of an Image.
tags	object	Resource tags
type	string	Resource type

list

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
extendedLocation	object	The extended location of the Image.
location	string	Resource location
properties	object	Describes the properties of an Image.
tags	object	Resource tags
type	string	Resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, imageName, subscriptionId	$expand	Gets an image.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets the list of images under a resource group. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.
list	select	subscriptionId		Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.
create_or_update	insert	resourceGroupName, imageName, subscriptionId		Create or update an image.
update	update	resourceGroupName, imageName, subscriptionId		Update an image.
delete	delete	resourceGroupName, imageName, subscriptionId		Deletes an Image.

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
imageName	string	The name of the image.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$expand	string	The expand expression to apply on the operation.

SELECT examples

get

Gets an image.

SELECT
id,
name,
extendedLocation,
location,
properties,
tags,
type
FROM azure.compute.images
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND imageName = '{{ imageName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Gets the list of images under a resource group. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.

SELECT
id,
name,
extendedLocation,
location,
properties,
tags,
type
FROM azure.compute.images
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.

SELECT
id,
name,
extendedLocation,
location,
properties,
tags,
type
FROM azure.compute.images
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or update an image.

INSERT INTO azure.compute.images (
data__properties,
data__extendedLocation,
data__location,
data__tags,
resourceGroupName,
imageName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}',
'{{ location }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ imageName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
extendedLocation,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: images
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the images resource.
    - name: imageName
      value: string
      description: Required parameter for the images resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the images resource.
    - name: properties
      value: object
      description: |
        Describes the properties of an Image.
    - name: extendedLocation
      value: object
      description: |
        The extended location of the Image.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags

UPDATE examples

update

Update an image.

UPDATE azure.compute.images
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND imageName = '{{ imageName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes an Image.

DELETE FROM azure.compute.images
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND imageName = '{{ imageName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;