命名空间:microsoft.graph
注意
与资源类型下 teamworkDevice 的设备管理相关的 Microsoft Graph beta API 将于 2025 年 11 月弃用,在此日期之后将不再受支持。
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
更新已启用 Microsoft Teams 的设备的软件。 此 API 触发长时间运行的作。
注意:Microsoft暂时提供 API 的使用,以免费管理已启用 Teams Microsoft 的设备。
Microsoft 将在未来收取使用部分或所有此类 API 的费用。 Microsoft 将提供定价更改的高级通知。
有关当前许可模型的详细信息,请参阅 许可和付款要求。
此 API 可用于以下国家级云部署。
| 全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
| ✅ |
✅ |
✅ |
✅ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
| 权限类型 |
最低特权权限 |
更高特权权限 |
| 委派(工作或学校帐户) |
TeamworkDevice.ReadWrite.All |
不可用。 |
| 委派(个人 Microsoft 帐户) |
不支持。 |
不支持。 |
| 应用程序 |
TeamworkDevice.ReadWrite.All |
不可用。 |
HTTP 请求
POST /teamwork/devices/{teamworkDeviceId}/updateSoftware
| 名称 |
说明 |
| Authorization |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
| Content-Type |
application/json. 必需。 |
请求正文
在请求正文中,提供参数的 JSON 表示形式。
下表显示了可用于此操作的参数。
| 参数 |
类型 |
说明 |
| softwareType |
teamworkSoftwareType |
要更新的软件类型。 有效类型为:adminAgent、、operatingSystem、firmwareteamsClient、partnerAgent、 companyPortal。 |
| softwareVersion |
String |
指定可用于更新的软件版本。 |
响应
如果成功,此方法返回 202 Accepted 响应代码。 响应还将包含一个 Location 标头,其中包含 teamworkDeviceOperation 资源的位置。 可以通过向此位置发出 GET 请求来检查软件更新作的状态,该请求返回作是 queued、 succeeded还是 failed。
如果作已处于排队状态,则此方法还会返回 409 Conflict 响应代码。
示例
请求
POST https://graph.microsoft.com/beta/teamwork/devices/0f3ce432-e432-0f3c-32e4-3c0f32e43c0f/updateSoftware
Content-Type: application/json
Content-length: 64
{
"softwareType": "teamsClient",
"softwareVersion": "1.0.96.22"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Teamwork.Devices.Item.UpdateSoftware;
using Microsoft.Graph.Beta.Models;
var requestBody = new UpdateSoftwarePostRequestBody
{
SoftwareType = TeamworkSoftwareType.TeamsClient,
SoftwareVersion = "1.0.96.22",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Teamwork.Devices["{teamworkDevice-id}"].UpdateSoftware.PostAsync(requestBody);
// 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"
graphteamwork "github.com/microsoftgraph/msgraph-beta-sdk-go/teamwork"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphteamwork.NewUpdateSoftwarePostRequestBody()
softwareType := graphmodels.TEAMSCLIENT_TEAMWORKSOFTWARETYPE
requestBody.SetSoftwareType(&softwareType)
softwareVersion := "1.0.96.22"
requestBody.SetSoftwareVersion(&softwareVersion)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Teamwork().Devices().ByTeamworkDeviceId("teamworkDevice-id").UpdateSoftware().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.teamwork.devices.item.updatesoftware.UpdateSoftwarePostRequestBody updateSoftwarePostRequestBody = new com.microsoft.graph.beta.teamwork.devices.item.updatesoftware.UpdateSoftwarePostRequestBody();
updateSoftwarePostRequestBody.setSoftwareType(TeamworkSoftwareType.TeamsClient);
updateSoftwarePostRequestBody.setSoftwareVersion("1.0.96.22");
graphClient.teamwork().devices().byTeamworkDeviceId("{teamworkDevice-id}").updateSoftware().post(updateSoftwarePostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const updateSoftware = {
softwareType: 'teamsClient',
softwareVersion: '1.0.96.22'
};
await client.api('/teamwork/devices/0f3ce432-e432-0f3c-32e4-3c0f32e43c0f/updateSoftware')
.version('beta')
.post(updateSoftware);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Teamwork\Devices\Item\UpdateSoftware\UpdateSoftwarePostRequestBody;
use Microsoft\Graph\Beta\Generated\Models\TeamworkSoftwareType;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new UpdateSoftwarePostRequestBody();
$requestBody->setSoftwareType(new TeamworkSoftwareType('teamsClient'));
$requestBody->setSoftwareVersion('1.0.96.22');
$graphServiceClient->teamwork()->devices()->byTeamworkDeviceId('teamworkDevice-id')->updateSoftware()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Teams
$params = @{
softwareType = "teamsClient"
softwareVersion = "1.0.96.22"
}
Update-MgBetaTeamworkDeviceSoftware -TeamworkDeviceId $teamworkDeviceId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.teamwork.devices.item.update_software.update_software_post_request_body import UpdateSoftwarePostRequestBody
from msgraph_beta.generated.models.teamwork_software_type import TeamworkSoftwareType
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = UpdateSoftwarePostRequestBody(
software_type = TeamworkSoftwareType.TeamsClient,
software_version = "1.0.96.22",
)
await graph_client.teamwork.devices.by_teamwork_device_id('teamworkDevice-id').update_software.post(request_body)
响应
HTTP/1.1 202 Accepted
Location: /teamwork/devices/0f3ce432-e432-0f3c-32e4-3c0f32e43c0f/operations/119eb06d-0c4b-4fb3-a754-33dd0d6b618c
Content-Type: text/plain
Content-Length: 0