credentials

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

Overview

Name	credentials
Type	Resource
Id	azure_extras.test_base.credentials

Fields

The following fields are returned by SELECT queries:

get

Get the test base Credential.

Name	Datatype	Description
properties	object	The test base credential properties.

list_by_test_base_account

The operation is completed.

Name	Datatype	Description
properties	object	The test base credential properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, testBaseAccountName, credentialName		Gets a test base credential Resource
list_by_test_base_account	select	subscriptionId, resourceGroupName, testBaseAccountName		Lists all the Credentials under a Test Base Account.
create	insert	subscriptionId, resourceGroupName, testBaseAccountName, credentialName		Creates or replaces a Test Base Credential.
update	update	subscriptionId, resourceGroupName, testBaseAccountName, credentialName		Updates an existing test base credential.
delete	delete	subscriptionId, resourceGroupName, testBaseAccountName, credentialName		Deletes an existing test base credential.

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
credentialName	string	The credential resource name.
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 credential Resource

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

list_by_test_base_account

Lists all the Credentials under a Test Base Account.

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

INSERT examples

create

Creates or replaces a Test Base Credential.

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

Manifest

# Description fields are for documentation purposes
- name: credentials
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the credentials resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the credentials resource.
    - name: testBaseAccountName
      value: string
      description: Required parameter for the credentials resource.
    - name: credentialName
      value: string
      description: Required parameter for the credentials resource.
    - name: properties
      value: object
      description: |
        The test base credential properties.

UPDATE examples

update

Updates an existing test base credential.

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

DELETE examples

delete

Deletes an existing test base credential.

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