[gallery-service-artifact] Add command example

[cxznmhdcxz]

---

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]

️✔️Azure CLI Extensions Breaking Change Test

️✔️Non Breaking Changes

[azure-client-tools-bot-prd]

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]

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

[github-actions]

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]

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]

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]

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]

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