accounts

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

Overview

Name	accounts
Type	Resource
Id	azure_extras.test_base.accounts

Fields

The following fields are returned by SELECT queries:

get

The Test Base Account was successfully found.

Name	Datatype	Description
identity	object	The identity of the testBaseAccount.
location	string	The geo-location where the resource lives
properties	object	Properties of a Test Base Account.
tags	object	Resource tags.

list_by_resource_group

The operation is completed.

Name	Datatype	Description
identity	object	The identity of the testBaseAccount.
location	string	The geo-location where the resource lives
properties	object	Properties of a Test Base Account.
tags	object	Resource tags.

list_by_subscription

The operation is completed.

Name	Datatype	Description
identity	object	The identity of the testBaseAccount.
location	string	The geo-location where the resource lives
properties	object	Properties of a Test Base Account.
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		Gets a Test Base Account.
list_by_resource_group	select	subscriptionId, resourceGroupName	getDeleted	Lists all the Test Base Accounts in a resource group.
list_by_subscription	select	subscriptionId	getDeleted	Lists all the Test Base Accounts in a subscription.
create	insert	subscriptionId, resourceGroupName, testBaseAccountName	restore	Create or replace (overwrite/recreate, with potential downtime) a Test Base Account in the specified subscription.
update	update	subscriptionId, resourceGroupName, testBaseAccountName		Update an existing Test Base Account.
delete	delete	subscriptionId, resourceGroupName, testBaseAccountName		Deletes a Test Base Account.
offboard	exec	subscriptionId, resourceGroupName, testBaseAccountName		Offboard a Test Base Account.
check_package_name_availability	exec	subscriptionId, resourceGroupName, testBaseAccountName, name, applicationName, version		Checks that the Test Base Package name and version is valid and is not already in use.

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
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.
getDeleted	boolean	The flag indicating if we need to include the Test Base Accounts which were soft deleted before.
restore	boolean	The flag indicating if we would like to restore the Test Base Accounts which were soft deleted before.

SELECT examples

get

Gets a Test Base Account.

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

list_by_resource_group

Lists all the Test Base Accounts in a resource group.

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

list_by_subscription

Lists all the Test Base Accounts in a subscription.

SELECT
identity,
location,
properties,
tags
FROM azure_extras.test_base.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND getDeleted = '{{ getDeleted }}'
;

INSERT examples

create

Create or replace (overwrite/recreate, with potential downtime) a Test Base Account in the specified subscription.

INSERT INTO azure_extras.test_base.accounts (
data__properties,
data__identity,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
testBaseAccountName,
restore
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ testBaseAccountName }}',
'{{ restore }}'
RETURNING
identity,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: accounts
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the accounts resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the accounts resource.
    - name: testBaseAccountName
      value: string
      description: Required parameter for the accounts resource.
    - name: properties
      value: object
      description: |
        Properties of a Test Base Account.
    - name: identity
      value: object
      description: |
        The identity of the testBaseAccount.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: restore
      value: boolean
      description: The flag indicating if we would like to restore the Test Base Accounts which were soft deleted before.

UPDATE examples

update

Update an existing Test Base Account.

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

DELETE examples

delete

Deletes a Test Base Account.

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

Lifecycle Methods

offboard

Offboard a Test Base Account.

EXEC azure_extras.test_base.accounts.offboard 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@testBaseAccountName='{{ testBaseAccountName }}' --required
;

check_package_name_availability

Checks that the Test Base Package name and version is valid and is not already in use.

EXEC azure_extras.test_base.accounts.check_package_name_availability 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@testBaseAccountName='{{ testBaseAccountName }}' --required 
@@json=
'{
"name": "{{ name }}", 
"applicationName": "{{ applicationName }}", 
"version": "{{ version }}", 
"type": "{{ type }}"
}'
;