pulumi-azure-native-kotlin/com.pulumi.azurenative.blueprint.kotlin/Assignment

Assignment

class Assignment : KotlinCustomResource

Represents a blueprint assignment. 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

Assignment with system-assigned managed identity at management group scope

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var assignment = new AzureNative.Blueprint.Assignment("assignment", new()
    {
        AssignmentName = "assignSimpleBlueprint",
        BlueprintId = "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
        Description = "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
        Identity = new AzureNative.Blueprint.Inputs.ManagedServiceIdentityArgs
        {
            Type = "SystemAssigned",
        },
        Location = "eastus",
        Parameters =
        {
            { "costCenter", new AzureNative.Blueprint.Inputs.ParameterValueArgs
            {
                Value = "Contoso/Online/Shopping/Production",
            } },
            { "owners", new AzureNative.Blueprint.Inputs.ParameterValueArgs
            {
                Value = new[]
                {
                    "johnDoe@contoso.com",
                    "johnsteam@contoso.com",
                },
            } },
            { "storageAccountType", new AzureNative.Blueprint.Inputs.ParameterValueArgs
            {
                Value = "Standard_LRS",
            } },
        },
        ResourceGroups =
        {
            { "storageRG", new AzureNative.Blueprint.Inputs.ResourceGroupValueArgs
            {
                Location = "eastus",
                Name = "defaultRG",
            } },
        },
        ResourceScope = "managementGroups/ContosoOnlineGroup",
        Scope = "subscriptions/00000000-0000-0000-0000-000000000000",
    });
});

package main
import (
	"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.NewAssignment(ctx, "assignment", &blueprint.AssignmentArgs{
			AssignmentName: pulumi.String("assignSimpleBlueprint"),
			BlueprintId:    pulumi.String("/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint"),
			Description:    pulumi.String("enforce pre-defined simpleBlueprint to this XXXXXXXX subscription."),
			Identity: &blueprint.ManagedServiceIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
			Location: pulumi.String("eastus"),
			Parameters: blueprint.ParameterValueMap{
				"costCenter": &blueprint.ParameterValueArgs{
					Value: pulumi.Any("Contoso/Online/Shopping/Production"),
				},
				"owners": &blueprint.ParameterValueArgs{
					Value: pulumi.Any{
						"johnDoe@contoso.com",
						"johnsteam@contoso.com",
					},
				},
				"storageAccountType": &blueprint.ParameterValueArgs{
					Value: pulumi.Any("Standard_LRS"),
				},
			},
			ResourceGroups: blueprint.ResourceGroupValueMap{
				"storageRG": &blueprint.ResourceGroupValueArgs{
					Location: pulumi.String("eastus"),
					Name:     pulumi.String("defaultRG"),
				},
			},
			ResourceScope: pulumi.String("managementGroups/ContosoOnlineGroup"),
			Scope:         pulumi.String("subscriptions/00000000-0000-0000-0000-000000000000"),
		})
		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.Assignment;
import com.pulumi.azurenative.blueprint.AssignmentArgs;
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 assignment = new Assignment("assignment", AssignmentArgs.builder()
            .assignmentName("assignSimpleBlueprint")
            .blueprintId("/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint")
            .description("enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.")
            .identity(Map.of("type", "SystemAssigned"))
            .location("eastus")
            .parameters(Map.ofEntries(
                Map.entry("costCenter", Map.of("value", "Contoso/Online/Shopping/Production")),
                Map.entry("owners", Map.of("value",
                    "johnDoe@contoso.com",
                    "johnsteam@contoso.com")),
                Map.entry("storageAccountType", Map.of("value", "Standard_LRS"))
            ))
            .resourceGroups(Map.of("storageRG", Map.ofEntries(
                Map.entry("location", "eastus"),
                Map.entry("name", "defaultRG")
            )))
            .resourceScope("managementGroups/ContosoOnlineGroup")
            .scope("subscriptions/00000000-0000-0000-0000-000000000000")
            .build());
    }
}

Assignment with system-assigned managed identity at subscription scope

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var assignment = new AzureNative.Blueprint.Assignment("assignment", new()
    {
        AssignmentName = "assignSimpleBlueprint",
        BlueprintId = "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
        Description = "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
        Identity = new AzureNative.Blueprint.Inputs.ManagedServiceIdentityArgs
        {
            Type = "SystemAssigned",
        },
        Location = "eastus",
        Parameters =
        {
            { "costCenter", new AzureNative.Blueprint.Inputs.ParameterValueArgs
            {
                Value = "Contoso/Online/Shopping/Production",
            } },
            { "owners", new AzureNative.Blueprint.Inputs.ParameterValueArgs
            {
                Value = new[]
                {
                    "johnDoe@contoso.com",
                    "johnsteam@contoso.com",
                },
            } },
            { "storageAccountType", new AzureNative.Blueprint.Inputs.ParameterValueArgs
            {
                Value = "Standard_LRS",
            } },
        },
        ResourceGroups =
        {
            { "storageRG", new AzureNative.Blueprint.Inputs.ResourceGroupValueArgs
            {
                Location = "eastus",
                Name = "defaultRG",
            } },
        },
        ResourceScope = "subscriptions/00000000-0000-0000-0000-000000000000",
    });
});

package main
import (
	"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.NewAssignment(ctx, "assignment", &blueprint.AssignmentArgs{
			AssignmentName: pulumi.String("assignSimpleBlueprint"),
			BlueprintId:    pulumi.String("/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint"),
			Description:    pulumi.String("enforce pre-defined simpleBlueprint to this XXXXXXXX subscription."),
			Identity: &blueprint.ManagedServiceIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
			Location: pulumi.String("eastus"),
			Parameters: blueprint.ParameterValueMap{
				"costCenter": &blueprint.ParameterValueArgs{
					Value: pulumi.Any("Contoso/Online/Shopping/Production"),
				},
				"owners": &blueprint.ParameterValueArgs{
					Value: pulumi.Any{
						"johnDoe@contoso.com",
						"johnsteam@contoso.com",
					},
				},
				"storageAccountType": &blueprint.ParameterValueArgs{
					Value: pulumi.Any("Standard_LRS"),
				},
			},
			ResourceGroups: blueprint.ResourceGroupValueMap{
				"storageRG": &blueprint.ResourceGroupValueArgs{
					Location: pulumi.String("eastus"),
					Name:     pulumi.String("defaultRG"),
				},
			},
			ResourceScope: pulumi.String("subscriptions/00000000-0000-0000-0000-000000000000"),
		})
		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.Assignment;
import com.pulumi.azurenative.blueprint.AssignmentArgs;
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 assignment = new Assignment("assignment", AssignmentArgs.builder()
            .assignmentName("assignSimpleBlueprint")
            .blueprintId("/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint")
            .description("enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.")
            .identity(Map.of("type", "SystemAssigned"))
            .location("eastus")
            .parameters(Map.ofEntries(
                Map.entry("costCenter", Map.of("value", "Contoso/Online/Shopping/Production")),
                Map.entry("owners", Map.of("value",
                    "johnDoe@contoso.com",
                    "johnsteam@contoso.com")),
                Map.entry("storageAccountType", Map.of("value", "Standard_LRS"))
            ))
            .resourceGroups(Map.of("storageRG", Map.ofEntries(
                Map.entry("location", "eastus"),
                Map.entry("name", "defaultRG")
            )))
            .resourceScope("subscriptions/00000000-0000-0000-0000-000000000000")
            .build());
    }
}

Assignment with user-assigned managed identity at management group scope

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var assignment = new AzureNative.Blueprint.Assignment("assignment", new()
    {
        AssignmentName = "assignSimpleBlueprint",
        BlueprintId = "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
        Description = "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
        Identity = new AzureNative.Blueprint.Inputs.ManagedServiceIdentityArgs
        {
            Type = "UserAssigned",
            UserAssignedIdentities =
            {
                { "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity", null },
            },
        },
        Location = "eastus",
        Parameters =
        {
            { "costCenter", new AzureNative.Blueprint.Inputs.ParameterValueArgs
            {
                Value = "Contoso/Online/Shopping/Production",
            } },
            { "owners", new AzureNative.Blueprint.Inputs.ParameterValueArgs
            {
                Value = new[]
                {
                    "johnDoe@contoso.com",
                    "johnsteam@contoso.com",
                },
            } },
            { "storageAccountType", new AzureNative.Blueprint.Inputs.ParameterValueArgs
            {
                Value = "Standard_LRS",
            } },
        },
        ResourceGroups =
        {
            { "storageRG", new AzureNative.Blueprint.Inputs.ResourceGroupValueArgs
            {
                Location = "eastus",
                Name = "defaultRG",
            } },
        },
        ResourceScope = "managementGroups/ContosoOnlineGroup",
        Scope = "subscriptions/00000000-0000-0000-0000-000000000000",
    });
});

package main
import (
	"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.NewAssignment(ctx, "assignment", &blueprint.AssignmentArgs{
			AssignmentName: pulumi.String("assignSimpleBlueprint"),
			BlueprintId:    pulumi.String("/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint"),
			Description:    pulumi.String("enforce pre-defined simpleBlueprint to this XXXXXXXX subscription."),
			Identity: blueprint.ManagedServiceIdentityResponse{
				Type: pulumi.String("UserAssigned"),
				UserAssignedIdentities: blueprint.UserAssignedIdentityMap{
					"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": nil,
				},
			},
			Location: pulumi.String("eastus"),
			Parameters: blueprint.ParameterValueMap{
				"costCenter": &blueprint.ParameterValueArgs{
					Value: pulumi.Any("Contoso/Online/Shopping/Production"),
				},
				"owners": &blueprint.ParameterValueArgs{
					Value: pulumi.Any{
						"johnDoe@contoso.com",
						"johnsteam@contoso.com",
					},
				},
				"storageAccountType": &blueprint.ParameterValueArgs{
					Value: pulumi.Any("Standard_LRS"),
				},
			},
			ResourceGroups: blueprint.ResourceGroupValueMap{
				"storageRG": &blueprint.ResourceGroupValueArgs{
					Location: pulumi.String("eastus"),
					Name:     pulumi.String("defaultRG"),
				},
			},
			ResourceScope: pulumi.String("managementGroups/ContosoOnlineGroup"),
			Scope:         pulumi.String("subscriptions/00000000-0000-0000-0000-000000000000"),
		})
		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.Assignment;
import com.pulumi.azurenative.blueprint.AssignmentArgs;
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 assignment = new Assignment("assignment", AssignmentArgs.builder()
            .assignmentName("assignSimpleBlueprint")
            .blueprintId("/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint")
            .description("enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.")
            .identity(Map.ofEntries(
                Map.entry("type", "UserAssigned"),
                Map.entry("userAssignedIdentities", Map.of("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity", ))
            ))
            .location("eastus")
            .parameters(Map.ofEntries(
                Map.entry("costCenter", Map.of("value", "Contoso/Online/Shopping/Production")),
                Map.entry("owners", Map.of("value",
                    "johnDoe@contoso.com",
                    "johnsteam@contoso.com")),
                Map.entry("storageAccountType", Map.of("value", "Standard_LRS"))
            ))
            .resourceGroups(Map.of("storageRG", Map.ofEntries(
                Map.entry("location", "eastus"),
                Map.entry("name", "defaultRG")
            )))
            .resourceScope("managementGroups/ContosoOnlineGroup")
            .scope("subscriptions/00000000-0000-0000-0000-000000000000")
            .build());
    }
}

Assignment with user-assigned managed identity at subscription scope

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var assignment = new AzureNative.Blueprint.Assignment("assignment", new()
    {
        AssignmentName = "assignSimpleBlueprint",
        BlueprintId = "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
        Description = "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
        Identity = new AzureNative.Blueprint.Inputs.ManagedServiceIdentityArgs
        {
            Type = "UserAssigned",
            UserAssignedIdentities =
            {
                { "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity", null },
            },
        },
        Location = "eastus",
        Parameters =
        {
            { "costCenter", new AzureNative.Blueprint.Inputs.ParameterValueArgs
            {
                Value = "Contoso/Online/Shopping/Production",
            } },
            { "owners", new AzureNative.Blueprint.Inputs.ParameterValueArgs
            {
                Value = new[]
                {
                    "johnDoe@contoso.com",
                    "johnsteam@contoso.com",
                },
            } },
            { "storageAccountType", new AzureNative.Blueprint.Inputs.ParameterValueArgs
            {
                Value = "Standard_LRS",
            } },
        },
        ResourceGroups =
        {
            { "storageRG", new AzureNative.Blueprint.Inputs.ResourceGroupValueArgs
            {
                Location = "eastus",
                Name = "defaultRG",
            } },
        },
        ResourceScope = "subscriptions/00000000-0000-0000-0000-000000000000",
    });
});

package main
import (
	"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.NewAssignment(ctx, "assignment", &blueprint.AssignmentArgs{
			AssignmentName: pulumi.String("assignSimpleBlueprint"),
			BlueprintId:    pulumi.String("/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint"),
			Description:    pulumi.String("enforce pre-defined simpleBlueprint to this XXXXXXXX subscription."),
			Identity: blueprint.ManagedServiceIdentityResponse{
				Type: pulumi.String("UserAssigned"),
				UserAssignedIdentities: blueprint.UserAssignedIdentityMap{
					"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": nil,
				},
			},
			Location: pulumi.String("eastus"),
			Parameters: blueprint.ParameterValueMap{
				"costCenter": &blueprint.ParameterValueArgs{
					Value: pulumi.Any("Contoso/Online/Shopping/Production"),
				},
				"owners": &blueprint.ParameterValueArgs{
					Value: pulumi.Any{
						"johnDoe@contoso.com",
						"johnsteam@contoso.com",
					},
				},
				"storageAccountType": &blueprint.ParameterValueArgs{
					Value: pulumi.Any("Standard_LRS"),
				},
			},
			ResourceGroups: blueprint.ResourceGroupValueMap{
				"storageRG": &blueprint.ResourceGroupValueArgs{
					Location: pulumi.String("eastus"),
					Name:     pulumi.String("defaultRG"),
				},
			},
			ResourceScope: pulumi.String("subscriptions/00000000-0000-0000-0000-000000000000"),
		})
		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.Assignment;
import com.pulumi.azurenative.blueprint.AssignmentArgs;
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 assignment = new Assignment("assignment", AssignmentArgs.builder()
            .assignmentName("assignSimpleBlueprint")
            .blueprintId("/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint")
            .description("enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.")
            .identity(Map.ofEntries(
                Map.entry("type", "UserAssigned"),
                Map.entry("userAssignedIdentities", Map.of("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity", ))
            ))
            .location("eastus")
            .parameters(Map.ofEntries(
                Map.entry("costCenter", Map.of("value", "Contoso/Online/Shopping/Production")),
                Map.entry("owners", Map.of("value",
                    "johnDoe@contoso.com",
                    "johnsteam@contoso.com")),
                Map.entry("storageAccountType", Map.of("value", "Standard_LRS"))
            ))
            .resourceGroups(Map.of("storageRG", Map.ofEntries(
                Map.entry("location", "eastus"),
                Map.entry("name", "defaultRG")
            )))
            .resourceScope("subscriptions/00000000-0000-0000-0000-000000000000")
            .build());
    }
}

Import

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

$ pulumi import azure-native:blueprint:Assignment assignSimpleBlueprint /{resourceScope}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}

Properties

blueprintId

val blueprintId: Output<String>?

ID of the published version of a blueprint definition.

description

val description: Output<String>?

Multi-line explain this resource.

displayName

val displayName: Output<String>?

One-liner string explain this resource.

val id: Output<String>

identity

val identity: Output<ManagedServiceIdentityResponse>

Managed identity for this blueprint assignment.

location

val location: Output<String>

The location of this blueprint assignment.

locks

val locks: Output<AssignmentLockSettingsResponse>?

Defines how resources deployed by a blueprint assignment are locked.

name

val name: Output<String>

Name of this resource.

parameters

val parameters: Output<Map<String, ParameterValueResponse>>

Blueprint assignment parameter values.

provisioningState

val provisioningState: Output<String>

State of the blueprint assignment.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

resourceGroups

val resourceGroups: Output<Map<String, ResourceGroupValueResponse>>

Names and locations of resource group placeholders.

scope

val scope: Output<String>?

The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required.

status

val status: Output<AssignmentStatusResponse>

Status of blueprint assignment. This field is readonly.

type

val type: Output<String>

Type of this resource.

urn

val urn: Output<String>