@microsoft/msgraph-sdk-security/security/alerts_v2/index.d.ts

Security fluent API for Microsoft Graph

import { type Alert, type AlertCollectionResponse } from '@microsoft/msgraph-sdk/models/security/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type AlertItemRequestBuilder } 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 alerts_v2 property of the microsoft.graph.security entity.
 */
export interface Alerts_v2RequestBuilder extends BaseRequestBuilder<Alerts_v2RequestBuilder> {
    /**
     * Provides operations to count the resources in the collection.
     */
    get count(): CountRequestBuilder;
    /**
     * Provides operations to manage the alerts_v2 property of the microsoft.graph.security entity.
     * @param alertId The unique identifier of alert
     * @returns {AlertItemRequestBuilder}
     */
    byAlertId(alertId: string): AlertItemRequestBuilder;
    /**
     * Get a list of alert resources created to track suspicious activities in an organization. This operation lets you filter and sort through alerts to create an informed cyber security response. It exposes a collection of alerts that were flagged in your network, within the time range you specified in your environment retention policy. The most recent alerts are displayed at the top of the list.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<AlertCollectionResponse>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/security-list-alerts_v2?view=graph-rest-1.0|Find more info here}
     */
    get(requestConfiguration?: RequestConfiguration<Alerts_v2RequestBuilderGetQueryParameters> | undefined): Promise<AlertCollectionResponse | undefined>;
    /**
     * Create new navigation property to alerts_v2 for security
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<Alert>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     */
    post(body: Alert, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Alert | undefined>;
    /**
     * Get a list of alert resources created to track suspicious activities in an organization. This operation lets you filter and sort through alerts to create an informed cyber security response. It exposes a collection of alerts that were flagged in your network, within the time range you specified in your environment retention policy. The most recent alerts are displayed at the top of the list.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<Alerts_v2RequestBuilderGetQueryParameters> | undefined): RequestInformation;
    /**
     * Create new navigation property to alerts_v2 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: Alert, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
 * Get a list of alert resources created to track suspicious activities in an organization. This operation lets you filter and sort through alerts to create an informed cyber security response. It exposes a collection of alerts that were flagged in your network, within the time range you specified in your environment retention policy. The most recent alerts are displayed at the top of the list.
 */
export interface Alerts_v2RequestBuilderGetQueryParameters {
    /**
     * 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 Alerts_v2RequestBuilderUriTemplate = "{+baseurl}/security/alerts_v2{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const Alerts_v2RequestBuilderNavigationMetadata: Record<Exclude<keyof Alerts_v2RequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const Alerts_v2RequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map