Azure 机密账本

ConfidentialLedgerClient 针对机密账本服务写入和检索账本条目。

此连接器在以下产品和区域中可用：

服务	Class	区域
Copilot Studio	高级	除以下各项外的所有 Power Automate 区域 ：      - 美国政府 （GCC）      - 美国政府 （GCC High）      - 由世纪互联运营的中国云      - 美国国防部（DoD）
Power Apps	高级	除以下各项外的所有 Power Apps 区域 ：      - 美国政府 （GCC）      - 美国政府 （GCC High）      - 由世纪互联运营的中国云      - 美国国防部（DoD）
Power Automate	高级	除以下各项外的所有 Power Automate 区域 ：      - 美国政府 （GCC）      - 美国政府 （GCC High）      - 由世纪互联运营的中国云      - 美国国防部（DoD）

联系人​​
Name	Azure 机密账本团队
Email	accledgerdevs@microsoft.com

连接器元数据
发布者	Microsoft Corporation
网站	https://www.microsoft.com/en-us/microsoft-365
隐私策略	https://privacy.microsoft.com/
类别	生产力

创建连接

连接器支持以下身份验证类型：

默认	用于创建连接的参数。	所有区域	不可共享

违约

适用：所有区域

用于创建连接的参数。

这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

限制

名称	调用	续订期
每个连接的 API 调用数	100	60 秒

操作

写入账本条目	可以选择指定集合 ID。
按事务 ID 获取收据	返回可用于验证事务完整性的加密收据。
按事务 ID 获取条目的状态	返回事务的当前状态，指示它是否已提交到账本。
按事务 ID 获取账本条目	可以选择指定集合 ID 以指示要从中提取值的集合。 若要返回较旧的账本条目，必须从磁盘读取并验证账本的相关部分。 为防止 enclave 内阻塞，响应将指示条目是否已准备就绪，以及响应的一部分，或者加载仍在进行中。
按集合和范围获取账本条目	可以选择指定集合 ID。 仅返回指定（或默认）集合中的条目。
获取当前账本条目	可以选择指定集合 ID 以指示要从中提取值的集合。 若要返回较旧的账本条目，必须从磁盘读取并验证账本的相关部分。 为防止 enclave 内阻塞，响应将指示条目是否已准备就绪，以及响应的一部分，或者加载仍在进行中。

写入账本条目

操作 ID:

CreateLedgerEntry

可以选择指定集合 ID。

参数

名称	密钥	必需	类型	说明
要用于 HTTP 请求的 API 版本。	api-version	True	string	要用于 HTTP 请求的 API 版本。
集合 ID。	collectionId		string	集合 ID。
内容	contents	True	string	账本条目的内容。
collectionId	collectionId		string
交易 ID	transactionId		string	交易 ID
账本的名称。	ledgerName	True	string	账本的名称。

返回

作为写入机密账本的结果返回的，响应中的事务 ID 指示写入何时变为持久。

Body

LedgerWriteResult

按事务 ID 获取收据

操作 ID:

GetReceipt

返回可用于验证事务完整性的加密收据。

参数

名称	密钥	必需	类型	说明
要用于 HTTP 请求的 API 版本。	api-version	True	string	要用于 HTTP 请求的 API 版本。
标识写入事务。	transactionId	True	string	标识写入事务。
账本的名称。	ledgerName	True	string	账本的名称。

返回

在指定 ID 处认证事务的收据。

Body

TransactionReceipt

按事务 ID 获取条目的状态

操作 ID:

GetTransactionStatus

返回事务的当前状态，指示它是否已提交到账本。

参数

名称	密钥	必需	类型	说明
要用于 HTTP 请求的 API 版本。	api-version	True	string	要用于 HTTP 请求的 API 版本。
标识写入事务。	transactionId	True	string	标识写入事务。
账本的名称。	ledgerName	True	string	账本的名称。

返回

返回对事务状态的查询的响应

Body

TransactionStatus

按事务 ID 获取账本条目

操作 ID:

GetLedgerEntry

可以选择指定集合 ID 以指示要从中提取值的集合。 若要返回较旧的账本条目，必须从磁盘读取并验证账本的相关部分。 为防止 enclave 内阻塞，响应将指示条目是否已准备就绪，以及响应的一部分，或者加载仍在进行中。

参数

名称	密钥	必需	类型	说明
要用于 HTTP 请求的 API 版本。	api-version	True	string	要用于 HTTP 请求的 API 版本。
集合 ID。	collectionId		string	集合 ID。
标识写入事务。	transactionId	True	string	标识写入事务。
账本的名称。	ledgerName	True	string	账本的名称。

返回

从较旧的事务 ID 查询账本条目的结果。仅当返回的状态为“就绪”时，账本条目才在响应中可用。

Body

LedgerQueryResult

按集合和范围获取账本条目

操作 ID:

ListLedgerEntries

可以选择指定集合 ID。 仅返回指定（或默认）集合中的条目。

参数

名称	密钥	必需	类型	说明
要用于 HTTP 请求的 API 版本。	api-version	True	string	要用于 HTTP 请求的 API 版本。
集合 ID。	collectionId		string	集合 ID。
指定区域中的第一个事务 ID。	fromTransactionId		string	指定区域中的第一个事务 ID。
指定区域中的最后一个事务 ID。	toTransactionId		string	指定区域中的最后一个事务 ID。
账本的名称。	ledgerName	True	string	账本的名称。

返回

响应查询时返回的分页账本条目。

Body

PagedLedgerEntries

获取当前账本条目

操作 ID:

GetCurrentLedgerEntry

可以选择指定集合 ID 以指示要从中提取值的集合。 若要返回较旧的账本条目，必须从磁盘读取并验证账本的相关部分。 为防止 enclave 内阻塞，响应将指示条目是否已准备就绪，以及响应的一部分，或者加载仍在进行中。

参数

名称	密钥	必需	类型	说明
要用于 HTTP 请求的 API 版本。	api-version	True	string	要用于 HTTP 请求的 API 版本。
集合 ID。	collectionId		string	集合 ID。
账本的名称。	ledgerName	True	string	账本的名称。

返回

账本中的条目。

Body

LedgerEntry

定义

LedgerEntries

账本条目的数组。

名称	路径	类型	说明
物品		LedgerEntry	账本中的条目。

LedgerEntry

账本中的条目。

名称	路径	类型	说明
内容	contents	string	账本条目的内容。
collectionId	collectionId	string
交易 ID	transactionId	string	交易 ID

LedgerQueryResult

从较旧的事务 ID 查询账本条目的结果。仅当返回的状态为“就绪”时，账本条目才在响应中可用。

名称	路径	类型	说明
状态	state	LedgerQueryState	账本查询的状态。
输入	entry	LedgerEntry	账本中的条目。

LedgerQueryState

账本查询的状态。

账本查询的状态。

string

LedgerWriteResult

作为写入机密账本的结果返回的，响应中的事务 ID 指示写入何时变为持久。

名称	路径	类型	说明
collectionId	collectionId	string

PagedLedgerEntries

响应查询时返回的分页账本条目。

名称	路径	类型	说明
状态	state	LedgerQueryState	账本查询的状态。
nextLink	nextLink	string	从中检索下一页结果的路径。
条目	entries	LedgerEntries	账本条目的数组。

TransactionId

账本状态的唯一标识符。 如果作为 LedgerEntry 的一部分返回，则指示从中读取条目的状态。

账本状态的唯一标识符。 如果作为 LedgerEntry 的一部分返回，则指示从中读取条目的状态。

string

TransactionReceipt

在指定 ID 处认证事务的收据。

名称	路径	类型	说明
applicationClaims	applicationClaims	ApplicationClaims	应用程序声明列表。
收据	receipt	ReceiptContents
状态	state	LedgerQueryState	账本查询的状态。
交易 ID	transactionId	TransactionId	账本状态的唯一标识符。 如果作为 LedgerEntry 的一部分返回，则指示从中读取条目的状态。

TransactionState

表示事务的状态。

表示事务的状态。

string

TransactionStatus

返回对事务状态的查询的响应

名称	路径	类型	说明
状态	state	TransactionState	表示事务的状态。
交易 ID	transactionId	TransactionId	账本状态的唯一标识符。 如果作为 LedgerEntry 的一部分返回，则指示从中读取条目的状态。

ApplicationClaims

应用程序声明列表。

名称	路径	类型	说明
物品		ApplicationClaim	账本应用程序的声明。

ApplicationClaim

账本应用程序的声明。

名称	路径	类型	说明
摘要	digest	ClaimDigest	采用摘要形式的应用程序声明。
kind	kind	ApplicationClaimKind	表示应用程序声明的类型。
ledgerEntry	ledgerEntry	LedgerEntryClaim	从账本输入数据派生的应用程序声明。

ApplicationClaimKind

表示应用程序声明的类型。

表示应用程序声明的类型。

string

ApplicationClaimProtocol

表示用于计算给定声明数据的声明摘要的协议。

表示用于计算给定声明数据的声明摘要的协议。

string

ClaimDigest

采用摘要形式的应用程序声明。

名称	路径	类型	说明
value	value	string	应用程序声明的摘要，采用十六进制形式。
协议	protocol	ApplicationClaimProtocol	表示用于计算给定声明数据的声明摘要的协议。

LedgerEntryClaim

从账本输入数据派生的应用程序声明。

名称	路径	类型	说明
collectionId	collectionId	string	集合的标识符。
内容	contents	string	账本条目的内容。
secretKey 密钥	secretKey	string	Base64 编码的密钥。
协议	protocol	ApplicationClaimProtocol	表示用于计算给定声明数据的声明摘要的协议。

ReceiptContents

名称	路径	类型	说明
证书	cert	string
叶	leaf	string
leafComponents	leafComponents	ReceiptLeafComponents
nodeId	nodeId	string
证明	proof	ReceiptElementArray
根	root	string
serviceEndorsements	serviceEndorsements	PemArray
签名	signature	string

ReceiptElement

名称	路径	类型	说明
left	left	string
右	right	string

ReceiptElementArray

名称	路径	类型	说明
物品		ReceiptElement

ReceiptLeafComponents

名称	路径	类型	说明
claimsDigest	claimsDigest	string
commitEvidence	commitEvidence	string
writeSetDigest	writeSetDigest	string

Pem

string

PemArray

名称	路径	类型	说明
物品		Pem