Edit

Share via

trainingCampaign resource type

  • Article

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 training campaign. In Attack simulation training in Microsoft 365 E5 or Microsoft Defender for Office 365 Plan 2, training campaigns are a fast, direct way to provide security training to users. Instead of creating and launching simulated phishing attacks that eventually lead to training, you can create and assign training campaigns directly to users.

A training campaign contains one or more built-in training modules that you select. Currently, there are over 70 training modules to select from. For more information about training modules, see training modules for Training campaigns in Attack simulation training.

Inherits from entity.

Methods

Method Return type Description
List trainingCampaign collection Get a list of the trainingCampaign objects and their properties.
Create trainingCampaign Create a new trainingCampaign object.
Get trainingCampaign Read the properties and relationships of a trainingCampaign object.
Update trainingCampaign Update the properties of a trainingCampaign object.
Delete None Delete a trainingCampaign object.

Properties

Property Type Description
campaignSchedule campaignSchedule Details about the schedule and current status for a training campaign
createdBy emailIdentity Identity of the user who created the training campaign
createdDateTime DateTimeOffset Date and time of creation of the training campaign.
description String Description of the training campaign.
displayName String Display name of the training campaign. Supports $filter and $orderby.
endUserNotificationSetting endUserNotificationSetting Details about the end user notification setting.
excludedAccountTarget accountTargetContent Users excluded from the training campaign.
id String Unique identifier for the training campaign. Inherited from entity.
includedAccountTarget accountTargetContent Users targeted in the training campaign.
lastModifiedBy emailIdentity Identity of the user who most recently modified the training campaign.
lastModifiedDateTime DateTimeOffset Date and time of the most recent modification of the training campaign.
report trainingCampaignReport Report of the training campaign.
trainingSetting trainingSetting Details about the training settings for a training campaign.

campaignStatus values

Member Description
unknown The campaign status isn't defined.
draft The campaign is in draft mode.
inProgress The campaign is in progress.
scheduled The campaign is scheduled.
completed The campaign is complete.
failed The campaign failed.
cancelled The campaign is cancelled.
excluded The campaign is excluded.
deleted The campaign is in draft mode.
unknownFutureValue Evolvable enumeration sentinel value. Don't use.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.trainingCampaign",
  "id": "String (identifier)",
  "createdBy": {
    "@odata.type": "microsoft.graph.emailIdentity"
  },
  "createdDateTime": "String (timestamp)",
  "description": "String",
  "displayName": "String",
  "endUserNotificationSetting": {
    "@odata.type": "microsoft.graph.endUserNotificationSetting"
  },
  "excludedAccountTarget": {
    "@odata.type": "microsoft.graph.accountTargetContent"
  },
  "includedAccountTarget": {
    "@odata.type": "microsoft.graph.accountTargetContent"
  },
  "lastModifiedBy": {
    "@odata.type": "microsoft.graph.emailIdentity"
  },
  "lastModifiedDateTime": "String (timestamp)",
  "report": {
    "@odata.type": "microsoft.graph.trainingCampaignReport"
  },
  "trainingSetting": {
    "@odata.type": "microsoft.graph.trainingSetting"
  },
  "campaignSchedule": {
    "@odata.type": "microsoft.graph.campaignSchedule"
  }
}

Related content