1. Docs
  2. Reference
  3. API
  4. @pulumi/azure
  5. blueprint

Module blueprint

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Functions

Others

Resources

Resource Assignment

class Assignment extends CustomResource

constructor

new Assignment(name: string, args: AssignmentArgs, opts?: pulumi.CustomResourceOptions)

Create a Assignment resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AssignmentState, opts?: pulumi.CustomResourceOptions): Assignment

Get an existing Assignment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Assignment

Returns true if the given object is an instance of Assignment. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property blueprintName

public blueprintName: pulumi.Output<string>;

The name of the blueprint assigned

property description

public description: pulumi.Output<string>;

The Description on the Blueprint

property displayName

public displayName: pulumi.Output<string>;

The display name of the blueprint

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property identity

public identity: pulumi.Output<AssignmentIdentity | undefined>;

property location

public location: pulumi.Output<string>;

The Azure location of the Assignment.

property lockExcludePrincipals

public lockExcludePrincipals: pulumi.Output<string[] | undefined>;

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

property lockMode

public lockMode: pulumi.Output<string | undefined>;

The locking mode of the Blueprint Assignment. One of None (Default), AllResourcesReadOnly, or AlResourcesDoNotDelete.

property name

public name: pulumi.Output<string>;

The name of the Blueprint Assignment

property parameterValues

public parameterValues: pulumi.Output<string | undefined>;

a JSON string to supply Blueprint Assignment parameter values.

property resourceGroups

public resourceGroups: pulumi.Output<string | undefined>;

a JSON string to supply the Blueprint Resource Group information.

property targetSubscriptionId

public targetSubscriptionId: pulumi.Output<string>;

The Subscription ID the Blueprint Published Version is to be applied to.

property type

public type: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property versionId

public versionId: pulumi.Output<string>;

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

Functions

Function getDefinition

getDefinition(args: GetDefinitionArgs, opts?: pulumi.InvokeOptions): Promise<GetDefinitionResult>

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

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const current = azure.core.getClientConfig({});
const root = current.then(current => azure.management.getGroup({
    name: current.tenantId,
}));
const example = root.then(root => azure.blueprint.getDefinition({
    name: "exampleManagementGroupBP",
    scopeId: root.id,
}));

Function getPublishedVersion

getPublishedVersion(args: GetPublishedVersionArgs, opts?: pulumi.InvokeOptions): Promise<GetPublishedVersionResult>

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

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const current = azure.core.getSubscription({});
const test = current.then(current => azure.blueprint.getPublishedVersion({
    scopeId: current.id,
    blueprintName: "exampleBluePrint",
    version: "dev_v2.3",
}));

Others

interface AssignmentArgs

interface AssignmentArgs

The set of arguments for constructing a Assignment resource.

property identity

identity?: pulumi.Input<AssignmentIdentity>;

property location

location?: pulumi.Input<string>;

The Azure location of the Assignment.

property lockExcludePrincipals

lockExcludePrincipals?: pulumi.Input<pulumi.Input<string>[]>;

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

property lockMode

lockMode?: pulumi.Input<string>;

The locking mode of the Blueprint Assignment. One of None (Default), AllResourcesReadOnly, or AlResourcesDoNotDelete.

property name

name?: pulumi.Input<string>;

The name of the Blueprint Assignment

property parameterValues

parameterValues?: pulumi.Input<string>;

a JSON string to supply Blueprint Assignment parameter values.

property resourceGroups

resourceGroups?: pulumi.Input<string>;

a JSON string to supply the Blueprint Resource Group information.

property targetSubscriptionId

targetSubscriptionId: pulumi.Input<string>;

The Subscription ID the Blueprint Published Version is to be applied to.

property versionId

versionId: pulumi.Input<string>;

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

interface AssignmentState

interface AssignmentState

Input properties used for looking up and filtering Assignment resources.

property blueprintName

blueprintName?: pulumi.Input<string>;

The name of the blueprint assigned

property description

description?: pulumi.Input<string>;

The Description on the Blueprint

property displayName

displayName?: pulumi.Input<string>;

The display name of the blueprint

property identity

identity?: pulumi.Input<AssignmentIdentity>;

property location

location?: pulumi.Input<string>;

The Azure location of the Assignment.

property lockExcludePrincipals

lockExcludePrincipals?: pulumi.Input<pulumi.Input<string>[]>;

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

property lockMode

lockMode?: pulumi.Input<string>;

The locking mode of the Blueprint Assignment. One of None (Default), AllResourcesReadOnly, or AlResourcesDoNotDelete.

property name

name?: pulumi.Input<string>;

The name of the Blueprint Assignment

property parameterValues

parameterValues?: pulumi.Input<string>;

a JSON string to supply Blueprint Assignment parameter values.

property resourceGroups

resourceGroups?: pulumi.Input<string>;

a JSON string to supply the Blueprint Resource Group information.

property targetSubscriptionId

targetSubscriptionId?: pulumi.Input<string>;

The Subscription ID the Blueprint Published Version is to be applied to.

property type

type?: pulumi.Input<string>;

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

property versionId

versionId?: pulumi.Input<string>;

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

interface GetDefinitionArgs

interface GetDefinitionArgs

A collection of arguments for invoking getDefinition.

property name

name: string;

The name of the Blueprint

property scopeId

scopeId: string;

The Resource ID of the scope at which the blueprint definition is stored. This will be with either a Subscription ID or Management Group ID.

interface GetDefinitionResult

interface GetDefinitionResult

A collection of values returned by getDefinition.

property description

description: string;

The description of the Blueprint Definition.

property displayName

displayName: string;

The display name of the Blueprint Definition.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property lastModified

lastModified: string;

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

property name

name: string;

property scopeId

scopeId: string;

property targetScope

targetScope: string;

The target scope.

property timeCreated

timeCreated: string;

The timestamp of when this Blueprint Definition was created.

property versions

versions: string[];

A list of versions published for this Blueprint Definition.

interface GetPublishedVersionArgs

interface GetPublishedVersionArgs

A collection of arguments for invoking getPublishedVersion.

property blueprintName

blueprintName: string;

The name of the Blueprint Definition

property scopeId

scopeId: string;

The Resource ID of the scope where the Blueprint Definition is stored. This will be with either a Subscription ID or Management Group ID.

property version

version: string;

The Version name of the Published Version of the Blueprint Definition

interface GetPublishedVersionResult

interface GetPublishedVersionResult

A collection of values returned by getPublishedVersion.

property blueprintName

blueprintName: string;

property description

description: string;

The description of the Blueprint Published Version

property displayName

displayName: string;

The display name of the Blueprint Published Version

property id

id: string;

The provider-assigned unique ID for this managed resource.

property lastModified

lastModified: string;

property scopeId

scopeId: string;

property targetScope

targetScope: string;

The target scope

property timeCreated

timeCreated: string;

property type

type: string;

The type of the Blueprint

property version

version: string;