Share via

az blueprint resource-group

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

This command group is implicitly deprecated because command group 'az blueprint' is deprecated and will be removed in a future release. 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.

Commands to manage blueprint resource group artifact.

Commands

Name Description Type Status
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 resource-group add

Breaking change

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.

Add a resource group artifact to the blueprint.

az blueprint resource-group add --blueprint-name
                                [--artifact-name]
                                [--depends-on]
                                [--description]
                                [--display-name]
                                [--management-group]
                                [--rg-location]
                                [--rg-name]
                                [--subscription]
                                [--tags]

Examples

Add a resource group artifact

az blueprint resource-group add \
--blueprint-name MyBlueprint --artifact-name MyResourceGroupArt

Required Parameters

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

--artifact-name

A unique name of this resource group artifact.

--depends-on

Artifacts which need to be deployed before the specified artifact.

--description

Description of the blueprint artifact.

--display-name

Display name of this resource group artifact.

--management-group -m

Use management group for the scope of the blueprint.

Property Value
Parameter group: Resource_scope Arguments
--rg-location

Location of this resource group. Leave empty if the resource group location will be specified during the blueprint assignment.

--rg-name

Name of this resource group. Leave empty if the resource group name will be specified during the blueprint assignment.

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

Tags to be assigned to this resource group.

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 resource-group list

Breaking change

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.

List blueprint resource group artifact.

az blueprint resource-group list --blueprint-name
                                 [--management-group]
                                 [--subscription]

Examples

List resource group artifacts

az blueprint resource-group list \
--blueprint-name MyBlueprint

Required Parameters

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

--management-group -m

Use management group for the scope of the blueprint.

Property Value
Parameter group: Resource_scope Arguments
--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 resource-group remove

Breaking change

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.

Remove a blueprint resource group artifact.

az blueprint resource-group remove --artifact-name
                                   --blueprint-name
                                   [--management-group]
                                   [--subscription]
                                   [--yes]

Examples

Remove a resource group artifact

az blueprint resource-group remove \
--blueprint-name MyBlueprint --artifact-name MyResourceGroupArt

Required Parameters

--artifact-name

A unique name of this resource group 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.

--management-group -m

Use management group for the scope of the blueprint.

Property Value
Parameter group: Resource_scope Arguments
--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
--yes -y

Do not prompt for confirmation.

Property Value
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

az blueprint resource-group show

Breaking change

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.

Show blueprint resource group artifact.

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

Examples

Show a resource group artifact

az blueprint resource-group show \
--blueprint-name MyBlueprint --artifact-name MyResourceGroupArt

Required Parameters

--artifact-name

A unique name of this resource group 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.

--management-group -m

Use management group for the scope of the blueprint.

Property Value
Parameter group: Resource_scope Arguments
--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 resource-group update

Breaking change

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 resource group artifact.

az blueprint resource-group update --artifact-name
                                   --blueprint-name
                                   [--depends-on]
                                   [--description]
                                   [--display-name]
                                   [--management-group]
                                   [--rg-location]
                                   [--rg-name]
                                   [--subscription]
                                   [--tags]

Examples

Update a resource group artifact

az blueprint resource-group update \
--blueprint-name MyBlueprint --artifact-name MyResourceGroupArt --display-name "My Resource Group"

Required Parameters

--artifact-name

A unique name of this resource group 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.

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

Display name of this resource group artifact.

--management-group -m

Use management group for the scope of the blueprint.

Property Value
Parameter group: Resource_scope Arguments
--rg-location

Location of this resource group. Leave empty if the resource group location will be specified during the blueprint assignment.

--rg-name

Name of this resource group. Leave empty if the resource group name will be specified during the blueprint assignment.

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

Tags to be assigned to this resource group.

Property Value
Parameter group: Resource Group 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