プリンターを更新する

名前空間: microsoft.graph

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

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください

アクセス許可の種類 最小特権アクセス許可 特権の高いアクセス許可
委任 (職場または学校のアカウント) Printer.ReadWrite.All Printer.FullControl.All
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション Printer.ReadWrite.All 注意事項なし。

メモ: 現時点では、アプリケーションのアクセス許可を使用して、物理デバイスを持たないプリンターのみを更新できます。

HTTP 要求

PATCH /print/printers/{printerId}

要求ヘッダー

名前 説明
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 ブール型 プリンターが現在新しい印刷ジョブを受け入れているかどうか。

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

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

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

メモ: 要求本文に操作属性を渡さないでください。 要求本文にはプリンター属性のみを含める必要があります。

メモ: プリンターが特定のプラットフォームと連携するには、そのプラットフォームの要件を満たす必要があります。 たとえば、Windows クライアントでは、 プリンターが MOPRIA 仕様に従って必須と見なされるすべての属性を指定することが想定されます。 MOPRIAのスペックはMOPRIAの有料会員のみが利用できます。

応答

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

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

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

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

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

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

要求

次の例は要求を示しています。

PATCH https://graph.microsoft.com/v1.0/print/printers/{printerId}
Content-Type: application/json

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

応答

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

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": "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"
  }
}