az blueprint artifact role

Commands to manage blueprint role assignment artifact.

Commands

az blueprint artifact role create

Create blueprint role artifact.

az blueprint artifact role update

Update blueprint role artifact.

az blueprint artifact role create

Create blueprint role artifact.

az blueprint artifact role create --artifact-name
                                  --blueprint-name
                                  --principal-ids
                                  --role-definition-id
                                  [--depends-on]
                                  [--description]
                                  [--display-name]
                                  [--management-group]
                                  [--resource-group-art]
                                  [--subscription]

Examples

Create a role artifact

az blueprint artifact role create \
--blueprint-name MyBlueprint --artifact-name MyRole --role-definition-id \
"/providers/Microsoft.Authorization/roleDefinitions/00000000-0000-0000-0000-000000000000" \
--principal-ids "[parameters('[Usergrouporapplicationname]:MyRoleAssignmentName')]"

Required Parameters

--artifact-name

Name of the blueprint artifact.

--blueprint-name

Name of the blueprint definition.

--principal-ids

Array of user or group identities in Azure Active Directory or a reference to the corresponding parameter in blueprint definiton. The roleDefinition will apply to each identity.

--role-definition-id

The full role definition id. Only built-in roles are supported.

Optional Parameters

--depends-on

Artifacts which need to be deployed before the specified artifact.

--description

Description of the blueprint artifact.

--display-name

DisplayName of this artifact.

--management-group -m

Use management group for the scope of the blueprint.

--resource-group-art

Name of the resource group artifact to which the policy will be assigned.

--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 artifact role update

Update blueprint role artifact.

az blueprint artifact role update --artifact-name
                                  --blueprint-name
                                  [--depends-on]
                                  [--description]
                                  [--display-name]
                                  [--management-group]
                                  [--resource-group-art]
                                  [--subscription]

Examples

Update a role artifact

az blueprint artifact role update \
--blueprint-name MyBlueprint --artifact-name MyRole --display-name "My Big Role"

Required Parameters

--artifact-name

Name of the blueprint 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

DisplayName of this artifact.

--management-group -m

Use management group for the scope of the blueprint.

--resource-group-art

Name of the resource group artifact to which the policy will be assigned.

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