ledger_digest_uploads

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

Overview

Name	ledger_digest_uploads
Type	Resource
Id	azure.sql.ledger_digest_uploads

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the ledger digest configuration.

Name	Datatype	Description
properties	object	Resource properties.

list_by_database

Successfully retrieved ledger upload settings.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, databaseName, ledgerDigestUploads, subscriptionId		Gets the current ledger digest upload configuration for a database.
list_by_database	select	resourceGroupName, serverName, databaseName, subscriptionId		Gets all ledger digest upload settings on a database.
create_or_update	insert	resourceGroupName, serverName, databaseName, ledgerDigestUploads, subscriptionId		Enables upload ledger digests to an Azure Storage account or an Azure Confidential Ledger instance.
disable	exec	resourceGroupName, serverName, databaseName, ledgerDigestUploads, subscriptionId		Disables uploading ledger digests to an Azure Storage account or an Azure Confidential Ledger 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
databaseName	string	The name of the database.
ledgerDigestUploads	string
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets the current ledger digest upload configuration for a database.

SELECT
properties
FROM azure.sql.ledger_digest_uploads
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND ledgerDigestUploads = '{{ ledgerDigestUploads }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_database

Gets all ledger digest upload settings on a database.

SELECT
properties
FROM azure.sql.ledger_digest_uploads
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Enables upload ledger digests to an Azure Storage account or an Azure Confidential Ledger instance.

INSERT INTO azure.sql.ledger_digest_uploads (
data__properties,
resourceGroupName,
serverName,
databaseName,
ledgerDigestUploads,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ databaseName }}',
'{{ ledgerDigestUploads }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: ledger_digest_uploads
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the ledger_digest_uploads resource.
    - name: serverName
      value: string
      description: Required parameter for the ledger_digest_uploads resource.
    - name: databaseName
      value: string
      description: Required parameter for the ledger_digest_uploads resource.
    - name: ledgerDigestUploads
      value: string
      description: Required parameter for the ledger_digest_uploads resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the ledger_digest_uploads resource.
    - name: properties
      value: object
      description: |
        Resource properties.

Lifecycle Methods

disable

Disables uploading ledger digests to an Azure Storage account or an Azure Confidential Ledger instance.

EXEC azure.sql.ledger_digest_uploads.disable 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@ledgerDigestUploads='{{ ledgerDigestUploads }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;