packages

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

Overview

Name	packages
Type	Resource
Id	azure_extras.test_base.packages

Fields

The following fields are returned by SELECT queries:

get

The Test Base Package was successfully found.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Test Base Package properties.
tags	object	Resource tags.

list_by_test_base_account

The operation is completed.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Test Base Package properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, testBaseAccountName, packageName		Gets a Test Base Package.
list_by_test_base_account	select	subscriptionId, resourceGroupName, testBaseAccountName		Lists all the packages under a Test Base Account.
create	insert	subscriptionId, resourceGroupName, testBaseAccountName, packageName		Create or replace (overwrite/recreate, with potential downtime) a Test Base Package.
update	update	subscriptionId, resourceGroupName, testBaseAccountName, packageName		Update an existing Test Base Package.
delete	delete	subscriptionId, resourceGroupName, testBaseAccountName, packageName		Deletes a Test Base Package.
hard_delete	exec	subscriptionId, resourceGroupName, testBaseAccountName, packageName		Hard Delete a Test Base Package.
run_test	exec	subscriptionId, resourceGroupName, testBaseAccountName, packageName		Trigger a test run on the package.

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
packageName	string	The resource name of the Test Base Package.
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 Package.

SELECT
location,
properties,
tags
FROM azure_extras.test_base.packages
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND testBaseAccountName = '{{ testBaseAccountName }}' -- required
AND packageName = '{{ packageName }}' -- required
;

list_by_test_base_account

Lists all the packages under a Test Base Account.

SELECT
location,
properties,
tags
FROM azure_extras.test_base.packages
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND testBaseAccountName = '{{ testBaseAccountName }}' -- required
;

INSERT examples

create

Create or replace (overwrite/recreate, with potential downtime) a Test Base Package.

INSERT INTO azure_extras.test_base.packages (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
testBaseAccountName,
packageName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ testBaseAccountName }}',
'{{ packageName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: packages
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the packages resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the packages resource.
    - name: testBaseAccountName
      value: string
      description: Required parameter for the packages resource.
    - name: packageName
      value: string
      description: Required parameter for the packages resource.
    - name: properties
      value: object
      description: |
        Test Base Package properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update an existing Test Base Package.

UPDATE azure_extras.test_base.packages
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND testBaseAccountName = '{{ testBaseAccountName }}' --required
AND packageName = '{{ packageName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes a Test Base Package.

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

Lifecycle Methods

hard_delete

Hard Delete a Test Base Package.

EXEC azure_extras.test_base.packages.hard_delete 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@testBaseAccountName='{{ testBaseAccountName }}' --required, 
@packageName='{{ packageName }}' --required
;

run_test

Trigger a test run on the package.

EXEC azure_extras.test_base.packages.run_test 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@testBaseAccountName='{{ testBaseAccountName }}' --required, 
@packageName='{{ packageName }}' --required 
@@json=
'{
"testType": "{{ testType }}", 
"osUpdateType": "{{ osUpdateType }}", 
"osName": "{{ osName }}", 
"releaseName": "{{ releaseName }}", 
"flightingRing": "{{ flightingRing }}", 
"customImageId": "{{ customImageId }}"
}'
;