PrinterShare.ReadBasic.All | Graph Permissions

Permission Details

Delegated Permission

Read basic information about printer shares

Allows the application to read basic information about printer shares on behalf of the signed-in user. Does not allow reading access control information.

Permission ID: 5fa075e9-b951-4165-947b-c63396ff0a37

Properties

Microsoft Graph v1.0 exact-category-docs

Properties is shown from stable Microsoft Graph v1.0 metadata.

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`Nullable	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`Nullable	The manufacturer reported by the printer associated with this printer share. Inherited from printerBase. Read-only.
`model`	`String`Nullable	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.
`allowedGroups`	`group collection`	The groups whose users have access to print using the printer.
`allowedUsers`	`user collection`	The users who have access to print using the printer.
`jobs`	`printJob collection`	The list of jobs that are queued for printing by the printer/printerShare.

Showing 15 of 16 properties.

JSON Representation

Microsoft Graph v1.0 exact-category-docs

JSON representation is shown from stable Microsoft Graph v1.0 metadata.

JSON representation

{
  "@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"
  }
}

Relationships

Microsoft Graph v1.0 exact-category-docs

Relationships is shown from stable Microsoft Graph v1.0 metadata.

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.
`status`	`printerStatus`	Related status data exposed by this resource.

Graph Methods

Delegated access App-only access

Exact Microsoft Learn match

Microsoft Graph v1.0 endpoints are mapped directly from refreshed Microsoft Learn permissions tables.

Methods
GET `/me/print/recentPrinterShares`
GET `/print/printers/{printerId}/shares`
GET `/print/printers/{printerId}/shares/{printerShareId}`
GET `/print/services`
GET `/print/services/{printServiceId}`
GET `/print/services/{printServiceId}/endpoints`
GET `/print/services/{printServiceId}/endpoints/{printServiceEndpointId}`
GET `/print/shares`
GET `/print/shares/{printerShareId}`

Exact Microsoft Learn match

Microsoft Graph beta endpoints are mapped directly from refreshed Microsoft Learn permissions tables.

Methods
GET `/me/print/recentPrinterShares`
GET `/print/printers/{printerId}/shares/{printerShareId}`
GET `/print/services`
GET `/print/services/{id}`
GET `/print/services/{id}/endpoints`
GET `/print/services/{id}/endpoints/{name}`
GET `/print/shares`
GET `/print/shares/{printerShareId}`

Exact Microsoft Learn PowerShell match

Microsoft Graph PowerShell v1.0 commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.

Commands
`Get-MgPrintPrinterShare` /print/printers/{printerId}/shares List printerShares for a printer
`Get-MgPrintService` /print/services List printServices
`Get-MgPrintService` /print/services/{printServiceId} Get printService
`Get-MgPrintServiceEndpoint` /print/services/{printServiceId}/endpoints List endpoints
`Get-MgPrintServiceEndpoint` /print/services/{printServiceId}/endpoints/{printServiceEndpointId} Get printServiceEndpoint
`Get-MgPrintShare` /print/shares List shares
`Get-MgPrintShare` /print/shares/{printerShareId} Get printerShare

Exact Microsoft Learn PowerShell match

Microsoft Graph PowerShell beta commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.

Commands
`Get-MgBetaPrintService` /print/services List printServices
`Get-MgBetaPrintService` /print/services/{id} Get printService
`Get-MgBetaPrintServiceEndpoint` /print/services/{id}/endpoints List printServiceEndpoints
`Get-MgBetaPrintServiceEndpoint` /print/services/{id}/endpoints/{name} Get printServiceEndpoint
`Get-MgBetaPrintShare` /print/shares List shares
`Get-MgBetaPrintShare` /print/shares/{printerShareId} Get printerShare

Code Examples

C# / .NET SDK

Get printerShare

View official example on Microsoft Learn

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Print.Shares["{printerShare-id}"].GetAsync();

JavaScript

Get printerShare

View official example on Microsoft Learn

const options = {
	authProvider,
};

const client = Client.init(options);

let printerShare = await client.api('/print/shares/{printerShareId}')
	.get();

PowerShell

Get printerShare

View official example on Microsoft Learn

Import-Module Microsoft.Graph.Devices.CloudPrint

Get-MgPrintShare -PrinterShareId $printerShareId

Python

Get printerShare

View official example on Microsoft Learn

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.print.shares.by_printer_share_id('printerShare-id').get()

App Registration

1

Navigate to Azure Portal

Go to App registrations in Microsoft Entra admin center

2

Add API Permission

Select your app → API permissions → Add a permission → Microsoft Graph

3

Select Permission Type

Choose Delegated permissions and search for PrinterShare.ReadBasic.All

4

Grant Admin Consent

Users can consent to this permission during sign-in.