Share via

az blueprint

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

Commands to manage blueprint.

Commands

Name Description Type Status
az blueprint artifact

Commands to manage blueprint artifact.

 Extension GA
az blueprint artifact delete

Delete a blueprint artifact.

 Extension Preview
az blueprint artifact list

List artifacts for a given blueprint definition.

 Extension Preview
az blueprint artifact policy

Commands to manage blueprint policy assignment artifact.

 Extension GA
az blueprint artifact policy create

Create blueprint policy artifact.

 Extension GA
az blueprint artifact policy update

Update blueprint policy artifact.

 Extension GA
az blueprint artifact role

Commands to manage blueprint role assignment artifact.

 Extension GA
az blueprint artifact role create

Create blueprint role artifact.

 Extension GA
az blueprint artifact role update

Update blueprint role artifact.

 Extension GA
az blueprint artifact show

Get a blueprint artifact.

 Extension Preview
az blueprint artifact template

Commands to manage blueprint ARM template artifact.

 Extension GA
az blueprint artifact template create

Create blueprint arm artifact.

 Extension GA
az blueprint artifact template update

Update blueprint arm artifact.

 Extension GA
az blueprint assignment

Commands to manage blueprint assignment.

 Extension GA
az blueprint assignment create

Create a blueprint assignment.

 Extension GA
az blueprint assignment delete

Delete a blueprint assignment.

 Extension Preview
az blueprint assignment list

List blueprint assignments within a subscription.

 Extension Preview
az blueprint assignment show

Get a blueprint assignment.

 Extension Preview
az blueprint assignment update

Update a blueprint assignment.

 Extension GA
az blueprint assignment wait

Place the CLI in a waiting state until a condition of the Blueprint Assignment is met.

 Extension GA
az blueprint assignment who

Get Blueprint Servie Principal Name objectId.

 Extension Preview
az blueprint create

Create a blueprint definition.

 Extension Preview
az blueprint delete

Delete a blueprint definition.

 Extension Preview
az blueprint export

Export a blueprint definition and artifacts to json file(s).

 Extension GA
az blueprint import

Import a blueprint definition and artifacts from a directoy of json files.

 Extension GA
az blueprint list

List blueprint definitions.

 Extension Preview
az blueprint publish

Publish a new version of the blueprint definition with the latest artifacts. Published blueprint definitions are immutable.

 Extension Preview
az blueprint resource-group

Commands to manage blueprint resource group artifact.

 Extension GA
az blueprint resource-group add

Add a resource group artifact to the blueprint.

 Extension GA
az blueprint resource-group list

List blueprint resource group artifact.

 Extension GA
az blueprint resource-group remove

Remove a blueprint resource group artifact.

 Extension GA
az blueprint resource-group show

Show blueprint resource group artifact.

 Extension GA
az blueprint resource-group update

Update blueprint resource group artifact.

 Extension GA
az blueprint show

Get a blueprint definition.

 Extension Preview
az blueprint update

Update a blueprint definition.

 Extension Preview
az blueprint version

Commands to manage published blueprint versions.

 Extension Preview
az blueprint version artifact

Commands to manage published blueprint artifacts.

 Extension Preview
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 delete

Delete a published version of a blueprint.

 Extension Preview
az blueprint version list

List published versions of given blueprint definition.

 Extension Preview
az blueprint version show

Get a published version of a blueprint.

 Extension Preview

az blueprint create

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a blueprint definition.

az blueprint create --name
                    --target-scope {managementGroup, subscription}
                    [--description]
                    [--display-name]
                    [--management-group]
                    [--parameters]
                    [--resource-groups]
                    [--subscription]

Examples

Create a subscription blueprint

az blueprint create --subscription MySubscription --name MyBlueprint --description "blueprint contains all artifacts" --target-scope subscription

Create a management group blueprint

az blueprint create --management-group MyManagementGroup --name MyBlueprint --description "blueprint contains all artifact" --target-scope subscription

Required Parameters

--name -n

Name of the blueprint definition.

--target-scope

The scope where this blueprint definition can be assigned.

Accepted values: managementGroup, subscription

Optional Parameters

--description

Multi-line explain this resource.

--display-name

One-liner string explain this resource.

--management-group -m

Use management group for the scope of the blueprint.

--parameters -p

Parameters required by this blueprint definition. It can be a JSON string or JSON file path. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-groups

Resource group placeholders defined by this blueprint definition. Expected value: json-string/@json-file. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a blueprint definition.

az blueprint delete --name
                    [--management-group]
                    [--subscription]
                    [--yes]

Examples

Delete a management group blueprint

az blueprint delete --management-group MyManagementGroup --name MyBlueprint

Delete a subscription blueprint

az blueprint delete --subscription MySubscription --name MyBlueprint

Required Parameters

--name -n

Name of the 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.

--yes -y

Do not prompt for confirmation.

Default value: False
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 export

Export a blueprint definition and artifacts to json file(s).

az blueprint export --name
                    --output-path
                    [--management-group]
                    [--subscription]
                    [--yes]

Examples

Export a blueprint definition and artifacts

az blueprint export --name MyBlueprint \
--output-path "path/to/blueprint/directory"

Required Parameters

--name -n

Name of the blueprint definition to export.

--output-path

The directory path for json definitions of the blueprint and artifacts. The blueprint definition file will be named blueprint.json. Artifacts json files will be in a subdirectory named artifacts.

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.

--yes -y

Skip user confirmation. When set, if directory does not exist, it will be created. If the directory exists and has contents, they will be overwritten. If not set, user will be prompted for permission to proceed.

Default value: False
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 import

Import a blueprint definition and artifacts from a directoy of json files.

az blueprint import --input-path
                    --name
                    [--management-group]
                    [--subscription]
                    [--yes]

Examples

Import a blueprint definition and artifacts

az blueprint import --name MyBlueprint \
--input-path "path/to/blueprint/directory"

Required Parameters

--input-path

The directory path for json definitions of the blueprint and artifacts. The blueprint definition file should be named blueprint.json. Artifacts json files should be in a subdirectory named artifacts.

--name -n

Name of the 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.

--yes -y

Do not prompt for confirmation.

Default value: False
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 list

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List blueprint definitions.

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

Examples

List blueprints in a management group

az blueprint list --management-group MyManagementGroup

List blueprints in a subscription

az blueprint list --subscription MySubscription

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 publish

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Publish a new version of the blueprint definition with the latest artifacts. Published blueprint definitions are immutable.

az blueprint publish --blueprint-name
                     --version
                     [--change-notes]
                     [--management-group]
                     [--subscription]

Examples

Publish a management group blueprint

az blueprint publish --management-group MyManagementGroup --blueprint-name MyBlueprint --version v2

Publish a subscription blueprint

az blueprint publish --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

--change-notes

Version-specific change notes.

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

az blueprint show

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a blueprint definition.

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

Examples

Show a management group blueprint

az blueprint show --management-group MyManagementGroup --name MyBlueprint

Show a subscription blueprint

az blueprint show --subscription MySubscription --name MyBlueprint

Required Parameters

--name -n

Name of the 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.

az blueprint update

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a blueprint definition.

az blueprint update --name
                    [--add]
                    [--description]
                    [--display-name]
                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                    [--management-group]
                    [--parameters]
                    [--remove]
                    [--resource-groups]
                    [--set]
                    [--subscription]
                    [--target-scope {managementGroup, subscription}]

Required Parameters

--name -n

Name of the blueprint definition.

Optional Parameters

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

--description

Multi-line explain this resource.

--display-name

One-liner string explain this resource.

--force-string

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--management-group -m

Use management group for the scope of the blueprint.

--parameters -p

Parameters required by this blueprint definition. It can be a JSON string or JSON file path. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--remove

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

--resource-groups

Resource group placeholders defined by this blueprint definition. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--set

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

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

--target-scope

The scope where this blueprint definition can be assigned.

Accepted values: managementGroup, subscription
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.