DSCResources/MSFT_AADRoleDefinition/MSFT_AADRoleDefinition.psm1
|
function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [System.String] $DisplayName, [Parameter()] [System.String] $Id, [Parameter()] [System.String] $Description, [Parameter()] [System.String[]] $ResourceScopes, [Parameter(Mandatory = $true)] [System.Boolean] $IsEnabled, [Parameter(Mandatory = $true)] [System.String[]] $RolePermissions, [Parameter()] [System.String] $TemplateId, [Parameter()] [System.String] $Version, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.Management.Automation.PSCredential] $ApplicationSecret, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [Switch] $ManagedIdentity ) Write-Verbose -Message 'Getting configuration of Azure AD role definition' $ConnectionMode = New-M365DSCConnection -Workload 'MicrosoftGraph' ` -InboundParameters $PSBoundParameters #Ensure the proper dependencies are installed in the current environment. Confirm-M365DSCDependencies #region Telemetry $ResourceName = $MyInvocation.MyCommand.ModuleName -replace 'MSFT_', '' $CommandName = $MyInvocation.MyCommand $data = Format-M365DSCTelemetryParameters -ResourceName $ResourceName ` -CommandName $CommandName ` -Parameters $PSBoundParameters Add-M365DSCTelemetryEvent -Data $data #endregion $nullReturn = $PSBoundParameters $nullReturn.Ensure = 'Absent' try { try { if (($null -ne $Id) -and ($Id -ne '')) { if ($null -ne $Script:exportedInstances -and $Script:ExportMode) { $AADRoleDefinition = $Script:exportedInstances | Where-Object -FilterScript {$_.Id -eq $Id} } else { $AADRoleDefinition = Get-MgBetaRoleManagementDirectoryRoleDefinition -Filter "Id eq '$($Id)'" } } } catch { Write-Verbose -Message "Could not retrieve AAD roledefinition by Id: {$Id}" } if ($null -eq $AADRoleDefinition) { if ($null -ne $Script:exportedInstances -and $Script:ExportMode) { $AADRoleDefinition = $Script:exportedInstances | Where-Object -FilterScript {$_.DisplayName -eq $DisplayName} } else { $AADRoleDefinition = Get-MgBetaRoleManagementDirectoryRoleDefinition -Filter "DisplayName eq '$($DisplayName)'" } } if ($null -eq $AADRoleDefinition) { return $nullReturn } else { $result = @{ Id = $AADRoleDefinition.Id DisplayName = $AADRoleDefinition.DisplayName Description = $AADRoleDefinition.Description ResourceScopes = $AADRoleDefinition.ResourceScopes IsEnabled = $AADRoleDefinition.IsEnabled RolePermissions = $AADRoleDefinition.RolePermissions.AllowedResourceActions TemplateId = $AADRoleDefinition.TemplateId Version = $AADRoleDefinition.Version Ensure = 'Present' Credential = $Credential ApplicationId = $ApplicationId ApplicationSecret = $ApplicationSecret TenantId = $TenantId CertificateThumbprint = $CertificateThumbprint Managedidentity = $ManagedIdentity.IsPresent } Write-Verbose -Message "Get-TargetResource Result: `n $(Convert-M365DscHashtableToString -Hashtable $result)" return $result } } catch { New-M365DSCLogEntry -Message 'Error retrieving data:' ` -Exception $_ ` -Source $($MyInvocation.MyCommand.Source) ` -TenantId $TenantId ` -Credential $Credential return $nullReturn } } function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $DisplayName, [Parameter()] [System.String] $Id, [Parameter()] [System.String] $Description, [Parameter()] [System.String[]] $ResourceScopes, [Parameter(Mandatory = $true)] [System.Boolean] $IsEnabled, [Parameter(Mandatory = $true)] [System.String[]] $RolePermissions, [Parameter()] [System.String] $TemplateId, [Parameter()] [System.String] $Version, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.Management.Automation.PSCredential] $ApplicationSecret, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [Switch] $ManagedIdentity ) Write-Verbose -Message 'Setting configuration of Azure AD role definition' #Ensure the proper dependencies are installed in the current environment. Confirm-M365DSCDependencies #region Telemetry $ResourceName = $MyInvocation.MyCommand.ModuleName -replace 'MSFT_', '' $CommandName = $MyInvocation.MyCommand $data = Format-M365DSCTelemetryParameters -ResourceName $ResourceName ` -CommandName $CommandName ` -Parameters $PSBoundParameters Add-M365DSCTelemetryEvent -Data $data #endregion $currentAADRoleDef = Get-TargetResource @PSBoundParameters $currentParameters = $PSBoundParameters $currentParameters.Remove('ApplicationId') | Out-Null $currentParameters.Remove('RolePermissions') | Out-Null $currentParameters.Remove('ResourceScopes') | Out-Null $currentParameters.Remove('TenantId') | Out-Null $currentParameters.Remove('CertificateThumbprint') | Out-Null $currentParameters.Remove('ManagedIdentity') | Out-Null $currentParameters.Remove('Credential') | Out-Null $currentParameters.Remove('Ensure') | Out-Null $rolePermissionsObj = @() $rolePermissionsObj += @{'allowedResourceActions' = $rolePermissions } $resourceScopesObj = @() $resourceScopesObj += $ResourceScopes $currentParameters.Add('RolePermissions', $rolePermissionsObj) | Out-Null if ($ResourceScopes.Length -gt 0) { $currentParameters.Add('ResourceScopes', $resourceScopesObj) | Out-Null } # Role definition should exist but it doesn't if ($Ensure -eq 'Present' -and $currentAADRoleDef.Ensure -eq 'Absent') { Write-Verbose -Message "Creating New AzureAD role defition {$DisplayName} with parameters:" Write-Verbose -Message (Convert-M365DscHashtableToString -Hashtable $currentParameters) $currentParameters.Remove('Id') | Out-Null New-MgBetaRoleManagementDirectoryRoleDefinition @currentParameters } # Role definition should exist and will be configured to desired state if ($Ensure -eq 'Present' -and $currentAADRoleDef.Ensure -eq 'Present') { Write-Verbose -Message "Updating existing AzureAD role definition {$DisplayName}" $currentParameters.Add('UnifiedRoleDefinitionId', $currentAADRoleDef.Id) $currentParameters.Remove('Id') | Out-Null Update-MgBetaRoleManagementDirectoryRoleDefinition @currentParameters } # Role definition exists but should not elseif ($Ensure -eq 'Absent' -and $currentAADRoleDef.Ensure -eq 'Present') { Write-Verbose -Message "Removing AzureAD role definition {$DisplayName}" Remove-MgBetaRoleManagementDirectoryRoleDefinition -UnifiedRoleDefinitionId $currentAADRoleDef.Id } } function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [System.String] $DisplayName, [Parameter()] [System.String] $Id, [Parameter()] [System.String] $Description, [Parameter()] [System.String[]] $ResourceScopes, [Parameter(Mandatory = $true)] [System.Boolean] $IsEnabled, [Parameter(Mandatory = $true)] [System.String[]] $RolePermissions, [Parameter()] [System.String] $TemplateId, [Parameter()] [System.String] $Version, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.Management.Automation.PSCredential] $ApplicationSecret, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [Switch] $ManagedIdentity ) #Ensure the proper dependencies are installed in the current environment. Confirm-M365DSCDependencies #region Telemetry $ResourceName = $MyInvocation.MyCommand.ModuleName -replace 'MSFT_', '' $CommandName = $MyInvocation.MyCommand $data = Format-M365DSCTelemetryParameters -ResourceName $ResourceName ` -CommandName $CommandName ` -Parameters $PSBoundParameters Add-M365DSCTelemetryEvent -Data $data #endregion Write-Verbose -Message 'Testing configuration of AzureAD role definition' $CurrentValues = Get-TargetResource @PSBoundParameters Write-Verbose -Message "Current Values: $(Convert-M365DscHashtableToString -Hashtable $CurrentValues)" Write-Verbose -Message "Target Values: $(Convert-M365DscHashtableToString -Hashtable $PSBoundParameters)" $ValuesToCheck = $PSBoundParameters $ValuesToCheck.Remove('Id') | Out-Null $ValuesToCheck.Remove('TemplateId') | Out-Null $TestResult = Test-M365DSCParameterState -CurrentValues $CurrentValues ` -Source $($MyInvocation.MyCommand.Source) ` -DesiredValues $PSBoundParameters ` -ValuesToCheck $ValuesToCheck.Keys Write-Verbose -Message "Test-TargetResource returned $TestResult" return $TestResult } function Export-TargetResource { [CmdletBinding()] [OutputType([System.String])] param ( [Parameter()] [System.String] $Filter, [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.Management.Automation.PSCredential] $ApplicationSecret, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [Switch] $ManagedIdentity ) $ConnectionMode = New-M365DSCConnection -Workload 'MicrosoftGraph' ` -InboundParameters $PSBoundParameters #Ensure the proper dependencies are installed in the current environment. Confirm-M365DSCDependencies #region Telemetry $ResourceName = $MyInvocation.MyCommand.ModuleName -replace 'MSFT_', '' $CommandName = $MyInvocation.MyCommand $data = Format-M365DSCTelemetryParameters -ResourceName $ResourceName ` -CommandName $CommandName ` -Parameters $PSBoundParameters Add-M365DSCTelemetryEvent -Data $data #endregion $dscContent = '' $i = 1 try { $Script:ExportMode = $true [array] $Script:exportedInstances = Get-MgBetaRoleManagementDirectoryRoleDefinition -Filter $Filter -All:$true -ErrorAction Stop if ($Script:exportedInstances.Length -gt 0) { Write-Host "`r`n" -NoNewline } foreach ($AADRoleDefinition in $Script:exportedInstances) { Write-Host " |---[$i/$($Script:exportedInstances.Count)] $($AADRoleDefinition.DisplayName)" -NoNewline $Params = @{ Credential = $Credential ApplicationId = $ApplicationId ApplicationSecret = $ApplicationSecret TenantId = $TenantId CertificateThumbprint = $CertificateThumbprint Managedidentity = $ManagedIdentity.IsPresent DisplayName = $AADRoleDefinition.DisplayName Id = $AADRoleDefinition.Id IsEnabled = $true RolePermissions = @('temp') } $Results = Get-TargetResource @Params if ($Results.Ensure -eq 'Present' -and ([array]$results.RolePermissions).Length -gt 0) { $Results = Update-M365DSCExportAuthenticationResults -ConnectionMode $ConnectionMode ` -Results $Results $currentDSCBlock = Get-M365DSCExportContentForResource -ResourceName $ResourceName ` -ConnectionMode $ConnectionMode ` -ModulePath $PSScriptRoot ` -Results $Results ` -Credential $Credential $dscContent += $currentDSCBlock Save-M365DSCPartialExport -Content $currentDSCBlock ` -FileName $Global:PartialExportFileName } Write-Host $Global:M365DSCEmojiGreenCheckMark $i++ } return $dscContent } catch { Write-Host $Global:M365DSCEmojiRedX New-M365DSCLogEntry -Message 'Error during Export:' ` -Exception $_ ` -Source $($MyInvocation.MyCommand.Source) ` -TenantId $TenantId ` -Credential $Credential return '' } } Export-ModuleMember -Function *-TargetResource |