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

az elastic-san volume-group

注意

此参考是 Azure CLI(版本 2.55.0 或更高版本)的 elastic-san 扩展的一部分。 该扩展将在首次运行 az elastic-san volume-group 命令时自动安装。 详细了解扩展。

管理弹性 SAN 卷组。

命令

名称 说明 类型 状态
az elastic-san volume-group create

创建卷组。

扩展 GA
az elastic-san volume-group delete

删除卷组。

扩展 GA
az elastic-san volume-group list

列出卷组。

扩展 GA
az elastic-san volume-group show

获取卷组。

扩展 GA
az elastic-san volume-group update

更新卷组。

扩展 GA
az elastic-san volume-group wait

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

扩展 GA

az elastic-san volume-group create

创建卷组。

az elastic-san volume-group create --elastic-san
                                   --name
                                   --resource-group
                                   [--encryption {EncryptionAtRestWithCustomerManagedKey, EncryptionAtRestWithPlatformKey}]
                                   [--encryption-properties]
                                   [--identity]
                                   [--network-acls]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--protocol-type {Iscsi, None}]

示例

使用 PlaformManagedkey 和 SystemAssignedIdentity 创建卷组

az elastic-san volume-group create -e "san_name" -n "vg_name" -g "rg" --tags '{key1910:bbbb}' --encryption EncryptionAtRestWithPlatformKey --protocol-type Iscsi --network-acls '{virtual-network-rules:[{id:"subnet_id",action:Allow}]}' --identity '{type:SystemAssigned}'

使用 CustomerManagedKey 和 UserAssignedIdentity 创建卷组

az elastic-san volume-group create -e "san_name" -n "vg_name" -g "rg" --encryption EncryptionAtRestWithCustomerManagedKey --protocol-type Iscsi --identity '{type:UserAssigned,user-assigned-identity:"uai_id"}' --encryption-properties '{key-vault-properties:{key-name:"key_name",key-vault-uri:"vault_uri"},identity:{user-assigned-identity:"uai_id"}}'

必需参数

--elastic-san --elastic-san-name -e

ElasticSan 的名称。

--name --volume-group-name -n

VolumeGroup 的名称。

--resource-group -g

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

可选参数

--encryption

加密类型。

接受的值: EncryptionAtRestWithCustomerManagedKey, EncryptionAtRestWithPlatformKey
--encryption-properties

描述密钥库和标识信息的加密属性支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--identity

资源的标识。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--network-acls

一组规则,用于控制特定网络位置的可访问性。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--no-wait

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--protocol-type

存储目标的类型。

接受的值: Iscsi, None
全局参数
--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 elastic-san volume-group delete

删除卷组。

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

示例

删除卷组。

az elastic-san volume-group delete -g "rg" -e "san_name" -n "vg_name"

可选参数

--elastic-san --elastic-san-name -e

ElasticSan 的名称。

--ids

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

--name --volume-group-name -n

VolumeGroup 的名称。

--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 配置默认订阅。

--yes -y

不提示确认。

默认值: 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 获取完整的调试日志。

az elastic-san volume-group list

列出卷组。

az elastic-san volume-group list --elastic-san
                                 --resource-group
                                 [--max-items]
                                 [--next-token]

示例

列出卷组。

az elastic-san volume-group list -g "rg" -e "san_name"

必需参数

--elastic-san --elastic-san-name -e

ElasticSan 的名称。

--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 elastic-san volume-group show

获取卷组。

az elastic-san volume-group show [--elastic-san]
                                 [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]

示例

获取卷组。

az elastic-san volume-group show -g "rg" -e "san_name" -n "vg_name"

可选参数

--elastic-san --elastic-san-name -e

ElasticSan 的名称。

--ids

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

--name --volume-group-name -n

VolumeGroup 的名称。

--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 elastic-san volume-group update

更新卷组。

az elastic-san volume-group update [--add]
                                   [--elastic-san]
                                   [--encryption {EncryptionAtRestWithCustomerManagedKey, EncryptionAtRestWithPlatformKey}]
                                   [--encryption-properties]
                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--identity]
                                   [--ids]
                                   [--name]
                                   [--network-acls]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--protocol-type {Iscsi, None}]
                                   [--remove]
                                   [--resource-group]
                                   [--set]
                                   [--subscription]

示例

更新卷组。

az elastic-san volume-group update -e "san_name" -n "vg_name" -g "rg" --protocol-type None --network-acls '{virtual-network-rules:[{id:"subnet_id_2",action:Allow}]}'

更新卷组以将 CustomerManagedKey 与 keyvault 详细信息配合使用

az elastic-san volume-group update -e "san_name" -n "vg_name" -g "rg" --encryption EncryptionAtRestWithCustomerManagedKey --encryption-properties '{key-vault-properties:{key-name:"key_name",key-vault-uri:"vault_uri"}}'

更新卷组以使用另一个 UserAssignedIdentity

az elastic-san volume-group update -e "san_name" -n "vg_name" -g "rg" --identity '{type:UserAssigned,user-assigned-identity:"uai_2_id"}' --encryption-properties '{key-vault-properties:{key-name:"key_name",key-vault-uri:"vault_uri"},identity:{user-assigned-identity:"uai_2_id"}}'

将卷组更新回 PlatformManagedKey

az elastic-san volume-group update -e "san_name" -n "vg_name" -g "rg" --encryption EncryptionAtRestWithPlatformKey

将卷组更新回 SystemAssignedIdentity

az elastic-san volume-group update -e "san_name" -n "vg_name" -g "rg" --identity '{type:SystemAssigned}'

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value、string 或 JSON 字符串>。

--elastic-san --elastic-san-name -e

ElasticSan 的名称。

--encryption

加密类型。

接受的值: EncryptionAtRestWithCustomerManagedKey, EncryptionAtRestWithPlatformKey
--encryption-properties

描述密钥库和标识信息的加密属性支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--force-string

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

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

资源的标识。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--ids

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

--name --volume-group-name -n

VolumeGroup 的名称。

--network-acls

一组规则,用于控制特定网络位置的可访问性。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--no-wait

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--protocol-type

存储目标的类型。

接受的值: Iscsi, None
--remove

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

--resource-group -g

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

--set

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

--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 elastic-san volume-group wait

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

az elastic-san volume-group wait [--created]
                                 [--custom]
                                 [--deleted]
                                 [--elastic-san]
                                 [--exists]
                                 [--ids]
                                 [--interval]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]
                                 [--timeout]
                                 [--updated]

可选参数

--created

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

默认值: False
--custom

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

--deleted

等到删除为止。

默认值: False
--elastic-san --elastic-san-name -e

ElasticSan 的名称。

--exists

等待资源存在。

默认值: False
--ids

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

--interval

轮询间隔(以秒为单位)。

默认值: 30
--name --volume-group-name -n

VolumeGroup 的名称。

--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 获取完整的调试日志。