az blueprint artifact template

  • Breaking change

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 artifact template command. Learn more about extensions.

Azure Blueprints is retiring on 31 January 2027, with phased restrictions starting 31 July 2026. After retirement, the service API stops responding and these commands will stop functioning; they will be removed from the Azure CLI in a later release. Migrate blueprint definitions to Template Specs and assignments to Azure Deployment Stacks (recommended). Migration guidance: https://aka.ms/AzureBlueprintsRetirement This command group is implicitly deprecated because command group 'az blueprint' is deprecated and will be removed in a future release.

Commands to manage blueprint ARM template artifact.

Commands

Name Description Type Status
az blueprint artifact template create

Create blueprint arm artifact.

 Extension GA
az blueprint artifact template update

Update blueprint arm artifact.

 Extension GA

az blueprint artifact template create

Breaking change

Azure Blueprints is retiring on 31 January 2027, with phased restrictions starting 31 July 2026. After retirement, the service API stops responding and these commands will stop functioning; they will be removed from the Azure CLI in a later release. Migrate blueprint definitions to Template Specs and assignments to Azure Deployment Stacks (recommended). Migration guidance: https://aka.ms/AzureBlueprintsRetirement This command is implicitly deprecated because command group 'az blueprint' is deprecated and will be removed in a future release.

Create blueprint arm artifact.

az blueprint artifact template create --artifact-name
                                      --blueprint-name
                                      --template
                                      [--acquire-policy-token]
                                      [--change-reference]
                                      [--depends-on]
                                      [--description]
                                      [--display-name]
                                      [--management-group]
                                      [--parameters]
                                      [--resource-group-art]
                                      [--subscription]

Examples

Create an arm artifact

az blueprint artifact template create \
--blueprint-name MyBlueprint --artifact-name MyTemplate \
--parameters path/to/parameter/file --template path/to/template

Required Parameters

--artifact-name

Name of the blueprint artifact.

--blueprint-name

Name of the blueprint definition.

--template -t

ARM template in JSON string or path to JSON file.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--depends-on

Artifacts which need to be deployed before the specified artifact.

--description

Description of the blueprint artifact.

--display-name

DisplayName of this artifact.

--management-group -m

Use management group for the scope of the blueprint.

Property Value
Parameter group: Resource_scope Arguments
--parameters -p

Parameters for ARM template artifact. It can be a JSON string or JSON file path.

--resource-group-art

Name of the resource group artifact to which the policy will be assigned.

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

Property Value
Parameter group: Resource_scope 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 blueprint artifact template update

Breaking change

Azure Blueprints is retiring on 31 January 2027, with phased restrictions starting 31 July 2026. After retirement, the service API stops responding and these commands will stop functioning; they will be removed from the Azure CLI in a later release. Migrate blueprint definitions to Template Specs and assignments to Azure Deployment Stacks (recommended). Migration guidance: https://aka.ms/AzureBlueprintsRetirement This command is implicitly deprecated because command group 'az blueprint' is deprecated and will be removed in a future release.

Update blueprint arm artifact.

az blueprint artifact template update --artifact-name
                                      --blueprint-name
                                      [--acquire-policy-token]
                                      [--change-reference]
                                      [--depends-on]
                                      [--description]
                                      [--display-name]
                                      [--management-group]
                                      [--parameters]
                                      [--resource-group-art]
                                      [--subscription]
                                      [--template]

Examples

Update a arm artifact

az blueprint artifact template update \
--blueprint-name MyBlueprint --artifact-name MyTemplate --display-name "My Template"

Required Parameters

--artifact-name

Name of the blueprint artifact.

--blueprint-name

Name of the blueprint definition.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--depends-on

Artifacts which need to be deployed before the specified artifact. Use '--depends-on' with no values to remove dependencies.

--description

Description of the blueprint artifact.

--display-name

DisplayName of this artifact.

--management-group -m

Use management group for the scope of the blueprint.

Property Value
Parameter group: Resource_scope Arguments
--parameters -p

Parameters for ARM template artifact. It can be a JSON string or JSON file path.

--resource-group-art

Name of the resource group artifact to which the policy will be assigned.

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

Property Value
Parameter group: Resource_scope Arguments
--template -t

ARM template in JSON string or path to JSON file.

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