platform_images

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

Overview

Name	platform_images
Type	Resource
Id	azure_stack.compute_admin.platform_images

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	ID of the resource.
name	string	Name of the resource.
location	string	Location of the resource.
properties	object	Platform image properties.
type	string	Type of Resource.

list

Name	Datatype	Description
id	string	ID of the resource.
name	string	Name of the resource.
location	string	Location of the resource.
properties	object	Platform image properties.
type	string	Type of Resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, location, publisher, offer, sku, version		Returns the specific platform image matching publisher, offer, skus and version.
list	select	subscriptionId, location		Returns a list of all platform images.
create	insert	subscriptionId, location, publisher, offer, sku, version		Creates a new platform image with given publisher, offer, skus and version.
delete	delete	subscriptionId, location, publisher, offer, sku, version		Delete a platform 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
location	string	The name of Azure region.
offer	string	Name of the offer.
publisher	string	Name of the publisher.
sku	string	Name of the SKU.
subscriptionId	string	The ID of the target subscription.
version	string	The version of the resource.

SELECT examples

get

Returns the specific platform image matching publisher, offer, skus and version.

SELECT
id,
name,
location,
properties,
type
FROM azure_stack.compute_admin.platform_images
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND location = '{{ location }}' -- required
AND publisher = '{{ publisher }}' -- required
AND offer = '{{ offer }}' -- required
AND sku = '{{ sku }}' -- required
AND version = '{{ version }}' -- required
;

list

Returns a list of all platform images.

SELECT
id,
name,
location,
properties,
type
FROM azure_stack.compute_admin.platform_images
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND location = '{{ location }}' -- required
;

INSERT examples

create

Creates a new platform image with given publisher, offer, skus and version.

INSERT INTO azure_stack.compute_admin.platform_images (
data__properties,
subscriptionId,
location,
publisher,
offer,
sku,
version
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ location }}',
'{{ publisher }}',
'{{ offer }}',
'{{ sku }}',
'{{ version }}'
RETURNING
id,
name,
location,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: platform_images
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the platform_images resource.
    - name: location
      value: string
      description: Required parameter for the platform_images resource.
    - name: publisher
      value: string
      description: Required parameter for the platform_images resource.
    - name: offer
      value: string
      description: Required parameter for the platform_images resource.
    - name: sku
      value: string
      description: Required parameter for the platform_images resource.
    - name: version
      value: string
      description: Required parameter for the platform_images resource.
    - name: properties
      value: object
      description: |
        Platform image properties.

DELETE examples

delete

Delete a platform image

DELETE FROM azure_stack.compute_admin.platform_images
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND location = '{{ location }}' --required
AND publisher = '{{ publisher }}' --required
AND offer = '{{ offer }}' --required
AND sku = '{{ sku }}' --required
AND version = '{{ version }}' --required
;