ledgers

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

Overview

Name	ledgers
Type	Resource
Id	azure.confidential_ledger.ledgers

Fields

vw_ledgers

Name	Datatype	Description
aad_based_security_principals	text	field from the properties object
cert_based_security_principals	text	field from the properties object
host_level	text	field from the properties object
identity_service_uri	text	field from the properties object
ledgerName	text	field from the properties object
ledger_internal_namespace	text	field from the properties object
ledger_name	text	field from the properties object
ledger_sku	text	field from the properties object
ledger_type	text	field from the properties object
ledger_uri	text	field from the properties object
location	text	The geo-location where the resource lives
max_body_size_in_mb	text	field from the properties object
node_count	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
running_state	text	field from the properties object
subject_name	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
worker_threads	text	field from the properties object
write_lb_address_prefix	text	field from the properties object

ledgers

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Additional Confidential Ledger properties.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	ledgerName, resourceGroupName, subscriptionId	Retrieves the properties of a Confidential Ledger.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Retrieves the properties of all Confidential Ledgers.
list_by_subscription	SELECT	subscriptionId	Retrieves the properties of all Confidential Ledgers.
create	INSERT	ledgerName, resourceGroupName, subscriptionId	Creates a Confidential Ledger with the specified ledger parameters.
delete	DELETE	ledgerName, resourceGroupName, subscriptionId	Deletes an existing Confidential Ledger.
update	UPDATE	ledgerName, resourceGroupName, subscriptionId	Updates properties of Confidential Ledger
backup	EXEC	ledgerName, resourceGroupName, subscriptionId, data__uri	Backs up a Confidential Ledger Resource.
restore	EXEC	ledgerName, resourceGroupName, subscriptionId, data__fileShareName, data__restoreRegion, data__uri	Restores a Confidential Ledger Resource.

SELECT examples

Retrieves the properties of all Confidential Ledgers.

vw_ledgers

SELECT
aad_based_security_principals,
cert_based_security_principals,
host_level,
identity_service_uri,
ledgerName,
ledger_internal_namespace,
ledger_name,
ledger_sku,
ledger_type,
ledger_uri,
location,
max_body_size_in_mb,
node_count,
provisioning_state,
resourceGroupName,
running_state,
subject_name,
subscriptionId,
tags,
worker_threads,
write_lb_address_prefix
FROM azure.confidential_ledger.vw_ledgers
WHERE subscriptionId = '{{ subscriptionId }}';

ledgers

SELECT
location,
properties,
tags
FROM azure.confidential_ledger.ledgers
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new ledgers resource.

All Properties

/*+ create */
INSERT INTO azure.confidential_ledger.ledgers (
ledgerName,
resourceGroupName,
subscriptionId,
tags,
location,
properties
)
SELECT 
'{{ ledgerName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ tags }}',
'{{ location }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: properties
      value:
        - name: ledgerName
          value: string
        - name: ledgerUri
          value: string
        - name: identityServiceUri
          value: string
        - name: ledgerInternalNamespace
          value: string
        - name: runningState
          value: []
        - name: ledgerType
          value: []
        - name: provisioningState
          value: []
        - name: ledgerSku
          value: []
        - name: aadBasedSecurityPrincipals
          value:
            - - name: principalId
                value: string
              - name: tenantId
                value: string
              - name: ledgerRoleName
                value: []
        - name: certBasedSecurityPrincipals
          value:
            - - name: cert
                value: string
        - name: hostLevel
          value: string
        - name: maxBodySizeInMb
          value: []
        - name: subjectName
          value: string
        - name: nodeCount
          value: []
        - name: writeLBAddressPrefix
          value: string
        - name: workerThreads
          value: integer

UPDATE example

Updates a ledgers resource.

/*+ update */
UPDATE azure.confidential_ledger.ledgers
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
ledgerName = '{{ ledgerName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified ledgers resource.

/*+ delete */
DELETE FROM azure.confidential_ledger.ledgers
WHERE ledgerName = '{{ ledgerName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';