プリンター共有を更新する

名前空間: microsoft.graph

重要

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

プリンター共有のプロパティを更新します。 このメソッドは、 プリンターをスワップするために使用できます。

たとえば、物理プリンター デバイスが故障した場合、管理者は新しい プリンター デバイスを登録し、ユーザーが何もしなくても新しいプリンターを指すようにこの printerShare を更新できます。

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

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

アクセス許可

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

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

HTTP 要求

PATCH /print/shares/{id}

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-type application/json. 必須です。

要求本文

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

次の表は、更新可能なプロパティの一覧です。

プロパティ 説明
プリンター microsoft.graph.printer このプリンター共有が関連するプリンター。 次の例に示す printer@odata.bind 構文を使用して、このプリンター共有が関連付けられているプリンターを更新します。
displayName 文字列 印刷クライアントが表示するプリンター共有の名前。
allowAllUsers ブール型 trueする場合、すべてのユーザーとグループにこのプリンター共有へのアクセス権が付与されます。 このプロパティは、 allowedUsers ナビゲーション プロパティおよび allowedGroups ナビゲーション プロパティで定義された許可リストに優先します。

注:

プリンター プロパティが更新された場合、同じ要求で他のプロパティを更新することはできません。

応答

成功した場合、このメソッドは応答本文で 200 OK 応答コードと更新された printerShare オブジェクトを返します。

要求

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

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

{
  "displayName": "ShareName",
  "allowAllUsers": true,
  "printer@odata.bind": "https://graph.microsoft.com/beta/print/printers/{id}"
}

応答

次の例は応答を示しています。

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

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#print/shares/$entity",
  "id": "d837c17b-3296-4384-a053-828d56e10f50",
  "displayName": "ShareName",
  "createdDateTime": "2020-02-04T00:00:00.0000000Z",
  "isAcceptingJobs": true,
  "allowAllUsers": true,
  "status": {
    "state": "stopped",
    "details": ["disconnected"],
    "description": ""
  }
}