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.
cloudConnectors	object	Cloud connectors. External cloud identifier used as part of scanning configuration.
createdAt	string (date-time)	Gets the time at which the entity was created.
createdBy	string	Gets the creator of the entity.
createdByObjectId	string	Gets the creators of the entity's object id.
endpoints	object	The URIs that are the public endpoints of the account.
friendlyName	string	Gets or sets the friendly name.
identity	object	Identity Info on the tracked resource.
location	string	Gets or sets the location.
managedResourceGroupName	string	Gets or sets the managed resource group name.
managedResources	object	Gets the resource identifiers of the managed resources.
privateEndpointConnections	array	Gets the private endpoint connections information.
provisioningState	string	Gets or sets the state of the provisioning. Known values are: "Unknown", "Creating", "Moving", "Deleting", "SoftDeleting", "SoftDeleted", "Failed", "Succeeded", and "Canceled".
publicNetworkAccess	string	Gets or sets the public network access. Known values are: "NotSpecified", "Enabled", and "Disabled".
sku	object	Gets or sets 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.
cloudConnectors	object	Cloud connectors. External cloud identifier used as part of scanning configuration.
createdAt	string (date-time)	Gets the time at which the entity was created.
createdBy	string	Gets the creator of the entity.
createdByObjectId	string	Gets the creators of the entity's object id.
endpoints	object	The URIs that are the public endpoints of the account.
friendlyName	string	Gets or sets the friendly name.
identity	object	Identity Info on the tracked resource.
location	string	Gets or sets the location.
managedResourceGroupName	string	Gets or sets the managed resource group name.
managedResources	object	Gets the resource identifiers of the managed resources.
privateEndpointConnections	array	Gets the private endpoint connections information.
provisioningState	string	Gets or sets the state of the provisioning. Known values are: "Unknown", "Creating", "Moving", "Deleting", "SoftDeleting", "SoftDeleted", "Failed", "Succeeded", and "Canceled".
publicNetworkAccess	string	Gets or sets the public network access. Known values are: "NotSpecified", "Enabled", and "Disabled".
sku	object	Gets or sets 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.
cloudConnectors	object	Cloud connectors. External cloud identifier used as part of scanning configuration.
createdAt	string (date-time)	Gets the time at which the entity was created.
createdBy	string	Gets the creator of the entity.
createdByObjectId	string	Gets the creators of the entity's object id.
endpoints	object	The URIs that are the public endpoints of the account.
friendlyName	string	Gets or sets the friendly name.
identity	object	Identity Info on the tracked resource.
location	string	Gets or sets the location.
managedResourceGroupName	string	Gets or sets the managed resource group name.
managedResources	object	Gets the resource identifiers of the managed resources.
privateEndpointConnections	array	Gets the private endpoint connections information.
provisioningState	string	Gets or sets the state of the provisioning. Known values are: "Unknown", "Creating", "Moving", "Deleting", "SoftDeleting", "SoftDeleted", "Failed", "Succeeded", and "Canceled".
publicNetworkAccess	string	Gets or sets the public network access. Known values are: "NotSpecified", "Enabled", and "Disabled".
sku	object	Gets or sets 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	resource_group_name, account_name, subscription_id		Gets the account resource. Get an account.
list_by_resource_group	select	resource_group_name, subscription_id	$skipToken	Gets the accounts resources by resource group. List accounts in ResourceGroup.
list_by_subscription	select	subscription_id	$skipToken	Gets the accounts resources by subscription. List accounts in Subscription.
create_or_update	insert	resource_group_name, account_name, subscription_id		Create or update an account resource. Creates or updates an account.
update	update	resource_group_name, account_name, subscription_id		Patches the account resource. Updates an account.
create_or_update	replace	resource_group_name, account_name, subscription_id		Create or update an account resource. Creates or updates an account.
delete	delete	resource_group_name, account_name, subscription_id		Deletes the account resource. Deletes an account resource.
list_keys	exec	resource_group_name, account_name, subscription_id		Lists the keys asynchronous. List the authorization keys associated with this account.
add_root_collection_admin	exec	resource_group_name, account_name, subscription_id		Add the administrator for root collection. Add the administrator for root collection associated with this account.
check_name_availability	exec	subscription_id		Checks the account name availability. 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
account_name	string	The name of the account. Required.
resource_group_name	string	The resource group name. Required.
subscription_id	string
$skipToken	string	The skip token. Default value is None.

SELECT examples

get

Gets the account resource. Get an account.

SELECT
id,
name,
cloudConnectors,
createdAt,
createdBy,
createdByObjectId,
endpoints,
friendlyName,
identity,
location,
managedResourceGroupName,
managedResources,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
type
FROM azure.purview.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

Gets the accounts resources by resource group. List accounts in ResourceGroup.

SELECT
id,
name,
cloudConnectors,
createdAt,
createdBy,
createdByObjectId,
endpoints,
friendlyName,
identity,
location,
managedResourceGroupName,
managedResources,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
type
FROM azure.purview.accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skipToken = '{{ $skipToken }}'
;

list_by_subscription

Gets the accounts resources by subscription. List accounts in Subscription.

SELECT
id,
name,
cloudConnectors,
createdAt,
createdBy,
createdByObjectId,
endpoints,
friendlyName,
identity,
location,
managedResourceGroupName,
managedResources,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
type
FROM azure.purview.accounts
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Create or update an account resource. Creates or updates an account.

INSERT INTO azure.purview.accounts (
identity,
location,
tags,
properties,
resource_group_name,
account_name,
subscription_id
)
SELECT 
'{{ identity }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
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: identity
    description: |
      Identity Info on the tracked resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: location
    value: "{{ location }}"
    description: |
      Gets or sets the location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Tags on the azure resource.
  - name: properties
    value:
      cloudConnectors:
        awsExternalId: "{{ awsExternalId }}"
      managedResourceGroupName: "{{ managedResourceGroupName }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"

UPDATE examples

update

Patches the account resource. Updates an account.

UPDATE azure.purview.accounts
SET 
identity = '{{ identity }}',
properties = '{{ properties }}',
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,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update an account resource. Creates or updates an account.

REPLACE azure.purview.accounts
SET 
identity = '{{ identity }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
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,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes the account resource. Deletes an account resource.

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

Lifecycle Methods

list_keys

Lists the keys asynchronous. List the authorization keys associated with this account.

EXEC azure.purview.accounts.list_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

add_root_collection_admin

Add the administrator for root collection. Add the administrator for root collection associated with this account.

EXEC azure.purview.accounts.add_root_collection_admin 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"objectId": "{{ objectId }}"
}'
;

check_name_availability

Checks the account name availability. Checks if account name is available.

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