@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.37 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Blueprint artifact that applies a Role 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 RoleAssignmentArtifact extends pulumi.CustomResource {
/**
* Get an existing RoleAssignmentArtifact 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): RoleAssignmentArtifact;
/**
* Returns true if the given object is an instance of RoleAssignmentArtifact. 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 RoleAssignmentArtifact;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Artifacts which need to be deployed before the specified artifact.
*/
readonly dependsOn: 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>;
/**
* Specifies the kind of blueprint artifact.
* Expected value is 'roleAssignment'.
*/
readonly kind: pulumi.Output<"roleAssignment">;
/**
* Name of this resource.
*/
readonly name: pulumi.Output<string>;
/**
* Array of user or group identities in Azure Active Directory. The roleDefinition will apply to each identity.
*/
readonly principalIds: pulumi.Output<any>;
/**
* RoleAssignment will be scope to this resourceGroup. If empty, it scopes to the subscription.
*/
readonly resourceGroup: pulumi.Output<string | undefined>;
/**
* Azure resource ID of the RoleDefinition.
*/
readonly roleDefinitionId: pulumi.Output<string>;
/**
* Type of this resource.
*/
readonly type: pulumi.Output<string>;
/**
* Create a RoleAssignmentArtifact 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: RoleAssignmentArtifactArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a RoleAssignmentArtifact resource.
*/
export interface RoleAssignmentArtifactArgs {
/**
* Name of the blueprint artifact.
*/
artifactName?: pulumi.Input<string>;
/**
* Name of the blueprint definition.
*/
blueprintName: pulumi.Input<string>;
/**
* Artifacts which need to be deployed before the specified artifact.
*/
dependsOn?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Multi-line explain this resource.
*/
description?: pulumi.Input<string>;
/**
* One-liner string explain this resource.
*/
displayName?: pulumi.Input<string>;
/**
* Specifies the kind of blueprint artifact.
* Expected value is 'roleAssignment'.
*/
kind: pulumi.Input<"roleAssignment">;
/**
* Array of user or group identities in Azure Active Directory. The roleDefinition will apply to each identity.
*/
principalIds: any;
/**
* RoleAssignment will be scope to this resourceGroup. If empty, it scopes to the subscription.
*/
resourceGroup?: pulumi.Input<string>;
/**
* The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').
*/
resourceScope: pulumi.Input<string>;
/**
* Azure resource ID of the RoleDefinition.
*/
roleDefinitionId: pulumi.Input<string>;
}