@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.07 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Security Assignment on a resource group over a given scope
*
* Uses Azure REST API version 2021-08-01-preview. In version 2.x of the Azure Native provider, it used API version 2021-08-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;
/**
* Additional data about the assignment
*/
readonly additionalData: pulumi.Output<outputs.security.AssignmentPropertiesResponseAdditionalData | undefined>;
/**
* Component item with key as applied to this standard assignment over the given scope
*/
readonly assignedComponent: pulumi.Output<outputs.security.AssignedComponentItemResponse | undefined>;
/**
* Standard item with key as applied to this standard assignment over the given scope
*/
readonly assignedStandard: pulumi.Output<outputs.security.AssignedStandardItemResponse | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* description of the standardAssignment
*/
readonly description: pulumi.Output<string | undefined>;
/**
* display name of the standardAssignment
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* expected effect of this assignment (Disable/Exempt/etc)
*/
readonly effect: pulumi.Output<string | undefined>;
/**
* Entity tag is used for comparing two or more entities from the same requested resource.
*/
readonly etag: pulumi.Output<string | undefined>;
/**
* Expiration date of this assignment as a full ISO date
*/
readonly expiresOn: pulumi.Output<string | undefined>;
/**
* Kind of the resource
*/
readonly kind: pulumi.Output<string | undefined>;
/**
* Location where the resource is stored
*/
readonly location: pulumi.Output<string | undefined>;
/**
* The assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.
*/
readonly metadata: pulumi.Output<any | undefined>;
/**
* Resource name
*/
readonly name: pulumi.Output<string>;
/**
* Scope to which the standardAssignment applies - can be a subscription path or a resource group under that subscription
*/
readonly scope: pulumi.Output<string | undefined>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.security.SystemDataResponse>;
/**
* A list of key value pairs that describe the resource.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Resource type
*/
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 {
/**
* Additional data about the assignment
*/
additionalData?: pulumi.Input<inputs.security.AssignmentPropertiesAdditionalDataArgs>;
/**
* Component item with key as applied to this standard assignment over the given scope
*/
assignedComponent?: pulumi.Input<inputs.security.AssignedComponentItemArgs>;
/**
* Standard item with key as applied to this standard assignment over the given scope
*/
assignedStandard?: pulumi.Input<inputs.security.AssignedStandardItemArgs>;
/**
* The security assignment key - unique key for the standard assignment
*/
assignmentId?: pulumi.Input<string>;
/**
* description of the standardAssignment
*/
description?: pulumi.Input<string>;
/**
* display name of the standardAssignment
*/
displayName?: pulumi.Input<string>;
/**
* expected effect of this assignment (Disable/Exempt/etc)
*/
effect?: pulumi.Input<string>;
/**
* Expiration date of this assignment as a full ISO date
*/
expiresOn?: pulumi.Input<string>;
/**
* Kind of the resource
*/
kind?: pulumi.Input<string>;
/**
* Location where the resource is stored
*/
location?: pulumi.Input<string>;
/**
* The assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.
*/
metadata?: any;
/**
* The name of the resource group within the user's subscription. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Scope to which the standardAssignment applies - can be a subscription path or a resource group under that subscription
*/
scope?: pulumi.Input<string>;
/**
* A list of key value pairs that describe the resource.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}