Mettre à jour trainingCampaign

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Mettre à jour les propriétés d’un objet trainingCampaign .

Cette API est disponible dans les déploiements cloud nationaux suivants.

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet
✅ ❌ ❌ ❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) AttackSimulation.ReadWrite.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application AttackSimulation.ReadWrite.All Non disponible.

Requête HTTP

PATCH /security/attackSimulation/trainingCampaigns/{trainingCampaignId}

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez uniquement les valeurs des propriétés à mettre à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conservent leurs valeurs précédentes ou sont recalculées en fonction des modifications apportées à d’autres valeurs de propriété.

Le tableau suivant spécifie les propriétés qui peuvent être mises à jour.

Propriété Type Description
createdBy emailIdentity Identité de l’utilisateur ayant créé la campagne de formation. Facultatif.
createdDateTime DateTimeOffset Date et heure de création de la campagne de formation. Facultatif.
description String Description de la campagne de formation. Facultatif.
displayName String Nom d’affichage de la campagne de formation. Obligatoire.
endUserNotificationSetting endUserNotificationSetting Détails sur le paramètre de notification à l’utilisateur final. Obligatoire.
excludedAccountTarget accountTargetContent Les utilisateurs exclus de la campagne de formation. Facultatif.
includedAccountTarget accountTargetContent Utilisateurs ciblés dans la campagne de formation. Obligatoire.
lastModifiedDateTime DateTimeOffset L’identité de l’utilisateur qui a modifié la campagne d’entraînement le plus récemment. Facultatif.
trainingSetting trainingSetting Détails sur les paramètres d’entraînement d’une campagne d’entraînement. Obligatoire.
campaignSchedule campaignSchedule Détails sur la planification et le statut actuel d’une campagne d’entraînement. Obligatoire.

Réponse

En cas de réussite, cette méthode renvoie un 202 Accepted code de réponse et un en-tête de suivi nommés location dans la réponse.

Exemple

L’exemple suivant montre comment mettre à jour le status de la campagne d’entraînement. Dans ce cas, une campagne de formation programmée est annulée.

Demande

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"
    }
}

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 202 Accepted