你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
az sig image-definition
注意
此命令组具有在 Azure CLI 和至少一个扩展中定义的命令。 安装每个扩展,使其受益于其扩展功能。 详细了解扩展。
使用 VM 管理共享库映像。
命令
名称 | 说明 | 类型 | 状态 |
---|---|---|---|
az sig image-definition create |
创建库映像定义。 |
核心 | GA |
az sig image-definition delete |
删除库映像。 |
核心 | GA |
az sig image-definition list |
列出库中的库映像定义。 |
核心 | GA |
az sig image-definition list-community |
列出库社区中的 VM 映像定义。 |
核心 | GA |
az sig image-definition list-community (image-gallery 扩展) |
列出库社区中的 VM 映像定义(预览版)。 |
扩展 | 实验 |
az sig image-definition list-shared |
列出直接共享到订阅或租户的库中的 VM 映像定义。 |
核心 | GA |
az sig image-definition show |
获取有关库映像定义的信息。 |
核心 | GA |
az sig image-definition show-community |
获取社区库映像。 |
核心 | GA |
az sig image-definition show-community (image-gallery 扩展) |
获取库社区中的图像(预览版)。 |
扩展 | 实验 |
az sig image-definition show-shared |
获取共享库映像。 |
核心 | GA |
az sig image-definition update |
更新 VM 映像定义。 |
核心 | GA |
az sig image-definition wait |
将 CLI 置于等待状态,直到满足条件。 |
核心 | GA |
az sig image-definition create
创建库映像定义。
az sig image-definition create --gallery-image-definition
--gallery-name
--offer
--os-type {Linux, Windows}
--publisher
--resource-group
--sku
[--architecture {Arm64, x64}]
[--description]
[--disallowed-disk-types]
[--end-of-life-date]
[--eula]
[--features]
[--hyper-v-generation {V1, V2}]
[--location]
[--maximum-cpu-core]
[--maximum-memory]
[--minimum-cpu-core]
[--minimum-memory]
[--os-state {Generalized, Specialized}]
[--plan-name]
[--plan-product]
[--plan-publisher]
[--privacy-statement-uri]
[--release-note-uri]
[--tags]
示例
为专用 Linux 映像创建映像定义
az sig image-definition create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--publisher GreatPublisher --offer GreatOffer --sku GreatSku \
--os-type linux --os-state Specialized
为通用 Linux 映像创建映像定义
az sig image-definition create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--publisher GreatPublisher --offer GreatOffer --sku GreatSku \
--os-type linux --os-state Generalized
为专用 Windows 映像创建映像定义
az sig image-definition create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--publisher GreatPublisher --offer GreatOffer --sku GreatSku \
--os-type windows --os-state Specialized
为通用 Windows 映像创建映像定义
az sig image-definition create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--publisher GreatPublisher --offer GreatOffer --sku GreatSku \
--os-type windows --os-state Generalized
使用计划信息创建映像定义
az sig image-definition create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--publisher GreatPublisher --offer GreatOffer --sku GreatSku \
--os-type linux --os-state Specialized --plan-name PlanName \
--plan-product PlanProduct --plan-publisher PlanPublisher
为支持休眠功能的图像创建映像定义
az sig image-definition create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--publisher GreatPublisher --offer GreatOffer --sku GreatSku \
--os-type linux --os-state Specialized \
--features IsHibernateSupported=true
为支持加速网络的映像创建映像定义
az sig image-definition create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--publisher GreatPublisher --offer GreatOffer --sku GreatSku \
--os-type linux --os-state Specialized \
--features IsAcceleratedNetworkSupported=true
为只能用于创建受信任 VM 的映像创建映像定义。 只能从此映像创建受信任的 VM。
az sig image-definition create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--publisher GreatPublisher --offer GreatOffer --sku GreatSku \
--os-type linux --os-state Specialized \
--features SecurityType=TrustedLaunch
为可用于创建机密 VM 的映像创建映像定义。
az sig image-definition create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--publisher GreatPublisher --offer GreatOffer --sku GreatSku \
--os-type linux --os-state Specialized \
--features SecurityType=ConfidentialVmSupported
为只能用于创建机密 VM 的映像创建映像定义。 只能从此映像创建机密 VM。
az sig image-definition create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--publisher GreatPublisher --offer GreatOffer --sku GreatSku \
--os-type linux --os-state Specialized \
--features SecurityType=ConfidentialVM
为可用于创建 Gen2 或 TrustedLaunchSupported VM 的映像创建映像定义。
az sig image-definition create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--publisher GreatPublisher --offer GreatOffer --sku GreatSku \
--os-type linux --os-state Specialized \
--features SecurityType=TrustedLaunchSupported
为可用于创建 Gen2、TrustedLaunch 或机密 VM 的映像创建映像定义。
az sig image-definition create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--publisher GreatPublisher --offer GreatOffer --sku GreatSku \
--os-type linux --os-state Specialized \
--features SecurityType=TrustedLaunchAndConfidentialVmSupported
创建映像定义并指示生命周期结束日期
az sig image-definition create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--publisher GreatPublisher --offer GreatOffer --sku GreatSku \
--os-type linux --os-state Specialized \
--end-of-life-date YYYY-MM-DDTHH:MM:SS+00:00
创建映像定义,并推荐最小和最大 CPU 和内存(GB)
az sig image-definition create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--publisher GreatPublisher --offer GreatOffer --sku GreatSku \
--os-type linux --os-state Specialized \
--minimum-cpu-core myMinCPU --maximum-cpu-core myMaxCPU \
--minimum-memory myMinMemory --maximum-memory myMaxMemory
创建映像定义并指示映像不建议使用哪些 OS 磁盘类型
az sig image-definition create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--publisher GreatPublisher --offer GreatOffer --sku GreatSku \
--os-type linux --os-state Specialized \
--disallowed-disk-types Standard_LRS
创建映像定义并提供 EULA、隐私声明 URI 和发行说明 URI
az sig image-definition create --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--publisher GreatPublisher --offer GreatOffer --sku GreatSku \
--os-type linux --os-state Specialized \
--eula path_to_eula --privacy-statement-uri path_to_statement \
--release-note-uri path_to_release_notes
必需参数
库映像定义。
库名称。
映像产品/服务。
从用户映像或专用 VHD 创建 VM 时,磁盘中包含的 OS 类型。
映像发布者。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
映像 SKU。
可选参数
CPU 体系结构。
库映像定义的说明。
不适用于映像的磁盘类型,例如Standard_LRS。
生命周期结束日期,例如“2020-12-31”。
库映像的 Eula 协议。
库映像功能的列表。 例如“IsSecureBootSupported=true IsMeasuredBootSupported=false”。
虚拟机的虚拟机监控程序生成。 仅适用于 OS 磁盘。
Location。 az account list-locations
中的值。 可以使用 az configure --defaults location=<location>
配置默认位置。
最大 CPU 核心数。
最大内存(以 MB 为单位)。
最小 CPU 核心数。
最小内存(以 MB 为单位)。
此属性允许用户指定在此映像下创建的虚拟机是“通用化”还是“专用”。
计划名称。
规划产品。
计划发布者。
隐私声明 URI。
发行说明 URI。
空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az sig image-definition delete
删除库映像。
az sig image-definition delete [--gallery-image-definition]
[--gallery-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
可选参数
要删除的库映像定义的名称。
要在其中删除映像定义的共享映像库的名称。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
不等待长时间运行的操作完成。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az sig image-definition list
列出库中的库映像定义。
az sig image-definition list --gallery-name
--resource-group
必需参数
要从中列出映像定义的共享映像库的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az sig image-definition list-community
列出库社区中的 VM 映像定义。
az sig image-definition list-community [--ids]
[--location]
[--marker]
[--public-gallery-name]
[--show-next-marker]
[--subscription]
示例
列出库社区中的映像定义。
az sig image-definition list-community --public-gallery-name publicGalleryName \
--location myLocation
可选参数
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
Location。 az account list-locations
中的值。 可以使用 az configure --defaults location=<location>
配置默认位置。
一个字符串值,该值标识要在下一个列表操作中返回的容器列表部分。 如果列表操作未返回剩余的所有容器,则返回响应正文中的 NextMarker 值,该容器将随当前页一起列出。 如果指定,此生成器将从上一个生成器停止的点开始返回结果。
社区库的公共名称。
指定后,在结果中显示 nextMarker。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az sig image-definition list-community (image-gallery 扩展)
此命令是实验性的,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
列出库社区中的 VM 映像定义(预览版)。
列出库社区中的 VM 映像定义(个人预览功能,如果有兴趣使用此功能,请通过电子邮件联系 sigpmdev@microsoft.com 社区映像库团队以注册预览版)。
az sig image-definition list-community [--ids]
[--location]
[--marker]
[--public-gallery-name]
[--show-next-marker]
[--subscription]
示例
列出库社区中的映像定义。
az sig image-definition list-community --public-gallery-name publicGalleryName \
--location myLocation
可选参数
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
Location。 az account list-locations
中的值。 可以使用 az configure --defaults location=<location>
配置默认位置。
一个字符串值,该值标识要在下一个列表操作中返回的容器列表部分。 如果列表操作未返回剩余的所有容器,则返回响应正文中的 NextMarker 值,该容器将随当前页一起列出。 如果指定,此生成器将从上一个生成器停止的点开始返回结果。
社区库的公共名称。
指定后,在结果中显示 nextMarker。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az sig image-definition list-shared
列出直接共享到订阅或租户的库中的 VM 映像定义。
az sig image-definition list-shared [--gallery-unique-name]
[--ids]
[--location]
[--marker]
[--shared-to {tenant}]
[--show-next-marker]
[--subscription]
示例
列出在给定位置直接共享到订阅的库中的图像定义。
az sig image-definition list-shared --gallery-unique-name galleryUniqueName \
--location myLocation
列出在给定位置直接共享到租户的库中的图像定义。
az sig image-definition list-shared --gallery-unique-name galleryUniqueName \
--location myLocation --shared-to tenant
可选参数
共享库的唯一名称。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
Location。 az account list-locations
中的值。 可以使用 az configure --defaults location=<location>
配置默认位置。
一个字符串值,该值标识要在下一个列表操作中返回的容器列表部分。 如果列表操作未返回剩余的所有容器,则返回响应正文中的 NextMarker 值,该容器将随当前页一起列出。 如果指定,此生成器将从上一个生成器停止的点开始返回结果。
用于确定执行列表操作时要提取的共享库的查询参数。 如果未指定,则按订阅 ID 列出。
指定后,在结果中显示 nextMarker。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az sig image-definition show
获取有关库映像定义的信息。
az sig image-definition show [--gallery-image-definition]
[--gallery-name]
[--ids]
[--resource-group]
[--subscription]
可选参数
要检索的库映像定义的名称。
要从中检索映像定义的共享映像库的名称。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az sig image-definition show-community
获取社区库映像。
az sig image-definition show-community [--gallery-image-definition]
[--ids]
[--location]
[--public-gallery-name]
[--subscription]
可选参数
要从中列出映像版本的社区库映像定义的名称。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
Location。 az account list-locations
中的值。 可以使用 az configure --defaults location=<location>
配置默认位置。
社区库的公共名称。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az sig image-definition show-community (image-gallery 扩展)
此命令是实验性的,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
获取库社区中的图像(预览版)。
获取库社区中的图像(个人预览功能,如果有兴趣使用此功能,请通过电子邮件联系 sigpmdev@microsoft.com 社区映像库团队以注册预览版)。
az sig image-definition show-community [--gallery-image-definition]
[--ids]
[--location]
[--public-gallery-name]
[--subscription]
示例
获取给定位置的库社区中的图像定义。
az sig image-definition show-community --public-gallery-name publicGalleryName \
--gallery-image-definition myGalleryImageName --location myLocation
可选参数
要从中列出映像版本的社区库映像定义的名称。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
Location。 az account list-locations
中的值。 可以使用 az configure --defaults location=<location>
配置默认位置。
社区库的公共名称。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az sig image-definition show-shared
获取共享库映像。
获取已直接共享到订阅或租户的共享库映像。
az sig image-definition show-shared [--gallery-image-definition]
[--gallery-unique-name]
[--ids]
[--location]
[--subscription]
示例
获取库中的映像定义,该定义直接共享到给定位置的订阅或租户。
az sig image-definition show-shared --gallery-unique-name galleryUniqueName --gallery-image-definition myGalleryImageName --location myLocation
可选参数
要从中列出映像版本的共享库映像定义的名称。
共享库的唯一名称。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
Location。 az account list-locations
中的值。 可以使用 az configure --defaults location=<location>
配置默认位置。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az sig image-definition update
更新 VM 映像定义。
az sig image-definition update --gallery-image-definition
--gallery-name
--resource-group
[--add]
[--force-string]
[--remove]
[--set]
示例
更改共享映像定义的建议配置
az sig image-definition update --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--resource-group MyResourceGroup --set recommended.vCpUs.min=myNewvCpUsMin \
recommended.vCpUs.max=myNewvCpUsMax recommended.memory.min=myNewMemoryMin \
recommended.memory.max=myNewMemoryMax description="newDescription"
删除共享映像定义的配置属性
az sig image-definition update --resource-group MyResourceGroup \
--gallery-name MyGallery --gallery-image-definition MyImage \
--resource-group MyResourceGroup --remove recommended.vCpUs.min
必需参数
库映像定义。
库名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value, string or JSON string>
。
使用“set”或“add”时,保留字符串文本,而不是尝试转换为 JSON。
从列表中删除属性或元素。 示例: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
通过指定要设置的属性路径和值来更新对象。 示例:--set property1.property2=<value>
。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az sig image-definition wait
将 CLI 置于等待状态,直到满足条件。
az sig image-definition wait [--created]
[--custom]
[--deleted]
[--exists]
[--gallery-image-definition]
[--gallery-name]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
可选参数
等待在“Succeeded”中使用“provisioningState”创建。
等待条件满足自定义 JMESPath 查询。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。
等到删除为止。
等待资源存在。
要检索的库映像定义的名称。
要从中检索映像定义的共享映像库的名称。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
轮询间隔(以秒为单位)。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
最大等待(以秒为单位)。
等到 provisioningState 更新为“Succeeded”。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。