az blueprint artifact

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

Commands to manage blueprint artifact.

Commands

Name	Description	Type	Status
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 artifact delete

Preview

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

Delete a blueprint artifact.

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

Examples

Delete a role assignment artifact

az blueprint artifact delete --subscription MySubscription --blueprint-name MyBlueprint --name OwnerAssignment

Delete an ARM template artifact

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

Required Parameters

--blueprint-name

Name of the blueprint definition.

--name -n

Name of the blueprint artifact.

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

Preview

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

List artifacts for a given blueprint definition.

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

Examples

List artifcats for a management group blueprint

az blueprint artifact list --management-group MyManagementGroup --blueprint-name MyBlueprint

List artifcats for a subscription blueprint

az blueprint artifact list --subscription MySubscription --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.

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

Preview

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

Get a blueprint artifact.

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

Examples

Show an artifact of a subscription blueprint

az blueprint artifact show --subscription MySubscription --blueprint-name MyBlueprint --name OwnerAssignment

Show an artifact of a management group blueprint

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

Required Parameters

--blueprint-name

Name of the blueprint definition.

--name -n

Name of the blueprint artifact.

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.