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

az sig

注意

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

管理共享映像库。

命令

名称	说明	类型	状态
az sig create	创建共享映像库。	核心	GA
az sig create (image-gallery 扩展)	创建共享映像库。	扩展	GA
az sig delete	删除共享映像库。	核心	GA
az sig gallery-application	管理库应用程序。	核心	GA
az sig gallery-application create	创建库应用程序定义。	核心	GA
az sig gallery-application delete	删除库应用程序。	核心	GA
az sig gallery-application list	列出库中的库应用程序定义。	核心	GA
az sig gallery-application show	获取有关库应用程序定义的信息。	核心	GA
az sig gallery-application update	更新库应用程序定义。	核心	GA
az sig gallery-application version	管理库应用程序版本。	核心	GA
az sig gallery-application version create	创建库应用程序版本。	核心	GA
az sig gallery-application version delete	删除库应用程序版本。	核心	GA
az sig gallery-application version list	列出库应用程序版本。	核心	GA
az sig gallery-application version show	获取有关库应用程序版本的信息。	核心	GA
az sig gallery-application version update	更新库应用程序版本。	核心	GA
az sig gallery-application version wait	将 CLI 置于等待状态，直到满足条件。	核心	GA
az sig gallery-application wait	将 CLI 置于等待状态，直到满足 sig 库应用程序的条件。	核心	GA
az sig image-definition	使用 VM 管理共享库映像。	核心和扩展	GA
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-version	使用 VM 管理共享库映像版本。	核心和扩展	GA
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 list	列出资源组下的库。	核心	GA
az sig list-community	列出直接共享到订阅或租户的所有社区库。	核心	GA
az sig list-shared	列出直接共享到订阅或租户的所有共享库。	核心	GA
az sig share	管理库共享配置文件。	核心和扩展	GA
az sig share add	与订阅和租户共享库。	核心	GA
az sig share enable-community	允许向社区共享库。	核心	GA
az sig share enable-community (image-gallery 扩展)	允许向社区共享库。	扩展	GA
az sig share remove	停止与订阅或租户共享库。	核心	GA
az sig share reset	禁止与订阅或租户共享库。	核心	GA
az sig share wait	将 CLI 置于等待状态，直到满足共享库的条件。	核心	GA
az sig show	检索有关共享映像库的信息。	核心	GA
az sig show-community	按库公共名称获取社区库。	核心	GA
az sig show-community (image-gallery 扩展)	获取已社区（预览版）的库。	扩展	实验
az sig show-shared	获取直接共享到订阅或租户的库。	核心	GA
az sig update	更新共享映像库。	核心	GA

az sig create

创建共享映像库。

az sig create --gallery-name
              --resource-group
              [--description]
              [--eula]
              [--location]
              [--permissions {Community, Groups, Private}]
              [--public-name-prefix]
              [--publisher-email]
              [--publisher-uri]
              [--soft-delete {false, true}]
              [--tags]

示例

创建共享映像库

az sig create --resource-group MyResourceGroup --gallery-name MyGallery

必需参数

--gallery-name -r

库名称。

--resource-group -g

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

可选参数

--description

库的说明。

--eula

社区库发布者 eula。

--location -l

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

--permissions

此属性允许指定共享库的权限。

接受的值: Community, Groups, Private

--public-name-prefix

社区库公共名称前缀。

--publisher-email

社区库发布者联系人电子邮件。

--publisher-uri

社区库发布者 URI。

--soft-delete

预览

为此库中的资源启用软删除，允许在保留期内恢复这些资源。

接受的值: false, true

--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 create (image-gallery 扩展)

创建共享映像库。

az sig create --gallery-name
              --resource-group
              [--description]
              [--eula]
              [--location]
              [--permissions {Community, Groups, Private}]
              [--public-name-prefix]
              [--publisher-email]
              [--publisher-uri]
              [--soft-delete {false, true}]
              [--tags]

示例

创建共享映像库

az sig create --resource-group MyResourceGroup --gallery-name MyGallery

必需参数

--gallery-name -r

库名称。

--resource-group -g

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

可选参数

--description

库的说明。

--eula

社区库许可协议和隐私声明。

--location -l

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

--permissions

实验

此属性允许指定共享库的权限。

接受的值: Community, Groups, Private

--public-name-prefix

社区库公共名称前缀。

--publisher-email

社区库发布者联系人电子邮件。

--publisher-uri

社区库发布者 URI。

--soft-delete

预览

为此库中的资源启用软删除，允许在保留期内恢复这些资源。

接受的值: false, true

--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 delete

删除共享映像库。

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

可选参数

--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 list

列出资源组下的库。

az sig list [--resource-group]

可选参数

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

列出直接共享到订阅或租户的所有社区库。

az sig list-community [--location]
                      [--marker]
                      [--show-next-marker]

示例

列出在给定位置直接共享到订阅的社区库

az sig list-community --location myLocation

根据下一个标记列出直接共享到租户的分页社区库

az sig list-community --location myLocation --marker nextMarker

可选参数

--location -l

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

--marker

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

--show-next-marker

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

全局参数

--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 list-shared

列出直接共享到订阅或租户的所有共享库。

az sig list-shared --location
                   [--shared-to {tenant}]

示例

列出在给定位置直接共享到订阅的共享库

az sig list-shared --location myLocation

列出在给定位置直接共享到租户的共享库

az sig list-shared --location myLocation --shared-to tenant

必需参数

--location -l

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

可选参数

--shared-to

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

接受的值: tenant

全局参数

--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 show

检索有关共享映像库的信息。

az sig show [--gallery-name]
            [--ids]
            [--resource-group]
            [--select]
            [--sharing-groups]
            [--subscription]

可选参数

--gallery-name -r

库名称。

--ids

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

--resource-group -g

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

--select

要应用于操作的 select 表达式。

--sharing-groups

用于查询共享库组的展开查询选项。

--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 show-community

按库公共名称获取社区库。

az sig show-community [--ids]
                      [--location]
                      [--name]
                      [--subscription]

可选参数

--ids

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

--location -l

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

--name --public-gallery-name -n

社区库的公共名称。

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

实验

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

获取已社区（预览版）的库。

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

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

示例

获取已位于给定位置的社区库。

az sig show-community --public-gallery-name publicGalleryName --location myLocation

可选参数

--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 show-shared

获取直接共享到订阅或租户的库。

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

示例

获取已直接共享到给定位置中的订阅或租户的库。

az sig show-shared --gallery-unique-name MyGalleryUniqueName --location MyLocation

可选参数

--gallery-unique-name --name -n

共享库的唯一名称。

--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 update

更新共享映像库。

az sig update --gallery-name
              --resource-group
              [--add]
              [--eula]
              [--force-string]
              [--permissions {Community, Groups, Private}]
              [--public-name-prefix]
              [--publisher-email]
              [--publisher-uri]
              [--remove]
              [--select]
              [--set]
              [--soft-delete {false, true}]

示例

允许将库共享到订阅或租户

az sig update --resource-group myResourceGroup --gallery-name myGallery \
--permissions groups

将库从专用更新到社区

az sig update -g myResourceGroup --gallery-name myGallery --permissions Community \
--publisher-uri myPublisherUri --publisher-email myPublisherEmail \
--eula myEula --public-name-prefix myPublicNamePrefix

必需参数

--gallery-name -r

库名称。

--resource-group -g

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

可选参数

--add

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

默认值: []

--eula

社区库发布者 eula。

--force-string

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

默认值: False

--permissions

此属性允许指定共享库的权限。

接受的值: Community, Groups, Private

--public-name-prefix

社区库公共名称前缀。

--publisher-email

社区库发布者联系人电子邮件。

--publisher-uri

社区库发布者 URI。

--remove

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

默认值: []

--select

要应用于操作的 select 表达式。 “权限”默认值为 None。

--set

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

默认值: []

--soft-delete

预览

为此库中的资源启用软删除，允许在保留期内恢复这些资源。

接受的值: false, true

全局参数

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