adc_catalogs

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

Overview

Name	adc_catalogs
Type	Resource
Id	azure.data_catalog.adc_catalogs

Fields

vw_adc_catalogs

Name	Datatype	Description
id	text	Resource Id
name	text	Resource name
admins	text	field from the properties object
catalogName	text	field from the properties object
enable_automatic_unit_adjustment	text	field from the properties object
etag	text	Resource etag
location	text	Resource location
resourceGroupName	text	field from the properties object
sku	text	field from the properties object
subscriptionId	text	field from the properties object
successfully_provisioned	text	field from the properties object
tags	text	Resource tags
type	text	Resource type
units	text	field from the properties object
users	text	field from the properties object

adc_catalogs

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
etag	string	Resource etag
location	string	Resource location
properties	object	Properties of the data catalog.
tags	object	Resource tags
type	string	Resource type

Methods

Name	Accessible by	Required Params	Description
get	SELECT	catalogName, resourceGroupName, subscriptionId	The Get Azure Data Catalog Service operation retrieves a json representation of the data catalog.
create_or_update	INSERT	catalogName, resourceGroupName, subscriptionId	The Create Azure Data Catalog service operation creates a new data catalog service with the specified parameters. If the specific service already exists, then any patchable properties will be updated and any immutable properties will remain unchanged.
delete	DELETE	catalogName, resourceGroupName, subscriptionId	The Delete Azure Data Catalog Service operation deletes an existing data catalog.
update	UPDATE	catalogName, resourceGroupName, subscriptionId	The Update Azure Data Catalog Service operation can be used to update the existing deployment. The update call only supports the properties listed in the PATCH body.

SELECT examples

The Get Azure Data Catalog Service operation retrieves a json representation of the data catalog.

vw_adc_catalogs

SELECT
id,
name,
admins,
catalogName,
enable_automatic_unit_adjustment,
etag,
location,
resourceGroupName,
sku,
subscriptionId,
successfully_provisioned,
tags,
type,
units,
users
FROM azure.data_catalog.vw_adc_catalogs
WHERE catalogName = '{{ catalogName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

adc_catalogs

SELECT
id,
name,
etag,
location,
properties,
tags,
type
FROM azure.data_catalog.adc_catalogs
WHERE catalogName = '{{ catalogName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.data_catalog.adc_catalogs (
catalogName,
resourceGroupName,
subscriptionId,
properties,
location,
tags,
etag
)
SELECT 
'{{ catalogName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ etag }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: sku
          value: string
        - name: units
          value: integer
        - name: admins
          value:
            - - name: upn
                value: string
              - name: objectId
                value: string
        - name: users
          value:
            - - name: upn
                value: string
              - name: objectId
                value: string
        - name: successfullyProvisioned
          value: boolean
        - name: enableAutomaticUnitAdjustment
          value: boolean
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object
    - name: etag
      value: string

UPDATE example

Updates a adc_catalogs resource.

/*+ update */
UPDATE azure.data_catalog.adc_catalogs
SET 
properties = '{{ properties }}',
location = '{{ location }}',
tags = '{{ tags }}',
etag = '{{ etag }}'
WHERE 
catalogName = '{{ catalogName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified adc_catalogs resource.

/*+ delete */
DELETE FROM azure.data_catalog.adc_catalogs
WHERE catalogName = '{{ catalogName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';