accounts

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

Overview

Name	accounts
Type	Resource
Id	azure.data_share.accounts

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The resource id of the azure resource.
name	string	Name of the azure resource.
createdAt	string (date-time)	Time at which the account was created.
identity	object	Identity Info on the Account. Required.
location	string	Location of the azure resource.
provisioningState	string	Provisioning state of the Account. Known values are: "Succeeded", "Creating", "Deleting", "Moving", and "Failed".
systemData	object	System Data of the Azure resource.
tags	object	Tags on the azure resource.
type	string	Type of the azure resource.
userEmail	string	Email of the user who created the resource.
userName	string	Name of the user who created the resource.

list_by_resource_group

Name	Datatype	Description
id	string	The resource id of the azure resource.
name	string	Name of the azure resource.
createdAt	string (date-time)	Time at which the account was created.
identity	object	Identity Info on the Account. Required.
location	string	Location of the azure resource.
provisioningState	string	Provisioning state of the Account. Known values are: "Succeeded", "Creating", "Deleting", "Moving", and "Failed".
systemData	object	System Data of the Azure resource.
tags	object	Tags on the azure resource.
type	string	Type of the azure resource.
userEmail	string	Email of the user who created the resource.
userName	string	Name of the user who created the resource.

list_by_subscription

Name	Datatype	Description
id	string	The resource id of the azure resource.
name	string	Name of the azure resource.
createdAt	string (date-time)	Time at which the account was created.
identity	object	Identity Info on the Account. Required.
location	string	Location of the azure resource.
provisioningState	string	Provisioning state of the Account. Known values are: "Succeeded", "Creating", "Deleting", "Moving", and "Failed".
systemData	object	System Data of the Azure resource.
tags	object	Tags on the azure resource.
type	string	Type of the azure resource.
userEmail	string	Email of the user who created the resource.
userName	string	Name of the user who created the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, subscription_id		Get an account under a resource group. Get an account.
list_by_resource_group	select	resource_group_name, subscription_id	$skipToken	List Accounts in a resource group. List Accounts in ResourceGroup.
list_by_subscription	select	subscription_id	$skipToken	List Accounts in a subscription. List Accounts in Subscription.
create	insert	resource_group_name, account_name, subscription_id, identity		Create an account in the given resource group. Create an account.
update	update	resource_group_name, account_name, subscription_id		Patch a given account. Patch an account.
delete	delete	resource_group_name, account_name, subscription_id		Delete an account. DeleteAccount.

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	The name of the share account. Required.
resource_group_name	string	The resource group name. Required.
subscription_id	string
$skipToken	string	Continuation token. Default value is None.

SELECT examples

get

Get an account under a resource group. Get an account.

SELECT
id,
name,
createdAt,
identity,
location,
provisioningState,
systemData,
tags,
type,
userEmail,
userName
FROM azure.data_share.accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List Accounts in a resource group. List Accounts in ResourceGroup.

SELECT
id,
name,
createdAt,
identity,
location,
provisioningState,
systemData,
tags,
type,
userEmail,
userName
FROM azure.data_share.accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skipToken = '{{ $skipToken }}'
;

list_by_subscription

List Accounts in a subscription. List Accounts in Subscription.

SELECT
id,
name,
createdAt,
identity,
location,
provisioningState,
systemData,
tags,
type,
userEmail,
userName
FROM azure.data_share.accounts
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create

Create an account in the given resource group. Create an account.

INSERT INTO azure.data_share.accounts (
location,
tags,
identity,
resource_group_name,
account_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ identity }}' /* required */,
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: accounts
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the accounts resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the accounts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the accounts resource.
  - name: location
    value: "{{ location }}"
    description: |
      Location of the azure resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Tags on the azure resource.
  - name: identity
    description: |
      Identity Info on the Account. Required.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"

UPDATE examples

update

Patch a given account. Patch an account.

UPDATE azure.data_share.accounts
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete an account. DeleteAccount.

DELETE FROM azure.data_share.accounts
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;