Stop-AzDataFactoryV2TriggerRun

Reference

Module:: Az.DataFactory

Stops a trigger run in a data factory.

Syntax

Stop-AzDataFactoryV2TriggerRun
    [-TriggerName] <String>
    [-TriggerRunId] <String>
    [-PassThru]
    [-ResourceGroupName] <String>
    [-DataFactoryName] <String>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Stop-AzDataFactoryV2TriggerRun
    [-InputObject] <PSTriggerRun>
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Stop-AzDataFactoryV2TriggerRun
    [-TriggerName] <String>
    [-TriggerRunId] <String>
    [-PassThru]
    [-DataFactory] <PSDataFactory>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Stop-AzDataFactoryV2TriggerRun cmdlet stops a trigger run in a data factory specified with the trigger name and trigger run ID. Currently only supported for TumblingWindowTriggers in WaitingOnDependency State.

Examples

Example 1

Stop-AzDataFactoryV2TriggerRun -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -TriggerName "testTumblingWindowTrigger" -TriggerRunId 08586002468005888497807248799CU16

This command stops the trigger run with id '08586002468005888497807248799CU16' in the factory WikiADF.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DataFactory

The data factory object.

Type:	PSDataFactory
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-DataFactoryName

The data factory name.

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

The information about the trigger run.

Type:	PSTriggerRun
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-PassThru

If specified the cmdlet write true in case operation succeeds.

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

-ResourceGroupName

The resource group name.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-TriggerName

The trigger name.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-TriggerRunId

The Run ID of the trigger.

Type:	String
Position:	3
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

PSTriggerRun

String

PSDataFactory

Outputs

Boolean

Share via