Get-AzVMBootDiagnostics api change to use RetrieveBootDiagnosticsData() (#13233)

* initial dev

* intermediate work

* get-azvmbootdiagnosticsdata dev, testing (maybe) , and changelog. No help doc update needed.

* test if removing file path and cmd in test removes CI failures

* updating to 12.7.0

updating Azure.Storage.Blobs to 12.7.0 from 12.6.0 to address CI failure.

* adding test with local file path back in

* remove get cmd from test

* back to 12.6.0

* 12.7.0-preview.1

* Update Compute.csproj

* attempt 12.5.0

* 12.7.0-preview

* 12.7.0-preview.1

* added back in local file path test

to see if any effect on the CI checks.

* commented out boot

commented out the cmd utilizing the local file path to my personal computer. Seems to be causing a test error in Test windows > Test. Removing to test it.

* to parity

* adding required assemblies

* removed last test cmd recorded

* Update Az.Compute.psd1

* try 12.6.0 with required assemblies.

* 12.7.0-preview.1

* simplified to CloudBlob

* removed unnecessary assmblies

* test updates, LivOnly.

* fix linux

* windows serial log

Author: Sandido

src/Compute/Compute.Test/ScenarioTests/VirtualMachineTests.cs

@@ -346,5 +346,12 @@ public void TestVirtualMachineImageListTopOrderExpand()
         {
             TestRunner.RunTestScript("Test-VirtualMachineImageListTopOrderExpand");
         }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.LiveOnly)]
+        public void TestVirtualMachineBootDiagnostics()
+        {
+            TestRunner.RunTestScript("Test-VirtualMachineBootDiagnostics");
+        }
     }
 }

src/Compute/Compute.Test/ScenarioTests/VirtualMachineTests.ps1

@@ -4412,3 +4412,69 @@ function Test-VirtualMachineImageListTopOrderExpand
 
 }
 
+<#
+.SYNOPSIS
+This test can only run in Record mode. SEveral lines need to be uncommented for it to test the cmdlet. 
+Downloads the managed boot diagnostics of a Windows machine to a local file path. 
+#>
+function Test-VirtualMachineBootDiagnostics
+{
+    # Setup
+    $rgname = Get-ComputeTestResourceName;
+    $loc = Get-ComputeVMLocation;
+
+    try
+    {
+        New-AzResourceGroup -Name $rgname -Location $loc -Force;
+
+        # VM Profile & Hardware
+        $vmsize = 'Standard_DS1_v2';
+        $vmname = 'vm' + $rgname;
+        # Create the file path on your machine, then set this variable to it. 
+        # $localPath = "C:\Users\adsandor\Documents\bootDiags"
+        
+        $p = New-AzVMConfig -VMName $vmname -VMSize $vmsize;
+        
+        # NRP
+        $subnet = New-AzVirtualNetworkSubnetConfig -Name ('subnet' + $rgname) -AddressPrefix "10.0.0.0/24";
+        $vnet = New-AzVirtualNetwork -Force -Name ('vnet' + $rgname) -ResourceGroupName $rgname -Location $loc -AddressPrefix "10.0.0.0/16" -Subnet $subnet;
+        $vnet = Get-AzVirtualNetwork -Name ('vnet' + $rgname) -ResourceGroupName $rgname;
+        $subnetId = $vnet.Subnets[0].Id;
+        #1
+        $pubip = New-AzPublicIpAddress -Force -Name ('pubip' + $rgname) -ResourceGroupName $rgname -Location $loc -AllocationMethod Dynamic -DomainNameLabel ('pubip' + $rgname);
+        $pubip = Get-AzPublicIpAddress -Name ('pubip' + $rgname) -ResourceGroupName $rgname;
+        $pubipId = $pubip.Id;
+        $nic = New-AzNetworkInterface -Force -Name ('nic' + $rgname) -ResourceGroupName $rgname -Location $loc -SubnetId $subnetId -PublicIpAddressId $pubip.Id;
+        $nic = Get-AzNetworkInterface -Name ('nic' + $rgname) -ResourceGroupName $rgname;
+        $nicId = $nic.Id;
+        
+        $p = Add-AzVMNetworkInterface -VM $p -Id $nicId;
+        
+        # OS & Image
+        $user = "Foo2";
+        $password = $PLACEHOLDER;
+        $securePassword = ConvertTo-SecureString $password -AsPlainText -Force;
+        $cred = New-Object System.Management.Automation.PSCredential ($user, $securePassword);
+        $computerName = 'test';
+        
+        # Windows OS test case. 
+        $p = Set-AzVMOperatingSystem -VM $p -Windows -ComputerName $computerName -Credential $cred;
+        
+        $imgRef = Get-DefaultCRPImage -loc $loc;
+        $p = ($imgRef | Set-AzVMSourceImage -VM $p);
+
+        # Virtual Machine
+        $vm = New-AzVM -ResourceGroupName $rgname -Location $loc -VM $p;
+        Assert-NotNull $vm;
+
+        # Get Managed Boot Diagnostics 
+        # uncomment this when running locally. 
+        # Get-AzVmBootDiagnosticsData -ResourceGroupName $rgname -Name $vmname -Windows -LocalPath $localPath;
+    }
+    finally
+    {
+        # Cleanup
+        Clean-ResourceGroup $rgname
+	}
+}
+

src/Compute/Compute.Test/SessionRecords/Microsoft.Azure.Commands.Compute.Test.ScenarioTests.VirtualMachineTests/TestVirtualMachineBootDiagnostics.json

@@ -27,6 +27,7 @@
 * New cmdlet `Get-AzDiskEncryptionSetAssociatedResource`
 * Added `Tier` and `LogicalSectorSize` optional parameters to the New-AzDiskConfig cmdlet. 
 * Added `Tier`, `MaxSharesCount`, `DiskIOPSReadOnly`, and `DiskMBpsReadOnly` optional parameters to the `New-AzDiskUpdateConfig` cmdlet. 
+* Modified `Get-AzVmBootDiagnostics` cmdlet to use the new RetrieveBootDiagnosticsData API instead of directly accessing the BootDiagnostics properties on the virtual machine.  
 
 ## Version 4.5.0
 * Fixed issue in `Update-ASRRecoveryPlan` by populating FailoverTypes

src/Compute/Compute/ChangeLog.md

@@ -22,11 +22,13 @@
 using Microsoft.Azure.Commands.Compute.Common;
 using Microsoft.Azure.Commands.Compute.Models;
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
+using Microsoft.Azure.Management.Compute;
 using Microsoft.Azure.Management.Storage.Version2017_10_01;
 using Microsoft.WindowsAzure.Commands.Sync.Download;
 using Microsoft.WindowsAzure.Storage.Auth;
 using Microsoft.WindowsAzure.Storage.Blob;
 
+
 namespace Microsoft.Azure.Commands.Compute
 {
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "VMBootDiagnosticsData", DefaultParameterSetName = WindowsParamSet)]
@@ -107,7 +109,7 @@ public override void ExecuteCmdlet()
                     || result.Body.DiagnosticsProfile.BootDiagnostics == null
                     || result.Body.DiagnosticsProfile.BootDiagnostics.Enabled == null
                     || !result.Body.DiagnosticsProfile.BootDiagnostics.Enabled.Value
-                    || result.Body.DiagnosticsProfile.BootDiagnostics.StorageUri == null)
+                    )
                 {
                     ThrowTerminatingError
                         (new ErrorRecord(
@@ -130,25 +132,26 @@ public override void ExecuteCmdlet()
                             null));
                 }
 
+                //console log
                 if (this.Windows.IsPresent
                     || (this.Linux.IsPresent && !string.IsNullOrEmpty(this.LocalPath)))
                 {
-                    var screenshotUri = new Uri(result.Body.InstanceView.BootDiagnostics.ConsoleScreenshotBlobUri);
-                    var localFile = this.LocalPath + screenshotUri.Segments[2];
-                    DownloadFromBlobUri(screenshotUri, localFile);
-                }
+                    var bootDiagnostics = this.VirtualMachineClient.RetrieveBootDiagnosticsData(this.ResourceGroupName, this.Name);
+                    var localPathTest = this.LocalPath;
+                    var localFile = this.LocalPath + new Uri(bootDiagnostics.ConsoleScreenshotBlobUri).Segments[2];
 
+                    DownloadFromBlobUri(new Uri(bootDiagnostics.ConsoleScreenshotBlobUri), localFile);
+                }
 
+                //serial log
+                var bootDiagnosticsSerial = this.VirtualMachineClient.RetrieveBootDiagnosticsData(this.ResourceGroupName, this.Name);
+                var logUri = new Uri(bootDiagnosticsSerial.SerialConsoleLogBlobUri);
+                var localFileSerial = (this.LocalPath ?? Path.GetTempPath()) + logUri.Segments[2];
+                DownloadFromBlobUri(logUri, localFileSerial);
                 if (this.Linux.IsPresent)
                 {
-                    var logUri = new Uri(result.Body.InstanceView.BootDiagnostics.SerialConsoleLogBlobUri);
-
-                    var localFile = (this.LocalPath ?? Path.GetTempPath()) + logUri.Segments[2];
-
-                    DownloadFromBlobUri(logUri, localFile);
-
                     var sb = new StringBuilder();
-                    using (var reader = new StreamReader(localFile))
+                    using (var reader = new StreamReader(localFileSerial))
                     {
                         string line;
                         while ((line = reader.ReadLine()) != null)
@@ -165,25 +168,12 @@ public override void ExecuteCmdlet()
         private void DownloadFromBlobUri(Uri sourceUri, string localFileInfo)
         {
             BlobUri blobUri;
-            string storagekey = "";
             if (!BlobUri.TryParseUri(sourceUri, out blobUri))
             {
                 throw new ArgumentOutOfRangeException("Source", sourceUri.ToString());
             }
 
-            var storageClient = AzureSession.Instance.ClientFactory.CreateArmClient<StorageManagementClient>(
-                        DefaultProfile.DefaultContext, AzureEnvironment.Endpoint.ResourceManager);
-
-
-            var storageService = storageClient.StorageAccounts.GetProperties(this.ResourceGroupName, blobUri.StorageAccountName);
-            if (storageService != null)
-            {
-                var storageKeys = storageClient.StorageAccounts.ListKeys(this.ResourceGroupName, storageService.Name);
-                storagekey = storageKeys.GetKey1();
-            }
-
-            StorageCredentials storagecred = new StorageCredentials(blobUri.StorageAccountName, storagekey);
-            var blob = new CloudBlob(sourceUri, storagecred);
+            var blob = new CloudBlob(sourceUri);
 
             blob.DownloadToFileAsync(localFileInfo, FileMode.Create).ConfigureAwait(false).GetAwaiter().GetResult();
         }