Frends.AzureBlobStorage.DownloadBlob / 4.1.0
Summary
Copies a blob onto the agent's file system, deciding up front what should happen if a file of that name is already there.
Typical use — getting a file onto disk for a tool or Task that works with paths; use the read Task when the content is only needed in memory
Input parameters for the DownloadBlob task, specifying what to download and where to save it.
| Name | Type | Default | Example | Description |
|---|---|---|---|---|
| ContainerName | String |
– | my-container |
Name of the Azure Blob Storage container from which the blob is downloaded. |
| BlobName | String |
– | sample.txt |
Name of the blob to download, including any virtual directory path. |
| TargetDirectory | String |
– | c:\temp |
Local directory where the downloaded file will be saved. |
| TargetFileName | String |
– | custom-name.txt |
Optional custom filename for the downloaded blob. If left empty the original blob name is used. |
| ActionOnExistingFile | FileExistsAction |
Throw |
FileExistsAction.Throw |
Specifies what to do when a file already exists at the destination path. Throw: raises an exception; Rename: appends an incrementing number; Overwrite: replaces the file. Possible values:
|