Mettre à jour l’imprimante

Espace de noms: microsoft.graph

Mettez à jour les propriétés d’un objet imprimante .

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	✅	✅	❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	Printer.ReadWrite.All	Printer.FullControl.All
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	Printer.ReadWrite.All	Non disponible.

Note: À l’heure actuelle, seules les imprimantes qui n’ont pas d’appareils physiques peuvent être mises à jour à l’aide des autorisations d’application.

Requête HTTP

PATCH /print/printers/{printerId}

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-type	application/json lors de l’utilisation d’autorisations déléguées ou application/ippapplication/json lors de l’utilisation d’autorisations d’application. Obligatoire.

Corps de la demande

Autorisations déléguées et charge utile JSON

Si vous utilisez des autorisations déléguées, dans le corps de la demande, fournissez les valeurs des champs d’imprimante appropriés qui doivent être mis à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conservent leurs valeurs précédentes ou sont recalculées en fonction des modifications apportées à d’autres valeurs de propriété. Pour de meilleures performances, n’incluez pas de valeurs existantes qui n’ont pas été modifiées.

Les propriétés suivantes peuvent être mises à jour à l’aide d’autorisations déléguées.

Propriété	Type	Description
Valeurs par défaut	printerDefaults	Paramètres d’impression par défaut de l’imprimante.
emplacement	printerLocation	Emplacement physique et/ou organisationnel de l’imprimante.
displayName	String	Nom de l’imprimante.

Autorisations d’application et charge utile JSON

Dans le corps de la demande, fournissez les valeurs des champs d’imprimante appropriés qui doivent être mis à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conservent leurs valeurs précédentes ou sont recalculées en fonction des modifications apportées à d’autres valeurs de propriété. Pour de meilleures performances, n’incluez pas de valeurs existantes qui n’ont pas été modifiées.

Les propriétés suivantes peuvent être mises à jour à l’aide des autorisations d’application.

Propriété	Type	Description
Valeurs par défaut	printerDefaults	Paramètres d’impression par défaut de l’imprimante.
fonctionnalités	printerCapabilities	Fonctionnalités de l’imprimante associée à ce partage d’imprimantes.
displayName	String	Nom de l’imprimante.
Fabricant	String	Fabricant de l’imprimante.
model	String	Nom du modèle de l’imprimante.
status	printerStatus	La status de traitement de l’imprimante, y compris les erreurs éventuelles.
isAcceptingJobs	Boolean	Indique si l’imprimante accepte actuellement de nouveaux travaux d’impression.

Autorisations d’application et charge utile IPP

Avec les autorisations d’application, une imprimante peut également être mise à jour à l’aide d’une charge utile IPP (Internet Printing Protocol). Dans ce cas, le corps de la requête contient un flux binaire qui représente le groupe Attributs de l’imprimante dans l’encodage IPP.

Le client DOIT fournir un ensemble d’attributs Printer avec une ou plusieurs valeurs (y compris les valeurs hors bande explicitement autorisées) telles que définies dans RFC8011 section 5.2 Attributs de modèle de travail (« attributs xxx-default », « xxx-supported » et « xxx-ready »), Section 5.4 Attributs de description de l’imprimante. Le client doit également fournir toutes les extensions d’attribut prises en charge par l’imprimante. La ou les valeurs de chaque attribut Printer fourni remplacent la ou les valeurs de l’attribut Printer correspondant sur l’objet Printer cible. Pour les attributs qui peuvent avoir plusieurs valeurs (1setOf), toutes les valeurs fournies par le client remplacent toutes les valeurs de l’attribut d’objet Printer correspondant.

Note: Ne transmettez pas les attributs d’opération dans le corps de la demande. Le corps de la demande doit contenir uniquement des attributs d’imprimante.

Note: Pour que les imprimantes fonctionnent avec une plateforme particulière, elles doivent répondre aux exigences de cette plateforme. Par exemple, sur le client Windows, il est prévu que l’imprimante spécifie tous les attributs considérés comme obligatoires conformément aux spécifications MOPRIA . Veuillez noter que les spécifications MOPRIA sont disponibles uniquement pour les membres rémunérés de MOPRIA.

Réponse

Autorisations déléguées et charge utile JSON

Si vous utilisez des autorisations déléguées, si elle réussit, cette méthode renvoie un 200 OK code de réponse et un objet imprimante mis à jour dans le corps de la réponse.

Autorisations d’application et charge utile JSON

Si vous utilisez des autorisations déléguées, si elle réussit, cette méthode renvoie un 200 OK code de réponse et un objet imprimante mis à jour dans le corps de la réponse.

Autorisations d’application et charge utile IPP

Si vous utilisez des autorisations d’application, si elle réussit, cette méthode retourne un 204 No content code de réponse. Il ne retourne rien dans le corps de la réponse.

Exemples

Demande

L’exemple suivant illustre une demande.

HTTP

PATCH https://graph.microsoft.com/v1.0/print/printers/{printerId}
Content-Type: application/json

{
  "name": "PrinterName",
  "location": {
    "latitude": 1.1,
    "longitude": 2.2,
    "altitudeInMeters": 3
  }
}

C#

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

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new Printer
{
	Location = new PrinterLocation
	{
		Latitude = 1.1d,
		Longitude = 2.2d,
		AltitudeInMeters = 3,
	},
	AdditionalData = new Dictionary<string, object>
	{
		{
			"name" , "PrinterName"
		},
	},
};

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

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc print printers patch --printer-id {printer-id} --body '{\
  "name": "PrinterName",\
  "location": {\
    "latitude": 1.1,\
    "longitude": 2.2,\
    "altitudeInMeters": 3\
  }\
}\
'

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewPrinter()
location := graphmodels.NewPrinterLocation()
latitude := float64(1.1)
location.SetLatitude(&latitude) 
longitude := float64(2.2)
location.SetLongitude(&longitude) 
altitudeInMeters := int32(3)
location.SetAltitudeInMeters(&altitudeInMeters) 
requestBody.SetLocation(location)
additionalData := map[string]interface{}{
	"name" : "PrinterName", 
}
requestBody.SetAdditionalData(additionalData)

printers, err := graphClient.Print().Printers().ByPrinterId("printer-id").Patch(context.Background(), requestBody, nil)

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Java

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Printer printer = new Printer();
PrinterLocation location = new PrinterLocation();
location.setLatitude(1.1d);
location.setLongitude(2.2d);
location.setAltitudeInMeters(3);
printer.setLocation(location);
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("name", "PrinterName");
printer.setAdditionalData(additionalData);
Printer result = graphClient.print().printers().byPrinterId("{printer-id}").patch(printer);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const printer = {
  name: 'PrinterName',
  location: {
    latitude: 1.1,
    longitude: 2.2,
    altitudeInMeters: 3
  }
};

await client.api('/print/printers/{printerId}')
	.update(printer);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Printer;
use Microsoft\Graph\Generated\Models\PrinterLocation;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new Printer();
$location = new PrinterLocation();
$location->setLatitude(1.1);
$location->setLongitude(2.2);
$location->setAltitudeInMeters(3);
$requestBody->setLocation($location);
$additionalData = [
	'name' => 'PrinterName',
];
$requestBody->setAdditionalData($additionalData);

$result = $graphServiceClient->escapedPrint()->printers()->byPrinterId('printer-id')->patch($requestBody)->wait();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Python

from msgraph import GraphServiceClient
from msgraph.generated.models.printer import Printer
from msgraph.generated.models.printer_location import PrinterLocation

graph_client = GraphServiceClient(credentials, scopes)

request_body = Printer(
	location = PrinterLocation(
		latitude = 1.1,
		longitude = 2.2,
		altitude_in_meters = 3,
	),
	additional_data = {
			"name" : "PrinterName",
	}
)

result = await graph_client.print.printers.by_printer_id('printer-id').patch(request_body)

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Réponse

L’exemple suivant illustre la réponse. Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#print/printers/$entity",
  "id": "016b5565-3bbf-4067-b9ff-4d68167eb1a6",
  "displayName": "PrinterName",
  "manufacturer": "PrinterManufacturer",
  "model": "PrinterModel",
  "isShared": true,
  "registeredDateTime": "2020-02-04T00:00:00.0000000Z",
  "isAcceptingJobs": true,
  "status": {
    "state": "idle",
    "details": [],
    "description": ""
  },
  "defaults": {
    "copiesPerJob":1,
    "contentType": "application/oxps",
    "finishings": ["none"],
    "mediaType": "stationery"
  },
  "location": {
    "latitude": 1.1,
    "longitude": 2.2,
    "altitudeInMeters": 3,
    "streetAddress": "One Microsoft Way",
    "subUnit": [
        "Main Plaza",
        "Unit 400"
    ],
    "city": "Redmond",
    "postalCode": "98052",
    "countryOrRegion": "USA",
    "site": "Puget Sound",
    "building": "Studio E",
    "floor": "1",
    "floorDescription": "First Floor",
    "roomName": "1234",
    "roomDescription": "First floor copy room",
    "organization": [
        "C+AI",
        "Microsoft Graph"
    ],
    "subdivision": [
        "King County",
        "Red West"
    ],
    "stateOrProvince": "Washington"
  }
}