collection

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

Overview

Name	collection
Type	Resource
Id	azure.purview_catalog.collection

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_or_update	insert	collection, endpoint		Creates or updates an entity to a collection. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array>, array>.
create_or_update	replace	collection, endpoint		Creates or updates an entity to a collection. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array>, array>.
create_or_update_bulk	exec	collection, endpoint		Creates or updates entities in bulk to a collection. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array>, array>.
move_entities_to_collection	exec	collection, endpoint		Move existing entities to the target collection.

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
collection	string	the collection unique name.
endpoint	string	The service endpoint host (no scheme). (default: )

INSERT examples

create_or_update

Creates or updates an entity to a collection. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array>, array>.

INSERT INTO azure.purview_catalog.collection (
collection,
endpoint
)
SELECT 
'{{ collection }}',
'{{ endpoint }}'
;

Manifest

# Description fields are for documentation purposes
- name: collection
props:
  - name: collection
    value: "{{ collection }}"
    description: Required parameter for the collection resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the collection resource.

REPLACE examples

create_or_update

Creates or updates an entity to a collection. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array>, array>.

REPLACE azure.purview_catalog.collection
SET 
-- No updatable properties
WHERE 
collection = '{{ collection }}' --required
AND endpoint = '{{ endpoint }}' --required;

Lifecycle Methods

create_or_update_bulk

Creates or updates entities in bulk to a collection. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array>, array>.

EXEC azure.purview_catalog.collection.create_or_update_bulk 
@collection='{{ collection }}' --required, 
@endpoint='{{ endpoint }}' --required
;

move_entities_to_collection

Move existing entities to the target collection.

EXEC azure.purview_catalog.collection.move_entities_to_collection 
@collection='{{ collection }}' --required, 
@endpoint='{{ endpoint }}' --required
;