@azure-tools/azcopy-node
Advanced tools
This package allows you to invoke AzCopy v10 from NodeJS.
const { AzCopyClient } = require("@azure-tools/azcopy-node");
let client = new AzCopyClient();
// AzCopy is used to move things from one location to another.
let src = /* a `AzCopyLocation` */;
let dst = /* a `AzCopyLocation` */;
// All functions that start AzCopy jobs return a job ID.
let jobId = await client.copy(src, dst);
let status;
// You use this job ID to check on the progress of your job, and know if it has finished.
while (!status || status.StatusType !== "EndOfJob") {
let jobInfo = await copyClient.getJobInfo(jobId)
status = jobInfo.latestStatus;
await new Promise((resolve, reject) => setTimeout(resolve, 1000));
}
AzCopy executables are available on NPM for Windows (32 and 64 bit), macOS, and Linux. This package already declares each of these as optional dependencies. The exact packages are:
They are optional dependencies because each package declares itself to only be valid for the OS it is intended for. This means that when you run npm install that only the AzCopy executable for the OS you are currently on will be installed.
If you wish to install all versions you can use the --force flag with npm install.
By default, AzCopyClient will use the @azure-tools AzCopy executable package which best matches your OS and architecture. There are two possibilities for using a different executable:
For the first scenario, if you want to force run either the 32bit for 64bit executable you can specify a bitness in the options object for the AzCopyClient constructor. Since Windows is the only OS to offer both 32 and 64 bit executables, this is really only something to consider for Windows.
For the second scenario you can use the exe field in the options object for the AzCopyClient constructor to specify the path to a custom AzCopy executable. If you do this there are two things to be aware of:
IRemoteAuthLocation, you cannot use the non-NPM versions of AzCopy on Linux. The AzCopy in @azure-tools/azcopy-linux uses a special build of AzCopy.When you use an IRemoteAuthLocation, azcopy-node must share the authentication/refresh token included in that location with the running AzCopy executable. This is done via the OS credential store. It is up to you to implement an ICredentialStore and include it in the options for your AzCopyClient if you wish for this to happen.
new AzCopyClient({
credentialStore: {
setEntry: async (service: string, account: string, value: string, exePath?: string, description?: string): Promise<void> => {
// you implement this
},
getEntry: async (service: string, account: string): Promise<string | null> => {
// you implement this
},
deleteEntry: async (service: string, account: string): Promise<boolean> => {
// you implement this
}
}
});
More information can be found in the JSDoc comments for ICredentialStore and TokenRefresher.
On macOS and Linux you may need to chmod the executables in order for them to run.
AzCopyClient will now use/prefer the @azure-tools/azcopy-win64 exe over the @azure-tools/azcopy-win32 exe.getCliCommand method on AzCopyClient.trailingDot to ICommonOptions.Bitness from IAzCopyClientOptions.ICopyOptions.listOfFiles and listOfVersions in ICommonOptions."FileBlob" and "BlobFile" to FromToOptionpreserveBlobTags to ICopyOptionsjobsRemove method on AzCopyClient"FileFile to FromToOptionincludeRegex to ICopyOptionsasSubDir to ICopyOptionsOverwriteExistingOption for use in ICopyOptionsAccessTier for use in ICopyOptionsRemoteAzCopyLocation union of all remote locationsdeleteJob method to AzCopyClient. Use this function to save memory once a job's info/status is no longer needed.nextPerformanceAdjustmentTime to IJobInfoadjustCapMbps method on AzCopyClientincludeDirectoryStub to ICopyOptions--trusted-microsoft-suffixes being added to commands when trustedDomainSuffixes is an empty array.ICopyOptions and IDeleteOptions were moved a new interface, ICommonOptions, with ICopyOptions and IDeleteOptions each inheriting that interface.includePath to ICopyOptions and IDeleteOptions.logLevel to ICopyOptions and IDeleteOptions.disableAutoDecoding to ICopyOptions.cacheControl to ICopyOptions.blockSizeMb to ICopyOptions.trustedDomainSuffixes to ICopyOptions and IDeleteOptions.keytar or macos-keychain. If you want to use an IRemoteAuthLocation you must now implement an ICredentialStore and include it in the options for your AzCopyClient. See Azure AD Scenarios and the JSDoc comments in ICredentialStore and TokenRefresher for more information.versionId. This can be used to point at a blob version.listOfVersions to ICopyOptions and IDeleteOptions. Works similarly to listOfFiles. See the JSDoc comments in either of the options files for more details."Archive" as a possible value of the accessTier copy option.forceIfReadOnly to IDeleteOptions.tags to ICopyOptions.FAQs
Unknown package
We found that @azure-tools/azcopy-node demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Malicious npm packages targeting React, Vue, Vite, Node.js, and Quill remained undetected for two years while deploying destructive payloads.
Security News
Open source maintainers are urging GitHub to let them block Copilot from submitting AI-generated issues and pull requests to their repositories.
Research
Security News
Malicious Koishi plugin silently exfiltrates messages with hex strings to a hardcoded QQ account, exposing secrets in chatbots across platforms.