blueprint

package
v3.33.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 7, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Assignment 

type Assignment struct {
	pulumi.CustomResourceState

	// The name of the blueprint assigned
	BlueprintName pulumi.StringOutput `pulumi:"blueprintName"`
	// The Description on the Blueprint
	Description pulumi.StringOutput `pulumi:"description"`
	// The display name of the blueprint
	DisplayName pulumi.StringOutput         `pulumi:"displayName"`
	Identity    AssignmentIdentityPtrOutput `pulumi:"identity"`
	// The Azure location of the Assignment.
	Location pulumi.StringOutput `pulumi:"location"`
	// a list of up to 5 Principal IDs that are permitted to bypass the locks applied by the Blueprint.
	LockExcludePrincipals pulumi.StringArrayOutput `pulumi:"lockExcludePrincipals"`
	// The locking mode of the Blueprint Assignment.  One of `None` (Default), `AllResourcesReadOnly`, or `AlResourcesDoNotDelete`.
	LockMode pulumi.StringPtrOutput `pulumi:"lockMode"`
	// The name of the Blueprint Assignment
	Name pulumi.StringOutput `pulumi:"name"`
	// a JSON string to supply Blueprint Assignment parameter values.
	ParameterValues pulumi.StringPtrOutput `pulumi:"parameterValues"`
	// a JSON string to supply the Blueprint Resource Group information.
	ResourceGroups pulumi.StringPtrOutput `pulumi:"resourceGroups"`
	// The Subscription ID the Blueprint Published Version is to be applied to.
	TargetSubscriptionId pulumi.StringOutput `pulumi:"targetSubscriptionId"`
	// The Identity type for the Managed Service Identity. Currently only `UserAssigned` is supported.
	Type pulumi.StringOutput `pulumi:"type"`
	// The ID of the Published Version of the blueprint to be assigned.
	VersionId pulumi.StringOutput `pulumi:"versionId"`
}

Manages a Blueprint Assignment resource

> **NOTE:** Azure Blueprints are in Preview and potentially subject to breaking change without notice.

> **NOTE:** Azure Blueprint Assignments can only be applied to Subscriptions. Assignments to Management Groups is not currently supported by the service or by this provider.

## Example Usage

```go package main

import ( 

"fmt"

"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/authorization"
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/blueprint"
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := core.GetClientConfig(ctx, nil, nil)
		if err != nil {
			return err
		}
		exampleSubscription, err := core.GetSubscription(ctx, nil, nil)
		if err != nil {
			return err
		}
		exampleDefinition, err := blueprint.GetDefinition(ctx, &blueprint.GetDefinitionArgs{
			Name:    "exampleBlueprint",
			ScopeId: exampleSubscription.Id,
		}, nil)
		if err != nil {
			return err
		}
		examplePublishedVersion, err := blueprint.GetPublishedVersion(ctx, &blueprint.GetPublishedVersionArgs{
			ScopeId:       exampleDefinition.ScopeId,
			BlueprintName: exampleDefinition.Name,
			Version:       "v1.0.0",
		}, nil)
		if err != nil {
			return err
		}
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("westeurope"),
			Tags: pulumi.StringMap{
				"Environment": pulumi.String("example"),
			},
		})
		if err != nil {
			return err
		}
		exampleUserAssignedIdentity, err := authorization.NewUserAssignedIdentity(ctx, "exampleUserAssignedIdentity", &authorization.UserAssignedIdentityArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
		})
		if err != nil {
			return err
		}
		operator, err := authorization.NewAssignment(ctx, "operator", &authorization.AssignmentArgs{
			Scope:              pulumi.String(exampleSubscription.Id),
			RoleDefinitionName: pulumi.String("Blueprint Operator"),
			PrincipalId:        exampleUserAssignedIdentity.PrincipalId,
		})
		if err != nil {
			return err
		}
		owner, err := authorization.NewAssignment(ctx, "owner", &authorization.AssignmentArgs{
			Scope:              pulumi.String(exampleSubscription.Id),
			RoleDefinitionName: pulumi.String("Owner"),
			PrincipalId:        exampleUserAssignedIdentity.PrincipalId,
		})
		if err != nil {
			return err
		}
		_, err = blueprint.NewAssignment(ctx, "exampleAssignment", &blueprint.AssignmentArgs{
			TargetSubscriptionId: pulumi.String(exampleSubscription.Id),
			VersionId:            pulumi.String(examplePublishedVersion.Id),
			Location:             exampleResourceGroup.Location,
			LockMode:             pulumi.String("AllResourcesDoNotDelete"),
			LockExcludePrincipals: pulumi.StringArray{
				pulumi.String(current.ObjectId),
			},
			Identity: &blueprint.AssignmentIdentityArgs{
				Type: pulumi.String("UserAssigned"),
				IdentityIds: pulumi.StringArray{
					exampleUserAssignedIdentity.ID(),
				},
			},
			ResourceGroups:  pulumi.String(fmt.Sprintf("%v%v%v%v%v", "    {\n", "      \"ResourceGroup\": {\n", "        \"name\": \"exampleRG-bp\"\n", "      }\n", "    }\n")),
			ParameterValues: pulumi.String(fmt.Sprintf("%v%v%v%v%v", "    {\n", "      \"allowedlocationsforresourcegroups_listOfAllowedLocations\": {\n", "        \"value\": [\"westus\", \"westus2\", \"eastus\", \"centralus\", \"centraluseuap\", \"southcentralus\", \"northcentralus\", \"westcentralus\", \"eastus2\", \"eastus2euap\", \"brazilsouth\", \"brazilus\", \"northeurope\", \"westeurope\", \"eastasia\", \"southeastasia\", \"japanwest\", \"japaneast\", \"koreacentral\", \"koreasouth\", \"indiasouth\", \"indiawest\", \"indiacentral\", \"australiaeast\", \"australiasoutheast\", \"canadacentral\", \"canadaeast\", \"uknorth\", \"uksouth2\", \"uksouth\", \"ukwest\", \"francecentral\", \"francesouth\", \"australiacentral\", \"australiacentral2\", \"uaecentral\", \"uaenorth\", \"southafricanorth\", \"southafricawest\", \"switzerlandnorth\", \"switzerlandwest\", \"germanynorth\", \"germanywestcentral\", \"norwayeast\", \"norwaywest\"]\n", "      }\n", "    }\n")),
		}, pulumi.DependsOn([]pulumi.Resource{
			operator,
			owner,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Azure Blueprint Assignments can be imported using the `resource id`, e.g.

```sh 

$ pulumi import azure:blueprint/assignment:Assignment example "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint"

```

func GetAssignment 

func GetAssignment(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AssignmentState, opts ...pulumi.ResourceOption) (*Assignment, error)

GetAssignment gets an existing Assignment resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAssignment 

func NewAssignment(ctx *pulumi.Context,
	name string, args *AssignmentArgs, opts ...pulumi.ResourceOption) (*Assignment, error)

NewAssignment registers a new resource with the given unique name, arguments, and options.

func (Assignment) ElementType added in v3.31.1 

func (Assignment) ElementType() reflect.Type

func (Assignment) ToAssignmentOutput added in v3.31.1 

func (i Assignment) ToAssignmentOutput() AssignmentOutput

func (Assignment) ToAssignmentOutputWithContext added in v3.31.1 

func (i Assignment) ToAssignmentOutputWithContext(ctx context.Context) AssignmentOutput

type AssignmentArgs 

type AssignmentArgs struct {
	Identity AssignmentIdentityPtrInput
	// The Azure location of the Assignment.
	Location pulumi.StringPtrInput
	// a list of up to 5 Principal IDs that are permitted to bypass the locks applied by the Blueprint.
	LockExcludePrincipals pulumi.StringArrayInput
	// The locking mode of the Blueprint Assignment.  One of `None` (Default), `AllResourcesReadOnly`, or `AlResourcesDoNotDelete`.
	LockMode pulumi.StringPtrInput
	// The name of the Blueprint Assignment
	Name pulumi.StringPtrInput
	// a JSON string to supply Blueprint Assignment parameter values.
	ParameterValues pulumi.StringPtrInput
	// a JSON string to supply the Blueprint Resource Group information.
	ResourceGroups pulumi.StringPtrInput
	// The Subscription ID the Blueprint Published Version is to be applied to.
	TargetSubscriptionId pulumi.StringInput
	// The ID of the Published Version of the blueprint to be assigned.
	VersionId pulumi.StringInput
}

The set of arguments for constructing a Assignment resource.

func (AssignmentArgs) ElementType 

func (AssignmentArgs) ElementType() reflect.Type

type AssignmentIdentity 

type AssignmentIdentity struct {
	IdentityIds []string `pulumi:"identityIds"`
	PrincipalId *string  `pulumi:"principalId"`
	TenantId    *string  `pulumi:"tenantId"`
	// The Identity type for the Managed Service Identity. Currently only `UserAssigned` is supported.
	Type string `pulumi:"type"`
}

type AssignmentIdentityArgs 

type AssignmentIdentityArgs struct {
	IdentityIds pulumi.StringArrayInput `pulumi:"identityIds"`
	PrincipalId pulumi.StringPtrInput   `pulumi:"principalId"`
	TenantId    pulumi.StringPtrInput   `pulumi:"tenantId"`
	// The Identity type for the Managed Service Identity. Currently only `UserAssigned` is supported.
	Type pulumi.StringInput `pulumi:"type"`
}

func (AssignmentIdentityArgs) ElementType 

func (AssignmentIdentityArgs) ElementType() reflect.Type

func (AssignmentIdentityArgs) ToAssignmentIdentityOutput 

func (i AssignmentIdentityArgs) ToAssignmentIdentityOutput() AssignmentIdentityOutput

func (AssignmentIdentityArgs) ToAssignmentIdentityOutputWithContext 

func (i AssignmentIdentityArgs) ToAssignmentIdentityOutputWithContext(ctx context.Context) AssignmentIdentityOutput

func (AssignmentIdentityArgs) ToAssignmentIdentityPtrOutput 

func (i AssignmentIdentityArgs) ToAssignmentIdentityPtrOutput() AssignmentIdentityPtrOutput

func (AssignmentIdentityArgs) ToAssignmentIdentityPtrOutputWithContext 

func (i AssignmentIdentityArgs) ToAssignmentIdentityPtrOutputWithContext(ctx context.Context) AssignmentIdentityPtrOutput

type AssignmentIdentityInput 

type AssignmentIdentityInput interface {
	pulumi.Input

	ToAssignmentIdentityOutput() AssignmentIdentityOutput
	ToAssignmentIdentityOutputWithContext(context.Context) AssignmentIdentityOutput
}

AssignmentIdentityInput is an input type that accepts AssignmentIdentityArgs and AssignmentIdentityOutput values. You can construct a concrete instance of `AssignmentIdentityInput` via: 

AssignmentIdentityArgs{...}

type AssignmentIdentityOutput 

type AssignmentIdentityOutput struct{ *pulumi.OutputState }

func (AssignmentIdentityOutput) ElementType 

func (AssignmentIdentityOutput) ElementType() reflect.Type

func (AssignmentIdentityOutput) IdentityIds 

func (o AssignmentIdentityOutput) IdentityIds() pulumi.StringArrayOutput

func (AssignmentIdentityOutput) PrincipalId 

func (o AssignmentIdentityOutput) PrincipalId() pulumi.StringPtrOutput

func (AssignmentIdentityOutput) TenantId 

func (o AssignmentIdentityOutput) TenantId() pulumi.StringPtrOutput

func (AssignmentIdentityOutput) ToAssignmentIdentityOutput 

func (o AssignmentIdentityOutput) ToAssignmentIdentityOutput() AssignmentIdentityOutput

func (AssignmentIdentityOutput) ToAssignmentIdentityOutputWithContext 

func (o AssignmentIdentityOutput) ToAssignmentIdentityOutputWithContext(ctx context.Context) AssignmentIdentityOutput

func (AssignmentIdentityOutput) ToAssignmentIdentityPtrOutput 

func (o AssignmentIdentityOutput) ToAssignmentIdentityPtrOutput() AssignmentIdentityPtrOutput

func (AssignmentIdentityOutput) ToAssignmentIdentityPtrOutputWithContext 

func (o AssignmentIdentityOutput) ToAssignmentIdentityPtrOutputWithContext(ctx context.Context) AssignmentIdentityPtrOutput

func (AssignmentIdentityOutput) Type 

func (o AssignmentIdentityOutput) Type() pulumi.StringOutput

The Identity type for the Managed Service Identity. Currently only `UserAssigned` is supported.

type AssignmentIdentityPtrInput 

type AssignmentIdentityPtrInput interface {
	pulumi.Input

	ToAssignmentIdentityPtrOutput() AssignmentIdentityPtrOutput
	ToAssignmentIdentityPtrOutputWithContext(context.Context) AssignmentIdentityPtrOutput
}

AssignmentIdentityPtrInput is an input type that accepts AssignmentIdentityArgs, AssignmentIdentityPtr and AssignmentIdentityPtrOutput values. You can construct a concrete instance of `AssignmentIdentityPtrInput` via: 

        AssignmentIdentityArgs{...}

or:

        nil

func AssignmentIdentityPtr 

func AssignmentIdentityPtr(v *AssignmentIdentityArgs) AssignmentIdentityPtrInput

type AssignmentIdentityPtrOutput 

type AssignmentIdentityPtrOutput struct{ *pulumi.OutputState }

func (AssignmentIdentityPtrOutput) Elem 

func (o AssignmentIdentityPtrOutput) Elem() AssignmentIdentityOutput

func (AssignmentIdentityPtrOutput) ElementType 

func (AssignmentIdentityPtrOutput) ElementType() reflect.Type

func (AssignmentIdentityPtrOutput) IdentityIds 

func (o AssignmentIdentityPtrOutput) IdentityIds() pulumi.StringArrayOutput

func (AssignmentIdentityPtrOutput) PrincipalId 

func (o AssignmentIdentityPtrOutput) PrincipalId() pulumi.StringPtrOutput

func (AssignmentIdentityPtrOutput) TenantId 

func (o AssignmentIdentityPtrOutput) TenantId() pulumi.StringPtrOutput

func (AssignmentIdentityPtrOutput) ToAssignmentIdentityPtrOutput 

func (o AssignmentIdentityPtrOutput) ToAssignmentIdentityPtrOutput() AssignmentIdentityPtrOutput

func (AssignmentIdentityPtrOutput) ToAssignmentIdentityPtrOutputWithContext 

func (o AssignmentIdentityPtrOutput) ToAssignmentIdentityPtrOutputWithContext(ctx context.Context) AssignmentIdentityPtrOutput

func (AssignmentIdentityPtrOutput) Type 

func (o AssignmentIdentityPtrOutput) Type() pulumi.StringPtrOutput

The Identity type for the Managed Service Identity. Currently only `UserAssigned` is supported.

type AssignmentInput added in v3.31.1 

type AssignmentInput interface {
	pulumi.Input

	ToAssignmentOutput() AssignmentOutput
	ToAssignmentOutputWithContext(ctx context.Context) AssignmentOutput
}

type AssignmentOutput added in v3.31.1 

type AssignmentOutput struct {
	*pulumi.OutputState
}

func (AssignmentOutput) ElementType added in v3.31.1 

func (AssignmentOutput) ElementType() reflect.Type

func (AssignmentOutput) ToAssignmentOutput added in v3.31.1 

func (o AssignmentOutput) ToAssignmentOutput() AssignmentOutput

func (AssignmentOutput) ToAssignmentOutputWithContext added in v3.31.1 

func (o AssignmentOutput) ToAssignmentOutputWithContext(ctx context.Context) AssignmentOutput

type AssignmentState 

type AssignmentState struct {
	// The name of the blueprint assigned
	BlueprintName pulumi.StringPtrInput
	// The Description on the Blueprint
	Description pulumi.StringPtrInput
	// The display name of the blueprint
	DisplayName pulumi.StringPtrInput
	Identity    AssignmentIdentityPtrInput
	// The Azure location of the Assignment.
	Location pulumi.StringPtrInput
	// a list of up to 5 Principal IDs that are permitted to bypass the locks applied by the Blueprint.
	LockExcludePrincipals pulumi.StringArrayInput
	// The locking mode of the Blueprint Assignment.  One of `None` (Default), `AllResourcesReadOnly`, or `AlResourcesDoNotDelete`.
	LockMode pulumi.StringPtrInput
	// The name of the Blueprint Assignment
	Name pulumi.StringPtrInput
	// a JSON string to supply Blueprint Assignment parameter values.
	ParameterValues pulumi.StringPtrInput
	// a JSON string to supply the Blueprint Resource Group information.
	ResourceGroups pulumi.StringPtrInput
	// The Subscription ID the Blueprint Published Version is to be applied to.
	TargetSubscriptionId pulumi.StringPtrInput
	// The Identity type for the Managed Service Identity. Currently only `UserAssigned` is supported.
	Type pulumi.StringPtrInput
	// The ID of the Published Version of the blueprint to be assigned.
	VersionId pulumi.StringPtrInput
}

func (AssignmentState) ElementType 

func (AssignmentState) ElementType() reflect.Type

type GetDefinitionArgs 

type GetDefinitionArgs struct {
	// The name of the Blueprint.
	Name string `pulumi:"name"`
	// The ID of the Subscription or Management Group, as the scope at which the blueprint definition is stored.
	ScopeId string `pulumi:"scopeId"`
}

A collection of arguments for invoking getDefinition.

type GetDefinitionResult 

type GetDefinitionResult struct {
	// The description of the Blueprint Definition.
	Description string `pulumi:"description"`
	// The display name of the Blueprint Definition.
	DisplayName string `pulumi:"displayName"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The timestamp of when this last modification was saved to the Blueprint Definition.
	LastModified string `pulumi:"lastModified"`
	Name         string `pulumi:"name"`
	ScopeId      string `pulumi:"scopeId"`
	// The target scope.
	TargetScope string `pulumi:"targetScope"`
	// The timestamp of when this Blueprint Definition was created.
	TimeCreated string `pulumi:"timeCreated"`
	// A list of versions published for this Blueprint Definition.
	Versions []string `pulumi:"versions"`
}

A collection of values returned by getDefinition.

func GetDefinition 

func GetDefinition(ctx *pulumi.Context, args *GetDefinitionArgs, opts ...pulumi.InvokeOption) (*GetDefinitionResult, error)

Use this data source to access information about an existing Azure Blueprint Definition

> **NOTE:** Azure Blueprints are in Preview and potentially subject to breaking change without notice.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/blueprint"
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/management"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := core.GetClientConfig(ctx, nil, nil)
		if err != nil {
			return err
		}
		opt0 := current.TenantId
		root, err := management.LookupGroup(ctx, &management.LookupGroupArgs{
			Name: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		_, err = blueprint.GetDefinition(ctx, &blueprint.GetDefinitionArgs{
			Name:    "exampleManagementGroupBP",
			ScopeId: root.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetPublishedVersionArgs 

type GetPublishedVersionArgs struct {
	// The name of the Blueprint Definition
	BlueprintName string `pulumi:"blueprintName"`
	// The ID of the Management Group / Subscription where this Blueprint Definition is stored.
	ScopeId string `pulumi:"scopeId"`
	// The Version name of the Published Version of the Blueprint Definition
	Version string `pulumi:"version"`
}

A collection of arguments for invoking getPublishedVersion.

type GetPublishedVersionResult 

type GetPublishedVersionResult struct {
	BlueprintName string `pulumi:"blueprintName"`
	// The description of the Blueprint Published Version
	Description string `pulumi:"description"`
	// The display name of the Blueprint Published Version
	DisplayName string `pulumi:"displayName"`
	// The provider-assigned unique ID for this managed resource.
	Id           string `pulumi:"id"`
	LastModified string `pulumi:"lastModified"`
	ScopeId      string `pulumi:"scopeId"`
	// The target scope
	TargetScope string `pulumi:"targetScope"`
	TimeCreated string `pulumi:"timeCreated"`
	// The type of the Blueprint
	Type    string `pulumi:"type"`
	Version string `pulumi:"version"`
}

A collection of values returned by getPublishedVersion.

func GetPublishedVersion 

func GetPublishedVersion(ctx *pulumi.Context, args *GetPublishedVersionArgs, opts ...pulumi.InvokeOption) (*GetPublishedVersionResult, error)

Use this data source to access information about an existing Blueprint Published Version

> **NOTE:** Azure Blueprints are in Preview and potentially subject to breaking change without notice.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/blueprint"
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := core.GetSubscription(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = blueprint.GetPublishedVersion(ctx, &blueprint.GetPublishedVersionArgs{
			ScopeId:       current.Id,
			BlueprintName: "exampleBluePrint",
			Version:       "dev_v2.3",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.