Blueprint

Represents a Blueprint definition. API Version: 2018-11-01-preview.

Example Usage

ManagementGroupBlueprint

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var blueprint = new AzureNative.Blueprint.Blueprint("blueprint", new()
    {
        BlueprintName = "simpleBlueprint",
        Description = "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}",
        Parameters = 
        {
            { "costCenter", new AzureNative.Blueprint.Inputs.ParameterDefinitionArgs
            {
                DisplayName = "force cost center tag for all resources under given subscription.",
                Type = "string",
            } },
            { "owners", new AzureNative.Blueprint.Inputs.ParameterDefinitionArgs
            {
                DisplayName = "assign owners to subscription along with blueprint assignment.",
                Type = "array",
            } },
            { "storageAccountType", new AzureNative.Blueprint.Inputs.ParameterDefinitionArgs
            {
                DisplayName = "storage account type.",
                Type = "string",
            } },
        },
        ResourceGroups = 
        {
            { "storageRG", new AzureNative.Blueprint.Inputs.ResourceGroupDefinitionArgs
            {
                Description = "Contains storageAccounts that collect all shoebox logs.",
                DisplayName = "storage resource group",
            } },
        },
        ResourceScope = "providers/Microsoft.Management/managementGroups/ContosoOnlineGroup",
        TargetScope = "subscription",
    });

});
package main

import (
	blueprint "github.com/pulumi/pulumi-azure-native/sdk/go/azure/blueprint"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := blueprint.NewBlueprint(ctx, "blueprint", &blueprint.BlueprintArgs{
			BlueprintName: pulumi.String("simpleBlueprint"),
			Description:   pulumi.String("blueprint contains all artifact kinds {'template', 'rbac', 'policy'}"),
			Parameters: blueprint.ParameterDefinitionMap{
				"costCenter": &blueprint.ParameterDefinitionArgs{
					DisplayName: pulumi.String("force cost center tag for all resources under given subscription."),
					Type:        pulumi.String("string"),
				},
				"owners": &blueprint.ParameterDefinitionArgs{
					DisplayName: pulumi.String("assign owners to subscription along with blueprint assignment."),
					Type:        pulumi.String("array"),
				},
				"storageAccountType": &blueprint.ParameterDefinitionArgs{
					DisplayName: pulumi.String("storage account type."),
					Type:        pulumi.String("string"),
				},
			},
			ResourceGroups: blueprint.ResourceGroupDefinitionMap{
				"storageRG": &blueprint.ResourceGroupDefinitionArgs{
					Description: pulumi.String("Contains storageAccounts that collect all shoebox logs."),
					DisplayName: pulumi.String("storage resource group"),
				},
			},
			ResourceScope: pulumi.String("providers/Microsoft.Management/managementGroups/ContosoOnlineGroup"),
			TargetScope:   pulumi.String("subscription"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.blueprint.Blueprint;
import com.pulumi.azurenative.blueprint.BlueprintArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var blueprint = new Blueprint("blueprint", BlueprintArgs.builder()        
            .blueprintName("simpleBlueprint")
            .description("blueprint contains all artifact kinds {'template', 'rbac', 'policy'}")
            .parameters(Map.ofEntries(
                Map.entry("costCenter", Map.ofEntries(
                    Map.entry("displayName", "force cost center tag for all resources under given subscription."),
                    Map.entry("type", "string")
                )),
                Map.entry("owners", Map.ofEntries(
                    Map.entry("displayName", "assign owners to subscription along with blueprint assignment."),
                    Map.entry("type", "array")
                )),
                Map.entry("storageAccountType", Map.ofEntries(
                    Map.entry("displayName", "storage account type."),
                    Map.entry("type", "string")
                ))
            ))
            .resourceGroups(Map.of("storageRG", Map.ofEntries(
                Map.entry("description", "Contains storageAccounts that collect all shoebox logs."),
                Map.entry("displayName", "storage resource group")
            )))
            .resourceScope("providers/Microsoft.Management/managementGroups/ContosoOnlineGroup")
            .targetScope("subscription")
            .build());

    }
}
import pulumi
import pulumi_azure_native as azure_native

blueprint = azure_native.blueprint.Blueprint("blueprint",
    blueprint_name="simpleBlueprint",
    description="blueprint contains all artifact kinds {'template', 'rbac', 'policy'}",
    parameters={
        "costCenter": azure_native.blueprint.ParameterDefinitionArgs(
            display_name="force cost center tag for all resources under given subscription.",
            type="string",
        ),
        "owners": azure_native.blueprint.ParameterDefinitionArgs(
            display_name="assign owners to subscription along with blueprint assignment.",
            type="array",
        ),
        "storageAccountType": azure_native.blueprint.ParameterDefinitionArgs(
            display_name="storage account type.",
            type="string",
        ),
    },
    resource_groups={
        "storageRG": azure_native.blueprint.ResourceGroupDefinitionArgs(
            description="Contains storageAccounts that collect all shoebox logs.",
            display_name="storage resource group",
        ),
    },
    resource_scope="providers/Microsoft.Management/managementGroups/ContosoOnlineGroup",
    target_scope="subscription")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const blueprint = new azure_native.blueprint.Blueprint("blueprint", {
    blueprintName: "simpleBlueprint",
    description: "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}",
    parameters: {
        costCenter: {
            displayName: "force cost center tag for all resources under given subscription.",
            type: "string",
        },
        owners: {
            displayName: "assign owners to subscription along with blueprint assignment.",
            type: "array",
        },
        storageAccountType: {
            displayName: "storage account type.",
            type: "string",
        },
    },
    resourceGroups: {
        storageRG: {
            description: "Contains storageAccounts that collect all shoebox logs.",
            displayName: "storage resource group",
        },
    },
    resourceScope: "providers/Microsoft.Management/managementGroups/ContosoOnlineGroup",
    targetScope: "subscription",
});
resources:
  blueprint:
    type: azure-native:blueprint:Blueprint
    properties:
      blueprintName: simpleBlueprint
      description: blueprint contains all artifact kinds {'template', 'rbac', 'policy'}
      parameters:
        costCenter:
          displayName: force cost center tag for all resources under given subscription.
          type: string
        owners:
          displayName: assign owners to subscription along with blueprint assignment.
          type: array
        storageAccountType:
          displayName: storage account type.
          type: string
      resourceGroups:
        storageRG:
          description: Contains storageAccounts that collect all shoebox logs.
          displayName: storage resource group
      resourceScope: providers/Microsoft.Management/managementGroups/ContosoOnlineGroup
      targetScope: subscription

ResourceGroupWithTags

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var blueprint = new AzureNative.Blueprint.Blueprint("blueprint", new()
    {
        BlueprintName = "simpleBlueprint",
        Description = "An example blueprint containing an RG with two tags.",
        ResourceGroups = 
        {
            { "myRGName", new AzureNative.Blueprint.Inputs.ResourceGroupDefinitionArgs
            {
                DisplayName = "My Resource Group",
                Location = "westus",
                Name = "myRGName",
                Tags = 
                {
                    { "costcenter", "123456" },
                    { "nameOnlyTag", "" },
                },
            } },
        },
        ResourceScope = "providers/Microsoft.Management/managementGroups/{ManagementGroupId}",
        TargetScope = "subscription",
    });

});
package main

import (
	blueprint "github.com/pulumi/pulumi-azure-native/sdk/go/azure/blueprint"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := blueprint.NewBlueprint(ctx, "blueprint", &blueprint.BlueprintArgs{
			BlueprintName: pulumi.String("simpleBlueprint"),
			Description:   pulumi.String("An example blueprint containing an RG with two tags."),
			ResourceGroups: blueprint.ResourceGroupDefinitionMap{
				"myRGName": &blueprint.ResourceGroupDefinitionArgs{
					DisplayName: pulumi.String("My Resource Group"),
					Location:    pulumi.String("westus"),
					Name:        pulumi.String("myRGName"),
					Tags: pulumi.StringMap{
						"costcenter":  pulumi.String("123456"),
						"nameOnlyTag": pulumi.String(""),
					},
				},
			},
			ResourceScope: pulumi.String("providers/Microsoft.Management/managementGroups/{ManagementGroupId}"),
			TargetScope:   pulumi.String("subscription"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.blueprint.Blueprint;
import com.pulumi.azurenative.blueprint.BlueprintArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var blueprint = new Blueprint("blueprint", BlueprintArgs.builder()        
            .blueprintName("simpleBlueprint")
            .description("An example blueprint containing an RG with two tags.")
            .resourceGroups(Map.of("myRGName", Map.ofEntries(
                Map.entry("displayName", "My Resource Group"),
                Map.entry("location", "westus"),
                Map.entry("name", "myRGName"),
                Map.entry("tags", Map.ofEntries(
                    Map.entry("costcenter", "123456"),
                    Map.entry("nameOnlyTag", "")
                ))
            )))
            .resourceScope("providers/Microsoft.Management/managementGroups/{ManagementGroupId}")
            .targetScope("subscription")
            .build());

    }
}
import pulumi
import pulumi_azure_native as azure_native

blueprint = azure_native.blueprint.Blueprint("blueprint",
    blueprint_name="simpleBlueprint",
    description="An example blueprint containing an RG with two tags.",
    resource_groups={
        "myRGName": azure_native.blueprint.ResourceGroupDefinitionArgs(
            display_name="My Resource Group",
            location="westus",
            name="myRGName",
            tags={
                "costcenter": "123456",
                "nameOnlyTag": "",
            },
        ),
    },
    resource_scope="providers/Microsoft.Management/managementGroups/{ManagementGroupId}",
    target_scope="subscription")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const blueprint = new azure_native.blueprint.Blueprint("blueprint", {
    blueprintName: "simpleBlueprint",
    description: "An example blueprint containing an RG with two tags.",
    resourceGroups: {
        myRGName: {
            displayName: "My Resource Group",
            location: "westus",
            name: "myRGName",
            tags: {
                costcenter: "123456",
                nameOnlyTag: "",
            },
        },
    },
    resourceScope: "providers/Microsoft.Management/managementGroups/{ManagementGroupId}",
    targetScope: "subscription",
});
resources:
  blueprint:
    type: azure-native:blueprint:Blueprint
    properties:
      blueprintName: simpleBlueprint
      description: An example blueprint containing an RG with two tags.
      resourceGroups:
        myRGName:
          displayName: My Resource Group
          location: westus
          name: myRGName
          tags:
            costcenter: '123456'
            nameOnlyTag:
      resourceScope: providers/Microsoft.Management/managementGroups/{ManagementGroupId}
      targetScope: subscription

SubscriptionBlueprint

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var blueprint = new AzureNative.Blueprint.Blueprint("blueprint", new()
    {
        BlueprintName = "simpleBlueprint",
        Description = "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}",
        Parameters = 
        {
            { "costCenter", new AzureNative.Blueprint.Inputs.ParameterDefinitionArgs
            {
                DisplayName = "force cost center tag for all resources under given subscription.",
                Type = "string",
            } },
            { "owners", new AzureNative.Blueprint.Inputs.ParameterDefinitionArgs
            {
                DisplayName = "assign owners to subscription along with blueprint assignment.",
                Type = "array",
            } },
            { "storageAccountType", new AzureNative.Blueprint.Inputs.ParameterDefinitionArgs
            {
                DisplayName = "storage account type.",
                Type = "string",
            } },
        },
        ResourceGroups = 
        {
            { "storageRG", new AzureNative.Blueprint.Inputs.ResourceGroupDefinitionArgs
            {
                Description = "Contains storageAccounts that collect all shoebox logs.",
                DisplayName = "storage resource group",
            } },
        },
        ResourceScope = "subscriptions/00000000-0000-0000-0000-000000000000",
        TargetScope = "subscription",
    });

});
package main

import (
	blueprint "github.com/pulumi/pulumi-azure-native/sdk/go/azure/blueprint"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := blueprint.NewBlueprint(ctx, "blueprint", &blueprint.BlueprintArgs{
			BlueprintName: pulumi.String("simpleBlueprint"),
			Description:   pulumi.String("blueprint contains all artifact kinds {'template', 'rbac', 'policy'}"),
			Parameters: blueprint.ParameterDefinitionMap{
				"costCenter": &blueprint.ParameterDefinitionArgs{
					DisplayName: pulumi.String("force cost center tag for all resources under given subscription."),
					Type:        pulumi.String("string"),
				},
				"owners": &blueprint.ParameterDefinitionArgs{
					DisplayName: pulumi.String("assign owners to subscription along with blueprint assignment."),
					Type:        pulumi.String("array"),
				},
				"storageAccountType": &blueprint.ParameterDefinitionArgs{
					DisplayName: pulumi.String("storage account type."),
					Type:        pulumi.String("string"),
				},
			},
			ResourceGroups: blueprint.ResourceGroupDefinitionMap{
				"storageRG": &blueprint.ResourceGroupDefinitionArgs{
					Description: pulumi.String("Contains storageAccounts that collect all shoebox logs."),
					DisplayName: pulumi.String("storage resource group"),
				},
			},
			ResourceScope: pulumi.String("subscriptions/00000000-0000-0000-0000-000000000000"),
			TargetScope:   pulumi.String("subscription"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.blueprint.Blueprint;
import com.pulumi.azurenative.blueprint.BlueprintArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var blueprint = new Blueprint("blueprint", BlueprintArgs.builder()        
            .blueprintName("simpleBlueprint")
            .description("blueprint contains all artifact kinds {'template', 'rbac', 'policy'}")
            .parameters(Map.ofEntries(
                Map.entry("costCenter", Map.ofEntries(
                    Map.entry("displayName", "force cost center tag for all resources under given subscription."),
                    Map.entry("type", "string")
                )),
                Map.entry("owners", Map.ofEntries(
                    Map.entry("displayName", "assign owners to subscription along with blueprint assignment."),
                    Map.entry("type", "array")
                )),
                Map.entry("storageAccountType", Map.ofEntries(
                    Map.entry("displayName", "storage account type."),
                    Map.entry("type", "string")
                ))
            ))
            .resourceGroups(Map.of("storageRG", Map.ofEntries(
                Map.entry("description", "Contains storageAccounts that collect all shoebox logs."),
                Map.entry("displayName", "storage resource group")
            )))
            .resourceScope("subscriptions/00000000-0000-0000-0000-000000000000")
            .targetScope("subscription")
            .build());

    }
}
import pulumi
import pulumi_azure_native as azure_native

blueprint = azure_native.blueprint.Blueprint("blueprint",
    blueprint_name="simpleBlueprint",
    description="blueprint contains all artifact kinds {'template', 'rbac', 'policy'}",
    parameters={
        "costCenter": azure_native.blueprint.ParameterDefinitionArgs(
            display_name="force cost center tag for all resources under given subscription.",
            type="string",
        ),
        "owners": azure_native.blueprint.ParameterDefinitionArgs(
            display_name="assign owners to subscription along with blueprint assignment.",
            type="array",
        ),
        "storageAccountType": azure_native.blueprint.ParameterDefinitionArgs(
            display_name="storage account type.",
            type="string",
        ),
    },
    resource_groups={
        "storageRG": azure_native.blueprint.ResourceGroupDefinitionArgs(
            description="Contains storageAccounts that collect all shoebox logs.",
            display_name="storage resource group",
        ),
    },
    resource_scope="subscriptions/00000000-0000-0000-0000-000000000000",
    target_scope="subscription")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const blueprint = new azure_native.blueprint.Blueprint("blueprint", {
    blueprintName: "simpleBlueprint",
    description: "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}",
    parameters: {
        costCenter: {
            displayName: "force cost center tag for all resources under given subscription.",
            type: "string",
        },
        owners: {
            displayName: "assign owners to subscription along with blueprint assignment.",
            type: "array",
        },
        storageAccountType: {
            displayName: "storage account type.",
            type: "string",
        },
    },
    resourceGroups: {
        storageRG: {
            description: "Contains storageAccounts that collect all shoebox logs.",
            displayName: "storage resource group",
        },
    },
    resourceScope: "subscriptions/00000000-0000-0000-0000-000000000000",
    targetScope: "subscription",
});
resources:
  blueprint:
    type: azure-native:blueprint:Blueprint
    properties:
      blueprintName: simpleBlueprint
      description: blueprint contains all artifact kinds {'template', 'rbac', 'policy'}
      parameters:
        costCenter:
          displayName: force cost center tag for all resources under given subscription.
          type: string
        owners:
          displayName: assign owners to subscription along with blueprint assignment.
          type: array
        storageAccountType:
          displayName: storage account type.
          type: string
      resourceGroups:
        storageRG:
          description: Contains storageAccounts that collect all shoebox logs.
          displayName: storage resource group
      resourceScope: subscriptions/00000000-0000-0000-0000-000000000000
      targetScope: subscription

Create Blueprint Resource

new Blueprint(name: string, args: BlueprintArgs, opts?: CustomResourceOptions);
@overload
def Blueprint(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              blueprint_name: Optional[str] = None,
              description: Optional[str] = None,
              display_name: Optional[str] = None,
              parameters: Optional[Mapping[str, ParameterDefinitionArgs]] = None,
              resource_groups: Optional[Mapping[str, ResourceGroupDefinitionArgs]] = None,
              resource_scope: Optional[str] = None,
              target_scope: Optional[Union[str, BlueprintTargetScope]] = None,
              versions: Optional[Any] = None)
@overload
def Blueprint(resource_name: str,
              args: BlueprintArgs,
              opts: Optional[ResourceOptions] = None)
func NewBlueprint(ctx *Context, name string, args BlueprintArgs, opts ...ResourceOption) (*Blueprint, error)
public Blueprint(string name, BlueprintArgs args, CustomResourceOptions? opts = null)
public Blueprint(String name, BlueprintArgs args)
public Blueprint(String name, BlueprintArgs args, CustomResourceOptions options)
type: azure-native:blueprint:Blueprint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args BlueprintArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args BlueprintArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args BlueprintArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BlueprintArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args BlueprintArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Blueprint Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Blueprint resource accepts the following input properties:

ResourceScope string

The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').

TargetScope string | Pulumi.AzureNative.Blueprint.BlueprintTargetScope

The scope where this blueprint definition can be assigned.

BlueprintName string

Name of the blueprint definition.

Description string

Multi-line explain this resource.

DisplayName string

One-liner string explain this resource.

Parameters Dictionary<string, Pulumi.AzureNative.Blueprint.Inputs.ParameterDefinitionArgs>

Parameters required by this blueprint definition.

ResourceGroups Dictionary<string, Pulumi.AzureNative.Blueprint.Inputs.ResourceGroupDefinitionArgs>

Resource group placeholders defined by this blueprint definition.

Versions object

Published versions of this blueprint definition.

ResourceScope string

The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').

TargetScope string | BlueprintTargetScope

The scope where this blueprint definition can be assigned.

BlueprintName string

Name of the blueprint definition.

Description string

Multi-line explain this resource.

DisplayName string

One-liner string explain this resource.

Parameters map[string]ParameterDefinitionArgs

Parameters required by this blueprint definition.

ResourceGroups map[string]ResourceGroupDefinitionArgs

Resource group placeholders defined by this blueprint definition.

Versions interface{}

Published versions of this blueprint definition.

resourceScope String

The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').

targetScope String | BlueprintTargetScope

The scope where this blueprint definition can be assigned.

blueprintName String

Name of the blueprint definition.

description String

Multi-line explain this resource.

displayName String

One-liner string explain this resource.

parameters Map<String,ParameterDefinitionArgs>

Parameters required by this blueprint definition.

resourceGroups Map<String,ResourceGroupDefinitionArgs>

Resource group placeholders defined by this blueprint definition.

versions Object

Published versions of this blueprint definition.

resourceScope string

The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').

targetScope string | BlueprintTargetScope

The scope where this blueprint definition can be assigned.

blueprintName string

Name of the blueprint definition.

description string

Multi-line explain this resource.

displayName string

One-liner string explain this resource.

parameters {[key: string]: ParameterDefinitionArgs}

Parameters required by this blueprint definition.

resourceGroups {[key: string]: ResourceGroupDefinitionArgs}

Resource group placeholders defined by this blueprint definition.

versions any

Published versions of this blueprint definition.

resource_scope str

The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').

target_scope str | BlueprintTargetScope

The scope where this blueprint definition can be assigned.

blueprint_name str

Name of the blueprint definition.

description str

Multi-line explain this resource.

display_name str

One-liner string explain this resource.

parameters Mapping[str, ParameterDefinitionArgs]

Parameters required by this blueprint definition.

resource_groups Mapping[str, ResourceGroupDefinitionArgs]

Resource group placeholders defined by this blueprint definition.

versions Any

Published versions of this blueprint definition.

resourceScope String

The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').

targetScope String | "subscription" | "managementGroup"

The scope where this blueprint definition can be assigned.

blueprintName String

Name of the blueprint definition.

description String

Multi-line explain this resource.

displayName String

One-liner string explain this resource.

parameters Map<Property Map>

Parameters required by this blueprint definition.

resourceGroups Map<Property Map>

Resource group placeholders defined by this blueprint definition.

versions Any

Published versions of this blueprint definition.

Outputs

All input properties are implicitly available as output properties. Additionally, the Blueprint resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Layout object

Layout view of the blueprint definition for UI reference.

Name string

Name of this resource.

Status Pulumi.AzureNative.Blueprint.Outputs.BlueprintStatusResponse

Status of the blueprint. This field is readonly.

Type string

Type of this resource.

Id string

The provider-assigned unique ID for this managed resource.

Layout interface{}

Layout view of the blueprint definition for UI reference.

Name string

Name of this resource.

Status BlueprintStatusResponse

Status of the blueprint. This field is readonly.

Type string

Type of this resource.

id String

The provider-assigned unique ID for this managed resource.

layout Object

Layout view of the blueprint definition for UI reference.

name String

Name of this resource.

status BlueprintStatusResponse

Status of the blueprint. This field is readonly.

type String

Type of this resource.

id string

The provider-assigned unique ID for this managed resource.

layout any

Layout view of the blueprint definition for UI reference.

name string

Name of this resource.

status BlueprintStatusResponse

Status of the blueprint. This field is readonly.

type string

Type of this resource.

id str

The provider-assigned unique ID for this managed resource.

layout Any

Layout view of the blueprint definition for UI reference.

name str

Name of this resource.

status BlueprintStatusResponse

Status of the blueprint. This field is readonly.

type str

Type of this resource.

id String

The provider-assigned unique ID for this managed resource.

layout Any

Layout view of the blueprint definition for UI reference.

name String

Name of this resource.

status Property Map

Status of the blueprint. This field is readonly.

type String

Type of this resource.

Supporting Types

BlueprintStatusResponse

LastModified string

Last modified time of this blueprint definition.

TimeCreated string

Creation time of this blueprint definition.

LastModified string

Last modified time of this blueprint definition.

TimeCreated string

Creation time of this blueprint definition.

lastModified String

Last modified time of this blueprint definition.

timeCreated String

Creation time of this blueprint definition.

lastModified string

Last modified time of this blueprint definition.

timeCreated string

Creation time of this blueprint definition.

last_modified str

Last modified time of this blueprint definition.

time_created str

Creation time of this blueprint definition.

lastModified String

Last modified time of this blueprint definition.

timeCreated String

Creation time of this blueprint definition.

BlueprintTargetScope

Subscription
subscription

The blueprint targets a subscription during blueprint assignment.

ManagementGroup
managementGroup

The blueprint targets a management group during blueprint assignment. This is reserved for future use.

BlueprintTargetScopeSubscription
subscription

The blueprint targets a subscription during blueprint assignment.

BlueprintTargetScopeManagementGroup
managementGroup

The blueprint targets a management group during blueprint assignment. This is reserved for future use.

Subscription
subscription

The blueprint targets a subscription during blueprint assignment.

ManagementGroup
managementGroup

The blueprint targets a management group during blueprint assignment. This is reserved for future use.

Subscription
subscription

The blueprint targets a subscription during blueprint assignment.

ManagementGroup
managementGroup

The blueprint targets a management group during blueprint assignment. This is reserved for future use.

SUBSCRIPTION
subscription

The blueprint targets a subscription during blueprint assignment.

MANAGEMENT_GROUP
managementGroup

The blueprint targets a management group during blueprint assignment. This is reserved for future use.

"subscription"
subscription

The blueprint targets a subscription during blueprint assignment.

"managementGroup"
managementGroup

The blueprint targets a management group during blueprint assignment. This is reserved for future use.

ParameterDefinition

Type string | Pulumi.AzureNative.Blueprint.TemplateParameterType

Allowed data types for Resource Manager template parameters.

AllowedValues List<object>

Array of allowed values for this parameter.

DefaultValue object

Default Value for this parameter.

Description string

Description of this parameter/resourceGroup.

DisplayName string

DisplayName of this parameter/resourceGroup.

StrongType string

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

Type string | TemplateParameterType

Allowed data types for Resource Manager template parameters.

AllowedValues []interface{}

Array of allowed values for this parameter.

DefaultValue interface{}

Default Value for this parameter.

Description string

Description of this parameter/resourceGroup.

DisplayName string

DisplayName of this parameter/resourceGroup.

StrongType string

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

type String | TemplateParameterType

Allowed data types for Resource Manager template parameters.

allowedValues List<Object>

Array of allowed values for this parameter.

defaultValue Object

Default Value for this parameter.

description String

Description of this parameter/resourceGroup.

displayName String

DisplayName of this parameter/resourceGroup.

strongType String

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

type string | TemplateParameterType

Allowed data types for Resource Manager template parameters.

allowedValues any[]

Array of allowed values for this parameter.

defaultValue any

Default Value for this parameter.

description string

Description of this parameter/resourceGroup.

displayName string

DisplayName of this parameter/resourceGroup.

strongType string

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

type str | TemplateParameterType

Allowed data types for Resource Manager template parameters.

allowed_values Sequence[Any]

Array of allowed values for this parameter.

default_value Any

Default Value for this parameter.

description str

Description of this parameter/resourceGroup.

display_name str

DisplayName of this parameter/resourceGroup.

strong_type str

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

type String | "string" | "array" | "bool" | "int" | "object" | "secureObject" | "secureString"

Allowed data types for Resource Manager template parameters.

allowedValues List<Any>

Array of allowed values for this parameter.

defaultValue Any

Default Value for this parameter.

description String

Description of this parameter/resourceGroup.

displayName String

DisplayName of this parameter/resourceGroup.

strongType String

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

ParameterDefinitionResponse

Type string

Allowed data types for Resource Manager template parameters.

AllowedValues List<object>

Array of allowed values for this parameter.

DefaultValue object

Default Value for this parameter.

Description string

Description of this parameter/resourceGroup.

DisplayName string

DisplayName of this parameter/resourceGroup.

StrongType string

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

Type string

Allowed data types for Resource Manager template parameters.

AllowedValues []interface{}

Array of allowed values for this parameter.

DefaultValue interface{}

Default Value for this parameter.

Description string

Description of this parameter/resourceGroup.

DisplayName string

DisplayName of this parameter/resourceGroup.

StrongType string

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

type String

Allowed data types for Resource Manager template parameters.

allowedValues List<Object>

Array of allowed values for this parameter.

defaultValue Object

Default Value for this parameter.

description String

Description of this parameter/resourceGroup.

displayName String

DisplayName of this parameter/resourceGroup.

strongType String

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

type string

Allowed data types for Resource Manager template parameters.

allowedValues any[]

Array of allowed values for this parameter.

defaultValue any

Default Value for this parameter.

description string

Description of this parameter/resourceGroup.

displayName string

DisplayName of this parameter/resourceGroup.

strongType string

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

type str

Allowed data types for Resource Manager template parameters.

allowed_values Sequence[Any]

Array of allowed values for this parameter.

default_value Any

Default Value for this parameter.

description str

Description of this parameter/resourceGroup.

display_name str

DisplayName of this parameter/resourceGroup.

strong_type str

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

type String

Allowed data types for Resource Manager template parameters.

allowedValues List<Any>

Array of allowed values for this parameter.

defaultValue Any

Default Value for this parameter.

description String

Description of this parameter/resourceGroup.

displayName String

DisplayName of this parameter/resourceGroup.

strongType String

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

ResourceGroupDefinition

DependsOn List<string>

Artifacts which need to be deployed before this resource group.

Description string

Description of this parameter/resourceGroup.

DisplayName string

DisplayName of this parameter/resourceGroup.

Location string

Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.

Name string

Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.

StrongType string

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

Tags Dictionary<string, string>

Tags to be assigned to this resource group.

DependsOn []string

Artifacts which need to be deployed before this resource group.

Description string

Description of this parameter/resourceGroup.

DisplayName string

DisplayName of this parameter/resourceGroup.

Location string

Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.

Name string

Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.

StrongType string

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

Tags map[string]string

Tags to be assigned to this resource group.

dependsOn List<String>

Artifacts which need to be deployed before this resource group.

description String

Description of this parameter/resourceGroup.

displayName String

DisplayName of this parameter/resourceGroup.

location String

Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.

name String

Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.

strongType String

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

tags Map<String,String>

Tags to be assigned to this resource group.

dependsOn string[]

Artifacts which need to be deployed before this resource group.

description string

Description of this parameter/resourceGroup.

displayName string

DisplayName of this parameter/resourceGroup.

location string

Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.

name string

Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.

strongType string

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

tags {[key: string]: string}

Tags to be assigned to this resource group.

depends_on Sequence[str]

Artifacts which need to be deployed before this resource group.

description str

Description of this parameter/resourceGroup.

display_name str

DisplayName of this parameter/resourceGroup.

location str

Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.

name str

Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.

strong_type str

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

tags Mapping[str, str]

Tags to be assigned to this resource group.

dependsOn List<String>

Artifacts which need to be deployed before this resource group.

description String

Description of this parameter/resourceGroup.

displayName String

DisplayName of this parameter/resourceGroup.

location String

Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.

name String

Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.

strongType String

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

tags Map<String>

Tags to be assigned to this resource group.

ResourceGroupDefinitionResponse

DependsOn List<string>

Artifacts which need to be deployed before this resource group.

Description string

Description of this parameter/resourceGroup.

DisplayName string

DisplayName of this parameter/resourceGroup.

Location string

Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.

Name string

Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.

StrongType string

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

Tags Dictionary<string, string>

Tags to be assigned to this resource group.

DependsOn []string

Artifacts which need to be deployed before this resource group.

Description string

Description of this parameter/resourceGroup.

DisplayName string

DisplayName of this parameter/resourceGroup.

Location string

Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.

Name string

Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.

StrongType string

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

Tags map[string]string

Tags to be assigned to this resource group.

dependsOn List<String>

Artifacts which need to be deployed before this resource group.

description String

Description of this parameter/resourceGroup.

displayName String

DisplayName of this parameter/resourceGroup.

location String

Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.

name String

Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.

strongType String

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

tags Map<String,String>

Tags to be assigned to this resource group.

dependsOn string[]

Artifacts which need to be deployed before this resource group.

description string

Description of this parameter/resourceGroup.

displayName string

DisplayName of this parameter/resourceGroup.

location string

Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.

name string

Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.

strongType string

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

tags {[key: string]: string}

Tags to be assigned to this resource group.

depends_on Sequence[str]

Artifacts which need to be deployed before this resource group.

description str

Description of this parameter/resourceGroup.

display_name str

DisplayName of this parameter/resourceGroup.

location str

Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.

name str

Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.

strong_type str

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

tags Mapping[str, str]

Tags to be assigned to this resource group.

dependsOn List<String>

Artifacts which need to be deployed before this resource group.

description String

Description of this parameter/resourceGroup.

displayName String

DisplayName of this parameter/resourceGroup.

location String

Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.

name String

Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.

strongType String

StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.

tags Map<String>

Tags to be assigned to this resource group.

TemplateParameterType

@String
string
Array
array
@Bool
bool
@Int
int
@Object
object
SecureObject
secureObject
SecureString
secureString
TemplateParameterTypeString
string
TemplateParameterTypeArray
array
TemplateParameterTypeBool
bool
TemplateParameterTypeInt
int
TemplateParameterTypeObject
object
TemplateParameterTypeSecureObject
secureObject
TemplateParameterTypeSecureString
secureString
String
string
Array
array
Bool
bool
Int_
int
Object
object
SecureObject
secureObject
SecureString
secureString
String
string
Array
array
Bool
bool
Int
int
Object
object
SecureObject
secureObject
SecureString
secureString
STRING
string
ARRAY
array
BOOL
bool
INT
int
OBJECT
object
SECURE_OBJECT
secureObject
SECURE_STRING
secureString
"string"
string
"array"
array
"bool"
bool
"int"
int
"object"
object
"secureObject"
secureObject
"secureString"
secureString

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:blueprint:Blueprint simpleBlueprint /subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint 

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0