accounts

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

Overview

Name	accounts
Type	Resource
Id	azure.graph_services.accounts

Fields

The following fields are returned by SELECT queries:

get

Account details.

Name	Datatype	Description
id	string	Azure resource ID.
name	string	Azure resource name.
location	string	Location of the resource.
properties	object	Property bag from billing account
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	resource tags.
type	string	Azure resource type.

list_by_resource_group

Account details.

Name	Datatype	Description
id	string	Azure resource ID.
name	string	Azure resource name.
location	string	Location of the resource.
properties	object	Property bag from billing account
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	resource tags.
type	string	Azure resource type.

list_by_subscription

Account details.

Name	Datatype	Description
id	string	Azure resource ID.
name	string	Azure resource name.
location	string	Location of the resource.
properties	object	Property bag from billing account
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	resource tags.
type	string	Azure resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName		Returns account resource for a given name.
list_by_resource_group	select	subscriptionId, resourceGroupName		Returns list of accounts apps.
list_by_subscription	select	subscriptionId		Returns list of accounts belonging to a subscription.
create_and_update	insert	subscriptionId, resourceGroupName, resourceName, data__properties		Create or update account resource.
update	update	subscriptionId, resourceGroupName, resourceName		Update account details.
delete	delete	subscriptionId, resourceGroupName, resourceName		Deletes a account resource.

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.
resourceName	string	The name of the resource.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Returns account resource for a given name.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.graph_services.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

list_by_resource_group

Returns list of accounts apps.

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

list_by_subscription

Returns list of accounts belonging to a subscription.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.graph_services.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_and_update

Create or update account resource.

INSERT INTO azure.graph_services.accounts (
data__location,
data__tags,
data__properties,
subscriptionId,
resourceGroupName,
resourceName
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

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: resourceName
      value: string
      description: Required parameter for the accounts resource.
    - name: location
      value: string
      description: |
        Location of the resource.
    - name: tags
      value: object
      description: |
        resource tags.
    - name: properties
      value: object
      description: |
        Property bag from billing account

UPDATE examples

update

Update account details.

UPDATE azure.graph_services.accounts
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a account resource.

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