accounts

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

Overview

Name	accounts
Type	Resource
Id	azure.purview.accounts

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Gets or sets the identifier.
name	string	Gets or sets the name.
identity	object	The Managed Identity of the resource
location	string	Gets or sets the location.
properties	object	The account properties
sku	object	The Sku
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Tags on the azure resource.
type	string	Gets or sets the type.

list_by_resource_group

Name	Datatype	Description
id	string	Gets or sets the identifier.
name	string	Gets or sets the name.
identity	object	The Managed Identity of the resource
location	string	Gets or sets the location.
properties	object	The account properties
sku	object	The Sku
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Tags on the azure resource.
type	string	Gets or sets the type.

list_by_subscription

Name	Datatype	Description
id	string	Gets or sets the identifier.
name	string	Gets or sets the name.
identity	object	The Managed Identity of the resource
location	string	Gets or sets the location.
properties	object	The account properties
sku	object	The Sku
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Tags on the azure resource.
type	string	Gets or sets the type.

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_or_update	insert	subscriptionId, resourceGroupName, accountName	api-version	Creates or updates an account
update	update	subscriptionId, resourceGroupName, accountName	api-version	Updates an account
delete	delete	subscriptionId, resourceGroupName, accountName	api-version	Deletes an account resource
add_root_collection_admin	exec	subscriptionId, resourceGroupName, accountName	api-version	Add the administrator for root collection associated with this account.
check_name_availability	exec	subscriptionId	api-version	Checks if account name is available.

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 account.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription identifier
$skipToken	string	The skip token.
api-version	string	The api version to use.

SELECT examples

get

Get an account

SELECT
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.purview.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
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.purview.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
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.purview.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Creates or updates an account

INSERT INTO azure.purview.accounts (
data__identity,
data__location,
data__tags,
data__properties,
data__sku,
subscriptionId,
resourceGroupName,
accountName,
api-version
)
SELECT 
'{{ identity }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ sku }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ api-version }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
;

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: identity
      value: object
      description: |
        The Managed Identity of the resource
    - name: location
      value: string
      description: |
        Gets or sets the location.
    - name: tags
      value: object
      description: |
        Tags on the azure resource.
    - name: properties
      value: object
      description: |
        The account properties
    - name: sku
      value: object
      description: |
        The Sku
    - name: api-version
      value: string
      description: The api version to use.

UPDATE examples

update

Updates an account

UPDATE azure.purview.accounts
SET 
data__identity = '{{ identity }}',
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes an account resource

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

Lifecycle Methods

add_root_collection_admin

Add the administrator for root collection associated with this account.

EXEC azure.purview.accounts.add_root_collection_admin 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"objectId": "{{ objectId }}"
}'
;

check_name_availability

Checks if account name is available.

EXEC azure.purview.accounts.check_name_availability 
@subscriptionId='{{ subscriptionId }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;