Assignment

Create a Assignment Resource

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

def 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);

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

public Assignment(string name, AssignmentArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args AssignmentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AssignmentArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AssignmentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Assignment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Assignment resource accepts the following input properties:

TargetSubscriptionId string: The Subscription ID the Blueprint Published Version is to be applied to.
VersionId string: The ID of the Published Version of the blueprint to be assigned.
Identity AssignmentIdentityArgs
Location string: The Azure location of the Assignment.
LockExcludePrincipals List<string>: a list of up to 5 Principal IDs that are permitted to bypass the locks applied by the Blueprint.
LockMode string: The locking mode of the Blueprint Assignment. One of None (Default), AllResourcesReadOnly, or AlResourcesDoNotDelete.
Name string: The name of the Blueprint Assignment
ParameterValues string: a JSON string to supply Blueprint Assignment parameter values.
ResourceGroups string: a JSON string to supply the Blueprint Resource Group information.

TargetSubscriptionId string: The Subscription ID the Blueprint Published Version is to be applied to.
VersionId string: The ID of the Published Version of the blueprint to be assigned.
Identity AssignmentIdentity
Location string: The Azure location of the Assignment.
LockExcludePrincipals []string: a list of up to 5 Principal IDs that are permitted to bypass the locks applied by the Blueprint.
LockMode string: The locking mode of the Blueprint Assignment. One of None (Default), AllResourcesReadOnly, or AlResourcesDoNotDelete.
Name string: The name of the Blueprint Assignment
ParameterValues string: a JSON string to supply Blueprint Assignment parameter values.
ResourceGroups string: a JSON string to supply the Blueprint Resource Group information.

targetSubscriptionId string: The Subscription ID the Blueprint Published Version is to be applied to.
versionId string: The ID of the Published Version of the blueprint to be assigned.
identity AssignmentIdentity
location string: The Azure location of the Assignment.
lockExcludePrincipals string[]: a list of up to 5 Principal IDs that are permitted to bypass the locks applied by the Blueprint.
lockMode string: The locking mode of the Blueprint Assignment. One of None (Default), AllResourcesReadOnly, or AlResourcesDoNotDelete.
name string: The name of the Blueprint Assignment
parameterValues string: a JSON string to supply Blueprint Assignment parameter values.
resourceGroups string: a JSON string to supply the Blueprint Resource Group information.

target_subscription_id str: The Subscription ID the Blueprint Published Version is to be applied to.
version_id str: The ID of the Published Version of the blueprint to be assigned.
identity Dict[AssignmentIdentity]
location str: The Azure location of the Assignment.
lock_exclude_principals List[str]: a list of up to 5 Principal IDs that are permitted to bypass the locks applied by the Blueprint.
lock_mode str: The locking mode of the Blueprint Assignment. One of None (Default), AllResourcesReadOnly, or AlResourcesDoNotDelete.
name str: The name of the Blueprint Assignment
parameter_values str: a JSON string to supply Blueprint Assignment parameter values.
resource_groups str: a JSON string to supply the Blueprint Resource Group information.

Outputs

All input properties are implicitly available as output properties. Additionally, the Assignment resource produces the following output properties:

BlueprintName string: The name of the blueprint assigned
Description string: The Description on the Blueprint
DisplayName string: The display name of the blueprint
Id string: The provider-assigned unique ID for this managed resource.
Type string: The Identity type for the Managed Service Identity. Currently only UserAssigned is supported.

BlueprintName string: The name of the blueprint assigned
Description string: The Description on the Blueprint
DisplayName string: The display name of the blueprint
Id string: The provider-assigned unique ID for this managed resource.
Type string: The Identity type for the Managed Service Identity. Currently only UserAssigned is supported.

blueprintName string: The name of the blueprint assigned
description string: The Description on the Blueprint
displayName string: The display name of the blueprint
id string: The provider-assigned unique ID for this managed resource.
type string: The Identity type for the Managed Service Identity. Currently only UserAssigned is supported.

blueprint_name str: The name of the blueprint assigned
description str: The Description on the Blueprint
display_name str: The display name of the blueprint
id str: The provider-assigned unique ID for this managed resource.
type str: The Identity type for the Managed Service Identity. Currently only UserAssigned is supported.

Look up an Existing Assignment Resource

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

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

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, __props__=None);

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

public static Assignment Get(string name, Input<string> id, AssignmentState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

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

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

blueprintName string: The name of the blueprint assigned
description string: The Description on the Blueprint
displayName string: The display name of the blueprint
identity AssignmentIdentity
location string: The Azure location of the Assignment.
lockExcludePrincipals string[]: a list of up to 5 Principal IDs that are permitted to bypass the locks applied by the Blueprint.
lockMode string: The locking mode of the Blueprint Assignment. One of None (Default), AllResourcesReadOnly, or AlResourcesDoNotDelete.
name string: The name of the Blueprint Assignment
parameterValues string: a JSON string to supply Blueprint Assignment parameter values.
resourceGroups string: a JSON string to supply the Blueprint Resource Group information.
targetSubscriptionId string: The Subscription ID the Blueprint Published Version is to be applied to.
type string: The Identity type for the Managed Service Identity. Currently only UserAssigned is supported.
versionId string: The ID of the Published Version of the blueprint to be assigned.

blueprint_name str: The name of the blueprint assigned
description str: The Description on the Blueprint
display_name str: The display name of the blueprint
identity Dict[AssignmentIdentity]
location str: The Azure location of the Assignment.
lock_exclude_principals List[str]: a list of up to 5 Principal IDs that are permitted to bypass the locks applied by the Blueprint.
lock_mode str: The locking mode of the Blueprint Assignment. One of None (Default), AllResourcesReadOnly, or AlResourcesDoNotDelete.
name str: The name of the Blueprint Assignment
parameter_values str: a JSON string to supply Blueprint Assignment parameter values.
resource_groups str: a JSON string to supply the Blueprint Resource Group information.
target_subscription_id str: The Subscription ID the Blueprint Published Version is to be applied to.
type str: The Identity type for the Managed Service Identity. Currently only UserAssigned is supported.
version_id str: The ID of the Published Version of the blueprint to be assigned.

Supporting Types

AssignmentIdentity

See the input and output API doc for this type.

IdentityIds List<string>
Type string: The Identity type for the Managed Service Identity. Currently only UserAssigned is supported.
PrincipalId string
TenantId string

IdentityIds []string
Type string: The Identity type for the Managed Service Identity. Currently only UserAssigned is supported.
PrincipalId string
TenantId string

identityIds string[]
type string: The Identity type for the Managed Service Identity. Currently only UserAssigned is supported.
principalId string
tenantId string

identityIds List[str]
type str: The Identity type for the Managed Service Identity. Currently only UserAssigned is supported.
principal_id str
tenant_id str

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud