命名空间:microsoft.graph
更新打印机共享的属性。 此方法可用于更换 打印机。
例如,如果物理打印机设备发生故障,管理员可以注册新的 打印机 设备,并更新此 printerShare 以指向新打印机,而无需用户执行任何操作。
API 可用性
此 API 可用于以下国家级云部署。
| 全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 |
|---|---|---|---|
| ✅ | ✅ | ✅ | ❌ |
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
| 权限类型 | 最低特权权限 | 更高特权权限 |
|---|---|---|
| 委派(工作或学校帐户) | PrinterShare.ReadWrite.All | 不可用。 |
| 委派(个人 Microsoft 帐户) | 不支持。 | 不支持。 |
| 应用程序 | 不支持。 | 不支持。 |
HTTP 请求
PATCH /print/shares/{printerShareId}
请求标头
| 名称 | 说明 |
|---|---|
| Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
| Content-Type | application/json. 必需。 |
请求正文
在请求正文中,为应更新的相关 printerShare 字段提供值。 请求正文中未包含的现有属性将保留其以前的值或根据其他属性值的更改重新计算。 为了获得最佳性能,请勿加入尚未更改的现有值。
可以更新以下属性:
| 属性 | 类型 | 说明 |
|---|---|---|
| allowAllUsers | 布尔值 | 如果为 true,则向所有用户和组授予对此打印机共享的访问权限。 这将取代由 allowedUsers 和 allowedGroups 导航属性定义的允许列表。 |
| displayName | String | 打印客户端应显示的打印机共享的名称。 |
| holdJobsForSecureRelease | 布尔值 | 指示发送到此打印机共享的打印作业是否保留在云中,直到用户在打印机上释放它们为止。 设置为 true 启用安全发布。 可选。 |
| 打印机 | microsoft.graph.printer | 此打印机共享相关的打印机。 使用以下示例中所示的语法更新 printer@odata.bind 此打印机共享与哪个打印机关联。 |
注意
如果要更新 打印机 属性,则无法在同一请求中更新其他属性。
响应
如果成功,此方法将在响应正文中返回 200 OK 响应代码和更新的 printerShare 对象。
示例
示例 1:更新与共享关联的打印机
以下示例演示如何更新与共享关联的打印机。
请求
以下示例显示了一个请求。
PATCH https://graph.microsoft.com/v1.0/print/shares/d837c17b-3296-4384-a053-828d56e10f50
Content-Type: application/json
{
"printer@odata.bind": "https://graph.microsoft.com/v1.0/print/printers/d5f2a1b0-1111-2222-3333-444455556666"
}
响应
以下示例显示了相应的响应。 注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#print/shares/$entity",
"id": "d837c17b-3296-4384-a053-828d56e10f50",
"displayName": "PrinterShare Name",
"createdDateTime": "2020-02-04T00:00:00.0000000Z",
"isAcceptingJobs": true,
"allowAllUsers": false,
"status": {
"state": "stopped",
"details": ["disconnected"],
"description": ""
}
}
示例 2:启用安全发布
以下示例为打印机共享启用安全发布。
请求
以下示例显示了一个请求。
PATCH https://graph.microsoft.com/v1.0/print/shares/b1c2d3e4-5555-6666-7777-888899990000
Content-Type: application/json
{
"holdJobsForSecureRelease": true
}
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "b1c2d3e4-5555-6666-7777-888899990000",
"displayName": "Contoso Printer - Building 5, Floor 2",
"holdJobsForSecureRelease": true
}