blueprint

package
v5.41.0 Latest Latest
Warning

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

 Go to latest Published: Apr 21, 2023 License: Apache-2.0 Imports: 7 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"`
	// An `identity` block as defined below.
	Identity AssignmentIdentityOutput `pulumi:"identity"`
	// The Azure location of the Assignment. Changing this forces a new resource to be created.
	Location pulumi.StringOutput `pulumi:"location"`
	// a list of up to 200 actions that are permitted to bypass the locks applied by the Blueprint.
	LockExcludeActions pulumi.StringArrayOutput `pulumi:"lockExcludeActions"`
	// 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 `AllResourcesDoNotDelete`. Defaults to `none`.
	LockMode pulumi.StringPtrOutput `pulumi:"lockMode"`
	// The name of the Blueprint Assignment. Changing this forces a new resource to be created.
	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. Changing this forces a new resource to be created.
	TargetSubscriptionId pulumi.StringOutput `pulumi:"targetSubscriptionId"`
	// Specifies the type of Managed Service Identity that should be configured on this Blueprint. Only possible value is `UserAssigned`.
	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 ( 

"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/authorization"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/blueprint"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi/sdk/v3/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.LookupSubscription(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("West Europe"),
			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("    {\n      \"ResourceGroup\": {\n        \"name\": \"exampleRG-bp\"\n      }\n    }\n"),
			ParameterValues: pulumi.String("    {\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 

func (*Assignment) ElementType() reflect.Type

func (*Assignment) ToAssignmentOutput 

func (i *Assignment) ToAssignmentOutput() AssignmentOutput

func (*Assignment) ToAssignmentOutputWithContext 

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

type AssignmentArgs 

type AssignmentArgs struct {
	// An `identity` block as defined below.
	Identity AssignmentIdentityInput
	// The Azure location of the Assignment. Changing this forces a new resource to be created.
	Location pulumi.StringPtrInput
	// a list of up to 200 actions that are permitted to bypass the locks applied by the Blueprint.
	LockExcludeActions pulumi.StringArrayInput
	// 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 `AllResourcesDoNotDelete`. Defaults to `none`.
	LockMode pulumi.StringPtrInput
	// The name of the Blueprint Assignment. Changing this forces a new resource to be created.
	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. Changing this forces a new resource to be created.
	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 AssignmentArray 

type AssignmentArray []AssignmentInput

func (AssignmentArray) ElementType 

func (AssignmentArray) ElementType() reflect.Type

func (AssignmentArray) ToAssignmentArrayOutput 

func (i AssignmentArray) ToAssignmentArrayOutput() AssignmentArrayOutput

func (AssignmentArray) ToAssignmentArrayOutputWithContext 

func (i AssignmentArray) ToAssignmentArrayOutputWithContext(ctx context.Context) AssignmentArrayOutput

type AssignmentArrayInput 

type AssignmentArrayInput interface {
	pulumi.Input

	ToAssignmentArrayOutput() AssignmentArrayOutput
	ToAssignmentArrayOutputWithContext(context.Context) AssignmentArrayOutput
}

AssignmentArrayInput is an input type that accepts AssignmentArray and AssignmentArrayOutput values. You can construct a concrete instance of `AssignmentArrayInput` via: 

AssignmentArray{ AssignmentArgs{...} }

type AssignmentArrayOutput 

type AssignmentArrayOutput struct{ *pulumi.OutputState }

func (AssignmentArrayOutput) ElementType 

func (AssignmentArrayOutput) ElementType() reflect.Type

func (AssignmentArrayOutput) Index 

func (o AssignmentArrayOutput) Index(i pulumi.IntInput) AssignmentOutput

func (AssignmentArrayOutput) ToAssignmentArrayOutput 

func (o AssignmentArrayOutput) ToAssignmentArrayOutput() AssignmentArrayOutput

func (AssignmentArrayOutput) ToAssignmentArrayOutputWithContext 

func (o AssignmentArrayOutput) ToAssignmentArrayOutputWithContext(ctx context.Context) AssignmentArrayOutput

type AssignmentIdentity 

type AssignmentIdentity struct {
	// Specifies a list of User Assigned Managed Identity IDs to be assigned to this Blueprint.
	IdentityIds []string `pulumi:"identityIds"`
	// Specifies the type of Managed Service Identity that should be configured on this Blueprint. Only possible value is `UserAssigned`.
	Type string `pulumi:"type"`
}

type AssignmentIdentityArgs 

type AssignmentIdentityArgs struct {
	// Specifies a list of User Assigned Managed Identity IDs to be assigned to this Blueprint.
	IdentityIds pulumi.StringArrayInput `pulumi:"identityIds"`
	// Specifies the type of Managed Service Identity that should be configured on this Blueprint. Only possible value is `UserAssigned`.
	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

Specifies a list of User Assigned Managed Identity IDs to be assigned to this Blueprint.

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

Specifies the type of Managed Service Identity that should be configured on this Blueprint. Only possible value is `UserAssigned`.

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

Specifies a list of User Assigned Managed Identity IDs to be assigned to this Blueprint.

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

Specifies the type of Managed Service Identity that should be configured on this Blueprint. Only possible value is `UserAssigned`.

type AssignmentInput 

type AssignmentInput interface {
	pulumi.Input

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

type AssignmentMap 

type AssignmentMap map[string]AssignmentInput

func (AssignmentMap) ElementType 

func (AssignmentMap) ElementType() reflect.Type

func (AssignmentMap) ToAssignmentMapOutput 

func (i AssignmentMap) ToAssignmentMapOutput() AssignmentMapOutput

func (AssignmentMap) ToAssignmentMapOutputWithContext 

func (i AssignmentMap) ToAssignmentMapOutputWithContext(ctx context.Context) AssignmentMapOutput

type AssignmentMapInput 

type AssignmentMapInput interface {
	pulumi.Input

	ToAssignmentMapOutput() AssignmentMapOutput
	ToAssignmentMapOutputWithContext(context.Context) AssignmentMapOutput
}

AssignmentMapInput is an input type that accepts AssignmentMap and AssignmentMapOutput values. You can construct a concrete instance of `AssignmentMapInput` via: 

AssignmentMap{ "key": AssignmentArgs{...} }

type AssignmentMapOutput 

type AssignmentMapOutput struct{ *pulumi.OutputState }

func (AssignmentMapOutput) ElementType 

func (AssignmentMapOutput) ElementType() reflect.Type

func (AssignmentMapOutput) MapIndex 

func (o AssignmentMapOutput) MapIndex(k pulumi.StringInput) AssignmentOutput

func (AssignmentMapOutput) ToAssignmentMapOutput 

func (o AssignmentMapOutput) ToAssignmentMapOutput() AssignmentMapOutput

func (AssignmentMapOutput) ToAssignmentMapOutputWithContext 

func (o AssignmentMapOutput) ToAssignmentMapOutputWithContext(ctx context.Context) AssignmentMapOutput

type AssignmentOutput 

type AssignmentOutput struct{ *pulumi.OutputState }

func (AssignmentOutput) BlueprintName added in v5.5.0 

func (o AssignmentOutput) BlueprintName() pulumi.StringOutput

The name of the blueprint assigned

func (AssignmentOutput) Description added in v5.5.0 

func (o AssignmentOutput) Description() pulumi.StringOutput

The Description on the Blueprint

func (AssignmentOutput) DisplayName added in v5.5.0 

func (o AssignmentOutput) DisplayName() pulumi.StringOutput

The display name of the blueprint

func (AssignmentOutput) ElementType 

func (AssignmentOutput) ElementType() reflect.Type

func (AssignmentOutput) Identity added in v5.5.0 

func (o AssignmentOutput) Identity() AssignmentIdentityOutput

An `identity` block as defined below.

func (AssignmentOutput) Location added in v5.5.0 

func (o AssignmentOutput) Location() pulumi.StringOutput

The Azure location of the Assignment. Changing this forces a new resource to be created.

func (AssignmentOutput) LockExcludeActions added in v5.5.0 

func (o AssignmentOutput) LockExcludeActions() pulumi.StringArrayOutput

a list of up to 200 actions that are permitted to bypass the locks applied by the Blueprint.

func (AssignmentOutput) LockExcludePrincipals added in v5.5.0 

func (o AssignmentOutput) LockExcludePrincipals() pulumi.StringArrayOutput

a list of up to 5 Principal IDs that are permitted to bypass the locks applied by the Blueprint.

func (AssignmentOutput) LockMode added in v5.5.0 

func (o AssignmentOutput) LockMode() pulumi.StringPtrOutput

The locking mode of the Blueprint Assignment. One of `None` (Default), `AllResourcesReadOnly`, or `AllResourcesDoNotDelete`. Defaults to `none`.

func (AssignmentOutput) Name added in v5.5.0 

func (o AssignmentOutput) Name() pulumi.StringOutput

The name of the Blueprint Assignment. Changing this forces a new resource to be created.

func (AssignmentOutput) ParameterValues added in v5.5.0 

func (o AssignmentOutput) ParameterValues() pulumi.StringPtrOutput

a JSON string to supply Blueprint Assignment parameter values.

func (AssignmentOutput) ResourceGroups added in v5.5.0 

func (o AssignmentOutput) ResourceGroups() pulumi.StringPtrOutput

a JSON string to supply the Blueprint Resource Group information.

func (AssignmentOutput) TargetSubscriptionId added in v5.5.0 

func (o AssignmentOutput) TargetSubscriptionId() pulumi.StringOutput

The Subscription ID the Blueprint Published Version is to be applied to. Changing this forces a new resource to be created.

func (AssignmentOutput) ToAssignmentOutput 

func (o AssignmentOutput) ToAssignmentOutput() AssignmentOutput

func (AssignmentOutput) ToAssignmentOutputWithContext 

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

func (AssignmentOutput) Type added in v5.5.0 

func (o AssignmentOutput) Type() pulumi.StringOutput

Specifies the type of Managed Service Identity that should be configured on this Blueprint. Only possible value is `UserAssigned`.

func (AssignmentOutput) VersionId added in v5.5.0 

func (o AssignmentOutput) VersionId() pulumi.StringOutput

The ID of the Published Version of the blueprint to be assigned.

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
	// An `identity` block as defined below.
	Identity AssignmentIdentityPtrInput
	// The Azure location of the Assignment. Changing this forces a new resource to be created.
	Location pulumi.StringPtrInput
	// a list of up to 200 actions that are permitted to bypass the locks applied by the Blueprint.
	LockExcludeActions pulumi.StringArrayInput
	// 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 `AllResourcesDoNotDelete`. Defaults to `none`.
	LockMode pulumi.StringPtrInput
	// The name of the Blueprint Assignment. Changing this forces a new resource to be created.
	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. Changing this forces a new resource to be created.
	TargetSubscriptionId pulumi.StringPtrInput
	// Specifies the type of Managed Service Identity that should be configured on this Blueprint. Only possible value is `UserAssigned`.
	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 GetDefinitionOutputArgs 

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

A collection of arguments for invoking getDefinition.

func (GetDefinitionOutputArgs) ElementType 

func (GetDefinitionOutputArgs) ElementType() reflect.Type

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/v5/go/azure/blueprint"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/management"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := core.GetClientConfig(ctx, nil, nil)
		if err != nil {
			return err
		}
		root, err := management.LookupGroup(ctx, &management.LookupGroupArgs{
			Name: pulumi.StringRef(current.TenantId),
		}, 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 GetDefinitionResultOutput 

type GetDefinitionResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getDefinition.

func GetDefinitionOutput 

func GetDefinitionOutput(ctx *pulumi.Context, args GetDefinitionOutputArgs, opts ...pulumi.InvokeOption) GetDefinitionResultOutput

func (GetDefinitionResultOutput) Description 

func (o GetDefinitionResultOutput) Description() pulumi.StringOutput

The description of the Blueprint Definition.

func (GetDefinitionResultOutput) DisplayName 

func (o GetDefinitionResultOutput) DisplayName() pulumi.StringOutput

The display name of the Blueprint Definition.

func (GetDefinitionResultOutput) ElementType 

func (GetDefinitionResultOutput) ElementType() reflect.Type

func (GetDefinitionResultOutput) Id 

func (o GetDefinitionResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetDefinitionResultOutput) LastModified 

func (o GetDefinitionResultOutput) LastModified() pulumi.StringOutput

The timestamp of when this last modification was saved to the Blueprint Definition.

func (GetDefinitionResultOutput) Name 

func (o GetDefinitionResultOutput) Name() pulumi.StringOutput

func (GetDefinitionResultOutput) ScopeId 

func (o GetDefinitionResultOutput) ScopeId() pulumi.StringOutput

func (GetDefinitionResultOutput) TargetScope 

func (o GetDefinitionResultOutput) TargetScope() pulumi.StringOutput

The target scope.

func (GetDefinitionResultOutput) TimeCreated 

func (o GetDefinitionResultOutput) TimeCreated() pulumi.StringOutput

The timestamp of when this Blueprint Definition was created.

func (GetDefinitionResultOutput) ToGetDefinitionResultOutput 

func (o GetDefinitionResultOutput) ToGetDefinitionResultOutput() GetDefinitionResultOutput

func (GetDefinitionResultOutput) ToGetDefinitionResultOutputWithContext 

func (o GetDefinitionResultOutput) ToGetDefinitionResultOutputWithContext(ctx context.Context) GetDefinitionResultOutput

func (GetDefinitionResultOutput) Versions 

func (o GetDefinitionResultOutput) Versions() pulumi.StringArrayOutput

A list of versions published for this Blueprint Definition.

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 GetPublishedVersionOutputArgs 

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

A collection of arguments for invoking getPublishedVersion.

func (GetPublishedVersionOutputArgs) ElementType 

func (GetPublishedVersionOutputArgs) ElementType() reflect.Type

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/v5/go/azure/blueprint"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := core.LookupSubscription(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
	})
}

```

type GetPublishedVersionResultOutput 

type GetPublishedVersionResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getPublishedVersion.

func GetPublishedVersionOutput 

func GetPublishedVersionOutput(ctx *pulumi.Context, args GetPublishedVersionOutputArgs, opts ...pulumi.InvokeOption) GetPublishedVersionResultOutput

func (GetPublishedVersionResultOutput) BlueprintName 

func (o GetPublishedVersionResultOutput) BlueprintName() pulumi.StringOutput

func (GetPublishedVersionResultOutput) Description 

func (o GetPublishedVersionResultOutput) Description() pulumi.StringOutput

The description of the Blueprint Published Version

func (GetPublishedVersionResultOutput) DisplayName 

func (o GetPublishedVersionResultOutput) DisplayName() pulumi.StringOutput

The display name of the Blueprint Published Version

func (GetPublishedVersionResultOutput) ElementType 

func (GetPublishedVersionResultOutput) ElementType() reflect.Type

func (GetPublishedVersionResultOutput) Id 

func (o GetPublishedVersionResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetPublishedVersionResultOutput) LastModified 

func (o GetPublishedVersionResultOutput) LastModified() pulumi.StringOutput

func (GetPublishedVersionResultOutput) ScopeId 

func (o GetPublishedVersionResultOutput) ScopeId() pulumi.StringOutput

func (GetPublishedVersionResultOutput) TargetScope 

func (o GetPublishedVersionResultOutput) TargetScope() pulumi.StringOutput

The target scope

func (GetPublishedVersionResultOutput) TimeCreated 

func (o GetPublishedVersionResultOutput) TimeCreated() pulumi.StringOutput

func (GetPublishedVersionResultOutput) ToGetPublishedVersionResultOutput 

func (o GetPublishedVersionResultOutput) ToGetPublishedVersionResultOutput() GetPublishedVersionResultOutput

func (GetPublishedVersionResultOutput) ToGetPublishedVersionResultOutputWithContext 

func (o GetPublishedVersionResultOutput) ToGetPublishedVersionResultOutputWithContext(ctx context.Context) GetPublishedVersionResultOutput

func (GetPublishedVersionResultOutput) Type 

func (o GetPublishedVersionResultOutput) Type() pulumi.StringOutput

The type of the Blueprint

func (GetPublishedVersionResultOutput) Version 

func (o GetPublishedVersionResultOutput) Version() pulumi.StringOutput

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.