Skip to content
This repository was archived by the owner on Jan 29, 2022. It is now read-only.

Latest commit

 

History

History
163 lines (123 loc) · 3.36 KB

Stop-CrmProcess.md

File metadata and controls

163 lines (123 loc) · 3.36 KB
external help file Module Name online version schema
AMSoftware.Crm.PowerShell.Commands.dll-Help.xml
AMSoftware.Crm
2.0.0

Stop-CrmProcess

SYNOPSIS

Stop a running asynchronous operation (System Job).

SYNTAX

StopProcessByAsyncOperation (Default)

Stop-CrmProcess [-ASyncOperation] <Guid> [-PassThru] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

StopProcessByWorkflow

Stop-CrmProcess [-Process] <Guid> [[-Record] <Guid>] [-PassThru] [-Force] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Stop a running asynchronous operation (System Job).

EXAMPLES

Example 1

PS C:\> Stop-CrmProcess -Process 'AA5C6340-D76D-44E1-B3B8-1D3EFA0C4B8D' -Record '146C4190-4D68-4A98-9B6E-AD911F4351D9'

Stop any System Job associated to the sepcified process and record.

PARAMETERS

-ASyncOperation

The id of the System Job to stop.

Type: System.Guid
Parameter Sets: StopProcessByAsyncOperation
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force

Stops the specified processes without prompting for confirmation.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

Returns an object that represents the asyncoperation. By default, this cmdlet does not generate any output.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Process

The id of the process (workflow) to stop all associated System Jobs for.

Type: System.Guid
Parameter Sets: StopProcessByWorkflow
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Record

The id of the record to stop the associated System Jobs for.

Type: System.Guid
Parameter Sets: StopProcessByWorkflow
Aliases: Id

Required: False
Position: 5
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.Guid

OUTPUTS

Microsoft.Xrm.Sdk.Entity

NOTES

RELATED LINKS

Get-CrmProcess

Start-CrmProcess