Share via

az blueprint resource-group

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

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

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

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

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

--tags

Tags to be assigned to this resource group.

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

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

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

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

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

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

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

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

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

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

--tags

Tags to be assigned to this resource group.

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.