An isomorphic javascript sdk for - SftpwithsshConnector
This package contains an isomorphic SDK for SftpwithsshConnector.
Currently supported environments
- Node.js version 6.x.x or higher
- Browser JavaScript
How to Install
npm install @easyapis/easyapis-sftpwithssh
How to use
nodejs - Authentication, client creation and getFileMetadataByPath sftpFile as an example written in TypeScript.
Install @azure/ms-rest-nodeauth
- Please install minimum version of
"@azure/ms-rest-nodeauth": "^3.0.0"
.
npm install @azure/ms-rest-nodeauth@"^3.0.0"
Sample code
import * as msRest from "@azure/ms-rest-js";
import * as msRestNodeAuth from "@azure/ms-rest-nodeauth";
import { SftpwithsshConnector, SftpwithsshConnectorModels, SftpwithsshConnectorMappers } from "@easyapis/easyapis-sftpwithssh";
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
msRestNodeAuth.interactiveLogin().then((creds) => {
const client = new SftpwithsshConnector(creds, subscriptionId);
const path = "testpath";
const queryParametersSingleEncoded = true;
client.sftpFile.getFileMetadataByPath(path, queryParametersSingleEncoded).then((result) => {
console.log("The result is:");
console.log(result);
});
}).catch((err) => {
console.error(err);
});
browser - Authentication, client creation and getFileMetadataByPath sftpFile as an example written in JavaScript.
Install @azure/ms-rest-browserauth
npm install @azure/ms-rest-browserauth
Sample code
See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser.
- index.html
<!DOCTYPE html>
<html lang="en">
<head>
<title>@easyapis/easyapis-sftpwithssh sample</title>
<script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
<script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script>
<script src="node_modules/@easyapis/easyapis-sftpwithssh/dist/easyapis-sftpwithssh.js"></script>
<script type="text/javascript">
const subscriptionId = "<Subscription_Id>";
const authManager = new msAuth.AuthManager({
clientId: "<client id for your Azure AD app>",
tenant: "<optional tenant for your organization>"
});
authManager.finalizeLogin().then((res) => {
if (!res.isLoggedIn) {
// may cause redirects
authManager.login();
}
const client = new Easyapis.EasyapisSftpwithssh.SftpwithsshConnector(res.creds, subscriptionId);
const path = "testpath";
const queryParametersSingleEncoded = true;
client.sftpFile.getFileMetadataByPath(path, queryParametersSingleEncoded).then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.log("An error occurred:");
console.error(err);
});
});
</script>
</head>
<body></body>
</html>