[gallery-service-artifact] Add command example #8962

cxznmhdcxz · 2025-07-14T03:39:18Z

This checklist is used to make sure that common guidelines for a pull request are followed.

Related command

General Guidelines

Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
Have you run python scripts/ci/test_index.py -q locally? (pip install wheel==0.30.0 required)
My extension version conforms to the Extension version schema

For new extensions:

My extension description/summary conforms to the Extension Summary Guidelines.

About Extension Publish

There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update src/index.json automatically.
You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify src/index.json.

azure-client-tools-bot-prd · 2025-07-14T03:39:21Z

️✔️Azure CLI Extensions Breaking Change Test

️✔️Non Breaking Changes

azure-client-tools-bot-prd · 2025-07-14T03:39:24Z

Hi @cxznmhdcxz,
Please write the description of changes which can be perceived by customers into HISTORY.rst.
If you want to release a new extension version, please update the version in setup.py as well.

yonzhan · 2025-07-14T03:39:30Z

Thank you for your contribution! We will review the pull request and get back to you soon.

github-actions · 2025-07-14T03:39:34Z

The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR.

Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions).
After that please run the following commands to enable git hooks:

pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>

Copilot

Pull Request Overview

This PR adds a command example to the gallery service artifact create command documentation. The change enhances the user experience by providing a concrete usage example for the az gallery service-artifact create command.

Adds a detailed command example showing how to create a service artifact with all required parameters

Copilot · 2025-07-14T03:39:56Z

...rvice-artifact/azext_gallery_service_artifact/aaz/latest/gallery/service_artifact/_create.py

    """Create a Service Artifact under a gallery.
+    
+    :example: Create a Service Artifact under a gallery.
+        az gallery service-artifact create --gallery-name gallery -g rg --service-artifact-name TestArco --location eastus2euap --target-locations "[{'name': 'eastus2euap'}, {'name': 'centraluseuap'}, {'name': 'westcentralus'}, {'name': 'westus'}]" --vm-artifacts-profiles "[{'artifactProfiles': [{'description': 'Using a SIG Image for mocking', 'imageReference': {'id': '/subscriptions/db75-92e7-4da3-8e63-0ed4bd4c3d5e/resourceGroups/robhoopa_validate_arco_changes/providers/Microsoft.Compute/galleries/ArcoBugBashGallery1/images/WindowsGen2ImageGeneralized1', 'initialVersion': '0.0.1'}}], 'description': 'VM Artifact profile with default upgrade window', 'name': 'vmArtifactsProfile', 'upgradeSdpPolicy': {'schedulingPolicy': {'disableRegularUpgrades': False, 'maxConcurrentResourceCountPerRegion': 5, 'upgradeWindow': 'Default'}, 'type': 'PlatformOrchestratedForNewAndExistingResources'}}]" --description "Test Arco"


The command example contains what appears to be a real subscription ID 'db75-92e7-4da3-8e63-0ed4bd4c3d5e' and resource group name 'robhoopa_validate_arco_changes'. Documentation examples should use placeholder values to avoid exposing real Azure resource identifiers.

Suggested change

az gallery service-artifact create --gallery-name gallery -g rg --service-artifact-name TestArco --location eastus2euap --target-locations "[{'name': 'eastus2euap'}, {'name': 'centraluseuap'}, {'name': 'westcentralus'}, {'name': 'westus'}]" --vm-artifacts-profiles "[{'artifactProfiles': [{'description': 'Using a SIG Image for mocking', 'imageReference': {'id': '/subscriptions/db75-92e7-4da3-8e63-0ed4bd4c3d5e/resourceGroups/robhoopa_validate_arco_changes/providers/Microsoft.Compute/galleries/ArcoBugBashGallery1/images/WindowsGen2ImageGeneralized1', 'initialVersion': '0.0.1'}}], 'description': 'VM Artifact profile with default upgrade window', 'name': 'vmArtifactsProfile', 'upgradeSdpPolicy': {'schedulingPolicy': {'disableRegularUpgrades': False, 'maxConcurrentResourceCountPerRegion': 5, 'upgradeWindow': 'Default'}, 'type': 'PlatformOrchestratedForNewAndExistingResources'}}]" --description "Test Arco"

az gallery service-artifact create --gallery-name gallery -g rg --service-artifact-name TestArco --location eastus2euap --target-locations "[{'name': 'eastus2euap'}, {'name': 'centraluseuap'}, {'name': 'westcentralus'}, {'name': 'westus'}]" --vm-artifacts-profiles "[{'artifactProfiles': [{'description': 'Using a SIG Image for mocking', 'imageReference': {'id': '/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Compute/galleries/ArcoBugBashGallery1/images/WindowsGen2ImageGeneralized1', 'initialVersion': '0.0.1'}}], 'description': 'VM Artifact profile with default upgrade window', 'name': 'vmArtifactsProfile', 'upgradeSdpPolicy': {'schedulingPolicy': {'disableRegularUpgrades': False, 'maxConcurrentResourceCountPerRegion': 5, 'upgradeWindow': 'Default'}, 'type': 'PlatformOrchestratedForNewAndExistingResources'}}]" --description "Test Arco"

Copilot · 2025-07-14T03:39:56Z

...rvice-artifact/azext_gallery_service_artifact/aaz/latest/gallery/service_artifact/_create.py

    """Create a Service Artifact under a gallery.
+    
+    :example: Create a Service Artifact under a gallery.
+        az gallery service-artifact create --gallery-name gallery -g rg --service-artifact-name TestArco --location eastus2euap --target-locations "[{'name': 'eastus2euap'}, {'name': 'centraluseuap'}, {'name': 'westcentralus'}, {'name': 'westus'}]" --vm-artifacts-profiles "[{'artifactProfiles': [{'description': 'Using a SIG Image for mocking', 'imageReference': {'id': '/subscriptions/db75-92e7-4da3-8e63-0ed4bd4c3d5e/resourceGroups/robhoopa_validate_arco_changes/providers/Microsoft.Compute/galleries/ArcoBugBashGallery1/images/WindowsGen2ImageGeneralized1', 'initialVersion': '0.0.1'}}], 'description': 'VM Artifact profile with default upgrade window', 'name': 'vmArtifactsProfile', 'upgradeSdpPolicy': {'schedulingPolicy': {'disableRegularUpgrades': False, 'maxConcurrentResourceCountPerRegion': 5, 'upgradeWindow': 'Default'}, 'type': 'PlatformOrchestratedForNewAndExistingResources'}}]" --description "Test Arco"


The command example is extremely long and difficult to read on a single line. Consider breaking it into multiple lines using line continuation () or restructuring it to improve readability in documentation.

Suggested change

az gallery service-artifact create --gallery-name gallery -g rg --service-artifact-name TestArco --location eastus2euap --target-locations "[{'name': 'eastus2euap'}, {'name': 'centraluseuap'}, {'name': 'westcentralus'}, {'name': 'westus'}]" --vm-artifacts-profiles "[{'artifactProfiles': [{'description': 'Using a SIG Image for mocking', 'imageReference': {'id': '/subscriptions/db75-92e7-4da3-8e63-0ed4bd4c3d5e/resourceGroups/robhoopa_validate_arco_changes/providers/Microsoft.Compute/galleries/ArcoBugBashGallery1/images/WindowsGen2ImageGeneralized1', 'initialVersion': '0.0.1'}}], 'description': 'VM Artifact profile with default upgrade window', 'name': 'vmArtifactsProfile', 'upgradeSdpPolicy': {'schedulingPolicy': {'disableRegularUpgrades': False, 'maxConcurrentResourceCountPerRegion': 5, 'upgradeWindow': 'Default'}, 'type': 'PlatformOrchestratedForNewAndExistingResources'}}]" --description "Test Arco"

az gallery service-artifact create \

--gallery-name gallery \

-g rg \

--service-artifact-name TestArco \

--location eastus2euap \

--target-locations "[

{'name': 'eastus2euap'},

{'name': 'centraluseuap'},

{'name': 'westcentralus'},

{'name': 'westus'}

]" \

--vm-artifacts-profiles "[

{

'artifactProfiles': [

{

'description': 'Using a SIG Image for mocking',

'imageReference': {

'id': '/subscriptions/db75-92e7-4da3-8e63-0ed4bd4c3d5e/resourceGroups/robhoopa_validate_arco_changes/providers/Microsoft.Compute/galleries/ArcoBugBashGallery1/images/WindowsGen2ImageGeneralized1',

'initialVersion': '0.0.1'

}

}

],

'description': 'VM Artifact profile with default upgrade window',

'name': 'vmArtifactsProfile',

'upgradeSdpPolicy': {

'schedulingPolicy': {

'disableRegularUpgrades': False,

'maxConcurrentResourceCountPerRegion': 5,

'upgradeWindow': 'Default'

},

'type': 'PlatformOrchestratedForNewAndExistingResources'

}

}

]" \

--description "Test Arco"

github-actions · 2025-07-14T03:40:29Z

CodeGen Tools Feedback Collection

Thank you for using our CodeGen tool. We value your feedback, and we would like to know how we can improve our product. Please take a few minutes to fill our codegen survey

github-actions · 2025-07-14T03:42:59Z

Hi @cxznmhdcxz

Release Suggestions

Module: gallery-service-artifact

Please log updates into to src/gallery-service-artifact/HISTORY.rst
Update VERSION to 1.0.0b2 in src/gallery-service-artifact/setup.py

Notes

For more info about extension versioning, please refer to Extension version schema

add example

ede6a38

Copilot AI review requested due to automatic review settings July 14, 2025 03:39

azure-client-tools-bot-prd bot added this to the August 2025 (2025-08-05) milestone Jul 14, 2025

Copilot AI reviewed Jul 14, 2025

View reviewed changes

yonzhan requested review from jsntcy and kairu-ms July 14, 2025 03:43

yonzhan assigned kairu-ms Jul 14, 2025

hide values

fadafcc

kairu-ms approved these changes Jul 22, 2025

View reviewed changes

kairu-ms merged commit 7a01872 into Azure:main Jul 22, 2025
24 checks passed

cxznmhdcxz deleted the command-example-gallery-service-artifact branch August 13, 2025 02:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[gallery-service-artifact] Add command example #8962

[gallery-service-artifact] Add command example #8962

Uh oh!

cxznmhdcxz commented Jul 14, 2025

Uh oh!

azure-client-tools-bot-prd bot commented Jul 14, 2025 •

edited

Loading

Uh oh!

azure-client-tools-bot-prd bot commented Jul 14, 2025

Uh oh!

yonzhan commented Jul 14, 2025

Uh oh!

github-actions bot commented Jul 14, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 14, 2025

Uh oh!

Copilot AI Jul 14, 2025

Uh oh!

github-actions bot commented Jul 14, 2025

Uh oh!

github-actions bot commented Jul 14, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

[gallery-service-artifact] Add command example #8962

[gallery-service-artifact] Add command example #8962

Uh oh!

Conversation

cxznmhdcxz commented Jul 14, 2025

Related command

General Guidelines

About Extension Publish

Uh oh!

azure-client-tools-bot-prd bot commented Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

azure-client-tools-bot-prd bot commented Jul 14, 2025

Uh oh!

yonzhan commented Jul 14, 2025

Uh oh!

github-actions bot commented Jul 14, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jul 14, 2025

CodeGen Tools Feedback Collection

Uh oh!

github-actions bot commented Jul 14, 2025

Release Suggestions

Module: gallery-service-artifact

Notes

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

azure-client-tools-bot-prd bot commented Jul 14, 2025 •

edited

Loading