@pulumi/azure-native/security/getCustomRecommendation.d.ts

[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [![Python version](https://badge.fury.io/py/pu

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Get a specific custom recommendation for the requested scope by customRecommendationName
 *
 * Uses Azure REST API version 2024-08-01.
 */
export declare function getCustomRecommendation(args: GetCustomRecommendationArgs, opts?: pulumi.InvokeOptions): Promise<GetCustomRecommendationResult>;
export interface GetCustomRecommendationArgs {
    /**
     * Name of the Custom Recommendation.
     */
    customRecommendationName: 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: string;
}
/**
 * Custom Recommendation
 */
export interface GetCustomRecommendationResult {
    /**
     * The assessment metadata key used when an assessment is generated for this Recommendation.
     */
    readonly assessmentKey: string;
    /**
     * The Azure API version of the resource.
     */
    readonly azureApiVersion: string;
    /**
     * List of all standard supported clouds.
     */
    readonly cloudProviders?: string[];
    /**
     * The description to relate to the assessments generated by this Recommendation.
     */
    readonly description?: string;
    /**
     * The display name of the assessments generated by this Recommendation.
     */
    readonly displayName?: string;
    /**
     * Resource Id
     */
    readonly id: string;
    /**
     * Resource name
     */
    readonly name: string;
    /**
     * KQL query representing the Recommendation results required.
     */
    readonly query?: string;
    /**
     * The remediation description to relate to the assessments generated by this Recommendation.
     */
    readonly remediationDescription?: string;
    /**
     * The severity to relate to the assessments generated by this Recommendation.
     */
    readonly securityIssue?: string;
    /**
     * The severity to relate to the assessments generated by this Recommendation.
     */
    readonly severity?: string;
    /**
     * Azure Resource Manager metadata containing createdBy and modifiedBy information.
     */
    readonly systemData: outputs.security.SystemDataResponse;
    /**
     * Resource type
     */
    readonly type: string;
}
/**
 * Get a specific custom recommendation for the requested scope by customRecommendationName
 *
 * Uses Azure REST API version 2024-08-01.
 */
export declare function getCustomRecommendationOutput(args: GetCustomRecommendationOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetCustomRecommendationResult>;
export interface GetCustomRecommendationOutputArgs {
    /**
     * Name of the Custom Recommendation.
     */
    customRecommendationName: 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>;
}