WindowsAutoPilotIntune.psm1
|
#region Graph functions function Get-AuthToken { <# .SYNOPSIS Internal function used by the Connect-AutoPilotIntune function. #> [cmdletbinding()] param ( [Parameter(Mandatory=$true)] $User ) $userUpn = New-Object "System.Net.Mail.MailAddress" -ArgumentList $User $tenant = $userUpn.Host Write-Host "Checking for AzureAD module..." $AadModule = Get-Module -Name "AzureAD" -ListAvailable if ($AadModule -eq $null) { Write-Host "AzureAD PowerShell module not found, looking for AzureADPreview" $AadModule = Get-Module -Name "AzureADPreview" -ListAvailable } if ($AadModule -eq $null) { write-host "AzureAD Powershell module not installed..." -f Red write-host "Install by running 'Install-Module AzureAD' or 'Install-Module AzureADPreview' from an elevated PowerShell prompt" -f Yellow write-host "Script can't continue..." -f Red exit } # Getting path to ActiveDirectory Assemblies # If the module count is greater than 1 find the latest version if($AadModule.count -gt 1){ $Latest_Version = ($AadModule | select version | Sort-Object)[-1] $aadModule = $AadModule | ? { $_.version -eq $Latest_Version.version } # Checking if there are multiple versions of the same module found if($AadModule.count -gt 1){ $aadModule = $AadModule | select -Unique } $adal = Join-Path $AadModule.ModuleBase "Microsoft.IdentityModel.Clients.ActiveDirectory.dll" $adalforms = Join-Path $AadModule.ModuleBase "Microsoft.IdentityModel.Clients.ActiveDirectory.Platform.dll" } else { $adal = Join-Path $AadModule.ModuleBase "Microsoft.IdentityModel.Clients.ActiveDirectory.dll" $adalforms = Join-Path $AadModule.ModuleBase "Microsoft.IdentityModel.Clients.ActiveDirectory.Platform.dll" } [System.Reflection.Assembly]::LoadFrom($adal) | Out-Null [System.Reflection.Assembly]::LoadFrom($adalforms) | Out-Null $clientId = "d1ddf0e4-d672-4dae-b554-9d5bdfd93547" $redirectUri = "urn:ietf:wg:oauth:2.0:oob" $resourceAppIdURI = "https://graph.microsoft.com" $authority = "https://login.microsoftonline.com/$Tenant" try { $authContext = New-Object "Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext" -ArgumentList $authority # https://msdn.microsoft.com/en-us/library/azure/microsoft.identitymodel.clients.activedirectory.promptbehavior.aspx # Change the prompt behaviour to force credentials each time: Auto, Always, Never, RefreshSession $platformParameters = New-Object "Microsoft.IdentityModel.Clients.ActiveDirectory.PlatformParameters" -ArgumentList "Auto" $userId = New-Object "Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier" -ArgumentList ($User, "OptionalDisplayableId") $authResult = $authContext.AcquireTokenAsync($resourceAppIdURI,$clientId,$redirectUri,$platformParameters,$userId).Result # If the accesstoken is valid then create the authentication header if($authResult.AccessToken){ # Creating header for Authorization token $authHeader = @{ 'Content-Type'='application/json' 'Authorization'="Bearer " + $authResult.AccessToken 'ExpiresOn'=$authResult.ExpiresOn } return $authHeader } else { Write-Host "Authorization Access Token is null, please re-run authentication..." -ForegroundColor Red break } } catch { write-host $_.Exception.Message -f Red write-host $_.Exception.ItemName -f Red break } } function Connect-AutoPilotIntune { <# .SYNOPSIS Authenticates and connects to Azure Active Directory via the Microsoft Graph. .DESCRIPTION The Connect-AutoPilotIntune function is used to authenticate and connect to Azure Active Directory via the Microsoft Graph API web services. You can optionally specify a user principal name (UPN). The password will be requested using a standard Azure AD form. .PARAMETER user User principal name (UPN) that should be used for authentication, which also determines the tenant for the connection. If not specified, an interactive prompt will be presented. .EXAMPLE Connect to the Microsoft Graph API using the specified user Connect-AutoPilotIntune �user user@contoso.onmicrosoft.com .NOTES The AzureAD or AzureADPreview modules must be present before this cmdlet can be used. These can be installed using a command line: Install-Module -Name AzureAD #> [cmdletbinding()] param ( [Parameter(Mandatory=$false)] $user = "" ) # Checking if authToken exists before running authentication if($global:authToken){ # Setting DateTime to Universal time to work in all timezones $DateTime = (Get-Date).ToUniversalTime() # If the authToken exists checking when it expires $TokenExpires = ($authToken.ExpiresOn.datetime - $DateTime).Minutes if($TokenExpires -le 0){ write-host "Authentication Token expired" $TokenExpires "minutes ago" -ForegroundColor Yellow # Defining User Principal Name if not present if($user -eq $null -or $user -eq ""){ $user = Read-Host -Prompt "Please specify your user principal name for Azure Authentication" } $global:authToken = Get-AuthToken -User $user } } # Authentication doesn't exist, calling Get-AuthToken function else { if ($user -eq $null -or $user -eq ""){ $user = Read-Host -Prompt "Please specify your user principal name for Azure Authentication" } # Getting the authorization token $global:authToken = Get-AuthToken -User $User } } #endregion #################################################### Function Get-AutoPilotDevice(){ <# .SYNOPSIS Gets devices currently registered with Windows Autopilot. .DESCRIPTION The Get-AutoPilotDevice cmdlet retrieves either the full list of devices registered with Windows Autopilot for the current Azure AD tenant, or a specific device if the ID of the device is specified. .PARAMETER id Optionally specifies the ID (GUID) for a specific Windows Autopilot device (which is typically returned after importing a new device) .EXAMPLE Get a list of all devices registered with Windows Autopilot Get-AutoPilotDevice #> [cmdletbinding()] param ( [Parameter(Mandatory=$false)] $id ) # Defining Variables $graphApiVersion = "beta" $Resource = "deviceManagement/windowsAutopilotDeviceIdentities" if ($id) { $uri = "https://graph.microsoft.com/$graphApiVersion/$Resource/$id" } else { $uri = "https://graph.microsoft.com/$graphApiVersion/$Resource" } try { $response = Invoke-RestMethod -Uri $uri -Headers $authToken -Method Get if ($id) { $response } else { $devices = $response.value $devicesNextLink = $response."@odata.nextLink" while ($devicesNextLink -ne $null){ $devicesResponse = (Invoke-RestMethod -Uri $devicesNextLink -Headers $authToken -Method Get) $devicesNextLink = $devicesResponse."@odata.nextLink" $devices += $devicesResponse.value } $devices } } catch { $ex = $_.Exception $errorResponse = $ex.Response.GetResponseStream() $reader = New-Object System.IO.StreamReader($errorResponse) $reader.BaseStream.Position = 0 $reader.DiscardBufferedData() $responseBody = $reader.ReadToEnd(); Write-Host "Response content:`n$responseBody" -f Red Write-Error "Request to $Uri failed with HTTP Status $($ex.Response.StatusCode) $($ex.Response.StatusDescription)" break } } Function Remove-AutoPilotDevice(){ <# .SYNOPSIS Removes a specific device currently registered with Windows Autopilot. .DESCRIPTION The Remove-AutoPilotDevice cmdlet removes the specified device, identified by its ID, from the list of devices registered with Windows Autopilot for the current Azure AD tenant. .PARAMETER id Specifies the ID (GUID) for a specific Windows Autopilot device .EXAMPLE Remove all Windows Autopilot devices from the current Azure AD tenant Get-AutoPilotDevice | Remove-AutoPilotDevice #> [cmdletbinding()] param ( [Parameter(Mandatory=$true)] $id ) # Defining Variables $graphApiVersion = "beta" $Resource = "deviceManagement/windowsAutopilotDeviceIdentities" $uri = "https://graph.microsoft.com/$graphApiVersion/$Resource/$id" try { Invoke-RestMethod -Uri $uri -Headers $authToken -Method Delete | Out-Null } catch { $ex = $_.Exception $errorResponse = $ex.Response.GetResponseStream() $reader = New-Object System.IO.StreamReader($errorResponse) $reader.BaseStream.Position = 0 $reader.DiscardBufferedData() $responseBody = $reader.ReadToEnd(); Write-Host "Response content:`n$responseBody" -f Red Write-Error "Request to $Uri failed with HTTP Status $($ex.Response.StatusCode) $($ex.Response.StatusDescription)" break } } #################################################### Function Get-AutoPilotImportedDevice(){ <# .SYNOPSIS Gets information about devices being imported into Windows Autopilot. .DESCRIPTION The Get-AutoPilotImportedDevice cmdlet retrieves either the full list of devices being imported into Windows Autopilot for the current Azure AD tenant, or information for a specific device if the ID of the device is specified. Once the import is complete, the information instance is expected to be deleted. .PARAMETER id Optionally specifies the ID (GUID) for a specific Windows Autopilot device being imported. .EXAMPLE Get a list of all devices being imported into Windows Autopilot for the current Azure AD tenant. Get-AutoPilotImportedDevice #> [cmdletbinding()] param ( [Parameter(Mandatory=$false)] $id ) # Defining Variables $graphApiVersion = "beta" $Resource = "deviceManagement/importedWindowsAutopilotDeviceIdentities" if ($id) { $uri = "https://graph.microsoft.com/$graphApiVersion/$Resource/$id" } else { $uri = "https://graph.microsoft.com/$graphApiVersion/$Resource" } try { $response = Invoke-RestMethod -Uri $uri -Headers $authToken -Method Get if ($id) { $response } else { $devices = $response.value $devicesNextLink = $response."@odata.nextLink" while ($devicesNextLink -ne $null){ $devicesResponse = (Invoke-RestMethod -Uri $devicesNextLink -Headers $authToken -Method Get) $devicesNextLink = $devicesResponse."@odata.nextLink" $devices += $devicesResponse.value } $devices } } catch { $ex = $_.Exception $errorResponse = $ex.Response.GetResponseStream() $reader = New-Object System.IO.StreamReader($errorResponse) $reader.BaseStream.Position = 0 $reader.DiscardBufferedData() $responseBody = $reader.ReadToEnd(); Write-Host "Response content:`n$responseBody" -f Red Write-Error "Request to $Uri failed with HTTP Status $($ex.Response.StatusCode) $($ex.Response.StatusDescription)" break } } <# .SYNOPSIS Adds a new device to Windows Autopilot. .DESCRIPTION The Add-AutoPilotImportedDevice cmdlet adds the specified device to Windows Autopilot for the current Azure AD tenant. Note that a status object is returned when this cmdlet completes; the actual import process is performed as a background batch process by the Microsoft Intune service. .PARAMETER serialNumber The hardware serial number of the device being added (mandatory). .PARAMETER hardwareIdentifier The hardware hash (4K string) that uniquely identifies the device. .PARAMETER orderIdentifier An optional identifier or tag that can be associated with this device, useful for grouping devices using Azure AD dynamic groups. .EXAMPLE Add a new device to Windows Autopilot for the current Azure AD tenant. Add-AutoPilotImportedDevice -serialNumber $serial -hardwareIdentifier $hash -orderIdentifier "Kiosk" #> Function Add-AutoPilotImportedDevice(){ [cmdletbinding()] param ( [Parameter(Mandatory=$true)] $serialNumber, [Parameter(Mandatory=$true)] $hardwareIdentifier, [Parameter(Mandatory=$false)] $orderIdentifier = "" ) # Defining Variables $graphApiVersion = "beta" $Resource = "deviceManagement/importedWindowsAutopilotDeviceIdentities" $uri = "https://graph.microsoft.com/$graphApiVersion/$Resource" $json = @" { "@odata.type": "#microsoft.graph.importedWindowsAutopilotDeviceIdentity", "orderIdentifier": "$orderIdentifier", "serialNumber": "$serialNumber", "productKey": "", "hardwareIdentifier": "$hardwareIdentifier", "state": { "@odata.type": "microsoft.graph.importedWindowsAutopilotDeviceIdentityState", "deviceImportStatus": "pending", "deviceRegistrationId": "", "deviceErrorCode": 0, "deviceErrorName": "" } } "@ try { Invoke-RestMethod -Uri $uri -Headers $authToken -Method Post -Body $json -ContentType "application/json" } catch { $ex = $_.Exception $errorResponse = $ex.Response.GetResponseStream() $reader = New-Object System.IO.StreamReader($errorResponse) $reader.BaseStream.Position = 0 $reader.DiscardBufferedData() $responseBody = $reader.ReadToEnd(); Write-Host "Response content:`n$responseBody" -f Red Write-Error "Request to $Uri failed with HTTP Status $($ex.Response.StatusCode) $($ex.Response.StatusDescription)" break } } Function Remove-AutoPilotImportedDevice(){ <# .SYNOPSIS Removes the status information for a device being imported into Windows Autopilot. .DESCRIPTION The Remove-AutoPilotImportedDevice cmdlet cleans up the status information about a new device being imported into Windows Autopilot. This should be done regardless of whether the import was successful or not. .PARAMETER id The ID (GUID) of the imported device status information to be removed (mandatory). .EXAMPLE Remove the status information for a specified device. Remove-AutoPilotImportedDevice -id $id #> [cmdletbinding()] param ( [Parameter(Mandatory=$true)] $id ) # Defining Variables $graphApiVersion = "beta" $Resource = "deviceManagement/importedWindowsAutopilotDeviceIdentities" $uri = "https://graph.microsoft.com/$graphApiVersion/$Resource/$id" try { Invoke-RestMethod -Uri $uri -Headers $authToken -Method Delete | Out-Null } catch { $ex = $_.Exception $errorResponse = $ex.Response.GetResponseStream() $reader = New-Object System.IO.StreamReader($errorResponse) $reader.BaseStream.Position = 0 $reader.DiscardBufferedData() $responseBody = $reader.ReadToEnd(); Write-Host "Response content:`n$responseBody" -f Red Write-Error "Request to $Uri failed with HTTP Status $($ex.Response.StatusCode) $($ex.Response.StatusDescription)" break } } #################################################### Function Get-AutoPilotProfile(){ <# .SYNOPSIS Gets Windows Autopilot profile details. .DESCRIPTION The Get-AutoPilotProfile cmdlet returns either a list of all Windows Autopilot profiles for the current Azure AD tenant, or information for the specific profile specified by its ID. .PARAMETER id Optionally, the ID (GUID) of the profile to be retrieved. .EXAMPLE Get a list of all Windows Autopilot profiles. Get-AutoPilotProfile #> [cmdletbinding()] param ( [Parameter(Mandatory=$false)] $id ) # Defining Variables $graphApiVersion = "beta" $Resource = "deviceManagement/windowsAutopilotDeploymentProfiles" if ($id) { $uri = "https://graph.microsoft.com/$graphApiVersion/$Resource/$id" } else { $uri = "https://graph.microsoft.com/$graphApiVersion/$Resource" } try { $response = Invoke-RestMethod -Uri $uri -Headers $authToken -Method Get if ($id) { $response } else { $response.Value } } catch { $ex = $_.Exception $errorResponse = $ex.Response.GetResponseStream() $reader = New-Object System.IO.StreamReader($errorResponse) $reader.BaseStream.Position = 0 $reader.DiscardBufferedData() $responseBody = $reader.ReadToEnd(); Write-Host "Response content:`n$responseBody" -f Red Write-Error "Request to $Uri failed with HTTP Status $($ex.Response.StatusCode) $($ex.Response.StatusDescription)" break } } Function Get-AutoPilotOrganization(){ <# .SYNOPSIS Gets information about the current Azure AD tenant (organization). .DESCRIPTION The Get-AutoPilotOrganization cmdlet retrieves the organization object for the current Azure AD tenant. This contains the tenant ID, as well as the list of domain names defined to the tenant. .EXAMPLE Get information about the current Azure AD tenant (organization). Get-AutoPilotOrganization #> [cmdletbinding()] param ( ) # Defining Variables $graphApiVersion = "v1.0" $Resource = "organization" $uri = "https://graph.microsoft.com/$graphApiVersion/$Resource" try { $response = Invoke-RestMethod -Uri $uri -Headers $authToken -Method Get $response.Value } catch { $ex = $_.Exception $errorResponse = $ex.Response.GetResponseStream() $reader = New-Object System.IO.StreamReader($errorResponse) $reader.BaseStream.Position = 0 $reader.DiscardBufferedData() $responseBody = $reader.ReadToEnd(); Write-Host "Response content:`n$responseBody" -f Red Write-Error "Request to $Uri failed with HTTP Status $($ex.Response.StatusCode) $($ex.Response.StatusDescription)" break } } Function ConvertTo-AutoPilotConfigurationJSON(){ <# .SYNOPSIS Converts the specified Windows Autopilot profile into a JSON format. .DESCRIPTION The ConvertTo-AutoPilotConfigurationJSON cmdlet converts the specified Windows Autopilot profile, as represented by a Microsoft Graph API object, into a JSON format. .PARAMETER profile A Windows Autopilot profile object, typically returned by Get-AutoPilotProfile .EXAMPLE Get the JSON representation of each Windows Autopilot profile in the current Azure AD tenant. Get-AutoPilotProfile | ConvertTo-AutoPilotConfigurationJSON #> [cmdletbinding()] param ( [Parameter(Mandatory=$true,ValueFromPipeline=$True)] [Object[]] $profile ) Process { $oobeSettings = $_.outOfBoxExperienceSettings # Build up properties $json = @{} $json.Add("Comment_File", "Profile $($_.displayName)") $json.Add("Version", 2049) $json.Add("ZtdCorrelationId", "7F9E6025-1E13-45F3-BF82-A3E8C5B59EAC") $json.Add("CloudAssignedDomainJoinMethod", 0) if ($_.deviceNameTemplate) { $json.Add("CloudAssignedDeviceName", $_.deviceNameTemplate) } # Figure out config value $oobeConfig = 8 if ($oobeSettings.userType -eq 'standard') { $oobeConfig += 2 } if ($oobeSettings.hidePrivacySettings -eq $true) { $oobeConfig += 4 } if ($oobeSettings.hideEULA -eq $true) { $oobeConfig += 16 } if ($oobeSettings.skipKeyboardSelectionPage -eq $true) { $oobeConfig += 1024 if ($_.language) { $json.Add("CloudAssignedLanguage", $_.language) } } if ($oobeSettings.deviceUsageType -eq 'shared') { $oobeConfig += 32 + 64 } $json.Add("CloudAssignedOobeConfig", $oobeConfig) # Set the forced enrollment setting if ($oobeSettings.hideEscapeLink -eq $true) { $json.Add("CloudAssignedForcedEnrollment", 1) } else { $json.Add("CloudAssignedForcedEnrollment", 0) } # Set the org-related info $org = Get-AutoPilotOrganization foreach ($domain in $org.VerifiedDomains) { if ($domain.isDefault) { $tenantDomain = $domain.name } } $json.Add("CloudAssignedTenantId", $org.id) $json.Add("CloudAssignedTenantDomain", $tenantDomain) $embedded = @{} $embedded.Add("CloudAssignedTenantDomain", $tenantDomain) $embedded.Add("CloudAssignedTenantUpn", "") if ($oobeSettings.hideEscapeLink -eq $true) { $embedded.Add("ForcedEnrollment", 1) } else { $embedded.Add("ForcedEnrollment", 0) } $ztc = @{} $ztc.Add("ZeroTouchConfig", $embedded) $json.Add("CloudAssignedAadServerData", (ConvertTo-JSON $ztc -Compress)) # Return the JSON ConvertTo-JSON $json } } #################################################### Function Import-AutoPilotCSV(){ <# .SYNOPSIS Adds a batch of new devices into Windows Autopilot. .DESCRIPTION The Import-AutoPilotCSV cmdlet processes a list of new devices (contained in a CSV file) using a several of the other cmdlets included in this module. It is a convenient wrapper to handle the details. After the devices have been added, the cmdlet will continue to check the status of the import process. Once all devices have been processed (successfully or not) the cmdlet will complete. This can take several minutes, as the devices are processed by Intune as a background batch process. .PARAMETER csvFile The file containing the list of devices to be added. .PARAMETER orderIdentifier An optional identifier or tag that can be associated with this device, useful for grouping devices using Azure AD dynamic groups. .EXAMPLE Add a batch of devices to Windows Autopilot for the current Azure AD tenant. Import-AutoPilotCSV -csvFile C:\Devices.csv #> [cmdletbinding()] param ( [Parameter(Mandatory=$true)] $csvFile, [Parameter(Mandatory=$false)] $orderIdentifier = "" ) # Read CSV and process each device $devices = Import-CSV $csvFile foreach ($device in $devices) { Add-AutoPilotImportedDevice -serialNumber $device.'Device Serial Number' -hardwareIdentifier $device.'Hardware Hash' -orderIdentifier $orderIdentifier } # While we could keep a list of all the IDs that we added and then check each one, it is # easier to just loop through all of them $processingCount = 1 while ($processingCount -gt 0) { $deviceStatuses = Get-AutoPilotImportedDevice $deviceCount = $deviceStatuses.Length # Check to see if any devices are still processing $processingCount = 0 foreach ($device in $deviceStatuses){ if ($device.state.deviceImportStatus -eq "unknown") { $processingCount = $processingCount + 1 } } Write-Host "Waiting for $processingCount of $deviceCount" # Still processing? Sleep before trying again. if ($processingCount -gt 0){ Start-Sleep 2 } } # Display the statuses $deviceStatuses | ForEach-Object { Write-Host "Serial number $($_.serialNumber): $($_.state.deviceImportStatus) $($_.state.deviceErrorCode) $($_.state.deviceErrorName)" } # Cleanup the imported device records $deviceStatuses | ForEach-Object { Remove-AutoPilotImportedDevice -id $_.id } } Function Invoke-AutopilotSync(){ <# .SYNOPSIS Initiates a synchronization of Windows Autopilot devices between the Autopilot deployment service and Intune. .DESCRIPTION The Invoke-AutopilotSync cmdlet initiates a synchronization between the Autopilot deployment service and Intune. This can be done after importing new devices, to ensure that they appear in Intune in the list of registered Autopilot devices. See https://developer.microsoft.com/en-us/graph/docs/api-reference/beta/api/intune_enrollment_windowsautopilotsettings_sync for more information. .EXAMPLE Initiate a synchronization. Invoke-AutopilotSync #> [cmdletbinding()] param ( ) # Defining Variables $graphApiVersion = "beta" $Resource = "deviceManagement/windowsAutopilotSettings/sync" $uri = "https://graph.microsoft.com/$graphApiVersion/$Resource" try { $response = Invoke-RestMethod -Uri $uri -Headers $authToken -Method Post $response.Value } catch { $ex = $_.Exception $errorResponse = $ex.Response.GetResponseStream() $reader = New-Object System.IO.StreamReader($errorResponse) $reader.BaseStream.Position = 0 $reader.DiscardBufferedData() $responseBody = $reader.ReadToEnd(); Write-Host "Response content:`n$responseBody" -f Red Write-Error "Request to $Uri failed with HTTP Status $($ex.Response.StatusCode) $($ex.Response.StatusDescription)" break } } |