azure-native.blueprint.Blueprint
Explore with Pulumi AI
Represents a Blueprint definition. Azure REST API version: 2018-11-01-preview. Prior API version in Azure Native 1.x: 2018-11-01-preview.
Other available API versions: 2017-11-11-preview.
Example Usage
ManagementGroupBlueprint
using System.Collections.Generic;
using System.Linq;
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 = AzureNative.Blueprint.TemplateParameterType.@String,
} },
{ "owners", new AzureNative.Blueprint.Inputs.ParameterDefinitionArgs
{
DisplayName = "assign owners to subscription along with blueprint assignment.",
Type = AzureNative.Blueprint.TemplateParameterType.Array,
} },
{ "storageAccountType", new AzureNative.Blueprint.Inputs.ParameterDefinitionArgs
{
DisplayName = "storage account type.",
Type = AzureNative.Blueprint.TemplateParameterType.@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 = AzureNative.Blueprint.BlueprintTargetScope.Subscription,
});
});
package main
import (
blueprint "github.com/pulumi/pulumi-azure-native-sdk/blueprint/v2"
"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(blueprint.TemplateParameterTypeString),
},
"owners": &blueprint.ParameterDefinitionArgs{
DisplayName: pulumi.String("assign owners to subscription along with blueprint assignment."),
Type: pulumi.String(blueprint.TemplateParameterTypeArray),
},
"storageAccountType": &blueprint.ParameterDefinitionArgs{
DisplayName: pulumi.String("storage account type."),
Type: pulumi.String(blueprint.TemplateParameterTypeString),
},
},
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(blueprint.BlueprintTargetScopeSubscription),
})
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": {
"display_name": "force cost center tag for all resources under given subscription.",
"type": azure_native.blueprint.TemplateParameterType.STRING,
},
"owners": {
"display_name": "assign owners to subscription along with blueprint assignment.",
"type": azure_native.blueprint.TemplateParameterType.ARRAY,
},
"storageAccountType": {
"display_name": "storage account type.",
"type": azure_native.blueprint.TemplateParameterType.STRING,
},
},
resource_groups={
"storageRG": {
"description": "Contains storageAccounts that collect all shoebox logs.",
"display_name": "storage resource group",
},
},
resource_scope="providers/Microsoft.Management/managementGroups/ContosoOnlineGroup",
target_scope=azure_native.blueprint.BlueprintTargetScope.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: azure_native.blueprint.TemplateParameterType.String,
},
owners: {
displayName: "assign owners to subscription along with blueprint assignment.",
type: azure_native.blueprint.TemplateParameterType.Array,
},
storageAccountType: {
displayName: "storage account type.",
type: azure_native.blueprint.TemplateParameterType.String,
},
},
resourceGroups: {
storageRG: {
description: "Contains storageAccounts that collect all shoebox logs.",
displayName: "storage resource group",
},
},
resourceScope: "providers/Microsoft.Management/managementGroups/ContosoOnlineGroup",
targetScope: azure_native.blueprint.BlueprintTargetScope.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 System.Linq;
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 = AzureNative.Blueprint.BlueprintTargetScope.Subscription,
});
});
package main
import (
blueprint "github.com/pulumi/pulumi-azure-native-sdk/blueprint/v2"
"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(blueprint.BlueprintTargetScopeSubscription),
})
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": {
"display_name": "My Resource Group",
"location": "westus",
"name": "myRGName",
"tags": {
"costcenter": "123456",
"nameOnlyTag": "",
},
},
},
resource_scope="providers/Microsoft.Management/managementGroups/{ManagementGroupId}",
target_scope=azure_native.blueprint.BlueprintTargetScope.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: azure_native.blueprint.BlueprintTargetScope.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 System.Linq;
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 = AzureNative.Blueprint.TemplateParameterType.@String,
} },
{ "owners", new AzureNative.Blueprint.Inputs.ParameterDefinitionArgs
{
DisplayName = "assign owners to subscription along with blueprint assignment.",
Type = AzureNative.Blueprint.TemplateParameterType.Array,
} },
{ "storageAccountType", new AzureNative.Blueprint.Inputs.ParameterDefinitionArgs
{
DisplayName = "storage account type.",
Type = AzureNative.Blueprint.TemplateParameterType.@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 = AzureNative.Blueprint.BlueprintTargetScope.Subscription,
});
});
package main
import (
blueprint "github.com/pulumi/pulumi-azure-native-sdk/blueprint/v2"
"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(blueprint.TemplateParameterTypeString),
},
"owners": &blueprint.ParameterDefinitionArgs{
DisplayName: pulumi.String("assign owners to subscription along with blueprint assignment."),
Type: pulumi.String(blueprint.TemplateParameterTypeArray),
},
"storageAccountType": &blueprint.ParameterDefinitionArgs{
DisplayName: pulumi.String("storage account type."),
Type: pulumi.String(blueprint.TemplateParameterTypeString),
},
},
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(blueprint.BlueprintTargetScopeSubscription),
})
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": {
"display_name": "force cost center tag for all resources under given subscription.",
"type": azure_native.blueprint.TemplateParameterType.STRING,
},
"owners": {
"display_name": "assign owners to subscription along with blueprint assignment.",
"type": azure_native.blueprint.TemplateParameterType.ARRAY,
},
"storageAccountType": {
"display_name": "storage account type.",
"type": azure_native.blueprint.TemplateParameterType.STRING,
},
},
resource_groups={
"storageRG": {
"description": "Contains storageAccounts that collect all shoebox logs.",
"display_name": "storage resource group",
},
},
resource_scope="subscriptions/00000000-0000-0000-0000-000000000000",
target_scope=azure_native.blueprint.BlueprintTargetScope.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: azure_native.blueprint.TemplateParameterType.String,
},
owners: {
displayName: "assign owners to subscription along with blueprint assignment.",
type: azure_native.blueprint.TemplateParameterType.Array,
},
storageAccountType: {
displayName: "storage account type.",
type: azure_native.blueprint.TemplateParameterType.String,
},
},
resourceGroups: {
storageRG: {
description: "Contains storageAccounts that collect all shoebox logs.",
displayName: "storage resource group",
},
},
resourceScope: "subscriptions/00000000-0000-0000-0000-000000000000",
targetScope: azure_native.blueprint.BlueprintTargetScope.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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Blueprint(name: string, args: BlueprintArgs, opts?: CustomResourceOptions);
@overload
def Blueprint(resource_name: str,
args: BlueprintArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Blueprint(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_scope: Optional[str] = None,
target_scope: Optional[Union[str, BlueprintTargetScope]] = 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,
versions: Optional[Any] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var blueprintResource = new AzureNative.Blueprint.Blueprint("blueprintResource", new()
{
ResourceScope = "string",
TargetScope = "string",
BlueprintName = "string",
Description = "string",
DisplayName = "string",
Parameters =
{
{ "string", new AzureNative.Blueprint.Inputs.ParameterDefinitionArgs
{
Type = AzureNative.Blueprint.TemplateParameterType.@String,
AllowedValues = new[]
{
"any",
},
DefaultValue = "any",
Description = "string",
DisplayName = "string",
StrongType = "string",
} },
},
ResourceGroups =
{
{ "string", new AzureNative.Blueprint.Inputs.ResourceGroupDefinitionArgs
{
DependsOn = new[]
{
"string",
},
Description = "string",
DisplayName = "string",
Location = "string",
Name = "string",
StrongType = "string",
Tags =
{
{ "string", "string" },
},
} },
},
Versions = "any",
});
example, err := blueprint.NewBlueprint(ctx, "blueprintResource", &blueprint.BlueprintArgs{
ResourceScope: pulumi.String("string"),
TargetScope: pulumi.String("string"),
BlueprintName: pulumi.String("string"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
Parameters: blueprint.ParameterDefinitionMap{
"string": &blueprint.ParameterDefinitionArgs{
Type: pulumi.String(blueprint.TemplateParameterTypeString),
AllowedValues: pulumi.Array{
pulumi.Any("any"),
},
DefaultValue: pulumi.Any("any"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
StrongType: pulumi.String("string"),
},
},
ResourceGroups: blueprint.ResourceGroupDefinitionMap{
"string": &blueprint.ResourceGroupDefinitionArgs{
DependsOn: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
Location: pulumi.String("string"),
Name: pulumi.String("string"),
StrongType: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
},
Versions: pulumi.Any("any"),
})
var blueprintResource = new Blueprint("blueprintResource", BlueprintArgs.builder()
.resourceScope("string")
.targetScope("string")
.blueprintName("string")
.description("string")
.displayName("string")
.parameters(Map.of("string", Map.ofEntries(
Map.entry("type", "string"),
Map.entry("allowedValues", "any"),
Map.entry("defaultValue", "any"),
Map.entry("description", "string"),
Map.entry("displayName", "string"),
Map.entry("strongType", "string")
)))
.resourceGroups(Map.of("string", Map.ofEntries(
Map.entry("dependsOn", "string"),
Map.entry("description", "string"),
Map.entry("displayName", "string"),
Map.entry("location", "string"),
Map.entry("name", "string"),
Map.entry("strongType", "string"),
Map.entry("tags", Map.of("string", "string"))
)))
.versions("any")
.build());
blueprint_resource = azure_native.blueprint.Blueprint("blueprintResource",
resource_scope="string",
target_scope="string",
blueprint_name="string",
description="string",
display_name="string",
parameters={
"string": {
"type": azure_native.blueprint.TemplateParameterType.STRING,
"allowed_values": ["any"],
"default_value": "any",
"description": "string",
"display_name": "string",
"strong_type": "string",
},
},
resource_groups={
"string": {
"depends_on": ["string"],
"description": "string",
"display_name": "string",
"location": "string",
"name": "string",
"strong_type": "string",
"tags": {
"string": "string",
},
},
},
versions="any")
const blueprintResource = new azure_native.blueprint.Blueprint("blueprintResource", {
resourceScope: "string",
targetScope: "string",
blueprintName: "string",
description: "string",
displayName: "string",
parameters: {
string: {
type: azure_native.blueprint.TemplateParameterType.String,
allowedValues: ["any"],
defaultValue: "any",
description: "string",
displayName: "string",
strongType: "string",
},
},
resourceGroups: {
string: {
dependsOn: ["string"],
description: "string",
displayName: "string",
location: "string",
name: "string",
strongType: "string",
tags: {
string: "string",
},
},
},
versions: "any",
});
type: azure-native:blueprint:Blueprint
properties:
blueprintName: string
description: string
displayName: string
parameters:
string:
allowedValues:
- any
defaultValue: any
description: string
displayName: string
strongType: string
type: string
resourceGroups:
string:
dependsOn:
- string
description: string
displayName: string
location: string
name: string
strongType: string
tags:
string: string
resourceScope: string
targetScope: string
versions: any
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Blueprint resource accepts the following input properties:
- Resource
Scope string - The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
- Target
Scope string | Pulumi.Azure Native. Blueprint. Blueprint Target Scope - The scope where this blueprint definition can be assigned.
- Blueprint
Name string - Name of the blueprint definition.
- Description string
- Multi-line explain this resource.
- Display
Name string - One-liner string explain this resource.
- Parameters
Dictionary<string, Pulumi.
Azure Native. Blueprint. Inputs. Parameter Definition Args> - Parameters required by this blueprint definition.
- Resource
Groups Dictionary<string, Pulumi.Azure Native. Blueprint. Inputs. Resource Group Definition Args> - Resource group placeholders defined by this blueprint definition.
- Versions object
- Published versions of this blueprint definition.
- Resource
Scope string - The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
- Target
Scope string | BlueprintTarget Scope - The scope where this blueprint definition can be assigned.
- Blueprint
Name string - Name of the blueprint definition.
- Description string
- Multi-line explain this resource.
- Display
Name string - One-liner string explain this resource.
- Parameters
map[string]Parameter
Definition Args - Parameters required by this blueprint definition.
- Resource
Groups map[string]ResourceGroup Definition Args - Resource group placeholders defined by this blueprint definition.
- Versions interface{}
- Published versions of this blueprint definition.
- resource
Scope String - The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
- target
Scope String | BlueprintTarget Scope - The scope where this blueprint definition can be assigned.
- blueprint
Name String - Name of the blueprint definition.
- description String
- Multi-line explain this resource.
- display
Name String - One-liner string explain this resource.
- parameters
Map<String,Parameter
Definition Args> - Parameters required by this blueprint definition.
- resource
Groups Map<String,ResourceGroup Definition Args> - Resource group placeholders defined by this blueprint definition.
- versions Object
- Published versions of this blueprint definition.
- resource
Scope string - The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
- target
Scope string | BlueprintTarget Scope - The scope where this blueprint definition can be assigned.
- blueprint
Name string - Name of the blueprint definition.
- description string
- Multi-line explain this resource.
- display
Name string - One-liner string explain this resource.
- parameters
{[key: string]: Parameter
Definition Args} - Parameters required by this blueprint definition.
- resource
Groups {[key: string]: ResourceGroup Definition Args} - 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 | BlueprintTarget Scope - 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, Parameter
Definition Args] - Parameters required by this blueprint definition.
- resource_
groups Mapping[str, ResourceGroup Definition Args] - Resource group placeholders defined by this blueprint definition.
- versions Any
- Published versions of this blueprint definition.
- resource
Scope String - The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
- target
Scope String | "subscription" | "managementGroup" - The scope where this blueprint definition can be assigned.
- blueprint
Name String - Name of the blueprint definition.
- description String
- Multi-line explain this resource.
- display
Name String - One-liner string explain this resource.
- parameters Map<Property Map>
- Parameters required by this blueprint definition.
- resource
Groups 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.
Azure Native. Blueprint. Outputs. Blueprint Status Response - Status of the blueprint. This field is readonly.
- Type string
- Type of this resource.
Supporting Types
BlueprintStatusResponse, BlueprintStatusResponseArgs
- Last
Modified string - Last modified time of this blueprint definition.
- Time
Created string - Creation time of this blueprint definition.
- Last
Modified string - Last modified time of this blueprint definition.
- Time
Created string - Creation time of this blueprint definition.
- last
Modified String - Last modified time of this blueprint definition.
- time
Created String - Creation time of this blueprint definition.
- last
Modified string - Last modified time of this blueprint definition.
- time
Created 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.
- last
Modified String - Last modified time of this blueprint definition.
- time
Created String - Creation time of this blueprint definition.
BlueprintTargetScope, BlueprintTargetScopeArgs
- Subscription
- subscriptionThe blueprint targets a subscription during blueprint assignment.
- Management
Group - managementGroupThe blueprint targets a management group during blueprint assignment. This is reserved for future use.
- Blueprint
Target Scope Subscription - subscriptionThe blueprint targets a subscription during blueprint assignment.
- Blueprint
Target Scope Management Group - managementGroupThe blueprint targets a management group during blueprint assignment. This is reserved for future use.
- Subscription
- subscriptionThe blueprint targets a subscription during blueprint assignment.
- Management
Group - managementGroupThe blueprint targets a management group during blueprint assignment. This is reserved for future use.
- Subscription
- subscriptionThe blueprint targets a subscription during blueprint assignment.
- Management
Group - managementGroupThe blueprint targets a management group during blueprint assignment. This is reserved for future use.
- SUBSCRIPTION
- subscriptionThe blueprint targets a subscription during blueprint assignment.
- MANAGEMENT_GROUP
- managementGroupThe blueprint targets a management group during blueprint assignment. This is reserved for future use.
- "subscription"
- subscriptionThe blueprint targets a subscription during blueprint assignment.
- "management
Group" - managementGroupThe blueprint targets a management group during blueprint assignment. This is reserved for future use.
ParameterDefinition, ParameterDefinitionArgs
- Type
string | Pulumi.
Azure Native. Blueprint. Template Parameter Type - Allowed data types for Resource Manager template parameters.
- Allowed
Values List<object> - Array of allowed values for this parameter.
- Default
Value object - Default Value for this parameter.
- Description string
- Description of this parameter/resourceGroup.
- Display
Name string - DisplayName of this parameter/resourceGroup.
- Strong
Type string - StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
- Type
string | Template
Parameter Type - Allowed data types for Resource Manager template parameters.
- Allowed
Values []interface{} - Array of allowed values for this parameter.
- Default
Value interface{} - Default Value for this parameter.
- Description string
- Description of this parameter/resourceGroup.
- Display
Name string - DisplayName of this parameter/resourceGroup.
- Strong
Type string - StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
- type
String | Template
Parameter Type - Allowed data types for Resource Manager template parameters.
- allowed
Values List<Object> - Array of allowed values for this parameter.
- default
Value Object - Default Value for this parameter.
- description String
- Description of this parameter/resourceGroup.
- display
Name String - DisplayName of this parameter/resourceGroup.
- strong
Type String - StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
- type
string | Template
Parameter Type - Allowed data types for Resource Manager template parameters.
- allowed
Values any[] - Array of allowed values for this parameter.
- default
Value any - Default Value for this parameter.
- description string
- Description of this parameter/resourceGroup.
- display
Name string - DisplayName of this parameter/resourceGroup.
- strong
Type string - StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
- type
str | Template
Parameter Type - 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" | "secure
Object" | "secure String" - Allowed data types for Resource Manager template parameters.
- allowed
Values List<Any> - Array of allowed values for this parameter.
- default
Value Any - Default Value for this parameter.
- description String
- Description of this parameter/resourceGroup.
- display
Name String - DisplayName of this parameter/resourceGroup.
- strong
Type String - StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
ParameterDefinitionResponse, ParameterDefinitionResponseArgs
- Type string
- Allowed data types for Resource Manager template parameters.
- Allowed
Values List<object> - Array of allowed values for this parameter.
- Default
Value object - Default Value for this parameter.
- Description string
- Description of this parameter/resourceGroup.
- Display
Name string - DisplayName of this parameter/resourceGroup.
- Strong
Type 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.
- Allowed
Values []interface{} - Array of allowed values for this parameter.
- Default
Value interface{} - Default Value for this parameter.
- Description string
- Description of this parameter/resourceGroup.
- Display
Name string - DisplayName of this parameter/resourceGroup.
- Strong
Type 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.
- allowed
Values List<Object> - Array of allowed values for this parameter.
- default
Value Object - Default Value for this parameter.
- description String
- Description of this parameter/resourceGroup.
- display
Name String - DisplayName of this parameter/resourceGroup.
- strong
Type 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.
- allowed
Values any[] - Array of allowed values for this parameter.
- default
Value any - Default Value for this parameter.
- description string
- Description of this parameter/resourceGroup.
- display
Name string - DisplayName of this parameter/resourceGroup.
- strong
Type 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.
- allowed
Values List<Any> - Array of allowed values for this parameter.
- default
Value Any - Default Value for this parameter.
- description String
- Description of this parameter/resourceGroup.
- display
Name String - DisplayName of this parameter/resourceGroup.
- strong
Type String - StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
ResourceGroupDefinition, ResourceGroupDefinitionArgs
- Depends
On List<string> - Artifacts which need to be deployed before this resource group.
- Description string
- Description of this parameter/resourceGroup.
- Display
Name 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.
- Strong
Type string - StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
- Dictionary<string, string>
- Tags to be assigned to this resource group.
- Depends
On []string - Artifacts which need to be deployed before this resource group.
- Description string
- Description of this parameter/resourceGroup.
- Display
Name 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.
- Strong
Type string - StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
- map[string]string
- Tags to be assigned to this resource group.
- depends
On List<String> - Artifacts which need to be deployed before this resource group.
- description String
- Description of this parameter/resourceGroup.
- display
Name 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.
- strong
Type String - StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
- Map<String,String>
- Tags to be assigned to this resource group.
- depends
On string[] - Artifacts which need to be deployed before this resource group.
- description string
- Description of this parameter/resourceGroup.
- display
Name 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.
- strong
Type string - StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
- {[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.
- Mapping[str, str]
- Tags to be assigned to this resource group.
- depends
On List<String> - Artifacts which need to be deployed before this resource group.
- description String
- Description of this parameter/resourceGroup.
- display
Name 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.
- strong
Type String - StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
- Map<String>
- Tags to be assigned to this resource group.
ResourceGroupDefinitionResponse, ResourceGroupDefinitionResponseArgs
- Depends
On List<string> - Artifacts which need to be deployed before this resource group.
- Description string
- Description of this parameter/resourceGroup.
- Display
Name 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.
- Strong
Type string - StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
- Dictionary<string, string>
- Tags to be assigned to this resource group.
- Depends
On []string - Artifacts which need to be deployed before this resource group.
- Description string
- Description of this parameter/resourceGroup.
- Display
Name 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.
- Strong
Type string - StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
- map[string]string
- Tags to be assigned to this resource group.
- depends
On List<String> - Artifacts which need to be deployed before this resource group.
- description String
- Description of this parameter/resourceGroup.
- display
Name 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.
- strong
Type String - StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
- Map<String,String>
- Tags to be assigned to this resource group.
- depends
On string[] - Artifacts which need to be deployed before this resource group.
- description string
- Description of this parameter/resourceGroup.
- display
Name 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.
- strong
Type string - StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
- {[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.
- Mapping[str, str]
- Tags to be assigned to this resource group.
- depends
On List<String> - Artifacts which need to be deployed before this resource group.
- description String
- Description of this parameter/resourceGroup.
- display
Name 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.
- strong
Type String - StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
- Map<String>
- Tags to be assigned to this resource group.
TemplateParameterType, TemplateParameterTypeArgs
- @String
- string
- Array
- array
- @Bool
- bool
- @Int
- int
- @Object
- object
- Secure
Object - secureObject
- Secure
String - secureString
- Template
Parameter Type String - string
- Template
Parameter Type Array - array
- Template
Parameter Type Bool - bool
- Template
Parameter Type Int - int
- Template
Parameter Type Object - object
- Template
Parameter Type Secure Object - secureObject
- Template
Parameter Type Secure String - 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
- Secure
Object - secureObject
- Secure
String - 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
- "secure
Object" - secureObject
- "secure
String" - secureString
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:blueprint:Blueprint simpleBlueprint /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0