accounts

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

Overview

Name	accounts
Type	Resource
Id	azure.purview.accounts

Fields

vw_accounts

Name	Datatype	Description
id	text	Gets or sets the identifier.
name	text	Gets or sets the name.
accountName	text	field from the properties object
account_status	text	field from the properties object
cloud_connectors	text	field from the properties object
created_at	text	field from the properties object
created_by	text	field from the properties object
created_by_object_id	text	field from the properties object
default_domain	text	field from the properties object
endpoints	text	field from the properties object
friendly_name	text	field from the properties object
identity	text	The Managed Identity of the resource
ingestion_storage	text	field from the properties object
location	text	Gets or sets the location.
managed_event_hub_state	text	field from the properties object
managed_resource_group_name	text	field from the properties object
managed_resources	text	field from the properties object
managed_resources_public_network_access	text	field from the properties object
merge_info	text	field from the properties object
private_endpoint_connections	text	field from the properties object
provisioning_state	text	field from the properties object
public_network_access	text	field from the properties object
resourceGroupName	text	field from the properties object
sku	text	Gets or sets the Sku.
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Tags on the azure resource.
tenant_endpoint_state	text	field from the properties object
type	text	Gets or sets the type.

accounts

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	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

Name	Accessible by	Required Params	Description
get	SELECT	accountName, resourceGroupName, subscriptionId	Get an account
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	List accounts in ResourceGroup
list_by_subscription	SELECT	subscriptionId	List accounts in Subscription
create_or_update	INSERT	accountName, resourceGroupName, subscriptionId	Creates or updates an account
delete	DELETE	accountName, resourceGroupName, subscriptionId	Deletes an account resource
update	UPDATE	accountName, resourceGroupName, subscriptionId	Updates an account
add_root_collection_admin	EXEC	accountName, resourceGroupName, subscriptionId	Add the administrator for root collection associated with this account.
check_name_availability	EXEC	subscriptionId	Checks if account name is available.

SELECT examples

List accounts in Subscription

vw_accounts

SELECT
id,
name,
accountName,
account_status,
cloud_connectors,
created_at,
created_by,
created_by_object_id,
default_domain,
endpoints,
friendly_name,
identity,
ingestion_storage,
location,
managed_event_hub_state,
managed_resource_group_name,
managed_resources,
managed_resources_public_network_access,
merge_info,
private_endpoint_connections,
provisioning_state,
public_network_access,
resourceGroupName,
sku,
subscriptionId,
system_data,
tags,
tenant_endpoint_state,
type
FROM azure.purview.vw_accounts
WHERE subscriptionId = '{{ subscriptionId }}';

accounts

SELECT
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.purview.accounts
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new accounts resource.

All Properties

/*+ create */
INSERT INTO azure.purview.accounts (
accountName,
resourceGroupName,
subscriptionId,
identity,
location,
tags,
properties,
sku
)
SELECT 
'{{ accountName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ identity }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ sku }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: string
        - name: userAssignedIdentities
          value: object
    - name: location
      value: string
    - name: name
      value: string
    - name: systemData
      value: string
    - name: tags
      value: object
    - name: type
      value: string
    - name: properties
      value:
        - name: accountStatus
          value: string
        - name: cloudConnectors
          value:
            - name: awsExternalId
              value: string
        - name: createdAt
          value: string
        - name: createdBy
          value: string
        - name: createdByObjectId
          value: string
        - name: defaultDomain
          value: string
        - name: endpoints
          value: string
        - name: friendlyName
          value: string
        - name: ingestionStorage
          value:
            - name: id
              value: string
            - name: primaryEndpoint
              value: string
            - name: publicNetworkAccess
              value: string
        - name: managedEventHubState
          value: string
        - name: managedResourceGroupName
          value: string
        - name: managedResources
          value: string
        - name: managedResourcesPublicNetworkAccess
          value: string
        - name: mergeInfo
          value:
            - name: accountLocation
              value: string
            - name: accountName
              value: string
            - name: accountResourceGroupName
              value: string
            - name: accountSubscriptionId
              value: string
            - name: deprovisioned
              value: boolean
            - name: mergeStatus
              value: string
            - name: typeOfAccount
              value: string
        - name: privateEndpointConnections
          value:
            - - name: id
                value: string
              - name: name
                value: string
              - name: systemData
                value: string
              - name: type
                value: string
              - name: properties
                value:
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: actionsRequired
                        value: string
                      - name: description
                        value: string
                      - name: status
                        value: string
                  - name: provisioningState
                    value: string
        - name: provisioningState
          value: string
        - name: publicNetworkAccess
          value: string
        - name: tenantEndpointState
          value: string
    - name: sku
      value: string

UPDATE example

Updates a accounts resource.

/*+ update */
UPDATE azure.purview.accounts
SET 
identity = '{{ identity }}',
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified accounts resource.

/*+ delete */
DELETE FROM azure.purview.accounts
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';