@microsoft/msgraph-sdk-security/security/attackSimulation/simulations/item/index.d.ts

Security fluent API for Microsoft Graph

import { type Simulation } from '@microsoft/msgraph-sdk/models/index.js';
import { type LandingPageRequestBuilder } from './landingPage/index.js';
import { type LoginPageRequestBuilder } from './loginPage/index.js';
import { type PayloadRequestBuilder } from './payload/index.js';
import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
 * Provides operations to manage the simulations property of the microsoft.graph.attackSimulationRoot entity.
 */
export interface SimulationItemRequestBuilder extends BaseRequestBuilder<SimulationItemRequestBuilder> {
    /**
     * Provides operations to manage the landingPage property of the microsoft.graph.simulation entity.
     */
    get landingPage(): LandingPageRequestBuilder;
    /**
     * Provides operations to manage the loginPage property of the microsoft.graph.simulation entity.
     */
    get loginPage(): LoginPageRequestBuilder;
    /**
     * Provides operations to manage the payload property of the microsoft.graph.simulation entity.
     */
    get payload(): PayloadRequestBuilder;
    /**
     * Delete an attack simulation campaign for a tenant.
     * @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
     * @see {@link https://learn.microsoft.com/graph/api/simulation-delete?view=graph-rest-1.0|Find more info here}
     */
    delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
    /**
     * Get an attack simulation campaign for a tenant.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<Simulation>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/simulation-get?view=graph-rest-1.0|Find more info here}
     */
    get(requestConfiguration?: RequestConfiguration<SimulationItemRequestBuilderGetQueryParameters> | undefined): Promise<Simulation | undefined>;
    /**
     * Update an attack simulation campaign for a tenant.
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<Simulation>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/simulation-update?view=graph-rest-1.0|Find more info here}
     */
    patch(body: Simulation, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Simulation | undefined>;
    /**
     * Delete an attack simulation campaign for a tenant.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
    /**
     * Get an attack simulation campaign for a tenant.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<SimulationItemRequestBuilderGetQueryParameters> | undefined): RequestInformation;
    /**
     * Update an attack simulation campaign for a tenant.
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toPatchRequestInformation(body: Simulation, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
 * Get an attack simulation campaign for a tenant.
 */
export interface SimulationItemRequestBuilderGetQueryParameters {
    /**
     * Expand related entities
     */
    expand?: string[];
    /**
     * Select properties to be returned
     */
    select?: string[];
}
/**
 * Uri template for the request builder.
 */
export declare const SimulationItemRequestBuilderUriTemplate = "{+baseurl}/security/attackSimulation/simulations/{simulation%2Did}{?%24expand,%24select}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const SimulationItemRequestBuilderNavigationMetadata: Record<Exclude<keyof SimulationItemRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const SimulationItemRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map