images

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

Overview

Name	images
Type	Resource
Id	azure.sphere.images

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

list_by_catalog

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, catalogName, imageName		Get a Image
list_by_catalog	select	subscriptionId, resourceGroupName, catalogName	$filter, $top, $skip, $maxpagesize	List Image resources by Catalog
create_or_update	insert	subscriptionId, resourceGroupName, catalogName, imageName		Create a Image
delete	delete	subscriptionId, resourceGroupName, catalogName, imageName		Delete a 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
catalogName	string	Name of catalog
imageName	string	Image name. Use an image GUID for GA versions of the API.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
$filter	string	Filter the result list using the given expression
$maxpagesize	integer (int32)	The maximum number of result items per page.
$skip	integer (int32)	The number of result items to skip.
$top	integer (int32)	The number of result items to return.

SELECT examples

get

Get a Image

SELECT
properties
FROM azure.sphere.images
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND catalogName = '{{ catalogName }}' -- required
AND imageName = '{{ imageName }}' -- required
;

list_by_catalog

List Image resources by Catalog

SELECT
properties
FROM azure.sphere.images
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND catalogName = '{{ catalogName }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
AND $maxpagesize = '{{ $maxpagesize }}'
;

INSERT examples

create_or_update

Create a Image

INSERT INTO azure.sphere.images (
data__properties,
subscriptionId,
resourceGroupName,
catalogName,
imageName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ catalogName }}',
'{{ imageName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: images
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the images resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the images resource.
    - name: catalogName
      value: string
      description: Required parameter for the images resource.
    - name: imageName
      value: string
      description: Required parameter for the images resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.

DELETE examples

delete

Delete a Image

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