draft_packages

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

Overview

Name	draft_packages
Type	Resource
Id	azure_extras.test_base.draft_packages

Fields

The following fields are returned by SELECT queries:

get

The Test Base Draft Package was successfully found.

Name	Datatype	Description
properties	object	Test Base Draft Package properties.

list_by_test_base_account

The operation is completed.

Name	Datatype	Description
properties	object	Test Base Draft Package properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, testBaseAccountName, draftPackageName		Gets a Test Base Draft Package.
list_by_test_base_account	select	subscriptionId, resourceGroupName, testBaseAccountName	packageName, editPackage	Lists all the draft packages under a test base account.
create	insert	subscriptionId, resourceGroupName, testBaseAccountName, draftPackageName		Creates or replaces a Test Base Draft Package.
update	update	subscriptionId, resourceGroupName, testBaseAccountName, draftPackageName		Updates an existing Test Base Draft Package.
delete	delete	subscriptionId, resourceGroupName, testBaseAccountName, draftPackageName		Deletes a Test Base Draft Package.
copy_from_package	exec	subscriptionId, resourceGroupName, testBaseAccountName, draftPackageName, packageId		Copy package file and metadata from a package to this draft package
extract_file	exec	subscriptionId, resourceGroupName, testBaseAccountName, draftPackageName, sourceFile		Performs extracting file operation for a Test Base Draft Package
generate_folders_and_scripts	exec	subscriptionId, resourceGroupName, testBaseAccountName, draftPackageName		Generates folders and scripts

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
draftPackageName	string	The resource name of the Test Base Draft 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.
editPackage	boolean	Parameter used to filter draft packages by editPackage property.
packageName	string	Parameter used to filter draft packages by linked Test Base Package.

SELECT examples

get

Gets a Test Base Draft Package.

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

list_by_test_base_account

Lists all the draft packages under a test base account.

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

INSERT examples

create

Creates or replaces a Test Base Draft Package.

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

Manifest

# Description fields are for documentation purposes
- name: draft_packages
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the draft_packages resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the draft_packages resource.
    - name: testBaseAccountName
      value: string
      description: Required parameter for the draft_packages resource.
    - name: draftPackageName
      value: string
      description: Required parameter for the draft_packages resource.
    - name: properties
      value: object
      description: |
        Test Base Draft Package properties.

UPDATE examples

update

Updates an existing Test Base Draft Package.

UPDATE azure_extras.test_base.draft_packages
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND testBaseAccountName = '{{ testBaseAccountName }}' --required
AND draftPackageName = '{{ draftPackageName }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes a Test Base Draft Package.

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

Lifecycle Methods

copy_from_package

Copy package file and metadata from a package to this draft package

EXEC azure_extras.test_base.draft_packages.copy_from_package 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@testBaseAccountName='{{ testBaseAccountName }}' --required, 
@draftPackageName='{{ draftPackageName }}' --required 
@@json=
'{
"packageId": "{{ packageId }}"
}'
;

extract_file

Performs extracting file operation for a Test Base Draft Package

EXEC azure_extras.test_base.draft_packages.extract_file 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@testBaseAccountName='{{ testBaseAccountName }}' --required, 
@draftPackageName='{{ draftPackageName }}' --required 
@@json=
'{
"fileType": "{{ fileType }}", 
"sourceFile": "{{ sourceFile }}", 
"intuneAppId": "{{ intuneAppId }}"
}'
;

generate_folders_and_scripts

Generates folders and scripts

EXEC azure_extras.test_base.draft_packages.generate_folders_and_scripts 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@testBaseAccountName='{{ testBaseAccountName }}' --required, 
@draftPackageName='{{ draftPackageName }}' --required 
@@json=
'{
"forceGenerate": {{ forceGenerate }}
}'
;