Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. security
  5. getCustomRecommendation
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.security.getCustomRecommendation

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

    Get a specific custom recommendation for the requested scope by customRecommendationName Azure REST API version: 2024-08-01.

    Using getCustomRecommendation

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCustomRecommendation(args: GetCustomRecommendationArgs, opts?: InvokeOptions): Promise<GetCustomRecommendationResult>
function getCustomRecommendationOutput(args: GetCustomRecommendationOutputArgs, opts?: InvokeOptions): Output<GetCustomRecommendationResult>
    def get_custom_recommendation(custom_recommendation_name: Optional[str] = None,
                              scope: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetCustomRecommendationResult
def get_custom_recommendation_output(custom_recommendation_name: Optional[pulumi.Input[str]] = None,
                              scope: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetCustomRecommendationResult]
    func LookupCustomRecommendation(ctx *Context, args *LookupCustomRecommendationArgs, opts ...InvokeOption) (*LookupCustomRecommendationResult, error)
func LookupCustomRecommendationOutput(ctx *Context, args *LookupCustomRecommendationOutputArgs, opts ...InvokeOption) LookupCustomRecommendationResultOutput

    > Note: This function is named LookupCustomRecommendation in the Go SDK.

    public static class GetCustomRecommendation 
{
    public static Task<GetCustomRecommendationResult> InvokeAsync(GetCustomRecommendationArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomRecommendationResult> Invoke(GetCustomRecommendationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCustomRecommendationResult> getCustomRecommendation(GetCustomRecommendationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:security:getCustomRecommendation
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CustomRecommendationName string
    Name of the Custom Recommendation.
    Scope 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})'
    CustomRecommendationName string
    Name of the Custom Recommendation.
    Scope 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})'
    customRecommendationName String
    Name of the Custom Recommendation.
    scope 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})'
    customRecommendationName string
    Name of the Custom Recommendation.
    scope 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})'
    custom_recommendation_name str
    Name of the Custom Recommendation.
    scope str
    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})'
    customRecommendationName String
    Name of the Custom Recommendation.
    scope 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})'

    getCustomRecommendation Result

    The following output properties are available:

    AssessmentKey string
    The assessment metadata key used when an assessment is generated for this Recommendation.
    Id string
    Resource Id
    Name string
    Resource name
    SystemData Pulumi.AzureNative.Security.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    Resource type
    CloudProviders List<string>
    List of all standard supported clouds.
    Description string
    The description to relate to the assessments generated by this Recommendation.
    DisplayName string
    The display name of the assessments generated by this Recommendation.
    Query string
    KQL query representing the Recommendation results required.
    RemediationDescription string
    The remediation description to relate to the assessments generated by this Recommendation.
    SecurityIssue string
    The severity to relate to the assessments generated by this Recommendation.
    Severity string
    The severity to relate to the assessments generated by this Recommendation.
    AssessmentKey string
    The assessment metadata key used when an assessment is generated for this Recommendation.
    Id string
    Resource Id
    Name string
    Resource name
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    Resource type
    CloudProviders []string
    List of all standard supported clouds.
    Description string
    The description to relate to the assessments generated by this Recommendation.
    DisplayName string
    The display name of the assessments generated by this Recommendation.
    Query string
    KQL query representing the Recommendation results required.
    RemediationDescription string
    The remediation description to relate to the assessments generated by this Recommendation.
    SecurityIssue string
    The severity to relate to the assessments generated by this Recommendation.
    Severity string
    The severity to relate to the assessments generated by this Recommendation.
    assessmentKey String
    The assessment metadata key used when an assessment is generated for this Recommendation.
    id String
    Resource Id
    name String
    Resource name
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    Resource type
    cloudProviders List<String>
    List of all standard supported clouds.
    description String
    The description to relate to the assessments generated by this Recommendation.
    displayName String
    The display name of the assessments generated by this Recommendation.
    query String
    KQL query representing the Recommendation results required.
    remediationDescription String
    The remediation description to relate to the assessments generated by this Recommendation.
    securityIssue String
    The severity to relate to the assessments generated by this Recommendation.
    severity String
    The severity to relate to the assessments generated by this Recommendation.
    assessmentKey string
    The assessment metadata key used when an assessment is generated for this Recommendation.
    id string
    Resource Id
    name string
    Resource name
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    Resource type
    cloudProviders string[]
    List of all standard supported clouds.
    description string
    The description to relate to the assessments generated by this Recommendation.
    displayName string
    The display name of the assessments generated by this Recommendation.
    query string
    KQL query representing the Recommendation results required.
    remediationDescription string
    The remediation description to relate to the assessments generated by this Recommendation.
    securityIssue string
    The severity to relate to the assessments generated by this Recommendation.
    severity string
    The severity to relate to the assessments generated by this Recommendation.
    assessment_key str
    The assessment metadata key used when an assessment is generated for this Recommendation.
    id str
    Resource Id
    name str
    Resource name
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    Resource type
    cloud_providers Sequence[str]
    List of all standard supported clouds.
    description str
    The description to relate to the assessments generated by this Recommendation.
    display_name str
    The display name of the assessments generated by this Recommendation.
    query str
    KQL query representing the Recommendation results required.
    remediation_description str
    The remediation description to relate to the assessments generated by this Recommendation.
    security_issue str
    The severity to relate to the assessments generated by this Recommendation.
    severity str
    The severity to relate to the assessments generated by this Recommendation.
    assessmentKey String
    The assessment metadata key used when an assessment is generated for this Recommendation.
    id String
    Resource Id
    name String
    Resource name
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    Resource type
    cloudProviders List<String>
    List of all standard supported clouds.
    description String
    The description to relate to the assessments generated by this Recommendation.
    displayName String
    The display name of the assessments generated by this Recommendation.
    query String
    KQL query representing the Recommendation results required.
    remediationDescription String
    The remediation description to relate to the assessments generated by this Recommendation.
    securityIssue String
    The severity to relate to the assessments generated by this Recommendation.
    severity String
    The severity to relate to the assessments generated by this Recommendation.

    Supporting Types

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-azure-native