Skip to content

print-list-shares.md

Latest commit

 

History

History
138 lines (106 loc) · 4.83 KB

print-list-shares.md

File metadata and controls

138 lines (106 loc) · 4.83 KB
title Get shares
description Retrieve a list of printer shares.
author braedenp-msft
ms.localizationpriority medium
ms.subservice universal-print
doc_type apiPageType
ms.date 04/05/2024

List shares

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Retrieve a list of printerShares.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

GET /print/shares

Optional query parameters

This method supports some of the OData query parameters to help customize the response. For general information, see OData query parameters.

Note: Using $top=n query parameter will return up to n shares. Caller needs to use skip token to enumerate over the entire list.

Exceptions

Some operators are not supported: $count, $orderby, $search.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of printerShare objects in the response body.

Note: The response will not contain the defaults or capabilities properties.

For following scenarios, response will contain limited set of properties (id,displayName,manufacturer,model,location):

  • Listing printer shares on behalf of user who is not Printer Administrator.
  • Filtering printer shares based on capabilities or location.

You can get additional properties via a Get printerShare request.

Example

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/print/shares

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#print/shares",
  "value": [
    {
      "id": "016b5565-3bbf-4067-b9ff-4d68167eb1a6",
      "displayName": "PrinterShareName",
      "createdDateTime": "2020-02-04T00:00:00.0000000Z"
    }
  ]
}