images

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

Overview

Name	images
Type	Resource
Id	azure_extras.sphere.images

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
componentId	string	The image component id.
description	string	The image description.
image	string	Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads.
imageId	string	Image ID.
imageName	string	Image name.
imageType	string	The image type. Known values are: "InvalidImageType", "OneBl", "PlutonRuntime", "WifiFirmware", "SecurityMonitor", "NormalWorldLoader", "NormalWorldDtb", "NormalWorldKernel", "RootFs", "Services", "Applications", "FwConfig", "BootManifest", "Nwfs", "TrustedKeystore", "Policy", "CustomerBoardConfig", "UpdateCertStore", "BaseSystemUpdateManifest", "FirmwareUpdateManifest", "CustomerUpdateManifest", "RecoveryManifest", "ManifestSet", and "Other".
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
regionalDataBoundary	string	Regional data boundary for an image. Known values are: "None" and "EU".
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".
uri	string	Location the image.

list_by_catalog

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
componentId	string	The image component id.
description	string	The image description.
image	string	Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads.
imageId	string	Image ID.
imageName	string	Image name.
imageType	string	The image type. Known values are: "InvalidImageType", "OneBl", "PlutonRuntime", "WifiFirmware", "SecurityMonitor", "NormalWorldLoader", "NormalWorldDtb", "NormalWorldKernel", "RootFs", "Services", "Applications", "FwConfig", "BootManifest", "Nwfs", "TrustedKeystore", "Policy", "CustomerBoardConfig", "UpdateCertStore", "BaseSystemUpdateManifest", "FirmwareUpdateManifest", "CustomerUpdateManifest", "RecoveryManifest", "ManifestSet", and "Other".
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
regionalDataBoundary	string	Regional data boundary for an image. Known values are: "None" and "EU".
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".
uri	string	Location the image.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, catalog_name, image_name, subscription_id		Get a Image.
list_by_catalog	select	resource_group_name, catalog_name, subscription_id	$filter, $top, $skip, $maxpagesize	List Image resources by Catalog.
create_or_update	insert	resource_group_name, catalog_name, image_name, subscription_id		Create a Image.
create_or_update	replace	resource_group_name, catalog_name, image_name, subscription_id		Create a Image.
delete	delete	resource_group_name, catalog_name, image_name, subscription_id		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
catalog_name	string	Name of catalog. Required.
image_name	string	Image name. Use an image GUID for GA versions of the API. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$filter	string	Filter the result list using the given expression. Default value is None.
$maxpagesize	integer	The maximum number of result items per page. Default value is None.
$skip	integer	The number of result items to skip. Default value is None.
$top	integer	The number of result items to return. Default value is None.

SELECT examples

get

Get a Image.

SELECT
id,
name,
componentId,
description,
image,
imageId,
imageName,
imageType,
provisioningState,
regionalDataBoundary,
systemData,
type,
uri
FROM azure_extras.sphere.images
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND catalog_name = '{{ catalog_name }}' -- required
AND image_name = '{{ image_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_catalog

List Image resources by Catalog.

SELECT
id,
name,
componentId,
description,
image,
imageId,
imageName,
imageType,
provisioningState,
regionalDataBoundary,
systemData,
type,
uri
FROM azure_extras.sphere.images
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND catalog_name = '{{ catalog_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
AND $maxpagesize = '{{ $maxpagesize }}'
;

INSERT examples

create_or_update

Create a Image.

INSERT INTO azure_extras.sphere.images (
properties,
resource_group_name,
catalog_name,
image_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ catalog_name }}',
'{{ image_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: images
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the images resource.
  - name: catalog_name
    value: "{{ catalog_name }}"
    description: Required parameter for the images resource.
  - name: image_name
    value: "{{ image_name }}"
    description: Required parameter for the images resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the images resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      image: "{{ image }}"
      imageId: "{{ imageId }}"
      imageName: "{{ imageName }}"
      regionalDataBoundary: "{{ regionalDataBoundary }}"
      uri: "{{ uri }}"
      description: "{{ description }}"
      componentId: "{{ componentId }}"
      imageType: "{{ imageType }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Create a Image.

REPLACE azure_extras.sphere.images
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND catalog_name = '{{ catalog_name }}' --required
AND image_name = '{{ image_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a Image.

DELETE FROM azure_extras.sphere.images
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND catalog_name = '{{ catalog_name }}' --required
AND image_name = '{{ image_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;