Get retentionLabel

Namespace: microsoft.graph.security

Read the properties and relationships of a retentionLabel object.

This API is available in the following national cloud deployments.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

HTTP request

GET /security/labels/retentionLabels/{retentionLabelId}
GET /security/triggers/retentionEvents/{retentionEventId}/labels/{retentionLabelId}

Optional query parameters

This method supports the expand OData query parameters to help customize the response. For example, to retrieve the retentionEventType property, you can use the expand parameter:$expand=retentionEventType or $expand=descriptors. For general information, see OData query parameters.

Request headers

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a microsoft.graph.security.retentionLabel object in the response body.

Examples

Request

Here's an example of a request.

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

// 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.Labels.RetentionLabels["{retentionLabel-id}"].GetAsync();

mgc-beta security labels retention-labels get --retention-label-id {retentionLabel-id}

// 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
retentionLabels, err := graphClient.Security().Labels().RetentionLabels().ByRetentionLabelId("retentionLabel-id").Get(context.Background(), nil)

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.models.security.RetentionLabel result = graphClient.security().labels().retentionLabels().byRetentionLabelId("{retentionLabel-id}").get();

const options = {
	authProvider,
};

const client = Client.init(options);

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

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


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


$result = $graphServiceClient->security()->labels()->retentionLabels()->byRetentionLabelId('retentionLabel-id')->get()->wait();

Import-Module Microsoft.Graph.Beta.Security

Get-MgBetaSecurityLabelRetentionLabel -RetentionLabelId $retentionLabelId

# 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.labels.retention_labels.by_retention_label_id('retentionLabel-id').get()

Response

Here's an example of the response.

Note: The response object shown here might be shortened for readability.

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

{
  "value": {
    "@odata.type": "#microsoft.graph.security.retentionLabel",
    "id": "64a99fb4-07be-0481-8746-44c15c0eef1f",
      "displayName": "Retention Schedule 10004",
      "behaviorDuringRetentionPeriod": "retain",
      "actionAfterRetentionPeriod": "relabel",
      "retentionTrigger": "dateCreated",
      "retentionDuration": {
        "@odata.type": "microsoft.graph.security.retentionDurationInDays",
        "days": 730
      },
      "isInUse": true,
      "descriptionForAdmins": "creation based retention label for schedule 10004",
      "descriptionForUsers": "retains for 2 years then relabeled",
      "createdBy": {
        "user": {
          "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
          "displayName": "Admin"
        }
      },
      "createdDateTime": "2017-11-27T02:10:12Z",
      "lastModifiedBy": {
        "user": {
          "id": "9563a605-e827-4324-a5a9-09efddff1e90",
          "displayName": "Records Manager"
        }
      },
      "lastModifiedDateTime": "2020-08-28T22:13:09Z",
      "labelToBeApplied": "Retention schedule 10005",
      "defaultRecordBehavior": "startLocked"
  }
}