Adf Custom Activity Element
X-Ref:
- Ast Adf Custom Activity Node
- Ast Adf Execution Activity Base Node
- Ast Adf Activity Base Node
- Ast Scope Boundary Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| Command | String | The command of the custom application for execution. This is a required property | |
| LinkedServiceName | AstAdfAzureBatchLinkedServiceNode | Azure Batch linked service. This is a required reference to an existing definiton. | |
| 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 | |
| AutoUserSpecification | String | Elevation level and scope for the user, default is nonadmin task. | |
| FolderPath | String | Path to the folder that contains the custom application. | |
| ResourceLinkedServiceName | AstAdfAzureStorageLinkedServiceBaseNode | Specifies a reference to the Azure Storage linked service that contains the address of the custom application. This references an existing definiton. | |
| RetentionTimeInDays | Double | 0 | The time for the files submitted for custom activity to be retained. |
| Retry | Int32 | -1 | Number of retry attempts. |
| RetryInterval | Int32 | 30 | Specifies the time in seconds between retry attempts. Range between 30 and 86400 with 30 being the default. |
| SecureInput | Boolean | False | Specify whether the input from the activity is sensitive and should not be logged to monitoring. |
| SecureOutput | Boolean | False | Specify whether the input from the activity is sensitive and should not be logged to monitoring |
| Timeout | String | "7" | Timeout for the activity to run. Defaults to 7 days. |
Singleton Children
| Child | API Type | Description |
|---|---|---|
| <Description /> | String | String is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx. |
| <ExtendedProperties /> | String | String is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx. |
| <ReferenceObjects /> | AstAdfCustomActivityReferenceObjectsNode | Contains the objects that are referenced in a Custom Activity. There are two separate collections within this node: a collection of Linked Service references and a collection of Dataset references. |
| <Scheduler /> | AstAdfActivityScheduleNode | AstAdfActivityScheduleNode objects correspond directly to scheduler specifications for activities in Azure Data Factory. |
Collection Children
| Child | API Type | Description |
|---|---|---|
| <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. |
| <Dependencies> <Dependency /> </Dependencies> | AstAdfActivityDependencyNode | This is the collection of activity dependencies that will control the execution of this Azure Data Factory activity. |
| <PipelineParameters> <Parameter /> </PipelineParameters> | AstAdfPipelineParameterNode | This is the collection of parameters that will be available to expressions in this Azure Data Factory activity. These parameters will be promoted automatically to the parent pipeline. |
| <UserProperties> <UserProperty /> </UserProperties> | AstAdfActivityUserPropertyNode | This is the collection of user properties that the user can monitor in the Adf monitor window. |