Merge pull request #8514 from maddieclayton/fixextensions

Add list capability for VMExtension

Author: Maddie Clayton

.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md renamed to .github/PULL_REQUEST_TEMPLATE.md

@@ -142,6 +142,13 @@ function Test-VirtualMachineExtension
         Assert-NotNull $ext.Statuses;
         Assert-NotNull $ext.SubStatuses;
 
+        $ext = Get-AzVMExtension -ResourceGroupName $rgname -VMName $vmname
+        Assert-True { $ext.Count -ge 1 }
+        Assert-Null $ext[0].Statuses
+
+        $ext = Get-AzVMExtension -ResourceGroupName $rgname -VMName $vmname -Status
+        Assert-NotNull $ext.Statuses
+
         # Remove Extension
         $ext | Remove-AzVMExtension -Force;
     }

src/Compute/Compute.Test/ScenarioTests/VirtualMachineExtensionTests.ps1

@@ -19,6 +19,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Update Get-AzVMExtension to list all installed extension if Name parameter is not provided
 * Add Tag and ResourceId parameters to Update-AzImage cmdlet
 * Get-AzVmssVM without instance ID and with InstanceView can list VMSS VMs with instance view.
 

src/Compute/Compute.Test/SessionRecords/Microsoft.Azure.Commands.Compute.Test.ScenarioTests.VirtualMachineExtensionTests/TestVirtualMachineExtension.json

@@ -29,6 +29,23 @@ public static AzureOperationResponse<VirtualMachineExtension> GetWithInstanceVie
             return result;
         }
 
+        public static AzureOperationResponse<VirtualMachineExtensionsListResult> ListWithInstanceView(this IVirtualMachineExtensionsOperations iVmExtensionOperations,
+           string rgName, string vmName)
+        {
+            string expand = "instanceView";
+            var result = iVmExtensionOperations.ListWithHttpMessagesAsync(rgName, vmName, expand).GetAwaiter().GetResult();
+
+            foreach (var vmExtension in result.Body.Value)
+            {
+                if (vmExtension.InstanceView == null)
+                {
+                    vmExtension.InstanceView = iVmExtensionOperations.GetWithInstanceView(rgName, vmName, vmExtension.Name).Body.InstanceView;
+                }
+            }
+
+            return result;
+        }
+
         public static AzureOperationResponse<VirtualMachine> GetWithInstanceView(this IVirtualMachinesOperations iVmExtensionOperations,
             string rgName, string vmName)
         {

src/Compute/Compute/ChangeLog.md

@@ -16,6 +16,7 @@
 using Microsoft.Azure.Commands.Compute.Models;
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
 using System.Management.Automation;
+using System.Linq;
 
 namespace Microsoft.Azure.Commands.Compute
 {
@@ -44,7 +45,7 @@ public class GetAzureVMExtensionCommand : VirtualMachineExtensionBaseCmdlet
 
         [Alias("ExtensionName")]
         [Parameter(
-            Mandatory = true,
+            Mandatory = false,
             Position = 2,
             ValueFromPipelineByPropertyName = true,
             HelpMessage = "The extension name.")]
@@ -65,16 +66,32 @@ public override void ExecuteCmdlet()
 
             ExecuteClientAction(() =>
             {
-                if (Status.IsPresent)
+                if (!string.IsNullOrEmpty(Name))
                 {
-                    var result = this.VirtualMachineExtensionClient.GetWithInstanceView(this.ResourceGroupName, this.VMName, this.Name);
-                    WriteObject(result.ToPSVirtualMachineExtension(this.ResourceGroupName, this.VMName));
+                    if (Status.IsPresent)
+                    {
+                        var result = this.VirtualMachineExtensionClient.GetWithInstanceView(this.ResourceGroupName, this.VMName, this.Name);
+                        WriteObject(result.ToPSVirtualMachineExtension(this.ResourceGroupName, this.VMName));
+                    }
+                    else
+                    {
+                        var result = this.VirtualMachineExtensionClient.GetWithHttpMessagesAsync(this.ResourceGroupName,
+                            this.VMName, this.Name).GetAwaiter().GetResult();
+                        WriteObject(result.ToPSVirtualMachineExtension(this.ResourceGroupName, this.VMName));
+                    }
                 }
                 else
                 {
-                    var result = this.VirtualMachineExtensionClient.GetWithHttpMessagesAsync(this.ResourceGroupName,
-                        this.VMName, this.Name).GetAwaiter().GetResult();
-                    WriteObject(result.ToPSVirtualMachineExtension(this.ResourceGroupName, this.VMName));
+                    if (Status.IsPresent)
+                    {
+                        var result = this.VirtualMachineExtensionClient.ListWithInstanceView(this.ResourceGroupName, this.VMName).Body.Value;
+                        WriteObject(result.ToList().Select(t => t.ToPSVirtualMachineExtension(this.ResourceGroupName, this.VMName)), true);
+                    }
+                    else
+                    {
+                        var result = this.VirtualMachineExtensionClient.ListWithHttpMessagesAsync(this.ResourceGroupName, this.VMName).GetAwaiter().GetResult().Body.Value;
+                        WriteObject(result.ToList().Select(t => t.ToPSVirtualMachineExtension(this.ResourceGroupName, this.VMName)), true);
+                    }
                 }
             });
         }

src/Compute/Compute/Common/ComputeClientInstancViewMethod.cs

@@ -1,4 +1,4 @@
----
+---
 external help file: Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml
 Module Name: Az.Compute
 ms.assetid: 842652D4-0F1C-4D0D-AB55-0D43D3C5D82A
@@ -14,7 +14,7 @@ Gets properties of Virtual Machine Extensions installed on a virtual machine.
 ## SYNTAX
 
 ```
-Get-AzVMExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [-Status]
+Get-AzVMExtension [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>] [-Status]
  [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
 ```
 
@@ -28,17 +28,78 @@ To get only the instance view of an extension, specify the Status parameter.
 ### Example 1: Get properties of an extension
 ```
 PS C:\> Get-AzVMExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine22" -Name "CustomScriptExtension"
+
+ResourceGroupName       : ResourceGroup11
+VMName                  : VirtualMachine22
+Name                    : CustomScriptExtension
+Location                : eastus
+Etag                    : null
+Publisher               : Microsoft.Azure.Extensions
+ExtensionType           : CustomScript
+TypeHandlerVersion      : 2.0
+Id                      : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup11
+                          /providers/Microsoft.Compute/virtualMachines/VirtualMachine22/extensions/CustomScriptExtension
+PublicSettings          : {}
+ProtectedSettings       :
+ProvisioningState       : Succeeded
+Statuses                :
+SubStatuses             :
+AutoUpgradeMinorVersion : True
+ForceUpdateTag          :
 ```
 
 This command gets properties for the extension named CustomScriptExtension on the virtual machine named VirtualMachine22 in the resource group ResourceGroup11.
 
 ### Example 2: Get instance view of an extension
 ```
 PS C:\> Get-AzVMExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine22" -Name "CustomScriptExtension" -Status
+
+ResourceGroupName       : ResourceGroup11
+VMName                  : VirtualMachine22
+Name                    : CustomScriptExtension
+Location                : eastus
+Etag                    : null
+Publisher               : Microsoft.Azure.Extensions
+ExtensionType           : CustomScript
+TypeHandlerVersion      : 2.0
+Id                      : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup11
+                          /providers/Microsoft.Compute/virtualMachines/VirtualMachine22/extensions/CustomScriptExtension
+PublicSettings          : {}
+ProtectedSettings       :
+ProvisioningState       : Succeeded
+Statuses                : {Microsoft.Azure.Management.Compute.Models.InstanceViewStatus}
+SubStatuses             :
+AutoUpgradeMinorVersion : True
+ForceUpdateTag          :
 ```
 
 This command gets the instance view for the extension named CustomScriptExtension on the virtual machine named VirtualMachine22 in the resource group ResourceGroup11.
 
+### Example 3: Get all extensions installed on a VM
+```
+PS C:\> Get-AzVMExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine22"
+
+ResourceGroupName       : ResourceGroup11
+VMName                  : VirtualMachine22
+Name                    : CustomScriptExtension
+Location                : eastus
+Etag                    : null
+Publisher               : Microsoft.Azure.Extensions
+ExtensionType           : CustomScript
+TypeHandlerVersion      : 2.0
+Id                      : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup11
+                          /providers/Microsoft.Compute/virtualMachines/VirtualMachine22/extensions/CustomScriptExtension
+PublicSettings          : {}
+ProtectedSettings       :
+ProvisioningState       : Succeeded
+Statuses                :
+SubStatuses             :
+AutoUpgradeMinorVersion : True
+ForceUpdateTag          :
+```
+
+This command gets the list of extensions installed on the virtual machine named VirtualMachine22 in the resource group ResourceGroup11.
+
 ## PARAMETERS
 
 ### -DefaultProfile
@@ -65,7 +126,7 @@ Type: System.String
 Parameter Sets: (All)
 Aliases: ExtensionName
 
-Required: True
+Required: False
 Position: 2
 Default value: None
 Accept pipeline input: True (ByPropertyName)

src/Compute/Compute/Extension/GetAzureVMExtensionCommand.cs

@@ -1130,6 +1130,10 @@
       "file": "src\\Compute\\Compute.Test\\SessionRecords\\Microsoft.Azure.Commands.Compute.Test.ScenarioTests.AEMExtensionTests\\TestAEMExtensionAdvancedLinuxMD_ESeries.json",
       "_justification": "Mocked test resource. The resources are being deleted after the test run in Record mode."
     },
+    {
+      "file": "src\\Compute\\Compute.Test\\SessionRecords\\Microsoft.Azure.Commands.Compute.Test.ScenarioTests.VirtualMachineExtensionTests\\TestVirtualMachineExtension.json",
+      "_justification": "Mocked test resource. The resources are being deleted after the test run in Record mode."
+    },
     {
       "file": "\\src\\Resources\\Resources.Test\\ScenarioTests\\certificate.pfx",
       "_justification": "Legitimate test certificate."
@@ -1138,17 +1142,17 @@
       "file": "\\src\\DataMigration\\DataMigration.Test\\SessionRecords\\Microsoft.Azure.Commands.ScenarioTest.DmsTest.ServiceTests\\TestConnectToTargetSqlDbMiSync.json",
       "_justification": "Legitimate session record, Key will be revoked after test"
     },
-	  {
+    {
       "file": "\\src\\DataMigration\\DataMigration.Test\\SessionRecords\\Microsoft.Azure.Commands.ScenarioTest.DmsTest.ServiceTests\\TestMigrateSqlSqlDbMiSync.json",
       "_justification": "Legitimate session record, Key will be revoked after test"
     },
-	  {
+    {
       "file": "\\src\\DataMigration\\DataMigration.Test\\SessionRecords\\Microsoft.Azure.Commands.ScenarioTest.DmsTest.ServiceTests\\TestValidateMigrationInputSqlSqlDbMiSync.json",
       "_justification": "Legitimate session record, Key will be revoked after test"
     },
-	  {
+    {
       "file": "\\src\\DataMigration\\DataMigration.Test\\SessionRecords\\Microsoft.Azure.Commands.ScenarioTest.DmsTest.ServiceTests\\TestMigrateSqlSqlDbMiSync.json",
       "_justification": "Legitimate session record, Key will be revoked after test"
     }
   ]
-}
+}