プリンターを取得する
[アーティクル]
11/18/2023
9 人の共同作成者
フィードバック
この記事の内容
名前空間: microsoft.graph
プリンター オブジェクトのプロパティとリレーションシップを取得します。
この API は、次の国内クラウド展開 で使用できます。
グローバル サービス
米国政府機関 L4
米国政府機関 L5 (DOD)
21Vianet が運営する中国
✅
✅
✅
❌
アクセス許可
この API を呼び出すには、次のいずれかのアクセス許可が必要です。 アクセス許可の選択方法などの詳細については、「アクセス許可 」を参照してください。
ユニバーサル印刷サービスを使用するには、ユーザーまたはアプリのテナントに、次の表に示すアクセス許可に加えて、アクティブなユニバーサル 印刷サブスクリプションが必要です。 サインインしているユーザーは プリンター管理者 である必要があります。
アクセス許可の種類
アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)
Printer.Read.All、Printer.ReadWrite.All、Printer.FullControl.All
委任 (個人用 Microsoft アカウント)
サポートされていません。
アプリケーション
Printer.Read.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 のドキュメント を参照してください。
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 のドキュメント を参照してください。
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
}
}
}