az blueprint resource-group

Commands to manage blueprint resource group artifact.

Commands

az blueprint resource-group add

Add a resource group artifact to the blueprint.

az blueprint resource-group list

List blueprint resource group artifact.

az blueprint resource-group remove

Remove a blueprint resource group artifact.

az blueprint resource-group show

Show blueprint resource group artifact.

az blueprint resource-group update

Update blueprint resource group artifact.

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.

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.

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.

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.

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.

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