scopejob README

Microsoft employee tooling: This extension should be used only by Microsoft employees to run SCOPE scripts on cosmos virtual clusters directly from VSCode.

Features

Available commands:

1. ScopeJob: Install Cosmos Module (Administrator)
2. ScopeJob: Uninstall Cosmos Module
3. ScopeJob: Compile Scope Script
4. ScopeJob: Run Cosmos Job
5. ScopeJob: Get last submitted job for the user
6. ScopeJob: Get Cosmos Clusters
7. ScopeJob-Extra: Get list of Powershell Cosmos module commands
8. ScopeJob-Extra: Run cosmos Powershell command
9. ScopeJob: Encode Cosmos User
10. ScopeJob: Connect To AAD Account
11. ScopeJob: Install Cosmos SDK (Optional)
12. ScopeJob: Set Cosmos SDK Path (Optional)

After the Powershell modules and Cosmos SDK are installed using the commands above, you can press F1 and try to run the available commands under ScopeJob and ScopeJob-Extra. In case you are not automatically authenticated to Cosmos resources, you'll have to run the 'Connect to AAD Account' or 'Encode Cosmos User' command in a powershell window. To get a full set of commands in from the Cosmos Powershell Module, you can run the ScopeJob-Extra: Get list of Powershell Cosmos module commands.

If a scope script file is open, press right click and you can access the shortcuts for compiling and running the script.

Requirements

In order to utilize this extension and execute the commands successfully, you'll need to be a Microsoft employee who has access to at least one cosmos vc and resource access to the cosmos SDK.

For a fully functional extension, install both Powershell Cosmos Module and Cosmos SDK using the following commands:

1. ScopeJob: Install Cosmos Module (Administrator) - Used to run scope jobs
2. ScopeJob: Install Cosmos SDK (Optional) - Used to compile scope jobs and get job status

Known Issues

1. There are a lot of commands that are part of the Cosmos SDK and are not available in the extension, yet. The workaround is to run the ScopeJob-Extra: Get list of Powershell Cosmos module commands and run the module commands manually in the terminal. You can also run scope.exe -help to get a list of commands.

2. ScopeJob: Get last submitted job for the user command will not always refresh. As a workaround, close and re-run the command again.

Release Notes

This is the initial alpha release of the extension and the main purpose of this release is to test and gather feedback

0.0.2

This release contains the main commands available in Cosmos for compiling, running scripts and checking the job status. More commands will be implemented soon. Until then, you can use the installed SDK to manually run the commands in a terminal window.

0.0.3

Added capability to manually uninstall the Cosmos Powershell Module. The module is not yet automatically uninstalled when the extension is uninstalled so, it gives the option to remove the Cosmos module and SDK files if not intended to be used without the extension itself.

0.0.4

Added a command for encoding the user for cosmos access. This will ease the experience for the first time usage of the extension after install.

Enabled global parameter value persisting capability. The parameters will be auto-populated with the latest value used for that command. They will globally persist for the logged in user.

Added the cosmos SDK path to the user's 'PATH' variable to enable the run of scope.exe commands in the terminal. This will cover more scope/cosmos capabilities than this extension currently offers in alpha version.

The zip file used to install Cosmos SDK, is removed to clear disk space.

0.0.5

Added new changes due to the NTLM deprecation on Cosmos.

A new PowerShell module installation was introduced. The "Install Cosmos Module" will remove the previous Cosmos module and install Az.Cosmos and Az.Accounts modules to enable AAD authentication for getting access to cosmos resources.

Improved the job running experience by adding progress information and the ability of running multiple jobs in parallel without having to wait for the previous job to finalize.

Optionally, you could install the Scope SDK. The SDK is useful only for more advanced scenarios in which users would like to either use custom versions of the SDK or use the scope libraries on other application.

0.0.6

Fixes for commands that deal with paths and file names with spaces. Fixes for getting the list of jobs for the user.