user_defined_roles

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

Overview

Name	user_defined_roles
Type	Resource
Id	azure.confidential_ledger_dataplane.user_defined_roles

Fields

The following fields are returned by SELECT queries:

get_user_defined_role

Name	Datatype	Description
roles	array	Roles. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_user_defined_role	select	roleName, ledger_endpoint		Gets role actions for user defined roles. user defined roles allow users to define and manage app specific AuthZ policy.
create_user_defined_role	insert	ledger_endpoint, roles		Creates new roles and their actions. User defined roles allow users to define and manage app specific AuthZ policy.
update_user_defined_role	update	ledger_endpoint, roles		Patch replaces the allowed action on existing roles,if the desire is to remove an existing action, the role must be deleted and recreated. User defined roles allow users to define and manage app specific AuthZ policy.
delete_user_defined_role	delete	roleName, ledger_endpoint		Deletes user defined roles. A user defined role allows the users to create and manage their own role actions using the API.

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: )
roleName	string	user defined role name. Required.

SELECT examples

get_user_defined_role

Gets role actions for user defined roles. user defined roles allow users to define and manage app specific AuthZ policy.

SELECT
roles
FROM azure.confidential_ledger_dataplane.user_defined_roles
WHERE roleName = '{{ roleName }}' -- required
AND ledger_endpoint = '{{ ledger_endpoint }}' -- required
;

INSERT examples

create_user_defined_role

Creates new roles and their actions. User defined roles allow users to define and manage app specific AuthZ policy.

INSERT INTO azure.confidential_ledger_dataplane.user_defined_roles (
roles,
ledger_endpoint
)
SELECT 
'{{ roles }}' /* required */,
'{{ ledger_endpoint }}'
;

Manifest

# Description fields are for documentation purposes
- name: user_defined_roles
props:
  - name: ledger_endpoint
    value: "{{ ledger_endpoint }}"
    description: Required parameter for the user_defined_roles resource.
  - name: roles
    description: |
      Roles. Required.
    value:
      - roleName: "{{ roleName }}"
        roleActions: "{{ roleActions }}"

UPDATE examples

update_user_defined_role

Patch replaces the allowed action on existing roles,if the desire is to remove an existing action, the role must be deleted and recreated. User defined roles allow users to define and manage app specific AuthZ policy.

UPDATE azure.confidential_ledger_dataplane.user_defined_roles
SET 
roles = '{{ roles }}'
WHERE 
ledger_endpoint = '{{ ledger_endpoint }}' --required
AND roles = '{{ roles }}' --required;

DELETE examples

delete_user_defined_role

Deletes user defined roles. A user defined role allows the users to create and manage their own role actions using the API.

DELETE FROM azure.confidential_ledger_dataplane.user_defined_roles
WHERE roleName = '{{ roleName }}' --required
AND ledger_endpoint = '{{ ledger_endpoint }}' --required
;