@microsoft/msgraph-beta-sdk-security/security/rules/detectionRules/index.d.ts

Security fluent API for Microsoft Graph

import { type DetectionRule, type DetectionRuleCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/security/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type DetectionRuleItemRequestBuilder } from './item/index.js';
import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
 * Provides operations to manage the detectionRules property of the microsoft.graph.security.rulesRoot entity.
 */
export interface DetectionRulesRequestBuilder extends BaseRequestBuilder<DetectionRulesRequestBuilder> {
    /**
     * Provides operations to count the resources in the collection.
     */
    get count(): CountRequestBuilder;
    /**
     * Provides operations to manage the detectionRules property of the microsoft.graph.security.rulesRoot entity.
     * @param detectionRuleId The unique identifier of detectionRule
     * @returns {DetectionRuleItemRequestBuilder}
     */
    byDetectionRuleId(detectionRuleId: string): DetectionRuleItemRequestBuilder;
    /**
     * Get a list of custom detection rules.With custom detections, you can proactively monitor for and respond to various events and system states, including suspected breach activity and misconfigured assets in their organization network.Custom detection rules, which are written in Kusto query language (KQL), automatically trigger alerts and response actions once there are events matching their KQL queries.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<DetectionRuleCollectionResponse>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/security-detectionrule-list?view=graph-rest-beta|Find more info here}
     */
    get(requestConfiguration?: RequestConfiguration<DetectionRulesRequestBuilderGetQueryParameters> | undefined): Promise<DetectionRuleCollectionResponse | undefined>;
    /**
     * Create new navigation property to detectionRules for security
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<DetectionRule>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     */
    post(body: DetectionRule, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<DetectionRule | undefined>;
    /**
     * Get a list of custom detection rules.With custom detections, you can proactively monitor for and respond to various events and system states, including suspected breach activity and misconfigured assets in their organization network.Custom detection rules, which are written in Kusto query language (KQL), automatically trigger alerts and response actions once there are events matching their KQL queries.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<DetectionRulesRequestBuilderGetQueryParameters> | undefined): RequestInformation;
    /**
     * Create new navigation property to detectionRules for security
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toPostRequestInformation(body: DetectionRule, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
 * Get a list of custom detection rules.With custom detections, you can proactively monitor for and respond to various events and system states, including suspected breach activity and misconfigured assets in their organization network.Custom detection rules, which are written in Kusto query language (KQL), automatically trigger alerts and response actions once there are events matching their KQL queries.
 */
export interface DetectionRulesRequestBuilderGetQueryParameters {
    /**
     * Include count of items
     */
    count?: boolean;
    /**
     * Expand related entities
     */
    expand?: string[];
    /**
     * Filter items by property values
     */
    filter?: string;
    /**
     * Order items by property values
     */
    orderby?: string[];
    /**
     * Search items by search phrases
     */
    search?: string;
    /**
     * Select properties to be returned
     */
    select?: string[];
    /**
     * Skip the first n items
     */
    skip?: number;
    /**
     * Show only the first n items
     */
    top?: number;
}
/**
 * Uri template for the request builder.
 */
export declare const DetectionRulesRequestBuilderUriTemplate = "{+baseurl}/security/rules/detectionRules{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const DetectionRulesRequestBuilderNavigationMetadata: Record<Exclude<keyof DetectionRulesRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const DetectionRulesRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map