Lister retentionLabels

Espace de noms : microsoft.graph.security

Importante

Les API sous la /beta version dans Microsoft Graph sont susceptibles de changer. 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 la version 1.0, utilisez le sélecteur de version .

Obtenez la liste des objets retentionLabel et de leurs propriétés.

Autorisations

L’une des autorisations suivantes est requise pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.

Type d’autorisation	Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)
Déléguée (compte professionnel ou scolaire)	RecordsManagement.Read.All, RecordsManagement.ReadWrite.All
Déléguée (compte Microsoft personnel)	Non prise en charge.
Application	Non prise en charge.

Requête HTTP

GET /security/labels/retentionLabels

Paramètres facultatifs de la requête

Cette méthode prend en charge les paramètres de requête OData de développement pour vous aider à personnaliser la réponse. Par exemple, pour récupérer la propriété retentionEventType , vous pouvez utiliser le expand paramètre :$expand=retentionEventType. Pour des informations générales, consultez paramètres de la requête OData.

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et une collection d’objets microsoft.graph.security.retentionLabel dans le corps de la réponse.

Exemples

Demande

HTTP

GET https://graph.microsoft.com/beta/security/labels/retentionLabels

C#

var graphClient = new GraphServiceClient(requestAdapter);

var result = await graphClient.Security.Labels.RetentionLabels.GetAsync();

Importante

Les sdk Microsoft Graph utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le Kit de développement logiciel (SDK), consultez Utiliser les Kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’une instance authProvider , consultez la documentation du SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let retentionLabels = await client.api('/security/labels/retentionLabels')
	.version('beta')
	.get();

Importante

Les sdk Microsoft Graph utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le Kit de développement logiciel (SDK), consultez Utiliser les Kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’une instance authProvider , consultez la documentation du SDK.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

RetentionLabelCollectionPage retentionLabels = graphClient.security().labels().retentionLabels()
	.buildRequest()
	.get();

Importante

Les sdk Microsoft Graph utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le Kit de développement logiciel (SDK), consultez Utiliser les Kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’une instance authProvider , consultez la documentation du SDK.

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


result, err := graphClient.Security().Labels().RetentionLabels().Get(context.Background(), nil)

Importante

Les sdk Microsoft Graph utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le Kit de développement logiciel (SDK), consultez Utiliser les Kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’une instance authProvider , consultez la documentation du SDK.

PowerShell

Import-Module Microsoft.Graph.Security

Get-MgSecurityLabelRetentionLabel

Importante

Les sdk Microsoft Graph utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le Kit de développement logiciel (SDK), consultez Utiliser les Kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’une instance authProvider , consultez la documentation du SDK.

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);


$requestResult = $graphServiceClient->security()->labels()->retentionLabels()->get();

Importante

Les sdk Microsoft Graph utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le Kit de développement logiciel (SDK), consultez Utiliser les Kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’une instance authProvider , consultez la documentation du SDK.

Réponse

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.security.retentionLabel",
      "id": "64a99fb4-07be-0481-8746-44c15c0eef1f",
      "displayName": "String",
      "behaviorDuringRetentionPeriod": "String",
      "actionAfterRetentionPeriod": "String",
      "retentionTrigger": "String",
      "retentionDuration": {
        "@odata.type": "microsoft.graph.security.retentionDuration"
      },
      "isInUse": "Boolean",
      "descriptionForAdmins": "String",
      "descriptionForUsers": "String",
      "createdBy": {
        "@odata.type": "microsoft.graph.identitySet"
      },
      "createdDateTime": "String (timestamp)",
      "lastModifiedBy": {
        "@odata.type": "microsoft.graph.identitySet"
      },
      "lastModifiedDateTime": "String (timestamp)",
      "labelToBeApplied": "String",
      "defaultRecordBehavior": "String"
    }
  ]
}