ledger_users

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

Overview

Name	ledger_users
Type	Resource
Id	azure.confidential_ledger_dataplane.ledger_users

Fields

The following fields are returned by SELECT queries:

get_ledger_user

Name	Datatype	Description
assignedRoles	array	Represents an assignable role. Required.
userId	string	Identifier for the user. This must either be an AAD object id or a certificate fingerprint.

list_ledger_users

Name	Datatype	Description
assignedRoles	array	Represents an assignable role. Required.
userId	string	Identifier for the user. This must either be an AAD object id or a certificate fingerprint.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ledger_user	select	user_id, ledger_endpoint		Gets a user with multiple roles. Gets a user with multiple roles.
list_ledger_users	select	ledger_endpoint		Gets details on a list of users. All users' object IDs and multiple roles will be returned.
create_or_update_ledger_user	insert	user_id, ledger_endpoint, assignedRoles		Adds a user or updates a user's fields. A JSON merge patch is applied for existing users.
create_or_update_ledger_user	replace	user_id, ledger_endpoint, assignedRoles		Adds a user or updates a user's fields. A JSON merge patch is applied for existing users.
delete_ledger_user	delete	user_id, ledger_endpoint		Deletes a user with multiple roles from the Confidential Ledger. Deletes a user with multiple roles from the Confidential Ledger.

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: )
user_id	string	The user id, either an AAD object ID or certificate fingerprint. Required.

SELECT examples

get_ledger_user

Gets a user with multiple roles. Gets a user with multiple roles.

SELECT
assignedRoles,
userId
FROM azure.confidential_ledger_dataplane.ledger_users
WHERE user_id = '{{ user_id }}' -- required
AND ledger_endpoint = '{{ ledger_endpoint }}' -- required
;

list_ledger_users

Gets details on a list of users. All users' object IDs and multiple roles will be returned.

SELECT
assignedRoles,
userId
FROM azure.confidential_ledger_dataplane.ledger_users
WHERE ledger_endpoint = '{{ ledger_endpoint }}' -- required
;

INSERT examples

create_or_update_ledger_user

Adds a user or updates a user's fields. A JSON merge patch is applied for existing users.

INSERT INTO azure.confidential_ledger_dataplane.ledger_users (
assignedRoles,
user_id,
ledger_endpoint
)
SELECT 
'{{ assignedRoles }}' /* required */,
'{{ user_id }}',
'{{ ledger_endpoint }}'
RETURNING
assignedRoles,
userId
;

Manifest

# Description fields are for documentation purposes
- name: ledger_users
props:
  - name: user_id
    value: "{{ user_id }}"
    description: Required parameter for the ledger_users resource.
  - name: ledger_endpoint
    value: "{{ ledger_endpoint }}"
    description: Required parameter for the ledger_users resource.
  - name: assignedRoles
    value:
      - "{{ assignedRoles }}"
    description: |
      Represents an assignable role. Required.

REPLACE examples

create_or_update_ledger_user

Adds a user or updates a user's fields. A JSON merge patch is applied for existing users.

REPLACE azure.confidential_ledger_dataplane.ledger_users
SET 
assignedRoles = '{{ assignedRoles }}'
WHERE 
user_id = '{{ user_id }}' --required
AND ledger_endpoint = '{{ ledger_endpoint }}' --required
AND assignedRoles = '{{ assignedRoles }}' --required
RETURNING
assignedRoles,
userId;

DELETE examples

delete_ledger_user

Deletes a user with multiple roles from the Confidential Ledger. Deletes a user with multiple roles from the Confidential Ledger.

DELETE FROM azure.confidential_ledger_dataplane.ledger_users
WHERE user_id = '{{ user_id }}' --required
AND ledger_endpoint = '{{ ledger_endpoint }}' --required
;