Adf Schedule Trigger Element
X-Ref:
- Ast Adf Schedule Trigger Node
- Ast Adf Trigger Base Node
- Ast Adf Root Object Node
- Ast Scope Boundary Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| Frequency | AdfRecurrenceFrequencies | Minute | Specifies the length of time of each interval. Accepted values are Minute, Hour, Day, Week, and Year. This is a required property |
| Name | String | Specifies the name of the object. This name can be used to reference this object from anywhere else in the program. This is a required property | |
| Count | Int32 | 0 | Specifies the number of times that the trigger will execute. |
| End | String | Specifies the date and time at which the pipeline becomes inactive. This property value is required if the Start property is supplied. If a value is not supplied, then the pipeline will not run until a start and end is set on Azure Data Factory. To specify that pipeline should run indefinitely, use a date far in the future such as '9999-09-09'. | |
| Interval | Int32 | 0 | Combines with the Frequency to describe how often a trigger is executed. For example an interval of 5 with a frequency of hours will run the trigger every 5 hours. |
| Start | String | Specifies the date and time at which the pipeline becomes active. This property value is required if the End property is supplied. If a value is not supplied, then the pipeline will not run until a start and end is set on Azure Data Factory. | |
| TimeZone | String | Specify the time-zone, currently only UTC is supported. |
Singleton Children
| Child | API Type | Description |
|---|---|---|
| <Schedule /> | AstAdfScheduleNode | AstAdfScheduleNode objects model a schedule to be passed into Schedule trigger nodes. |
Collection Children
| Child | API Type | Description |
|---|---|---|
| <Pipelines> <Pipeline /> </Pipelines> | AstAdfPipelineExecutionNode | This is the collection of pipelines that will be executed along with parameter values. This is a required property |
| <AdfAnnotations> <AdfAnnotation /> </AdfAnnotations> | String | This is the collection of annotations that will be emitted in the json. |
| <Annotations> <Annotation /> </Annotations> | AstAnnotationNode | This is a collection of annotation items that can be used to specify documentation, tags, or other information. Annotations are particularly useful for storing information about nodes that can be used by BimlScript code. |