adc_catalogs

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

Overview

Name	adc_catalogs
Type	Resource
Id	azure.data_catalog.adc_catalogs

Fields

The following fields are returned by SELECT queries:

get

HTTP 200 (OK) if the operation was successful.

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
etag	string	Resource etag
location	string	Resource location
properties	object	Azure Data Catalog properties.
tags	object	Resource tags
type	string	Resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, catalogName		The Get Azure Data Catalog Service operation retrieves a json representation of the data catalog.
create_or_update	insert	subscriptionId, resourceGroupName, catalogName		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.
update	update	subscriptionId, resourceGroupName, catalogName		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.
delete	delete	subscriptionId, resourceGroupName, catalogName		The Delete Azure Data Catalog Service operation deletes an existing data catalog.

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
catalogName	string	The name of the data catalog in the specified subscription and resource group.
resourceGroupName	string	The name of the resource group within the user's subscription. The name is case insensitive.
subscriptionId	string	Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

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

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

INSERT examples

create_or_update

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.

INSERT INTO azure.data_catalog.adc_catalogs (
data__properties,
data__location,
data__tags,
data__etag,
subscriptionId,
resourceGroupName,
catalogName
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ etag }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ catalogName }}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: adc_catalogs
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the adc_catalogs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the adc_catalogs resource.
    - name: catalogName
      value: string
      description: Required parameter for the adc_catalogs resource.
    - name: properties
      value: object
      description: |
        Azure Data Catalog properties.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags
    - name: etag
      value: string
      description: |
        Resource etag

UPDATE examples

update

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.

UPDATE azure.data_catalog.adc_catalogs
SET 
data__properties = '{{ properties }}',
data__location = '{{ location }}',
data__tags = '{{ tags }}',
data__etag = '{{ etag }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND catalogName = '{{ catalogName }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

DELETE examples

delete

The Delete Azure Data Catalog Service operation deletes an existing data catalog.

DELETE FROM azure.data_catalog.adc_catalogs
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND catalogName = '{{ catalogName }}' --required
;