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
- list_by_resource_group
- list_by_subscription
| Name | Datatype | Description |
|---|---|---|
id | string | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. |
name | string | The name of the resource. |
description | string | The description of the account. |
location | string | The geo-location where the resource lives. Required. |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
systemId | string | The internally assigned unique identifier of the resource. |
tags | object | Resource tags. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". |
| Name | Datatype | Description |
|---|---|---|
id | string | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. |
name | string | The name of the resource. |
description | string | The description of the account. |
location | string | The geo-location where the resource lives. Required. |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
systemId | string | The internally assigned unique identifier of the resource. |
tags | object | Resource tags. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". |
| Name | Datatype | Description |
|---|---|---|
id | string | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. |
name | string | The name of the resource. |
description | string | The description of the account. |
location | string | The geo-location where the resource lives. Required. |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
systemId | string | The internally assigned unique identifier of the resource. |
tags | object | Resource tags. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | account_name, resource_group_name, subscription_id | Get information about an account. | |
list_by_resource_group | select | resource_group_name, subscription_id | Retrieve a list of accounts within a given resource group. | |
list_by_subscription | select | subscription_id | Retrieve a list of accounts within a subscription. | |
create_or_update | insert | account_name, resource_group_name, subscription_id, location | Creates an account. | |
update | update | account_name, resource_group_name, subscription_id | Updates an account. | |
create_or_update | replace | account_name, resource_group_name, subscription_id, location | Creates an account. | |
delete | delete | account_name, resource_group_name, subscription_id | 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 |
|---|---|---|
account_name | string | Name of the account. Required. |
resource_group_name | string | The name of the resource group. The name is case insensitive. Required. |
subscription_id | string |
SELECT examples
- get
- list_by_resource_group
- list_by_subscription
Get information about an account.
SELECT
id,
name,
description,
location,
systemData,
systemId,
tags,
type
FROM azure_extras.power_platform.accounts
WHERE account_name = '{{ account_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
Retrieve a list of accounts within a given resource group.
SELECT
id,
name,
description,
location,
systemData,
systemId,
tags,
type
FROM azure_extras.power_platform.accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
Retrieve a list of accounts within a subscription.
SELECT
id,
name,
description,
location,
systemData,
systemId,
tags,
type
FROM azure_extras.power_platform.accounts
WHERE subscription_id = '{{ subscription_id }}' -- required
;
INSERT examples
- create_or_update
- Manifest
Creates an account.
INSERT INTO azure_extras.power_platform.accounts (
tags,
location,
properties,
account_name,
resource_group_name,
subscription_id
)
SELECT
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ account_name }}',
'{{ resource_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;
# Description fields are for documentation purposes
- name: accounts
props:
- name: account_name
value: "{{ account_name }}"
description: Required parameter for the accounts resource.
- name: resource_group_name
value: "{{ resource_group_name }}"
description: Required parameter for the accounts resource.
- name: subscription_id
value: "{{ subscription_id }}"
description: Required parameter for the accounts resource.
- name: tags
value: "{{ tags }}"
description: |
Resource tags.
- name: location
value: "{{ location }}"
description: |
The geo-location where the resource lives. Required.
- name: properties
description: |
The properties that define configuration for the account.
value:
systemId: "{{ systemId }}"
description: "{{ description }}"
UPDATE examples
- update
Updates an account.
UPDATE azure_extras.power_platform.accounts
SET
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE
account_name = '{{ account_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;
REPLACE examples
- create_or_update
Creates an account.
REPLACE azure_extras.power_platform.accounts
SET
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE
account_name = '{{ account_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;
DELETE examples
- delete
Delete an account.
DELETE FROM azure_extras.power_platform.accounts
WHERE account_name = '{{ account_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;