Azure Confidential Ledger
The ConfidentialLedgerClient writes and retrieves ledger entries against the Confidential Ledger service.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Azure Confidential Ledger Team |
| accledgerdevs@microsoft.com |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft Corporation |
| Website | https://www.microsoft.com/en-us/microsoft-365 |
| Privacy policy | https://privacy.microsoft.com/ |
| Categories | Productivity |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Gets a receipt by transaction id |
Returns a cryptographic receipt that can be used to verify the integrity of a transaction. |
| Gets ledger entries by collection and range |
A collection id may optionally be specified. Only entries in the specified (or default) collection will be returned. |
| Gets the current ledger entry |
A collection id may optionally be specified to indicate the collection from which to fetch the value. 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. |
| Gets the ledger entry by transaction id |
A collection id may optionally be specified to indicate the collection from which to fetch the value. 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. |
| Gets the status of an entry by transaction id |
Returns the current status of a transaction, indicating whether it has been committed to the ledger. |
| Writes a ledger entry |
A collection id may optionally be specified. |
Gets a receipt by transaction id
Returns a cryptographic receipt that can be used to verify the integrity of a transaction.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The API version to be used with the HTTP request.
|
api-version | True | string |
The API version to be used with the HTTP request. |
|
Identifies a write transaction.
|
transactionId | True | string |
Identifies a write transaction. |
|
The name of the ledger.
|
ledgerName | True | string |
The name of the ledger. |
Returns
A receipt certifying the transaction at the specified id.
- Body
- TransactionReceipt
Gets ledger entries by collection and range
A collection id may optionally be specified. Only entries in the specified (or default) collection will be returned.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The API version to be used with the HTTP request.
|
api-version | True | string |
The API version to be used with the HTTP request. |
|
The collection id.
|
collectionId | string |
The collection id. |
|
|
Specify the first transaction ID in a range.
|
fromTransactionId | string |
Specify the first transaction ID in a range. |
|
|
Specify the last transaction ID in a range.
|
toTransactionId | string |
Specify the last transaction ID in a range. |
|
|
The name of the ledger.
|
ledgerName | True | string |
The name of the ledger. |
Returns
Paginated ledger entries returned in response to a query.
- Body
- PagedLedgerEntries
Gets the current ledger entry
A collection id may optionally be specified to indicate the collection from which to fetch the value. 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.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The API version to be used with the HTTP request.
|
api-version | True | string |
The API version to be used with the HTTP request. |
|
The collection id.
|
collectionId | string |
The collection id. |
|
|
The name of the ledger.
|
ledgerName | True | string |
The name of the ledger. |
Returns
An entry in the ledger.
- Body
- LedgerEntry
Gets the ledger entry by transaction id
A collection id may optionally be specified to indicate the collection from which to fetch the value. 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.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The API version to be used with the HTTP request.
|
api-version | True | string |
The API version to be used with the HTTP request. |
|
The collection id.
|
collectionId | string |
The collection id. |
|
|
Identifies a write transaction.
|
transactionId | True | string |
Identifies a write transaction. |
|
The name of the ledger.
|
ledgerName | True | string |
The name of the ledger. |
Returns
The result of querying for a ledger entry from an older transaction id. The ledger entry is available in the response only if the returned state is Ready.
- Body
- LedgerQueryResult
Gets the status of an entry by transaction id
Returns the current status of a transaction, indicating whether it has been committed to the ledger.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The API version to be used with the HTTP request.
|
api-version | True | string |
The API version to be used with the HTTP request. |
|
Identifies a write transaction.
|
transactionId | True | string |
Identifies a write transaction. |
|
The name of the ledger.
|
ledgerName | True | string |
The name of the ledger. |
Returns
Response returned to a query for the transaction status
- Body
- TransactionStatus
Writes a ledger entry
A collection id may optionally be specified.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The API version to be used with the HTTP request.
|
api-version | True | string |
The API version to be used with the HTTP request. |
|
The collection id.
|
collectionId | string |
The collection id. |
|
|
contents
|
contents | True | string |
Contents of the ledger entry. |
|
collectionId
|
collectionId | string | ||
|
transactionId
|
transactionId | string |
Transaction Id |
|
|
The name of the ledger.
|
ledgerName | True | string |
The name of the ledger. |
Returns
Returned as a result of a write to the Confidential Ledger, the transaction id in the response indicates when the write will become durable.
- Body
- LedgerWriteResult
Definitions
LedgerEntries
Array of ledger entries.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
LedgerEntry |
An entry in the ledger. |
LedgerEntry
An entry in the ledger.
| Name | Path | Type | Description |
|---|---|---|---|
|
contents
|
contents | string |
Contents of the ledger entry. |
|
collectionId
|
collectionId | string | |
|
transactionId
|
transactionId | string |
Transaction Id |
LedgerQueryResult
The result of querying for a ledger entry from an older transaction id. The ledger entry is available in the response only if the returned state is Ready.
| Name | Path | Type | Description |
|---|---|---|---|
|
state
|
state | LedgerQueryState |
State of a ledger query. |
|
entry
|
entry | LedgerEntry |
An entry in the ledger. |
LedgerQueryState
LedgerWriteResult
Returned as a result of a write to the Confidential Ledger, the transaction id in the response indicates when the write will become durable.
| Name | Path | Type | Description |
|---|---|---|---|
|
collectionId
|
collectionId | string |
PagedLedgerEntries
Paginated ledger entries returned in response to a query.
| Name | Path | Type | Description |
|---|---|---|---|
|
state
|
state | LedgerQueryState |
State of a ledger query. |
|
nextLink
|
nextLink | string |
Path from which to retrieve the next page of results. |
|
entries
|
entries | LedgerEntries |
Array of ledger entries. |
TransactionId
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.
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.
TransactionReceipt
A receipt certifying the transaction at the specified id.
| Name | Path | Type | Description |
|---|---|---|---|
|
applicationClaims
|
applicationClaims | ApplicationClaims |
List of application claims. |
|
receipt
|
receipt | ReceiptContents | |
|
state
|
state | LedgerQueryState |
State of a ledger query. |
|
transactionId
|
transactionId | TransactionId |
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. |
TransactionState
TransactionStatus
Response returned to a query for the transaction status
| Name | Path | Type | Description |
|---|---|---|---|
|
state
|
state | TransactionState |
Represents the state of the transaction. |
|
transactionId
|
transactionId | TransactionId |
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. |
ApplicationClaims
List of application claims.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
ApplicationClaim |
A claim of a ledger application. |
ApplicationClaim
A claim of a ledger application.
| Name | Path | Type | Description |
|---|---|---|---|
|
digest
|
digest | ClaimDigest |
An application claim in digested form. |
|
kind
|
kind | ApplicationClaimKind |
Represents the kind of an application claim. |
|
ledgerEntry
|
ledgerEntry | LedgerEntryClaim |
An application claim derived from ledger entry data. |
ApplicationClaimKind
ApplicationClaimProtocol
Represents the protocol to be used to compute the digest of a claim from the given claim data.
Represents the protocol to be used to compute the digest of a claim from the given claim data.
ClaimDigest
An application claim in digested form.
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | string |
The digest of the application claim, in hexadecimal form. |
|
protocol
|
protocol | ApplicationClaimProtocol |
Represents the protocol to be used to compute the digest of a claim from the given claim data. |
LedgerEntryClaim
An application claim derived from ledger entry data.
| Name | Path | Type | Description |
|---|---|---|---|
|
collectionId
|
collectionId | string |
Identifier of a collection. |
|
contents
|
contents | string |
Contents of a ledger entry. |
|
secretKey
|
secretKey | string |
Base64-encoded secret key. |
|
protocol
|
protocol | ApplicationClaimProtocol |
Represents the protocol to be used to compute the digest of a claim from the given claim data. |
ReceiptContents
| Name | Path | Type | Description |
|---|---|---|---|
|
cert
|
cert | string | |
|
leaf
|
leaf | string | |
|
leafComponents
|
leafComponents | ReceiptLeafComponents | |
|
nodeId
|
nodeId | string | |
|
proof
|
proof | ReceiptElementArray | |
|
root
|
root | string | |
|
serviceEndorsements
|
serviceEndorsements | PemArray | |
|
signature
|
signature | string |
ReceiptElement
| Name | Path | Type | Description |
|---|---|---|---|
|
left
|
left | string | |
|
right
|
right | string |
ReceiptElementArray
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
ReceiptElement |
ReceiptLeafComponents
| Name | Path | Type | Description |
|---|---|---|---|
|
claimsDigest
|
claimsDigest | string | |
|
commitEvidence
|
commitEvidence | string | |
|
writeSetDigest
|
writeSetDigest | string |
Pem
PemArray
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
Pem |