printer resource type

Namespace: microsoft.graph

Important

Microsoft is offering usage of the cloud printing APIs to manage Universal Print at no charge and there are no foreseeable plans to charge for the use of these APIs.

Represents a printer device that has been 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:

Inherits from printerBase.

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.
restoreFactoryDefaults None Restore a printer's default settings to the values specified by the manufacturer.
List jobs printJob collection Get a list of print jobs that are queued for processing by the printer.
Create 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 shares printerShare collection Get a list of printerShares that this printer is associated with. Currently, only one printerShare can be associated with a printer.
List taskTriggers None List printTaskTriggers associated with this printer.
Create taskTrigger printTaskTrigger Create a printTaskTrigger that runs when print events occur.
Delete taskTrigger None Delete a printTaskTrigger that is associated with the printer.

Properties

Property Type Description
id String The document's identifier. Inherited from printerBase. Read-only.
displayName String The name of the printer. Inherited from printerBase.
manufacturer String The manufacturer reported by the printer. Inherited from printerBase.
model String The model name reported by the printer. Inherited from printerBase.
registeredDateTime DateTimeOffset The DateTimeOffset when the printer was registered. Read-only.
status printerStatus The processing status of the printer, including any errors. Inherited from printerBase.
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 Whether the printer is currently accepting new print jobs. Inherited from printerBase.
location printerLocation The physical and/or organizational location of the printer. Inherited from printerBase.
defaults printerDefaults The printer's default print settings. Inherited from printerBase.
capabilities printerCapabilities The capabilities of the printer associated with this printer share. Inherited from printerBase.
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 are queued for printing by the printer. Inherited from printerBase.
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 is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.printer",
  "id": "String (identifier)",
  "displayName": "String",
  "manufacturer": "String",
  "model": "String",
  "isAcceptingJobs": "Boolean",
  "defaults": {
    "@odata.type": "microsoft.graph.printerDefaults"
  },
  "location": {
    "@odata.type": "microsoft.graph.printerLocation"
  },
  "capabilities": {
    "@odata.type": "microsoft.graph.printerCapabilities"
  },
  "status": {
    "@odata.type": "microsoft.graph.printerStatus"
  },
  "registeredDateTime": "String (timestamp)",
  "isShared": "Boolean",
  "hasPhysicalDevice": "Boolean",
  "lastSeenDateTime": "String (timestamp)"
}