collections
Creates, updates, deletes, gets or lists a collections resource.
Overview
| Name | collections |
| Type | Resource |
| Id | azure.confidential_ledger_dataplane.collections |
Fields
The following fields are returned by SELECT queries:
- list_collections
| Name | Datatype | Description |
|---|---|---|
collectionId | string | Identifier for the collection. Required. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_collections | select | ledger_endpoint | Retrieves a list of collection ids present in the Confidential Ledger. Collection ids are user-created collections of ledger entries. |
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 |
|---|---|---|
ledger_endpoint | string | The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client ledgerEndpoint parameter. (default: ) |
SELECT examples
- list_collections
Retrieves a list of collection ids present in the Confidential Ledger. Collection ids are user-created collections of ledger entries.
SELECT
collectionId
FROM azure.confidential_ledger_dataplane.collections
WHERE ledger_endpoint = '{{ ledger_endpoint }}' -- required
;