Microsoft.Blueprint blueprints/artifacts 2018-11-01-preview
Bicep resource definition
The blueprints/artifacts resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
- Subscriptions - See subscription deployment commands
- Management groups - See management 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'
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 |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
| kind | Set the object type | policyAssignment roleAssignment template (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 |
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 |
| 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' (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 |
| displayName | One-liner string explain this resource. | string |
| principalIds | Array of user or group identities in Azure Active Directory. The roleDefinition will apply to each identity. | 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' (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 |
| 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 | The Resource Manager template blueprint artifact body. | 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 |
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. |
ARM template resource definition
The blueprints/artifacts resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
- Subscriptions - See subscription deployment commands
- Management groups - See management 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.
{
"type": "Microsoft.Blueprint/blueprints/artifacts",
"apiVersion": "2018-11-01-preview",
"name": "string",
"kind": "string",
// 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": {},
"resourceGroup": "string",
"roleDefinitionId": "string"
}
For template, use:
"kind": "template",
"properties": {
"dependsOn": [ "string" ],
"description": "string",
"displayName": "string",
"parameters": {},
"resourceGroup": "string",
"template": {}
}
Property values
blueprints/artifacts
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Blueprint/blueprints/artifacts' |
| apiVersion | The resource api version | '2018-11-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| kind | Set the object type | policyAssignment roleAssignment template (required) |
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 |
| 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' (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 |
| displayName | One-liner string explain this resource. | string |
| principalIds | Array of user or group identities in Azure Active Directory. The roleDefinition will apply to each identity. | |
| 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' (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 |
| 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 | The Resource Manager template blueprint artifact body. |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Blueprints - Create a new blueprint definition |
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:
- Resource groups
- Subscriptions
- Management 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" {
type = "Microsoft.Blueprint/blueprints/artifacts@2018-11-01-preview"
name = "string"
parent_id = "string"
// For remaining properties, see blueprints/artifacts objects
body = jsonencode({
kind = "string"
})
}
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"
resourceGroup = "string"
roleDefinitionId = "string"
}
For template, use:
kind = "template"
properties = {
dependsOn = [
"string"
]
description = "string"
displayName = "string"
parameters = {}
resourceGroup = "string"
}
Property values
blueprints/artifacts
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Blueprint/blueprints/artifacts@2018-11-01-preview" |
| 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 |
| kind | Set the object type | policyAssignment roleAssignment template (required) |
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 |
| 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" (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 |
| displayName | One-liner string explain this resource. | string |
| principalIds | Array of user or group identities in Azure Active Directory. The roleDefinition will apply to each identity. | |
| 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" (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 |
| 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 | The Resource Manager template blueprint artifact body. |