Skip to content

printer-create.md

Latest commit

 

History

History
132 lines (103 loc) · 5.25 KB

printer-create.md

File metadata and controls

132 lines (103 loc) · 5.25 KB
title printer: create
description Create (register) a printer with the Universal Print service.
author nilakhan
ms.localizationpriority medium
ms.subservice universal-print
doc_type apiPageType
ms.date 04/04/2024

printer: create

Namespace: microsoft.graph

Create (register) a printer with the Universal Print service. This is a long-running operation and as such, it returns a printerCreateOperation that can be used to track and verify the registration of the printer.

For help creating the required Certificate Signing Request (CSR) for creating printer, see the CSR generation code sample.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

HTTP request

POST /print/printers/create

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the parameters.

The following table shows the parameters that can be used with this action.

Parameter Type Description Required?
displayName String The display name to assign to the printer. Yes
manufacturer String The manufacturer of the printer. Yes
model String The model of the printer. Yes
physicalDeviceId String The physical device UUID of the printer. Required if the hasPhysicalDevice property is true. No
hasPhysicalDevice Boolean True if the printer has physical output device, false otherwise. If omitted, the default value is true. No
certificateSigningRequest printCertificateSigningRequest The X.509 Certificate Signing Request (CSR) for the certificate created and used by the printer to identify itself. Yes
connectorId String ID of the connector acting as proxy to the printer. No

Response

If successful, this method returns a 202 Accepted response code and a link to the associated printerCreateOperation in the Operation-Location header.

You make a GET request to the linked URL to get the status of an ongoing printer registration. After printer registration has completed successfully, a GET request to the linked URL will contain the created printer object and registered certificate.

Examples

Request

HTTP

POST https://graph.microsoft.com/v1.0/print/printers/create
Content-Type: application/json

{
  "displayName": "Test Printer",
  "manufacturer": "Test Printer Manufacturer",
  "model": "Test Printer Model",
  "physicalDeviceId": null,
  "hasPhysicalDevice": false,
  "certificateSigningRequest": { 
    "content": "{content}",
    "transportKey": "{sampleTransportKey}"
  },
  "connectorId": null
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

HTTP/1.1 202 Accepted
Operation-Location: https://graph.microsoft.com/v1.0/print/operations/f221760a-52e8-4c11-b8c5-5dfaef3a49db
Retry-After: 5