accounts

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

Overview

Name	accounts
Type	Resource
Id	azure_extras.graph_services.accounts

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Azure resource ID.
name	string	Azure resource name.
appId	string	Customer owned application ID. Required.
billingPlanId	string	Billing Plan Id.
location	string	Location of the resource.
provisioningState	string	Provisioning state. Known values are: "Succeeded", "Failed", and "Canceled".
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

Name	Datatype	Description
id	string	Azure resource ID.
name	string	Azure resource name.
appId	string	Customer owned application ID. Required.
billingPlanId	string	Billing Plan Id.
location	string	Location of the resource.
provisioningState	string	Provisioning state. Known values are: "Succeeded", "Failed", and "Canceled".
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	resource tags.
type	string	Azure resource type.

list_by_subscription

Name	Datatype	Description
id	string	Azure resource ID.
name	string	Azure resource name.
appId	string	Customer owned application ID. Required.
billingPlanId	string	Billing Plan Id.
location	string	Location of the resource.
provisioningState	string	Provisioning state. Known values are: "Succeeded", "Failed", and "Canceled".
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	resource_group_name, resource_name, subscription_id		Returns account resource for a given name.
list_by_resource_group	select	resource_group_name, subscription_id		Returns list of accounts apps.
list_by_subscription	select	subscription_id		Returns list of accounts belonging to a subscription.
update	update	resource_group_name, resource_name, subscription_id		Update account details.
delete	delete	resource_group_name, resource_name, subscription_id		Deletes a account resource.
create_and_update	exec	resource_group_name, resource_name, subscription_id, properties		Create or update 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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the resource. Required.
subscription_id	string

SELECT examples

get

Returns account resource for a given name.

SELECT
id,
name,
appId,
billingPlanId,
location,
provisioningState,
systemData,
tags,
type
FROM azure_extras.graph_services.accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Returns list of accounts apps.

SELECT
id,
name,
appId,
billingPlanId,
location,
provisioningState,
systemData,
tags,
type
FROM azure_extras.graph_services.accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Returns list of accounts belonging to a subscription.

SELECT
id,
name,
appId,
billingPlanId,
location,
provisioningState,
systemData,
tags,
type
FROM azure_extras.graph_services.accounts
WHERE subscription_id = '{{ subscription_id }}' -- required
;

UPDATE examples

update

Update account details.

UPDATE azure_extras.graph_services.accounts
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a account resource.

DELETE FROM azure_extras.graph_services.accounts
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

create_and_update

Create or update account resource.

EXEC azure_extras.graph_services.accounts.create_and_update 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"properties": "{{ properties }}"
}'
;