ConfidentialLedgerClient.GetCurrentLedgerEntry(String, RequestContext) Method

Definition

Namespace:

Azure.Security.ConfidentialLedger

Assembly:

Azure.Security.ConfidentialLedger.dll

Package:

Azure.Security.ConfidentialLedger v1.3.0

Source:

ConfidentialLedgerClient.cs

[Protocol Method] Gets the current value available in the ledger.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

C#

public virtual Azure.Response GetCurrentLedgerEntry(string collectionId = default, Azure.RequestContext context = default);

Parameters

collectionId

String

The collection id.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetCurrentLedgerEntry and parse the result.

Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
ConfidentialLedgerClient client = new ConfidentialLedgerClient(endpoint, credential);

Response response = client.GetCurrentLedgerEntry();

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("contents").ToString());

This sample shows how to call GetCurrentLedgerEntry with all parameters and parse the result.

Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
ConfidentialLedgerClient client = new ConfidentialLedgerClient(endpoint, credential);

Response response = client.GetCurrentLedgerEntry(collectionId: "<collectionId>");

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("contents").ToString());
Console.WriteLine(result.GetProperty("collectionId").ToString());
Console.WriteLine(result.GetProperty("transactionId").ToString());

Remarks

A collection id may optionally be specified.

Below is the JSON schema for the response payload.

Response Body:

Schema for LedgerEntry:

{
  contents: string, # Required. Contents of the ledger entry.
  collectionId: string, # Optional.
  transactionId: string, # Optional. A unique identifier for the state of the ledger. If returned as part of a LedgerEntry, it indicates the state from which the entry was read.
}

Applies to