Merge pull request #216491 from ericd-mst-github/erd-run-command-windows

Erd run command windows

Author: v-dirichards

articles/virtual-machines/TOC.yml

@@ -880,9 +880,9 @@
       href: ./linux/run-command.md
     - name: Action Run Commands for Windows
       href: ./windows/run-command.md
-    - name: Managed Run Commands for Linux (preview)
+    - name: Managed Run Commands for Linux
       href: ./linux/run-command-managed.md
-    - name: Managed Run Commands for Windows (preview)
+    - name: Managed Run Commands for Windows
       href: ./windows/run-command-managed.md
   - name: Extensions
     items:

articles/virtual-machines/linux/run-command-managed.md

@@ -1,41 +1,32 @@
 ---
-title: Run scripts in a Linux VM in Azure using managed Run Commands (preview)
+title: Run scripts in a Linux VM in Azure using managed Run Commands
 description: This topic describes how to run scripts within an Azure Linux virtual machine by using the updated managed Run Command feature.
 services: automation
 ms.service: virtual-machines
 ms.collection: linux
 author: nikhilpatel909
 ms.author: erd
-ms.date: 09/08/2022
+ms.date: 10/31/2022
 ms.topic: how-to  
 ms.reviewer: erd
 ms.custom: devx-track-azurepowershell, devx-track-azurecli
 ---
-# Preview: Run scripts in your Linux VM by using managed Run Commands
+# Run scripts in your Linux VM by using managed Run Commands
 
 **Applies to:** :heavy_check_mark: Linux VMs :heavy_check_mark: Flexible scale sets 
 
-> [!IMPORTANT]
-> **Managed Run Command** is currently in public preview.
-> This preview version is provided without a service-level agreement, and we don't recommend it for production workloads. Certain features might not be supported or might have constrained capabilities. 
-> For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
 
 The Run Command feature uses the virtual machine (VM) agent to run scripts within an Azure Linux VM. You can use these scripts for general machine or application management. They can help you quickly diagnose and remediate VM access and network issues and get the VM back to a good state.
 
 The *updated* managed Run Command uses the same VM agent channel to execute scripts and provides the following enhancements over the [original action oriented Run Command](run-command.md): 
 - Support for updated Run Command through ARM deployment template 
 - Parallel execution of multiple scripts 
-- Sequential execution of scripts 
-- RunCommand script can be canceled  
+- Sequential execution of scripts   
 - User specified script timeout 
 - Support for long running (hours/days) scripts 
 - Passing secrets (parameters, passwords) in a secure manner
 
 
-## Register for preview
-
-You must register your subscription in order to use managed Run Command during public preview. Go to [set up preview features in Azure subscription](../../azure-resource-manager/management/preview-features.md) for registration instructions and use the feature name `RunCommandPreview`.
-
 ## Azure CLI 
 
 The following examples use [az vm run-command](/cli/azure/vm/run-command) to run shell script on an Azure Linux VM.
@@ -61,6 +52,10 @@ This command will retrieve current execution progress, including latest output,
 az vm run-command show --name "myRunCommand" --vm-name "myVM" --resource-group "myRG" --expand instanceView
 ```
 
+> [!Note]
+> Output and error fields in `instanceView` is limited to last 4KB.
+> If you'd like to access the full output and error, you have the option of forwarding the output and error data to storage append blobs using `-outputBlobUri` and `-errorBlobUri` parameters while executing Run Command using `Set-AzVMRunCommand` or `Set-AzVMssRunCommand`.
+
 ### Delete RunCommand resource from the VM
 Remove the RunCommand resource previously deployed on the VM. If the script execution is still in progress, execution will be terminated. 
 
@@ -101,6 +96,101 @@ This command will retrieve current execution progress, including latest output,
 Get-AzVMRunCommand -ResourceGroupName "myRG" -VMName "myVM" -RunCommandName "RunCommandName" -Expand instanceView
 ```
 
+### Create or update Run Command on a VM using SourceScriptURI (storage blob SAS URL)
+Create or update Run Command on a Windows VM using a SAS URL of a storage blob that contains a PowerShell script. `SourceScriptUri` can be a storage blob’s full SAS URL or public URL. 
+
+> [!NOTE]
+> The SAS URL must provide read access to the blob. An expiration time of 24 hours is suggested for the SAS URL. SAS URLs can be generated on Azure portal using blob's options, or SAS token using `New-AzStorageBlobSASToken`. If generating SAS token using `New-AzStorageBlobSASToken`, your SAS URL = "base blob URL" + "?" + "SAS token from New-AzStorageBlobSASToken"
+
+```azurepowershell-interactive
+Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceScriptUri <SourceScriptURI>
+```
+
+### Get a Run Command Instance View for a VM after Creating or Updating Run Command
+
+Get a Run Command for VM with Instance View. Instance View contains the execution state of Run Command (Succeeded, Failed, etc.), exit code, standard output and standard error generated by executing the script using Run Command. A non-zero ExitCode indicates an unsuccessful execution.
+
+```azurepowershell-interactive
+$x = Get-AzVMRunCommand -ResourceGroupName MyRG -VMName MyVM -RunCommandName MyRunCommand -Expand InstanceView
+$x.InstanceView
+```
+
+Expected output:
+```azurepowershell-interactive
+ExecutionState   : Succeeded
+ExecutionMessage :
+ExitCode         : 0
+Output           :   
+output       : uid=0(root) gid=0(root) groups=0(root)
+                   HelloWorld
+
+Error            :
+StartTime        : 10/27/2022 9:10:52 PM
+EndTime          : 10/27/2022 9:10:55 PM
+Statuses         :
+```
+`InstanceView.ExecutionState` -Status of user's Run Command script. Refer this state to know whether your script was successful or not.
+
+`ProvisioningState` - Status of general extension provisioning end to end ( whether extension platform was able to trigger Run Command script or not). 
+
+### Create or update Run Command on a VM using SourceScript (script text)
+Create or update Run Command on a VM passing the script content directly to -SourceScript parameter. Use `;` to separate multiple commands.
+
+```azurepowershell-interactive
+Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVML -RunCommandName MyRunCommand2 -Location EastUS2EUAP -SourceScript "id; echo HelloWorld"
+```
+### Create or update Run Command on a VM using SourceCommandId
+Create or update Run Command on a VM using pre-existing `commandId`. Available commandIds can be retrieved using [Get-AzVMRunCommandDocument](/powershell/module/az.compute/get-azvmruncommanddocument).
+
+```azurepowershell-interactive
+Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceCommandId ipconfig
+```
+
+### Create or update Run Command on a VM using OutputBlobUri, ErrorBlobUri to stream standard output and standard error messages to output and error Append blobs
+
+Create or update Run Command on a VM and stream standard output and standard error messages to output and error Append blobs.
+
+```azurepowershell-interactive
+Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVML -RunCommandName MyRunCommand3 -Location EastUS2EUAP EastUS2EUAP -SourceScriptUri <SourceScriptUri> -OutputBlobUri <OutputBlobUri> -ErrorBlobUri <errorbloburi>
+```
+
+> [!NOTE]
+>  Output and error blobs must be of type `AppendBlob` and their SAS URLs must provide read, append, create, write access to the blob. An expiration time of 24 hours is suggested for the SAS URL. If output or error blob does not exist, a blob of type AppendBlob will be created. SAS URLs can be generated on Azure portal using blob's options, or SAS token using New-AzStorageBlobSASToken. If generating SAS token using `New-AzStorageBlobSASToken`, SAS URL = base blob URL + "?" + SAS token from `New-AzStorageBlobSASToken`.
+
+### Create or update Run Command on a VM, run the Run Command as a different user using RunAsUser and RunAsPassword parameters
+Create or update Run Command on a VM, run the Run Command as a different user using `RunAsUser` and `RunAsPassword` parameters. For RunAs to work properly, contact admin of VM and make sure user is added on the VM, user has access to resources accessed by the Run Command (Directories, Files, Network etc.), and in case of Windows VM, 'Secondary Logon' service is running on the VM.
+
+```azurepowershell-interactive
+Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP EastUS2EUAP -SourceScriptUri <SourceScriptUri> -RunAsUser myusername -RunAsPassword mypassword
+```
+### Create or update Run Command on a Virtual Machine Scale Sets resource using SourceScriptUri (storage blob SAS URL).
+Create or update Run Command on a Virtual Machine Scale Sets resource using a SAS URL of a storage blob that contains a bash script.
+
+```azurepowershell-interactive
+Set-AzVmssVMRunCommand -ResourceGroupName MyRG0 -VMScaleSetName MyVMSS -InstanceId 0 -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceScriptUri <SourceScriptUri>
+```
+
+> [!Note] 
+> Note SAS URL must provide read access to the blob. An expiration time of 24 hours is suggested for SAS URL. SAS URLs can be generated on Azure portal using blob's options, or SAS token using New-AzStorageBlobSASToken. If generating SAS token using New-AzStorageBlobSASToken, SAS URL = base blob URL + "?" + SAS token from `New-AzStorageBlobSASToken`.
+
+### Create or update Run Command on a VM instance using Parameter and ProtectedParameter parameters (Public and Protected Parameters to script)
+
+```azurepowershell-interactive
+$PublicParametersArray = @([Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IRunCommandInputParameter]@{name='publicParam1';value='publicParam1value'},
+>> [Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IRunCommandInputParameter]@{name='publicParam2';value='publicParam2value'})
+
+$ProtectedParametersArray = @([Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IRunCommandInputParameter]@{name='secret1';value='secret1value'},
+>> [Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IRunCommandInputParameter]@{name='secret2';value='secret2value'})
+
+Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceScriptUri <SourceScriptUri> -Parameter $PublicParametersArray -ProtectedParameter $ProtectedParametersArray
+```
+Use `ProtectedParameter` to pass any sensitive inputs to script such as passwords, keys etc.
+
+- Windows: Parameters and ProtectedParameters are passed to script as arguments are passed to script and run like this `myscript.ps1 -publicParam1 publicParam1value -publicParam2 publicParam2value -secret1 secret1value -secret2 secret2value`
+- Linux: Named Parameters and its values are set to environment config, which should be accessible within the `.sh` script. For Nameless arguments, pass an empty string to name input. Nameless arguments are passed to script and run like this - `myscript.sh publicParam1value publicParam2value secret1value secret2value`
+
+
+
 ### Delete RunCommand resource from the VM
 Remove the RunCommand resource previously deployed on the VM. If the script execution is still in progress, execution will be terminated. 
 
@@ -175,11 +265,10 @@ GET /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers
 GET /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.Compute/virtualMachines/<vmName>/runcommands/<runCommandName>?$expand=instanceView&api-version=2019-12-01 
 ```
 
-### Cancel a specific Run Command deployment 
-
-To cancel a running deployment, you can PUT or PATCH on the running instance of Run Command and specify a blank script in the request body. This will cancel the ongoing execution. 
+### Delete a specific Run Command deployment 
+ 
 
-You can also delete the instance of Run Command.  
+Delete the instance of Run Command  
 
 ```rest
 DELETE /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.Compute/virtualMachines/<vmName>/runcommands/<runCommandName>?api-version=2019-12-01 

articles/virtual-machines/run-command-overview.md

@@ -2,11 +2,11 @@
 title: Run scripts in a Windows or Linux VM in Azure with Run Command
 description: This topic provides an overview of running scripts within an Azure virtual machine by using the Run Command feature
 ms.service: virtual-machines
-author: cynthn
-ms.author: cynthn
-ms.date: 10/27/2021
+author: nikhilpatel909
+ms.author: erd
+ms.date: 11/03/2022
 ms.topic: how-to  
-ms.reviewer: jushiman
+ms.reviewer: erd
 ms.custom: devx-track-azurepowershell
 
 ---
@@ -19,9 +19,8 @@ Run Command uses the virtual machine (VM) agent to run scripts within an Azure W
 The original set of commands are action orientated. The updated set of commands, currently in Public Preview, are management orientated and enable you to run multiple scripts and has less restrictions. This article will explain the difference between the two sets of run commands and help you decide which set is the right one to use in your scenario.  
 
 > [!IMPORTANT]
-> **Managed Run Command** is currently in public preview.
-> This preview version is provided without a service-level agreement, and we don't recommend it for production workloads. Certain features might not be supported or might have constrained capabilities. 
-> For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
+> **Managed Run Command**  is currently available in Azure CLI, PowerShell, and API at this time.
+
 
 
 ## When to use action or managed commands