ConfidentialLedgerClient.GetCollectionsAsync(RequestContext) Method

Definition

Namespace:

Azure.Security.ConfidentialLedger

Assembly:

Azure.Security.ConfidentialLedger.dll

Package:

Azure.Security.ConfidentialLedger v1.3.0

Source:

ConfidentialLedgerClient.cs

[Protocol Method] Retrieves a list of collection ids present in the Confidential Ledger

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

public virtual Azure.AsyncPageable<BinaryData> GetCollectionsAsync (Azure.RequestContext context = default);

abstract member GetCollectionsAsync : Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetCollectionsAsync : Azure.RequestContext -> Azure.AsyncPageable<BinaryData>

Public Overridable Function GetCollectionsAsync (Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)

Parameters

context

RequestContext

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

Returns

AsyncPageable<BinaryData>

The AsyncPageable<T> from the service containing a list of BinaryData objects. Details of the body schema for each item in the collection are in the Remarks section below.

Exceptions

RequestFailedException

Service returned a non-success status code.

Examples

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

TokenCredential credential = new DefaultAzureCredential();
ConfidentialLedgerClient client = new ConfidentialLedgerClient(new Uri("http://localhost:3000"), credential);

await foreach (BinaryData item in client.GetCollectionsAsync())
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("collectionId").ToString());
}

This sample shows how to call GetCollectionsAsync with all request content and parse the result.

TokenCredential credential = new DefaultAzureCredential();
ConfidentialLedgerClient client = new ConfidentialLedgerClient(new Uri("http://localhost:3000"), credential);

await foreach (BinaryData item in client.GetCollectionsAsync())
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("collectionId").ToString());
}

Remarks

Collection ids are user-created collections of ledger entries

Below is the JSON schema for one item in the pageable response.

Response Body:

Schema for PagedCollections:

{
  collectionId: string, # Required.
}