New-MgBetaPrintTaskDefinition
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 v1.0 release of this cmdlet, view New-MgPrintTaskDefinition
Syntax
CreateExpanded (Default)
New-MgBetaPrintTaskDefinition
[-ResponseHeadersVariable <string>]
[-AdditionalProperties <hashtable>]
[-CreatedBy <IMicrosoftGraphAppIdentity>]
[-DisplayName <string>]
[-Id <string>]
[-Tasks <IMicrosoftGraphPrintTask[]>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Create
New-MgBetaPrintTaskDefinition
-BodyParameter <IMicrosoftGraphPrintTaskDefinition>
[-ResponseHeadersVariable <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
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.
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Beta.Devices.CloudPrint
$params = @{
displayName = "Test TaskDefinitionName"
createdBy = @{
displayName = "Requesting App Display Name"
}
}
New-MgBetaPrintTaskDefinition -BodyParameter $params
This example shows how to use the New-MgBetaPrintTaskDefinition Cmdlet.
Parameters
-AdditionalProperties
Additional Parameters
Parameter properties
| Type: | System.Collections.Hashtable |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-BodyParameter
printTaskDefinition To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphPrintTaskDefinition |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Create
| 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 |
-CreatedBy
appIdentity To construct, see NOTES section for CREATEDBY properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphAppIdentity |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DisplayName
The name of the printTaskDefinition.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| 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.Beta.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.Beta.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
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| 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 |
-Tasks
A list of tasks that have been created based on this definition. The list includes currently running tasks and recently completed tasks. Read-only. To construct, see NOTES section for TASKS properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphPrintTask[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| 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.Beta.PowerShell.Models.IMicrosoftGraphPrintTaskDefinition
{{ Fill in the Description }}
System.Collections.IDictionary
{{ Fill in the Description }}
Outputs
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphPrintTaskDefinition
{{ 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 <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.
[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/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
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.
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
[(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