Share via

az blueprint version artifact

  • Preview
  • Reference

Note

This reference is part of the blueprint extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an az blueprint version artifact command. Learn more about extensions.

Command group 'az blueprint version' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Commands to manage published blueprint artifacts.

Commands

Name Description Type Status
az blueprint version artifact list

List artifacts for a version of a published blueprint.

 Extension Preview
az blueprint version artifact show

Show an artifact for a published blueprint.

 Extension Preview

az blueprint version artifact list

Preview

Command group 'az blueprint version' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List artifacts for a version of a published blueprint.

az blueprint version artifact list --blueprint-name
                                   --version
                                   [--management-group]
                                   [--max-items]
                                   [--next-token]
                                   [--subscription]

Examples

List artifacts of a published management group blueprint

az blueprint version artifact list --management-group MyManagementGroup --blueprint-name MyBlueprint --version v2

List artifacts of a published subscription blueprint

az blueprint version artifact list --subscription MySubscription --blueprint-name MyBlueprint --version v2

Required Parameters

--blueprint-name

Name of the blueprint definition.

--version

Version of the published blueprint definition.

Optional Parameters

--management-group -m

Use management group for the scope of the blueprint.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

--subscription -s

Use subscription for the scope of the blueprint. If --management-group is not specified, --subscription value or the default subscription will be used as the scope.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az blueprint version artifact show

Preview

Command group 'az blueprint version' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show an artifact for a published blueprint.

az blueprint version artifact show --artifact-name
                                   --blueprint-name
                                   --version
                                   [--management-group]
                                   [--subscription]

Examples

Show a role assignment artifact

az blueprint version artifact show --subscription MySubscription --blueprint-name MyBlueprint --version v2 --artifact-name OwnerAssignment

Show a template artifact

az blueprint version artifact show --management-group MyManagementGroup --blueprint-name MyBlueprint --version v2 --artifact-name StorageTemplate

Required Parameters

--artifact-name

Name of the blueprint artifact.

--blueprint-name

Name of the blueprint definition.

--version

Version of the published blueprint definition.

Optional Parameters

--management-group -m

Use management group for the scope of the blueprint.

--subscription -s

Use subscription for the scope of the blueprint. If --management-group is not specified, --subscription value or the default subscription will be used as the scope.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.