printerShare resource type
Namespace: microsoft.graph
Represents a printer that is intended to be discoverable by users and printing applications.
Inherits from printerBase.
Methods
| Method | Return type | Description |
|---|---|---|
| List | printerShare collection | Get a list of printer shares in the tenant. |
| Get | printerShare | Read properties and relationships of a printerShare object. |
| Update | printerShare | Update a printerShare object. |
| Delete | None | Unshare a printer. |
| List jobs for a printer share | printJob collection | Get a list of print jobs that are queued for processing by the printerShare. |
| Create job for a printer share | printJob | Create a new print job for the printerShare. To start printing the job, use start. |
| List allowed users | user collection | Retrieve a list of users who have been granted access to submit print jobs to the associated printer share. |
| Create allowed user | None | Grant the specified user access to submit print jobs to the associated printer share. |
| Delete allowed user | None | Revoke printer share access from the specified user. |
| List allowed groups | group collection | Retrieve a list of groups that have been granted access to submit print jobs to the associated printer share. |
| Create allowed group | None | Grant the specified group access to submit print jobs to the associated printer share. |
| Delete allowed group | None | Revoke printer share access from the specified group. |
Properties
| Property | Type | Description |
|---|---|---|
| allowAllUsers | Boolean | If true, all users and groups will be granted access to this printer share. This supersedes the allow lists defined by the allowedUsers and allowedGroups navigation properties. |
| capabilities | printerCapabilities | The capabilities of the printer associated with this printer share. Inherited from printerBase. |
| createdDateTime | DateTimeOffset | The DateTimeOffset when the printer share was created. Read-only. |
| defaults | printerDefaults | The default print settings of the printer associated with this printer share. Inherited from printerBase. |
| displayName | String | The name of the printer share that print clients should display. Inherited from printerBase. |
| id | String | The printerShare's identifier. Inherited from printerBase. Read-only. |
| isAcceptingJobs | Boolean | Whether the printer associated with this printer share is currently accepting new print jobs. Inherited from printerBase. |
| location | printerLocation | The physical and/or organizational location of the printer associated with this printer share. Inherited from printerBase. |
| manufacturer | String | The manufacturer reported by the printer associated with this printer share. Inherited from printerBase. Read-only. |
| model | String | The model name reported by the printer associated with this printer share. Inherited from printerBase. Read-only. |
| status | printerStatus | The processing status, including any errors, of the printer associated with this printer share.Inherited from printerBase. Read-only. |
| viewPoint | printerShareViewpoint | Additional data for a printer share as viewed by the signed-in user. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| printer | printer | The printer that this printer share is related to. |
| allowedUsers | user collection | The users who have access to print using the printer. |
| allowedGroups | group | The groups whose users have access to print using the printer. |
| jobs | printJob collection | The list of jobs that are queued for printing by the printer associated with this printer share. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.printerShare",
"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"
},
"allowAllUsers": "Boolean",
"createdDateTime": "String (timestamp)",
"viewPoint": {"@odata.type": "microsoft.graph.printerShareViewpoint"}
}