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.
Update the properties of a printer share. This method can be used to swap printers.
For example, if a physical printer device breaks, an administrator can register a new printer device and update this printerShare to point to the new printer without requiring users to take any action.
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
PATCH /print/shares/{id}
Request body
In the request body, supply the values for relevant printerShare fields to be updated. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.
The following table lists the properties that can be updated.
| Property |
Type |
Description |
| 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 to update which printer this printer share is associated with. |
| displayName |
String |
The name of the printer share that print clients should display. |
| allowAllUsers |
Boolean |
If true, all users and groups are granted access to this printer share. This property supersedes the allow lists defined by the allowedUsers and allowedGroups navigation properties. |
Note
If the printer property is updated, other properties can't be updated in the same request.
Response
If successful, this method returns a 200 OK response code and an updated printerShare object in the response body.
Examples
Request
The following example shows a request.
PATCH https://graph.microsoft.com/beta/print/shares/{id}
Content-type: application/json
{
"displayName": "ShareName",
"allowAllUsers": true,
"printer@odata.bind": "https://graph.microsoft.com/beta/print/printers/{id}"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new PrinterShare
{
DisplayName = "ShareName",
AllowAllUsers = true,
AdditionalData = new Dictionary<string, object>
{
{
"printer@odata.bind" , "https://graph.microsoft.com/beta/print/printers/{id}"
},
},
};
// 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}"].PatchAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewPrinterShare()
displayName := "ShareName"
requestBody.SetDisplayName(&displayName)
allowAllUsers := true
requestBody.SetAllowAllUsers(&allowAllUsers)
additionalData := map[string]interface{}{
"printer@odata.bind" : "https://graph.microsoft.com/beta/print/printers/{id}",
}
requestBody.SetAdditionalData(additionalData)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
shares, err := graphClient.Print().Shares().ByPrinterShareId("printerShare-id").Patch(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
PrinterShare printerShare = new PrinterShare();
printerShare.setDisplayName("ShareName");
printerShare.setAllowAllUsers(true);
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("printer@odata.bind", "https://graph.microsoft.com/beta/print/printers/{id}");
printerShare.setAdditionalData(additionalData);
PrinterShare result = graphClient.print().shares().byPrinterShareId("{printerShare-id}").patch(printerShare);
const options = {
authProvider,
};
const client = Client.init(options);
const printerShare = {
displayName: 'ShareName',
allowAllUsers: true,
'printer@odata.bind': 'https://graph.microsoft.com/beta/print/printers/{id}'
};
await client.api('/print/shares/{id}')
.version('beta')
.update(printerShare);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\PrinterShare;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new PrinterShare();
$requestBody->setDisplayName('ShareName');
$requestBody->setAllowAllUsers(true);
$additionalData = [
'printer@odata.bind' => 'https://graph.microsoft.com/beta/print/printers/{id}',
];
$requestBody->setAdditionalData($additionalData);
$result = $graphServiceClient->escapedPrint()->shares()->byPrinterShareId('printerShare-id')->patch($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Devices.CloudPrint
$params = @{
displayName = "ShareName"
allowAllUsers = $true
"printer@odata.bind" = "https://graph.microsoft.com/beta/print/printers/{id}"
}
Update-MgBetaPrintShare -PrinterShareId $printerShareId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.printer_share import PrinterShare
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = PrinterShare(
display_name = "ShareName",
allow_all_users = True,
additional_data = {
"printer@odata_bind" : "https://graph.microsoft.com/beta/print/printers/{id}",
}
)
result = await graph_client.print.shares.by_printer_share_id('printerShare-id').patch(request_body)
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/$entity",
"id": "d837c17b-3296-4384-a053-828d56e10f50",
"displayName": "ShareName",
"createdDateTime": "2020-02-04T00:00:00.0000000Z",
"isAcceptingJobs": true,
"allowAllUsers": true,
"status": {
"state": "stopped",
"details": ["disconnected"],
"description": ""
}
}