Now I’m going to take it a little further with the help of PowerShell Studio’s ready-to-use templates.<\/p>\n
Using “Grid Job” Template<\/h3>\n
I am going to use the GUI Form “Grid Job<\/strong>” template (File\u00a0> New\u00a0> New\u00a0 Form\u00a0> Forms > Grid Job).<\/p>\n This is a PowerShell Studio single form file which includes some of SAPIEN’s Helper Functions\u00a0 to assist with your GUI application development.<\/p>\n Below is a list of the Helper Functions available when using the “Grid Job<\/strong>” template:<\/p>\n In this article I will cover the JobTracker\u00a0Add-JobTracker<\/strong>\u00a0helper function and the DataGridView ConvertTo-DataTable<\/strong> and Update-DataGridView<\/strong> helper functions.<\/p>\n First I will change the Button control text property from “Query<\/em>” to “StartJob<\/em>“. Then I will add a Label control and change the label text property to “Time:<\/em>“. Finally, I will save the file as “JobTracker_AzureRM_Sample.psf<\/em>“.<\/p>\n Before I start to implement my code, let’s take a look at the main function used for background job processing: Add-JobTracker<\/strong>.<\/p>\n The following parameters can be used:<\/p>\n The JobTracker functions can be found in a custom Control Set labeled “Button – Start Job<\/em>” which is part of the “Grid Job<\/strong>” template.<\/p>\n The JobTracker helper functions are highlighted below:<\/p>\n The\u00a0“Grid Job<\/strong>” template also has a DataGridView component, with helper functions that convert and display the receive-job result in a simple format.<\/p>\n Here’s where I can use the following helper functions:<\/p>\n ConvertTo-DataTable<\/strong> – This function converts the result object into a data table object. Array objects created in PowerShell can be displayed in a DataGridView component. The benefit of using a DataTable is that it allows you to use sorting. This can be accomplished with the following two lines of code:<\/p>\n Note that “$datagridviewResults<\/em>” is the name on the DataGridView component in the form:<\/p>\n The DataGridView helper functions are highlighted below:<\/p>\n I also made the following additional changes:<\/p>\n In the $formMain_Load<\/em>\u00a0form event, I added a global variable for the job name: $global:JobName<\/em>. For now, this is a hard-coded constant string.<\/p>\n In the $buttonStartJob_Click<\/em>\u00a0button event, I added the Timer code which updates the label “Timer:<\/em>” text property with the recurring execution time.<\/p>\n In the Add-JobTracker<\/strong>\u00a0function I added the “-ArgumentList<\/em>” parameter to pass the hard-coded system name value. In the “-JobScript” parameter, values can be passed through the Param($Argument1).<\/p>\n Note that you can rename this variable to suit your needs\u2014with a descriptive name that describes the purpose of the argument.<\/p>\n Remember, any hard-coded variable is a prospect for automation. It is up to the developer to improve the application.<\/p>\n Next I start adding the code in the Add-JobTracker<\/strong> function. All of this is happening in the $buttonStartJob_Click<\/em> button event.<\/p>\n The following image shows the areas where the code can be added and follows the process after the ScriptBlock has been submitted to the background for processing:<\/p>\n In this Azure GUI form sample I am using the following Add-JobTracker<\/strong> function parameters in the $buttonStartJob_Click<\/em>\u00a0button event:<\/p>\n 1. ‘-Name<\/em>‘ and the ‘-ArgumentList<\/em>‘:<\/p>\n 2. ‘-JobScript<\/em>‘:<\/p>\n 3. ‘-CompletedScript<\/em>‘:<\/p>\n 4. ‘-UpdateScript<\/em>‘ – There are two added code blocks: “UpdateJobResults<\/em>” and the “TimerUpdateCode<\/em>“.<\/p>\n You can use both the ‘-UpdateScript<\/em>‘ and ‘-CompletedScript<\/em>‘ parameter section to update the information on the DataGridView component.<\/p>\n In this Azure GUI form application I am using the Get-Job<\/strong> cmdlet results to display the progress of the background job in the DataGridView component during the “-UpdateScript<\/em>” process. When the job completes, the “-CompletedScript<\/em>” section gets the result from the Receive-Job<\/strong> cmdlet that is sent to the DataGridView component.<\/p>\n This “Grid job<\/strong>” sample shows how to integrate Azure scripts into a GUI application to take advantage of background processing.<\/p>\n Remember to submit Azure scripts as background jobs to prevent the GUI form from freezing.<\/p>\n This article covered two main topics: I also covered the parameters used in the Add-JobTracker<\/strong> function which is enough to get you started.<\/p>\n PowerShell Studio template can cut down time in development. Specially when taking time to understand these helper functions.<\/p>\n You can download the updated sample Windows GUI here:\u00a0JobTracker_AzureRM_Sample.zip<\/a> As always, if you have any ideas, comments, or feedback, please\u00a0visit our feedback forum<\/a>\u00a0and reference this post.<\/p>\n <\/p>\n![\"\"](\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2018\/08\/AzureBJ_01_2018-07-31_9-26-39-300x175.jpg\")
<\/a><\/p>\n\n
![\"\"](\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2018\/08\/AzureBJ_02_2018-07-31_9-26-39-300x201.jpg\")
<\/a><\/p>\nUnderstanding JobTracker Function<\/h3>\n
Basic usage syntax:\r\nAdd-JobTracker [-Name] <String> [-JobScript] <ScriptBlock> [[-ArgumentList] <Object>] [[-CompletedScript] <ScriptBlock>] [[-UpdateScript] <ScriptBlock>] [<CommonParameters>]<\/pre>\n
\n
![\"\"](\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2018\/08\/AzureBJ_03_2018-07-31_9-26-39-300x183.jpg\")
<\/a><\/p>\n![\"\"](\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2018\/08\/AzureBJ_10_2018-07-31_9-26-39-231x300.jpg\")
<\/a><\/p>\nUnderstanding DataGridView Functions<\/h3>\n
\nUpdate-DataGridView<\/strong> – This function reads the data type object to be displayed in the DataGridView component.<\/p>\nBasic usage syntax:\r\nConvertTo-DataTable [[-InputObject] <Object>] [[-Table] <DataTable>] [-RetainColumns] [-FilterWMIProperties] [<CommonParameters>]\r\n\r\nUpdate-DataGridView [-DataGridView] <DataGridView> [-Item] <Object> [[-DataMember] <String>] `\r\n[[-AutoSizeColumns] {None | ColumnHeader | AllCellsExceptHeader | AllCells | DisplayedCellsExceptHeader | DisplayedCells | Fill} ] [<CommonParameters>]<\/pre>\n## - Sample Code to display converted data table object results into a Databgridview component:\r\n$dgvResults = ConvertTo-DataTable -InputObject $results -FilterWMIProperties;\r\nUpdate-DataGridView -DataGridView $datagridviewResults -Item $dgvResults -AutoSizeColumns DisplayedCells;<\/pre>\n
![\"\"](\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2018\/08\/AzureBJ_05_2018-07-31_9-26-39-300x144.jpg\")
<\/a><\/p>\n![\"\"](\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2018\/08\/AzureBJ_11_2018-07-31_9-26-39-231x300.jpg\")
<\/a><\/p>\nSome Additional Changes<\/h3>\n
![\"\"](\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2018\/08\/AzureBJ_06_2018-07-31_9-26-39-300x160.jpg\")
<\/a><\/p>\n![\"\"](\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2018\/08\/AzureBJ_07_2018-07-31_9-26-39-300x133.jpg\")
<\/a><\/p>\n![\"\"](\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2018\/08\/AzureBJ_08_2018-07-31_9-26-39-300x205.jpg\")
<\/a><\/p>\n![\"\"](\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2018\/08\/AzureBJ_09_2018-07-31_9-26-39-300x126.jpg\")
<\/a><\/p>\nWorking with Add-JobTracker function<\/h3>\n
![\"\"](\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2018\/08\/AzureBJ_04_2018-07-31_9-26-39-300x264.jpg\")
<\/a><\/p>\n Add-JobTracker -Name $global:JobName -ArgumentList 'Win2K16VM1' `...<\/pre>\n
#region AddScriptBlockJob\r\n\r\n#--------------------------------------------------\r\n# Add Script Code below\r\n# -------------------------------------------------\r\n\r\n## - Automatic Sign-On to Azure:\r\nImport-AzureRmContext -Path 'c:\\Temp\\WinPS_AsubRMprofile.json' | Out-Null;\r\n\r\nWrite-Host \"Stopping Azure VM - $Argument1\";\r\n\r\n## - Run Azure cmdlet with AsJob parameter:\r\nStop-AzureRMVM -ResourceGroupName \"GlobalAzureBootCampResources\" `\r\n-Name $Argument1 `\r\n-Force;\r\n\r\n#--------------------------------------------------\r\n# End of Script Code\r\n# -------------------------------------------------\r\n\r\n#endregion AddScriptBlockJob<\/pre>\n
![\"\"](\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2018\/08\/AzureBJ_12_2018-07-31_9-26-39-300x141.jpg\")
<\/a><\/p>\n#region EndOfJopScript\r\n\r\n#--------------------------------------------------\r\n# Add Script Code below\r\n# -------------------------------------------------\r\n \r\n## - Popup messagebox:\r\n[System.Windows.Forms.MessageBox]::Show('Background Task Completed!','CompletedScript Event Message')\r\n## - CompletedScript will only show data if there are any:\r\n$results = Receive-Job -Job $Job -Keep;\r\n\r\n## - Add code display Receive-Job results in the Databgridview:\r\n$dgvResults = ConvertTo-DataTable -InputObject $results -FilterWMIProperties;\r\nUpdate-DataGridView -DataGridView $datagridviewResults -Item $dgvResults -AutoSizeColumns DisplayedCells;\r\n\r\n#--------------------------------------------------\r\n# End of Script Code\r\n# -------------------------------------------------\r\n\r\n#endregion EndOfJopScript<\/pre>\n![\"\"](\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2018\/08\/AzureBJ_13_2018-07-31_9-26-39-300x157.jpg\")
<\/a><\/p>\n#region UpdateJobResults\r\n\r\n#--------------------------------------------------\r\n# Add Script Code below\r\n# -------------------------------------------------\r\n\r\n## - Commented out line below, enabled if needed:\r\n$results = Get-Job -Name $global:JobName `\r\n| Select-Object -property State, Name, PSBeginTime, PSEndTime, PSJobTypeName, Command, location;\r\n\r\n$dgvResults = ConvertTo-DataTable -InputObject $results -FilterWMIProperties;\r\nUpdate-DataGridView -DataGridView $datagridviewResults -Item $dgvResults -AutoSizeColumns DisplayedCells\r\n\r\n#--------------------------------------------------\r\n# End of Script Code\r\n# -------------------------------------------------\r\n\r\n#endregion UpdateJobResults<\/pre>\n
#region TimerUpdateCode\r\n\r\n#--------------------------------------------------\r\n#\t\t\tScript Code Added for timer\r\n# -------------------------------------------------\r\n\r\n## - To Display Time Elapsed and update datagridviewGetJob:\r\n$CurrentTime = $global:Time.Elapsed;\r\n$DisplayTime = $([string]::Format(\"Time: {0:d2}:{1:d2}:{2:d2}\",\r\n\t $CurrentTime.hours,\r\n\t $CurrentTime.minutes,\r\n\t $CurrentTime.seconds))\r\n$labelTime.Text = $DisplayTime;\r\n\r\n#--------------------------------------------------\r\n#\t\t\tEnd of Script Code\r\n# -------------------------------------------------\r\n\r\n#endregion TimerUpdateCode<\/pre>\n![\"\"](\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2018\/08\/AzureBJ_14a_2018-07-31_9-26-39-300x208.jpg\")
<\/a><\/p>\n![\"\"](\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2018\/08\/AzureBJ_15_2018-07-31_9-26-39-300x147.jpg\")
<\/a><\/p>\nSummary<\/h3>\n
\n1. Use the JobTracker Add-JobTracker<\/strong> helper function to submit the Azure code as a background job.
\n2. Use the DataGridView helper functions (ConvertTo-DataTable<\/strong>\u00a0and\u00a0Update-DataGridView<\/strong>) to display the results during and after the background process.<\/p>\n
\nCheckout this short two minute video showing the GUI form in action: Sample_AzureGUI_HelperFunctions<\/a><\/p>\nRelated Articles<\/h3>\n
\n
Feedback<\/h3>\n