Differences
This shows you the differences between the selected revisions of the page.
| 2014-09-10 | 2014-09-10 | ||
| old revision restored (martin) | c# section completed (martin) | ||
| Line 195: | Line 195: | ||
| ==== [[consoleapp]] C# Console Application ==== | ==== [[consoleapp]] C# Console Application ==== | ||
| + | //If you are implementing your task using C# (console) application, you can use WinSCP .NET assembly to implement file transfer/synchronization. Implementing the task in C# may be useful for very complex and possibly continuous jobs.// | ||
| - | TODO | + | //Start with learning more about the [[library|WinSCP .NET assembly]] and see some [[library_examples|C# examples]].// |
| - | (*Particularly, when your WebJob is a console application, you may want to use Microsoft Visual Studio for Web to develop it, starting with Microsoft Azure WebJob from Microsoft Azure SDK. You can then use //Public as Azure WebJob// wizard to upload the file to the Azure web site and to setup job scheduling (if required).*) | + | Comparing with generic WinSCP .NET assembly C# examples, your Azure transfer application should: |
| + | |||
| + | ··* have a wrapper batch file named ''run.bat'' so that Azure correctly identifies it as [[guide_microsoft_azure_webjob_sftp#structure|the main executable]]((There will be two ''.exe'' files, your application and ''winscp.exe'', so Azure won't know which one to pick up, unless you name your application ''run.exe''.)); | ||
| + | * propagate any error from WinSCP .NET library to its exit code, so that Azure correctly identifies failures (any non-zero exit code is a failure to Azure); | ||
| + | * enable session logging to a unique job run directory (''%WEBJOBS_DATA_PATH%\%WEBJOBS_RUN_ID%''); | ||
| + | * locate source or destination paths of the transfer using WebJob [[guide_microsoft_azure_webjob_sftp#environment|environment variables]]; | ||
| + | * [[guide_microsoft_azure_webjob_sftp#log|print the session log to the standard output]], so that it is available from Azure Management Portal or provide other means for accessing the log. | ||
| + | |||
| + | An example C# code that backs up the WebSite to a remote SFTP server: | ||
| + | |||
| + | <code csharp> | ||
| + | using System; | ||
| + | using System.IO; | ||
| + | using WinSCP; | ||
| + | |||
| + | class Example | ||
| + | { | ||
| + | public static int Main() | ||
| + | { | ||
| + | int result; | ||
| + | string sessionLogPath = | ||
| + | Path.Combine( | ||
| + | Environment.GetEnvironmentVariable("WEBJOBS_DATA_PATH"), | ||
| + | Environment.GetEnvironmentVariable("WEBJOBS_RUN_ID"), | ||
| + | "session.log"); | ||
| + | |||
| + | try | ||
| + | { | ||
| + | // Setup session options | ||
| + | SessionOptions sessionOptions = new SessionOptions | ||
| + | { | ||
| + | Protocol = Protocol.Sftp, | ||
| + | HostName = "example.com", | ||
| + | UserName = "user", | ||
| + | Password = "mypassword", | ||
| + | SshHostKeyFingerprint = "ssh-rsa 2048 xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx" | ||
| + | }; | ||
| + | |||
| + | using (Session session = new Session()) | ||
| + | { | ||
| + | session.SessionLogPath = sessionLogPath; | ||
| + | |||
| + | // Connect | ||
| + | Console.WriteLine("Connecting..."); | ||
| + | session.Open(sessionOptions); | ||
| + | |||
| + | string backupPath = | ||
| + | "/home/user/backup/" + | ||
| + | Environment.GetEnvironmentVariable("WEBJOBS_RUN_ID"); | ||
| + | session.CreateDirectory(backupPath); | ||
| + | |||
| + | Console.WriteLine("Uploading..."); | ||
| + | string source = Path.Combine(Environment.GetEnvironmentVariable("WEBROOT_PATH"), "*"); | ||
| + | string target = backupPath + "/"; | ||
| + | session.PutFiles(source, target).Check(); | ||
| + | } | ||
| + | |||
| + | result = 0; | ||
| + | } | ||
| + | catch (Exception e) | ||
| + | { | ||
| + | Console.WriteLine("Error: {0}", e); | ||
| + | result = 1; | ||
| + | } | ||
| + | |||
| + | // Dumping session log to Azure log (standard output) when it exists | ||
| + | if (File.Exists(sessionLogPath)) | ||
| + | { | ||
| + | Console.WriteLine("Session log:"); | ||
| + | |||
| + | using (Stream sessionLog = File.OpenRead(sessionLogPath)) | ||
| + | using (Stream standardOutput = Console.OpenStandardOutput()) | ||
| + | { | ||
| + | sessionLog.CopyTo(standardOutput); | ||
| + | } | ||
| + | } | ||
| + | |||
| + | return result; | ||
| + | } | ||
| + | } | ||
| + | </code> | ||
| + | |||
| + | An example wrapper batch file (''run.bat'') that simply runs your application executable: | ||
| + | |||
| + | <code batch> | ||
| + | ConsoleApplication1.exe | ||
| + | </code> | ||
| + | |||
| + | A complete WebJob package (to be [[guide_microsoft_azure_webjob_sftp#deploying|deployed to Azure WebSite]]) consists of following files: | ||
| + | |||
| + | * your application executable (e.g. ''ConsoleApplication1.exe''); | ||
| + | * ''winscp.exe'' [[executables|executable]]; | ||
| + | * ''winscpnet.dll'' [[library|.NET assembly]]; | ||
| + | * ''run.bat'' wrapper batch file; | ||
| + | * optionally [[public_key|a private key file]] for SSH authentication. | ||
| + | |||
| + | You can develop the WebJob (console) application as any other, even using //Visual Studio Express for Windows Desktop//. If you are using //Visual Studio Express for Web//, you can use //Microsoft Azure WebJob// project template. It's basically the same template as a //Console Application// in the Desktop edition.((Web edition does not have //Console Application// template.)) | ||
| + | |||
| + | With //Visual Studio Express for Web// (2013 edition with Update 3) you can ease [[guide_microsoft_azure_webjob_sftp#deploying|the deployment]] using command //Publish as Azure WebJob//, which is available in the project context menu in //Solution Explorer//. It opens //[[http://azure.microsoft.com/en-us/documentation/articles/websites-dotnet-deploy-webjobs/#configure|Add Azure WebJob]]// dialog that allows you to name your job and setup how it is run (including scheduling). Make sure you add all additional files needed for the job (i.e. ''winscp.exe'', ''run.bat'' and private key, as shown above) to the project with //Build Action// set to //Content// to have them deployed (see also [[library_install#vs|Using WinSCP .NET assembly from Visual Studio]]). When you submit the dialog, a publish process starts on the background in //Web Publish Activity// pane. Next time you publish, after making changes to the project, only modified files are uploaded. See also [[http://azure.microsoft.com/en-us/documentation/articles/websites-dotnet-deploy-webjobs/|How to Deploy Azure WebJobs to Azure Websites]]. | ||
| ===== Further Reading ===== | ===== Further Reading ===== | ||