Upload-WindowsAutopilotDeviceInfo.ps1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
<#PSScriptInfo
.VERSION 1.1.0 .GUID 8d3532b3-ff9f-4031-b06f-25fcab76c626 .AUTHOR NickolajA .DESCRIPTION Gather device hash from local machine and automatically upload it to Autopilot .COMPANYNAME SCConfigMgr .COPYRIGHT .TAGS Autopilot Windows Intune .LICENSEURI .PROJECTURI https://github.com/SCConfigMgr/Intune/blob/master/Autopilot/Upload-WindowsAutopilotDeviceInfo.ps1 .ICONURI .EXTERNALMODULEDEPENDENCIES .REQUIREDSCRIPTS .EXTERNALSCRIPTDEPENDENCIES .RELEASENOTES #> #Requires -Module AzureAD #Requires -Module PSIntuneAuth <# .SYNOPSIS Gather device hash from local machine and automatically upload it to Autopilot. .DESCRIPTION This script automatically gathers the device hash, serial number, manufacturer and model and uploads that data into Autopilot. Authentication is required within this script and required permissions for creating Autopilot device identities are needed. .PARAMETER TenantName Specify the tenant name, e.g. tenantname.onmicrosoft.com. .PARAMETER ApplicationID Specify the Application ID of the app registration in Azure AD. By default, the script will attempt to use well known Microsoft Intune PowerShell app registration (d1ddf0e4-d672-4dae-b554-9d5bdfd93547). .PARAMETER GroupTag Specify the group tag to easier differentiate Autopilot devices, e.g. 'ABCSales'. .PARAMETER UserPrincipalName Specify the primary user principal name, e.g. 'firstname.lastname@domain.com'. .EXAMPLE # Gather device hash from local computer and upload to Autopilot using Intune Graph API's: .\Upload-WindowsAutopilotDeviceInfo.ps1 -TenantName "tenant.onmicrosoft.com" # Gather device hash from local computer and upload to Autopilot using Intune Graph API's with a given group tag as 'AADUserDriven': .\Upload-WindowsAutopilotDeviceInfo.ps1 -TenantName "tenant.onmicrosoft.com" -GroupTag "AADUserDriven" # Gather device hash from local computer and upload to Autopilot using Intune Graph API's with a given group tag as 'AADUserDriven' and 'somone@domain.com' as the assigned user: .\Upload-WindowsAutopilotDeviceInfo.ps1 -TenantName "tenant.onmicrosoft.com" -GroupTag "AADUserDriven" -UserPrincipalName "someone@domain.com" .NOTES FileName: Upload-WindowsAutopilotDeviceInfo.ps1 Author: Nickolaj Andersen Contact: @NickolajA Created: 2019-03-21 Updated: 2019-10-29 Version history: 1.0.0 - (2019-03-21) Script created. 1.1.0 - (2019-10-29) Added support for specifying the primary user assigned to the uploaded Autopilot device as well as renaming the OrderIdentifier parameter to GroupTag. Thanks to @Stgrdk for his contributions. Switched from Get-CimSession to Get-WmiObject to get device details from WMI. #> [CmdletBinding(SupportsShouldProcess=$true)] param( [parameter(Mandatory=$true, HelpMessage="Specify the tenant name, e.g. tenantname.onmicrosoft.com.")] [ValidateNotNullOrEmpty()] [string]$TenantName, [parameter(Mandatory=$false, HelpMessage="Specify the Application ID of the app registration in Azure AD. By default, the script will attempt to use well known Microsoft Intune PowerShell app registration (d1ddf0e4-d672-4dae-b554-9d5bdfd93547).")] [ValidateNotNullOrEmpty()] [string]$ApplicationID = "d1ddf0e4-d672-4dae-b554-9d5bdfd93547", [parameter(Mandatory=$false, HelpMessage="Specify the group tag to easier differentiate Autopilot devices, e.g. 'ABCSales'.")] [ValidateNotNullOrEmpty()] [string]$GroupTag, [parameter(Mandatory=$false, HelpMessage="Specify the primary user principal name, e.g. 'firstname.lastname@domain.com'.")] [ValidateNotNullOrEmpty()] [string]$UserPrincipalName ) Begin { # Determine if the AzureAD module needs to be installed try { Write-Verbose -Message "Attempting to locate AzureAD module" $AzureADModule = Get-InstalledModule -Name AzureAD -ErrorAction Stop -Verbose:$false if ($AzureADModule -ne $null) { Write-Verbose -Message "AzureAD module detected, checking for latest version" $LatestModuleVersion = (Find-Module -Name AzureAD -ErrorAction Stop -Verbose:$false).Version if ($LatestModuleVersion -gt $AzureADModule.Version) { Write-Verbose -Message "Latest version of AzureAD module is not installed, attempting to install: $($LatestModuleVersion.ToString())" $UpdateModuleInvocation = Update-Module -Name AzureAD -Force -ErrorAction Stop -Confirm:$false -Verbose:$false } } } catch [System.Exception] { Write-Warning -Message "Unable to detect AzureAD module, attempting to install from PSGallery" try { # Install NuGet package provider $PackageProvider = Install-PackageProvider -Name NuGet -Force -Verbose:$false # Install PSIntuneAuth module Install-Module -Name AzureAD -Force -ErrorAction Stop -Confirm:$false -Verbose:$false Write-Verbose -Message "Successfully installed AzureAD" } catch [System.Exception] { Write-Warning -Message "An error occurred while attempting to install AzureAD module. Error message: $($_.Exception.Message)" ; break } } # Determine if the PSIntuneAuth module needs to be installed try { Write-Verbose -Message "Attempting to locate PSIntuneAuth module" $PSIntuneAuthModule = Get-InstalledModule -Name PSIntuneAuth -ErrorAction Stop -Verbose:$false if ($PSIntuneAuthModule -ne $null) { Write-Verbose -Message "Authentication module detected, checking for latest version" $LatestModuleVersion = (Find-Module -Name PSIntuneAuth -ErrorAction Stop -Verbose:$false).Version if ($LatestModuleVersion -gt $PSIntuneAuthModule.Version) { Write-Verbose -Message "Latest version of PSIntuneAuth module is not installed, attempting to install: $($LatestModuleVersion.ToString())" $UpdateModuleInvocation = Update-Module -Name PSIntuneAuth -Scope CurrentUser -Force -ErrorAction Stop -Confirm:$false -Verbose:$false } } } catch [System.Exception] { Write-Warning -Message "Unable to detect PSIntuneAuth module, attempting to install from PSGallery" try { # Install NuGet package provider $PackageProvider = Install-PackageProvider -Name NuGet -Force -Verbose:$false # Install PSIntuneAuth module Install-Module -Name PSIntuneAuth -Scope AllUsers -Force -ErrorAction Stop -Confirm:$false -Verbose:$false Write-Verbose -Message "Successfully installed PSIntuneAuth" } catch [System.Exception] { Write-Warning -Message "An error occurred while attempting to install PSIntuneAuth module. Error message: $($_.Exception.Message)" ; break } } # Check if token has expired and if, request a new Write-Verbose -Message "Checking for existing authentication token" if ($Global:AuthToken -ne $null) { $UTCDateTime = (Get-Date).ToUniversalTime() $TokenExpireMins = ($Global:AuthToken.ExpiresOn.datetime - $UTCDateTime).Minutes Write-Verbose -Message "Current authentication token expires in (minutes): $($TokenExpireMins)" if ($TokenExpireMins -le 0) { Write-Verbose -Message "Existing token found but has expired, requesting a new token" $Global:AuthToken = Get-MSIntuneAuthToken -TenantName $TenantName -ClientID $ApplicationID } else { Write-Verbose -Message "Existing authentication token has not expired, will not request a new token" } } else { Write-Verbose -Message "Authentication token does not exist, requesting a new token" $Global:AuthToken = Get-MSIntuneAuthToken -TenantName $TenantName -ClientID $ApplicationID } } Process { # Functions function Get-ErrorResponseBody { param( [parameter(Mandatory=$true)] [ValidateNotNullOrEmpty()] [System.Exception]$Exception ) # Read the error stream $ErrorResponseStream = $Exception.Response.GetResponseStream() $StreamReader = New-Object System.IO.StreamReader($ErrorResponseStream) $StreamReader.BaseStream.Position = 0 $StreamReader.DiscardBufferedData() $ResponseBody = $StreamReader.ReadToEnd(); # Handle return object return $ResponseBody } # Gather device hash data Write-Verbose -Message "Gather device hash data from local machine" $DeviceHashData = (Get-WmiObject -Namespace "root/cimv2/mdm/dmmap" -Class "MDM_DevDetail_Ext01" -Filter "InstanceID='Ext' AND ParentID='./DevDetail'" -Verbose:$false).DeviceHardwareData $SerialNumber = (Get-WmiObject -Class "Win32_BIOS" -Verbose:$false).SerialNumber $ProductKey = (Get-WmiObject -Class "SoftwareLicensingService" -Verbose:$false).OA3xOriginalProductKey # Construct Graph variables $GraphVersion = "beta" $GraphResource = "deviceManagement/importedWindowsAutopilotDeviceIdentities" $GraphURI = "https://graph.microsoft.com/$($GraphVersion)/$($GraphResource)" # Construct hash table for new Autopilot device identity and convert to JSON Write-Verbose -Message "Constructing required JSON body based upon parameter input data for device hash upload" $AutopilotDeviceIdentity = [ordered]@{ '@odata.type' = '#microsoft.graph.importedWindowsAutopilotDeviceIdentity' 'orderIdentifier' = if ($GroupTag) { "$($GroupTag)" } else { "" } 'serialNumber' = "$($SerialNumber)" 'productKey' = if ($ProductKey) { "$($ProductKey)" } else { "" } 'hardwareIdentifier' = "$($DeviceHashData)" 'assignedUserPrincipalName' = if ($UserPrincipalName) { "$($UserPrincipalName)" } else { "" } 'state' = @{ '@odata.type' = 'microsoft.graph.importedWindowsAutopilotDeviceIdentityState' 'deviceImportStatus' = 'pending' 'deviceRegistrationId' = '' 'deviceErrorCode' = 0 'deviceErrorName' = '' } } $AutopilotDeviceIdentityJSON = $AutopilotDeviceIdentity | ConvertTo-Json try { # Call Graph API and post JSON data for new Autopilot device identity Write-Verbose -Message "Attempting to post data for hardware hash upload" $AutopilotDeviceIdentityResponse = Invoke-RestMethod -Uri $GraphURI -Headers $AuthToken -Method Post -Body $AutopilotDeviceIdentityJSON -ContentType "application/json" -ErrorAction Stop -Verbose:$false $AutopilotDeviceIdentityResponse } catch [System.Exception] { # Construct stream reader for reading the response body from API call $ResponseBody = Get-ErrorResponseBody -Exception $_.Exception # Handle response output and error message Write-Output -InputObject "Response content:`n$ResponseBody" Write-Warning -Message "Failed to upload hardware hash. Request to $($GraphURI) failed with HTTP Status $($_.Exception.Response.StatusCode) and description: $($_.Exception.Response.StatusDescription)" } try { # Call Graph API and post Autopilot devices sync command Write-Verbose -Message "Attempting to perform a sync action in Autopilot" $GraphResource = "deviceManagement/windowsAutopilotSettings/sync" $GraphURI = "https://graph.microsoft.com/$($GraphVersion)/$($GraphResource)" (Invoke-RestMethod -Uri $GraphURI -Headers $AuthToken -Method Post -ErrorAction Stop -Verbose:$false).Value } catch [System.Exception] { # Construct stream reader for reading the response body from API call $ResponseBody = Get-ErrorResponseBody -Exception $_.Exception # Handle response output and error message Write-Output -InputObject "Response content:`n$ResponseBody" Write-Warning -Message "Request to $GraphURI failed with HTTP Status $($_.Exception.Response.StatusCode) and description: $($_.Exception.Response.StatusDescription)" } } |