@azure-rest/confidential-ledger package

Interfaces

CollectionOutput
ConfidentialLedgerEnclavesOutput
ConfidentialLedgerErrorBodyOutput
ConfidentialLedgerErrorOutput
ConsortiumMemberOutput
ConsortiumOutput
ConstitutionOutput
CreateLedgerEntry200Headers
CreateLedgerEntry200Response	A collection id may optionally be specified.
CreateLedgerEntryBodyParam
CreateLedgerEntryMediaTypesParam
CreateLedgerEntryQueryParam
CreateLedgerEntryQueryParamProperties
CreateLedgerEntrydefaultResponse	A collection id may optionally be specified.
CreateOrUpdateUser200Response	A JSON merge patch is applied for existing users
CreateOrUpdateUserBodyParam
CreateOrUpdateUserMediaTypesParam
CreateOrUpdateUserdefaultResponse	A JSON merge patch is applied for existing users
DeleteUser
DeleteUser204Response	Deletes a user from the Confidential Ledger.
DeleteUserdefaultResponse	Deletes a user from the Confidential Ledger.
EnclaveQuoteOutput
GetConstitution
GetConstitution200Response	The constitution is a script that assesses and applies proposals from consortium members.
GetConstitutiondefaultResponse	The constitution is a script that assesses and applies proposals from consortium members.
GetCurrentLedgerEntry
GetCurrentLedgerEntry200Response	A collection id may optionally be specified.
GetCurrentLedgerEntryQueryParam
GetCurrentLedgerEntryQueryParamProperties
GetCurrentLedgerEntrydefaultResponse	A collection id may optionally be specified.
GetEnclaveQuotes
GetEnclaveQuotes200Response	A quote is an SGX enclave measurement that can be used to verify the validity of a node and its enclave.
GetEnclaveQuotesdefaultResponse	A quote is an SGX enclave measurement that can be used to verify the validity of a node and its enclave.
GetLedgerEntry
GetLedgerEntry200Response	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.
GetLedgerEntryQueryParam
GetLedgerEntryQueryParamProperties
GetLedgerEntrydefaultResponse	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.
GetReceipt
GetReceipt200Response	Gets a receipt certifying ledger contents at a particular transaction id.
GetReceiptdefaultResponse	Gets a receipt certifying ledger contents at a particular transaction id.
GetTransactionStatus
GetTransactionStatus200Response	Gets the status of an entry identified by a transaction id.
GetTransactionStatusdefaultResponse	Gets the status of an entry identified by a transaction id.
GetUser200Response	Gets a user.
GetUserdefaultResponse	Gets a user.
LedgerEntry
LedgerEntryOutput
LedgerIdentity
LedgerQueryResultOutput
LedgerUser
LedgerUserOutput
LedgerWriteResultOutput
ListCollections
ListCollections200Response	Collection ids are user-created collections of ledger entries
ListCollectionsdefaultResponse	Collection ids are user-created collections of ledger entries
ListConsortiumMembers
ListConsortiumMembers200Response	Consortium members can manage the Confidential Ledger.
ListConsortiumMembersdefaultResponse	Consortium members can manage the Confidential Ledger.
ListLedgerEntries
ListLedgerEntries200Response	A collection id may optionally be specified. Only entries in the specified (or default) collection will be returned.
ListLedgerEntriesQueryParam
ListLedgerEntriesQueryParamProperties
ListLedgerEntriesdefaultResponse	A collection id may optionally be specified. Only entries in the specified (or default) collection will be returned.
PagedCollectionsOutput
PagedLedgerEntriesOutput
PagingOptions	Options for the paging helper
ReceiptContentsOutput
ReceiptElementOutput
ReceiptLeafComponentsOutput
Routes
TransactionReceiptOutput
TransactionStatusOutput

Type Aliases

ConfidentialLedgerClient
CreateLedgerEntryParameters
CreateOrUpdateUserParameters
DeleteUserParameters
GetArrayType	Helper type to extract the type of an array
GetConstitutionParameters
GetCurrentLedgerEntryParameters
GetEnclaveQuotesParameters
GetLedgerEntryParameters
GetPage	The type of a custom function that defines how to get a page and a link to the next one if any.
GetReceiptParameters
GetTransactionStatusParameters
GetUserParameters
ListCollectionsParameters
ListConsortiumMembersParameters
ListLedgerEntriesParameters
PaginateReturn	Helper type to infer the Type of the paged elements from the response type This type is generated based on the swagger information for x-ms-pageable specifically on the itemName property which indicates the property of the response where the page items are found. The default value is value. This type will allow us to provide strongly typed Iterator based on the response we get as second parameter

Functions

default(string, string, ClientOptions)
default(string, string, TokenCredential, ClientOptions)
getLedgerIdentity(string, string)
isUnexpected(GetConstitution200Response | GetConstitutiondefaultResponse)
isUnexpected(ListConsortiumMembers200Response | ListConsortiumMembersdefaultResponse)
isUnexpected(GetEnclaveQuotes200Response | GetEnclaveQuotesdefaultResponse)
isUnexpected(ListCollections200Response | ListCollectionsdefaultResponse)
isUnexpected(ListLedgerEntries200Response | ListLedgerEntriesdefaultResponse)
isUnexpected(CreateLedgerEntry200Response | CreateLedgerEntrydefaultResponse)
isUnexpected(GetLedgerEntry200Response | GetLedgerEntrydefaultResponse)
isUnexpected(GetReceipt200Response | GetReceiptdefaultResponse)
isUnexpected(GetTransactionStatus200Response | GetTransactionStatusdefaultResponse)
isUnexpected(GetCurrentLedgerEntry200Response | GetCurrentLedgerEntrydefaultResponse)
isUnexpected(DeleteUser204Response | DeleteUserdefaultResponse)
isUnexpected(GetUser200Response | GetUserdefaultResponse)
isUnexpected(CreateOrUpdateUser200Response | CreateOrUpdateUserdefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)	Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

Function Details

default(string, string, ClientOptions)

function default(ledgerEndpoint: string, ledgerIdentityCertificate: string, options?: ClientOptions): ConfidentialLedgerClient

Parameters

ledgerEndpoint

string

ledgerIdentityCertificate

string

options

ClientOptions

Returns

ConfidentialLedgerClient

default(string, string, TokenCredential, ClientOptions)

function default(ledgerEndpoint: string, ledgerIdentityCertificate: string, credentials: TokenCredential, options?: ClientOptions): ConfidentialLedgerClient

Parameters

ledgerEndpoint

string

ledgerIdentityCertificate

string

credentials

TokenCredential

options

ClientOptions

Returns

ConfidentialLedgerClient

getLedgerIdentity(string, string)

function getLedgerIdentity(ledgerId: string, identityServiceBaseUrl?: string): Promise<LedgerIdentity>

Parameters

ledgerId

string

identityServiceBaseUrl

string

Returns

Promise<LedgerIdentity>

isUnexpected(GetConstitution200Response | GetConstitutiondefaultResponse)

function isUnexpected(response: GetConstitution200Response | GetConstitutiondefaultResponse): response

Parameters

response

GetConstitution200Response | GetConstitutiondefaultResponse

Returns

response

isUnexpected(ListConsortiumMembers200Response | ListConsortiumMembersdefaultResponse)

function isUnexpected(response: ListConsortiumMembers200Response | ListConsortiumMembersdefaultResponse): response

Parameters

response

ListConsortiumMembers200Response | ListConsortiumMembersdefaultResponse

Returns

response

isUnexpected(GetEnclaveQuotes200Response | GetEnclaveQuotesdefaultResponse)

function isUnexpected(response: GetEnclaveQuotes200Response | GetEnclaveQuotesdefaultResponse): response

Parameters

response

GetEnclaveQuotes200Response | GetEnclaveQuotesdefaultResponse

Returns

response

isUnexpected(ListCollections200Response | ListCollectionsdefaultResponse)

function isUnexpected(response: ListCollections200Response | ListCollectionsdefaultResponse): response

Parameters

response

ListCollections200Response | ListCollectionsdefaultResponse

Returns

response

isUnexpected(ListLedgerEntries200Response | ListLedgerEntriesdefaultResponse)

function isUnexpected(response: ListLedgerEntries200Response | ListLedgerEntriesdefaultResponse): response

Parameters

response

ListLedgerEntries200Response | ListLedgerEntriesdefaultResponse

Returns

response

isUnexpected(CreateLedgerEntry200Response | CreateLedgerEntrydefaultResponse)

function isUnexpected(response: CreateLedgerEntry200Response | CreateLedgerEntrydefaultResponse): response

Parameters

response

CreateLedgerEntry200Response | CreateLedgerEntrydefaultResponse

Returns

response

isUnexpected(GetLedgerEntry200Response | GetLedgerEntrydefaultResponse)

function isUnexpected(response: GetLedgerEntry200Response | GetLedgerEntrydefaultResponse): response

Parameters

response

GetLedgerEntry200Response | GetLedgerEntrydefaultResponse

Returns

response

isUnexpected(GetReceipt200Response | GetReceiptdefaultResponse)

function isUnexpected(response: GetReceipt200Response | GetReceiptdefaultResponse): response

Parameters

response

GetReceipt200Response | GetReceiptdefaultResponse

Returns

response

isUnexpected(GetTransactionStatus200Response | GetTransactionStatusdefaultResponse)

function isUnexpected(response: GetTransactionStatus200Response | GetTransactionStatusdefaultResponse): response

Parameters

response

GetTransactionStatus200Response | GetTransactionStatusdefaultResponse

Returns

response

isUnexpected(GetCurrentLedgerEntry200Response | GetCurrentLedgerEntrydefaultResponse)

function isUnexpected(response: GetCurrentLedgerEntry200Response | GetCurrentLedgerEntrydefaultResponse): response

Parameters

response

GetCurrentLedgerEntry200Response | GetCurrentLedgerEntrydefaultResponse

Returns

response

isUnexpected(DeleteUser204Response | DeleteUserdefaultResponse)

function isUnexpected(response: DeleteUser204Response | DeleteUserdefaultResponse): response

Parameters

response

DeleteUser204Response | DeleteUserdefaultResponse

Returns

response

isUnexpected(GetUser200Response | GetUserdefaultResponse)

function isUnexpected(response: GetUser200Response | GetUserdefaultResponse): response

Parameters

response

GetUser200Response | GetUserdefaultResponse

Returns

response

isUnexpected(CreateOrUpdateUser200Response | CreateOrUpdateUserdefaultResponse)

function isUnexpected(response: CreateOrUpdateUser200Response | CreateOrUpdateUserdefaultResponse): response

Parameters

response

CreateOrUpdateUser200Response | CreateOrUpdateUserdefaultResponse

Returns

response

paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>

Parameters

client

Client

Client to use for sending the next page requests

initialResponse

TResponse

Initial response containing the nextLink and current page of elements

options

PagingOptions<TResponse>

Returns

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator to iterate the elements