Ledger Digest Uploads - Create Or Update

Service:

SQL Database

API Version:

2021-11-01

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/ledgerDigestUploads/current?api-version=2021-11-01

URI Parameters

Name	In	Required	Type	Description
databaseName	path	True	string	The name of the database.
ledgerDigestUploads	path	True	LedgerDigestUploadsName
resourceGroupName	path	True	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	path	True	string	The name of the server.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Request Body

Name	Type	Description
properties.digestStorageEndpoint	string	The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger.

Responses

Name	Type	Description
200 OK	LedgerDigestUploads	Successfully updated the ledger digest upload configuration
202 Accepted		Updating the ledger digest upload configuration is in progress.
Other Status Codes		*** Error Responses: *** 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object. 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint. 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI. 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”. 400 LedgerMissingDigestStorageEndPoint - User attempted to configure ledger digest storage without providing an endpoint 400 LedgerException - The server encountered an unexpected exception 400 LedgerDigestUploadsNotSupportedOnGeoSecondary - The ledger digest storage cannot be configured on secondary databases. 400 InsufficientStorageAccountPermissions - Read or write operations are not allowed on the storage account. 400 StorageAccountIsDisabled - The storage account is disabled. 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist. 400 PreviousOperationInProgress - Uploading ledger digests is being enabled or disabled for database. Please wait for the previous request to complete. 400 NoServerIdentity - No identity is configured for specified server. For information on how to configure an identity for the server see https://go.microsoft.com/fwlink/?linkid=2156804 400 SubscriptionDoesNotHaveServer - Subscription does not contain server. 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered. The error message from Active Directory Authentication library (ADAL) is {0}. 400 LedgerDigestUploadIsNotSupportedOnResourceType - Uploading ledger digests is currently not supported for this resource type. 400 InvalidOperationOnNamedReplicas - The ledger digest storage cannot be configured on a named replica. 400 LedgerDigestUploadsNotSupportedOnGeoChaining - User attempted to set automatic upload of ledger digest in database configured with secondaries of secondaries. 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage or Azure Confidential Ledger endpoint. 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist. 404 SourceDatabaseNotFound - Specified database does not exist. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 OperationIdNotFound - The operation with Id does not exist. 409 OperationCancelled - The operation has been cancelled by user. 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource. 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources. 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources. 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Examples

Enables ledger digest upload configuration for a database

Sample request

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/ledgertestrg/providers/Microsoft.Sql/servers/ledgertestserver/databases/testdb/ledgerDigestUploads/current?api-version=2021-11-01

{
  "properties": {
    "digestStorageEndpoint": "https://MyAccount.blob.core.windows.net"
  }
}

Java

import com.azure.resourcemanager.sql.fluent.models.LedgerDigestUploadsInner;
import com.azure.resourcemanager.sql.models.LedgerDigestUploadsName;

/**
 * Samples for LedgerDigestUploadsOperation CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/LedgerDigestUploadsEnable.json
     */
    /**
     * Sample code: Enables ledger digest upload configuration for a database.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        enablesLedgerDigestUploadConfigurationForADatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getLedgerDigestUploadsOperations().createOrUpdate("ledgertestrg",
            "ledgertestserver", "testdb", LedgerDigestUploadsName.CURRENT,
            new LedgerDigestUploadsInner().withDigestStorageEndpoint("https://MyAccount.blob.core.windows.net"),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/ledgertestrg/providers/Microsoft.Sql/servers/ledgertestserver/databases/testdb/ledgerDigestUpload/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/databases/ledgerDigestUploads",
  "properties": {
    "digestStorageEndpoint": "https://mystorage.blob.core.windows.net",
    "state": "Enabled"
  }
}

Status code:

202

Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/ledgertestrg/providers/Microsoft.Sql/locations/eastus/ledgerDigestUploadOperationResults/11111111-1111-1111-1111-111111111111

Definitions

Name	Description
LedgerDigestUploads	Azure SQL Database ledger digest upload settings.
LedgerDigestUploadsName
LedgerDigestUploadsState	Specifies the state of ledger digest upload.

LedgerDigestUploads

Azure SQL Database ledger digest upload settings.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.digestStorageEndpoint	string	The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger.
properties.state	LedgerDigestUploadsState	Specifies the state of ledger digest upload.
type	string	Resource type.

LedgerDigestUploadsName

Name	Type	Description
current	string

LedgerDigestUploadsState

Specifies the state of ledger digest upload.

Name	Type	Description
Disabled	string
Enabled	string