Actualizar impresora

Espacio de nombres: microsoft.graph

Actualice las propiedades de un objeto de impresora .

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global	Gobierno de EE. UU. L4	Us Government L5 (DOD)	China operada por 21Vianet
✅	✅	✅	❌

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso	Permisos con privilegios mínimos	Permisos con privilegios más altos
Delegado (cuenta profesional o educativa)	Printer.ReadWrite.All	Printer.FullControl.All
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	Printer.ReadWrite.All	No disponible.

Nota: En este momento, solo las impresoras que no tienen dispositivos físicos se pueden actualizar mediante permisos de aplicación.

Solicitud HTTP

PATCH /print/printers/{printerId}

Encabezados de solicitud

Nombre	Descripción
Authorization	{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Tipo de contenido	application/json cuando se usan permisos application/ipp delegados o application/json cuando se usan permisos de aplicación. Obligatorio.

Cuerpo de la solicitud

Permisos delegados y carga de JSON

Si usa permisos delegados, en el cuerpo de la solicitud, proporcione los valores de los campos de impresora pertinentes que se deben actualizar. Las propiedades existentes que no se incluyen en el cuerpo de la solicitud mantienen sus valores anteriores o se recalculan en función de los cambios realizados en otros valores de propiedad. Para obtener el mejor rendimiento, no incluya valores existentes que no hayan cambiado.

Las siguientes propiedades se pueden actualizar mediante permisos delegados.

Propiedad	Tipo	Descripción
defaults	printerDefaults	La configuración de impresión predeterminada de la impresora.
ubicación	printerLocation	Ubicación física o organizativa de la impresora.
displayName	Cadena	Nombre de la impresora.

Permisos de aplicación y carga de JSON

En el cuerpo de la solicitud, proporcione los valores de los campos de impresora pertinentes que se deben actualizar. Las propiedades existentes que no se incluyen en el cuerpo de la solicitud mantienen sus valores anteriores o se recalculan en función de los cambios realizados en otros valores de propiedad. Para obtener el mejor rendimiento, no incluya valores existentes que no hayan cambiado.

Las siguientes propiedades se pueden actualizar mediante permisos de aplicación.

Propiedad	Tipo	Descripción
defaults	printerDefaults	La configuración de impresión predeterminada de la impresora.
capabilities	printerCapabilities	Capacidades de la impresora asociada a este recurso compartido de impresora.
displayName	Cadena	Nombre de la impresora.
manufacturer	Cadena	Fabricante de la impresora.
model	Cadena	Nombre del modelo de la impresora.
status	printerStatus	Estado de procesamiento de la impresora, incluidos los errores.
isAcceptingJobs	Booleano	Si la impresora está aceptando nuevos trabajos de impresión.

Permisos de aplicación y carga de IPP

Con permisos de aplicación, una impresora también se puede actualizar mediante una carga de Protocolo de impresión por Internet (IPP). En este caso, el cuerpo de la solicitud contiene una secuencia binaria que representa el grupo Atributos de impresora en la codificación IPP.

El cliente DEBE proporcionar un conjunto de atributos Printer con uno o varios valores (incluidos los valores fuera de banda permitidos explícitamente) tal como se define en RFC8011 sección 5.2 Atributos de plantilla de trabajo ("xxx-default", "xxx-supported" y "xxx-ready"), Atributos de descripción de impresora de la sección 5.4 . El cliente también debe proporcionar cualquier extensión de atributo compatible con printer. Los valores de cada atributo Printer proporcionado reemplazan los valores del atributo Printer correspondiente en el objeto Printer de destino. Para los atributos que pueden tener varios valores (1setOf), todos los valores proporcionados por el cliente reemplazan todos los valores del atributo de objeto Printer correspondiente.

Nota: No pase atributos de operación en el cuerpo de la solicitud. El cuerpo de la solicitud solo debe contener atributos de impresora.

Nota: Para que las impresoras funcionen con una plataforma determinada, debe cumplir los requisitos de esa plataforma. Por ejemplo, en el cliente de Windows, se espera que la impresora especifique todos los atributos que se consideran obligatorios según las especificaciones de MOPRIA . Tenga en cuenta que las especificaciones MOPRIA solo están disponibles para los miembros de pago de MOPRIA.

Respuesta

Permisos delegados y carga de JSON

Si usa permisos delegados, si se ejecuta correctamente, este método devuelve un 200 OK código de respuesta y un objeto de impresora actualizado en el cuerpo de la respuesta.

Permisos de aplicación y carga de JSON

Si usa permisos delegados, si se ejecuta correctamente, este método devuelve un 200 OK código de respuesta y un objeto de impresora actualizado en el cuerpo de la respuesta.

Permisos de aplicación y carga de IPP

Si usa permisos de aplicación, si se ejecuta correctamente, este método devuelve un código de 204 No content respuesta. No devuelve nada en el cuerpo de la respuesta.

Ejemplos

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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);

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

CLI

mgc print printers patch --printer-id {printer-id} --body '{\
  "name": "PrinterName",\
  "location": {\
    "latitude": 1.1,\
    "longitude": 2.2,\
    "altitudeInMeters": 3\
  }\
}\
'

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Ir

// Code snippets are only available for the latest major version. Current major version is $v1.*

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

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)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
printers, err := graphClient.Print().Printers().ByPrinterId("printer-id").Patch(context.Background(), requestBody, nil)

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del 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);

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del 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);

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del 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();

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del 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)

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Respuesta

En el ejemplo siguiente se muestra la respuesta. Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

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