accounts

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

Overview

Name	accounts
Type	Resource
Id	azure.autonomous_dev_platform.accounts

Fields

The following fields are returned by SELECT queries:

get

The ADP account properties were retrieved successfully

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	List of account properties
systemData	object	The system meta data relating to this resource
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	List of account properties
systemData	object	The system meta data relating to this resource
tags	object	Resource tags.

list

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	List of account properties
systemData	object	The system meta data relating to this resource
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, accountName		Gets the properties of an ADP account
list_by_resource_group	select	subscriptionId, resourceGroupName		List all ADP accounts available under the resource group
list	select	subscriptionId		List all ADP accounts available under the subscription
create_or_update	insert	subscriptionId, resourceGroupName, accountName		Creates or updates an ADP account
update	update	subscriptionId, resourceGroupName, accountName		Updates the properties of an existing ADP account
delete	delete	subscriptionId, resourceGroupName, accountName		Deletes an ADP account
check_name_availability	exec	subscriptionId, name, type		Checks that the account name 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
accountName	string	The name of the ADP account
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets the properties of an ADP account

SELECT
location,
properties,
systemData,
tags
FROM azure.autonomous_dev_platform.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
;

list_by_resource_group

List all ADP accounts available under the resource group

SELECT
location,
properties,
systemData,
tags
FROM azure.autonomous_dev_platform.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list

List all ADP accounts available under the subscription

SELECT
location,
properties,
systemData,
tags
FROM azure.autonomous_dev_platform.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates an ADP account

INSERT INTO azure.autonomous_dev_platform.accounts (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
accountName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}'
RETURNING
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: accounts
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the accounts resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the accounts resource.
    - name: accountName
      value: string
      description: Required parameter for the accounts resource.
    - name: properties
      value: object
      description: |
        List of account properties
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates the properties of an existing ADP account

UPDATE azure.autonomous_dev_platform.accounts
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
RETURNING
location,
properties,
systemData,
tags;

DELETE examples

delete

Deletes an ADP account

DELETE FROM azure.autonomous_dev_platform.accounts
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
;

Lifecycle Methods

check_name_availability

Checks that the account name is valid and is not already in use

EXEC azure.autonomous_dev_platform.accounts.check_name_availability 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;