user_defined_endpoints

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

Overview

Name	user_defined_endpoints
Type	Resource
Id	azure.confidential_ledger_dataplane.user_defined_endpoints

Fields

The following fields are returned by SELECT queries:

get_user_defined_endpoint

Name	Datatype	Description
metadata	object	Metadata information for the bundle. Required.
modules	array	Any object. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_user_defined_endpoint	select	ledger_endpoint		Gets a user defined endpoint. Returns the user defined endpoint in the ACL instance.
create_user_defined_endpoint	insert	ledger_endpoint, metadata, modules		Creates a user defined endpoint. Creates the user defined endpoint in the ACL instance.

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

get_user_defined_endpoint

Gets a user defined endpoint. Returns the user defined endpoint in the ACL instance.

SELECT
metadata,
modules
FROM azure.confidential_ledger_dataplane.user_defined_endpoints
WHERE ledger_endpoint = '{{ ledger_endpoint }}' -- required
;

INSERT examples

create_user_defined_endpoint

Creates a user defined endpoint. Creates the user defined endpoint in the ACL instance.

INSERT INTO azure.confidential_ledger_dataplane.user_defined_endpoints (
metadata,
modules,
ledger_endpoint
)
SELECT 
'{{ metadata }}' /* required */,
'{{ modules }}' /* required */,
'{{ ledger_endpoint }}'
;

Manifest

# Description fields are for documentation purposes
- name: user_defined_endpoints
props:
  - name: ledger_endpoint
    value: "{{ ledger_endpoint }}"
    description: Required parameter for the user_defined_endpoints resource.
  - name: metadata
    description: |
      Metadata information for the bundle. Required.
    value:
      endpoints: "{{ endpoints }}"
  - name: modules
    description: |
      Any object. Required.
    value:
      - module: "{{ module }}"
        name: "{{ name }}"