Listar objetos trainingCampaign

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.

Obtenha uma lista de objetos trainingCampaign e suas propriedades.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global	Governo dos EUA L4	US Government L5 (DOD)	China operada pela 21Vianet
✅	❌	❌	❌

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

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

Solicitação HTTP

GET /security/attackSimulation/trainingCampaigns

Parâmetros de consulta opcionais

Esse método dá suporte aos $countparâmetros de consulta , $filter, , $top$orderby$skipToken, e $select OData para ajudar a personalizar a resposta. Você pode usar os $filter parâmetros de consulta e $orderby nas propriedades campaignSchedule/completionDateTime, displayName, campaignSchedule/launchDateTime e campaignSchedule/status.

Se o conjunto de resultados se estender por várias páginas, o corpo da resposta conterá um @odata.nextLink que você pode usar para paginar o conjunto de resultados.

A lista a seguir mostra alguns exemplos de solicitações que usam os parâmetros de consulta OData com suporte:

GET /security/attackSimulation/trainingCampaigns?$count=true
GET /security/attackSimulation/trainingCampaigns?$filter={property} eq '{property-value}'
GET /security/attackSimulation/trainingCampaigns?$filter={property} eq '{property-value}'&$top=5
GET /security/attackSimulation/trainingCampaigns?$orderby={property}
GET /security/attackSimulation/trainingCampaigns?$skipToken={skipToken}
GET /security/attackSimulation/trainingCampaigns?$top=1
GET /security/attackSimulation/trainingCampaigns?$select={property}

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se for bem-sucedido, esse método retornará um 200 OK código de resposta e uma coleção de objetos trainingCampaign no corpo da resposta.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

HTTP

GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Security.AttackSimulation.TrainingCampaigns.GetAsync();

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Ir

// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
trainingCampaigns, err := graphClient.Security().AttackSimulation().TrainingCampaigns().Get(context.Background(), nil)

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

TrainingCampaignCollectionResponse result = graphClient.security().attackSimulation().trainingCampaigns().get();

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let trainingCampaigns = await client.api('/security/attackSimulation/trainingCampaigns')
	.version('beta')
	.get();

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

PHP

<?php
use Microsoft\Graph\Beta\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->security()->attackSimulation()->trainingCampaigns()->get()->wait();

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

PowerShell

Import-Module Microsoft.Graph.Beta.Security

Get-MgBetaSecurityAttackSimulationTrainingCampaign

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.security.attack_simulation.training_campaigns.get()

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "value": [
        {
            "@odata.etag": "W/\"dub9zfj4Rk68MmY/KYwXKgADRgyGsw==\"",
            "id": "81c59451-2929-5b39-86f0-5a2b15f1314f",
            "displayName": "Sample Training Campaign",
            "description": "Sample Training Campaign Description",
            "createdDateTime": "2024-02-18T08:36:07.6534871Z",
            "lastModifiedDateTime": "2024-02-19T08:00:01.9417887Z",
            "endUserNotificationSetting": null,
            "includedAccountTarget": null,
            "excludedAccountTarget": null,
            "trainingSetting": null,
            "campaignSchedule": {
                "launchDateTime": "2024-02-18T08:37:44Z",
                "completionDateTime": "2024-02-19T07:59:44Z",
                "status": "completed"
            },
            "createdBy": {
              "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21",
              "displayName": "Reed Flores",
              "email": "reed@contoso.com"
            },
            "lastModifiedBy": {
              "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21",
              "displayName": "Reed Flores",
              "email": "reed@contoso.com"
            },
        }
    ]
}