AsBuiltReport.Microsoft.Azure

0.1.2

Src/Private/Get-AbrAzVirtualMachine.ps1

function Get-AbrAzVirtualMachine {
    <#
    .SYNOPSIS
    Used by As Built Report to retrieve Azure Virtual Machine information from the Azure subscription
    .DESCRIPTION
 
    .NOTES
        Version: 0.1.0
        Author: Tim Carman
        Twitter: @tpcarman
        Github: tpcarman
    .EXAMPLE
 
    .LINK
 
    #>
    [CmdletBinding()]
    param (
    )

    begin {
        Write-PScriboMessage "VM InfoLevel set at $($InfoLevel.VirtualMachine)."
    }

    process {
        $AzVMs = Get-AzVM -Status | Where-Object {$_.id.split('/')[2] -eq $AzSubscription.Id} | Sort-Object Name
        if (($InfoLevel.VirtualMachine -gt 0) -and ($AzVMs)) {
            Write-PscriboMessage "Collecting Azure VM information."
            Section -Style Heading4 'Virtual Machines' {
                $AzVMInfo = @()
                foreach ($AzVM in $AzVMs) {
                    $AzVMSize = Get-AzVMSize -Location $AzVm.Location | Where-Object {$_.Name -eq $AzVm.HardwareProfile.VmSize}
                    $AzVmNic = Get-AzNetworkInterface | Where-Object {$_.VirtualMachine.Id -eq $AzVm.id}
                    $AzVmBackupStatus = Get-AzRecoveryServicesBackupStatus -Name $AzVm.Name -ResourceGroupName $AzVm.ResourceGroupName -Type "AzureVM"
                    $AzVmExtensions = Get-AzVMExtension -VMName $AzVm.Name -ResourceGroupName $AzVm.ResourceGroupName | Sort-Object Name
                    $AzVmDiskEncryption = Get-AzVMDiskEncryptionStatus -ResourceGroupName $AzVm.ResourceGroupName -VMName $AzVm.Name
                    $InObj = [Ordered]@{
                        'Name' = $AzVM.Name
                        'Resource Group' = $AzVM.ResourceGroupName
                        'Location' = $AzLocationLookup."$($AzVm.Location)"
                        'Subscription' = "$($AzSubscriptionLookup.(($AzVm.Id).split('/')[2]))"
                        'Status' = Switch ($AzVm.PowerState) {
                            'Vm deallocated' { 'Deallocated'}
                            'Vm running' { 'Running' }
                            default { $AzVm.PowerState }
                        }
                        'Private IP Address' = $AzVmNic.IpConfigurations.PrivateIpAddress
                        'Private IP Assignment' = $AzVmNic.IpConfigurations.PrivateIpAllocationMethod
                        'Virtual Network / Subnet' = ($AzVmNic.IpConfigurations.Subnet.Id).split('/')[4] + " / " + ($AzVmNic.IpConfigurations.Subnet.Id).split('/')[-1]
                        'OS Type' = $AzVm.StorageProfile.OsDisk.OsType
                        'Size' = $AzVm.HardwareProfile.VmSize
                        'vCPUs' = $AzVMSize.NumberOfCores
                        'RAM' = "$($AzVMSize.MemoryInMB / 1024) GiB"
                        #'Operating System' = ''
                        'OS Disk' = ($AzVm.StorageProfile.OsDisk.Name)
                        'OS Disk Size' = Switch ($AzVm.StorageProfile.OsDisk.DiskSizeGB) {
                            $null { '--' }
                            default { "$($AzVm.StorageProfile.OsDisk.DiskSizeGB) GiB" }
                        }
                        'OS Disk Type' = Switch ($AzVm.StorageProfile.OsDisk.ManagedDisk.StorageAccountType) {
                            $null { '--' }
                            'Standard_LRS' { 'Standard LRS' }
                            'Premium_LRS' { 'Premium LRS' }
                            'Premium_ZRS' { 'Premium ZRS' }
                            'StandardSSD_LRS' { 'Standard SSD LRS' }
                            'StandardSSD_ZRS' { 'Standard SSD ZRS' }
                            'UltraSSD_LRS' { 'Ultra SSD LRS' }
                        }
                        'No. of Data Disks' = ($AzVm.StorageProfile.DataDisks).Count
                        'Azure Disk Encryption' = Switch ($AzVmDiskEncryption.OsVolumeEncryptionSettings.Enabled) {
                            $true { 'Enabled' }
                            $false { 'Not Enabled' }
                            $null { 'Not Enabled' }
                        }
                        'Boot Diagnostics' = & {
                            if (($AzVM.DiagnosticsProfile.BootDiagnostics.Enabled) -and ($null -eq $AzVM.DiagnosticsProfile.BootDiagnostics.StorageUri)) {
                                "Enabled with managed storage account"
                            } elseif (($AzVM.DiagnosticsProfile.BootDiagnostics.Enabled) -and ($AzVM.DiagnosticsProfile.BootDiagnostics.StorageUri)) {
                                "Enabled with custom storage account"
                            } else {
                                "Disabled"
                            }
                        }
                        'Boot Diagnostics Storage Account' = Switch ($AzVM.DiagnosticsProfile.BootDiagnostics.StorageUri) {
                            $null { '--' }
                            default { $AzVM.DiagnosticsProfile.BootDiagnostics.StorageUri.split('.')[0].trimstart('https://') }
                        }
                        'Azure Backup' = Switch ($AzVmBackupStatus.BackedUp) {
                            $true { 'Enabled' }
                            $false { 'Not Enabled' }
                            $null { 'Not Enabled' }
                        }
                        'Extensions' = & {
                            if ($null -eq $AzVmExtensions.Name) {
                                '--'
                            } else { $AzVmExtensions.Name -join ', ' }
                        }
                    }
                    $AzVMInfo += [PSCustomObject]$InObj
                }

                if ($Healthcheck.VirtualMachine.Status) {
                    $AzVMInfo | Where-Object { $_.'Status' -ne 'Running' } | Set-Style -Style Warning -Property 'Status'
                }
                if ($Healthcheck.VirtualMachine.BootDiagnostics) {
                    $AzVMInfo | Where-Object { $_.'Boot Diagnostics' -ne 'Enabled with custom storage account' } | Set-Style -Style Warning -Property 'Boot Diagnostics'
                    $AzVMInfo | Where-Object { $_.'Boot Diagnostics' -eq 'Disabled' } | Set-Style -Style Critical -Property 'Boot Diagnostics'
                }
                if ($Healthcheck.VirtualMachine.BackupEnabled) {
                    $AzVMInfo | Where-Object { $_.'Azure Backup' -ne 'Enabled' } | Set-Style -Style Warning -Property 'Azure Backup'
                }
                if ($Healthcheck.VirtualMachine.DiskEncryption) {
                    $AzVMInfo | Where-Object { $_.'Azure Disk Encryption' -ne 'Enabled' } | Set-Style -Style Warning -Property 'Azure Disk Encryption'
                }
                if ($InfoLevel.VirtualMachine -ge 2) {
                    Paragraph "The following sections detail the configuration of the virtual machines within the $($AzSubscription.Name) subscription."
                    foreach ($AzVM in $AzVMInfo) {
                        Section -Style Heading5 "$($AzVM.Name)" {
                            $TableParams = @{
                                Name = "Virtual Machine - $($AzVM.Name)"
                                List = $true
                                ColumnWidths = 50, 50
                            }
                            if ($Report.ShowTableCaptions) {
                                $TableParams['Caption'] = "- $($TableParams.Name)"
                            }
                            $AzVM | Table @TableParams
                        }
                    }
                } else {
                    Paragraph "The following table summarises the configuration of the virtual machines within the $($AzSubscription.Name) subscription."
                    BlankLine
                    $TableParams = @{
                        Name = "Virtual Machines - $($AzSubscription.Name)"
                        List = $false
                        Columns = 'Name', 'Resource Group', 'Location', 'Status', 'Private IP Address', 'OS Type'
                        ColumnWidths = 21, 23, 15, 13, 15, 13
                    }
                    if ($Report.ShowTableCaptions) {
                        $TableParams['Caption'] = "- $($TableParams.Name)"
                    }
                    $AzVMInfo | Table @TableParams
                }
            }
        }
    }

    end {}
}