az blueprint artifact template
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.
Blueprints and associated commands will be deprecated as early as July 2026. Customers are encouraged to transition to Template Specs and Deployments Stacks to support their scenarios beyond that date. Migration documentation is available at https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/migrate-blueprint. 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 | Deprecated |
az blueprint artifact template update |
Update blueprint arm artifact. |
Extension | Deprecated |
az blueprint artifact template create
Blueprints and associated commands will be deprecated as early as July 2026. Customers are encouraged to transition to Template Specs and Deployments Stacks to support their scenarios beyond that date. Migration documentation is available at https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/migrate-blueprint. 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
[--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
Name of the blueprint artifact.
Name of the blueprint definition.
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.
Artifacts which need to be deployed before the specified artifact.
Description of the blueprint artifact.
DisplayName of this artifact.
Use management group for the scope of the blueprint.
Property | Value |
---|---|
Parameter group: | Resource_scope Arguments |
Parameters for ARM template artifact. It can be a JSON string or JSON file path.
Name of the resource group artifact to which the policy will be assigned.
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az blueprint artifact template update
Blueprints and associated commands will be deprecated as early as July 2026. Customers are encouraged to transition to Template Specs and Deployments Stacks to support their scenarios beyond that date. Migration documentation is available at https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/migrate-blueprint. 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
[--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
Name of the blueprint artifact.
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.
Artifacts which need to be deployed before the specified artifact. Use '--depends-on' with no values to remove dependencies.
Description of the blueprint artifact.
DisplayName of this artifact.
Use management group for the scope of the blueprint.
Property | Value |
---|---|
Parameter group: | Resource_scope Arguments |
Parameters for ARM template artifact. It can be a JSON string or JSON file path.
Name of the resource group artifact to which the policy will be assigned.
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 |
ARM template in JSON string or path to JSON file.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |