printer resource type
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Represents a printer device that is registered with the Universal Print service. Printer resources can be used to manage print jobs, printer settings, printer metadata, and registration status.
This resource supports:
Methods
| Method | Return Type | Description |
|---|---|---|
| Create | printerCreateOperation | Create (register) a new printer with Universal Print. |
| Get | printer | Read the properties and relationships of the printer object. |
| Update | printer | Update the printer object. |
| Delete | None | Unregister the physical printer from the Universal Print service. |
| Restore factory defaults | None | Restore a printer's default settings to the values specified by the manufacturer. |
| List print jobs | printJob collection | Get a list of print jobs that the printer queues for processing. |
| Create print job | printJob | Create a new print job for the printer. To start printing the job, use start. |
| List connectors | printConnector collection | Get a list of connectors that this printer is associated with. |
| List task triggers | None | List printTaskTriggers associated with this printer. |
| Create task trigger | printTaskTrigger | Create a printTaskTrigger that runs when print events occur. |
| Delete task trigger | None | Delete a printTaskTrigger that is associated with the printer. |
Properties
| Property | Type | Description |
|---|---|---|
| id | String | The printer's identifier. Read-only. |
| displayName | String | The name of the printer. |
| manufacturer | String | The manufacturer reported by the printer. |
| model | String | The model name reported by the printer. |
| registeredDateTime | DateTimeOffset | The DateTimeOffset when the printer was registered. Read-only. |
| status | printerStatus | The processing status of the printer, including any errors. |
| isShared | Boolean | True if the printer is shared; false otherwise. Read-only. |
| hasPhysicalDevice | Boolean | True if the printer has a physical device for printing. Read-only. |
| isAcceptingJobs | Boolean | If true, the printer is currently accepting new print jobs. |
| location | printerLocation | The physical and/or organizational location of the printer. |
| defaults | printerDefaults | The printer's default print settings. |
| capabilities | printerCapabilities | The capabilities of the printer. |
| lastSeenDateTime | DateTimeOffset | The most recent dateTimeOffset when a printer interacted with Universal Print. Read-only. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| jobs | printJob collection | The list of jobs that the printer queues for printing. |
| shares | printerShare collection | The list of printerShares that are associated with the printer. Currently, only one printerShare can be associated with the printer. Read-only. Nullable. |
| connectors | printConnector | The connectors that are associated with the printer. |
| taskTriggers | printTaskTrigger collection | A list of task triggers that are associated with the printer. |
JSON representation
The following JSON representation shows the resource type.
{
"id": "String (identifier)",
"displayName": "String",
"manufacturer": "String",
"model": "String",
"isShared": true,
"registeredDateTime": "String (timestamp)",
"isAcceptingJobs": true,
"hasPhysicalDevice": true,
"location": {"@odata.type": "microsoft.graph.printerLocation"},
"status": {"@odata.type": "microsoft.graph.printerStatus"},
"defaults": {"@odata.type": "microsoft.graph.printerDefaults"},
"capabilities": {"@odata.type": "microsoft.graph.printerCapabilities"},
"lastSeenDateTime": "String (timestamp)"
}