@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.45 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Security assessment on a resource - response format
*
* Uses Azure REST API version 2021-06-01. In version 2.x of the Azure Native provider, it used API version 2021-06-01.
*
* Other available API versions: 2019-01-01-preview, 2020-01-01, 2025-05-04-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native security [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Assessment extends pulumi.CustomResource {
/**
* Get an existing Assessment 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): Assessment;
/**
* Returns true if the given object is an instance of Assessment. 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 Assessment;
/**
* Additional data regarding the assessment
*/
readonly additionalData: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* User friendly display name of the assessment
*/
readonly displayName: pulumi.Output<string>;
/**
* Links relevant to the assessment
*/
readonly links: pulumi.Output<outputs.security.AssessmentLinksResponse>;
/**
* Describes properties of an assessment metadata.
*/
readonly metadata: pulumi.Output<outputs.security.SecurityAssessmentMetadataPropertiesResponse | undefined>;
/**
* Resource name
*/
readonly name: pulumi.Output<string>;
/**
* Data regarding 3rd party partner integration
*/
readonly partnersData: pulumi.Output<outputs.security.SecurityAssessmentPartnerDataResponse | undefined>;
/**
* Details of the resource that was assessed
*/
readonly resourceDetails: pulumi.Output<outputs.security.AzureResourceDetailsResponse | outputs.security.OnPremiseResourceDetailsResponse | outputs.security.OnPremiseSqlResourceDetailsResponse>;
/**
* The result of the assessment
*/
readonly status: pulumi.Output<outputs.security.AssessmentStatusResponseResponse>;
/**
* Resource type
*/
readonly type: pulumi.Output<string>;
/**
* Create a Assessment 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: AssessmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Assessment resource.
*/
export interface AssessmentArgs {
/**
* Additional data regarding the assessment
*/
additionalData?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The Assessment Key - Unique key for the assessment type
*/
assessmentName?: pulumi.Input<string>;
/**
* Describes properties of an assessment metadata.
*/
metadata?: pulumi.Input<inputs.security.SecurityAssessmentMetadataPropertiesArgs>;
/**
* Data regarding 3rd party partner integration
*/
partnersData?: pulumi.Input<inputs.security.SecurityAssessmentPartnerDataArgs>;
/**
* Details of the resource that was assessed
*/
resourceDetails: pulumi.Input<inputs.security.AzureResourceDetailsArgs | inputs.security.OnPremiseResourceDetailsArgs | inputs.security.OnPremiseSqlResourceDetailsArgs>;
/**
* The identifier of the resource.
*/
resourceId: pulumi.Input<string>;
/**
* The result of the assessment
*/
status: pulumi.Input<inputs.security.AssessmentStatusArgs>;
}