@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 5.35 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Represents a blueprint assignment.
*
* Uses Azure REST API version 2018-11-01-preview. In version 2.x of the Azure Native provider, it used API version 2018-11-01-preview.
*/
export declare class Assignment extends pulumi.CustomResource {
/**
* Get an existing Assignment resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): 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.
*/
static isInstance(obj: any): obj is Assignment;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* ID of the published version of a blueprint definition.
*/
readonly blueprintId: pulumi.Output<string | undefined>;
/**
* Multi-line explain this resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* One-liner string explain this resource.
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* Managed identity for this blueprint assignment.
*/
readonly identity: pulumi.Output<outputs.blueprint.ManagedServiceIdentityResponse>;
/**
* The location of this blueprint assignment.
*/
readonly location: pulumi.Output<string>;
/**
* Defines how resources deployed by a blueprint assignment are locked.
*/
readonly locks: pulumi.Output<outputs.blueprint.AssignmentLockSettingsResponse | undefined>;
/**
* Name of this resource.
*/
readonly name: pulumi.Output<string>;
/**
* Blueprint assignment parameter values.
*/
readonly parameters: pulumi.Output<{
[key: string]: outputs.blueprint.ParameterValueResponse;
}>;
/**
* State of the blueprint assignment.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Names and locations of resource group placeholders.
*/
readonly resourceGroups: pulumi.Output<{
[key: string]: outputs.blueprint.ResourceGroupValueResponse;
}>;
/**
* The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required.
*/
readonly scope: pulumi.Output<string | undefined>;
/**
* Status of blueprint assignment. This field is readonly.
*/
readonly status: pulumi.Output<outputs.blueprint.AssignmentStatusResponse>;
/**
* Type of this resource.
*/
readonly type: pulumi.Output<string>;
/**
* Create a Assignment resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: AssignmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Assignment resource.
*/
export interface AssignmentArgs {
/**
* Name of the blueprint assignment.
*/
assignmentName?: pulumi.Input<string>;
/**
* ID of the published version of a blueprint definition.
*/
blueprintId?: pulumi.Input<string>;
/**
* Multi-line explain this resource.
*/
description?: pulumi.Input<string>;
/**
* One-liner string explain this resource.
*/
displayName?: pulumi.Input<string>;
/**
* Managed identity for this blueprint assignment.
*/
identity: pulumi.Input<inputs.blueprint.ManagedServiceIdentityArgs>;
/**
* The location of this blueprint assignment.
*/
location?: pulumi.Input<string>;
/**
* Defines how resources deployed by a blueprint assignment are locked.
*/
locks?: pulumi.Input<inputs.blueprint.AssignmentLockSettingsArgs>;
/**
* Blueprint assignment parameter values.
*/
parameters: pulumi.Input<{
[key: string]: pulumi.Input<inputs.blueprint.ParameterValueArgs>;
}>;
/**
* Names and locations of resource group placeholders.
*/
resourceGroups: pulumi.Input<{
[key: string]: pulumi.Input<inputs.blueprint.ResourceGroupValueArgs>;
}>;
/**
* The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
*/
resourceScope: pulumi.Input<string>;
/**
* The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required.
*/
scope?: pulumi.Input<string>;
}