accounts

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

Overview

Name	accounts
Type	Resource
Id	azure_extras.power_platform.accounts

Fields

The following fields are returned by SELECT queries:

get

OK. Account found.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The properties that define configuration for the account.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list_by_resource_group

OK. Accounts listed.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The properties that define configuration for the account.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list_by_subscription

OK. Accounts listed.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The properties that define configuration for the account.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	accountName, subscriptionId, resourceGroupName		Get information about an account.
list_by_resource_group	select	subscriptionId, resourceGroupName		Retrieve a list of accounts within a given resource group.
list_by_subscription	select	subscriptionId		Retrieve a list of accounts within a subscription.
create_or_update	insert	accountName, subscriptionId, resourceGroupName		Creates an account.
update	update	accountName, subscriptionId, resourceGroupName		Updates an account.
delete	delete	accountName, subscriptionId, resourceGroupName		Delete an 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
accountName	string	Name of the 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

Get information about an account.

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

list_by_resource_group

Retrieve a list of accounts within a given resource group.

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

list_by_subscription

Retrieve a list of accounts within a subscription.

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

INSERT examples

create_or_update

Creates an account.

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

Manifest

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

UPDATE examples

update

Updates an account.

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

DELETE examples

delete

Delete an account.

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