命名空间:microsoft.graph
更新 对象的属性 nameditem
。
此 API 可用于以下国家级云部署。
全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
✅ |
✅ |
✅ |
❌ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
权限类型 |
最低特权权限 |
更高特权权限 |
委派(工作或学校帐户) |
Files.ReadWrite |
不可用。 |
委派(个人 Microsoft 帐户) |
Files.ReadWrite |
不可用。 |
应用程序 |
不支持。 |
不支持。 |
HTTP 请求
PATCH /me/drive/items/{id}/workbook/names/{name}
PATCH /me/drive/root:/{item-path}:/workbook/names/{name}
名称 |
说明 |
Authorization |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
Content-Type |
application/json. 必需。 |
Workbook-Session-Id |
确定是否保留更改的工作簿会话 ID。 可选。 |
请求正文
在请求正文中,提供应更新的相关字段的值。 请求正文中未包含的现有属性会保留其以前的值,或者根据对其他属性值的更改重新计算。 为了实现最佳性能,不得添加尚未变化的现有值。
属性 |
类型 |
说明 |
visible |
布尔值 |
指定对象是否可见。 |
comment |
string |
表示与此名称相关联的注释。 |
响应
如果成功,此方法在响应正文中返回响应 200 OK
代码和更新 的 workbookNamedItem 对象。
示例
请求
以下示例显示了一个请求。
PATCH https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}
Content-type: application/json
{
"type": "type-value",
"scope": "scope-value",
"comment": "comment-value",
"value": {
},
"visible": true
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
using Microsoft.Kiota.Abstractions.Serialization;
var requestBody = new WorkbookNamedItem
{
Type = "type-value",
Scope = "scope-value",
Comment = "comment-value",
Value = new UntypedObject(new Dictionary<string, UntypedNode>
{
}),
Visible = 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}"].Workbook.Names["{workbookNamedItem-id}"].PatchAsync(requestBody);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
mgc drives items workbook names patch --drive-id {drive-id} --drive-item-id {driveItem-id} --workbook-named-item-id {workbookNamedItem-id} --body '{\
"type": "type-value",\
"scope": "scope-value",\
"comment": "comment-value",\
"value": {\
},\
"visible": true\
}\
'
有关如何将 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.NewWorkbookNamedItem()
type := "type-value"
requestBody.SetType(&type)
scope := "scope-value"
requestBody.SetScope(&scope)
comment := "comment-value"
requestBody.SetComment(&comment)
value := graph.NewUntypedNode()
requestBody.SetValue(value)
visible := true
requestBody.SetVisible(&visible)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
names, err := graphClient.Drives().ByDriveId("drive-id").Items().ByDriveItemId("driveItem-id").Workbook().Names().ByWorkbookNamedItemId("workbookNamedItem-id").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);
WorkbookNamedItem workbookNamedItem = new WorkbookNamedItem();
workbookNamedItem.setType("type-value");
workbookNamedItem.setScope("scope-value");
workbookNamedItem.setComment("comment-value");
UntypedNode value = new UntypedNode();
workbookNamedItem.setValue(value);
workbookNamedItem.setVisible(true);
WorkbookNamedItem result = graphClient.drives().byDriveId("{drive-id}").items().byDriveItemId("{driveItem-id}").workbook().names().byWorkbookNamedItemId("{workbookNamedItem-id}").patch(workbookNamedItem);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
const options = {
authProvider,
};
const client = Client.init(options);
const workbookNamedItem = {
type: 'type-value',
scope: 'scope-value',
comment: 'comment-value',
value: {
},
visible: true
};
await client.api('/me/drive/items/{id}/workbook/names/{name}')
.update(workbookNamedItem);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\WorkbookNamedItem;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new WorkbookNamedItem();
$requestBody->setType('type-value');
$requestBody->setScope('scope-value');
$requestBody->setComment('comment-value');
$value = new UntypedNode();
$requestBody->setValue($value);
$requestBody->setVisible(true);
$result = $graphServiceClient->drives()->byDriveId('drive-id')->items()->byDriveItemId('driveItem-id')->workbook()->names()->byWorkbookNamedItemId('workbookNamedItem-id')->patch($requestBody)->wait();
有关如何将 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.workbook_named_item import WorkbookNamedItem
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = WorkbookNamedItem(
type = "type-value",
scope = "scope-value",
comment = "comment-value",
value = UntypedNode(
),
visible = True,
)
result = await graph_client.drives.by_drive_id('drive-id').items.by_drive_item_id('driveItem-id').workbook.names.by_workbook_named_item_id('workbookNamedItem-id').patch(request_body)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
响应
以下示例显示了相应的响应。 注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"name": "name-value",
"type": "type-value",
"value": {
},
"visible": true
}