Microsoft.Blueprint blueprints/artifacts

The blueprints/artifacts resource type can be deployed to: Resource groups, Subscriptions, Management groups.

To learn about resource group deployments, see Bicep or ARM template. To learn about subscription deployments, see Bicep or ARM template To learn about management group deployments, see Bicep or ARM template

Template format

To create a Microsoft.Blueprint/blueprints/artifacts resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Blueprint/blueprints/artifacts@2018-11-01-preview' = {
  name: 'string'
  kind: 'string'
  parent: resourceSymbolicName
  // For remaining properties, see blueprints/artifacts objects
}

blueprints/artifacts objects

Set the kind property to specify the type of object.

For policyAssignment, use:

  kind: 'policyAssignment'
  properties: {
    dependsOn: [
      'string'
    ]
    description: 'string'
    displayName: 'string'
    parameters: {}
    policyDefinitionId: 'string'
    resourceGroup: 'string'
  }

For roleAssignment, use:

  kind: 'roleAssignment'
  properties: {
    dependsOn: [
      'string'
    ]
    description: 'string'
    displayName: 'string'
    principalIds: any()
    resourceGroup: 'string'
    roleDefinitionId: 'string'
  }

For template, use:

  kind: 'template'
  properties: {
    dependsOn: [
      'string'
    ]
    description: 'string'
    displayName: 'string'
    parameters: {}
    resourceGroup: 'string'
    template: any()
  }

Property values

blueprints/artifacts

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Blueprint/blueprints/artifacts'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2018-11-01-preview'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
kind Set the object type policyAssignment
roleAssignment
template
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: blueprints

PolicyAssignmentArtifact

Name Description Value
kind Specifies the kind of blueprint artifact. 'policyAssignment'
properties Properties of a Policy assignment blueprint artifact. PolicyAssignmentArtifactProperties (required)

PolicyAssignmentArtifactProperties

Name Description Value
dependsOn Artifacts which need to be deployed before the specified artifact. string[]
description Multi-line explain this resource. string
displayName One-liner string explain this resource. string
parameters Parameter values for the policy definition. object (required)
policyDefinitionId Azure resource ID of the policy definition. string (required)
resourceGroup Name of the resource group placeholder to which the policy will be assigned. string

RoleAssignmentArtifact

Name Description Value
kind Specifies the kind of blueprint artifact. 'roleAssignment'
properties Properties of a Role assignment blueprint artifact. RoleAssignmentArtifactProperties (required)

RoleAssignmentArtifactProperties

Name Description Value
dependsOn Artifacts which need to be deployed before the specified artifact. string[]
description Multi-line explain this resource. string
displayName One-liner string explain this resource. string
principalIds Anything For Bicep, you can use the any() function.(required)
resourceGroup RoleAssignment will be scope to this resourceGroup. If empty, it scopes to the subscription. string
roleDefinitionId Azure resource ID of the RoleDefinition. string (required)

TemplateArtifact

Name Description Value
kind Specifies the kind of blueprint artifact. 'template'
properties Properties of a Resource Manager template blueprint artifact. TemplateArtifactProperties (required)

TemplateArtifactProperties

Name Description Value
dependsOn Artifacts which need to be deployed before the specified artifact. string[]
description Multi-line explain this resource. string
displayName One-liner string explain this resource. string
parameters Resource Manager template blueprint artifact parameter values. object (required)
resourceGroup If applicable, the name of the resource group placeholder to which the Resource Manager template blueprint artifact will be deployed. string
template Any object For Bicep, you can use the any() function.(required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Blueprints - Create a new blueprint definition

Deploy to Azure
This template creaes an Azure Blueprint blueprint definition. The blueprint definition includes a policy assignment artifact and can be modified and then deployed to management groups or subscriptions for consistent environments.