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 --service-artifact-name
                                   --resource-group
                                   --target-locations
                                   --vm-artifacts-profiles
                                   [--description]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--tags]

Required Parameters

--gallery-name

The name of the Gallery under which the Service Artifact is created.

--location

The Azure region where Service Artifact is created.

Property	Value
Parameter group:	GalleryServiceArtifact Arguments

--name --service-artifact-name -n

The name of the Gallery Service Artifact.

--resource-group -g

The name of the resource group. The name is case insensitive.

--target-locations

List of target locations for the Service Artifact Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--vm-artifacts-profiles

VM Artifact Profile Definition Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--description

Description of the Service Artifact.

Property	Value
Parameter group:	Properties Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--tags

Resource tags Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	GalleryServiceArtifact Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az gallery service-artifact get

Get a Service Artifact under a gallery.

az gallery service-artifact get [--expand {latestVersion}]
                                [--gallery-name]
                                [--ids]
                                [--name --service-artifact-name]
                                [--resource-group]
                                [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--expand

The expand expression to apply on the operation. Passing 'latestVersion' as value would return image reference from each region of the Service Artifact.

Property	Value
Accepted values:	latestVersion

--gallery-name

The name of the Gallery under which the Service Artifact is created.

Property	Value
Parameter group:	Resource Id Arguments

--ids

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.

Property	Value
Parameter group:	Resource Id Arguments

--name --service-artifact-name -n

The name of the Gallery Service Artifact.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

The name of the resource group. The name is case insensitive.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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

--gallery-name

The name of the Gallery under which the Service Artifact is created.

--resource-group -g

The name of the resource group. The name is case insensitive.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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 --service-artifact-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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

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>.

Property	Value
Parameter group:	Generic Update Arguments

--description

Description of the Service Artifact.

Property	Value
Parameter group:	Properties Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--gallery-name

The name of the Gallery under which the Service Artifact is created.

Property	Value
Parameter group:	Resource Id Arguments

--ids

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.

Property	Value
Parameter group:	Resource Id Arguments

--location

The Azure region where Service Artifact is created.

Property	Value
Parameter group:	GalleryServiceArtifact Arguments

--name --service-artifact-name -n

The name of the Gallery Service Artifact.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

The name of the resource group. The name is case insensitive.

Property	Value
Parameter group:	Resource Id Arguments

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--tags

Resource tags Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	GalleryServiceArtifact Arguments

--target-locations

List of target locations for the Service Artifact Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--vm-artifacts-profiles

VM Artifact Profile Definition Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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 --service-artifact-name]
                                 [--resource-group]
                                 [--subscription]
                                 [--timeout]
                                 [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--expand

The expand expression to apply on the operation. Passing 'latestVersion' as value would return image reference from each region of the Service Artifact.

Property	Value
Accepted values:	latestVersion

--gallery-name

The name of the Gallery under which the Service Artifact is created.

Property	Value
Parameter group:	Resource Id Arguments

--ids

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.

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --service-artifact-name -n

The name of the Gallery Service Artifact.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

The name of the resource group. The name is case insensitive.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False