你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az confidentialledger

Note

此命令组具有两个或多个扩展中定义的命令。每次运行扩展命令时，每个扩展都会自动安装。 Learn more about extensions.

管理机密账本。

命令

名称	说明	类型	Status
az confidentialledger check-name-availability	检查资源名称是否可用。	Extension	GA
az confidentialledger create	使用指定的账本参数创建机密账本。	Extension	GA
az confidentialledger delete	删除现有的机密账本。	Extension	GA
az confidentialledger list	列出所有机密账本的属性。	Extension	GA
az confidentialledger managedccfs	部署和管理 Azure 托管 CCF 实例。	Extension	Preview
az confidentialledger managedccfs create	创建 Azure 托管 CCF 服务的实例。	Extension	Preview
az confidentialledger managedccfs delete	删除托管 CCF 实例。	Extension	Preview
az confidentialledger managedccfs list	查看资源组中的 Azure 托管 CCF 实例。	Extension	Preview
az confidentialledger managedccfs show	查看实例的详细信息。	Extension	Preview
az confidentialledger managedccfs update	修补托管 CCF 实例。	Extension	Preview
az confidentialledger managedccfs wait	将 CLI 置于等待状态，直到满足条件。	Extension	Preview
az confidentialledger show	获取机密账本的属性。	Extension	GA
az confidentialledger update	使用指定的账本参数更新机密账本。	Extension	GA
az confidentialledger wait	将 CLI 置于等待状态，直到满足条件。	Extension	GA

az confidentialledger check-name-availability

检查资源名称是否可用。

az confidentialledger check-name-availability [--name]
                                              [--type]

示例

CheckNameAvailability

az confidentialledger check-name-availability --type Microsoft.ConfidentialLedger/ledgers --name sample-name

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--name

需要检查其可用性的资源的名称。

属性	值
Parameter group:	NameAvailabilityRequest Arguments

--type

资源类型。

属性	值
Parameter group:	NameAvailabilityRequest Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az confidentialledger create

使用指定的账本参数创建机密账本。

az confidentialledger create --ledger-name --name
                             --resource-group
                             [--aad-based-security-principals --aad-based-users]
                             [--application-type {CodeTransparency, ConfidentialLedger}]
                             [--cert-based-security-principals --cert-based-users]
                             [--enclave-platform {AmdSevSnp, IntelSgx}]
                             [--host-level]
                             [--ledger-sku {Basic, Standard, Unknown}]
                             [--ledger-type {Private, Public, Unknown}]
                             [--location]
                             [--max-body-size-in-mb]
                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                             [--node-count]
                             [--running-state {Active, Paused, Pausing, Resuming, Unknown}]
                             [--subject-name]
                             [--tags]
                             [--worker-threads]
                             [--write-lb-address-prefix --write-lb-prefix]

示例

使用基于证书的安全主体的 ConfidentialLedgerCreate

az confidentialledger create --resource-group DummyResourceGroupName --ledger-name DummyLedgerName --ledger-type Public --ledger-sku Standard --location EastUS --aad-based-security-principals "[{principal-id:34621747-6fc8-4771-a2eb-72f31c461f2e,tenant-id:bce123b9-2b7b-4975-8360-5ca0b9b1cd08,ledger-role-name:Administrator}]" --tags "{additionalProps1:'additional properties'}"

使用基于证书的安全主体的 ConfidentialLedgerCreate

az confidentialledger create --resource-group DummyResourceGroupName --ledger-name DummyLedgerName --ledger-type Public --ledger-sku Standard --location EastUS --cert-based-security-principals "[{cert:'-----BEGIN CERTIFICATE-----MIIBsjCCATigAwIBAgIUZWIbyG79TniQLd2UxJuU74tqrKcwCgYIKoZIzj0EAwMwEDEOMAwGA1UEAwwFdXNlcjAwHhcNMjEwMzE2MTgwNjExWhcNMjIwMzE2MTgwNjExWjAQMQ4wDAYDVQQDDAV1c2VyMDB2MBAGByqGSM49AgEGBSuBBAAiA2IABBiWSo/j8EFit7aUMm5lF+lUmCu+IgfnpFD+7QMgLKtxRJ3aGSqgS/GpqcYVGddnODtSarNE/HyGKUFUolLPQ5ybHcouUk0kyfA7XMeSoUA4lBz63Wha8wmXo+NdBRo39qNTMFEwHQYDVR0OBBYEFPtuhrwgGjDFHeUUT4nGsXaZn69KMB8GA1UdIwQYMBaAFPtuhrwgGjDFHeUUT4nGsXaZn69KMA8GA1UdEwEB/wQFMAMBAf8wCgYIKoZIzj0EAwMDaAAwZQIxAOnozm2CyqRwSSQLls5r+mUHRGRyXHXwYtM4Dcst/VEZdmS9fqvHRCHbjUlO/+HNfgIwMWZ4FmsjD3wnPxONOm9YdVn/PRD7SsPRPbOjwBiE4EBGaHDsLjYAGDSGi7NJnSkA-----END CERTIFICATE-----',ledger-role-name:Reader}]" --tags "{additionalProps1:'additional properties'}"

必需参数

--ledger-name --name -n

机密账本的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--aad-based-security-principals --aad-based-users

所有基于 AAD 的安全主体的数组。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--application-type

机密账本的应用程序类型。

属性	值
Parameter group:	Properties Arguments
接受的值:	CodeTransparency, ConfidentialLedger

--cert-based-security-principals --cert-based-users

所有基于证书的安全主体的数组。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--enclave-platform

机密账本的 Enclave 平台。

属性	值
Parameter group:	Properties Arguments
接受的值:	AmdSevSnp, IntelSgx

--host-level

不受信任的主机的日志记录级别的 CCF 属性：跟踪、调试、信息、失败、致命。

属性	值
Parameter group:	Properties Arguments

--ledger-sku

与账本关联的 SKU。

属性	值
Parameter group:	Properties Arguments
接受的值:	Basic, Standard, Unknown

--ledger-type

机密账本的类型。

属性	值
Parameter group:	Properties Arguments
接受的值:	Private, Public, Unknown

--location -l

未指定资源所在的地理位置，将使用资源组的位置。

属性	值
Parameter group:	ConfidentialLedger Arguments

--max-body-size-in-mb

HTTP 请求正文最大大小的 CCF 属性：1MB、5MB、10MB。

属性	值
Parameter group:	Properties Arguments

--no-wait

不等待长时间运行的操作完成。

属性	值
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--node-count

ACC 账本中的 CCF 节点数。

属性	值
Parameter group:	Properties Arguments

--running-state

表示 Ledger 的 RunningState 的对象。

属性	值
Parameter group:	Properties Arguments
接受的值:	Active, Paused, Pausing, Resuming, Unknown

--subject-name

要包含在节点证书中的使用者名称的 CCF 属性。默认值：CN=CCF 节点。

属性	值
Parameter group:	Properties Arguments

--tags

Resource tags. 支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	ConfidentialLedger Arguments

--worker-threads

处理 enclave 中传入客户端请求的其他线程数（请谨慎修改！）。

属性	值
Parameter group:	Properties Arguments

--write-lb-address-prefix --write-lb-prefix

写入负载均衡器的前缀。 Example: write.

属性	值
Parameter group:	Properties Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az confidentialledger delete

删除现有的机密账本。

az confidentialledger delete [--ids]
                             [--ledger-name --name]
                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                             [--resource-group]
                             [--subscription]
                             [--yes]

示例

ConfidentialLedgerDelete

az confidentialledger delete --resource-group DummyResourceGroupName --ledger-name DummyLedgerName

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--ledger-name --name -n

机密账本的名称。

属性	值
Parameter group:	Resource Id Arguments

--no-wait

不等待长时间运行的操作完成。

属性	值
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

--yes -y

不要提示确认。

属性	值
默认值:	False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az confidentialledger list

列出所有机密账本的属性。

az confidentialledger list [--filter]
                           [--max-items]
                           [--next-token]
                           [--resource-group]

示例

ConfidentialLedgerListBySub

az confidentialledger list

ConfidentialLedgerListByResourceGroup

az confidentialledger list --resource-group DummyResourceGroupName

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--filter

要应用于列表作的筛选器。 eg. $filter=ledgerType eq “Public”。

--max-items

命令输出中要返回的项总数。如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。若要恢复分页，请在后续命令的 --next-token 参数中提供令牌值。

属性	值
Parameter group:	Pagination Arguments

--next-token

用于指定开始分页的位置的令牌。这是先前截断的响应中的令牌值。

属性	值
Parameter group:	Pagination Arguments

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az confidentialledger show

获取机密账本的属性。

az confidentialledger show [--ids]
                           [--ledger-name --name]
                           [--resource-group]
                           [--subscription]

示例

ConfidentialLedgerGet

az confidentialledger show --resource-group DummyResourceGroupName --ledger-name DummyLedgerName

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--ledger-name --name -n

机密账本的名称。

属性	值
Parameter group:	Resource Id Arguments

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az confidentialledger update

使用指定的账本参数更新机密账本。

az confidentialledger update [--aad-based-security-principals --aad-based-users]
                             [--add]
                             [--application-type {CodeTransparency, ConfidentialLedger}]
                             [--cert-based-security-principals --cert-based-users]
                             [--enclave-platform {AmdSevSnp, IntelSgx}]
                             [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                             [--host-level]
                             [--ids]
                             [--ledger-name --name]
                             [--ledger-sku {Basic, Standard, Unknown}]
                             [--ledger-type {Private, Public, Unknown}]
                             [--max-body-size-in-mb]
                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                             [--node-count]
                             [--remove]
                             [--resource-group]
                             [--running-state {Active, Paused, Pausing, Resuming, Unknown}]
                             [--set]
                             [--subject-name]
                             [--subscription]
                             [--tags]
                             [--worker-threads]
                             [--write-lb-address-prefix --write-lb-prefix]

示例

ConfidentialLedgerUpdate

az confidentialledger update --resource-group DummyResourceGroupName --ledger-name DummyLedgerName --location EastUS --aad-based-security-principals "[{principal-id:34621747-6fc8-4771-a2eb-72f31c461f2e,tenant-id:bce123b9-2b7b-4975-8360-5ca0b9b1cd08,ledger-role-name:Contributor}]" --tags "{additionalProps1:'additional update properties'}"

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--aad-based-security-principals --aad-based-users

所有基于 AAD 的安全主体的数组。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--add

通过指定路径和键值对将对象添加到对象列表。示例：--add property.listProperty <key=value, string or JSON string>。

属性	值
Parameter group:	Generic Update Arguments

--application-type

机密账本的应用程序类型。

属性	值
Parameter group:	Properties Arguments
接受的值:	CodeTransparency, ConfidentialLedger

--cert-based-security-principals --cert-based-users

所有基于证书的安全主体的数组。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--enclave-platform

机密账本的 Enclave 平台。

属性	值
Parameter group:	Properties Arguments
接受的值:	AmdSevSnp, IntelSgx

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

属性	值
Parameter group:	Generic Update Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--host-level

不受信任的主机的日志记录级别的 CCF 属性：跟踪、调试、信息、失败、致命。

属性	值
Parameter group:	Properties Arguments

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--ledger-name --name -n

机密账本的名称。

属性	值
Parameter group:	Resource Id Arguments

--ledger-sku

与账本关联的 SKU。

属性	值
Parameter group:	Properties Arguments
接受的值:	Basic, Standard, Unknown

--ledger-type

机密账本的类型。

属性	值
Parameter group:	Properties Arguments
接受的值:	Private, Public, Unknown

--max-body-size-in-mb

HTTP 请求正文最大大小的 CCF 属性：1MB、5MB、10MB。

属性	值
Parameter group:	Properties Arguments

--no-wait

不等待长时间运行的操作完成。

属性	值
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--node-count

ACC 账本中的 CCF 节点数。

属性	值
Parameter group:	Properties Arguments

--remove

从列表中删除属性或元素。示例： --remove property.list <indexToRemove> OR --remove propertyToRemove.

属性	值
Parameter group:	Generic Update Arguments

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--running-state

表示 Ledger 的 RunningState 的对象。

属性	值
Parameter group:	Properties Arguments
接受的值:	Active, Paused, Pausing, Resuming, Unknown

--set

通过指定要设置的属性路径和值来更新对象。示例：--set property1.property2=<value>。

属性	值
Parameter group:	Generic Update Arguments

--subject-name

要包含在节点证书中的使用者名称的 CCF 属性。默认值：CN=CCF 节点。

属性	值
Parameter group:	Properties Arguments

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

--tags

Resource tags. 支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	ConfidentialLedger Arguments

--worker-threads

处理 enclave 中传入客户端请求的其他线程数（请谨慎修改！）。

属性	值
Parameter group:	Properties Arguments

--write-lb-address-prefix --write-lb-prefix

写入负载均衡器的前缀。 Example: write.

属性	值
Parameter group:	Properties Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az confidentialledger wait

将 CLI 置于等待状态，直到满足条件。

az confidentialledger wait [--created]
                           [--custom]
                           [--deleted]
                           [--exists]
                           [--ids]
                           [--interval]
                           [--ledger-name --name]
                           [--resource-group]
                           [--subscription]
                           [--timeout]
                           [--updated]

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

等待在“Succeeded”中使用“provisioningState”创建。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--custom

等待条件满足自定义 JMESPath 查询。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

属性	值
Parameter group:	Wait Condition Arguments

--deleted

等到删除为止。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--exists

等待资源存在。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--interval

轮询间隔（以秒为单位）。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	30

--ledger-name --name -n

机密账本的名称。

属性	值
Parameter group:	Resource Id Arguments

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

--timeout

最大等待（以秒为单位）。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	3600

--updated

等到 provisioningState 更新为“Succeeded”。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

通过

az confidentialledger

命令

az confidentialledger check-name-availability

示例

可选参数

az confidentialledger create

示例

必需参数

可选参数

az confidentialledger delete

示例

可选参数

az confidentialledger list

示例

可选参数

az confidentialledger show

示例

可选参数

az confidentialledger update

示例

可选参数

az confidentialledger wait

可选参数

反馈