ledger

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

Overview

Name	ledger
Type	Resource
Id	azure.confidential_ledger.ledger

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	Name of the Resource.
aadBasedSecurityPrincipals	array	Array of all AAD based Security Principals.
certBasedSecurityPrincipals	array	Array of all cert based Security Principals.
identityServiceUri	string	Endpoint for accessing network identity.
ledgerInternalNamespace	string	Internal namespace for the Ledger.
ledgerName	string	Unique name for the Confidential Ledger.
ledgerType	string	Type of Confidential Ledger. Known values are: "Unknown", "Public", and "Private".
ledgerUri	string	Endpoint for calling Ledger Service.
location	string	The Azure location where the Confidential Ledger is running.
provisioningState	string	Provisioning state of Ledger Resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Creating", "Deleting", and "Updating".
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Additional tags for Confidential Ledger.
type	string	The type of the resource.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	Name of the Resource.
aadBasedSecurityPrincipals	array	Array of all AAD based Security Principals.
certBasedSecurityPrincipals	array	Array of all cert based Security Principals.
identityServiceUri	string	Endpoint for accessing network identity.
ledgerInternalNamespace	string	Internal namespace for the Ledger.
ledgerName	string	Unique name for the Confidential Ledger.
ledgerType	string	Type of Confidential Ledger. Known values are: "Unknown", "Public", and "Private".
ledgerUri	string	Endpoint for calling Ledger Service.
location	string	The Azure location where the Confidential Ledger is running.
provisioningState	string	Provisioning state of Ledger Resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Creating", "Deleting", and "Updating".
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Additional tags for Confidential Ledger.
type	string	The type of the resource.

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	Name of the Resource.
aadBasedSecurityPrincipals	array	Array of all AAD based Security Principals.
certBasedSecurityPrincipals	array	Array of all cert based Security Principals.
identityServiceUri	string	Endpoint for accessing network identity.
ledgerInternalNamespace	string	Internal namespace for the Ledger.
ledgerName	string	Unique name for the Confidential Ledger.
ledgerType	string	Type of Confidential Ledger. Known values are: "Unknown", "Public", and "Private".
ledgerUri	string	Endpoint for calling Ledger Service.
location	string	The Azure location where the Confidential Ledger is running.
provisioningState	string	Provisioning state of Ledger Resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Creating", "Deleting", and "Updating".
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Additional tags for Confidential Ledger.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, ledger_name, subscription_id		Retrieves information about a Confidential Ledger resource. Retrieves the properties of a Confidential Ledger.
list_by_resource_group	select	resource_group_name, subscription_id	$filter	Retrieves information about all Confidential Ledger resources under the given subscription and resource group. Retrieves the properties of all Confidential Ledgers.
list_by_subscription	select	subscription_id	$filter	Retrieves information about all Confidential Ledger resources under the given subscription. Retrieves the properties of all Confidential Ledgers.
create	insert	resource_group_name, ledger_name, subscription_id		Creates a Confidential Ledger. Creates a Confidential Ledger with the specified ledger parameters.
update	update	resource_group_name, ledger_name, subscription_id		Update Confidential Ledger properties. Updates properties of Confidential Ledger.
delete	delete	resource_group_name, ledger_name, subscription_id		Deletes a Confidential Ledger resource. Deletes an existing 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_name	string	Name of the Confidential Ledger. Required.
resource_group_name	string	The name of the resource group. Required.
subscription_id	string
$filter	string	The filter to apply on the list operation. eg. $filter=ledgerType eq 'Public'. Default value is None.

SELECT examples

get

Retrieves information about a Confidential Ledger resource. Retrieves the properties of a Confidential Ledger.

SELECT
id,
name,
aadBasedSecurityPrincipals,
certBasedSecurityPrincipals,
identityServiceUri,
ledgerInternalNamespace,
ledgerName,
ledgerType,
ledgerUri,
location,
provisioningState,
systemData,
tags,
type
FROM azure.confidential_ledger.ledger
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND ledger_name = '{{ ledger_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Retrieves information about all Confidential Ledger resources under the given subscription and resource group. Retrieves the properties of all Confidential Ledgers.

SELECT
id,
name,
aadBasedSecurityPrincipals,
certBasedSecurityPrincipals,
identityServiceUri,
ledgerInternalNamespace,
ledgerName,
ledgerType,
ledgerUri,
location,
provisioningState,
systemData,
tags,
type
FROM azure.confidential_ledger.ledger
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

list_by_subscription

Retrieves information about all Confidential Ledger resources under the given subscription. Retrieves the properties of all Confidential Ledgers.

SELECT
id,
name,
aadBasedSecurityPrincipals,
certBasedSecurityPrincipals,
identityServiceUri,
ledgerInternalNamespace,
ledgerName,
ledgerType,
ledgerUri,
location,
provisioningState,
systemData,
tags,
type
FROM azure.confidential_ledger.ledger
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Creates a Confidential Ledger. Creates a Confidential Ledger with the specified ledger parameters.

INSERT INTO azure.confidential_ledger.ledger (
location,
tags,
properties,
resource_group_name,
ledger_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ ledger_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: ledger
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the ledger resource.
  - name: ledger_name
    value: "{{ ledger_name }}"
    description: Required parameter for the ledger resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the ledger resource.
  - name: location
    value: "{{ location }}"
    description: |
      The Azure location where the Confidential Ledger is running.
  - name: tags
    value: "{{ tags }}"
    description: |
      Additional tags for Confidential Ledger.
  - name: properties
    description: |
      Properties of Confidential Ledger Resource.
    value:
      ledgerName: "{{ ledgerName }}"
      ledgerUri: "{{ ledgerUri }}"
      identityServiceUri: "{{ identityServiceUri }}"
      ledgerInternalNamespace: "{{ ledgerInternalNamespace }}"
      ledgerType: "{{ ledgerType }}"
      provisioningState: "{{ provisioningState }}"
      aadBasedSecurityPrincipals:
        - principalId: "{{ principalId }}"
          tenantId: "{{ tenantId }}"
          ledgerRoleName: "{{ ledgerRoleName }}"
      certBasedSecurityPrincipals:
        - cert: "{{ cert }}"
          ledgerRoleName: "{{ ledgerRoleName }}"

UPDATE examples

update

Update Confidential Ledger properties. Updates properties of Confidential Ledger.

UPDATE azure.confidential_ledger.ledger
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND ledger_name = '{{ ledger_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a Confidential Ledger resource. Deletes an existing Confidential Ledger.

DELETE FROM azure.confidential_ledger.ledger
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND ledger_name = '{{ ledger_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;