users

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

Overview

Name	users
Type	Resource
Id	azure.confidential_ledger_dataplane.users

Fields

The following fields are returned by SELECT queries:

get_user

Name	Datatype	Description
assignedRole	string	Represents an assignable role. Required. Known values are: "Administrator", "Contributor", and "Reader". (Administrator, Contributor, Reader)
userId	string	Identifier for the user. This must either be an AAD object id or a certificate fingerprint.

list_users

Name	Datatype	Description
assignedRole	string	Represents an assignable role. Required. Known values are: "Administrator", "Contributor", and "Reader". (Administrator, Contributor, Reader)
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_user	select	user_id, ledger_endpoint		Gets a user. Gets a user.
list_users	select	ledger_endpoint		Gets details on a list of users. All users' object IDs and single role per user will be returned.
create_or_update_user	insert	user_id, ledger_endpoint, assignedRole		Adds a user or updates a user's fields. A JSON merge patch is applied for existing users.
create_or_update_user	replace	user_id, ledger_endpoint, assignedRole		Adds a user or updates a user's fields. A JSON merge patch is applied for existing users.
delete_user	delete	user_id, ledger_endpoint		Deletes a user from the Confidential Ledger. Deletes a user 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_user

Gets a user. Gets a user.

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

list_users

Gets details on a list of users. All users' object IDs and single role per user will be returned.

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

INSERT examples

create_or_update_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.users (
assignedRole,
user_id,
ledger_endpoint
)
SELECT 
'{{ assignedRole }}' /* required */,
'{{ user_id }}',
'{{ ledger_endpoint }}'
RETURNING
assignedRole,
userId
;

Manifest

# Description fields are for documentation purposes
- name: users
props:
  - name: user_id
    value: "{{ user_id }}"
    description: Required parameter for the users resource.
  - name: ledger_endpoint
    value: "{{ ledger_endpoint }}"
    description: Required parameter for the users resource.
  - name: assignedRole
    value: "{{ assignedRole }}"
    description: |
      Represents an assignable role. Required. Known values are: "Administrator", "Contributor", and "Reader".
    valid_values: ['Administrator', 'Contributor', 'Reader']

REPLACE examples

create_or_update_user

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

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

DELETE examples

delete_user

Deletes a user from the Confidential Ledger. Deletes a user from the Confidential Ledger.

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