@microsoft/msgraph-sdk-security
Version:
Security fluent API for Microsoft Graph
80 lines • 4.31 kB
TypeScript
import { type Alert } from '@microsoft/msgraph-sdk/models/security/index.js';
import { type CommentsRequestBuilder } from './comments/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 AlertItemRequestBuilder extends BaseRequestBuilder<AlertItemRequestBuilder> {
/**
* The comments property
*/
get comments(): CommentsRequestBuilder;
/**
* Delete navigation property alerts_v2 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>;
/**
* Get the properties and relationships of an alert object.
* @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
* @see {@link https://learn.microsoft.com/graph/api/security-alert-get?view=graph-rest-1.0|Find more info here}
*/
get(requestConfiguration?: RequestConfiguration<AlertItemRequestBuilderGetQueryParameters> | undefined): Promise<Alert | undefined>;
/**
* Update the properties of an alert object in an organization based on the specified alert id property.
* @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
* @see {@link https://learn.microsoft.com/graph/api/security-alert-update?view=graph-rest-1.0|Find more info here}
*/
patch(body: Alert, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Alert | undefined>;
/**
* Delete navigation property alerts_v2 for security
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
/**
* Get the properties and relationships of an alert object.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<AlertItemRequestBuilderGetQueryParameters> | undefined): RequestInformation;
/**
* Update the properties of an alert object in an organization based on the specified alert id property.
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toPatchRequestInformation(body: Alert, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* Get the properties and relationships of an alert object.
*/
export interface AlertItemRequestBuilderGetQueryParameters {
/**
* Expand related entities
*/
expand?: string[];
/**
* Select properties to be returned
*/
select?: string[];
}
/**
* Uri template for the request builder.
*/
export declare const AlertItemRequestBuilderUriTemplate = "{+baseurl}/security/alerts_v2/{alert%2Did}{?%24expand,%24select}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const AlertItemRequestBuilderNavigationMetadata: Record<Exclude<keyof AlertItemRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const AlertItemRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map