< Back

Set-AzureRmDataFactoryV2Trigger

Tue Jan 29, 2019 9:41 pm

NAME Set-AzureRmDataFactoryV2Trigger



SYNOPSIS

Creates a trigger in a data factory.





SYNTAX

Set-AzureRmDataFactoryV2Trigger [-ResourceGroupName] <String> [-DataFactoryName] <String> [-Name] <String> [-DefinitionFile] <String>

[-DefaultProfile <IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]



Set-AzureRmDataFactoryV2Trigger [-ResourceId] <String> [-DefinitionFile] <String> [-DefaultProfile <IAzureContextContainer>] [-Force] [-Confirm]

[-WhatIf] [<CommonParameters>]





DESCRIPTION

The Set-AzureRmDataFactoryV2Trigger cmdlet creates a trigger in a data factory. If you specify a name for a trigger that already exists, the

cmdlet prompts for confirmation before replacing the trigger. If you specify the Force parameter, the cmdlet replaces the existing trigger without

prompting for confirmation. Triggers are created in the 'Stopped' state, meaning that they don't immediately begin invoking pipelines that they

reference.





PARAMETERS

-DataFactoryName <String>

The data factory name.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DefinitionFile <String>

The JSON file path.



Required? true

Position? 3

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Force [<SwitchParameter>]

Runs the cmdlet without prompting for confirmation.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

The trigger name.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

The resource group name.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceId <String>

The Azure resource ID.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what happens if the cmdlet runs, but doesn't run the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String







OUTPUTS

Microsoft.Azure.Commands.DataFactoryV2.Models.PSTrigger







NOTES









Example 1: Create a trigger



PS C:\\> Set-AzureRmDataFactoryV2Trigger -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "ScheduledTrigger" -DefinitionFile

".\\scheduledTrigger.json"



TriggerName : ScheduledTrigger

ResourceGroupName : ADF

DataFactoryName : WikiADF

Properties : Microsoft.Azure.Management.DataFactory.Models.ScheduleTrigger

RuntimeState : Stopped



Create a new trigger called "ScheduledTrigger" in the data factory "WikiADF". The trigger is created in the 'Stopped' state, meaning that it

doesn't immediately start. A trigger can be started using the `Start-AzureRmDataFactoryV2Trigger` cmdlet.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... yv2trigger

Get-AzureRmDataFactoryV2Trigger

Start-AzureRmDataFactoryV2Trigger

Stop-AzureRmDataFactoryV2Trigger

Remove-AzureRmDataFactoryV2Trigger