存档团队

命名空间：microsoft.graph

存档指定的团队。 存档团队后，用户无法再对团队进行大部分更改。 例如，用户无法再在团队中的任何频道上发送或赞消息;编辑团队的名称或说明;也不编辑其他设置。 但是，仍允许对团队进行成员身份更改。

存档属于异步操作。 异步操作成功完成后，团队就会存档，这可能会在来自此 API 的响应之后发生。

要存档团队，团队和 组 必须具有一个所有者。

要从存档状态还原团队，请使用 API 取消存档。

此 API 可用于以下国家级云部署。

全局服务	美国政府 L4	美国政府 L5 (DOD)	由世纪互联运营的中国
✅	✅	✅	✅

权限

为此 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 响应代码。 响应还包含标头 Location ，其中包含为处理团队存档而创建的 teamsAsyncOperation 的位置。 可通过向此位置发出 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

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc teams archive post --team-id {team-id}

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphteams "github.com/microsoftgraph/msgraph-sdk-go/teams"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphteams.NewArchivePostRequestBody()

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\Models\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

from msgraph import GraphServiceClient
from msgraph.generated.models.archive_post_request_body import ArchivePostRequestBody

graph_client = GraphServiceClient(credentials, scopes)

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