🔍 Code Extractor

A data class representing a report of an attack simulation and training campaign, containing an overview and information about participating users.

Purpose

SimulationReport serves as a data container for attack simulation and training campaign reports in Microsoft 365 security services. It inherits from ClientValue, making it suitable for client-side data representation and serialization. The class encapsulates campaign overview information and is designed to be used within the Office 365 security API context for retrieving and managing simulation campaign data.

Source Code

class SimulationReport(ClientValue):
    """
    Represents a report of an attack simulation and training campaign, including an overview and users who
    participated in the campaign.
    """

    def __init__(self, overview=SimulationReportOverview()):
        """
        :param SimulationReportOverview overview: Overview of an attack simulation and training campaign.
        """
        self.overview = overview

Parameters

Parameter Details

overview: A SimulationReportOverview object containing the overview details of the attack simulation and training campaign. Defaults to an empty SimulationReportOverview instance if not provided. This parameter holds summary information about the campaign's execution and results.

Return Value

Instantiation returns a SimulationReport object with the overview attribute set to the provided SimulationReportOverview instance or a default empty overview. The object represents a complete simulation report that can be used for data access, serialization, or further processing within the Office 365 security framework.

Class Interface

Methods

Attributes

Dependencies

• office365

Required Imports

from office365.directory.security.attacksimulations.report_overview import SimulationReportOverview
from office365.runtime.client_value import ClientValue

Usage Example

from office365.directory.security.attacksimulations.report_overview import SimulationReportOverview
from office365.directory.security.attacksimulations.simulation_report import SimulationReport

# Create a report with default overview
report = SimulationReport()

# Create a report with a specific overview
overview = SimulationReportOverview()
report_with_overview = SimulationReport(overview=overview)

# Access the overview
report_overview = report.overview

# Typically used when retrieved from Office 365 API
# context.load(simulation_campaign.report)
# context.execute_query()
# campaign_report = simulation_campaign.report

Best Practices

• This class is primarily a data container and should be instantiated with a valid SimulationReportOverview object for meaningful use
• As it inherits from ClientValue, it is designed for client-side representation and may have serialization capabilities inherited from the base class
• Typically instantiated by the Office 365 SDK when retrieving simulation campaign data rather than manually created
• The class is immutable after construction in typical usage - the overview attribute is set during initialization
• When using within the Office 365 SDK context, ensure proper authentication and permissions are configured to access simulation report data
• This class is part of a larger object hierarchy for security simulation management and should be used in conjunction with related classes like SimulationReportOverview

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class SimulationReport_v1 90.7% similar

  A data class representing an overview report of an attack simulation and training campaign, inheriting from ClientValue for Office 365 API integration.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/security/attacksimulations/report_overview.py

• class AttackSimulationSimulationUserCoverage 75.8% similar

  A data class representing cumulative simulation data and results for a user in Microsoft 365 attack simulation and training scenarios.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/security/attacksimulations/user_coverage.py

• class Simulation 72.7% similar

  Represents an attack simulation training campaign in Microsoft Defender for Office 365, providing access to phishing simulation exercises and training reports.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/security/attacksimulations/simulation.py

• class AttackSimulationRepeatOffender 67.8% similar

  A data model class representing a user in a Microsoft 365 tenant who has repeatedly fallen victim to simulated phishing attacks and security training campaigns.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/security/attacksimulations/repeat_offender.py

• class SimulationAutomationRun 66.8% similar

  A class representing a run of an attack simulation automation on a Microsoft 365 tenant, inheriting from the Entity base class.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/security/attacksimulations/automation_run.py