Обновление принтера

Пространство имен: microsoft.graph

Обновите свойства объекта принтера .

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	✅	✅	❌

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения	Разрешения с наименьшими привилегиями	Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись)	Printer.ReadWrite.All	Printer.FullControl.All
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.	Не поддерживается.
Приложение	Printer.ReadWrite.All	Недоступно.

Примечание: Сейчас с помощью разрешений приложений можно обновить только принтеры, не имеющие физических устройств.

HTTP-запрос

PATCH /print/printers/{printerId}

Заголовки запросов

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type	application/json при использовании делегированных application/ipp разрешений или application/json при использовании разрешений приложения. Обязательно.

Текст запроса

Делегированные разрешения и полезные данные JSON

При использовании делегированных разрешений в тексте запроса укажите значения для соответствующих полей принтера , которые должны быть обновлены. Существующие свойства, которые не включены в текст запроса, сохраняют свои предыдущие значения или пересчитываются на основе изменений других значений свойств. Для достижения оптимальной производительности не включайте существующие значения, которые не изменились.

Следующие свойства можно обновить с помощью делегированных разрешений.

Свойство	Тип	Описание
defaults	printerDefaults	Параметры печати принтера по умолчанию.
расположение	printerLocation	Физическое или организационное расположение принтера.
displayName	String	Имя принтера.

Разрешения приложения и полезные данные JSON

В тексте запроса укажите значения для соответствующих полей принтера , которые должны быть обновлены. Существующие свойства, которые не включены в текст запроса, сохраняют свои предыдущие значения или пересчитываются на основе изменений других значений свойств. Для достижения оптимальной производительности не включайте существующие значения, которые не изменились.

Следующие свойства можно обновить с помощью разрешений приложения.

Свойство	Тип	Описание
defaults	printerDefaults	Параметры печати принтера по умолчанию.
capabilities	printerCapabilities	Возможности принтера, связанного с этой общей папкой принтера.
displayName	String	Имя принтера.
manufacturer	String	Производитель принтера.
model	String	Имя модели принтера.
status	printerStatus	Состояние обработки принтера, включая все ошибки.
isAcceptingJobs	Логический	Указывает, принимает ли принтер новые задания печати.

Разрешения приложений и полезные данные IPP

С разрешениями приложения принтер также можно обновить с помощью полезных данных протокола IPP. В этом случае текст запроса содержит двоичный поток, представляющий группу Атрибуты принтера в кодировке IPP.

Клиент должен предоставить набор атрибутов принтера с одним или несколькими значениями (включая явно разрешенные внеполосные значения), как определено в разделе RFC8011 5.2 Атрибуты шаблона задания ("xxx-default", "xxx-supported" и "xxx-ready"), раздел 5.4 Атрибуты описания принтера. Клиент также должен предоставить все расширения атрибутов, поддерживаемые принтером. Значения каждого предоставленного атрибута Printer заменяют значения соответствующего атрибута Printer в целевом объекте Printer. Для атрибутов, которые могут иметь несколько значений (1setOf), все значения, предоставленные клиентом, заменяют все значения соответствующего атрибута объекта Printer.

Примечание: Не передайте атрибуты операции в тексте запроса. Текст запроса должен содержать только атрибуты принтера.

Примечание: Чтобы принтеры работали с определенной платформой, они должны соответствовать требованиям этой платформы. Например, в клиенте Windows ожидается, что принтер указывает все атрибуты, которые считаются обязательными согласно спецификациям MOPRIA . Обратите внимание, что спецификации MOPRIA доступны только для платных участников MOPRIA.

Отклик

Делегированные разрешения и полезные данные JSON

При использовании делегированных разрешений в случае успешного выполнения этот метод возвращает код отклика 200 OK и обновленный объект принтера в теле отклика.

Разрешения приложения и полезные данные JSON

При использовании делегированных разрешений в случае успешного выполнения этот метод возвращает код отклика 200 OK и обновленный объект принтера в теле отклика.

Разрешения приложений и полезные данные IPP

При использовании разрешений приложения в случае успешного выполнения этот метод возвращает 204 No content код ответа. Он не возвращает ничего в теле ответа.

Примеры

Запрос

Ниже показан пример запроса.

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

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

CLI

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

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Go

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

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по 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);

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по 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);

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по 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();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по 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)

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

Ниже показан пример отклика. Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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