Share via


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

Syntax

UpdateExpanded (Default)

Update-MgPrintTaskDefinitionTask
    -PrintTaskDefinitionId <string>
    -PrintTaskId <string>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-Definition <IMicrosoftGraphPrintTaskDefinition>]
    [-Id <string>]
    [-ParentUrl <string>]
    [-Status <IMicrosoftGraphPrintTaskStatus>]
    [-Trigger <IMicrosoftGraphPrintTaskTrigger>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update

Update-MgPrintTaskDefinitionTask
    -PrintTaskDefinitionId <string>
    -PrintTaskId <string>
    -BodyParameter <IMicrosoftGraphPrintTask>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityExpanded

Update-MgPrintTaskDefinitionTask
    -InputObject <IDevicesCloudPrintIdentity>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-Definition <IMicrosoftGraphPrintTaskDefinition>]
    [-Id <string>]
    [-ParentUrl <string>]
    [-Status <IMicrosoftGraphPrintTaskStatus>]
    [-Trigger <IMicrosoftGraphPrintTaskTrigger>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentity

Update-MgPrintTaskDefinitionTask
    -InputObject <IDevicesCloudPrintIdentity>
    -BodyParameter <IMicrosoftGraphPrintTask>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

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.

Examples

Example 1: Code snippet


Import-Module Microsoft.Graph.Devices.CloudPrint

$params = @{
	status = @{
		state = "completed"
		description = "completed"
	}
}

Update-MgPrintTaskDefinitionTask -PrintTaskDefinitionId $printTaskDefinitionId -PrintTaskId $printTaskId -BodyParameter $params

This example shows how to use the Update-MgPrintTaskDefinitionTask Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:System.Collections.Hashtable
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BodyParameter

printTask To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphPrintTask
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
Update
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Break

Wait for .NET debugger to attach

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Definition

printTaskDefinition To construct, see NOTES section for DEFINITION properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphPrintTaskDefinition
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:System.Collections.IDictionary
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

The unique identifier for an entity. Read-only.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IDevicesCloudPrintIdentity
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-ParentUrl

The URL for the print entity that triggered this task. For example, https://graph.microsoft.com/v1.0/print/printers/{printerId}/jobs/{jobId}. Read-only.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PrintTaskDefinitionId

The unique identifier of printTaskDefinition

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Update
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PrintTaskId

The unique identifier of printTask

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Update
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Proxy

The URI for the proxy server to use

Parameter properties

Type:System.Uri
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:System.Management.Automation.PSCredential
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Status

printTaskStatus To construct, see NOTES section for STATUS properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphPrintTaskStatus
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Trigger

printTaskTrigger To construct, see NOTES section for TRIGGER properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphPrintTaskTrigger
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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.

Inputs

Microsoft.Graph.PowerShell.Models.IDevicesCloudPrintIdentity

{{ Fill in the Description }}

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphPrintTask

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphPrintTask

{{ Fill in the Description }}

Notes

COMPLEX PARAMETER PROPERTIES

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 <IMicrosoftGraphPrintTask>: printTask [(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 [(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 ID representing application in Microsoft Entra ID. [DisplayName <String>]: Refers to the application name displayed in the Microsoft Entra admin center. [ServicePrincipalId <String>]: Refers to the unique ID for the service principal in Microsoft Entra ID. [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/v1.0/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

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 ID representing application in Microsoft Entra ID. [DisplayName <String>]: Refers to the application name displayed in the Microsoft Entra admin center. [ServicePrincipalId <String>]: Refers to the unique ID for the service principal in Microsoft Entra ID. [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. [Id <String>]: The unique identifier for an entity. Read-only. [Definition <IMicrosoftGraphPrintTaskDefinition>]: printTaskDefinition [ParentUrl <String>]: The URL for the print entity that triggered this task. For example, https://graph.microsoft.com/v1.0/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

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 <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 [(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 ID representing application in Microsoft Entra ID. [DisplayName <String>]: Refers to the application name displayed in the Microsoft Entra admin center. [ServicePrincipalId <String>]: Refers to the unique ID for the service principal in Microsoft Entra ID. [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. [Id <String>]: The unique identifier for an entity. Read-only. [Definition <IMicrosoftGraphPrintTaskDefinition>]: printTaskDefinition [ParentUrl <String>]: The URL for the print entity that triggered this task. For example, https://graph.microsoft.com/v1.0/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 [Event <String>]: printEvent