Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Microsoft.Blueprint blueprints/artifacts
Bicep resource definition
The blueprints/artifacts resource type can be deployed with operations that target:
- Tenant - See tenant deployment commands* Management groups - See management group deployment commands* Subscription - See subscription deployment commands* Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Blueprint/blueprints/artifacts resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Blueprint/blueprints/artifacts@2018-11-01-preview' = {
name: 'string'
kind: 'string'
// For remaining properties, see Microsoft.Blueprint/blueprints/artifacts objects
}
Microsoft.Blueprint/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: {
{customized property}: {
reference: {
keyVault: {
id: 'string'
}
secretName: 'string'
secretVersion: 'string'
}
value: any(...)
}
}
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: {
{customized property}: {
reference: {
keyVault: {
id: 'string'
}
secretName: 'string'
secretVersion: 'string'
}
value: any(...)
}
}
resourceGroup: 'string'
template: any(...)
}
}
Property Values
Microsoft.Blueprint/blueprints/artifacts
| Name | Description | Value |
|---|---|---|
| kind | Set to 'policyAssignment' for type PolicyAssignmentArtifact. Set to 'roleAssignment' for type RoleAssignmentArtifact. Set to 'template' for type TemplateArtifact. | 'policyAssignment' 'roleAssignment' 'template' (required) |
| name | The resource name | string (required) |
| 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 |
KeyVaultReference
| Name | Description | Value |
|---|---|---|
| id | Azure resource ID of the Key Vault. | string (required) |
ParameterValue
| Name | Description | Value |
|---|---|---|
| reference | Parameter value as reference type. | SecretValueReference |
| value | Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans. | any |
PolicyAssignmentArtifact
| Name | Description | Value |
|---|---|---|
| kind | Specifies the kind of blueprint artifact. | 'policyAssignment' (required) |
| properties | properties for policyAssignment 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 Constraints: Max length = 500 |
| displayName | One-liner string explain this resource. | string Constraints: Max length = 256 |
| parameters | Parameter values for the policy definition. | PolicyAssignmentArtifactPropertiesParameters (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 |
PolicyAssignmentArtifactPropertiesParameters
| Name | Description | Value |
|---|
RoleAssignmentArtifact
| Name | Description | Value |
|---|---|---|
| kind | Specifies the kind of blueprint artifact. | 'roleAssignment' (required) |
| properties | Properties for 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 Constraints: Max length = 500 |
| displayName | One-liner string explain this resource. | string Constraints: Max length = 256 |
| principalIds | Array of user or group identities in Azure Active Directory. The roleDefinition will apply to each identity. | any (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) |
SecretValueReference
| Name | Description | Value |
|---|---|---|
| keyVault | Specifies the reference to a given Azure Key Vault. | KeyVaultReference (required) |
| secretName | Name of the secret. | string (required) |
| secretVersion | The version of the secret to use. If left blank, the latest version of the secret is used. | string |
TemplateArtifact
| Name | Description | Value |
|---|---|---|
| kind | Specifies the kind of blueprint artifact. | 'template' (required) |
| properties | Properties for 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 Constraints: Max length = 500 |
| displayName | One-liner string explain this resource. | string Constraints: Max length = 256 |
| parameters | Resource Manager template blueprint artifact parameter values. | TemplateArtifactPropertiesParameters (required) |
| resourceGroup | If applicable, the name of the resource group placeholder to which the Resource Manager template blueprint artifact will be deployed. | string |
| template | The Resource Manager template blueprint artifact body. | any (required) |
TemplateArtifactPropertiesParameters
| Name | Description | Value |
|---|
ARM template resource definition
The blueprints/artifacts resource type can be deployed with operations that target:
- Tenant - See tenant deployment commands* Management groups - See management group deployment commands* Subscription - See subscription deployment commands* Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Blueprint/blueprints/artifacts resource, add the following JSON to your template.
{
"name": "string",
"kind": "string"
// For remaining properties, see Microsoft.Blueprint/blueprints/artifacts objects
}
Microsoft.Blueprint/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": {
"{customized property}": {
"reference": {
"keyVault": {
"id": "string"
},
"secretName": "string",
"secretVersion": "string"
},
"value": {}
}
},
"policyDefinitionId": "string",
"resourceGroup": "string"
}
}
For roleAssignment, use:
{
"kind": "roleAssignment",
"properties": {
"dependsOn": [ "string" ],
"description": "string",
"displayName": "string",
"principalIds": {},
"resourceGroup": "string",
"roleDefinitionId": "string"
}
}
For template, use:
{
"kind": "template",
"properties": {
"dependsOn": [ "string" ],
"description": "string",
"displayName": "string",
"parameters": {
"{customized property}": {
"reference": {
"keyVault": {
"id": "string"
},
"secretName": "string",
"secretVersion": "string"
},
"value": {}
}
},
"resourceGroup": "string",
"template": {}
}
}
Property Values
Microsoft.Blueprint/blueprints/artifacts
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2018-11-01-preview' |
| kind | Set to 'policyAssignment' for type PolicyAssignmentArtifact. Set to 'roleAssignment' for type RoleAssignmentArtifact. Set to 'template' for type TemplateArtifact. | 'policyAssignment' 'roleAssignment' 'template' (required) |
| name | The resource name | string (required) |
| type | The resource type | 'Microsoft.Blueprint/blueprints/artifacts' |
KeyVaultReference
| Name | Description | Value |
|---|---|---|
| id | Azure resource ID of the Key Vault. | string (required) |
ParameterValue
| Name | Description | Value |
|---|---|---|
| reference | Parameter value as reference type. | SecretValueReference |
| value | Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans. | any |
PolicyAssignmentArtifact
| Name | Description | Value |
|---|---|---|
| kind | Specifies the kind of blueprint artifact. | 'policyAssignment' (required) |
| properties | properties for policyAssignment 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 Constraints: Max length = 500 |
| displayName | One-liner string explain this resource. | string Constraints: Max length = 256 |
| parameters | Parameter values for the policy definition. | PolicyAssignmentArtifactPropertiesParameters (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 |
PolicyAssignmentArtifactPropertiesParameters
| Name | Description | Value |
|---|
RoleAssignmentArtifact
| Name | Description | Value |
|---|---|---|
| kind | Specifies the kind of blueprint artifact. | 'roleAssignment' (required) |
| properties | Properties for 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 Constraints: Max length = 500 |
| displayName | One-liner string explain this resource. | string Constraints: Max length = 256 |
| principalIds | Array of user or group identities in Azure Active Directory. The roleDefinition will apply to each identity. | any (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) |
SecretValueReference
| Name | Description | Value |
|---|---|---|
| keyVault | Specifies the reference to a given Azure Key Vault. | KeyVaultReference (required) |
| secretName | Name of the secret. | string (required) |
| secretVersion | The version of the secret to use. If left blank, the latest version of the secret is used. | string |
TemplateArtifact
| Name | Description | Value |
|---|---|---|
| kind | Specifies the kind of blueprint artifact. | 'template' (required) |
| properties | Properties for 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 Constraints: Max length = 500 |
| displayName | One-liner string explain this resource. | string Constraints: Max length = 256 |
| parameters | Resource Manager template blueprint artifact parameter values. | TemplateArtifactPropertiesParameters (required) |
| resourceGroup | If applicable, the name of the resource group placeholder to which the Resource Manager template blueprint artifact will be deployed. | string |
| template | The Resource Manager template blueprint artifact body. | any (required) |
TemplateArtifactPropertiesParameters
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Blueprints - Create a new blueprint definition 👁 Deploy to Azure |
This template creates 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. |
Terraform (AzAPI provider) resource definition
The blueprints/artifacts resource type can be deployed with operations that target:
- Tenant* Management groups* Subscription* Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Blueprint/blueprints/artifacts resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
name = "string"
kind = "string"
// For remaining properties, see Microsoft.Blueprint/blueprints/artifacts objects
}
Microsoft.Blueprint/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 = {
{customized property} = {
reference = {
keyVault = {
id = "string"
}
secretName = "string"
secretVersion = "string"
}
value = ?
}
}
policyDefinitionId = "string"
resourceGroup = "string"
}
}
For roleAssignment, use:
{
kind = "roleAssignment"
properties = {
dependsOn = [
"string"
]
description = "string"
displayName = "string"
principalIds = ?
resourceGroup = "string"
roleDefinitionId = "string"
}
}
For template, use:
{
kind = "template"
properties = {
dependsOn = [
"string"
]
description = "string"
displayName = "string"
parameters = {
{customized property} = {
reference = {
keyVault = {
id = "string"
}
secretName = "string"
secretVersion = "string"
}
value = ?
}
}
resourceGroup = "string"
template = ?
}
}
Property Values
Microsoft.Blueprint/blueprints/artifacts
| Name | Description | Value |
|---|---|---|
| kind | Set to 'policyAssignment' for type PolicyAssignmentArtifact. Set to 'roleAssignment' for type RoleAssignmentArtifact. Set to 'template' for type TemplateArtifact. | 'policyAssignment' 'roleAssignment' 'template' (required) |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: blueprints |
| type | The resource type | "Microsoft.Blueprint/blueprints/artifacts@2018-11-01-preview" |
KeyVaultReference
| Name | Description | Value |
|---|---|---|
| id | Azure resource ID of the Key Vault. | string (required) |
ParameterValue
| Name | Description | Value |
|---|---|---|
| reference | Parameter value as reference type. | SecretValueReference |
| value | Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans. | any |
PolicyAssignmentArtifact
| Name | Description | Value |
|---|---|---|
| kind | Specifies the kind of blueprint artifact. | 'policyAssignment' (required) |
| properties | properties for policyAssignment 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 Constraints: Max length = 500 |
| displayName | One-liner string explain this resource. | string Constraints: Max length = 256 |
| parameters | Parameter values for the policy definition. | PolicyAssignmentArtifactPropertiesParameters (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 |
PolicyAssignmentArtifactPropertiesParameters
| Name | Description | Value |
|---|
RoleAssignmentArtifact
| Name | Description | Value |
|---|---|---|
| kind | Specifies the kind of blueprint artifact. | 'roleAssignment' (required) |
| properties | Properties for 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 Constraints: Max length = 500 |
| displayName | One-liner string explain this resource. | string Constraints: Max length = 256 |
| principalIds | Array of user or group identities in Azure Active Directory. The roleDefinition will apply to each identity. | any (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) |
SecretValueReference
| Name | Description | Value |
|---|---|---|
| keyVault | Specifies the reference to a given Azure Key Vault. | KeyVaultReference (required) |
| secretName | Name of the secret. | string (required) |
| secretVersion | The version of the secret to use. If left blank, the latest version of the secret is used. | string |
TemplateArtifact
| Name | Description | Value |
|---|---|---|
| kind | Specifies the kind of blueprint artifact. | 'template' (required) |
| properties | Properties for 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 Constraints: Max length = 500 |
| displayName | One-liner string explain this resource. | string Constraints: Max length = 256 |
| parameters | Resource Manager template blueprint artifact parameter values. | TemplateArtifactPropertiesParameters (required) |
| resourceGroup | If applicable, the name of the resource group placeholder to which the Resource Manager template blueprint artifact will be deployed. | string |
| template | The Resource Manager template blueprint artifact body. | any (required) |
TemplateArtifactPropertiesParameters
| Name | Description | Value |
|---|
Feedback
Was this page helpful?