collections
Creates, updates, deletes, gets or lists a collections resource.
Overview
| Name | collections |
| Type | Resource |
| Id | azure.purview_administration.collections |
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 |
|---|---|---|---|---|
list_collections | exec | endpoint | List the collections in the account. | |
list_child_collection_names | exec | endpoint | Lists the child collections names in the collection. | |
get_collection | exec | endpoint | Get a collection. | |
get_collection_path | exec | endpoint | Gets the parent name and parent friendly name chains that represent the collection path. |
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 |
|---|---|---|
endpoint | string | The service endpoint host (no scheme). (default: ) |
Lifecycle Methods
- list_collections
- list_child_collection_names
- get_collection
- get_collection_path
List the collections in the account.
EXEC azure.purview_administration.collections.list_collections
@endpoint='{{ endpoint }}' --required
;
Lists the child collections names in the collection.
EXEC azure.purview_administration.collections.list_child_collection_names
@endpoint='{{ endpoint }}' --required
;
Get a collection.
EXEC azure.purview_administration.collections.get_collection
@endpoint='{{ endpoint }}' --required
;
Gets the parent name and parent friendly name chains that represent the collection path.
EXEC azure.purview_administration.collections.get_collection_path
@endpoint='{{ endpoint }}' --required
;