Update trainingCampaign

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Aktualisieren Sie die Eigenschaften eines trainingCampaign-Objekts .

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) AttackSimulation.ReadWrite.All Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application AttackSimulation.ReadWrite.All Nicht verfügbar.

HTTP-Anforderung

PATCH /security/attackSimulation/trainingCampaigns/{trainingCampaignId}

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext nur die Werte für die zu aktualisierenden Eigenschaften an. Vorhandene Eigenschaften, die nicht im Anforderungstext enthalten sind, behalten ihre vorherigen Werte bei oder werden basierend auf Änderungen an anderen Eigenschaftswerten neu berechnet.

In der folgenden Tabelle sind die Eigenschaften angegeben, die aktualisiert werden können.

Eigenschaft Typ Beschreibung
createdBy emailIdentity Die Identität des Benutzers, der die Schulungskampagne erstellt hat. Optional.
createdDateTime DateTimeOffset Das Datum und die Uhrzeit der Erstellung der Schulungskampagne. Optional.
description Zeichenfolge Die Beschreibung der Schulungskampagne. Optional.
displayName Zeichenfolge Der Anzeigename der Schulungskampagne. Erforderlich.
endUserNotificationSetting endUserNotificationSetting Details zur Einstellung für die Endbenutzerbenachrichtigung. Erforderlich.
excludedAccountTarget accountTargetContent Die Benutzer, die von der Schulungskampagne ausgeschlossen werden. Optional.
includedAccountTarget accountTargetContent Die Benutzer, die von der Schulungskampagne adressiert werden. Erforderlich.
lastModifiedDateTime DateTimeOffset Die Identität des Benutzers, der die Schulungskampagne zuletzt geändert hat. Optional.
trainingSetting trainingSetting Details zu den Schulungseinstellungen für eine Schulungskampagne. Erforderlich.
campaignSchedule campaignSchedule Details zum Zeitplan und aktuellen Status einer Schulungskampagne. Erforderlich.

Antwort

Bei erfolgreicher Ausführung gibt diese Methode einen 202 Accepted Antwortcode und einen Nachverfolgungsheader zurück, der in der Antwort benannt ist location .

Beispiel

Das folgende Beispiel zeigt, wie Sie den Status der Schulungskampagne aktualisieren können. In diesem Fall wird eine geplante Schulungskampagne abgesagt.

Anforderung

PATCH https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/{trainingCampaignId}
Content-Type: application/json

{
    "displayName": "Graph Training Campaign",
    "description": "Graph Training Campaign Description",
    "createdBy": {
        "email": "john@contoso.com"
    },
    "lastModifiedBy": {
        "email": "john@contoso.com"
    },
    "includedAccountTarget": {
        "type": "addressBook",
        "accountTargetEmails": [
            "john@contoso.com"
        ]
    },
    "endUserNotificationSetting": {
        "notificationPreference": "microsoft",
        "settingType": "trainingSelected",
        "trainingReminder": {
            "deliveryFrequency": "weekly",
            "endUserNotification@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/endUserNotifications('fe521249-9901-4584-a987-026a9980c58e')",
            "defaultLanguage": "en"
        },
        "trainingAssignment": {
            "endUserNotification@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/endUserNotifications('36fb4dc1-7c37-4b96-9096-12e6d6014fae')",
            "defaultLanguage": "en"
        }
    },
    "trainingSetting": {
        "settingType": "microsoftCustom",
        "trainingAssignmentMappings": [
            {
                "assignedTo": [
                    "allUsers"
                ],
                "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('40454905-dc26-4f36-b854-3042a5362cb3')"
            },
            {
                "assignedTo": [
                    "allUsers"
                ],
                "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('ea70ae06-3859-4818-be9d-270ee81d80a4')"
            },
            {
                "assignedTo": [
                    "allUsers"
                ],
                "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('d733d88c-1b5a-48e3-a588-9910e41ac21d')"
            }
        ]
    },
    "campaignSchedule": {
        "launchDateTime": "2024-02-15T07:59:44Z",
        "completionDateTime": "2024-02-18T07:59:44Z",
        "status": "Cancelled"
    }
}

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 202 Accepted