az gallery service-artifact
Note
This reference is part of the gallery-service-artifact extension for the Azure CLI (version 2.57.0 or higher). The extension will automatically install the first time you run an az gallery service-artifact command. Learn more about extensions.
Azure Compute Gallery Service Artifact.
Commands
Name | Description | Type | Status |
---|---|---|---|
az gallery service-artifact create |
Create a Service Artifact under a gallery. |
Extension | GA |
az gallery service-artifact get |
Get a Service Artifact under a gallery. |
Extension | GA |
az gallery service-artifact list |
List a list of Service Artifacts in a gallery. |
Extension | GA |
az gallery service-artifact update |
Update a Service Artifact under a gallery. |
Extension | GA |
az gallery service-artifact wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az gallery service-artifact create
Create a Service Artifact under a gallery.
az gallery service-artifact create --gallery-name
--location
--name
--resource-group
--target-locations
--vm-artifacts-profiles
[--description]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--tags]
Required Parameters
The name of the Gallery under which the Service Artifact is created.
The Azure region where Service Artifact is created.
The name of the Gallery Service Artifact.
The name of the resource group. The name is case insensitive.
List of target locations for the Service Artifact Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
VM Artifact Profile Definition Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Optional Parameters
Description of the Service Artifact.
Do not wait for the long-running operation to finish.
Resource tags Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az gallery service-artifact get
Get a Service Artifact under a gallery.
az gallery service-artifact get [--expand {latestVersion}]
[--gallery-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
Optional Parameters
The expand expression to apply on the operation. Passing 'latestVersion' as value would return image reference from each region of the Service Artifact.
The name of the Gallery under which the Service Artifact is created.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the Gallery Service Artifact.
The name of the resource group. The name is case insensitive.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az gallery service-artifact list
List a list of Service Artifacts in a gallery.
az gallery service-artifact list --gallery-name
--resource-group
Required Parameters
The name of the Gallery under which the Service Artifact is created.
The name of the resource group. The name is case insensitive.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az gallery service-artifact update
Update a Service Artifact under a gallery.
az gallery service-artifact update [--add]
[--description]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--gallery-name]
[--ids]
[--location]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--tags]
[--target-locations]
[--vm-artifacts-profiles]
Optional Parameters
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.
Description of the Service Artifact.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
The name of the Gallery under which the Service Artifact is created.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The Azure region where Service Artifact is created.
The name of the Gallery Service Artifact.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
The name of the resource group. The name is case insensitive.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Resource tags Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
List of target locations for the Service Artifact Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
VM Artifact Profile Definition Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az gallery service-artifact wait
Place the CLI in a waiting state until a condition is met.
az gallery service-artifact wait [--created]
[--custom]
[--deleted]
[--exists]
[--expand {latestVersion}]
[--gallery-name]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
The expand expression to apply on the operation. Passing 'latestVersion' as value would return image reference from each region of the Service Artifact.
The name of the Gallery under which the Service Artifact is created.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Polling interval in seconds.
The name of the Gallery Service Artifact.
The name of the resource group. The name is case insensitive.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI