image_definitions

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

Overview

Name	image_definitions
Type	Resource
Id	azure_extras.test_base.image_definitions

Fields

The following fields are returned by SELECT queries:

get

Get the detailed properties of the image definition if applicable.

Name	Datatype	Description
properties	object	Test Base custom image properties.

list_by_test_base_account

Get image definition existence and get detailed properties if applicable.

Name	Datatype	Description
properties	object	Test Base custom image properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, testBaseAccountName, imageDefinitionName		Get image properties under the image definition name created by test base custom image which derived from 'VHD' source.
list_by_test_base_account	select	subscriptionId, resourceGroupName, testBaseAccountName		List all image definition properties created by test base custom images which are derived from 'VHD' source.
create	insert	subscriptionId, resourceGroupName, testBaseAccountName, imageDefinitionName		Create image definition for test base custom images which are derived from 'VHD' source.
delete	delete	subscriptionId, resourceGroupName, testBaseAccountName, imageDefinitionName		Delete a test base image definition resource.

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
imageDefinitionName	string	The resource name of the test base image definition.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
testBaseAccountName	string	The resource name of the Test Base Account.

SELECT examples

get

Get image properties under the image definition name created by test base custom image which derived from 'VHD' source.

SELECT
properties
FROM azure_extras.test_base.image_definitions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND testBaseAccountName = '{{ testBaseAccountName }}' -- required
AND imageDefinitionName = '{{ imageDefinitionName }}' -- required
;

list_by_test_base_account

List all image definition properties created by test base custom images which are derived from 'VHD' source.

SELECT
properties
FROM azure_extras.test_base.image_definitions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND testBaseAccountName = '{{ testBaseAccountName }}' -- required
;

INSERT examples

create

Create image definition for test base custom images which are derived from 'VHD' source.

INSERT INTO azure_extras.test_base.image_definitions (
data__properties,
subscriptionId,
resourceGroupName,
testBaseAccountName,
imageDefinitionName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ testBaseAccountName }}',
'{{ imageDefinitionName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: image_definitions
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the image_definitions resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the image_definitions resource.
    - name: testBaseAccountName
      value: string
      description: Required parameter for the image_definitions resource.
    - name: imageDefinitionName
      value: string
      description: Required parameter for the image_definitions resource.
    - name: properties
      value: object
      description: |
        Test Base custom image properties.

DELETE examples

delete

Delete a test base image definition resource.

DELETE FROM azure_extras.test_base.image_definitions
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND testBaseAccountName = '{{ testBaseAccountName }}' --required
AND imageDefinitionName = '{{ imageDefinitionName }}' --required
;