Share via


Ledger Digest Uploads - List By Database

Gets all ledger digest upload settings on a database.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/ledgerDigestUploads?api-version=2023-08-01

URI Parameters

Name In Required Type Description
databaseName
path True

string

The name of the database.

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.

Responses

Name Type Description
200 OK

LedgerDigestUploadsListResult

Successfully retrieved ledger upload settings.

Other Status Codes

ErrorResponse

*** 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”.

  • 404 ResourceNotFound - The requested resource was not found.

Examples

Gets list of ledger digest upload settings on a database.

Sample request

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

Sample response

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

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

LedgerDigestUploads

Azure SQL Database ledger digest upload settings.

LedgerDigestUploadsListResult

A list of ledger digest upload settings.

LedgerDigestUploadsState

Specifies the state of ledger digest upload.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

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.

LedgerDigestUploadsListResult

A list of ledger digest upload settings.

Name Type Description
nextLink

string

Link to retrieve next page of results.

value

LedgerDigestUploads[]

Array of results.

LedgerDigestUploadsState

Specifies the state of ledger digest upload.

Value Description
Enabled
Disabled