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
identity	object	Identity Info on the Account
location	string	Location of the azure resource.
properties	object	Properties on the account
tags	object	Tags on the azure resource.

list_by_resource_group

Name	Datatype	Description
identity	object	Identity Info on the Account
location	string	Location of the azure resource.
properties	object	Properties on the account
tags	object	Tags on the azure resource.

list_by_subscription

Name	Datatype	Description
identity	object	Identity Info on the Account
location	string	Location of the azure resource.
properties	object	Properties on the account
tags	object	Tags on the azure resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName	api-version	Get an account
list_by_resource_group	select	subscriptionId, resourceGroupName	api-version, $skipToken	List Accounts in ResourceGroup
list_by_subscription	select	subscriptionId	api-version, $skipToken	List Accounts in Subscription
create	insert	subscriptionId, resourceGroupName, accountName, data__identity	api-version	Create an account
update	update	subscriptionId, resourceGroupName, accountName	api-version	Patch an account
delete	delete	subscriptionId, resourceGroupName, accountName	api-version	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
accountName	string	The name of the share account.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription identifier
$skipToken	string	Continuation token
api-version	string	The api version to use.

SELECT examples

get

Get an account

SELECT
identity,
location,
properties,
tags
FROM azure.data_share.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_resource_group

List Accounts in ResourceGroup

SELECT
identity,
location,
properties,
tags
FROM azure.data_share.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
AND $skipToken = '{{ $skipToken }}'
;

list_by_subscription

List Accounts in Subscription

SELECT
identity,
location,
properties,
tags
FROM azure.data_share.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create

Create an account

INSERT INTO azure.data_share.accounts (
data__location,
data__tags,
data__identity,
data__properties,
subscriptionId,
resourceGroupName,
accountName,
api-version
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ identity }}' /* required */,
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ api-version }}'
RETURNING
identity,
location,
properties,
tags
;

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: accountName
      value: string
      description: Required parameter for the accounts resource.
    - name: location
      value: string
      description: |
        Location of the azure resource.
    - name: tags
      value: object
      description: |
        Tags on the azure resource.
    - name: identity
      value: object
      description: |
        Identity Info on the Account
    - name: properties
      value: object
      description: |
        Properties on the account
    - name: api-version
      value: string
      description: The api version to use.

UPDATE examples

update

Patch an account

UPDATE azure.data_share.accounts
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
identity,
location,
properties,
tags;

DELETE examples

delete

DeleteAccount

DELETE FROM azure.data_share.accounts
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND api-version = '{{ api-version }}'
;