ardiffact

Home > @microsoft/azure-artifact-storage > downloadArtifacts

downloadArtifacts() function

Downloads artifacts from Azure Blob Storage container to the local file system

Signature:

declare function downloadArtifacts(config: AzureBlobStorageConfig, prefix: string, downloadDirectory?: string, filter?: string | string[], gzip?: boolean): Promise<{
    name: string;
    path?: string;
}[]>;

Parameters

Parameter	Type	Description
config	AzureBlobStorageConfig	The AzureBlobStorageConfig used to create an instance of a Storage client
prefix	string	Prefix for the blob name in Azure Blob Storage
downloadDirectory	string	Local directory to download artifacts to
filter	string | string[]	Globbing pattern to use to filter blobs
gzip	boolean	Whether to decompress the artifacts

Returns:

Promise<{ name: string; path?: string; }[]>

• List of names and paths to downloaded artifacts

This site is open source. Improve this page.