Compartilhar via


Atualizar formaçãoCampaign

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Atualize as propriedades de um objeto trainingCampaign .

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) AttackSimulation.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application AttackSimulation.ReadWrite.All Indisponível.

Solicitação HTTP

PATCH /security/attackSimulation/trainingCampaigns/{trainingCampaignId}

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo do pedido, forneça apenas os valores das propriedades a atualizar. As propriedades existentes que não estão incluídas no corpo do pedido mantêm os valores anteriores ou são recalculadas com base em alterações a outros valores de propriedade.

A tabela a seguir especifica as propriedades que podem ser atualizadas.

Propriedade Tipo Descrição
createdBy emailIdentity A identidade do utilizador que criou a campanha de formação. Opcional.
createdDateTime DateTimeOffset A data e hora da criação da campanha de formação. Opcional.
description Cadeia de caracteres A descrição da campanha de formação. Opcional.
displayName Cadeia de caracteres O nome a apresentar da campanha de formação. Obrigatório.
endUserNotificationSetting endUserNotificationSetting Detalhes sobre a definição de notificação do utilizador final. Obrigatório.
excludedAccountTarget accountTargetContent Os utilizadores excluídos da campanha de formação. Opcional.
includedAccountTarget accountTargetContent Os utilizadores visados na campanha de formação. Obrigatório.
lastModifiedDateTime DateTimeOffset A identidade do utilizador que modificou recentemente a campanha de formação. Opcional.
trainingSetting trainingSetting Detalhes sobre as definições de formação de uma campanha de formação. Obrigatório.
campaignSchedule campaignSchedule Detalhes sobre a agenda e o status atual para uma campanha de formação. Obrigatório.

Resposta

Se for bem-sucedido, este método devolve um 202 Accepted código de resposta e um cabeçalho de controlo com o nome location na resposta.

Exemplo

O exemplo seguinte mostra como atualizar o status da campanha de formação. Neste caso, uma campanha de formação agendada é cancelada.

Solicitação

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

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 202 Accepted