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

az sig image-version

注意

此命令组具有在 Azure CLI 和至少一个扩展中定义的命令。 安装每个扩展,使其受益于其扩展功能。 详细了解扩展。

使用 VM 管理共享库映像版本。

命令

名称 说明 类型 状态
az sig image-version create

创建新的映像版本。

核心 GA
az sig image-version delete

删除库映像版本。

核心 GA
az sig image-version list

列出库映像定义中的库映像版本。

核心 GA
az sig image-version list-community

列出库社区中的 VM 映像版本。

核心 GA
az sig image-version list-community (image-gallery 扩展)

列出库社区中的 VM 映像版本(预览版)。

扩展 实验
az sig image-version list-shared

列出直接共享到订阅或租户的库中的 VM 映像版本。

核心 GA
az sig image-version show

检索有关库映像版本的信息。

核心 GA
az sig image-version show-community

获取社区库映像版本。

核心 GA
az sig image-version show-community (image-gallery 扩展)

获取库社区中的映像版本(预览版)。

扩展 实验
az sig image-version show-shared

获取直接共享到订阅或租户的库中的映像版本。

核心 GA
az sig image-version undelete

还原软删除的映像版本。

核心 预览
az sig image-version update

更新共享映像版本。

核心 GA
az sig image-version wait

等待映像版本相关操作。

核心 GA

az sig image-version create

创建新的映像版本。

此操作可能需要很长时间,具体取决于副本 (replica)个区域编号。 建议使用“--no-wait”。

az sig image-version create --gallery-image-definition
                            --gallery-image-version
                            --gallery-name
                            --resource-group
                            [--allow-replicated-location-deletion {false, true}]
                            [--data-snapshot-luns]
                            [--data-snapshots]
                            [--data-vhds-luns]
                            [--data-vhds-sa]
                            [--data-vhds-uris]
                            [--end-of-life-date]
                            [--exclude-from-latest {false, true}]
                            [--image-version]
                            [--location]
                            [--managed-image]
                            [--no-wait]
                            [--os-snapshot]
                            [--os-vhd-storage-account]
                            [--os-vhd-uri]
                            [--replica-count]
                            [--replication-mode {Full, Shallow}]
                            [--storage-account-type {Premium_LRS, Standard_LRS, Standard_ZRS}]
                            [--tags]
                            [--target-edge-zone-encryption]
                            [--target-edge-zones]
                            [--target-region-cvm-encryption]
                            [--target-region-encryption]
                            [--target-regions]
                            [--virtual-machine]

示例

从虚拟机添加新映像版本

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--virtual-machine /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/virtualMachines/MyVM

从托管映像添加新映像版本

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--managed-image /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/images/MyManagedImage

从另一个映像版本添加新映像版本

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--image-version /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/galleries/MyGallery/images/MyImageDefinition/versions/1.0.0

从托管磁盘添加新映像版本

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--os-snapshot /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/disks/MyOSDisk

从托管磁盘添加新映像版本并添加其他数据磁盘

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--os-snapshot /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/disks/MyOSDisk \
--data-snapshots /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/disks/MyDataDisk \
--data-snapshot-luns 0

从 OS 磁盘的快照添加新映像版本。

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--os-snapshot /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/snapshots/MyOsDiskSnapshot

从 OS 磁盘的快照添加新映像版本,并将其他快照添加为数据磁盘

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--os-snapshot /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/snapshots/MyOsDiskSnapshot \
--data-snapshots /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/snapshots/MyDiskSnapshot \
--data-snapshot-luns 0

从 OS 磁盘的 VHD 添加新映像版本。

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--os-vhd-storage-account /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Storage/storageAccounts/mystorageaccount \
--os-vhd-uri https://mystorageaccount.blob.core.windows.net/container/path_to_vhd_file

从 OS 磁盘的 VHD 添加新映像版本,并将其他 VHD 添加为数据磁盘

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--os-vhd-storage-account /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Storage/storageAccounts/mystorageaccount \
--os-vhd-uri https://mystorageaccount.blob.core.windows.net/container/path_to_vhd_file \
--data-vhds-sa /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Storage/storageAccounts/myotherstorageaccount \
--data-vhds-uris https://myotherstorageaccount.blob.core.windows.net/container/path_to_vhd_file \
--data-vhds-luns 0

可以合并快照、托管磁盘和 VHD 以创建新的映像版本。 使用 VHD 作为 OS 磁盘和托管磁盘以及作为数据磁盘快照添加新的映像版本。

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--os-vhd-storage-account /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Storage/storageAccounts/mystorageaccount \
--os-vhd-uri https://mystorageaccount.blob.core.windows.net/container/path_to_vhd_file \
--data-snapshots /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/disks/MyDataDisk subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/snapshots/MyDiskSnapshot \
--data-snapshot-luns 0 1

添加新的映像版本并将其复制到其他区域。 映像版本的源的主页位置必须包含在目标区域列表中。 对于每个附加区域,可以指定不同的副本 (replica)计数和存储帐户类型。 否则,该区域将从全局继承。 默认副本 (replica)计数为 1,默认存储帐户类型为标准 LRS。 在此示例中,eastus2 将有一个存储在标准 ZRS 存储中的副本 (replica),ukwest 将有 3 副本 (replica) 存储在标准 ZRS 存储中,southindia 将有一个存储在标准 LRS 存储中的副本 (replica),巴西西部将有 2 副本 (replica) 存储在标准 LRS 存储中。

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 --replica-count 1 \
--storage-account-type Standard_ZRS --managed-image image-name \
--target-regions eastus2 ukwest=3 southindia=standard_lrs \
brazilsouth=2=standard_lrs

使用磁盘加密集添加具有加密的新映像版本。 加密应用于属于映像版本的每个磁盘。

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--virtual-machine /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/virtualMachines/MyVM \
--target-regions westus=2=standard eastus \
--target-region-encryption WestUSDiskEncryptionSet1,0,WestUSDiskEncryptionSet2 \
EastUSDiskEncryptionSet1,0,EastUSDiskEncryptionSet2

添加新映像版本并将其复制到扩展位置。

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 --replica-count 1 \
--storage-account-type Standard_ZRS --managed-image image-name \
--target-edge-zones westus=microsoftlosangeles1 eastus=microsoftlosangeles2=1 \
brazilsouth=2=standard_lrs

添加新的映像版本,并使用磁盘加密集将其复制到具有加密的扩展位置。

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--virtual-machine /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/virtualMachines/MyVM \
--target-edge-zones westus=microsoftlosangeles1 \
--target-edge-zone-encryption microsoftlosangeles1,WestUSDiskEncryptionSet1,0,WestUSDiskEncryptionSet2

添加新的映像版本,不要等待它。 以后,可以在准备好从库映像版本创建 VM 时调用“az sig image-version wait”命令

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--virtual-machine /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/virtualMachines/MyVM \
--no-wait

添加新的映像版本,但将其从考虑中删除为映像定义中的最新版本

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--virtual-machine /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/virtualMachines/MyVM \
--exclude-from-latest true

添加新映像版本并设置其生命周期结束日期。 映像版本仍可用于在其生命周期结束日期后创建虚拟机。

az sig image-version create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--virtual-machine /subscriptions/00000000-0000-0000-0000-00000000xxxx/resourceGroups/imageGroups/providers/Microsoft.Compute/virtualMachines/MyVM \
--end-of-life-date 2024-08-02T00:00:00+00:00

必需参数

--gallery-image-definition -i

库映像定义。

--gallery-image-version -e

语义版本模式中的库映像版本。 允许的字符是数字和句点。 数字必须介于 32 位整数的范围内,例如 <MajorVersion>.<MinorVersion>.<Patch>

--gallery-name -r

库名称。

--resource-group -g

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

可选参数

--allow-replicated-location-deletion

指示是否允许从副本 (replica)指定区域中删除此库映像版本。

接受的值: false, true
--data-snapshot-luns

数据磁盘快照的逻辑单位数(以空格分隔)。

--data-snapshots

数据磁盘快照的名称或 ID(以空格分隔)。

--data-vhds-luns

数据磁盘的源 VHD URI 的逻辑单位号(以空格分隔)。

--data-vhds-sa --data-vhds-storage-accounts

数据磁盘源 VHD URI 的存储帐户的名称或 ID(以空格分隔)。

--data-vhds-uris

数据磁盘的源 VHD URI(空格分隔)。

--end-of-life-date

生命周期结束日期,例如“2020-12-31”。

--exclude-from-latest

该标志表示,如果设置为 true,则省略版本部署 VM 的人员将不会使用此版本。

接受的值: false, true
--image-version

库映像版本源的资源 ID。

--location -l

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

--managed-image

映像名称(如果位于同一资源组中)或资源 ID。

--no-wait

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

默认值: False
--os-snapshot

OS 磁盘快照的名称或 ID。

--os-vhd-storage-account

OS 磁盘的源 VHD URI 的存储帐户的名称或 ID。

--os-vhd-uri

OS 磁盘的源 VHD URI。

--replica-count

要为每个区域创建的默认副本 (replica)数。 若要设置区域副本 (replica)计数,请使用 --target-regions。

--replication-mode

可选参数,它指定要用于副本 (replica)的模式。 此属性不可更新。

接受的值: Full, Shallow
--storage-account-type

每个区域使用的默认存储帐户类型。 若要设置区域存储帐户类型,请使用 --target-regions。

接受的值: Premium_LRS, Standard_LRS, Standard_ZRS
--tags

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

--target-edge-zone-encryption --zone-encryption

用于在每个区域的库项目中加密 OS 和数据磁盘的客户托管密钥的空间分隔列表。 每个边缘区域的格式:os_des<>、<lun1_des>、<lun2_des>。

--target-edge-zones

区域、边缘区域、副本 (replica)计数和存储类型的空格分隔列表。 使用 =[=][=] 可选择性地为每个区域设置副本 (replica)计数和/或存储帐户类型。 如果未指定副本 (replica)计数,将使用默认副本 (replica)计数。 如果未指定存储帐户类型,将使用默认存储帐户类型。 如果指定了“--target-edge-zone None”,则会清除目标扩展位置。

--target-region-cvm-encryption

机密 VM 的客户托管密钥的空间分隔列表,用于加密每个区域的库项目中的 OS 磁盘。 每个区域的格式: <os_cvm_encryption_type>,<os_cvm_des>. os_cvm_encryption_type的有效值为 EncryptedVMGuestStateOnlyWithPmk、EncryptedWithPmk、EncryptedWithCmk。

--target-region-encryption

用于在每个区域的库项目中加密 OS 和数据磁盘的客户托管密钥的空间分隔列表。 每个区域的格式: <os_des>,<lun1>,<lun1_des>,<lun2>,<lun2_des>. 使用“null”作为占位符。

--target-regions

区域及其副本 (replica)计数的空格分隔列表。 用于<region>[=<replica count>][=<storage account type>]选择为每个区域设置副本 (replica)计数和/或存储帐户类型。 如果未指定副本 (replica)计数,将使用默认副本 (replica)计数。 如果未指定存储帐户类型,将使用默认存储帐户类型。

--virtual-machine

VM 源的资源 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 sig image-version delete

删除库映像版本。

az sig image-version delete [--gallery-image-definition]
                            [--gallery-image-version]
                            [--gallery-name]
                            [--ids]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--resource-group]
                            [--subscription]

可选参数

--gallery-image-definition --gallery-image-name -i

映像版本所在的库映像定义的名称。

--gallery-image-version --gallery-image-version-name -e

要删除的库映像版本的名称。

--gallery-name -r

映像定义所在的共享映像库的名称。

--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 sig image-version list

列出库映像定义中的库映像版本。

az sig image-version list --gallery-image-definition
                          --gallery-name
                          --resource-group
                          [--max-items]
                          [--next-token]

必需参数

--gallery-image-definition --gallery-image-name -i

库映像定义。

--gallery-name -r

库名称。

--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 sig image-version list-community

列出库社区中的 VM 映像版本。

az sig image-version list-community [--gallery-image-definition]
                                    [--ids]
                                    [--location]
                                    [--marker]
                                    [--public-gallery-name]
                                    [--show-next-marker]
                                    [--subscription]

示例

列出库社区中的映像版本。

az sig image-version list-community --public-gallery-name publicGalleryName \
--gallery-image-definition MyImage --location myLocation

可选参数

--gallery-image-definition -i

要从中列出映像版本的社区库映像定义的名称。

--ids

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

--location -l

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

--marker

一个字符串值,该值标识要在下一个列表操作中返回的容器列表部分。 如果列表操作未返回剩余的所有容器,则返回响应正文中的 NextMarker 值,该容器将随当前页一起列出。 如果指定,此生成器将从上一个生成器停止的点开始返回结果。

--public-gallery-name

社区库的公共名称。

--show-next-marker

指定后,在结果中显示 nextMarker。

--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 sig image-version list-community (image-gallery 扩展)

实验

此命令是实验性的,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

列出库社区中的 VM 映像版本(预览版)。

列出库社区中的 VM 映像版本(个人预览功能,如果有兴趣使用此功能,请通过电子邮件联系 sigpmdev@microsoft.com 社区映像库团队以注册预览版)。

az sig image-version list-community [--gallery-image-definition]
                                    [--ids]
                                    [--location]
                                    [--marker]
                                    [--public-gallery-name]
                                    [--show-next-marker]
                                    [--subscription]

示例

列出库社区中的映像版本。

az sig image-version list-community --public-gallery-name publicGalleryName \
--gallery-image-definition MyImage --location myLocation

可选参数

--gallery-image-definition -i

要从中列出映像版本的社区库映像定义的名称。

--ids

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

--location -l

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

--marker

一个字符串值,该值标识要在下一个列表操作中返回的容器列表部分。 如果列表操作未返回剩余的所有容器,则返回响应正文中的 NextMarker 值,该容器将随当前页一起列出。 如果指定,此生成器将从上一个生成器停止的点开始返回结果。

--public-gallery-name

社区库的公共名称。

--show-next-marker

指定后,在结果中显示 nextMarker。

--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 sig image-version list-shared

列出直接共享到订阅或租户的库中的 VM 映像版本。

az sig image-version list-shared [--gallery-image-definition]
                                 [--gallery-unique-name]
                                 [--ids]
                                 [--location]
                                 [--marker]
                                 [--shared-to {tenant}]
                                 [--show-next-marker]
                                 [--subscription]

示例

列出库中直接共享到给定位置和映像定义的订阅中的映像版本。

az sig image-version list-shared --gallery-unique-name galleryUniqueName \
--gallery-image-definition MyImage --location myLocation

列出库中直接共享到给定位置和映像定义的租户中的映像版本。

az sig image-version list-shared --gallery-unique-name galleryUniqueName \
--gallery-image-definition MyImage --location myLocation --shared-to tenant

可选参数

--gallery-image-definition -i

要从中列出映像版本的共享库映像定义的名称。

--gallery-unique-name

共享库的唯一名称。

--ids

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

--location -l

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

--marker

一个字符串值,该值标识要在下一个列表操作中返回的容器列表部分。 如果列表操作未返回剩余的所有容器,则返回响应正文中的 NextMarker 值,该容器将随当前页一起列出。 如果指定,此生成器将从上一个生成器停止的点开始返回结果。

--shared-to

用于确定执行列表操作时要提取的共享库的查询参数。 如果未指定,则按订阅 ID 列出。

接受的值: tenant
--show-next-marker

指定后,在结果中显示 nextMarker。

--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 sig image-version show

检索有关库映像版本的信息。

az sig image-version show --gallery-image-definition
                          --gallery-image-version
                          --gallery-name
                          --resource-group
                          [--expand]

必需参数

--gallery-image-definition -i

库映像定义。

--gallery-image-version -e

语义版本模式中的库映像版本。 允许的字符是数字和句点。 数字必须介于 32 位整数的范围内,例如 <MajorVersion>.<MinorVersion>.<Patch>

--gallery-name -r

库名称。

--resource-group -g

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

可选参数

--expand

要应用于操作的展开表达式,例如“ReplicationStatus”。

全局参数
--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 sig image-version show-community

获取社区库映像版本。

az sig image-version show-community [--gallery-image-definition]
                                    [--gallery-image-version]
                                    [--ids]
                                    [--location]
                                    [--public-gallery-name]
                                    [--subscription]

可选参数

--gallery-image-definition --gallery-image-name -i

要从中列出映像版本的社区库映像定义的名称。

--gallery-image-version --gallery-image-version-name -e

语义版本模式中的库映像版本。 允许的字符是数字和句点。 数字必须介于 32 位整数的范围内,例如 <MajorVersion>.<MinorVersion>.<Patch>

--ids

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

--location -l

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

--public-gallery-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 sig image-version show-community (image-gallery 扩展)

实验

此命令是实验性的,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

获取库社区中的映像版本(预览版)。

获取库社区中的映像版本(个人预览功能,如果有兴趣使用此功能,请通过电子邮件联系 sigpmdev@microsoft.com 社区映像库团队以注册预览版)。

az sig image-version show-community [--gallery-image-definition]
                                    [--gallery-image-version]
                                    [--ids]
                                    [--location]
                                    [--public-gallery-name]
                                    [--subscription]

示例

获取给定位置的库社区中的映像版本。

az sig image-version show-community --public-gallery-name publicGalleryName \
--gallery-image-definition MyImage --gallery-image-version 1.0.0 --location myLocation

可选参数

--gallery-image-definition -i

要从中列出映像版本的社区库映像定义的名称。

--gallery-image-version -e

要创建的库映像版本的名称。 需要遵循语义版本名称模式:允许的字符是数字和句点。 数字必须介于 32 位整数的范围内。 格式:。。。

--ids

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

--location -l

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

--public-gallery-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 sig image-version show-shared

获取直接共享到订阅或租户的库中的映像版本。

az sig image-version show-shared [--gallery-image-definition]
                                 [--gallery-image-version]
                                 [--gallery-unique-name]
                                 [--ids]
                                 [--location]
                                 [--subscription]

示例

获取库中的映像版本,该版本直接共享到给定位置的订阅或租户。

az sig image-version show-shared --gallery-unique-name galleryUniqueName --gallery-image-definition MyImage --gallery-image-version 1.0.0 --location myLocation

可选参数

--gallery-image-definition --gallery-image-name -i

要从中列出映像版本的共享库映像定义的名称。

--gallery-image-version --gallery-image-version-name -e

要创建的库映像版本的名称。 需要遵循语义版本名称模式:允许的字符是数字和句点。 数字必须介于 32 位整数的范围内。 格式:。。。

--gallery-unique-name

共享库的唯一名称。

--ids

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

--location -l

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

--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 sig image-version undelete

预览

此命令处于预览阶段,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

还原软删除的映像版本。

只有在启用软删除的库中使用时,操作才会成功。

az sig image-version undelete --gallery-image-definition
                              --gallery-image-version
                              --gallery-name
                              --resource-group
                              [--allow-replicated-location-deletion {false, true}]
                              [--location]
                              [--no-wait]
                              [--tags]

示例

还原软删除的映像版本

az sig image-version undelete --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.1.1

必需参数

--gallery-image-definition -i

库映像定义。

--gallery-image-version -e

语义版本模式中的库映像版本。 允许的字符是数字和句点。 数字必须介于 32 位整数的范围内,例如 <MajorVersion>.<MinorVersion>.<Patch>

--gallery-name -r

库名称。

--resource-group -g

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

可选参数

--allow-replicated-location-deletion

指示是否允许从副本 (replica)指定区域中删除此库映像版本。

接受的值: false, true
--location -l

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

--no-wait

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

默认值: False
--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 sig image-version update

更新共享映像版本。

az sig image-version update --gallery-image-definition
                            --gallery-image-version
                            --gallery-name
                            --resource-group
                            [--add]
                            [--allow-replicated-location-deletion {false, true}]
                            [--force-string]
                            [--no-wait]
                            [--remove]
                            [--replica-count]
                            [--set]
                            [--target-edge-zones]
                            [--target-regions]

示例

更改副本 (replica)区域和副本 (replica)计数

az sig image-version update --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--target-regions westcentralus=2 eastus2

更改扩展位置副本 (replica)

az sig image-version update --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--target-edge-zones westus=microsoftlosangeles1 eastus=microsoftlosangeles2=1

清除扩展位置副本 (replica)

az sig image-version update --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--target-edge-zones None

复制到其他区域。 (可选)可以使用最新版本的映像定义设置区域副本 (replica)计数并排除此映像。

az sig image-version update --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0 \
--add publishingProfile.targetRegions name=westcentralus \
regionalReplicaCount=3 excludeFromLatest=true

更改映像定义中的最新版本是否应考虑映像。 将此值设置为 true 会从考虑中排除映像,并将此值设置为 false 包括要考虑的映像。

az sig image-version update -g MyResourceGroup --gallery-name MyGallery \
--gallery-image-definition MyImage --gallery-image-version 1.0.0 \
--set publishingProfile.excludeFromLatest=true

更改映像版本的生命周期结束日期。 映像仍可用于在生命周期结束后创建虚拟机。

az sig image-version update -g MyResourceGroup --gallery-name MyGallery \
--gallery-image-definition MyImage --gallery-image-version 1.0.0 \
--set publishingProfile.endOfLifeDate=2024-08-02T00:00:00+00:00

允许从副本 (replica)区域中删除库映像版本。

az sig image-version update -g MyResourceGroup --gallery-name MyGallery \
--gallery-image-definition MyImage --gallery-image-version 1.0.0 \
--set safetyProfile.allowDeletionOfReplicatedLocations=true

必需参数

--gallery-image-definition -i

库映像定义。

--gallery-image-version -e

语义版本模式中的库映像版本。 允许的字符是数字和句点。 数字必须介于 32 位整数的范围内,例如 <MajorVersion>.<MinorVersion>.<Patch>

--gallery-name -r

库名称。

--resource-group -g

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

可选参数

--add

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

默认值: []
--allow-replicated-location-deletion

指示是否允许从副本 (replica)指定区域中删除此库映像版本。

接受的值: false, true
--force-string

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

默认值: False
--no-wait

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

默认值: False
--remove

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

默认值: []
--replica-count

要为每个区域创建的默认副本 (replica)数。 若要设置区域副本 (replica)计数,请使用 --target-regions。

--set

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

默认值: []
--target-edge-zones

区域、边缘区域、副本 (replica)计数和存储类型的空格分隔列表。 使用 =[=][=] 可选择性地为每个区域设置副本 (replica)计数和/或存储帐户类型。 如果未指定副本 (replica)计数,将使用默认副本 (replica)计数。 如果未指定存储帐户类型,将使用默认存储帐户类型。 如果指定了“--target-edge-zone None”,则会清除目标扩展位置。

--target-regions

区域及其副本 (replica)计数的空格分隔列表。 用于<region>[=<replica count>][=<storage account type>]选择为每个区域设置副本 (replica)计数和/或存储帐户类型。 如果未指定副本 (replica)计数,将使用默认副本 (replica)计数。 如果未指定存储帐户类型,将使用默认存储帐户类型。

全局参数
--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 sig image-version wait

等待映像版本相关操作。

az sig image-version wait --gallery-image-definition
                          --gallery-image-version
                          --gallery-name
                          --resource-group
                          [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--expand]
                          [--interval]
                          [--timeout]
                          [--updated]

示例

等待映像版本更新

az sig image-version wait --updated --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0

等待映像版本相关操作。 (自动生成)

az sig image-version wait --created --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--gallery-image-version 1.0.0

必需参数

--gallery-image-definition -i

库映像定义。

--gallery-image-version -e

语义版本模式中的库映像版本。 允许的字符是数字和句点。 数字必须介于 32 位整数的范围内,例如 <MajorVersion>.<MinorVersion>.<Patch>

--gallery-name -r

库名称。

--resource-group -g

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

可选参数

--created

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

默认值: False
--custom

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

--deleted

等到删除为止。

默认值: False
--exists

等待资源存在。

默认值: False
--expand

要应用于操作的展开表达式。 “ReplicationStatus”默认值为 None。

--interval

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

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