managed_ledger_digest_uploads

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

Overview

Name	managed_ledger_digest_uploads
Type	Resource
Id	azure.sql.managed_ledger_digest_uploads

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
digestStorageEndpoint	string	The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger.
state	string	Specifies the state of ledger digest upload. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_database

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
digestStorageEndpoint	string	The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger.
state	string	Specifies the state of ledger digest upload. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, managed_instance_name, database_name, ledger_digest_uploads, subscription_id		Gets the current ledger digest upload configuration for a database.
list_by_database	select	resource_group_name, managed_instance_name, database_name, subscription_id		Gets all ledger digest upload settings on a database.
create_or_update	insert	resource_group_name, managed_instance_name, database_name, ledger_digest_uploads, subscription_id		Enables upload ledger digests to an Azure Storage account or an Azure Confidential Ledger instance.
create_or_update	replace	resource_group_name, managed_instance_name, database_name, ledger_digest_uploads, subscription_id		Enables upload ledger digests to an Azure Storage account or an Azure Confidential Ledger instance.
disable	exec	resource_group_name, managed_instance_name, database_name, ledger_digest_uploads, subscription_id		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
database_name	string	The name of the database. Required.
ledger_digest_uploads	string	"current" Required.
managed_instance_name	string	The name of the managed instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the current ledger digest upload configuration for a database.

SELECT
id,
name,
digestStorageEndpoint,
state,
systemData,
type
FROM azure.sql.managed_ledger_digest_uploads
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND ledger_digest_uploads = '{{ ledger_digest_uploads }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_database

Gets all ledger digest upload settings on a database.

SELECT
id,
name,
digestStorageEndpoint,
state,
systemData,
type
FROM azure.sql.managed_ledger_digest_uploads
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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.managed_ledger_digest_uploads (
properties,
resource_group_name,
managed_instance_name,
database_name,
ledger_digest_uploads,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ managed_instance_name }}',
'{{ database_name }}',
'{{ ledger_digest_uploads }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: managed_ledger_digest_uploads
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the managed_ledger_digest_uploads resource.
  - name: managed_instance_name
    value: "{{ managed_instance_name }}"
    description: Required parameter for the managed_ledger_digest_uploads resource.
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the managed_ledger_digest_uploads resource.
  - name: ledger_digest_uploads
    value: "{{ ledger_digest_uploads }}"
    description: Required parameter for the managed_ledger_digest_uploads resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the managed_ledger_digest_uploads resource.
  - name: properties
    description: |
      Resource properties.
    value:
      digestStorageEndpoint: "{{ digestStorageEndpoint }}"
      state: "{{ state }}"

REPLACE examples

create_or_update

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

REPLACE azure.sql.managed_ledger_digest_uploads
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND managed_instance_name = '{{ managed_instance_name }}' --required
AND database_name = '{{ database_name }}' --required
AND ledger_digest_uploads = '{{ ledger_digest_uploads }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

Lifecycle Methods

disable

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

EXEC azure.sql.managed_ledger_digest_uploads.disable 
@resource_group_name='{{ resource_group_name }}' --required, 
@managed_instance_name='{{ managed_instance_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@ledger_digest_uploads='{{ ledger_digest_uploads }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;