simulationAutomationRun resource type

Article
07/23/2024

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents a run of an attack simulation automation on a tenant.

Inherits from entity.

Methods

Method	Return type	Description
List	simulationAutomationRun collection	Get a list of the attack simulation automation runs for a tenant.

Properties

Property	Type	Description
endDateTime	DateTimeOffset	Date and time when the run ends in an attack simulation automation.
id	String	Unique identifier for the run of an attack simulation automation. Inherited from entity.
simulationId	String	Unique identifier for the attack simulation campaign initiated in the attack simulation automation run.
startDateTime	DateTimeOffset	Date and time when the run starts in an attack simulation automation.
status	simulationAutomationRunStatus	Status of the attack simulation automation run. The possible values are: `unknown`, `running`, `succeeded`, `failed`, `skipped`, `unknownFutureValue`.

simulationAutomationRunStatus values

Member	Description
unknown	The status of a simulation automation run is not defined.
running	The simulation automation run is running.
succeeded	The simulation automation run has succeeded.
failed	The simulation automation run has failed.
skipped	The simulation automation run has skipped.
unknownFutureValue	Evolvable enumeration sentinel value. Do not use.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.simulationAutomationRun",
  "endDateTime": "String (timestamp)",
  "id": "String (identifier)",
  "simulationId": "String",
  "startDateTime": "String (timestamp)",
  "status": "String"
}

Share via