az sig image-definition

使用 VM 管理共用資源庫映射。

命令

az sig image-definition create

建立資源庫映射定義。

az sig image-definition delete

刪除資源庫映射。

az sig image-definition list

列出資源庫中的圖庫映射定義。

az sig image-definition list-community

列出資源庫社群中的 VM 映射定義。

az sig image-definition list-shared

列出資源庫中直接與您訂用帳戶或租使用者共用的 VM 映射定義。

az sig image-definition show

擷取資源庫映射定義的相關資訊。

az sig image-definition show-community

取得社群資源庫映射。

az sig image-definition show-shared

取得共用資源庫映射。

az sig image-definition update

更新 VM 映射定義。

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

建立映射定義並指出生命循環結束日期

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

必要參數

--gallery-image-definition -i

資源庫映射定義。

--gallery-name -r

資源庫名稱。

--offer -f

映射供應專案。

--os-type

從使用者映射或特製化 VHD 建立 VM 時,磁片中包含的 OS 類型。

接受的值: Linux, Windows
--publisher -p

映射發行者。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--sku -s

映射 SKU。

選擇性參數

--architecture

CPU 架構。

接受的值: Arm64, x64
--description

資源庫映射定義的描述。

--disallowed-disk-types

無法與映射搭配使用的磁片類型,例如Standard_LRS。

--end-of-life-date

生命循環結束日期,例如 '2020-12-31'。

--eula

資源庫映射的 Eula 合約。

--features

資源庫映射功能的清單。 例如「IsSecureBootSupported=true IsMeasuredBootSupported=false」。

--hyper-v-generation

虛擬機器的 Hypervisor 產生。 僅適用于 OS 磁片。

接受的值: V1, V2
預設值: V1
--location -l

位置。 值的來源:az account list-locations。 您可以使用 az configure --defaults location=<location> 來設定預設位置。

--maximum-cpu-core

最大 CPU 核心數。

--maximum-memory

以 MB 為單位的記憶體上限。

--minimum-cpu-core

CPU 核心下限。

--minimum-memory

以 MB 為單位的最小記憶體。

--os-state

此屬性可讓使用者指定在此映射下建立的虛擬機器是「一般化」或「特製化」。

接受的值: Generalized, Specialized
預設值: Generalized
--plan-name

方案名稱。

--plan-product

規劃產品。

--plan-publisher

規劃發行者。

--privacy-statement-uri

隱私權聲明 URI。

--release-note-uri

版本資訊 URI。

--tags

空格分隔標記:key[=value] [key[=value] ...]。使用 「」 清除現有的標籤。

az sig image-definition delete

刪除資源庫映射。

az sig image-definition delete [--gallery-image-definition]
                               [--gallery-name]
                               [--ids]
                               [--resource-group]
                               [--subscription]

選擇性參數

--gallery-image-definition -i

資源庫映射定義。

--gallery-name -r

資源庫名稱。

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用帳戶 az account set -s NAME_OR_ID

az sig image-definition list

列出資源庫中的圖庫映射定義。

az sig image-definition list --gallery-name
                             --resource-group

必要參數

--gallery-name -r

資源庫名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

az sig image-definition list-community

列出資源庫社群中的 VM 映射定義。

列出資源庫社群中的 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

選擇性參數

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。

--location -l

位置。 值的來源:az account list-locations。 您可以使用 az configure --defaults location=<location> 來設定預設位置。

--marker

字串值,識別要以下一個清單作業傳回之容器清單的部分。 如果清單作業未傳回剩餘的所有容器,則會在回應本文中傳回 NextMarker 值,以便與目前頁面一起列出。 如果指定,這個產生器會從先前產生器停止的點開始傳回結果。

--public-gallery-name

社群資源庫的公用名稱。

--show-next-marker

指定時,顯示結果中的 nextMarker。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

az sig image-definition list-shared

列出資源庫中直接與您訂用帳戶或租使用者共用的 VM 映射定義。

列出資源庫中直接與您訂用帳戶或租使用者共用的 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

選擇性參數

--gallery-unique-name

共用資源庫的唯一名稱。

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 'Resource Id' 引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他 「資源識別碼」引數。

--location -l

位置。 值的來源:az account list-locations。 您可以使用 az configure --defaults location=<location> 來設定預設位置。

--marker

字串值,識別下一個清單作業所要傳回之容器清單的部分。 如果清單作業未傳回剩餘的所有容器,則會傳迴響應本文內的 NextMarker 值,以使用目前頁面列出。 如果指定,這個產生器會從先前產生器停止的點開始傳回結果。

--shared-to

查詢參數,決定執行清單作業時要擷取哪些共用資源庫。 如果未指定,請依訂用帳戶識別碼列出。

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

指定時,顯示結果中的 nextMarker。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

az sig image-definition show

擷取資源庫映射定義的相關資訊。

az sig image-definition show [--gallery-image-definition]
                             [--gallery-name]
                             [--ids]
                             [--resource-group]
                             [--subscription]

選擇性參數

--gallery-image-definition -i

資源庫映射定義。

--gallery-name -r

資源庫名稱。

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 'Resource Id' 引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他 「資源識別碼」引數。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

az sig image-definition show-community

取得社群資源庫映射。

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

選擇性參數

--gallery-image-definition -i

要從中列出映射版本的社群資源庫映射定義名稱。

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 'Resource Id' 引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他 「資源識別碼」引數。

--location -l

位置。 值的來源:az account list-locations。 您可以使用 az configure --defaults location=<location> 來設定預設位置。

--public-gallery-name

社群資源庫的公用名稱。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

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

選擇性參數

--gallery-image-definition -i

要從中列出映射版本的共用資源庫映射定義名稱。

--gallery-unique-name

共用資源庫的唯一名稱。

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 'Resource Id' 引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他 「資源識別碼」引數。

--location -l

位置。 值的來源:az account list-locations。 您可以使用 az configure --defaults location=<location> 來設定預設位置。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

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

必要參數

--gallery-image-definition -i

資源庫映射定義。

--gallery-name -r

資源庫名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--add

藉由指定路徑和索引鍵值組,將物件新增至物件清單。 範例:--add property.listProperty < key=value、string 或 JSON 字串 > 。

預設值: []
--force-string

使用 'set' 或 'add' 時,請保留字元串常值,而不是嘗試轉換成 JSON。

預設值: False
--remove

從清單中移除屬性或專案。 範例:--remove property.list OR --remove propertyToRemove。

預設值: []
--set

指定要設定的屬性路徑和值來更新 物件。 範例:--set property1.property2=。

預設值: []