@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.39 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Represents a Blueprint definition.
*
* 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 Blueprint extends pulumi.CustomResource {
/**
* Get an existing Blueprint 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): Blueprint;
/**
* Returns true if the given object is an instance of Blueprint. 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 Blueprint;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Multi-line explain this resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* One-liner string explain this resource.
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* Layout view of the blueprint definition for UI reference.
*/
readonly layout: pulumi.Output<any>;
/**
* Name of this resource.
*/
readonly name: pulumi.Output<string>;
/**
* Parameters required by this blueprint definition.
*/
readonly parameters: pulumi.Output<{
[key: string]: outputs.blueprint.ParameterDefinitionResponse;
} | undefined>;
/**
* Resource group placeholders defined by this blueprint definition.
*/
readonly resourceGroups: pulumi.Output<{
[key: string]: outputs.blueprint.ResourceGroupDefinitionResponse;
} | undefined>;
/**
* Status of the blueprint. This field is readonly.
*/
readonly status: pulumi.Output<outputs.blueprint.BlueprintStatusResponse>;
/**
* The scope where this blueprint definition can be assigned.
*/
readonly targetScope: pulumi.Output<string>;
/**
* Type of this resource.
*/
readonly type: pulumi.Output<string>;
/**
* Published versions of this blueprint definition.
*/
readonly versions: pulumi.Output<any | undefined>;
/**
* Create a Blueprint 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: BlueprintArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Blueprint resource.
*/
export interface BlueprintArgs {
/**
* Name of the blueprint definition.
*/
blueprintName?: pulumi.Input<string>;
/**
* Multi-line explain this resource.
*/
description?: pulumi.Input<string>;
/**
* One-liner string explain this resource.
*/
displayName?: pulumi.Input<string>;
/**
* Parameters required by this blueprint definition.
*/
parameters?: pulumi.Input<{
[key: string]: pulumi.Input<inputs.blueprint.ParameterDefinitionArgs>;
}>;
/**
* Resource group placeholders defined by this blueprint definition.
*/
resourceGroups?: pulumi.Input<{
[key: string]: pulumi.Input<inputs.blueprint.ResourceGroupDefinitionArgs>;
}>;
/**
* 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 scope where this blueprint definition can be assigned.
*/
targetScope: pulumi.Input<string | enums.blueprint.BlueprintTargetScope>;
/**
* Published versions of this blueprint definition.
*/
versions?: any;
}