名前空間: microsoft.graph
コンテンツをレコードとして分類する driveItem の保持ラベルをロックまたはロック解除します。
管理者の観点からの保持ラベルの詳細については、「 保持ラベルを使用して SharePoint に格納されているドキュメントのライフサイクルを管理する」を参照してください。
保持ラベルをロックおよびロック解除する方法の詳細については、「 レコードのバージョン管理を使用して SharePoint または OneDrive に格納されているレコードを更新する」を参照してください。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス |
米国政府機関 L4 |
米国政府機関 L5 (DOD) |
21Vianet が運営する中国 |
| ✅ |
✅ |
✅ |
✅ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。
アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 |
最小特権アクセス許可 |
より高い特権のアクセス許可 |
| 委任 (職場または学校のアカウント) |
Files.ReadWrite.All |
Sites.ReadWrite.All |
| 委任 (個人用 Microsoft アカウント) |
サポートされていません。 |
サポートされていません。 |
| アプリケーション |
Files.ReadWrite.All |
Sites.ReadWrite.All |
HTTP 要求
PATCH /drives/{drive-id}/items/{item-id}/retentionLabel
| 名前 |
説明 |
| Authorization |
ベアラー {token}。 必須です。
認証と認可についての詳細をご覧ください。 |
| Content-Type |
application/json. 必須です。 |
要求本文
要求本文で、次のパラメーターを持つ JSON オブジェクトを指定します。
応答
成功した場合、このメソッドは応答コード 200 OK と、応答本文で更新された itemRetentionLabel オブジェクトを返します。
例
要求
次の例は要求を示しています。
PATCH https://graph.microsoft.com/v1.0/drives/b!t18F8ybsHUq1z3LTz8xvZqP8zaSWjkFNhsME-Fepo75dTf9vQKfeRblBZjoSQrd7/items/01NKDM7HMOJTVYMDOSXFDK2QJDXCDI3WUK/retentionLabel
Content-Type: application/json
{
"retentionSettings": {
"isRecordLocked": true
}
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new ItemRetentionLabel
{
RetentionSettings = new RetentionLabelSettings
{
IsRecordLocked = true,
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Drives["{drive-id}"].Items["{driveItem-id}"].RetentionLabel.PatchAsync(requestBody);
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewItemRetentionLabel()
retentionSettings := graphmodels.NewRetentionLabelSettings()
isRecordLocked := true
retentionSettings.SetIsRecordLocked(&isRecordLocked)
requestBody.SetRetentionSettings(retentionSettings)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
retentionLabel, err := graphClient.Drives().ByDriveId("drive-id").Items().ByDriveItemId("driveItem-id").RetentionLabel().Patch(context.Background(), requestBody, nil)
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
ItemRetentionLabel itemRetentionLabel = new ItemRetentionLabel();
RetentionLabelSettings retentionSettings = new RetentionLabelSettings();
retentionSettings.setIsRecordLocked(true);
itemRetentionLabel.setRetentionSettings(retentionSettings);
ItemRetentionLabel result = graphClient.drives().byDriveId("{drive-id}").items().byDriveItemId("{driveItem-id}").retentionLabel().patch(itemRetentionLabel);
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
const options = {
authProvider,
};
const client = Client.init(options);
const itemRetentionLabel = {
retentionSettings: {
isRecordLocked: true
}
};
await client.api('/drives/b!t18F8ybsHUq1z3LTz8xvZqP8zaSWjkFNhsME-Fepo75dTf9vQKfeRblBZjoSQrd7/items/01NKDM7HMOJTVYMDOSXFDK2QJDXCDI3WUK/retentionLabel')
.update(itemRetentionLabel);
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\ItemRetentionLabel;
use Microsoft\Graph\Generated\Models\RetentionLabelSettings;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ItemRetentionLabel();
$retentionSettings = new RetentionLabelSettings();
$retentionSettings->setIsRecordLocked(true);
$requestBody->setRetentionSettings($retentionSettings);
$result = $graphServiceClient->drives()->byDriveId('drive-id')->items()->byDriveItemId('driveItem-id')->retentionLabel()->patch($requestBody)->wait();
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
Import-Module Microsoft.Graph.Files
$params = @{
retentionSettings = @{
isRecordLocked = $true
}
}
Update-MgDriveItemRetentionLabel -DriveId $driveId -DriveItemId $driveItemId -BodyParameter $params
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.item_retention_label import ItemRetentionLabel
from msgraph.generated.models.retention_label_settings import RetentionLabelSettings
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ItemRetentionLabel(
retention_settings = RetentionLabelSettings(
is_record_locked = True,
),
)
result = await graph_client.drives.by_drive_id('drive-id').items.by_drive_item_id('driveItem-id').retention_label.patch(request_body)
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
応答
次の例は応答を示しています。
HTTP/1.1 200 OK
Content-Type: application/json
{
"name": "Retention label for Contracts",
"retentionSettings": {
"behaviorDuringRetentionPeriod": "retain",
"isDeleteAllowed": false,
"isRecordLocked": true,
"isMetadataUpdateAllowed": false,
"isContentUpdateAllowed": false,
"isLabelUpdateAllowed": false
},
"isLabelAppliedExplicitly": false,
"labelAppliedDateTime": "2022-12-22T10:18:23.6580555+00:00",
"labelAppliedBy": {
"user": {
"id": "56d171c8-a92e-4359-9c4a-38b88ac7eabd",
"displayName": "Contoso Admin"
}
}
}