Skip to content

Commit d22ba5e

Browse files
CopilotLiliDeng
andcommitted
Add documentation for marketplace_source parameter in SIG transformer
Co-authored-by: LiliDeng <[email protected]>
1 parent 72b25ad commit d22ba5e

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

docs/run_test/transformers.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,22 @@ Usage
9595
rename:
9696
azure_sig_url: shared_gallery
9797
98+
Alternatively, if your SIG is created from a marketplace image, you can provide the source marketplace image instead of manually specifying architecture, Hyper-V generation, and security type:
99+
100+
.. code:: yaml
101+
102+
transformer:
103+
- type: azure_sig
104+
vhd: "https://sc.blob.core.windows.net/vhds/pageblob.vhd"
105+
gallery_resource_group_name: rg_name
106+
gallery_name: galleryname
107+
gallery_image_location:
108+
- westus3
109+
- westus2
110+
gallery_image_name: image_name
111+
gallery_image_fullname: Microsoft Linux arm64 0.0.1
112+
marketplace_source: "canonical 0001-com-ubuntu-server-jammy 22_04-lts-arm64 latest"
113+
98114
Process
99115
````````
100116
- Create Resource group
@@ -223,6 +239,24 @@ host_caching_type
223239
type: string | Default: "None" | Allowed Values: "None", "ReadOnly", "ReadWrite"
224240

225241

242+
marketplace_source
243+
^^^^^^^^^^^^^^^^^^
244+
type: string | Default: ""
245+
246+
Optional marketplace image identifier to automatically derive architecture, Hyper-V generation, and security type from the source marketplace image. This is useful when creating a SIG from a marketplace image-based VHD.
247+
248+
When specified, this parameter will override:
249+
- ``gallery_image_architecture``
250+
- ``gallery_image_hyperv_generation``
251+
- ``gallery_image_securitytype``
252+
253+
Format: ``<publisher> <offer> <sku> <version>``
254+
255+
Example: ``canonical 0001-com-ubuntu-server-jammy 22_04-lts-arm64 latest``
256+
257+
Note: If marketplace_source is not provided, you must manually specify gallery_image_architecture, gallery_image_hyperv_generation, and gallery_image_securitytype as needed.
258+
259+
226260
rename
227261
^^^^^^
228262
type: <key>: <value>

0 commit comments

Comments
 (0)