DatabricksDsc.psd1

#
# Module manifest for module 'DatabricksDsc'
#
# Generated by: Gijs Reijn
#
# Generated on: 11/11/2025
#

@{

# Script module or binary module file associated with this manifest.
RootModule = 'DatabricksDsc.psm1'

# Version number of this module.
ModuleVersion = '0.2.0'

# Supported PSEditions
# CompatiblePSEditions = @()

# ID used to uniquely identify this module
GUID = 'ed73147c-3839-4284-9c85-13299b31525e'

# Author of this module
Author = 'Gijs Reijn'

# Company or vendor of this module
CompanyName = 'Gijs Reijn'

# Copyright statement for this module
Copyright = '(c) Gijs Reijn. All rights reserved.'

# Description of the functionality provided by this module
Description = 'This module contains class-based DSC resources for Databricks'

# Minimum version of the PowerShell engine required by this module
PowerShellVersion = '5.0'

# Name of the PowerShell host required by this module
# PowerShellHostName = ''

# Minimum version of the PowerShell host required by this module
# PowerShellHostVersion = ''

# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# DotNetFrameworkVersion = ''

# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# ClrVersion = ''

# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
RequiredModules = @()

# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()

# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = @('Get-DatabricksUser','New-DatabricksUser','Remove-DatabricksUser','Set-DatabricksUser')

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
CmdletsToExport = "*"

# Variables to export from this module
VariablesToExport = @()

# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
AliasesToExport = @()

# DSC resources to export from this module
DscResourcesToExport = @('DatabricksAccountServicePrincipal','DatabricksAccountUser','DatabricksClusterPolicy','DatabricksClusterPolicyPermission','DatabricksServicePrincipal','DatabricksUser')

# List of all modules packaged with this module
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

    PSData = @{

        # Tags applied to this module. These help with module discovery in online galleries.
        # Tags = @()

        # A URL to the license for this module.
        # LicenseUri = ''

        # A URL to the main website for this project.
        # ProjectUri = ''

        # A URL to an icon representing this module.
        # IconUri = ''

        # ReleaseNotes of this module
        ReleaseNotes = '## [0.2.0-preview0002] - 2025-11-19

### Added

- Initial implementation of Databricks User management
  - Added `DatabricksResourceBase` class as the base class for all
    Databricks DSC resources
  - Added `DatabricksUser` DSC resource for managing users in Databricks
    workspace
  - Added complex types: `DatabricksReason`, `UserEmail`, `UserName`,
    `UserEntitlement`, and `UserRole` with `IComparable` and `IEquatable`
    implementations for proper comparison and sorting
  - Added `IpAccessList` DSC resource as a simple demonstration resource
  - Added public commands:
    - `Get-DatabricksUser` - Retrieve users from workspace
    - `New-DatabricksUser` - Create new users in workspace
    - `Set-DatabricksUser` - Update existing users in workspace
    - `Remove-DatabricksUser` - Remove users from workspace
  - Added private functions:
    - `ConvertTo-DatabricksAuthHeader` - Convert SecureString to Bearer token
  - Added localization support for all resources and commands
  - Complex types now implement `Equals()`, `CompareTo()`, and `ToString()`
    methods for proper comparison and display
  - Added unit tests for all complex type classes:
    - `DatabricksReason.Tests.ps1`
    - `UserEmail.Tests.ps1`
    - `UserName.Tests.ps1`
    - `UserEntitlement.Tests.ps1`
    - `UserRole.Tests.ps1`
  - Added unit tests for all public commands:
    - `Get-DatabricksUser.Tests.ps1`
    - `New-DatabricksUser.Tests.ps1`
    - `Set-DatabricksUser.Tests.ps1`
    - `Remove-DatabricksUser.Tests.ps1`
  - Added unit tests for all private functions:
    - `ConvertTo-DatabricksAuthHeader.Tests.ps1`
    - `UserName.Tests.ps1`
    - `UserEntitlement.Tests.ps1`
    - `UserRole.Tests.ps1`
- Added `DatabricksClusterPolicyPermission` DSC resource for managing
  cluster policy permissions in Databricks workspace
  - Added `ClusterPolicyAccessControlEntry` complex type with `IComparable`
    and `IEquatable` implementations for proper comparison and sorting
  - Supports user, group, and service principal permissions
  - Automatically detects principal type based on format (@ for users,
    GUID for service principals)
  - Added comprehensive unit tests for `DatabricksClusterPolicyPermission`
    covering all methods and validation logic
- Added `DatabricksServicePrincipal` DSC resource for managing service
  principals via SCIM API
  - Uses `ApplicationId` (GUID) as the key property
  - Supports SCIM 2.0 PatchOp format for updates
  - Reuses `UserEntitlement` and `UserRole` complex types
  - Includes GUID validation for ApplicationId
  - Added localization strings for all operations
  - Added comprehensive unit tests covering all methods and SCIM operations
- Updated `DatabricksUser` resource to use SCIM 2.0 PatchOp format for
  PATCH operations
  - Added `BuildUserPatchPayload()` method with proper SCIM schemas and
    Operations array structure
  - Added unit tests for SCIM PatchOp payload generation
  - Supports CAN_USE permission level
  - Uses PUT for creating permissions and PATCH for updating
  - Supports removing all permissions by setting `_exist` to `$false`
  - Added unit tests for complex types:
    - `ClusterPolicyAccessControlEntry.Tests.ps1`
    - `ClusterPolicyPermissionTypes.Tests.ps1`
- Added account-level resources for managing users and service principals
  across all workspaces in a Databricks account:
  - Added `DatabricksAccountUser` DSC resource for account-level user management
    - Uses account-level SCIM API: `/api/2.0/accounts/{account_id}/scim/v2/Users`
    - Requires `AccountId` (UUID) as additional key property
    - Does not support entitlements (account-level limitation)
    - Supports roles for admin assignments
    - Uses SCIM 2.0 PatchOp format for updates
    - Added localization strings for all operations
    - Added comprehensive unit tests (~1100 lines) covering all methods
  - Added `DatabricksAccountServicePrincipal` DSC resource for account-level
    service principal management
    - Uses account-level SCIM API: `/api/2.0/accounts/{account_id}/scim/v2/ServicePrincipals`
    - Requires `AccountId` (UUID) as additional key property
    - Uses `ApplicationId` (GUID) as the key identifier
    - Does not support entitlements (account-level limitation)
    - Supports roles for admin assignments
    - Uses SCIM 2.0 PatchOp format for updates
    - Added localization strings for all operations
    - Added comprehensive unit tests (~950 lines) covering all methods
  - Both account-level resources have `ExternalId` as read-only property
  - Updated help documentation for workspace-level resources to clarify scope
    and reference account-level alternatives

### Changed

- For changes in existing functionality.

### Deprecated

- For soon-to-be removed features.

### Removed

- For now removed features.

### Fixed

- For any bug fix.

### Security

- In case of vulnerabilities.
'


        # Prerelease string of this module
        Prerelease =  'preview0002'

        # Flag to indicate whether the module requires explicit user acceptance for install/update/save
        # RequireLicenseAcceptance = $false

        # External dependent modules of this module
        # ExternalModuleDependencies = @()

    } # End of PSData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module
# HelpInfoURI = ''

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}