Cmdlets/IDMGraph.ps1
|
Function New-IDMGraphApp{ <# .SYNOPSIS Creates a new Azure AD app registration with the necessary permissions for Intune device management. .PARAMETER CloudEnvironment Specifies the cloud environment to use. Valid values are Public, USGov, USGovDoD. .PARAMETER appNamePrefix Specifies the prefix for the app name. The app name will be the prefix plus a random identifier. .EXAMPLE New-IDMGraphApp -CloudEnvironment Public -appNamePrefix "IntuneDeviceManagerApp" Creates a new app registration in the public cloud with the name "IntuneDeviceManagerApp-<random identifier>" .LINK https://learn.microsoft.com/en-us/powershell/microsoftgraph/app-only?view=graph-powershell-1.0&tabs=azure-portal https://learn.microsoft.com/en-us/troubleshoot/azure/active-directory/verify-first-party-apps-sign-in https://learn.microsoft.com/en-us/graph/api/serviceprincipal-post-approleassignments?view=graph-rest-1.0&tabs=powershell#request https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/template-tutorial-deployment-script?tabs=CLI #> [CmdletBinding()] param( [Parameter(Mandatory = $false)] [ValidateSet('Public','Global','USGov','USGovDoD')] [string] $CloudEnvironment = 'Global', [Parameter(Mandatory = $false)] $AppNamePrefix = "IntuneDeviceManagerApp" ) $ErrorActionPreference = 'Stop' #Requires -Modules Microsoft.Graph.Authentication,Microsoft.Graph.Applications Switch($CloudEnvironment){ 'Public' {$GraphEnvironment = 'Global'} 'USGov' { $GraphEnvironment = 'USGov'} 'USGoDoD' { $GraphEnvironment = 'USGovDoD'} default { $GraphEnvironment = 'Global'} } #Connect to Graph Write-Host ("Connecting to Graph...") -ForegroundColor Cyan -NoNewline Connect-MgGraph -Environment $GraphEnvironment -Scopes "Application.ReadWrite.All","User.Read" -NoWelcome Write-Host ("done") -ForegroundColor Green $TenantID = Get-MgContext | Select-Object -Property TenantId #Set variables for the app $startDate = Get-Date $endDate = $startDate.AddYears(1) $randomIdentifier = (New-Guid).ToString().Substring(0,8) $appName = ($AppNamePrefix + '-' + $randomIdentifier) #Get Role id for DeviceManagementConfiguration.ReadWrite.All $GraphResourceId = "00000003-0000-0000-c000-000000000000" $GraphServicePrincipal = Get-MgServicePrincipal -Filter "AppId eq '$GraphResourceId'" #$GraphServicePrincipal = (Get-MgServicePrincipal -Filter "DisplayName eq 'Microsoft Graph'") $Permissions = $GraphServicePrincipal.AppRoles | Where-Object {$_.value -in $script:GraphScopes} # Create app registration Write-Host ("Creating app registration named: {0}..." -f $appName) -ForegroundColor White -NoNewline $app = New-MgApplication -DisplayName $appName -AppRoles $Permissions # Azure doesn't always update immediately, make sure app exists before we try to update its config $appExists = $false while (!$appExists) { Write-Host "." -NoNewline -ForegroundColor White Start-Sleep -Seconds 2 $appExists = Get-MgApplication -ApplicationId $app.Id } Write-Host ("{0}" -f $app.AppId) -ForegroundColor Green #Create the client secret $PasswordCredentials = @{ StartDateTime = $startDate EndDateTime = $endDate DisplayName = ($appNamePrefix + "_" + ($startDate).ToUniversalTime().ToString("yyyyMMdd")) } Write-Host ("Generating app secret with name: {0}..." -f $PasswordCredentials.DisplayName) -ForegroundColor White -NoNewline $ClientSecret = Add-MgApplicationPassword -ApplicationId $app.Id -PasswordCredential $PasswordCredentials #$ClientSecret | Select-Object -ExpandProperty SecretText Write-Host ("done: {0}..." -f $ClientSecret.SecretText.Substring(0,7)) -ForegroundColor Green Write-Host ("Create corresponding service principal..") -ForegroundColor White -NoNewline # Create corresponding service principal $appSp = New-MgServicePrincipal -AppId $app.AppId Write-Host ("done") -ForegroundColor Green #Grant the DeviceManagementConfiguration.ReadWrite.All permisssions to api Foreach($Permission in $Permissions){ Write-Host ("Granting permissions to app...") -ForegroundColor White -NoNewline $params = @{ "PrincipalId" = $appSp.id #ObjectID of the enterprise app for my app registration "ResourceId" = $GraphServicePrincipal.Id #ID of graph service principal ID in my tenant "AppRoleId" = $Permission.Id #ID of the graph role } $null = New-MgServicePrincipalAppRoleAssignment -ServicePrincipalId $appSp.id -BodyParameter $params Write-Host ("done") -ForegroundColor Green } Disconnect-MgGraph -ErrorAction SilentlyContinue Write-Host ("App registration created:") -ForegroundColor Cyan #build object to return $appdetails = "" | Select-Object Name,AppId,Secret,TenantID $appdetails.Name = $appName $appdetails.TenantID = $TenantID.TenantId $appdetails.AppId = $app.AppId $appdetails.Secret = $ClientSecret.SecretText return $appdetails } Function Get-IDMGraphAppAuthToken { <# .SYNOPSIS Authenticates to the Graph API via the Microsoft.Graph.Intune module using app-based authentication. .DESCRIPTION The Connect-IDMGraphApp cmdlet is a wrapper cmdlet that helps authenticate to the Graph API using the Microsoft.Graph.Intune module. It leverages an Azure AD app ID and app secret for authentication. See https://oofhours.com/2019/11/29/app-based-authentication-with-intune/ for more information. https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#create-a-new-application-secret .PARAMETER Tenant Specifies the tenant (e.g. contoso.onmicrosoft.com) to which to authenticate. .PARAMETER AppId Specifies the Azure AD app ID (GUID) for the application that will be used to authenticate. .PARAMETER AppSecret Specifies the Azure AD app secret corresponding to the app ID that will be used to authenticate. .EXAMPLE Get-IDMGraphAppAuthToken -TenantId $TenantID -AppId $app -AppSecret $secret #> [cmdletbinding()] param ( [Parameter(Mandatory = $false)] [ValidateSet('Public','Global','USGov','USGovDoD')] [string] $CloudEnvironment = 'Global', [Parameter(Mandatory=$true)] [Alias('ClientId')] [String]$AppId, [Parameter(Mandatory=$true)] [Alias('Tenant')] [String]$TenantID, [Parameter(Mandatory=$true)] [Alias('ClientSecret')] [String]$AppSecret ) switch ($CloudEnvironment) { 'Global' {$AzureEndpoint = 'https://login.microsoftonline.com';$graphEndpoint = 'https://graph.microsoft.com'} 'USGov' {$AzureEndpoint = 'https://login.microsoftonline.us';$graphEndpoint = 'https://graph.microsoft.us'} 'USGovDoD' {$AzureEndpoint = 'https://login.microsoftonline.us';$graphEndpoint = 'https://dod-graph.microsoft.us'} } try { #convert secret into creds $azurePassword = ConvertTo-SecureString $AppSecret -AsPlainText -Force $psCred = New-Object System.Management.Automation.PSCredential($AppId , $azurePassword) #connect to Azure using App service principal Connect-AzAccount -Credential $psCred -TenantId $TenantID -ServicePrincipal | Out-Null #Grab the Azure context which will include Azure Token $context = [Microsoft.Azure.Commands.Common.Authentication.Abstractions.AzureRmProfileProvider]::Instance.Profile.DefaultContext $aadToken = [Microsoft.Azure.Commands.Common.Authentication.AzureSession]::Instance.AuthenticationFactory.Authenticate($context.Account, ` $context.Environment, $context.Tenant.Id.ToString(), $null, [Microsoft.Azure.Commands.Common.Authentication.ShowDialog]::Never, ` $null, $graphEndpoint).AccessToken $Body = @{ Grant_Type = "client_credentials" Scope = "$graphEndpoint/.default" client_Id = $AppId Client_Secret = $AppSecret } $ConnectGraph = Invoke-RestMethod -Uri "$AzureEndpoint/$TenantID/oauth2/v2.0/token" -Method POST -Body $Body -ErrorAction Stop $token = $ConnectGraph.access_token #format the date correctly $ExpiresOnMinutes = $ConnectGraph.expires_in / 60 $ExpiresOn = (Get-Date).AddMinutes($ExpiresOnMinutes).ToString("M/d/yyyy hh:mm tt +00:00") # Creating header for Authorization token $authHeader = @{ 'Content-Type'='application/json' 'Authorization'="Bearer " + $token 'ExpiresOn'=$ExpiresOn } return $authHeader } Catch{ Write-Error ("{0}: {1}" -f $_.Exception.ItemName, $_.Exception.Message) } } function Connect-IDMGraphApp{ <# .SYNOPSIS This function is used to authenticate with the Graph API REST interface .DESCRIPTION The function authenticate with the Graph API Interface with the tenant name .PARAMETER User Must be in UPN format (email). This is the user principal name (eg user@domain.com) .EXAMPLE Get-IDMGraphAuthToken Authenticates you with the Graph API interface .NOTES Requires: Microsoft.Graph.Authentication module .LINK Reference: https://learn.microsoft.com/en-us/graph/deployments #> [cmdletbinding()] param( [Parameter(Mandatory = $false)] [ValidateSet('Global','USGov','USGovDoD')] [string] $CloudEnvironment = 'Global', $AppAuthToken ) If($AppAuthToken) { $SecureToken = ConvertTo-SecureString $AppAuthToken -AsPlainText -Force Try{ Connect-MgGraph -AccessToken $SecureToken -NoWelcome } Catch{ Write-Error ("{0}: {1}" -f $_.Exception.ItemName, $_.Exception.Message) } }Else{ Try{ Connect-MgGraph -Environment $CloudEnvironment -Scopes $script:GraphScopes -NoWelcome } Catch{ Write-Error ("{0}: {1}" -f $_.Exception.ItemName, $_.Exception.Message) } } return (Get-MgContext) } function Update-IDMGraphAppAuthToken{ <# .SYNOPSIS Refreshes an access token based on refresh token .PARAMETER Token Token is the existing refresh token .PARAMETER tenantID This is the tenant ID in GUID format .PARAMETER ClientID This is the app reg client ID in GUID format .PARAMETER Secret This is the client secret .PARAMETER Scope An array of access scope, default is: "Group.ReadWrite.All" & "User.ReadWrite.All" .LINK Reference: https://docs.microsoft.com/en-us/graph/auth-v2-user#3-get-a-token Reference: https://learn.microsoft.com/en-us/entra/identity-platform/authentication-national-cloud #> Param( [parameter(Mandatory = $true)] [String]$Token, [parameter(Mandatory = $true)] [String]$TenantID, [parameter(Mandatory = $true)] [String]$ClientID, [parameter(Mandatory = $true)] [String]$Secret, [Parameter(Mandatory = $false)] [ValidateSet('Global','USGov','USGovDoD')] [string] $CloudEnvironment = 'Global', [parameter(Mandatory = $false)] [String[]]$Scope = @("Group.ReadWrite.All","User.ReadWrite.All") ) # Defining Variables $oAuthApiVersion = "v2.0" switch ($CloudEnvironment) { 'Global' {$AzureEndpoint = 'https://login.microsoftonline.com';$graphEndpoint = 'https://graph.microsoft.com'} 'USGov' {$AzureEndpoint = 'https://login.microsoftonline.us';$graphEndpoint = 'https://graph.microsoft.us'} 'USGovDoD' {$AzureEndpoint = 'https://login.microsoftonline.us';$graphEndpoint = 'https://dod-graph.microsoft.us'} } $uri = "$AzureEndpoint/$TenantID/oauth2/$oAuthApiVersion/token" $bodyHash = @{ client_id = $ClientID scope = ($Scope -join ' ') refresh_token = $Token #redirect_uri =' http://localhost' redirect_uri = ($graphEndpoint + '/.default') grant_type = 'refresh_token' client_secret = $Secret } $body = ($bodyHash.GetEnumerator() | Foreach {$_.key +'='+ [System.Web.HttpUtility]::UrlEncode($_.Value)}) -Join '&' try { Write-Verbose "GET $uri" $Response = Invoke-RestMethod -Uri $uri -body $body -ContentType 'application/x-www-form-urlencoded' -Method Post -ErrorAction Stop } catch { Write-ErrorResponse($_) } return $Response } Function Invoke-IDMGraphBatchRequests{ <# .SYNOPSIS Invoke GET method to Microsoft Graph Rest API using batch method .DESCRIPTION Invoke Rest method using the get method but do it using collection of Get requests as one batch request .PARAMETER $Uri Specify graph uri(s) for requests .PARAMETER Headers Header for Graph bearer token. Must be in hashtable format: Name Value ---- ----- Authorization = 'Bearer eyJ0eXAiOiJKV1QiLCJub25jZSI6ImVhMnZPQjlqSmNDOTExcVJtNE1EaEpCd2YyVmRyNXlodjRqejFOOUZhNmciLCJhbGci...' Content-Type = 'application/json' ExpiresOn = '7/29/2022 7:55:14 PM +00:00' Use command: $AuthToken = Get-IDMGraphAuthToken -User (Connect-MSGraph).UPN .PARAMETER Passthru Using -Passthru will out graph data including next link and context. Value contains devices. No Passthru will out value only .EXAMPLE $Uri = 'https://graph.microsoft.com/beta/deviceManagement/managedDevices' Invoke-IDMGraphBatchRequests -Uri $Uri -Headers $AuthToken .EXAMPLE $UriResources = @( 'https://graph.microsoft.com/beta/users/c9d00ac2-b07d-4477-961b-442bbc424586/memberOf' 'https://graph.microsoft.com/beta/devices/b215decf-4188-4d19-9e22-fb2e89ae0fec/memberOf' 'https://graph.microsoft.com/beta/deviceManagement/deviceCompliancePolicies' 'https://graph.microsoft.com/beta/deviceManagement/deviceComplianceScripts' 'https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations' 'https://graph.microsoft.com/beta/deviceManagement/deviceEnrollmentConfigurations' 'https://graph.microsoft.com/beta/deviceManagement/deviceHealthScripts' 'https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts' 'https://graph.microsoft.com/beta/deviceManagement/roleScopeTags' 'https://graph.microsoft.com/beta/deviceManagement/windowsQualityUpdateProfiles' 'https://graph.microsoft.com/beta/deviceManagement/windowsFeatureUpdateProfiles' 'https://graph.microsoft.com/beta/deviceAppManagement/windowsInformationProtectionPolicies' 'https://graph.microsoft.com/beta/deviceAppManagement/mdmWindowsInformationProtectionPolicies' 'https://graph.microsoft.com/beta/deviceAppManagement/mobileApps' 'https://graph.microsoft.com/beta/deviceAppManagement/policysets' ) $Response = $UriResources | Invoke-IDMGraphBatchRequests -Headers $Global:AuthToken -verbose .EXAMPLE Invoke-IDMGraphBatchRequests -Uri 'https://graph.microsoft.com/beta/deviceManagement/managedDevices' -Headers $Global:AuthToken -Passthru .LINK https://docs.microsoft.com/en-us/graph/sdks/batch-requests?tabs=csharp https://docs.microsoft.com/en-us/graph/json-batching #> [cmdletbinding()] param ( [Parameter(Mandatory=$True,ValueFromPipelineByPropertyName=$true,ValueFromPipeline=$true,HelpMessage="Specify Uri or array or Uris")] [string[]]$Uri, [Parameter(Mandatory=$false)] [hashtable]$Headers = $Global:AuthToken, [switch]$Passthru ) Begin{ $graphApiVersion = "beta" $Method = 'GET' $batch = @() $i = 1 #Build custom object for assignment $BatchProperties = "" | Select requests If($null -eq $Global:graphEndpoint){ Write-Error "Graph endpoint not found. Please authenticate with Get-IDMGraphAuthToken or Connect-MgGraph first" } } Process{ Foreach($url in $Uri | Select -Unique){ $URLRequests = "" | Select id,method,url $URLRequests.id = $i $URLRequests.method = $Method $URLRequests.url = $url.replace("$Global:graphEndpoint/$graphApiVersion",'') $i++ $batch += $URLRequests } } End{ $BatchProperties.requests = $batch #convert body to json $BatchBody = $BatchProperties | ConvertTo-Json Write-Verbose $BatchBody $batchUri = "$Global:graphEndpoint/$graphApiVersion/`$batch" try { Write-Verbose "Get $batchUri" $response = Invoke-RestMethod -Uri $batchUri -Headers $Headers -Method Post -Body $BatchBody } catch { Write-ErrorResponse($_) } If($Passthru){ return $response.responses.body } Else{ $BatchResponses = @() $i=0 foreach($Element in $response.responses.body){ $hashtable = @{} Foreach($Item in $Element.value){ foreach( $property in $Item.psobject.properties.name ) { $hashtable[$property] = $Item.$property } $hashtable['uri'] = "$Global:graphEndpoint/$graphApiVersion" + $batch[$i].url #$hashtable['type'] = (Split-Path $Element.'@odata.context' -Leaf).replace('$metadata#','') $Object = New-Object PSObject -Property $hashtable $BatchResponses += $Object } $i++ } return $BatchResponses } } } Function Invoke-IDMGraphRequests{ <# .SYNOPSIS Invoke GET method to Microsoft Graph Rest API in multithread .DESCRIPTION Invoke Rest method using the get method but do it using a pool of runspaces .PARAMETER $Uri Specify graph uri(s) for requests .PARAMETER Headers Header for Graph bearer token. Must be in hashtable format: Name Value ---- ----- Authorization = 'Bearer eyJ0eXAiOiJKV1QiLCJub25jZSI6ImVhMnZPQjlqSmNDOTExcVJtNE1EaEpCd2YyVmRyNXlodjRqejFOOUZhNmciLCJhbGci...' Content-Type = 'application/json' ExpiresOn = '7/29/2022 7:55:14 PM +00:00' Use command: $AuthToken = Get-IDMGraphAuthToken -User (Connect-MSGraph).UPN .PARAMETER Threads Integer. Defaults to 15. Don't change unless needed (for slower CPU's) .PARAMETER Passthru Using -Passthru will out graph data including next link and context. Value contains devices. No Passthru will out value only .EXAMPLE $Uri = 'https://graph.microsoft.com/beta/deviceManagement/managedDevices' Invoke-IDMGraphRequests -Uri $Uri -Headers $AuthToken .EXAMPLE $Uri = @( 'https://graph.microsoft.com/beta/deviceManagement/deviceCompliancePolicies' 'https://graph.microsoft.com/beta/deviceManagement/deviceComplianceScripts' 'https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations' 'https://graph.microsoft.com/beta/deviceManagement/deviceEnrollmentConfigurations' 'https://graph.microsoft.com/beta/deviceManagement/deviceHealthScripts' 'https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts' 'https://graph.microsoft.com/beta/deviceManagement/roleScopeTags' 'https://graph.microsoft.com/beta/deviceManagement/windowsQualityUpdateProfiles' 'https://graph.microsoft.com/beta/deviceManagement/windowsFeatureUpdateProfiles' 'https://graph.microsoft.com/beta/deviceAppManagement/windowsInformationProtectionPolicies' 'https://graph.microsoft.com/beta/deviceAppManagement/mdmWindowsInformationProtectionPolicies' 'https://graph.microsoft.com/beta/deviceAppManagement/mobileApps' 'https://graph.microsoft.com/beta/deviceAppManagement/policysets' ) $Responses = $Uri | Invoke-IDMGraphRequests -Threads $Uri.count .EXAMPLE Invoke-IDMGraphRequests -Uri 'https://graph.microsoft.com/beta/deviceManagement/managedDevices' -Passthru .LINK https://b-blog.info/en/implement-multi-threading-with-net-runspaces-in-powershell.html https://adamtheautomator.com/powershell-multithreading/ #> [cmdletbinding()] param ( [Parameter(Mandatory=$True,ValueFromPipelineByPropertyName=$true,ValueFromPipeline=$true,HelpMessage="Specify Uri or array or Uris")] [string[]]$Uri, [Parameter(Mandatory=$true)] [hashtable]$Headers, [int]$Threads = 15, [switch]$Passthru ) Begin{ #initialSessionState will hold typeDatas and functions that will be passed to every runspace. $initialSessionState = [System.Management.Automation.Runspaces.InitialSessionState]::CreateDefault(); #define function to run function Get-RestData { param ( [Parameter(Mandatory=$true,Position=0)][string]$Uri, [Parameter(Mandatory=$False,Position=1)][hashtable]$Headers ) try { $response = Invoke-RestMethod -Uri $Uri -Headers $Headers -Method Get -DisableKeepAlive -ErrorAction Stop } catch { $ex = $_.Exception $errorResponse = $ex.Response.GetResponseStream() $reader = New-Object System.IO.StreamReader($errorResponse) $reader.BaseStream.Position = 0 $reader.DiscardBufferedData() $responseBody = $reader.ReadToEnd(); Write-Error ("{0}: Error Status: {1}; {2}" -f $uri,$ex.Response.StatusCode,$responseBody) } return $response } #add function to the initialSessionState $GetRestData_def = Get-Content Function:\Get-RestData $GetRestDataSessionStateFunction = New-Object System.Management.Automation.Runspaces.SessionStateFunctionEntry -ArgumentList 'Get-RestData', $GetRestData_def $initialSessionState.Commands.Add($GetRestDataSessionStateFunction) #define your TypeData (Makes the output as object later on) $init = @{ MemberName = 'Init'; MemberType = 'ScriptMethod'; Value = { Add-Member -InputObject $this -MemberType NoteProperty -Name uri -Value $null Add-Member -InputObject $this -MemberType NoteProperty -Name headers -Value $null Add-Member -InputObject $this -MemberType NoteProperty -Name rawdata -Value $null }; Force = $true; } # and initiate the function call to add to session state: $populate = @{ MemberName = 'Populate'; MemberType = 'ScriptMethod'; Value = { param ( [Parameter(Mandatory=$true)][string]$Uri, [Parameter(Mandatory=$true)][hashtable]$Headers ) $this.uri = $Uri $this.headers = $Headers $this.rawdata = (Get-RestData -Uri $Uri -Headers $Headers) }; Force = $true; } Update-TypeData -TypeName 'Custom.Object' @Init; Update-TypeData -TypeName 'Custom.Object' @Populate; $customObject_typeEntry = New-Object System.Management.Automation.Runspaces.SessionStateTypeEntry -ArgumentList $(Get-TypeData Custom.Object), $false; $initialSessionState.Types.Add($customObject_typeEntry); #define our main, entry point to runspace $ScriptBlock = { Param ( [PSCustomObject]$Uri, $Headers ) #build object and $page = [PsCustomObject]@{PsTypeName ='Custom.Object'}; $page.Init(); $page.Populate($Uri,$Headers); $Result = New-Object PSObject -Property @{ uri = $page.Uri #value = $page.value value = $page.rawdata.value nextlink = $page.rawdata.'@odata.nextLink' }; return $Result; } #build Runsapce threads $RunspacePool = [RunspaceFactory]::CreateRunspacePool(1, $Threads, $initialSessionState, $Host); $RunspacePool.Open(); $Jobs = @(); } Process{ #START THE JOB $i = 0; foreach($url in $Uri) { #$Uri - some array of uris $i++; #call scriptblock with arguments $Job = [powershell]::Create().AddScript($ScriptBlock).AddArgument($url).AddArgument($Headers); $Job.RunspacePool = $RunspacePool; $Jobs += New-Object PSObject -Property @{ RunNum = $i; Pipe = $Job; Result = $Job.BeginInvoke(); } } } End{ $results = @(); #TEST $job = $jobs foreach ($Job in $Jobs) { $Result = $Job.Pipe.EndInvoke($Job.Result) #add uri to object list if passthru used $Results += $Result } If($Passthru){ Return $Results } Else{ $JobResponses = @() $i=0 $Item = $Results.value[0] Foreach($Item in $Results.value){ $hashtable = @{} foreach( $property in $Item.psobject.properties.name ) { $hashtable[$property] = $Item.$property } $hashtable['uri'] = $Results[$i].uri #$hashtable['type'] = $Results[$i].uri | Split-Path -Leaf -ErrorAction SilentlyContinue $Object = New-Object PSObject -Property $hashtable $JobResponses += $Object $i++ } return $JobResponses } } } |