Atualização da impressora

Namespace: microsoft.graph

Atualize as propriedades de um objeto de impressora .

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global	Governo dos EUA L4	GOVERNO DOS EUA L5 (DOD)	China operada pela 21Vianet
✅	✅	✅	❌

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão	Permissões menos privilegiadas	Permissões privilegiadas mais altas
Delegado (conta corporativa ou de estudante)	Printer.ReadWrite.All	Printer.FullControl.All
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Application	Printer.ReadWrite.All	Indisponível.

Nota: No momento, somente impressoras que não têm dispositivos físicos podem ser atualizadas usando permissões de aplicativo.

Solicitação HTTP

PATCH /print/printers/{printerId}

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-type	application/json ao usar permissões application/ipp delegadas ou application/json ao usar permissões de aplicativo. Obrigatório.

Corpo da solicitação

Permissões delegadas e carga JSON

Se usar permissões delegadas, no corpo da solicitação, forneça os valores para os campos de impressora relevantes que devem ser atualizados. As propriedades existentes que não estão incluídas no corpo da solicitação mantêm seus valores anteriores ou são recalculadas com base em alterações em outros valores de propriedade. Para alcançar o melhor desempenho, não inclua valores existentes que não foram alterados.

As propriedades a seguir podem ser atualizadas usando permissões delegadas.

Propriedade	Tipo	Descrição
defaults	printerDefaults	As configurações de impressão padrão da impressora.
localização	printerLocation	O local físico e/ou organizacional da impressora.
displayName	Cadeia de caracteres	O nome da impressora.

Permissões de aplicativo e carga JSON

No corpo da solicitação, forneça os valores para os campos de impressora relevantes que devem ser atualizados. As propriedades existentes que não estão incluídas no corpo da solicitação mantêm seus valores anteriores ou são recalculadas com base em alterações em outros valores de propriedade. Para alcançar o melhor desempenho, não inclua valores existentes que não foram alterados.

As propriedades a seguir podem ser atualizadas usando permissões de aplicativo.

Propriedade	Tipo	Descrição
defaults	printerDefaults	As configurações de impressão padrão da impressora.
capabilities	printerCapabilities	Os recursos da impressora associados a esse compartilhamento de impressora.
displayName	Cadeia de caracteres	O nome da impressora.
fabricante	Cadeia de caracteres	O fabricante da impressora.
modelo	Cadeia de caracteres	O nome do modelo da impressora.
status	printerStatus	O status de processamento da impressora, incluindo quaisquer erros.
isAcceptingJobs	Booliano	Se a impressora está aceitando novos trabalhos de impressão no momento.

Permissões de aplicativo e carga de IPP

Com permissões de aplicativo, uma impressora também pode ser atualizada usando uma carga IPP (Protocolo de Impressão da Internet). Nesse caso, o corpo da solicitação contém um fluxo binário que representa o grupo Atributos de Impressora na codificação IPP.

O cliente DEVE fornecer um conjunto de atributos de Impressora com um ou mais valores (incluindo valores fora de banda explicitamente permitidos) conforme definido em RFC8011 seção 5.2 Atributos de Modelo de Trabalho ("xxx-default", atributos "xxx-supported" e "xxx-ready"), Seção 5.4 Atributos de Descrição da Impressora. O cliente também deve fornecer quaisquer extensões de atributo compatíveis com a Impressora. O valor(s) de cada atributo impressora fornecido substitui os valores do atributo impressora correspondente no objeto Impressora de destino. Para atributos que podem ter vários valores (1setOf), todos os valores fornecidos pelo cliente substituem todos os valores do atributo de objeto impressora correspondente.

Nota: Não passe atributos de operação no corpo da solicitação. O corpo da solicitação deve conter apenas atributos de impressora.

Nota: Para que as impressoras trabalhem com uma plataforma específica, ela deve atender aos requisitos dessa plataforma. Por exemplo, no cliente Windows, espera-se que a impressora especifique todos os atributos considerados obrigatórios de acordo com as especificações MOPRIA . Observe que as especificações MOPRIA estão disponíveis apenas para os membros pagos do MOPRIA.

Resposta

Permissões delegadas e carga JSON

Se usar permissões delegadas, se for bem-sucedido, esse método retornará um código de 200 OK resposta e um objeto de impressora atualizado no corpo da resposta.

Permissões de aplicativo e carga JSON

Se usar permissões delegadas, se for bem-sucedido, esse método retornará um código de 200 OK resposta e um objeto de impressora atualizado no corpo da resposta.

Permissões de aplicativo e carga de IPP

Se usar permissões de aplicativo, se for bem-sucedido, esse método retornará um código de 204 No content resposta. Ele não retorna nada no corpo da resposta.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

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 obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

CLI

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

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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 obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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 obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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 obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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 obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.printer import Printer
from msgraph.generated.models.printer_location import PrinterLocation
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
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 obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Resposta

O exemplo a seguir mostra a resposta. Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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