チームをアーカイブする

名前空間: microsoft.graph

指定されたチームをアーカイブします。 チームがアーカイブされると、ユーザーはチームにほとんどの変更を加えなくなります。 たとえば、ユーザーは、チーム内の任意のチャネルでメッセージを送信したり、好きになったりすることはできません。チームの名前または説明を編集する。他の設定を編集することもありません。 ただし、チームへのメンバーシップの変更は引き続き許可されます。

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

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

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

この API は、次の国内クラウド展開で使用できます。

グローバル サービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	✅	✅	✅

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

この API では、管理者のアクセス許可がサポートされています。 Microsoft Teamsサービス管理者は、メンバーではないチームにアクセスできます。

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

注:

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

HTTP 要求

POST /teams/{id}/archive

要求ヘッダー

ヘッダー	値
Authorization	ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。

要求本文

要求では、 必要に応じて 、次のように shouldSetSpoSiteReadOnlyForMembers パラメーターを JSON 本文に含めることができます。

{
    "shouldSetSpoSiteReadOnlyForMembers": true
}

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

重要

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

応答

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

例

要求

次の例は要求を示しています。

HTTP

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

{
  
}

C#

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

// Dependencies
using Microsoft.Graph.Teams.Item.Archive;

var requestBody = new ArchivePostRequestBody
{
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Teams["{team-id}"].Archive.PostAsync(requestBody);

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

CLI

mgc teams archive post --team-id {team-id}

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

Go

// 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"
	  graphteams "github.com/microsoftgraph/msgraph-sdk-go/teams"
	  //other-imports
)

requestBody := graphteams.NewArchivePostRequestBody()

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Teams().ByTeamId("team-id").Archive().Post(context.Background(), requestBody, nil)

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

Java

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.teams.item.archive.ArchivePostRequestBody archivePostRequestBody = new com.microsoft.graph.teams.item.archive.ArchivePostRequestBody();
graphClient.teams().byTeamId("{team-id}").archive().post(archivePostRequestBody);

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

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const archive = {
  
};

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

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

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Teams\Item\Archive\ArchivePostRequestBody;


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

$requestBody = new ArchivePostRequestBody();

$graphServiceClient->teams()->byTeamId('team-id')->archive()->post($requestBody)->wait();

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

PowerShell

Import-Module Microsoft.Graph.Teams

$params = @{
}

Invoke-MgArchiveTeam -TeamId $teamId -BodyParameter $params

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

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.teams.item.archive.archive_post_request_body import ArchivePostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ArchivePostRequestBody(
)

await graph_client.teams.by_team_id('team-id').archive.post(request_body)

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

応答

次の例は応答を示しています。

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