ledgers

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

Overview

Name	ledgers
Type	Resource
Id	azure.confidential_ledger.ledgers

Fields

The following fields are returned by SELECT queries:

get

The request was successful; response contains the Confidential Ledger

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of Confidential Ledger Resource. (title: LedgerProperties)
tags	object	Resource tags.

list_by_resource_group

The request was successful; response contains the Confidential Ledger

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of Confidential Ledger Resource. (title: LedgerProperties)
tags	object	Resource tags.

list_by_subscription

The request was successful; response contains the list of Confidential Ledgers

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of Confidential Ledger Resource. (title: LedgerProperties)
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, ledgerName		Retrieves the properties of a Confidential Ledger.
list_by_resource_group	select	subscriptionId, resourceGroupName	$filter	Retrieves the properties of all Confidential Ledgers.
list_by_subscription	select	subscriptionId	$filter	Retrieves the properties of all Confidential Ledgers.
create	insert	subscriptionId, resourceGroupName, ledgerName		Creates a Confidential Ledger with the specified ledger parameters.
update	update	subscriptionId, resourceGroupName, ledgerName		Updates properties of Confidential Ledger
delete	delete	subscriptionId, resourceGroupName, ledgerName		Deletes an existing Confidential Ledger.
backup	exec	subscriptionId, resourceGroupName, ledgerName, uri		Backs up a Confidential Ledger Resource.
restore	exec	subscriptionId, resourceGroupName, ledgerName, fileShareName, restoreRegion, uri		Restores a Confidential Ledger Resource.

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
ledgerName	string	Name of the Confidential Ledger
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
$filter	string	The filter to apply on the list operation. eg. $filter=ledgerType eq 'Public'

SELECT examples

get

Retrieves the properties of a Confidential Ledger.

SELECT
location,
properties,
tags
FROM azure.confidential_ledger.ledgers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND ledgerName = '{{ ledgerName }}' -- required
;

list_by_resource_group

Retrieves the properties of all Confidential Ledgers.

SELECT
location,
properties,
tags
FROM azure.confidential_ledger.ledgers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $filter = '{{ $filter }}'
;

list_by_subscription

Retrieves the properties of all Confidential Ledgers.

SELECT
location,
properties,
tags
FROM azure.confidential_ledger.ledgers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Creates a Confidential Ledger with the specified ledger parameters.

INSERT INTO azure.confidential_ledger.ledgers (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
ledgerName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ ledgerName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: ledgers
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the ledgers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the ledgers resource.
    - name: ledgerName
      value: string
      description: Required parameter for the ledgers resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Properties of Confidential Ledger Resource.

UPDATE examples

update

Updates properties of Confidential Ledger

UPDATE azure.confidential_ledger.ledgers
SET 
data__tags = '{{ tags }}',
data__location = '{{ location }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND ledgerName = '{{ ledgerName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes an existing Confidential Ledger.

DELETE FROM azure.confidential_ledger.ledgers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND ledgerName = '{{ ledgerName }}' --required
;

Lifecycle Methods

backup

Backs up a Confidential Ledger Resource.

EXEC azure.confidential_ledger.ledgers.backup 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@ledgerName='{{ ledgerName }}' --required 
@@json=
'{
"restoreRegion": "{{ restoreRegion }}", 
"uri": "{{ uri }}"
}'
;

restore

Restores a Confidential Ledger Resource.

EXEC azure.confidential_ledger.ledgers.restore 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@ledgerName='{{ ledgerName }}' --required 
@@json=
'{
"fileShareName": "{{ fileShareName }}", 
"restoreRegion": "{{ restoreRegion }}", 
"uri": "{{ uri }}"
}'
;