获取打印机
本文内容
命名空间:microsoft.graph
检索 打印机 对象的属性和关系。
此 API 可用于以下国家级云部署 。
全局服务
美国政府 L4
美国政府 L5 (DOD)
由世纪互联运营的中国
✅
✅
✅
❌
权限
要调用此 API,需要以下权限之一。 若要了解详细信息,包括如何选择权限的信息,请参阅权限 。
若要使用通用打印服务,用户或应用的租户必须具有有效的通用打印订阅,以及下表中列出的权限。 登录用户必须是 打印机管理员 。
权限类型
权限(从最低特权到最高特权)
委派(工作或学校帐户)
Printer.Read.All、Printer.ReadWrite.All、Printer.FullControl.All
委派(个人 Microsoft 帐户)
不支持。
应用程序
打印机。阅读.All,Printer.ReadWrite.All
HTTP 请求
GET /print/printers/{id}
GET /print/shares/{id}/printer
可选的查询参数
此方法支持某些 OData 查询参数(包括 $select
和 $expand
),以帮助自定义响应。 例如:
GET /print/printers/{id}?$select=id,displayName,capabilities
若要了解一般信息,请参阅 OData 查询参数 。
名称
说明
Authorization
持有者 {token}。 必填。 详细了解 身份验证和授权 。
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此方法在 200 OK
响应正文中返回响应代码和 打印机 对象。
默认情况下,响应不包含 printerCapabilities 。 若要获取 printerCapabilities ,请使用 $select
查询参数。
示例
示例 1:获取打印机
请求
GET https://graph.microsoft.com/v1.0/print/printers/{printerId}
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Print.Printers["{printer-id}"].GetAsync();
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc print printers get --printer-id {printer-id}
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
//other-imports
)
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)
printers, err := graphClient.Print().Printers().ByPrinterId("printer-id").Get(context.Background(), nil)
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
Printer result = graphClient.print().printers().byPrinterId("{printer-id}").get();
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
const options = {
authProvider,
};
const client = Client.init(options);
let printer = await client.api('/print/printers/{printerId}')
.get();
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
<?php
use Microsoft\Graph\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$result = $graphServiceClient->escapedPrint()->printers()->byPrinterId('printer-id')->get()->wait();
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
Import-Module Microsoft.Graph.Devices.CloudPrint
Get-MgPrintPrinter -PrinterId $printerId
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
from msgraph import GraphServiceClient
graph_client = GraphServiceClient(credentials, scopes)
result = await graph_client.print.printers.by_printer_id('printer-id').get()
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
响应
注意: 为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#print/printers/$entity",
"id": "016b5565-3bbf-4067-b9ff-4d68167eb1a6",
"displayName": "PrinterName",
"manufacturer": "PrinterManufacturer",
"model": "PrinterModel",
"isShared": true,
"registeredDateTime": "2020-02-04T00:00:00.0000000Z",
"isAcceptingJobs": true,
"status": {
"state": "stopped",
"details": [
"disconnected"
],
"description": ""
},
"defaults": {
"copiesPerJob": 1,
"finishings": [
"none"
],
"mediaColor": "Unknown",
"mediaType": "stationery",
"mediaSize": "North America Letter",
"pagesPerSheet": 1,
"orientation": "portrait",
"outputBin": "auto",
"inputBin": "auto",
"contentType": "application/oxps",
"fitPdfToPage": false,
"multipageLayout": null,
"colorMode": "color",
"quality": "medium",
"duplexMode": "oneSided",
"dpi": 600,
"scaling": null
},
"location": {
"latitude": 1.1,
"longitude": 2.2,
"altitudeInMeters": 3,
"streetAddress": "One Microsoft Way",
"subUnit": [
"Main Plaza",
"Unit 400"
],
"city": "Redmond",
"postalCode": "98052",
"countryOrRegion": "USA",
"site": "Puget Sound",
"building": "Studio E",
"floor": "1",
"floorDescription": "First Floor",
"roomName": "1234",
"roomDescription": "First floor copy room",
"organization": [
"C+AI",
"Microsoft Graph"
],
"subdivision": [
"King County",
"Red West"
],
"stateOrProvince": "Washington"
}
}
示例 2:获取打印机及其功能
请求
GET https://graph.microsoft.com/v1.0/print/printers/{printerId}?$select=id,displayName,capabilities
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Print.Printers["{printer-id}"].GetAsync((requestConfiguration) =>
{
requestConfiguration.QueryParameters.Select = new string []{ "id","displayName","capabilities" };
});
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc print printers get --printer-id {printer-id} --select "id,displayName,capabilities"
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphprint "github.com/microsoftgraph/msgraph-sdk-go/print"
//other-imports
)
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)
requestParameters := &graphprint.PrintPrinterItemRequestBuilderGetQueryParameters{
Select: [] string {"id","displayName","capabilities"},
}
configuration := &graphprint.PrintPrinterItemRequestBuilderGetRequestConfiguration{
QueryParameters: requestParameters,
}
printers, err := graphClient.Print().Printers().ByPrinterId("printer-id").Get(context.Background(), configuration)
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
Printer result = graphClient.print().printers().byPrinterId("{printer-id}").get(requestConfiguration -> {
requestConfiguration.queryParameters.select = new String []{"id", "displayName", "capabilities"};
});
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
const options = {
authProvider,
};
const client = Client.init(options);
let printer = await client.api('/print/printers/{printerId}')
.select('id,displayName,capabilities')
.get();
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Print\Printers\Item\PrinterItemRequestBuilderGetRequestConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestConfiguration = new PrinterItemRequestBuilderGetRequestConfiguration();
$queryParameters = PrinterItemRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->select = ["id","displayName","capabilities"];
$requestConfiguration->queryParameters = $queryParameters;
$result = $graphServiceClient->escapedPrint()->printers()->byPrinterId('printer-id')->get($requestConfiguration)->wait();
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
Import-Module Microsoft.Graph.Devices.CloudPrint
Get-MgPrintPrinter -PrinterId $printerId -Property "id,displayName,capabilities"
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
from msgraph import GraphServiceClient
from msgraph.generated.print.printers.item.printer_item_request_builder import PrinterItemRequestBuilder
graph_client = GraphServiceClient(credentials, scopes)
query_params = PrinterItemRequestBuilder.PrinterItemRequestBuilderGetQueryParameters(
select = ["id","displayName","capabilities"],
)
request_configuration = PrinterItemRequestBuilder.PrinterItemRequestBuilderGetRequestConfiguration(
query_parameters = query_params,
)
result = await graph_client.print.printers.by_printer_id('printer-id').get(request_configuration = request_configuration)
有关如何将 SDK 添加 到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档 。
响应
注意: 为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#print/printers/$entity",
"id": "016b5565-3bbf-4067-b9ff-4d68167eb1a6",
"displayName": "PrinterName",
"capabilities": {
"isColorPrintingSupported": true,
"supportsFitPdfToPage": false,
"contentTypes": [
"application/pdf",
"image/pwg-raster",
"application/PCLm"
],
"isPageRangeSupported": false,
"qualities": [
"medium"
],
"dpis": [
600
],
"duplexModes": [
"oneSided",
"flipOnLongEdge",
"flipOnShortEdge"
],
"finishings": [
"none"
],
"mediaTypes": [
"stationery"
],
"mediaSizes": [
"North America Letter"
],
"outputBins": [
"tray-1"
],
"colorModes": [
"grayscale",
"color"
],
"inputBins": [
"tray-1"
],
"collation": true,
"scalings": [
"fill"
],
"copiesPerJob": {
"start": 1,
"end": 38
}
}
}