{"id":15431,"date":"2018-07-19T06:00:40","date_gmt":"2018-07-19T13:00:40","guid":{"rendered":"https:\/\/www.sapien.com\/blog\/?p=15431"},"modified":"2018-07-31T10:30:13","modified_gmt":"2018-07-31T17:30:13","slug":"new-video-powershell-studio-working-with-azure-cmdlets-in-background-jobs","status":"publish","type":"post","link":"https:\/\/dev.sapien.com\/blog\/2018\/07\/19\/new-video-powershell-studio-working-with-azure-cmdlets-in-background-jobs\/","title":{"rendered":"New Video – PowerShell Studio: Working with Azure cmdlets in Background Jobs"},"content":{"rendered":"

Our latest video shows two different ways\u00a0to execute a console AzureRM script as a job using PowerShell Studio 2018.<\/p>\n

\"\"<\/a><\/p>\n

In this short video we demonstrate how to use the Azure cmdlet Stop-AzureRmVM<\/em> to stop an Azure VM by submitting the script code as a background job in two different ways:<\/p>\n

1. Create the scriptblock containing the Azure cmdlet to be submitted as a job using the Start-Job<\/em> cmdlet.
\n2. Create a more elaborate scriptblock containing the Azure cmdlet to be submitted as a job using the -AsJob<\/em> parameter.<\/p>\n

Both jobs can save the status and any output results from the Get-Job<\/em> and Receive-Job<\/em> cmdlets.<\/p>\n

What’s involved in this process:<\/p>\n

    \n
  1. Connect to Azure and execute the command.<\/li>\n
  2. Use the\u00a0Start-Job<\/em>\u00a0cmdlet to submit the scriptblock as a background job.<\/li>\n
  3. Use the\u00a0Do\/While<\/em> loop to display the job progress.<\/li>\n
  4. Use the Receive-Job<\/em> cmdlet to save the job results.<\/li>\n
  5. Use the Get-Job<\/em> cmdlet to display the saved job results at the end of the process.<\/li>\n<\/ol>\n

    We also show the use of adding an argument by passing a parameter to the scriptblock.<\/p>\n

    View the video here:\u00a0SAPIEN PowerShell Studio: Working with Azure Cmdlets In Background Jobs<\/a><\/p>\n

    Take Way<\/h3>\n

    This example provides a scripting framework that is not limited to Azure, and that can also easily be enhanced. It is better to use background jobs when working with Azure commands in a GUI application.<\/p>\n

    Most importantly, store the code in a scriptblock and submit the job using the\u00a0Start-Job<\/em> cmdlet. The Receive-Job<\/em> cmdlet will save information generated by the job, and the\u00a0Get-Job<\/em>\u00a0cmdlet will provide the status information of the background job\u2014so if the job doesn’t generate any output, then it will not save any data.<\/p>\n

    Sample Code<\/h3>\n

    Feel free to copy\/paste the code against your AzureRM VM’s.<\/p>\n

    Check the AzureRM VM Status:<\/h4>\n
    ## - Check for VM status:\r\nGet-AzureRmVM -ResourceGroupName 'GlobalAzureBootCampResources' -status `\r\n| Select-Object Name, PowerState;<\/pre>\n
    Run Stop-AzureRMVM without using the -AsJob parameter:<\/h4>\n
    #region RunStop-AzureRMVM_NoAsJobParam\r\n\r\n## 1 - Run Stop-AzureRMVM cmdlet without the -AsJob parameter:\r\n$JobName = \"StopVmScriptJob\";\r\n$JobScript = {\r\n\r\n## - Sign-On to Azure:\r\nImport-AzureRmContext -Path 'C:\\Temp\\WinPS_AsubRMprofile.json' | Out-Null;\r\n\r\n## - Run Azure cmdlet with AsJob parameter:\r\nStop-AzureRMVM -ResourceGroupName \"GlobalAzureBootCampResources\" `\r\n-Name 'Win2K16VM1' `\r\n-Force -Verbose;\r\n};\r\n\r\n## - Step that submit the scriptblock as a background job - ##\r\n$job = Start-Job -Name $Name -ScriptBlock $JobScript;\r\n\r\n## - Loop to check for The Stop-AzureRM cmdlet job completion:\r\n\"Processing Started - $($JobName) - $((Get-Date).ToString(\"MM\/dd\/yyyy-MM:hh:ss\"))\"\r\ndo {\r\nStart-Sleep -Seconds 10;\r\n\"Processing! - $($JobName) - $((Get-Date).ToString(\"MM\/dd\/yyyy-MM:hh:ss\"))\"\r\n}\r\nwhile ((Get-Job).State -ne 'Completed');\r\n\"Process Completed - $($JobName) - $((Get-Date).ToString(\"MM\/dd\/yyyy-MM:hh:ss\"))\"\r\n\r\n## - Saving Job results:\r\n$ReceiveJobStatus1 = Receive-Job -Job $job -Keep;\r\n$GetJobStatus1 = Get-Job;\r\n\r\n## - Displaying Job results:\r\n$ReceiveJobStatus1\r\n$GetJobStatus1 | Format-List;\r\n\r\n#endregion RunStop-AzureRMVM_NoAsJobParam<\/pre>\n
    Run Stop-AzureRMVM using the -AsJob parameter:<\/h4>\n
    #region RunStop-AzureRMVM_WithAsJobParam\r\n\r\n## 2 - Run Stop-AzureRMVM cmdlet with the -AsJob parameter:\r\n$JobName = \"StopVmCmdletAsJob\";\r\n$JobScript = {\r\nparam($Name)\r\n\r\n## - Sign-On to Azure:\r\nImport-AzureRmContext -Path 'C:\\Temp\\WinPS_AsubRMprofile.json' | Out-Null;\r\n$TaskName = \"StopVM1_$($Name)\";\r\n\r\n## - Run Azure cmdlet with AsJob parameter:\r\nStop-AzureRMVM -ResourceGroupName \"GlobalAzureBootCampResources\" `\r\n-Name $Name `\r\n-AsJob `\r\n-Force -Verbose;\r\n\r\n## - Inside Job Loop to check for the cmdlet job completion:\r\n\"`r`nProcess Started - $TaskName - $((Get-Date).ToString(\"MM\/dd\/yyyy-MM:hh:ss\"))\"\r\ndo {\r\nStart-Sleep -Seconds 10;\r\n\"Processing! $TaskName - $((Get-Date).ToString(\"MM\/dd\/yyyy-MM:hh:ss\"))\"\r\n}\r\nwhile ((Get-Job).State -ne 'Completed');\r\n\"Process Ended - $TaskName - $((Get-Date).ToString(\"MM\/dd\/yyyy-MM:hh:ss\"))\"\r\n\r\n\"`r`nGetting Job General Results:\"\r\n$AzGetJobStatus1 = Get-Job\r\n$AzGetJobStatus1 | Format-List\r\n\r\n\"Getting Receive Results:\"\r\n$AzureReceiveJobStatus2 = Receive-Job * -Keep;\r\n$AzureReceiveJobStatus2 | Format-List\r\n}\r\n\r\n## - Step that submit the scriptblock as a background job - ##\r\n$job = Start-Job -Name $Name -ScriptBlock $JobScript -ArgumentList 'Win2K16VM1';\r\n\r\n## - Loop to check for The Stop-AzureRM cmdlet job completion:\r\n\"`r`nBackground Process Started - $($JobName) - $((Get-Date).ToString(\"MM\/dd\/yyyy-MM:hh:ss\"))\"\r\ndo {\r\nStart-Sleep -Seconds 10;\r\n\"Processing Job - $($JobName) - $((Get-Date).ToString(\"MM\/dd\/yyyy-MM:hh:ss\"))\"\r\n}\r\nwhile ((Get-Job).State -ne 'Completed');\r\n\"Background Process Completed - $($JobName) - $((Get-Date).ToString(\"MM\/dd\/yyyy-MM:hh:ss\"))\"\r\n\r\n## - Saving Job results:\r\n$ReceiveJobStatus2 = Receive-Job -Job $job -Keep;\r\n$GetJobStatus2 = Get-Job\r\n\r\n## - Displaying Job results:\r\n$ReceiveJobStatus2\r\n$GetJobStatus2 | Format-List\r\n\r\n#endregion RunStop-AzureRMVM_WithAsJobParam<\/pre>\n
    Summary<\/h3>\n
    Create and test the script using the PowerShell Console before implementing in a GUI application such as PowerShell Studio. This sample script will require some minor changes as you build the GUI application.\u00a0 Refer to the related articles below for more details.<\/p>\n
    Related Articles<\/h3>\n