az blueprint

Commands to manage blueprint.

Commands

az blueprint artifact

Commands to manage blueprint artifact.

az blueprint artifact delete

Delete a blueprint artifact.

az blueprint artifact list

List artifacts for a given blueprint definition.

az blueprint artifact policy

Commands to manage blueprint policy assignment artifact.

az blueprint artifact policy create

Create blueprint policy artifact.

az blueprint artifact policy update

Update blueprint policy artifact.

az blueprint artifact role

Commands to manage blueprint role assignment artifact.

az blueprint artifact role create

Create blueprint role artifact.

az blueprint artifact role update

Update blueprint role artifact.

az blueprint artifact show

Get a blueprint artifact.

az blueprint artifact template

Commands to manage blueprint ARM template artifact.

az blueprint artifact template create

Create blueprint arm artifact.

az blueprint artifact template update

Update blueprint arm artifact.

az blueprint assignment

Commands to manage blueprint assignment.

az blueprint assignment create

Create a blueprint assignment.

az blueprint assignment delete

Delete a blueprint assignment.

az blueprint assignment list

List blueprint assignments within a subscription.

az blueprint assignment show

Get a blueprint assignment.

az blueprint assignment update

Update a blueprint assignment.

az blueprint assignment wait

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

az blueprint assignment who

Get Blueprint Servie Principal Name objectId.

az blueprint create

Create a blueprint definition.

az blueprint delete

Delete a blueprint definition.

az blueprint import

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

az blueprint list

List blueprint definitions.

az blueprint publish

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

az blueprint resource-group

Commands to manage blueprint resource group artifact.

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 show

Get a blueprint definition.

az blueprint update

Update a blueprint definition.

az blueprint version

Commands to manage published blueprint versions.

az blueprint version artifact

Commands to manage published blueprint artifacts.

az blueprint version artifact list

List artifacts for a version of a published blueprint.

az blueprint version artifact show

Show an artifact for a published blueprint.

az blueprint version delete

Delete a published version of a blueprint.

az blueprint version list

List published versions of given blueprint definition.

az blueprint version show

Get a published version of a blueprint.

az blueprint create

Create a blueprint definition.

az blueprint create --name
                    [--description]
                    [--display-name]
                    [--management-group]
                    [--parameters]
                    [--subscription]
                    [--target-scope {managementGroup, 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.

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.

--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
default value: subscription

az blueprint delete

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.

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.

az blueprint list

List blueprint definitions.

az blueprint list [--management-group]
                  [--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.

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

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.

az blueprint show

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.

az blueprint update

Update a blueprint definition.

az blueprint update --name
                    [--add]
                    [--description]
                    [--force-string]
                    [--management-group]
                    [--parameters]
                    [--remove]
                    [--set]
                    [--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.

--force-string

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

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

--remove

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

--set

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

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