custom_images

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

Overview

Name	custom_images
Type	Resource
Id	azure_extras.test_base.custom_images

Fields

The following fields are returned by SELECT queries:

get

The test base custom image was successfully found.

Name	Datatype	Description
properties	object	Test Base custom image properties.

list_by_test_base_account

The operation is completed.

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, customImageName		Gets a test base custom image.
list_by_test_base_account	select	subscriptionId, resourceGroupName, testBaseAccountName		Lists all the custom images under a test base account.
create	insert	subscriptionId, resourceGroupName, testBaseAccountName, customImageName		Creates a test base custom image.
delete	delete	subscriptionId, resourceGroupName, testBaseAccountName, customImageName		Deletes a test base custom image.
check_image_name_availability	exec	subscriptionId, resourceGroupName, testBaseAccountName, definitionName, versionName		Checks that the test vase custom image generated from VHD resource has valid and unique definition and version, return architecture and OS state of potential existing image definition.

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
customImageName	string	The resource name of the test base custom image.
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

Gets a test base custom image.

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

list_by_test_base_account

Lists all the custom images under a test base account.

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

INSERT examples

create

Creates a test base custom image.

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

Manifest

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

DELETE examples

delete

Deletes a test base custom image.

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

Lifecycle Methods

check_image_name_availability

Checks that the test vase custom image generated from VHD resource has valid and unique definition and version, return architecture and OS state of potential existing image definition.

EXEC azure_extras.test_base.custom_images.check_image_name_availability 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@testBaseAccountName='{{ testBaseAccountName }}' --required 
@@json=
'{
"definitionName": "{{ definitionName }}", 
"versionName": "{{ versionName }}"
}'
;