ConfidentialLedgerClient Class

Definition

Namespace:: Azure.Security.ConfidentialLedger

Assembly:: Azure.Security.ConfidentialLedger.dll

Package:: Azure.Security.ConfidentialLedger v1.3.0

Package:: Azure.Security.ConfidentialLedger v2.0.0-beta.3

Source:: ConfidentialLedgerClient.cs

Source:: ConfidentialLedgerClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Write and retrieve ledger entries against the Confidential Ledger service.

public class ConfidentialLedgerClient

type ConfidentialLedgerClient = class

Public Class ConfidentialLedgerClient

Inheritance: Object
ConfidentialLedgerClient

Constructors

Name	Description
ConfidentialLedgerClient()	Initializes a new instance of ConfidentialLedgerClient for mocking.
ConfidentialLedgerClient(ConfidentialLedgerClientSettings)	Initializes a new instance of ConfidentialLedgerClient from a ConfidentialLedgerClientSettings.
ConfidentialLedgerClient(Uri, TokenCredential, ConfidentialLedgerClientOptions)	Initializes a new instance of ConfidentialLedgerClient.
ConfidentialLedgerClient(Uri, TokenCredential)	Initializes a new instance of ConfidentialLedgerClient.
ConfidentialLedgerClient(Uri, X509Certificate2, ConfidentialLedgerClientOptions)	Initializes a new instance of ConfidentialLedgerClient.
ConfidentialLedgerClient(Uri, X509Certificate2)	Initializes a new instance of ConfidentialLedgerClient.

Properties

Name	Description
Pipeline	The HTTP pipeline for sending and receiving REST requests and responses.

Methods

Name	Description
CreateLedgerEntry(LedgerEntry, String, String, CancellationToken)	A collection id may optionally be specified.
CreateLedgerEntry(RequestContent, String, RequestContext)	[Protocol Method] Writes a ledger entry. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateLedgerEntry(RequestContent, String, String, RequestContext)	[Protocol Method] A collection id may optionally be specified. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateLedgerEntryAsync(LedgerEntry, String, String, CancellationToken)	A collection id may optionally be specified.
CreateLedgerEntryAsync(RequestContent, String, RequestContext)	[Protocol Method] Writes a ledger entry. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateLedgerEntryAsync(RequestContent, String, String, RequestContext)	[Protocol Method] A collection id may optionally be specified. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateOrUpdateLedgerUser(String, RequestContent, RequestContext)	[Protocol Method] A JSON merge patch is applied for existing users This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateOrUpdateLedgerUserAsync(String, RequestContent, RequestContext)	[Protocol Method] A JSON merge patch is applied for existing users This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateOrUpdateUser(String, RequestContent, RequestContext)	[Protocol Method] A JSON merge patch is applied for existing users This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateOrUpdateUserAsync(String, RequestContent, RequestContext)	[Protocol Method] A JSON merge patch is applied for existing users This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateUserDefinedEndpoint(LedgerBundle, CancellationToken)	Creates the user defined endpoint in the ACL instance.
CreateUserDefinedEndpoint(RequestContent, RequestContext)	[Protocol Method] Creates the user defined endpoint in the ACL instance This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateUserDefinedEndpointAsync(LedgerBundle, CancellationToken)	Creates the user defined endpoint in the ACL instance.
CreateUserDefinedEndpointAsync(RequestContent, RequestContext)	[Protocol Method] Creates the user defined endpoint in the ACL instance This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateUserDefinedFunction(String, RequestContent, RequestContext)	[Protocol Method] Creates the user defined function in the Confidential Ledger This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateUserDefinedFunction(String, UserDefinedFunction, CancellationToken)	Creates the user defined function in the Confidential Ledger.
CreateUserDefinedFunctionAsync(String, RequestContent, RequestContext)	[Protocol Method] Creates the user defined function in the Confidential Ledger This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateUserDefinedFunctionAsync(String, UserDefinedFunction, CancellationToken)	Creates the user defined function in the Confidential Ledger.
CreateUserDefinedRoleStable(RequestContent, RequestContext)	[Protocol Method] User defined roles allow users to define and manage app specific AuthZ policy. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateUserDefinedRoleStable(UserDefinedRoles, CancellationToken)	User defined roles allow users to define and manage app specific AuthZ policy.
CreateUserDefinedRoleStableAsync(RequestContent, RequestContext)	[Protocol Method] User defined roles allow users to define and manage app specific AuthZ policy. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateUserDefinedRoleStableAsync(UserDefinedRoles, CancellationToken)	User defined roles allow users to define and manage app specific AuthZ policy.
DeleteLedgerUser(String, CancellationToken)	Deletes a user with multiple roles from the Confidential Ledger.
DeleteLedgerUser(String, RequestContext)	[Protocol Method] Deletes a user with multiple roles from the Confidential Ledger. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteLedgerUserAsync(String, CancellationToken)	Deletes a user with multiple roles from the Confidential Ledger.
DeleteLedgerUserAsync(String, RequestContext)	[Protocol Method] Deletes a user with multiple roles from the Confidential Ledger. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteUser(String, CancellationToken)	Deletes a user from the Confidential Ledger.
DeleteUser(String, RequestContext)	[Protocol Method] Deletes a user from the Confidential Ledger. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteUserAsync(String, CancellationToken)	Deletes a user from the Confidential Ledger.
DeleteUserAsync(String, RequestContext)	[Protocol Method] Deletes a user from the Confidential Ledger. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteUserDefinedFunction(String, CancellationToken)	Deletes a user defined function from the Confidential Ledger.
DeleteUserDefinedFunction(String, RequestContext)	[Protocol Method] Deletes a user defined function from the Confidential Ledger. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteUserDefinedFunctionAsync(String, CancellationToken)	Deletes a user defined function from the Confidential Ledger.
DeleteUserDefinedFunctionAsync(String, RequestContext)	[Protocol Method] Deletes a user defined function from the Confidential Ledger. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteUserDefinedRoleStable(String, CancellationToken)	A user defined role allows the users to create and manage their own role actions using the API.
DeleteUserDefinedRoleStable(String, RequestContext)	[Protocol Method] A user defined role allows the users to create and manage their own role actions using the API. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteUserDefinedRoleStableAsync(String, CancellationToken)	A user defined role allows the users to create and manage their own role actions using the API.
DeleteUserDefinedRoleStableAsync(String, RequestContext)	[Protocol Method] A user defined role allows the users to create and manage their own role actions using the API. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ExecuteUserDefinedFunction(String, RequestContent, RequestContext)	[Protocol Method] Executes the user defined function in the Confidential Ledger This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ExecuteUserDefinedFunction(String, UserDefinedFunctionExecutionProperties, CancellationToken)	Executes the user defined function in the Confidential Ledger.
ExecuteUserDefinedFunctionAsync(String, RequestContent, RequestContext)	[Protocol Method] Executes the user defined function in the Confidential Ledger This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ExecuteUserDefinedFunctionAsync(String, UserDefinedFunctionExecutionProperties, CancellationToken)	Executes the user defined function in the Confidential Ledger.
GetCollections(CancellationToken)	Collection ids are user-created collections of ledger entries.
GetCollections(RequestContext)	[Protocol Method] Collection ids are user-created collections of ledger entries This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetCollectionsAsync(CancellationToken)	Collection ids are user-created collections of ledger entries.
GetCollectionsAsync(RequestContext)	[Protocol Method] Collection ids are user-created collections of ledger entries This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetConsortiumMembers(CancellationToken)	Consortium members can manage the Confidential Ledger.
GetConsortiumMembers(RequestContext)	[Protocol Method] Consortium members can manage the Confidential Ledger. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetConsortiumMembersAsync(CancellationToken)	Consortium members can manage the Confidential Ledger.
GetConsortiumMembersAsync(RequestContext)	[Protocol Method] Consortium members can manage the Confidential Ledger. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetConstitution(CancellationToken)	The constitution is a script that assesses and applies proposals from consortium members.
GetConstitution(RequestContext)	[Protocol Method] The constitution is a script that assesses and applies proposals from consortium members. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetConstitutionAsync(CancellationToken)	The constitution is a script that assesses and applies proposals from consortium members.
GetConstitutionAsync(RequestContext)	[Protocol Method] The constitution is a script that assesses and applies proposals from consortium members. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetCurrentLedgerEntry(String, CancellationToken)	A collection id may optionally be specified.
GetCurrentLedgerEntry(String, RequestContext)	Gets the current value available in the ledger.
GetCurrentLedgerEntryAsync(String, CancellationToken)	A collection id may optionally be specified.
GetCurrentLedgerEntryAsync(String, RequestContext)	Gets the current value available in the ledger.
GetEnclaveQuotes(CancellationToken)	A quote is an SGX enclave measurement that can be used to verify the validity of a node and its enclave.
GetEnclaveQuotes(RequestContext)	[Protocol Method] A quote is an SGX enclave measurement that can be used to verify the validity of a node and its enclave. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetEnclaveQuotesAsync(CancellationToken)	A quote is an SGX enclave measurement that can be used to verify the validity of a node and its enclave.
GetEnclaveQuotesAsync(RequestContext)	[Protocol Method] A quote is an SGX enclave measurement that can be used to verify the validity of a node and its enclave. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetLedgerEntries(String, String, String, RequestContext)	[Protocol Method] Gets all ledger entries. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetLedgerEntries(String, String, String, String, CancellationToken)	A collection id may optionally be specified. Only entries in the specified (or default) collection will be returned.
GetLedgerEntries(String, String, String, String, RequestContext)	[Protocol Method] A collection id may optionally be specified. Only entries in the specified (or default) collection will be returned. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetLedgerEntriesAsync(String, String, String, RequestContext)	[Protocol Method] Gets all ledger entries. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetLedgerEntriesAsync(String, String, String, String, CancellationToken)	A collection id may optionally be specified. Only entries in the specified (or default) collection will be returned.
GetLedgerEntriesAsync(String, String, String, String, RequestContext)	[Protocol Method] A collection id may optionally be specified. Only entries in the specified (or default) collection will be returned. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetLedgerEntry(String, String, CancellationToken)	To return older ledger entries, the relevant sections of the ledger must be read from disk and validated. To prevent blocking within the enclave, the response will indicate whether the entry is ready and part of the response, or if the loading is still ongoing.
GetLedgerEntry(String, String, RequestContext)	Gets the ledger entry at the specified transaction id.
GetLedgerEntryAsync(String, String, CancellationToken)	To return older ledger entries, the relevant sections of the ledger must be read from disk and validated. To prevent blocking within the enclave, the response will indicate whether the entry is ready and part of the response, or if the loading is still ongoing.
GetLedgerEntryAsync(String, String, RequestContext)	Gets the ledger entry at the specified transaction id.
GetLedgerUser(String, CancellationToken)	Gets a user with multiple roles.
GetLedgerUser(String, RequestContext)	[Protocol Method] Gets a user with multiple roles. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetLedgerUserAsync(String, CancellationToken)	Gets a user with multiple roles.
GetLedgerUserAsync(String, RequestContext)	[Protocol Method] Gets a user with multiple roles. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetLedgerUsers(CancellationToken)	All users' object IDs and multiple roles will be returned.
GetLedgerUsers(RequestContext)	[Protocol Method] All users' object IDs and multiple roles will be returned. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetLedgerUsersAsync(CancellationToken)	All users' object IDs and multiple roles will be returned.
GetLedgerUsersAsync(RequestContext)	[Protocol Method] All users' object IDs and multiple roles will be returned. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetOperationStatus(String, RequestContext)	[Protocol Method] Gets the status of a queued ledger entry by Ledger Gateway operation id. Returned when a prior call to PostLedgerEntry(WaitUntil, RequestContent, String, String, RequestContext) or its async counterpart received a `202 Accepted` response.
GetOperationStatusAsync(String, RequestContext)	[Protocol Method] Gets the status of a queued ledger entry by Ledger Gateway operation id. Returned when a prior call to PostLedgerEntry(WaitUntil, RequestContent, String, String, RequestContext) or its async counterpart received a `202 Accepted` response.
GetReceipt(String, CancellationToken)	Gets a receipt certifying ledger contents at a particular transaction id.
GetReceipt(String, RequestContext)	[Protocol Method] Gets a receipt certifying ledger contents at a particular transaction id. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetReceiptAsync(String, CancellationToken)	Gets a receipt certifying ledger contents at a particular transaction id.
GetReceiptAsync(String, RequestContext)	[Protocol Method] Gets a receipt certifying ledger contents at a particular transaction id. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRuntimeOptions(CancellationToken)	It returns the runtime options.
GetRuntimeOptions(RequestContext)	[Protocol Method] It returns the runtime options This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRuntimeOptionsAsync(CancellationToken)	It returns the runtime options.
GetRuntimeOptionsAsync(RequestContext)	[Protocol Method] It returns the runtime options This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetTags(String, CancellationToken)	Retrieves the tags associated with a collection.
GetTags(String, RequestContext)	[Protocol Method] Retrieves the tags associated with a collection. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetTagsAsync(String, CancellationToken)	Retrieves the tags associated with a collection.
GetTagsAsync(String, RequestContext)	[Protocol Method] Retrieves the tags associated with a collection. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetTransactionStatus(String, CancellationToken)	Gets the status of an entry identified by a transaction id.
GetTransactionStatus(String, RequestContext)	[Protocol Method] Gets the status of an entry identified by a transaction id. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetTransactionStatusAsync(String, CancellationToken)	Gets the status of an entry identified by a transaction id.
GetTransactionStatusAsync(String, RequestContext)	[Protocol Method] Gets the status of an entry identified by a transaction id. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetUser(String, CancellationToken)	Gets a user.
GetUser(String, RequestContext)	[Protocol Method] Gets a user. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetUserAsync(String, CancellationToken)	Gets a user.
GetUserAsync(String, RequestContext)	[Protocol Method] Gets a user. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetUserDefinedEndpoint(CancellationToken)	Returns the user defined endpoint in the ACL instance.
GetUserDefinedEndpoint(RequestContext)	[Protocol Method] Returns the user defined endpoint in the ACL instance This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetUserDefinedEndpointAsync(CancellationToken)	Returns the user defined endpoint in the ACL instance.
GetUserDefinedEndpointAsync(RequestContext)	[Protocol Method] Returns the user defined endpoint in the ACL instance This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetUserDefinedEndpointsModule(String, CancellationToken)	It gets the module for the user defined endpoint.
GetUserDefinedEndpointsModule(String, RequestContext)	[Protocol Method] It gets the module for the user defined endpoint. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetUserDefinedEndpointsModuleAsync(String, CancellationToken)	It gets the module for the user defined endpoint.
GetUserDefinedEndpointsModuleAsync(String, RequestContext)	[Protocol Method] It gets the module for the user defined endpoint. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetUserDefinedFunction(String, CancellationToken)	Returns the user defined function in the Confidential Ledger.
GetUserDefinedFunction(String, RequestContext)	[Protocol Method] Returns the user defined function in the Confidential Ledger This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetUserDefinedFunctionAsync(String, CancellationToken)	Returns the user defined function in the Confidential Ledger.
GetUserDefinedFunctionAsync(String, RequestContext)	[Protocol Method] Returns the user defined function in the Confidential Ledger This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetUserDefinedFunctions(CancellationToken)	User defined functions stored in the Confidential Ledger.
GetUserDefinedFunctions(RequestContext)	[Protocol Method] User defined functions stored in the Confidential Ledger This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetUserDefinedFunctionsAsync(CancellationToken)	User defined functions stored in the Confidential Ledger.
GetUserDefinedFunctionsAsync(RequestContext)	[Protocol Method] User defined functions stored in the Confidential Ledger This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetUserDefinedRole(String, CancellationToken)	user defined roles allow users to define and manage app specific AuthZ policy.
GetUserDefinedRole(String, RequestContext)	[Protocol Method] user defined roles allow users to define and manage app specific AuthZ policy. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetUserDefinedRoleAsync(String, CancellationToken)	user defined roles allow users to define and manage app specific AuthZ policy.
GetUserDefinedRoleAsync(String, RequestContext)	[Protocol Method] user defined roles allow users to define and manage app specific AuthZ policy. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetUsers(CancellationToken)	All users' object IDs and single role per user will be returned.
GetUsers(RequestContext)	[Protocol Method] All users' object IDs and single role per user will be returned. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetUsersAsync(CancellationToken)	All users' object IDs and single role per user will be returned.
GetUsersAsync(RequestContext)	[Protocol Method] All users' object IDs and single role per user will be returned. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
PostLedgerEntry(WaitUntil, RequestContent, String, RequestContext)	[Protocol Method] Gets all ledger entries. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
PostLedgerEntry(WaitUntil, RequestContent, String, String, RequestContext)	Posts a new entry to the ledger. A collection id may optionally be specified.
PostLedgerEntryAsync(WaitUntil, RequestContent, String, RequestContext)	[Protocol Method] Gets all ledger entries. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
PostLedgerEntryAsync(WaitUntil, RequestContent, String, String, RequestContext)	Posts a new entry to the ledger. A collection id may optionally be specified.
RehydratePostLedgerEntryOperation(String, CancellationToken)	Reconstructs a Operation that represents a queued ledger entry previously initiated against the Confidential Ledger Gateway. Use this to resume polling for an operation whose id was persisted by the caller (typically after the original process has been restarted or when delegating completion to a different worker).
UpdateRuntimeOptionsStable(RequestContent, RequestContext)	[Protocol Method] Updates the runtime options. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
UpdateRuntimeOptionsStableAsync(RequestContent, RequestContext)	[Protocol Method] Updates the runtime options. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
UpdateUserDefinedRoleStable(RequestContent, RequestContext)	[Protocol Method] User defined roles allow users to define and manage app specific AuthZ policy. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
UpdateUserDefinedRoleStableAsync(RequestContent, RequestContext)	[Protocol Method] User defined roles allow users to define and manage app specific AuthZ policy. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

Applies to

Feedback

Was this page helpful?