Azure Blob Download Task Element
Azure Blob Download Task Element
X-Ref:
- Ast Azure Blob Download Task Node
- Ast Azure Blob Transfer Task Node
- Ast Task Base Node
- Ast Task Node
- Ast Scope Boundary Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| BlobContainer | String | Specifies the name of the blob container that should be the target of file uploads or the source of file downloads. This is a required property. | |
| ConnectionName | AstAzureStorageConnectionNode | Specifies the AzureStorageConnection that should be used to connect to Microsoft Azure Blob Storage. This is a required reference to an existing definition. | |
| LocalDirectory | String | Specifies the path to the local directory that will store files to upload or files that have been downloaded. 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. | |
| BlobDirectory | String | Specifies the virtual hierarchical structure directory path that should be used to locate files for download or that should be prepended to files that are uploaded to blob storage. | |
| DelayValidation | Boolean | false | Specifies whether the validation of the Dataflow task in SSIS should be delayed until the package is executed. |
| Disabled | Boolean | false | Specifies whether the item is disabled. Default is False. |
| DisableEventHandlers | Boolean | false | Specifies whether the event handlers for this task, container, or package should be prevented from executing. Default is False. |
| EndTimeRange | DateTime | 01/01/0001 00:00:00 | Specifies the end DateTime for files that should be uploaded or downloaded. Only files created before this will be included. |
| ExecutionValueVariableName | AstVariableBaseNode | Specifies a variable to hold the execution results of this component. References an existing definition. | |
| FailPackageOnFailure | Boolean | false | Determines whether the container will fail when a component fails. If this is a package, only False is valid. |
| FailParentOnFailure | Boolean | false | Determines whether the parent container will fail when a child container fails. Default is False. |
| FileFilter | String | * | Filter (wildcards allowed) to include files for upload/download. Defaults to '*' (all files). |
| ForcedExecutionValue | String | 0 | Used if ForceExecutionValue is True. This is the value returned as the execution result. |
| ForcedExecutionValueDataType | TypeCode | Int32 | Specifies the data type of the ForcedExecutionValue. |
| ForceExecutionResult | ForceExecutionResult | None | Specifies whether a forced result should be returned. Default is None. |
| ForceExecutionValue | Boolean | false | Indicates whether the ForcedExecutionValue should be used. |
| Id | Guid | 00000000-0000-0000-0000-000000000000 | Allows specifying a unique ID (GUID) for consistent builds. |
| IsolationLevel | IsolationLevel | Serializable | Sets the isolation level for transactions in this container. |
| Language | Language | Inherited | Specifies the default language for this task and its children. |
| LoggingMode | LoggingMode | Inherit | Specifies whether logging is enabled or inherited from parent. |
| MaxErrorCount | Int32 | 1 | Maximum number of errors before the package stops. Default is 1. |
| StartTimeRange | DateTime | 01/01/0001 00:00:00 | Only files created after this datetime will be included in transfer. |
| TransactionMode | ContainerTransactionMode | Join | Specifies the transaction context this task will execute in. |
Singleton Children
| Child | API Type | Description |
|---|---|---|
| <PrecedenceConstraints /> | AstTaskflowPrecedenceConstraintsNode | The AstTaskflowPrecedenceConstraintsNode type corresponds directly to a precedence constraint in a SQL Server Integration Services task control flow. |
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. |
| <Events> <Event /> </Events> | AstTaskEventHandlerNode | This is a collection of event handlers that can respond to SQL Server Integration Services events that are raised on this task. |
| <Expressions> <Expression /> </Expressions> | AstPropertyExpressionNode | This is a collection of SSIS expression definitions for property value overrides that are specific to this task, container, or package. |
| <LogEvents> <LogEvent /> </LogEvents> | AstLogEventNode | This is a container for log event definitions that are specific to this task, container, or package. |
| <LogProviders> Multiple Choices... </LogProviders> | AstLogProviderBaseNode | Defines the log providers to use for the SSIS task or container This is a container for log provider definitions that are specific to this task, container, or package. |
| <Variables> <Variable /> </Variables> | AstVariableNode | This is a container for variable definitions that are specific to this task, container, or package. |