@microsoft/msgraph-sdk-security
Version:
Security fluent API for Microsoft Graph
80 lines • 5.1 kB
TypeScript
import { type Incident } from '@microsoft/msgraph-sdk/models/security/index.js';
import { type AlertsRequestBuilder } from './alerts/index.js';
import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
* Provides operations to manage the incidents property of the microsoft.graph.security entity.
*/
export interface IncidentItemRequestBuilder extends BaseRequestBuilder<IncidentItemRequestBuilder> {
/**
* Provides operations to manage the alerts property of the microsoft.graph.security.incident entity.
*/
get alerts(): AlertsRequestBuilder;
/**
* Delete navigation property incidents for security
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
*/
delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
/**
* Retrieve the properties and relationships of an incident object. Attacks are typically inflicted on different types of entities, such as devices, users, and mailboxes, resulting in multiple alert objects. Microsoft 365 Defender correlates alerts with the same attack techniques or the same attacker into an incident.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<Incident>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/security-incident-get?view=graph-rest-1.0|Find more info here}
*/
get(requestConfiguration?: RequestConfiguration<IncidentItemRequestBuilderGetQueryParameters> | undefined): Promise<Incident | undefined>;
/**
* Update the properties of an incident object.
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<Incident>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/security-incident-update?view=graph-rest-1.0|Find more info here}
*/
patch(body: Incident, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Incident | undefined>;
/**
* Delete navigation property incidents for security
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
/**
* Retrieve the properties and relationships of an incident object. Attacks are typically inflicted on different types of entities, such as devices, users, and mailboxes, resulting in multiple alert objects. Microsoft 365 Defender correlates alerts with the same attack techniques or the same attacker into an incident.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<IncidentItemRequestBuilderGetQueryParameters> | undefined): RequestInformation;
/**
* Update the properties of an incident object.
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toPatchRequestInformation(body: Incident, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* Retrieve the properties and relationships of an incident object. Attacks are typically inflicted on different types of entities, such as devices, users, and mailboxes, resulting in multiple alert objects. Microsoft 365 Defender correlates alerts with the same attack techniques or the same attacker into an incident.
*/
export interface IncidentItemRequestBuilderGetQueryParameters {
/**
* Expand related entities
*/
expand?: string[];
/**
* Select properties to be returned
*/
select?: string[];
}
/**
* Uri template for the request builder.
*/
export declare const IncidentItemRequestBuilderUriTemplate = "{+baseurl}/security/incidents/{incident%2Did}{?%24expand,%24select}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const IncidentItemRequestBuilderNavigationMetadata: Record<Exclude<keyof IncidentItemRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const IncidentItemRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map