All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.azure.resourcemanager.security.models.CustomRecommendation Maven / Gradle / Ivy

Go to download

This package contains Microsoft Azure SDK for Security Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. API spec for Microsoft.Security (Azure Security Center) resource provider. Package tag package-composite-v3.

There is a newer version: 1.0.0
Show newest version
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.security.models;

import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.security.fluent.models.CustomRecommendationInner;
import java.util.List;

/**
 * An immutable client-side representation of CustomRecommendation.
 */
public interface CustomRecommendation {
    /**
     * Gets the id property: Fully qualified resource Id for the resource.
     * 
     * @return the id value.
     */
    String id();

    /**
     * Gets the name property: The name of the resource.
     * 
     * @return the name value.
     */
    String name();

    /**
     * Gets the type property: The type of the resource.
     * 
     * @return the type value.
     */
    String type();

    /**
     * Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
     * 
     * @return the systemData value.
     */
    SystemData systemData();

    /**
     * Gets the query property: KQL query representing the Recommendation results required.
     * 
     * @return the query value.
     */
    String query();

    /**
     * Gets the cloudProviders property: List of all standard supported clouds.
     * 
     * @return the cloudProviders value.
     */
    List cloudProviders();

    /**
     * Gets the severity property: The severity to relate to the assessments generated by this Recommendation.
     * 
     * @return the severity value.
     */
    SeverityEnum severity();

    /**
     * Gets the securityIssue property: The severity to relate to the assessments generated by this Recommendation.
     * 
     * @return the securityIssue value.
     */
    SecurityIssue securityIssue();

    /**
     * Gets the displayName property: The display name of the assessments generated by this Recommendation.
     * 
     * @return the displayName value.
     */
    String displayName();

    /**
     * Gets the description property: The description to relate to the assessments generated by this Recommendation.
     * 
     * @return the description value.
     */
    String description();

    /**
     * Gets the remediationDescription property: The remediation description to relate to the assessments generated by
     * this Recommendation.
     * 
     * @return the remediationDescription value.
     */
    String remediationDescription();

    /**
     * Gets the assessmentKey property: The assessment metadata key used when an assessment is generated for this
     * Recommendation.
     * 
     * @return the assessmentKey value.
     */
    String assessmentKey();

    /**
     * Gets the inner com.azure.resourcemanager.security.fluent.models.CustomRecommendationInner object.
     * 
     * @return the inner object.
     */
    CustomRecommendationInner innerModel();

    /**
     * The entirety of the CustomRecommendation definition.
     */
    interface Definition extends DefinitionStages.Blank, DefinitionStages.WithScope, DefinitionStages.WithCreate {
    }

    /**
     * The CustomRecommendation definition stages.
     */
    interface DefinitionStages {
        /**
         * The first stage of the CustomRecommendation definition.
         */
        interface Blank extends WithScope {
        }

        /**
         * The stage of the CustomRecommendation definition allowing to specify parent resource.
         */
        interface WithScope {
            /**
             * Specifies scope.
             * 
             * @param scope 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})'.
             * @return the next definition stage.
             */
            WithCreate withExistingScope(String scope);
        }

        /**
         * The stage of the CustomRecommendation definition which contains all the minimum required properties for the
         * resource to be created, but also allows for any other optional properties to be specified.
         */
        interface WithCreate extends DefinitionStages.WithQuery, DefinitionStages.WithCloudProviders,
            DefinitionStages.WithSeverity, DefinitionStages.WithSecurityIssue, DefinitionStages.WithDisplayName,
            DefinitionStages.WithDescription, DefinitionStages.WithRemediationDescription {
            /**
             * Executes the create request.
             * 
             * @return the created resource.
             */
            CustomRecommendation create();

            /**
             * Executes the create request.
             * 
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            CustomRecommendation create(Context context);
        }

        /**
         * The stage of the CustomRecommendation definition allowing to specify query.
         */
        interface WithQuery {
            /**
             * Specifies the query property: KQL query representing the Recommendation results required..
             * 
             * @param query KQL query representing the Recommendation results required.
             * @return the next definition stage.
             */
            WithCreate withQuery(String query);
        }

        /**
         * The stage of the CustomRecommendation definition allowing to specify cloudProviders.
         */
        interface WithCloudProviders {
            /**
             * Specifies the cloudProviders property: List of all standard supported clouds..
             * 
             * @param cloudProviders List of all standard supported clouds.
             * @return the next definition stage.
             */
            WithCreate withCloudProviders(List cloudProviders);
        }

        /**
         * The stage of the CustomRecommendation definition allowing to specify severity.
         */
        interface WithSeverity {
            /**
             * Specifies the severity property: The severity to relate to the assessments generated by this
             * Recommendation..
             * 
             * @param severity The severity to relate to the assessments generated by this Recommendation.
             * @return the next definition stage.
             */
            WithCreate withSeverity(SeverityEnum severity);
        }

        /**
         * The stage of the CustomRecommendation definition allowing to specify securityIssue.
         */
        interface WithSecurityIssue {
            /**
             * Specifies the securityIssue property: The severity to relate to the assessments generated by this
             * Recommendation..
             * 
             * @param securityIssue The severity to relate to the assessments generated by this Recommendation.
             * @return the next definition stage.
             */
            WithCreate withSecurityIssue(SecurityIssue securityIssue);
        }

        /**
         * The stage of the CustomRecommendation definition allowing to specify displayName.
         */
        interface WithDisplayName {
            /**
             * Specifies the displayName property: The display name of the assessments generated by this
             * Recommendation..
             * 
             * @param displayName The display name of the assessments generated by this Recommendation.
             * @return the next definition stage.
             */
            WithCreate withDisplayName(String displayName);
        }

        /**
         * The stage of the CustomRecommendation definition allowing to specify description.
         */
        interface WithDescription {
            /**
             * Specifies the description property: The description to relate to the assessments generated by this
             * Recommendation..
             * 
             * @param description The description to relate to the assessments generated by this Recommendation.
             * @return the next definition stage.
             */
            WithCreate withDescription(String description);
        }

        /**
         * The stage of the CustomRecommendation definition allowing to specify remediationDescription.
         */
        interface WithRemediationDescription {
            /**
             * Specifies the remediationDescription property: The remediation description to relate to the assessments
             * generated by this Recommendation..
             * 
             * @param remediationDescription The remediation description to relate to the assessments generated by this
             * Recommendation.
             * @return the next definition stage.
             */
            WithCreate withRemediationDescription(String remediationDescription);
        }
    }

    /**
     * Begins update for the CustomRecommendation resource.
     * 
     * @return the stage of resource update.
     */
    CustomRecommendation.Update update();

    /**
     * The template for CustomRecommendation update.
     */
    interface Update extends UpdateStages.WithQuery, UpdateStages.WithCloudProviders, UpdateStages.WithSeverity,
        UpdateStages.WithSecurityIssue, UpdateStages.WithDisplayName, UpdateStages.WithDescription,
        UpdateStages.WithRemediationDescription {
        /**
         * Executes the update request.
         * 
         * @return the updated resource.
         */
        CustomRecommendation apply();

        /**
         * Executes the update request.
         * 
         * @param context The context to associate with this operation.
         * @return the updated resource.
         */
        CustomRecommendation apply(Context context);
    }

    /**
     * The CustomRecommendation update stages.
     */
    interface UpdateStages {
        /**
         * The stage of the CustomRecommendation update allowing to specify query.
         */
        interface WithQuery {
            /**
             * Specifies the query property: KQL query representing the Recommendation results required..
             * 
             * @param query KQL query representing the Recommendation results required.
             * @return the next definition stage.
             */
            Update withQuery(String query);
        }

        /**
         * The stage of the CustomRecommendation update allowing to specify cloudProviders.
         */
        interface WithCloudProviders {
            /**
             * Specifies the cloudProviders property: List of all standard supported clouds..
             * 
             * @param cloudProviders List of all standard supported clouds.
             * @return the next definition stage.
             */
            Update withCloudProviders(List cloudProviders);
        }

        /**
         * The stage of the CustomRecommendation update allowing to specify severity.
         */
        interface WithSeverity {
            /**
             * Specifies the severity property: The severity to relate to the assessments generated by this
             * Recommendation..
             * 
             * @param severity The severity to relate to the assessments generated by this Recommendation.
             * @return the next definition stage.
             */
            Update withSeverity(SeverityEnum severity);
        }

        /**
         * The stage of the CustomRecommendation update allowing to specify securityIssue.
         */
        interface WithSecurityIssue {
            /**
             * Specifies the securityIssue property: The severity to relate to the assessments generated by this
             * Recommendation..
             * 
             * @param securityIssue The severity to relate to the assessments generated by this Recommendation.
             * @return the next definition stage.
             */
            Update withSecurityIssue(SecurityIssue securityIssue);
        }

        /**
         * The stage of the CustomRecommendation update allowing to specify displayName.
         */
        interface WithDisplayName {
            /**
             * Specifies the displayName property: The display name of the assessments generated by this
             * Recommendation..
             * 
             * @param displayName The display name of the assessments generated by this Recommendation.
             * @return the next definition stage.
             */
            Update withDisplayName(String displayName);
        }

        /**
         * The stage of the CustomRecommendation update allowing to specify description.
         */
        interface WithDescription {
            /**
             * Specifies the description property: The description to relate to the assessments generated by this
             * Recommendation..
             * 
             * @param description The description to relate to the assessments generated by this Recommendation.
             * @return the next definition stage.
             */
            Update withDescription(String description);
        }

        /**
         * The stage of the CustomRecommendation update allowing to specify remediationDescription.
         */
        interface WithRemediationDescription {
            /**
             * Specifies the remediationDescription property: The remediation description to relate to the assessments
             * generated by this Recommendation..
             * 
             * @param remediationDescription The remediation description to relate to the assessments generated by this
             * Recommendation.
             * @return the next definition stage.
             */
            Update withRemediationDescription(String remediationDescription);
        }
    }

    /**
     * Refreshes the resource to sync with Azure.
     * 
     * @return the refreshed resource.
     */
    CustomRecommendation refresh();

    /**
     * Refreshes the resource to sync with Azure.
     * 
     * @param context The context to associate with this operation.
     * @return the refreshed resource.
     */
    CustomRecommendation refresh(Context context);
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy