UNPKG

@pulumi/azure-native

Version:

[![Slack](http://www.pulumi.com/images/docs/badges/slack.svg)](https://slack.pulumi.com) [![NPM version](https://badge.fury.io/js/%40pulumi%2Fazure-native.svg)](https://npmjs.com/package/@pulumi/azure-native) [![Python version](https://badge.fury.io/py/pu

122 lines (121 loc) 5.02 kB
import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; import * as enums from "../types/enums"; /** * Custom Recommendation * * Uses Azure REST API version 2024-08-01. In version 2.x of the Azure Native provider, it used API version 2024-08-01. */ export declare class CustomRecommendation extends pulumi.CustomResource { /** * Get an existing CustomRecommendation 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): CustomRecommendation; /** * Returns true if the given object is an instance of CustomRecommendation. 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 CustomRecommendation; /** * The assessment metadata key used when an assessment is generated for this Recommendation. */ readonly assessmentKey: pulumi.Output<string>; /** * The Azure API version of the resource. */ readonly azureApiVersion: pulumi.Output<string>; /** * List of all standard supported clouds. */ readonly cloudProviders: pulumi.Output<string[] | undefined>; /** * The description to relate to the assessments generated by this Recommendation. */ readonly description: pulumi.Output<string | undefined>; /** * The display name of the assessments generated by this Recommendation. */ readonly displayName: pulumi.Output<string | undefined>; /** * Resource name */ readonly name: pulumi.Output<string>; /** * KQL query representing the Recommendation results required. */ readonly query: pulumi.Output<string | undefined>; /** * The remediation description to relate to the assessments generated by this Recommendation. */ readonly remediationDescription: pulumi.Output<string | undefined>; /** * The severity to relate to the assessments generated by this Recommendation. */ readonly securityIssue: pulumi.Output<string | undefined>; /** * The severity to relate to the assessments generated by this Recommendation. */ readonly severity: pulumi.Output<string | undefined>; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ readonly systemData: pulumi.Output<outputs.security.SystemDataResponse>; /** * Resource type */ readonly type: pulumi.Output<string>; /** * Create a CustomRecommendation 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: CustomRecommendationArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a CustomRecommendation resource. */ export interface CustomRecommendationArgs { /** * List of all standard supported clouds. */ cloudProviders?: pulumi.Input<pulumi.Input<string | enums.security.RecommendationSupportedClouds>[]>; /** * Name of the Custom Recommendation. */ customRecommendationName?: pulumi.Input<string>; /** * The description to relate to the assessments generated by this Recommendation. */ description?: pulumi.Input<string>; /** * The display name of the assessments generated by this Recommendation. */ displayName?: pulumi.Input<string>; /** * KQL query representing the Recommendation results required. */ query?: pulumi.Input<string>; /** * The remediation description to relate to the assessments generated by this Recommendation. */ remediationDescription?: pulumi.Input<string>; /** * The scope of the custom recommendation. Valid scopes are: management group (format: 'providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})' */ scope: pulumi.Input<string>; /** * The severity to relate to the assessments generated by this Recommendation. */ securityIssue?: pulumi.Input<string | enums.security.SecurityIssue>; /** * The severity to relate to the assessments generated by this Recommendation. */ severity?: pulumi.Input<string | enums.security.SeverityEnum>; }