Adf Web Activity Element
Adf Web Activity Element
X-Ref:
- Ast Adf Web Activity Node
- Ast Adf Web Request Activity Base Node
- Ast Adf Execution Activity Base Node
- Ast Adf Activity Base Node
- Ast Scope Boundary Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| Method | AdfRestMethod | Get | Specifies either Get, Post, or Put method for the target endpoint. 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 | |
| Url | String | If the Url is a string value, then it specifies the target endpoint, if it is an expression then it evaluates to the target endpoint. This is a required property | |
| DisableAsyncPattern | Boolean | False | Specifies whether HTTP GET should be invoked on the location given in an HTTP 202 Response. |
| DisableCertificateValidation | Boolean | False | Specifies whether the certificate should be validated during the HTTP request. |
| HttpRequestTimeout | String | Specifies the timeout after which the HTTP web request should fail if a response is not received. Use the TimeSpan format (hh:mm:ss). The default value is 1 minute (00:01:00). Acceptable values fall between 1 and 10 minutes. | |
| 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 |
|---|---|---|
| <Authentication /> | AstAdfWebActivityAuthenticationNode | AstAdfWebActivityAuthenticationNode objects specify the authentication type and the credentials to be passed to the target end point. |
| <Body /> | String | String is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx. |
| <ConnectVia /> | AstAdfLinkedServiceConnectViaNode | Specifies the integration runtime that should be used to connect to the selected linked service. |
| <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. |
| <Datasets> <Dataset /> </Datasets> | AstAdfDatasetReferenceNode | Specifies an array of Datasets that are referenced by the web activity |
| <Dependencies> <Dependency /> </Dependencies> | AstAdfActivityDependencyNode | This is the collection of activity dependencies that will control the execution of this Azure Data Factory activity. |
| <Headers> <Header /> </Headers> | AstAdfWebActivityKeyValueNode | Specifies a list of headers that are sent to the request end point. "Content-Type" is a required key. |
| <LinkedServices> <LinkedService /> </LinkedServices> | AstAdfLinkedServiceReferenceNode | Specifies an array of Linked Lists that are referenced by the web 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. |