blueprint¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.blueprint.Assignment(resource_name, opts=None, identity=None, location=None, lock_exclude_principals=None, lock_mode=None, name=None, parameter_values=None, resource_groups=None, target_subscription_id=None, version_id=None, __props__=None, __name__=None, __opts__=None)¶

Create a Assignment resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] location: The Azure location of the Assignment. :param pulumi.Input[list] lock_exclude_principals: a list of up to 5 Principal IDs that are permitted to bypass the locks applied by the Blueprint. :param pulumi.Input[str] lock_mode: The locking mode of the Blueprint Assignment. One of None (Default), AllResourcesReadOnly, or AlResourcesDoNotDelete. :param pulumi.Input[str] name: The name of the Blueprint Assignment :param pulumi.Input[str] parameter_values: a JSON string to supply Blueprint Assignment parameter values. :param pulumi.Input[str] resource_groups: a JSON string to supply the Blueprint Resource Group information. :param pulumi.Input[str] target_subscription_id: The Subscription ID the Blueprint Published Version is to be applied to. :param pulumi.Input[str] version_id: The ID of the Published Version of the blueprint to be assigned.

The identity object supports the following:

• identityIds (pulumi.Input[list])

• principal_id (pulumi.Input[str])

• tenant_id (pulumi.Input[str])

• type (pulumi.Input[str]) - The Identity type for the Managed Service Identity. Currently only UserAssigned is supported.

blueprint_name: pulumi.Output[str] = None¶

The name of the blueprint assigned

description: pulumi.Output[str] = None¶

The Description on the Blueprint

display_name: pulumi.Output[str] = None¶

The display name of the blueprint

location: pulumi.Output[str] = None¶

The Azure location of the Assignment.

lock_exclude_principals: pulumi.Output[list] = None¶

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

lock_mode: pulumi.Output[str] = None¶

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

name: pulumi.Output[str] = None¶

The name of the Blueprint Assignment

parameter_values: pulumi.Output[str] = None¶

a JSON string to supply Blueprint Assignment parameter values.

resource_groups: pulumi.Output[str] = None¶

a JSON string to supply the Blueprint Resource Group information.

target_subscription_id: pulumi.Output[str] = None¶

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

type: pulumi.Output[str] = None¶

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

version_id: pulumi.Output[str] = None¶

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

static get(resource_name, id, opts=None, blueprint_name=None, description=None, display_name=None, identity=None, location=None, lock_exclude_principals=None, lock_mode=None, name=None, parameter_values=None, resource_groups=None, target_subscription_id=None, type=None, version_id=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• blueprint_name (pulumi.Input[str]) – The name of the blueprint assigned

• description (pulumi.Input[str]) – The Description on the Blueprint

• display_name (pulumi.Input[str]) – The display name of the blueprint

• location (pulumi.Input[str]) – The Azure location of the Assignment.

• lock_exclude_principals (pulumi.Input[list]) – a list of up to 5 Principal IDs that are permitted to bypass the locks applied by the Blueprint.

• lock_mode (pulumi.Input[str]) – The locking mode of the Blueprint Assignment. One of None (Default), AllResourcesReadOnly, or AlResourcesDoNotDelete.

• name (pulumi.Input[str]) – The name of the Blueprint Assignment

• parameter_values (pulumi.Input[str]) – a JSON string to supply Blueprint Assignment parameter values.

• resource_groups (pulumi.Input[str]) – a JSON string to supply the Blueprint Resource Group information.

• target_subscription_id (pulumi.Input[str]) – The Subscription ID the Blueprint Published Version is to be applied to.

• type (pulumi.Input[str]) – The Identity type for the Managed Service Identity. Currently only UserAssigned is supported.

• version_id (pulumi.Input[str]) – The ID of the Published Version of the blueprint to be assigned.

The identity object supports the following:

• identityIds (pulumi.Input[list])

• principal_id (pulumi.Input[str])

• tenant_id (pulumi.Input[str])

• type (pulumi.Input[str]) - The Identity type for the Managed Service Identity. Currently only UserAssigned is supported.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.blueprint.AwaitableGetDefinitionResult(description=None, display_name=None, id=None, last_modified=None, name=None, scope_id=None, target_scope=None, time_created=None, versions=None)¶

class pulumi_azure.blueprint.AwaitableGetPublishedVersionResult(blueprint_name=None, description=None, display_name=None, id=None, last_modified=None, scope_id=None, target_scope=None, time_created=None, type=None, version=None)¶

class pulumi_azure.blueprint.GetDefinitionResult(description=None, display_name=None, id=None, last_modified=None, name=None, scope_id=None, target_scope=None, time_created=None, versions=None)¶

A collection of values returned by getDefinition.

description = None¶

The description of the Blueprint Definition.

display_name = None¶

The display name of the Blueprint Definition.

id = None¶

The provider-assigned unique ID for this managed resource.

last_modified = None¶

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

target_scope = None¶

The target scope.

time_created = None¶

The timestamp of when this Blueprint Definition was created.

versions = None¶

A list of versions published for this Blueprint Definition.

class pulumi_azure.blueprint.GetPublishedVersionResult(blueprint_name=None, description=None, display_name=None, id=None, last_modified=None, scope_id=None, target_scope=None, time_created=None, type=None, version=None)¶

A collection of values returned by getPublishedVersion.

description = None¶

The description of the Blueprint Published Version

display_name = None¶

The display name of the Blueprint Published Version

id = None¶

The provider-assigned unique ID for this managed resource.

target_scope = None¶

The target scope

type = None¶

The type of the Blueprint

pulumi_azure.blueprint.get_definition(name=None, scope_id=None, opts=None)¶

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.

import pulumi
import pulumi_azure as azure

current = azure.core.get_client_config()
root = azure.management.get_group(name=current.tenant_id)
example = azure.blueprint.get_definition(name="exampleManagementGroupBP",
    scope_id=root.id)

Parameters

• name (str) – The name of the Blueprint

• scope_id (str) – 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.

pulumi_azure.blueprint.get_published_version(blueprint_name=None, scope_id=None, version=None, opts=None)¶

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.

import pulumi
import pulumi_azure as azure

current = azure.core.get_subscription()
test = azure.blueprint.get_published_version(scope_id=current.id,
    blueprint_name="exampleBluePrint",
    version="dev_v2.3")

Parameters

• blueprint_name (str) – The name of the Blueprint Definition

• scope_id (str) – The Resource ID of the scope where the Blueprint Definition is stored. This will be with either a Subscription ID or Management Group ID.

• version (str) – The Version name of the Published Version of the Blueprint Definition