ConfidentialLedgerClient.GetLedgerEntriesAsync メソッド

定義

名前空間:

Azure.Security.ConfidentialLedger

アセンブリ:

Azure.Security.ConfidentialLedger.dll

パッケージ:

Azure.Security.ConfidentialLedger v1.2.0

[プロトコルメソッド]範囲に対応するコレクションから台帳エントリを取得します。

• この プロトコルメソッド を使用すると、高度なシナリオで応答の要求と処理を明示的に作成できます。

public virtual Azure.AsyncPageable<BinaryData> GetLedgerEntriesAsync (string collectionId = default, string fromTransactionId = default, string toTransactionId = default, Azure.RequestContext context = default);

abstract member GetLedgerEntriesAsync : string * string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetLedgerEntriesAsync : string * string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>

Public Overridable Function GetLedgerEntriesAsync (Optional collectionId As String = Nothing, Optional fromTransactionId As String = Nothing, Optional toTransactionId As String = Nothing, Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)

パラメーター

collectionId

String

コレクション ID。

fromTransactionId

String

範囲内の最初のトランザクション ID を指定します。

toTransactionId

String

範囲内の最後のトランザクション ID を指定します。

context

RequestContext

要求コンテキスト。これは、呼び出しごとにクライアント パイプラインの既定の動作をオーバーライドできます。

戻り値

AsyncPageable<BinaryData>

AsyncPageable<T>オブジェクトの一覧を含むサービスの BinaryData 。 コレクション内の各項目の本文スキーマの詳細については、以下の「解説」セクションを参照してください。

例外

RequestFailedException

サービスから成功以外の状態コードが返されました。

例

このサンプルでは、GetLedgerEntriesAsync を呼び出して結果を解析する方法を示します。

var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ConfidentialLedgerClient(endpoint, credential);

await foreach (var item in client.GetLedgerEntriesAsync())
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("contents").ToString());
}

このサンプルでは、すべてのパラメーターを使用して GetLedgerEntriesAsync を呼び出す方法と、結果を解析する方法を示します。

var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ConfidentialLedgerClient(endpoint, credential);

await foreach (var item in client.GetLedgerEntriesAsync("<collectionId>", "<fromTransactionId>", "<toTransactionId>"))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("contents").ToString());
    Console.WriteLine(result.GetProperty("collectionId").ToString());
    Console.WriteLine(result.GetProperty("transactionId").ToString());
}

注釈

必要に応じて、コレクション ID を指定できます。 指定した (または既定の) コレクション内のエントリのみが返されます。

ページング可能な応答の 1 つの項目の JSON スキーマを次に示します。

応答本文:

の LedgerEntriesスキーマ:

{
  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.
}