printer : create

Article
10/28/2023

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Créez (inscrivez) une imprimante auprès du service d’impression universelle. Il s’agit d’une opération de longue durée et, par conséquent, elle retourne une propriété printerCreateOperation qui peut être utilisée pour suivre et vérifier l’inscription de l’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.Create	Printer.FullControl.All, Printer.ReadWrite.All
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	Non prise en charge.	Non prise en charge.

Requête HTTP

POST /print/printers/create

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-type	application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez un objet JSON avec les propriétés suivantes.

Paramètre	Type	Description	Obligatoire ?
displayName	Chaîne	Nom d’affichage à affecter à l’imprimante.	Oui
Fabricant	Chaîne	Fabricant de l’imprimante.	Oui
model	Chaîne	Modèle de l’imprimante.	Oui
physicalDeviceId	Chaîne	UUID du périphérique physique de l’imprimante. Obligatoire si la propriété a la `hasPhysicalDevice` valeur true.	Non
hasPhysicalDevice	Valeur booléenne	True si l’imprimante a un périphérique de sortie physique ; sinon, false. En cas d’omission, la valeur par défaut est true.	Non
certificateSigningRequest	printCertificateSigningRequest	Demande de signature de certificat X.509 pour le certificat créé et utilisé par l’imprimante pour s’identifier.	Oui
connectorId	Chaîne	ID du connecteur agissant comme proxy pour l’imprimante.	Non

Réponse

Si elle réussit, cette méthode renvoie un 202 Accepted code de réponse et un lien vers l’objet printerCreateOperation associé dans l’en-tête Operation-Location .

Vous pouvez utiliser une requête GET sur l’URL liée pour obtenir les status d’une inscription d’imprimante en cours. Une fois l’inscription de l’imprimante terminée, une requête GET à l’URL liée contient l’objet d’imprimante créé et le certificat inscrit.

Exemple

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/beta/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
}


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

// Dependencies
using Microsoft.Graph.Beta.Print.Printers.Create;
using Microsoft.Graph.Beta.Models;

var requestBody = new CreatePostRequestBody
{
	DisplayName = "Test Printer",
	Manufacturer = "Test Printer Manufacturer",
	Model = "Test Printer Model",
	PhysicalDeviceId = null,
	HasPhysicalDevice = false,
	CertificateSigningRequest = new PrintCertificateSigningRequest
	{
		Content = "{content}",
		TransportKey = "{sampleTransportKey}",
	},
	ConnectorId = null,
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Print.Printers.Create.PostAsync(requestBody);

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

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


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta print printers create post --body '{\
  "displayName": "Test Printer",\
  "manufacturer": "Test Printer Manufacturer",\
  "model": "Test Printer Model",\
  "physicalDeviceId": null,\
  "hasPhysicalDevice": false,\
  "certificateSigningRequest": { \
    "content": "{content}",\
    "transportKey": "{sampleTransportKey}"\
  },\
  "connectorId": null\
}\
'

Importante



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphprint.NewCreatePostRequestBody()
displayName := "Test Printer"
requestBody.SetDisplayName(&displayName) 
manufacturer := "Test Printer Manufacturer"
requestBody.SetManufacturer(&manufacturer) 
model := "Test Printer Model"
requestBody.SetModel(&model) 
physicalDeviceId := null
requestBody.SetPhysicalDeviceId(&physicalDeviceId) 
hasPhysicalDevice := false
requestBody.SetHasPhysicalDevice(&hasPhysicalDevice) 
certificateSigningRequest := graphmodels.NewPrintCertificateSigningRequest()
content := "{content}"
certificateSigningRequest.SetContent(&content) 
transportKey := "{sampleTransportKey}"
certificateSigningRequest.SetTransportKey(&transportKey) 
requestBody.SetCertificateSigningRequest(certificateSigningRequest)
connectorId := null
requestBody.SetConnectorId(&connectorId) 

graphClient.Print().Printers().Create().Post(context.Background(), requestBody, nil)

Importante


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.beta.print.printers.create.CreatePostRequestBody createPostRequestBody = new com.microsoft.graph.beta.print.printers.create.CreatePostRequestBody();
createPostRequestBody.setDisplayName("Test Printer");
createPostRequestBody.setManufacturer("Test Printer Manufacturer");
createPostRequestBody.setModel("Test Printer Model");
createPostRequestBody.setPhysicalDeviceId(null);
createPostRequestBody.setHasPhysicalDevice(false);
PrintCertificateSigningRequest certificateSigningRequest = new PrintCertificateSigningRequest();
certificateSigningRequest.setContent("{content}");
certificateSigningRequest.setTransportKey("{sampleTransportKey}");
createPostRequestBody.setCertificateSigningRequest(certificateSigningRequest);
createPostRequestBody.setConnectorId(null);
graphClient.print().printers().create().post(createPostRequestBody);

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

const create = {
  displayName: 'Test Printer',
  manufacturer: 'Test Printer Manufacturer',
  model: 'Test Printer Model',
  physicalDeviceId: null,
  hasPhysicalDevice: false,
  certificateSigningRequest: { 
    content: '{content}',
    transportKey: '{sampleTransportKey}'
  },
  connectorId: null
};

await client.api('/print/printers/create')
	.version('beta')
	.post(create);

Importante


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\CreatePostRequestBody;
use Microsoft\Graph\Generated\Models\PrintCertificateSigningRequest;


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

$requestBody = new CreatePostRequestBody();
$requestBody->setDisplayName('Test Printer');
$requestBody->setManufacturer('Test Printer Manufacturer');
$requestBody->setModel('Test Printer Model');
$requestBody->setPhysicalDeviceId(null);
$requestBody->setHasPhysicalDevice(false);
$certificateSigningRequest = new PrintCertificateSigningRequest();
$certificateSigningRequest->setContent('{content}');
$certificateSigningRequest->setTransportKey('{sampleTransportKey}');
$requestBody->setCertificateSigningRequest($certificateSigningRequest);
$requestBody->setConnectorId(null);

$graphServiceClient->escapedPrint()->printers()->create()->post($requestBody)->wait();

Importante


Import-Module Microsoft.Graph.Beta.Devices.CloudPrint

$params = @{
	displayName = "Test Printer"
	manufacturer = "Test Printer Manufacturer"
	model = "Test Printer Model"
	physicalDeviceId = $null
	hasPhysicalDevice = $false
	certificateSigningRequest = @{
		content = '{content}'
		transportKey = '{sampleTransportKey}'
	}
	connectorId = $null
}

New-MgBetaPrintPrinter -BodyParameter $params

Importante


from msgraph import GraphServiceClient
from msgraph.generated.print.printers.create.create_post_request_body import CreatePostRequestBody
from msgraph.generated.models.print_certificate_signing_request import PrintCertificateSigningRequest

graph_client = GraphServiceClient(credentials, scopes)

request_body = CreatePostRequestBody(
	display_name = "Test Printer",
	manufacturer = "Test Printer Manufacturer",
	model = "Test Printer Model",
	physical_device_id = None,
	has_physical_device = False,
	certificate_signing_request = PrintCertificateSigningRequest(
		content = "{content}",
		transport_key = "{sampleTransportKey}",
	),
	connector_id = None,
)

await graph_client.print.printers.create.post(request_body)

Importante

Réponse

L’exemple suivant illustre la réponse.

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

printer : create

Autorisations

Requête HTTP

En-têtes de demande

Corps de la demande

Réponse

Exemple

Demande

Réponse

Commentaires

Commentaires

Ressources supplémentaires