Create printerShare
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.
Create a new printerShare for the specified printer.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
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.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | PrinterShare.ReadWrite.All | Not available. |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Not supported. | Not supported. |
HTTP request
POST /print/shares
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-type | application/json. Required. |
Request body
In the request body, supply a JSON representation of the printerShare object.
The following table shows the properties that can be provided when you create the printerShare.
Property | Type | Description | Required? |
---|---|---|---|
printer | microsoft.graph.printer | The printer that this printer share is related to. Use the printer@odata.bind syntax as shown in the following example. |
Yes |
displayName | String | The name of the printer share that print clients should display. Maximum length allowed is 50 characters. | Yes |
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. | No |
Response
If successful, this method returns a 201 Created
response code and a printerShare object in the response body.
Example
Request
The following example shows a request.
POST https://graph.microsoft.com/beta/print/shares
Content-type: application/json
{
"name": "name-value",
"printer@odata.bind": "https://graph.microsoft.com/beta/print/printers/{id}"
}
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 201 Created
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#print/shares/$entity",
"id": "7361c7c1-ff07-4565-9897-bef6895a7d04",
"displayName": "ShareName",
"createdDateTime": "2020-02-04T00:00:00.0000000Z"
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for