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

az disk-encryption-set

  • 参考

磁盘加密集资源。

命令

名称 说明 类型 状态
az disk-encryption-set create

创建磁盘加密集。

 核心 GA
az disk-encryption-set delete

删除磁盘加密集。

 核心 GA
az disk-encryption-set identity

管理磁盘加密集的标识。

 核心 GA
az disk-encryption-set identity assign

将托管标识添加到现有磁盘加密集。

 核心 GA
az disk-encryption-set identity remove

从现有磁盘加密集中删除托管标识。

 核心 GA
az disk-encryption-set identity show

显示磁盘加密集的托管标识。

 核心 GA
az disk-encryption-set list

列出磁盘加密集。

 核心 GA
az disk-encryption-set list-associated-resources

列出使用此磁盘加密集加密的所有资源。

 核心 GA
az disk-encryption-set show

获取有关磁盘加密集的信息。

 核心 GA
az disk-encryption-set update

更新磁盘加密集。

 核心 GA
az disk-encryption-set wait

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

 核心 GA

az disk-encryption-set create

创建磁盘加密集。

az disk-encryption-set create --key-url
                              --name
                              --resource-group
                              [--auto-rotation {false, true}]
                              [--encryption-type {ConfidentialVmEncryptedWithCustomerKey, EncryptionAtRestWithCustomerKey, EncryptionAtRestWithPlatformAndCustomerKeys, EncryptionAtRestWithPlatformKey}]
                              [--federated-client-id]
                              [--location]
                              [--mi-system-assigned {false, true}]
                              [--mi-user-assigned]
                              [--no-wait]
                              [--source-vault]
                              [--tags]

示例

创建磁盘加密集。

az disk-encryption-set create --resource-group MyResourceGroup --name MyDiskEncryptionSet --key-url MyKey --source-vault MyVault

使用系统分配的标识创建磁盘加密集。

az disk-encryption-set create --resource-group MyResourceGroup --name MyDiskEncryptionSet --key-url MyKey --source-vault MyVault --mi-system-assigned

使用用户分配的标识创建磁盘加密集。

az disk-encryption-set create --resource-group MyResourceGroup --name MyDiskEncryptionSet --key-url MyKey --source-vault MyVault --mi-user-assigned myAssignedId

使用系统分配的标识和用户分配的标识创建磁盘加密集。

az disk-encryption-set create --resource-group MyResourceGroup --name MyDiskEncryptionSet --key-url MyKey --source-vault MyVault --mi-system-assigned --mi-user-assigned myAssignedId

创建包含多租户应用程序客户端 ID 的磁盘加密集，以访问不同租户中的密钥保管库。

az disk-encryption-set create --resource-group MyResourceGroup --name MyDiskEncryptionSet --key-url MyKey --source-vault MyVault --federated-client-id myFederatedClientId

创建支持双重加密的磁盘加密集。

az disk-encryption-set create --resource-group MyResourceGroup --name MyDiskEncryptionSet --key-url MyKey --source-vault MyVault --encryption-type EncryptionAtRestWithPlatformAndCustomerKeys

必需参数

--key-url

指向 KeyVault 中的密钥或机密的 URL。

--name -n

磁盘加密集的名称。

--resource-group -g

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

可选参数

--auto-rotation --enable-auto-key-rotation

启用密钥的自动轮换。

接受的值: false, true
--encryption-type

用于加密磁盘数据的密钥类型。 EncryptionAtRestWithPlatformKey：磁盘使用平台托管密钥进行静态加密。 它是默认加密类型。 EncryptionAtRestWithCustomerKey：磁盘使用客户管理的密钥进行静态加密，客户可以更改和吊销。 EncryptionAtRestWithPlatformAndCustomerKeys：磁盘使用 2 层加密静态加密。 其中一个密钥是客户管理的，另一个密钥是平台管理的。 ConfidentialVmEncryptedWithCustomerKey：机密 VM 接受的其他加密类型。 磁盘使用客户管理的密钥进行静态加密。

接受的值: ConfidentialVmEncryptedWithCustomerKey, EncryptionAtRestWithCustomerKey, EncryptionAtRestWithPlatformAndCustomerKeys, EncryptionAtRestWithPlatformKey
--federated-client-id

跨租户方案中使用的联合客户端 ID。

--location -l

Location。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--mi-system-assigned

提供此标志以使用系统分配的标识。 请查看有关更多示例的帮助。

接受的值: false, true
--mi-user-assigned

要用于磁盘加密集的用户分配标识 ID。 请查看有关更多示例的帮助。

--no-wait

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

默认值: False
--source-vault

包含密钥或机密的 KeyVault 的名称或 ID。

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

全局参数
--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

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

--subscription

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

--verbose

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

az disk-encryption-set delete

删除磁盘加密集。

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

示例

删除磁盘加密集。

az disk-encryption-set delete --name MyDiskEncryptionSet --resource-group MyResourceGroup

可选参数

--disk-encryption-set-name --name -n

磁盘加密集的名称。

--ids

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

--no-wait

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

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

全局参数
--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

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

--subscription

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

--verbose

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

az disk-encryption-set list

列出磁盘加密集。

az disk-encryption-set list [--max-items]
                            [--next-token]
                            [--resource-group]

可选参数

--max-items

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

--next-token

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

--resource-group -g

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

全局参数
--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

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

--subscription

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

--verbose

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

az disk-encryption-set list-associated-resources

列出使用此磁盘加密集加密的所有资源。

az disk-encryption-set list-associated-resources --disk-encryption-set-name
                                                 --resource-group
                                                 [--max-items]
                                                 [--next-token]

必需参数

--disk-encryption-set-name --name -n

磁盘加密集的名称。

--resource-group -g

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

可选参数

--max-items

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

--next-token

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

全局参数
--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

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

--subscription

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

--verbose

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

az disk-encryption-set show

获取有关磁盘加密集的信息。

az disk-encryption-set show [--disk-encryption-set-name]
                            [--ids]
                            [--resource-group]
                            [--subscription]

示例

获取磁盘加密集的信息

az disk-encryption-set show --name MyDiskEncryptionSet --resource-group MyResourceGroup

可选参数

--disk-encryption-set-name --name -n

磁盘加密集的名称。

--ids

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

--resource-group -g

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

--subscription

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

全局参数
--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

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

--subscription

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

--verbose

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

az disk-encryption-set update

更新磁盘加密集。

az disk-encryption-set update [--add]
                              [--auto-rotation {false, true}]
                              [--federated-client-id]
                              [--force-string]
                              [--ids]
                              [--key-url]
                              [--name]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--source-vault]
                              [--subscription]

示例

更新磁盘加密集。 （自动生成）

az disk-encryption-set update --name MyDiskEncryptionSet --resource-group MyResourceGroup --key-url MyKey --source-vault MyVault

更新磁盘加密集的多租户应用程序客户端 ID。

az disk-encryption-set update --name MyDiskEncryptionSet --resource-group MyResourceGroup --key-url MyKey --source-vault MyVault --federated-client-id myFederatedClientId

清除磁盘加密集的多租户应用程序客户端 ID。

az disk-encryption-set update --name MyDiskEncryptionSet --resource-group MyResourceGroup --key-url MyKey --source-vault MyVault --federated-client-id None

可选参数

--add

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

默认值: []
--auto-rotation --enable-auto-key-rotation

启用密钥的自动轮换。

接受的值: false, true
--federated-client-id

跨租户方案中使用的联合客户端 ID。

--force-string

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

默认值: False
--ids

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

--key-url

指向 KeyVault 中的密钥或机密的 URL。

--name -n

磁盘加密集的名称。

--remove

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

默认值: []
--resource-group -g

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

--set

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

默认值: []
--source-vault

包含密钥或机密的 KeyVault 的名称或 ID。

--subscription

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

全局参数
--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

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

--subscription

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

--verbose

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

az disk-encryption-set wait

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

az disk-encryption-set wait [--created]
                            [--custom]
                            [--deleted]
                            [--disk-encryption-set-name]
                            [--exists]
                            [--ids]
                            [--interval]
                            [--resource-group]
                            [--subscription]
                            [--timeout]
                            [--updated]

可选参数

--created

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

默认值: False
--custom

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

--deleted

等到删除为止。

默认值: False
--disk-encryption-set-name --name -n

磁盘加密集的名称。

--exists

等待资源存在。

默认值: False
--ids

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

--interval

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

默认值: 30
--resource-group -g

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

--subscription

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

--timeout

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

默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False
全局参数
--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

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

--subscription

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

--verbose

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