@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 3.72 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Get metadata information on an assessment type in a specific subscription
*
* Uses Azure REST API version 2021-06-01.
*
* Other available API versions: 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 function getAssessmentMetadataInSubscription(args: GetAssessmentMetadataInSubscriptionArgs, opts?: pulumi.InvokeOptions): Promise<GetAssessmentMetadataInSubscriptionResult>;
export interface GetAssessmentMetadataInSubscriptionArgs {
/**
* The Assessment Key - Unique key for the assessment type
*/
assessmentMetadataName: string;
}
/**
* Security assessment metadata response
*/
export interface GetAssessmentMetadataInSubscriptionResult {
/**
* BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition
*/
readonly assessmentType: string;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
readonly categories?: string[];
/**
* Human readable description of the assessment
*/
readonly description?: string;
/**
* User friendly display name of the assessment
*/
readonly displayName: string;
/**
* Resource Id
*/
readonly id: string;
/**
* The implementation effort required to remediate this assessment
*/
readonly implementationEffort?: string;
/**
* Resource name
*/
readonly name: string;
/**
* Describes the partner that created the assessment
*/
readonly partnerData?: outputs.security.SecurityAssessmentMetadataPartnerDataResponse;
readonly plannedDeprecationDate?: string;
/**
* Azure resource ID of the policy definition that turns this assessment calculation on
*/
readonly policyDefinitionId: string;
/**
* True if this assessment is in preview release status
*/
readonly preview?: boolean;
readonly publishDates?: outputs.security.SecurityAssessmentMetadataPropertiesResponseResponsePublishDates;
/**
* Human readable description of what you should do to mitigate this security issue
*/
readonly remediationDescription?: string;
/**
* The severity level of the assessment
*/
readonly severity: string;
readonly tactics?: string[];
readonly techniques?: string[];
readonly threats?: string[];
/**
* Resource type
*/
readonly type: string;
/**
* The user impact of the assessment
*/
readonly userImpact?: string;
}
/**
* Get metadata information on an assessment type in a specific subscription
*
* Uses Azure REST API version 2021-06-01.
*
* Other available API versions: 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 function getAssessmentMetadataInSubscriptionOutput(args: GetAssessmentMetadataInSubscriptionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetAssessmentMetadataInSubscriptionResult>;
export interface GetAssessmentMetadataInSubscriptionOutputArgs {
/**
* The Assessment Key - Unique key for the assessment type
*/
assessmentMetadataName: pulumi.Input<string>;
}