Adf Kusto Query Language Activity Element
Adf Kusto Query Language Activity Element
API Type:
Varigence.Languages.Biml.DataFactory.AstAdfKustoQueryLanguageActivityNode
X-Ref:
- Ast Adf Kusto Query Language 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 | KQL management command or query that runs against the Microsoft Fabric KQL database item. 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 | |
| CommandTimeout | String | Time span signifying the length of time before the command times out. | |
| LinkedServiceName | AstAdfKustoDatabaseLinkedServiceNode | Specifies a reference to the Microsoft Fabric KQL database linked service the command runs against. This references an existing definiton. | |
| OnInactiveMarkAs | AdfActivityOnInactiveMarkAs | Succeeded | Specifies the status result of the activity when the state is set to Inactive (Succeeded, Failed, or Skipped). If not provided when the activity is inactive, the status will be Succeeded by default. |
| 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 |
| State | AdfActivityState | Active | Specifies the state of the activity (Active or Inactive). If not provided, the state will be Active by default. |
| 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. |
| <RawJsonProperties /> | String | String is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx. |
| <RawJsonTypeProperties /> | String | String is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx. |
| <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. |