test_base_accounts

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

Overview

Name	test_base_accounts
Type	Resource
Id	azure_extras.testbase.test_base_accounts

Fields

The following fields are returned by SELECT queries:

check_package_name_availability

Name	Datatype	Description
message	string	The detailed info regarding the reason associated with the name. Required if nameAvailable == false.
nameAvailable	boolean	Value indicating the availability of the name: true if the name is available; otherwise, false.
reason	string	The reason for unavailability of a name. Required if nameAvailable == false. Known values are: "Invalid" and "AlreadyExists".

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
accessLevel	string	The access level of the Test Base Account.
etag	string	Resource Etag.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", "Cancelled", "Creating", "Deleting", and "Updating".
sku	object	Describes a Test Base Account SKU. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure.
systemData	object	The system metadata relating to this resource.
tags	object	The tags of the resource.
type	string	Resource type.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
accessLevel	string	The access level of the Test Base Account.
etag	string	Resource Etag.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", "Cancelled", "Creating", "Deleting", and "Updating".
sku	object	Describes a Test Base Account SKU. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure.
systemData	object	The system metadata relating to this resource.
tags	object	The tags of the resource.
type	string	Resource type.

list_by_subscription

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
accessLevel	string	The access level of the Test Base Account.
etag	string	Resource Etag.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", "Cancelled", "Creating", "Deleting", and "Updating".
sku	object	Describes a Test Base Account SKU. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure.
systemData	object	The system metadata relating to this resource.
tags	object	The tags of the resource.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
check_package_name_availability	select	resource_group_name, test_base_account_name, subscription_id		Checks that the Test Base Package name and version is valid and is not already in use.
get	select	resource_group_name, test_base_account_name, subscription_id		Gets a Test Base Account.
list_by_resource_group	select	resource_group_name, subscription_id	getDeleted	Lists all the Test Base Accounts in a resource group.
list_by_subscription	select	subscription_id	getDeleted	Lists all the Test Base Accounts in a subscription. This API is required by ARM guidelines.
create	insert	resource_group_name, test_base_account_name, subscription_id, location	restore	Create or replace (overwrite/recreate, with potential downtime) a Test Base Account in the specified subscription.
update	update	resource_group_name, test_base_account_name, subscription_id		Update an existing Test Base Account.
delete	delete	resource_group_name, test_base_account_name, subscription_id		Deletes a Test Base Account.
get_file_upload_url	exec	resource_group_name, test_base_account_name, subscription_id		Gets the file upload URL of a Test Base Account.
offboard	exec	resource_group_name, test_base_account_name, subscription_id		Offboard a Test Base Account.

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
resource_group_name	string	The name of the resource group that contains the resource. Required.
subscription_id	string
test_base_account_name	string	The resource name of the Test Base Account. Required.
getDeleted	boolean	The flag indicating if we need to include the Test Base Accounts which were soft deleted before. Default value is None.
restore	boolean	The flag indicating if we would like to restore the Test Base Accounts which were soft deleted before. Default value is None.

SELECT examples

check_package_name_availability

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

SELECT
message,
nameAvailable,
reason
FROM azure_extras.testbase.test_base_accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND test_base_account_name = '{{ test_base_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Gets a Test Base Account.

SELECT
id,
name,
accessLevel,
etag,
location,
provisioningState,
sku,
systemData,
tags,
type
FROM azure_extras.testbase.test_base_accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND test_base_account_name = '{{ test_base_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all the Test Base Accounts in a resource group.

SELECT
id,
name,
accessLevel,
etag,
location,
provisioningState,
sku,
systemData,
tags,
type
FROM azure_extras.testbase.test_base_accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND getDeleted = '{{ getDeleted }}'
;

list_by_subscription

Lists all the Test Base Accounts in a subscription. This API is required by ARM guidelines.

SELECT
id,
name,
accessLevel,
etag,
location,
provisioningState,
sku,
systemData,
tags,
type
FROM azure_extras.testbase.test_base_accounts
WHERE subscription_id = '{{ subscription_id }}' -- 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.testbase.test_base_accounts (
tags,
location,
properties,
resource_group_name,
test_base_account_name,
subscription_id,
restore
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ test_base_account_name }}',
'{{ subscription_id }}',
'{{ restore }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: test_base_accounts
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the test_base_accounts resource.
  - name: test_base_account_name
    value: "{{ test_base_account_name }}"
    description: Required parameter for the test_base_accounts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the test_base_accounts resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      The tags of the resource.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    value:
      sku:
        resourceType: "{{ resourceType }}"
        name: "{{ name }}"
        tier: "{{ tier }}"
        capabilities:
          - name: "{{ name }}"
            value: "{{ value }}"
        locations:
          - "{{ locations }}"
  - name: restore
    value: {{ restore }}
    description: The flag indicating if we would like to restore the Test Base Accounts which were soft deleted before. Default value is None.
    description: The flag indicating if we would like to restore the Test Base Accounts which were soft deleted before. Default value is None.

UPDATE examples

update

Update an existing Test Base Account.

UPDATE azure_extras.testbase.test_base_accounts
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND test_base_account_name = '{{ test_base_account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a Test Base Account.

DELETE FROM azure_extras.testbase.test_base_accounts
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND test_base_account_name = '{{ test_base_account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_file_upload_url

Gets the file upload URL of a Test Base Account.

EXEC azure_extras.testbase.test_base_accounts.get_file_upload_url 
@resource_group_name='{{ resource_group_name }}' --required, 
@test_base_account_name='{{ test_base_account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"blobName": "{{ blobName }}"
}'
;

offboard

Offboard a Test Base Account.

EXEC azure_extras.testbase.test_base_accounts.offboard 
@resource_group_name='{{ resource_group_name }}' --required, 
@test_base_account_name='{{ test_base_account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;