Runs the command in a mode that only reports what would happen without performing the actions.
Parameter properties
Type:
System.Management.Automation.SwitchParameter
Supports wildcards:
False
DontShow:
False
Aliases:
wi
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters.
To create the parameters described below, construct a hash table containing the appropriate properties.
For information on hash tables, run Get-Help about_Hash_Tables.
BODYPARAMETER <IMicrosoftGraphPrintJob>: printJob
[(Any) <Object>]: This indicates any property can be added to this object.
[Id <String>]: The unique identifier for an entity.
Read-only.
[AcknowledgedDateTime <DateTime?>]:
[CompletedDateTime <DateTime?>]:
[Configuration <IMicrosoftGraphPrintJobConfiguration>]: printJobConfiguration
[(Any) <Object>]: This indicates any property can be added to this object.
[Collate <Boolean?>]: Whether the printer should collate pages when printing multiple copies of a multi-page document.
[ColorMode <String>]: printColorMode
[Copies <Int32?>]: The number of copies that should be printed.
Read-only.
[Dpi <Int32?>]: The resolution to use when printing the job, expressed in dots per inch (DPI).
Read-only.
[DuplexMode <String>]: printDuplexMode
[FeedOrientation <String>]: printerFeedOrientation
[Finishings <String[]>]: Finishing processes to use when printing.
[FitPdfToPage <Boolean?>]:
[InputBin <String>]: The input bin (tray) to use when printing.
See the printer's capabilities for a list of supported input bins.
[Margin <IMicrosoftGraphPrintMargin>]: printMargin
[(Any) <Object>]: This indicates any property can be added to this object.
[Bottom <Int32?>]: The margin in microns from the bottom edge.
[Left <Int32?>]: The margin in microns from the left edge.
[Right <Int32?>]: The margin in microns from the right edge.
[Top <Int32?>]: The margin in microns from the top edge.
[MediaSize <String>]: The media sizeto use when printing.
Supports standard size names for ISO and ANSI media sizes.
Valid values are listed in the printerCapabilities topic.
[MediaType <String>]: The default media (such as paper) type to print the document on.
[MultipageLayout <String>]: printMultipageLayout
[Orientation <String>]: printOrientation
[OutputBin <String>]: The output bin to place completed prints into.
See the printer's capabilities for a list of supported output bins.
[PageRanges <IMicrosoftGraphIntegerRange[]>]: The page ranges to print.
Read-only.
[End <Int64?>]: The inclusive upper bound of the integer range.
[Maximum <Int64?>]:
[Minimum <Int64?>]:
[Start <Int64?>]: The inclusive lower bound of the integer range.
[PagesPerSheet <Int32?>]: The number of document pages to print on each sheet.
[Quality <String>]: printQuality
[Scaling <String>]: printScaling
[CreatedBy <IMicrosoftGraphUserIdentity>]: userIdentity
[(Any) <Object>]: This indicates any property can be added to this object.
[DisplayName <String>]: The display name of the identity.
This property is read-only.
[Id <String>]: The identifier of the identity.
This property is read-only.
[IPAddress <String>]: Indicates the client IP address associated with the user performing the activity (audit log only).
[UserPrincipalName <String>]: The userPrincipalName attribute of the user.
[CreatedDateTime <DateTime?>]: The DateTimeOffset when the job was created.
Read-only.
[DisplayName <String>]: The name of the print job.
[Documents <IMicrosoftGraphPrintDocument[]>]:
[Id <String>]: The unique identifier for an entity.
Read-only.
[Configuration <IMicrosoftGraphPrinterDocumentConfiguration>]: printerDocumentConfiguration
[(Any) <Object>]: This indicates any property can be added to this object.
[Collate <Boolean?>]:
[ColorMode <String>]: printColorMode
[Copies <Int32?>]:
[Dpi <Int32?>]:
[DuplexMode <String>]: printDuplexMode
[FeedDirection <String>]: printerFeedDirection
[FeedOrientation <String>]: printerFeedOrientation
[Finishings <String[]>]:
[FitPdfToPage <Boolean?>]:
[InputBin <String>]:
[Margin <IMicrosoftGraphPrintMargin>]: printMargin
[MediaSize <String>]:
[MediaType <String>]:
[MultipageLayout <String>]: printMultipageLayout
[Orientation <String>]: printOrientation
[OutputBin <String>]:
[PageRanges <IMicrosoftGraphIntegerRange[]>]:
[PagesPerSheet <Int32?>]:
[Quality <String>]: printQuality
[Scaling <String>]: printScaling
[ContentType <String>]: The document's content (MIME) type.
Read-only.
[DisplayName <String>]: The document's name.
Read-only.
[DownloadedDateTime <DateTime?>]:
[Size <Int64?>]: The document's size in bytes.
Read-only.
[UploadedDateTime <DateTime?>]:
[ErrorCode <Int32?>]:
[IsFetchable <Boolean?>]: If true, document can be fetched by printer.
[RedirectedFrom <String>]: Contains the source job URL, if the job has been redirected from another printer.
[RedirectedTo <String>]: Contains the destination job URL, if the job has been redirected to another printer.
[Status <IMicrosoftGraphPrintJobStatus>]: printJobStatus
[(Any) <Object>]: This indicates any property can be added to this object.
[AcquiredByPrinter <Boolean?>]:
[Description <String>]: A human-readable description of the print job's current processing state.
Read-only.
[Details <String[]>]: Additional details for print job state.
Valid values are described in the following table.
Read-only.
[IsAcquiredByPrinter <Boolean?>]: True if the job was acknowledged by a printer; false otherwise.
Read-only.
[ProcessingState <String>]: printJobProcessingState
[ProcessingStateDescription <String>]:
[State <String>]: printJobProcessingState
[Tasks <IMicrosoftGraphPrintTask[]>]: A list of printTasks that were triggered by this print job.
[Id <String>]: The unique identifier for an entity.
Read-only.
[Definition <IMicrosoftGraphPrintTaskDefinition>]: printTaskDefinition
[(Any) <Object>]: This indicates any property can be added to this object.
[Id <String>]: The unique identifier for an entity.
Read-only.
[CreatedBy <IMicrosoftGraphAppIdentity>]: appIdentity
[(Any) <Object>]: This indicates any property can be added to this object.
[AppId <String>]: Refers to the unique identifier representing application ID in the Microsoft Entra ID.
[DisplayName <String>]: Refers to the application name displayed in the Microsoft Entra admin center.
[ServicePrincipalId <String>]: Refers to the unique identifier indicating service principal ID in Microsoft Entra ID for the corresponding App.
[ServicePrincipalName <String>]: Refers to the Service Principal Name is the Application name in the tenant.
[DisplayName <String>]: The name of the printTaskDefinition.
[Tasks <IMicrosoftGraphPrintTask[]>]: A list of tasks that have been created based on this definition.
The list includes currently running tasks and recently completed tasks.
Read-only.
[ParentUrl <String>]: The URL for the print entity that triggered this task.
For example, https://graph.microsoft.com/beta/print/printers/{printerId}/jobs/{jobId}.
Read-only.
[Status <IMicrosoftGraphPrintTaskStatus>]: printTaskStatus
[(Any) <Object>]: This indicates any property can be added to this object.
[Description <String>]: A human-readable description of the current processing state of the printTask.
[State <String>]: printTaskProcessingState
[Trigger <IMicrosoftGraphPrintTaskTrigger>]: printTaskTrigger
[(Any) <Object>]: This indicates any property can be added to this object.
[Id <String>]: The unique identifier for an entity.
Read-only.
[Definition <IMicrosoftGraphPrintTaskDefinition>]: printTaskDefinition
[Event <String>]: printEvent
CONFIGURATION <IMicrosoftGraphPrintJobConfiguration>: printJobConfiguration
[(Any) <Object>]: This indicates any property can be added to this object.
[Collate <Boolean?>]: Whether the printer should collate pages when printing multiple copies of a multi-page document.
[ColorMode <String>]: printColorMode
[Copies <Int32?>]: The number of copies that should be printed.
Read-only.
[Dpi <Int32?>]: The resolution to use when printing the job, expressed in dots per inch (DPI).
Read-only.
[DuplexMode <String>]: printDuplexMode
[FeedOrientation <String>]: printerFeedOrientation
[Finishings <String[]>]: Finishing processes to use when printing.
[FitPdfToPage <Boolean?>]:
[InputBin <String>]: The input bin (tray) to use when printing.
See the printer's capabilities for a list of supported input bins.
[Margin <IMicrosoftGraphPrintMargin>]: printMargin
[(Any) <Object>]: This indicates any property can be added to this object.
[Bottom <Int32?>]: The margin in microns from the bottom edge.
[Left <Int32?>]: The margin in microns from the left edge.
[Right <Int32?>]: The margin in microns from the right edge.
[Top <Int32?>]: The margin in microns from the top edge.
[MediaSize <String>]: The media sizeto use when printing.
Supports standard size names for ISO and ANSI media sizes.
Valid values are listed in the printerCapabilities topic.
[MediaType <String>]: The default media (such as paper) type to print the document on.
[MultipageLayout <String>]: printMultipageLayout
[Orientation <String>]: printOrientation
[OutputBin <String>]: The output bin to place completed prints into.
See the printer's capabilities for a list of supported output bins.
[PageRanges <IMicrosoftGraphIntegerRange[]>]: The page ranges to print.
Read-only.
[End <Int64?>]: The inclusive upper bound of the integer range.
[Maximum <Int64?>]:
[Minimum <Int64?>]:
[Start <Int64?>]: The inclusive lower bound of the integer range.
[PagesPerSheet <Int32?>]: The number of document pages to print on each sheet.
[Quality <String>]: printQuality
[Scaling <String>]: printScaling
CREATEDBY <IMicrosoftGraphUserIdentity>: userIdentity
[(Any) <Object>]: This indicates any property can be added to this object.
[DisplayName <String>]: The display name of the identity.
This property is read-only.
[Id <String>]: The identifier of the identity.
This property is read-only.
[IPAddress <String>]: Indicates the client IP address associated with the user performing the activity (audit log only).
[UserPrincipalName <String>]: The userPrincipalName attribute of the user.
DOCUMENTS <IMicrosoftGraphPrintDocument[]>: .
[Id <String>]: The unique identifier for an entity.
Read-only.
[Configuration <IMicrosoftGraphPrinterDocumentConfiguration>]: printerDocumentConfiguration
[(Any) <Object>]: This indicates any property can be added to this object.
[Collate <Boolean?>]:
[ColorMode <String>]: printColorMode
[Copies <Int32?>]:
[Dpi <Int32?>]:
[DuplexMode <String>]: printDuplexMode
[FeedDirection <String>]: printerFeedDirection
[FeedOrientation <String>]: printerFeedOrientation
[Finishings <String[]>]:
[FitPdfToPage <Boolean?>]:
[InputBin <String>]:
[Margin <IMicrosoftGraphPrintMargin>]: printMargin
[(Any) <Object>]: This indicates any property can be added to this object.
[Bottom <Int32?>]: The margin in microns from the bottom edge.
[Left <Int32?>]: The margin in microns from the left edge.
[Right <Int32?>]: The margin in microns from the right edge.
[Top <Int32?>]: The margin in microns from the top edge.
[MediaSize <String>]:
[MediaType <String>]:
[MultipageLayout <String>]: printMultipageLayout
[Orientation <String>]: printOrientation
[OutputBin <String>]:
[PageRanges <IMicrosoftGraphIntegerRange[]>]:
[End <Int64?>]: The inclusive upper bound of the integer range.
[Maximum <Int64?>]:
[Minimum <Int64?>]:
[Start <Int64?>]: The inclusive lower bound of the integer range.
[PagesPerSheet <Int32?>]:
[Quality <String>]: printQuality
[Scaling <String>]: printScaling
[ContentType <String>]: The document's content (MIME) type.
Read-only.
[DisplayName <String>]: The document's name.
Read-only.
[DownloadedDateTime <DateTime?>]:
[Size <Int64?>]: The document's size in bytes.
Read-only.
[UploadedDateTime <DateTime?>]:
INPUTOBJECT <IDevicesCloudPrintIdentity>: Identity Parameter
[GroupId <String>]: The unique identifier of group
[PrintConnectorId <String>]: The unique identifier of printConnector
[PrintDocumentId <String>]: The unique identifier of printDocument
[PrintJobId <String>]: The unique identifier of printJob
[PrintOperationId <String>]: The unique identifier of printOperation
[PrintServiceEndpointId <String>]: The unique identifier of printServiceEndpoint
[PrintServiceId <String>]: The unique identifier of printService
[PrintTaskDefinitionId <String>]: The unique identifier of printTaskDefinition
[PrintTaskId <String>]: The unique identifier of printTask
[PrintTaskTriggerId <String>]: The unique identifier of printTaskTrigger
[PrinterId <String>]: The unique identifier of printer
[PrinterShareId <String>]: The unique identifier of printerShare
[UserId <String>]: The unique identifier of user
STATUS <IMicrosoftGraphPrintJobStatus>: printJobStatus
[(Any) <Object>]: This indicates any property can be added to this object.
[AcquiredByPrinter <Boolean?>]:
[Description <String>]: A human-readable description of the print job's current processing state.
Read-only.
[Details <String[]>]: Additional details for print job state.
Valid values are described in the following table.
Read-only.
[IsAcquiredByPrinter <Boolean?>]: True if the job was acknowledged by a printer; false otherwise.
Read-only.
[ProcessingState <String>]: printJobProcessingState
[ProcessingStateDescription <String>]:
[State <String>]: printJobProcessingState
TASKS <IMicrosoftGraphPrintTask[]>: A list of printTasks that were triggered by this print job.
[Id <String>]: The unique identifier for an entity.
Read-only.
[Definition <IMicrosoftGraphPrintTaskDefinition>]: printTaskDefinition
[(Any) <Object>]: This indicates any property can be added to this object.
[Id <String>]: The unique identifier for an entity.
Read-only.
[CreatedBy <IMicrosoftGraphAppIdentity>]: appIdentity
[(Any) <Object>]: This indicates any property can be added to this object.
[AppId <String>]: Refers to the unique identifier representing application ID in the Microsoft Entra ID.
[DisplayName <String>]: Refers to the application name displayed in the Microsoft Entra admin center.
[ServicePrincipalId <String>]: Refers to the unique identifier indicating service principal ID in Microsoft Entra ID for the corresponding App.
[ServicePrincipalName <String>]: Refers to the Service Principal Name is the Application name in the tenant.
[DisplayName <String>]: The name of the printTaskDefinition.
[Tasks <IMicrosoftGraphPrintTask[]>]: A list of tasks that have been created based on this definition.
The list includes currently running tasks and recently completed tasks.
Read-only.
[ParentUrl <String>]: The URL for the print entity that triggered this task.
For example, https://graph.microsoft.com/beta/print/printers/{printerId}/jobs/{jobId}.
Read-only.
[Status <IMicrosoftGraphPrintTaskStatus>]: printTaskStatus
[(Any) <Object>]: This indicates any property can be added to this object.
[Description <String>]: A human-readable description of the current processing state of the printTask.
[State <String>]: printTaskProcessingState
[Trigger <IMicrosoftGraphPrintTaskTrigger>]: printTaskTrigger
[(Any) <Object>]: This indicates any property can be added to this object.
[Id <String>]: The unique identifier for an entity.
Read-only.
[Definition <IMicrosoftGraphPrintTaskDefinition>]: printTaskDefinition
[Event <String>]: printEvent