チームをアーカイブする

名前空間: microsoft.graph

指定されたチームをアーカイブします。 チームをアーカイブすると、ユーザーはチームのチャネルでメッセージを送信したり、いいねしたり、チームの名前、説明、またはその他の設定、通常、チームへの変更がほとんどできなくなります。 チームへのメンバーシップの変更はそのまま許可されます。

アーカイブは非同期操作です。 非同期操作が正常に完了すると、チームがアーカイブされます。この API の応答に続いて発生する可能性があります。

チームをアーカイブできるのは、チームとグループが所有者の場合です。

アーカイブした状態からチームを復元するには、API を使用してアーカイブを解除します。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。 アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	TeamSettings.ReadWrite.All, Group.ReadWrite.All**, Directory.ReadWrite.All**
委任 (個人用 Microsoft アカウント)	サポートされていません。
アプリケーション	TeamSettings.ReadWrite.Group*, TeamSettings.ReadWrite.All, Group.ReadWrite.All**, Directory.ReadWrite.All**

注:

• * でマークされたアクセス許可は、リソース固有の同意を使用します。
• ** でマークされたアクセス許可は、下位互換性のためにのみサポートされます。 前の表に記載されている別のアクセス許可を使用するようにソリューションを更新し、今後これらのアクセス許可を使用しないようにすることをお勧めします。

注: この API は、管理者のアクセス許可をサポートします。 グローバル管理者と Microsoft Teams サービス管理者は、メンバーではないチームにアクセスできます。

HTTP 要求

POST /teams/{id}/archive

要求ヘッダー

ヘッダー	値
Authorization	ベアラー {token}。 必須です。

要求本文

次のように、リクエストではオプションで JSON の本文にshouldSetSpoSiteReadOnlyForMembersパラメーターを入力できます。

{
    "shouldSetSpoSiteReadOnlyForMembers": true
}

このオプションのパラメーターは、チーム メンバーのアクセス許可を、チームに関連付けられている Sharepoint Online サイトで読み取り専用に設定するかどうかを定義します。 False に設定したり、本文を完全に省略したりすると、この手順がスキップされます。

重要

shouldSetSpoSiteReadOnlyForMembers パラメーターは、アプリケーション コンテキストではサポートされていません。

応答

アーカイブが正常に開始された場合、このメソッドは202 Accepted応答コードを返します。 応答には、チームのアーカイブを処理するのに作成された teamsAsyncOperation の場所を含むLocationヘッダーも含まれます。 この場所に GET 要求を作成して、アーカイブ操作の状態を確認します。

例

要求

要求の例を次に示します。

HTTP

POST https://graph.microsoft.com/v1.0/teams/{id}/archive

C#

var graphClient = new GraphServiceClient(requestAdapter);

await graphClient.Teams["{team-id}"].Archive.PostAsync(null);

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/teams/{id}/archive')
	.post();

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Java

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

graphClient.teams("{id}")
	.archive(TeamArchiveParameterSet
		.newBuilder()
		.withShouldSetSpoSiteReadOnlyForMembers(null)
		.build())
	.buildRequest()
	.post();

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



graphClient.TeamsById("team-id").Archive().Post(context.Background(), nil)

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

PowerShell

Import-Module Microsoft.Graph.Teams

Invoke-MgArchiveTeam -TeamId $teamId

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

PHP

<?php

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


$graphServiceClient->teamsById('team-id')->archive()->post();

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

応答の例を次に示します。

HTTP/1.1 202 Accepted
Location: /teams({id})/operations({opId})
Content-Type: text/plain
Content-Length: 0