プリンターを更新する

[アーティクル]
01/20/2022

名前空間: microsoft.graph

重要

Microsoft Graph のバージョンの /beta API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。

プリンターオブジェクトのプロパティを更新します。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

次のアクセス許可に加えて、ユーザーのテナントにアクティブなユニバーサル印刷サブスクリプションが必要です。サインインしているユーザーはプリンター管理者である必要があります。

プリンターを登録したアプリだけが、アプリケーションのアクセス許可を使用してプリンターを更新できます。

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	Printer.ReadWrite.All, Printer.FullControl.All
委任 (個人用 Microsoft アカウント)	サポートされていません。
アプリケーション	Printer.ReadWrite.All

注: 現在、アプリケーションのアクセス許可を使用して更新できるのは、物理デバイスを持つプリンターのみです。

HTTP 要求

PATCH /print/printers/{id}

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須。
Content-type	`application/json` 委任されたアクセス許可を使用する場合、または `application/ipp` `application/json` アプリケーションのアクセス許可を使用する場合。必須です。

要求本文

委任されたアクセス許可と JSON ペイロード

委任されたアクセス許可を使用する場合は、要求本文で、更新する必要がある関連するプリンターフィールドの値を指定します。要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。最適なパフォーマンスを得るために、変更されていない既存の値を含めないでください。

委任されたアクセス許可を使用して、次のプロパティを更新できます。

プロパティ	型	説明
既定	printerDefaults	プリンターの既定の印刷設定。
場所	printerLocation	プリンターの物理的な場所または組織の場所。
displayName	String	プリンターの名前。

アプリケーションのアクセス許可と JSON ペイロード

要求本文で、更新する必要がある関連するプリンターフィールドの値を指定します。要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。最適なパフォーマンスを得るために、変更されていない既存の値を含めないでください。

次のプロパティは、アプリケーションのアクセス許可を使用して更新できます。

プロパティ	型	説明
既定	printerDefaults	プリンターの既定の印刷設定。
capabilities	printerCapabilities	このプリンター共有に関連付けられているプリンターの機能。
displayName	String	プリンターの名前。
manufacturer	String	プリンターの製造元。
model	String	プリンターのモデル名。
status	printerStatus	エラーを含むプリンターの処理状態。
isAcceptingJobs	Boolean	プリンターが現在新しい印刷ジョブを受け入れるかどうか。

アプリケーションのアクセス許可と IPP ペイロード

アプリケーションのアクセス許可を使用すると、インターネット印刷プロトコル (IPP) ペイロードを使用してプリンターを更新できます。この場合、要求本文には、IPP エンコードの Printer Attributes グループを表すバイナリストリームが含まれています。

クライアントは、RFC8011 セクション 5.2ジョブテンプレート属性 ("xxx-default"、"xxx-supported"、"xxx-ready" 属性)、セクション5.4 Printer Description Attributes、および Printer でサポートされる属性拡張で定義されている 1 つ以上の値 (明示的に許可されたアウトオブバンド値を含む) を含む Printer 属性のセットを指定する必要があります。指定された各 Printer 属性の値は、ターゲット Printer オブジェクトの対応する Printer 属性の値を置き換える。複数の値 (1setOf) を持つ属性の場合、クライアントによって指定された値はすべて、対応する Printer オブジェクト属性のすべての値を置き換える。

注: 要求本文で操作属性を渡す必要はありません。要求本文にはプリンター属性のみを含む必要があります。

注: プリンターが特定のプラットフォームで動作するには、そのプラットフォームの要件を満たす必要があります。たとえば、Windows クライアントでは、プリンターが MOPRIA 仕様ごとに必須と見なされるすべての属性を指定する必要があります。 MOPRIA の仕様は、MOPRIA の有料メンバーだけが利用できます。

応答

委任されたアクセス許可と JSON ペイロード

委任されたアクセス許可を使用する場合、成功した場合、このメソッドは応答コードと更新されたプリンターオブジェクトを応答本文 200 OK で返します。

アプリケーションのアクセス許可と JSON ペイロード

アプリケーションのアクセス許可と IPP ペイロード

アプリケーションのアクセス許可を使用している場合、成功した場合、このメソッドは応答コード 204 No content を返します。応答本文には何も返されません。

例

要求

要求の例を次に示します。

PATCH https://graph.microsoft.com/beta/print/printers/{id}
Content-type: application/json

{
  "name": "PrinterName",
  "location": {
    "latitude": 1.1,
    "longitude": 2.2,
    "altitudeInMeters": 3
  }
}


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var printer = new Printer
{
    Name = "PrinterName",
    Location = new PrinterLocation
    {
        Latitude = 1.1,
        Longitude = 2.2,
        AltitudeInMeters = 3
    }
};

await graphClient.Print.Printers["{printer-id}"]
    .Request()
    .UpdateAsync(printer);

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ版で使用できるすべての種類、プロパティ、API はサポートされていません。 SDK を使用してベータ API にアクセスする方法の詳細については、「Microsoft Graph SDK とベータ API を使用する」を参照してください。

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


const options = {
    authProvider,
};

const client = Client.init(options);

const printer = {
  name: 'PrinterName',
  location: {
    latitude: 1.1,
    longitude: 2.2,
    altitudeInMeters: 3
  }
};

await client.api('/print/printers/{id}')
    .version('beta')
    .update(printer);

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/print/printers/{id}"]]];
[urlRequest setHTTPMethod:@"PATCH"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

MSGraphPrinter *printer = [[MSGraphPrinter alloc] init];
[printer setName:@"PrinterName"];
MSGraphPrinterLocation *location = [[MSGraphPrinterLocation alloc] init];
[location setLatitude: 1.1];
[location setLongitude: 2.2];
[location setAltitudeInMeters: 3];
[printer setLocation:location];

NSError *error;
NSData *printerData = [printer getSerializedDataWithError:&error];
[urlRequest setHTTPBody:printerData];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        //Request Completed

}];

[meDataTask execute];

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

Printer printer = new Printer();
printer.name = "PrinterName";
PrinterLocation location = new PrinterLocation();
location.latitude = 1.1d;
location.longitude = 2.2d;
location.altitudeInMeters = 3;
printer.location = location;

graphClient.print().printers("{id}")
    .buildRequest()
    .patch(printer);

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := msgraphsdk.NewPrinter()
name := "PrinterName"
requestBody.SetName(&name)
location := msgraphsdk.NewPrinterLocation()
requestBody.SetLocation(location)
latitude := float64(1.1)
location.SetLatitude(&latitude)
longitude := float64(2.2)
location.SetLongitude(&longitude)
altitudeInMeters := int32(3)
location.SetAltitudeInMeters(&altitudeInMeters)
printerId := "printer-id"
graphClient.Print().PrintersById(&printerId).Patch(requestBody)

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


Import-Module Microsoft.Graph.Devices.CloudPrint

$params = @{
    Name = "PrinterName"
    Location = @{
        Latitude = 1.1
        Longitude = 2.2
        AltitudeInMeters = 3
    }
}

Update-MgPrintPrinter -PrinterId $printerId -BodyParameter $params

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

応答の例を次に示します。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$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": "idle",
    "details": [],
    "description": ""
  },
  "defaults": {
    "copiesPerJob":1,
    "contentType": "application/oxps",
    "finishings": ["none"],
    "mediaType": "stationery"
  },
  "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"
  }
}

プリンターを更新する

アクセス許可

HTTP 要求

要求ヘッダー

要求本文

委任されたアクセス許可と JSON ペイロード

アプリケーションのアクセス許可と JSON ペイロード

アプリケーションのアクセス許可と IPP ペイロード

応答

委任されたアクセス許可と JSON ペイロード

アプリケーションのアクセス許可と JSON ペイロード

アプリケーションのアクセス許可と IPP ペイロード

例

要求

応答

フィードバック