Share via


Microsoft.Graph.Devices.CloudPrint Module

Microsoft Graph PowerShell Cmdlets

Microsoft.Graph.Devices.CloudPrint Cmdlets

Cmdlet Description
Get-MgPrint

Get print

Note

To view the beta release of this cmdlet, view Get-MgBetaPrint

Get-MgPrintConnector

Retrieve the properties and relationships of a printConnector object.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintConnector

Get-MgPrintConnectorCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintConnectorCount

Get-MgPrintOperation

Retrieve the properties and relationships of a printOperation object.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintOperation

Get-MgPrintOperationCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintOperationCount

Get-MgPrintPrinter

Retrieve the properties and relationships of a printer object.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintPrinter

Get-MgPrintPrinterConnector

The connectors that are associated with the printer.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintPrinterConnector

Get-MgPrintPrinterConnectorCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintPrinterConnectorCount

Get-MgPrintPrinterCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintPrinterCount

Get-MgPrintPrinterJob

Retrieve the properties and relationships of a print job.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintPrinterJob

Get-MgPrintPrinterJobCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintPrinterJobCount

Get-MgPrintPrinterJobDocument

Get documents from print

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintPrinterJobDocument

Get-MgPrintPrinterJobDocumentContent

Download the binary file associated with a printDocument. Calling this method yields a redirect response with a preauthenticated URL that can be used to download the payload.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintPrinterJobDocumentContent

Get-MgPrintPrinterJobDocumentCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintPrinterJobDocumentCount

Get-MgPrintPrinterJobTask

A list of printTasks that were triggered by this print job.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintPrinterJobTask

Get-MgPrintPrinterJobTaskCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintPrinterJobTaskCount

Get-MgPrintPrinterJobTaskDefinition

The printTaskDefinition that was used to create this task. Read-only.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintPrinterJobTaskDefinition

Get-MgPrintPrinterJobTaskTrigger

The printTaskTrigger that triggered this task's execution. Read-only.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintPrinterJobTaskTrigger

Get-MgPrintPrinterShare

The list of printerShares that are associated with the printer. Currently, only one printerShare can be associated with the printer. Read-only. Nullable.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintPrinterShare

Get-MgPrintPrinterShareCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintPrinterShareCount

Get-MgPrintPrinterTaskTrigger

Get a task trigger from a printer. For details about how to use this API to add pull printing support to Universal Print, see Extending Universal Print to support pull printing.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintPrinterTaskTrigger

Get-MgPrintPrinterTaskTriggerCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintPrinterTaskTriggerCount

Get-MgPrintPrinterTaskTriggerDefinition

An abstract definition that is used to create a printTask when triggered by a print event. Read-only.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintPrinterTaskTriggerDefinition

Get-MgPrintService

Retrieve the properties and relationships of a print service.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintService

Get-MgPrintServiceCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintServiceCount

Get-MgPrintServiceEndpoint

Retrieve the properties and relationships of a print service endpoint.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintServiceEndpoint

Get-MgPrintServiceEndpointCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintServiceEndpointCount

Get-MgPrintShare

Retrieve the properties and relationships of a printer share.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShare

Get-MgPrintShareAllowedGroup

Retrieve a list of groups that have been granted access to submit print jobs to the associated printerShare.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareAllowedGroup

Get-MgPrintShareAllowedGroupByRef

Retrieve a list of groups that have been granted access to submit print jobs to the associated printerShare.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareAllowedGroupByRef

Get-MgPrintShareAllowedGroupCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareAllowedGroupCount

Get-MgPrintShareAllowedGroupServiceProvisioningError

Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports $filter (eq, not, for isResolved and serviceInstance).

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareAllowedGroupServiceProvisioningError

Get-MgPrintShareAllowedGroupServiceProvisioningErrorCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareAllowedGroupServiceProvisioningErrorCount

Get-MgPrintShareAllowedUser

Retrieve a list of users who have been granted access to submit print jobs to the associated printerShare.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareAllowedUser

Get-MgPrintShareAllowedUserByRef

Retrieve a list of users who have been granted access to submit print jobs to the associated printerShare.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareAllowedUserByRef

Get-MgPrintShareAllowedUserCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareAllowedUserCount

Get-MgPrintShareAllowedUserMailboxSetting

Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Returned only on $select.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareAllowedUserMailboxSetting

Get-MgPrintShareAllowedUserServiceProvisioningError

Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareAllowedUserServiceProvisioningError

Get-MgPrintShareAllowedUserServiceProvisioningErrorCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareAllowedUserServiceProvisioningErrorCount

Get-MgPrintShareCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareCount

Get-MgPrintShareJob

The list of jobs that are queued for printing by the printer/printerShare.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareJob

Get-MgPrintShareJobCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareJobCount

Get-MgPrintShareJobDocument

Get documents from print

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareJobDocument

Get-MgPrintShareJobDocumentContent

The unique identifier for an entity. Read-only.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareJobDocumentContent

Get-MgPrintShareJobDocumentCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareJobDocumentCount

Get-MgPrintShareJobTask

A list of printTasks that were triggered by this print job.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareJobTask

Get-MgPrintShareJobTaskCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareJobTaskCount

Get-MgPrintShareJobTaskDefinition

The printTaskDefinition that was used to create this task. Read-only.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareJobTaskDefinition

Get-MgPrintShareJobTaskTrigger

The printTaskTrigger that triggered this task's execution. Read-only.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintShareJobTaskTrigger

Get-MgPrintSharePrinter

The printer that this printer share is related to.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintSharePrinter

Get-MgPrintTaskDefinition

Get details about a task definition. For details about how to use this API to add pull printing support to Universal Print, see Extending Universal Print to support pull printing.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintTaskDefinition

Get-MgPrintTaskDefinitionCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintTaskDefinitionCount

Get-MgPrintTaskDefinitionTask

Get details about a print task. For details about how to use this API to add pull printing support to Universal Print, see Extending Universal Print to support pull printing.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintTaskDefinitionTask

Get-MgPrintTaskDefinitionTaskCount

Get the number of the resource

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintTaskDefinitionTaskCount

Get-MgPrintTaskDefinitionTaskTrigger

The printTaskTrigger that triggered this task's execution. Read-only.

Note

To view the beta release of this cmdlet, view Get-MgBetaPrintTaskDefinitionTaskTrigger

Invoke-MgAbortPrintPrinterJob

Abort a print job. Only applications using application permissions can abort a print job. Aborting a print job will only succeed if there is a printTask in a processing state on the associated print job, started by a trigger that the requesting app created. For details about how to register a task trigger, see Extending Universal Print to support pull printing.

Note

To view the beta release of this cmdlet, view Invoke-MgBetaAbortPrintPrinterJob

Invoke-MgAbortPrintShareJob

Abort a print job. Only applications using application permissions can abort a print job. Aborting a print job will only succeed if there is a printTask in a processing state on the associated print job, started by a trigger that the requesting app created. For details about how to register a task trigger, see Extending Universal Print to support pull printing.

Note

To view the beta release of this cmdlet, view Invoke-MgBetaAbortPrintShareJob

Invoke-MgRedirectPrintPrinterJob

Redirect a print job to a different printer. Redirecting a print job will only succeed if there is a printTask in a processing state on the associated print job, started by a trigger that the requesting app created. For details about how to use this API to add pull printing support to Universal Print, see Extending Universal Print to support pull printing.

Note

To view the beta release of this cmdlet, view Invoke-MgBetaRedirectPrintPrinterJob

Invoke-MgRedirectPrintShareJob

Redirect a print job to a different printer. Redirecting a print job will only succeed if there is a printTask in a processing state on the associated print job, started by a trigger that the requesting app created. For details about how to use this API to add pull printing support to Universal Print, see Extending Universal Print to support pull printing.

Note

To view the beta release of this cmdlet, view Invoke-MgBetaRedirectPrintShareJob

New-MgPrintConnector

Create new navigation property to connectors for print

Note

To view the beta release of this cmdlet, view New-MgBetaPrintConnector

New-MgPrintOperation

Create new navigation property to operations for print

Note

To view the beta release of this cmdlet, view New-MgBetaPrintOperation

New-MgPrintPrinter

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.

Note

To view the beta release of this cmdlet, view New-MgBetaPrintPrinter

New-MgPrintPrinterJob

Create a new printJob for a printer. Also creates a new printDocument associated with the printJob.

Note

To view the beta release of this cmdlet, view New-MgBetaPrintPrinterJob

New-MgPrintPrinterJobDocument

Create new navigation property to documents for print

Note

To view the beta release of this cmdlet, view New-MgBetaPrintPrinterJobDocument

New-MgPrintPrinterJobDocumentUploadSession

Create an upload session that allows an app to iteratively upload ranges of a binary file linked to the print document. As part of the response, this action returns an upload URL that can be used in subsequent sequential PUT queries. Request headers for each PUT operation can be used to specify the exact range of bytes to be uploaded. This allows transfer to be resumed, in case the network connection is dropped during upload.

Note

To view the beta release of this cmdlet, view New-MgBetaPrintPrinterJobDocumentUploadSession

New-MgPrintPrinterJobTask

Create new navigation property to tasks for print

Note

To view the beta release of this cmdlet, view New-MgBetaPrintPrinterJobTask

New-MgPrintPrinterTaskTrigger

Create a new task trigger on the specified printer. Currently, only one task trigger can be specified per printer, but this limit might be removed in the future.

Note

To view the beta release of this cmdlet, view New-MgBetaPrintPrinterTaskTrigger

New-MgPrintService

Create new navigation property to services for print

Note

To view the beta release of this cmdlet, view New-MgBetaPrintService

New-MgPrintServiceEndpoint

Create new navigation property to endpoints for print

Note

To view the beta release of this cmdlet, view New-MgBetaPrintServiceEndpoint

New-MgPrintShare

Create a new printerShare for the specified printer.

Note

To view the beta release of this cmdlet, view New-MgBetaPrintShare

New-MgPrintShareAllowedGroupByRef

Grant the specified group access to submit print jobs to the associated printerShare.

Note

To view the beta release of this cmdlet, view New-MgBetaPrintShareAllowedGroupByRef

New-MgPrintShareAllowedUserByRef

Grant the specified user access to submit print jobs to the associated printerShare.

Note

To view the beta release of this cmdlet, view New-MgBetaPrintShareAllowedUserByRef

New-MgPrintShareJob

Create a new printJob for a printerShare. Also creates a new printDocument associated with the printJob.

Note

To view the beta release of this cmdlet, view New-MgBetaPrintShareJob

New-MgPrintShareJobDocument

Create new navigation property to documents for print

Note

To view the beta release of this cmdlet, view New-MgBetaPrintShareJobDocument

New-MgPrintShareJobDocumentUploadSession

Create an upload session that allows an app to iteratively upload ranges of a binary file linked to the print document. As part of the response, this action returns an upload URL that can be used in subsequent sequential PUT queries. Request headers for each PUT operation can be used to specify the exact range of bytes to be uploaded. This allows transfer to be resumed, in case the network connection is dropped during upload.

Note

To view the beta release of this cmdlet, view New-MgBetaPrintShareJobDocumentUploadSession

New-MgPrintShareJobTask

Create new navigation property to tasks for print

Note

To view the beta release of this cmdlet, view New-MgBetaPrintShareJobTask

New-MgPrintTaskDefinition

Create a new task definition. For details about how to use this API to add pull printing support to Universal Print, see Extending Universal Print to support pull printing.

Note

To view the beta release of this cmdlet, view New-MgBetaPrintTaskDefinition

New-MgPrintTaskDefinitionTask

Create new navigation property to tasks for print

Note

To view the beta release of this cmdlet, view New-MgBetaPrintTaskDefinitionTask

Remove-MgPrintConnector

Delete (unregister) a printConnector.

Note

To view the beta release of this cmdlet, view Remove-MgBetaPrintConnector

Remove-MgPrintOperation

Delete navigation property operations for print

Note

To view the beta release of this cmdlet, view Remove-MgBetaPrintOperation

Remove-MgPrintPrinter

Delete (unregister) a printer.

Note

To view the beta release of this cmdlet, view Remove-MgBetaPrintPrinter

Remove-MgPrintPrinterJob

Delete navigation property jobs for print

Note

To view the beta release of this cmdlet, view Remove-MgBetaPrintPrinterJob

Remove-MgPrintPrinterJobDocument

Delete navigation property documents for print

Note

To view the beta release of this cmdlet, view Remove-MgBetaPrintPrinterJobDocument

Remove-MgPrintPrinterJobDocumentContent

The unique identifier for an entity. Read-only.

Note

To view the beta release of this cmdlet, view Remove-MgBetaPrintPrinterJobDocumentContent

Remove-MgPrintPrinterJobTask

Delete navigation property tasks for print

Note

To view the beta release of this cmdlet, view Remove-MgBetaPrintPrinterJobTask

Remove-MgPrintPrinterTaskTrigger

Delete the task trigger of a printer to prevent related print events from triggering tasks on the specified printer.

Note

To view the beta release of this cmdlet, view Remove-MgBetaPrintPrinterTaskTrigger

Remove-MgPrintService

Delete navigation property services for print

Note

To view the beta release of this cmdlet, view Remove-MgBetaPrintService

Remove-MgPrintServiceEndpoint

Delete navigation property endpoints for print

Note

To view the beta release of this cmdlet, view Remove-MgBetaPrintServiceEndpoint

Remove-MgPrintShare

Delete a printer share (unshare the associated printer). This action can't be undone. If the printer is shared again in the future, any Windows users who had previously installed the printer needs to discover and reinstall it.

Note

To view the beta release of this cmdlet, view Remove-MgBetaPrintShare

Remove-MgPrintShareAllowedGroupByRef

Revoke the specified group's access to submit print jobs to the associated printerShare.

Note

To view the beta release of this cmdlet, view Remove-MgBetaPrintShareAllowedGroupByRef

Remove-MgPrintShareAllowedUserByRef

Revoke the specified user's access to submit print jobs to the associated printerShare.

Note

To view the beta release of this cmdlet, view Remove-MgBetaPrintShareAllowedUserByRef

Remove-MgPrintShareJob

Delete navigation property jobs for print

Note

To view the beta release of this cmdlet, view Remove-MgBetaPrintShareJob

Remove-MgPrintShareJobDocument

Delete navigation property documents for print

Note

To view the beta release of this cmdlet, view Remove-MgBetaPrintShareJobDocument

Remove-MgPrintShareJobDocumentContent

The unique identifier for an entity. Read-only.

Note

To view the beta release of this cmdlet, view Remove-MgBetaPrintShareJobDocumentContent

Remove-MgPrintShareJobTask

Delete navigation property tasks for print

Note

To view the beta release of this cmdlet, view Remove-MgBetaPrintShareJobTask

Remove-MgPrintTaskDefinition

Delete a taskDefinition. For details about how to use this API to add pull printing support to Universal Print, see Extending Universal Print to support pull printing.

Note

To view the beta release of this cmdlet, view Remove-MgBetaPrintTaskDefinition

Remove-MgPrintTaskDefinitionTask

Delete navigation property tasks for print

Note

To view the beta release of this cmdlet, view Remove-MgBetaPrintTaskDefinitionTask

Restore-MgPrintPrinterFactoryDefault

Restore a printer's default settings to the values specified by the manufacturer.

Note

To view the beta release of this cmdlet, view Restore-MgBetaPrintPrinterFactoryDefault

Set-MgPrintPrinterJobDocumentContent

The unique identifier for an entity. Read-only.

Note

To view the beta release of this cmdlet, view Set-MgBetaPrintPrinterJobDocumentContent

Set-MgPrintShareJobDocumentContent

The unique identifier for an entity. Read-only.

Note

To view the beta release of this cmdlet, view Set-MgBetaPrintShareJobDocumentContent

Start-MgPrintPrinterJob

Submits the print job to the associated printer or printerShare. It will be printed after any existing pending jobs are completed, aborted, or canceled.

Note

To view the beta release of this cmdlet, view Start-MgBetaPrintPrinterJob

Start-MgPrintShareJob

Submits the print job to the associated printer or printerShare. It will be printed after any existing pending jobs are completed, aborted, or canceled.

Note

To view the beta release of this cmdlet, view Start-MgBetaPrintShareJob

Stop-MgPrintPrinterJob

Cancel a print job. Print jobs can be canceled only on behalf of a user, using delegated permissions.

Note

To view the beta release of this cmdlet, view Stop-MgBetaPrintPrinterJob

Stop-MgPrintShareJob

Cancel a print job. Print jobs can be canceled only on behalf of a user, using delegated permissions.

Note

To view the beta release of this cmdlet, view Stop-MgBetaPrintShareJob

Update-MgPrint

Update print

Note

To view the beta release of this cmdlet, view Update-MgBetaPrint

Update-MgPrintConnector

Update the properties of a printConnector object.

Note

To view the beta release of this cmdlet, view Update-MgBetaPrintConnector

Update-MgPrintOperation

Update the navigation property operations in print

Note

To view the beta release of this cmdlet, view Update-MgBetaPrintOperation

Update-MgPrintPrinter

Update the properties of a printer object.

Note

To view the beta release of this cmdlet, view Update-MgBetaPrintPrinter

Update-MgPrintPrinterJob

Update a print job. Only the configuration property can be updated. Updating a print job will only succeed if there is a printTask in a processing state on the associated print job, started by a trigger that the requesting app created. For details about how to register a task trigger, see Extending Universal Print to support pull printing.

Note

To view the beta release of this cmdlet, view Update-MgBetaPrintPrinterJob

Update-MgPrintPrinterJobDocument

Update the navigation property documents in print

Note

To view the beta release of this cmdlet, view Update-MgBetaPrintPrinterJobDocument

Update-MgPrintPrinterJobTask

Update the navigation property tasks in print

Note

To view the beta release of this cmdlet, view Update-MgBetaPrintPrinterJobTask

Update-MgPrintPrinterTaskTrigger

Update the navigation property taskTriggers in print

Note

To view the beta release of this cmdlet, view Update-MgBetaPrintPrinterTaskTrigger

Update-MgPrintService

Update the navigation property services in print

Note

To view the beta release of this cmdlet, view Update-MgBetaPrintService

Update-MgPrintServiceEndpoint

Update the navigation property endpoints in print

Note

To view the beta release of this cmdlet, view Update-MgBetaPrintServiceEndpoint

Update-MgPrintShare

Update the properties of a printer share. This method can be used to swap printers. For example, if a physical printer device breaks, an administrator can register a new printer device and update this printerShare to point to the new printer without requiring users to take any action.

Note

To view the beta release of this cmdlet, view Update-MgBetaPrintShare

Update-MgPrintShareAllowedUserMailboxSetting

Update property mailboxSettings value.

Note

To view the beta release of this cmdlet, view Update-MgBetaPrintShareAllowedUserMailboxSetting

Update-MgPrintShareJob

Update the navigation property jobs in print

Note

To view the beta release of this cmdlet, view Update-MgBetaPrintShareJob

Update-MgPrintShareJobDocument

Update the navigation property documents in print

Note

To view the beta release of this cmdlet, view Update-MgBetaPrintShareJobDocument

Update-MgPrintShareJobTask

Update the navigation property tasks in print

Note

To view the beta release of this cmdlet, view Update-MgBetaPrintShareJobTask

Update-MgPrintTaskDefinition

Update a task definition. For details about how to use this API to add pull printing support to Universal Print, see Extending Universal Print to support pull printing.

Note

To view the beta release of this cmdlet, view Update-MgBetaPrintTaskDefinition

Update-MgPrintTaskDefinitionTask

Update a print task. For details about how to use this API to add pull printing support to Universal Print, see Extending Universal Print to support pull printing.

Note

To view the beta release of this cmdlet, view Update-MgBetaPrintTaskDefinitionTask