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.4.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 = @('DatabricksAccountMetastoreAssignment','DatabricksAccountServicePrincipal','DatabricksAccountUser','DatabricksAccountWorkspacePermissionAssignment','DatabricksClusterPolicy','DatabricksClusterPolicyPermission','DatabricksGroup','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.4.0-preview0002] - 2025-11-23 ### Added - Added `DatabricksGroup` resource for managing groups in a Databricks workspace - Manages groups using the workspace-level SCIM API v2 - Key property: `DisplayName` (unique identifier) - Properties: `ExternalId`, `Members`, `Entitlements`, `Roles`, and read-only `Groups` (parent groups) - Supports create, update, and delete operations - Uses workspace-level SCIM API endpoints: - POST: `/api/2.0/preview/scim/v2/Groups` for create - GET: `/api/2.0/preview/scim/v2/Groups` for list/read - PATCH: `/api/2.0/preview/scim/v2/Groups/{id}` for update (SCIM PatchOp format) - DELETE: `/api/2.0/preview/scim/v2/Groups/{id}` for remove - Implements complex types: `GroupMember`, `GroupEntitlement`, `GroupRole`, and `ParentGroup` following SCIM schema - Members can be users or other groups (nested groups) - Entitlements support values: `allow-cluster-create`, `allow-instance-pool-create`, `workspace-access`, `databricks-sql-access` - Roles support AWS instance profile ARNs - Groups property shows parent groups (read-only, cannot be set directly) - All array properties are sorted for consistent comparison - Validates WorkspaceUrl format (must start with https://) - Validates DisplayName is not empty - Includes comprehensive unit tests (40+ tests) covering all methods and scenarios - Implements Export functionality: - `GetAllResourcesFromApi()` retrieves all groups from workspace - `CreateExportInstance()` converts API group data to resource instances - `Export([FilteringInstance])` supports filtering by any property - Export() without parameters throws error requiring authentication - Added localization strings for all operations (DG0001-DG0018) - Added `DatabricksAccountWorkspacePermissionAssignment` resource for managing workspace permission assignments at the account level - Manages permission assignments for principals (users, service principals, or groups) at the workspace level - Key properties: `AccountId`, `WorkspaceId`, `PrincipalId`, and `Permissions` - Supports assignment (create/update via PUT) and unassignment (DELETE) - Uses account-level API endpoints: - GET: `/api/2.0/accounts/{account_id}/workspaces/{workspace_id}/permissionassignments` - PUT: `/api/2.0/accounts/{account_id}/workspaces/{workspace_id}/permissionassignments/principals/{principal_id}` - DELETE: `/api/2.0/accounts/{account_id}/workspaces/{workspace_id}/permissionassignments/principals/{principal_id}` - Validates AccountId as GUID, WorkspaceId and PrincipalId as numeric - Supports WorkspacePermissionLevel enum with User and Admin values - Handles API response structure with `principal.principal_id` for identification and `permissions` as string array - Includes comprehensive unit tests covering all methods and scenarios - Added localization strings for all operations (DAWPA0001-DAWPA0015) - Added `WorkspacePermissionLevel` enum for workspace permission levels - Supported values: User and Admin - Used by `DatabricksAccountWorkspacePermissionAssignment` resource - Added `DatabricksAccountMetastoreAssignment` resource for managing Unity Catalog metastore assignments to workspaces - Manages workspace-to-metastore assignments at the account level - Key properties: `AccountId`, `WorkspaceId`, and `MetastoreId` - Supports assignment (create/update via PUT) and unassignment (DELETE) - Uses account-level API endpoints: - GET: `/api/2.0/accounts/{account_id}/workspaces/{workspace_id}/metastore` - POST: `/api/2.0/accounts/{account_id}/workspaces/{workspace_id}/metastores` - DELETE: `/api/2.0/accounts/{account_id}/workspaces/{workspace_id}/metastores/{metastore_id}` - Validates AccountId and MetastoreId as GUIDs, WorkspaceId as numeric - Includes comprehensive unit tests with 32 test cases covering all methods and scenarios - Implements Export functionality: - `GetAllResourcesFromApi()` retrieves all workspace assignments for a metastore using GET `/api/2.0/accounts/{account_id}/metastores/{metastore_id}/workspaces` - `CreateExportInstance()` converts API workspace assignment data to resource instances - `Export([FilteringInstance])` supports filtering by WorkspaceId - Requires AccountId and MetastoreId to be set in the filtering instance - Added localization strings for export operations (DAMA0016-DAMA0019) - Added 7 unit tests for Export functionality covering all scenarios - Added `DatabricksAccountResourceBase` intermediate base class for account-level DSC resources - Inherits from `DatabricksResourceBase` and provides specialized functionality for account-level operations - Introduces `AccountsUrl` property with default value `https://accounts.azuredatabricks.net` - Constructor automatically sets `WorkspaceUrl` from `AccountsUrl` for base class compatibility - Simplifies configuration for account-level resources by providing sensible defaults - Account-level resources (`DatabricksAccountUser`, `DatabricksAccountServicePrincipal`, `DatabricksAccountMetastoreAssignment`) now inherit from this base class - Added `_exist` property to all account-level resources - `DatabricksAccountUser`, `DatabricksAccountServicePrincipal`, and `DatabricksAccountMetastoreAssignment` now include the `_exist` property - Defaults to `$true` for proper existence management - Enables proper handling of resource presence/absence in desired state - Added configuration examples for `DatabricksAccountMetastoreAssignment` resource - Example 001: Basic metastore assignment to workspace - Example 002: Remove metastore assignment from workspace ### Fixed - Fixed `DatabricksClusterPolicy` resource examples to use hashtable format for the `Definition` property instead of JSON string - Updated all three examples (basic, complete, and user limit) to demonstrate proper hashtable usage with YAML syntax - Makes examples more readable and easier to maintain - Fixed `DatabricksAccountMetastoreAssignment` to correctly parse API response - Updated to handle nested `metastore_assignment` object structure from API - Checks `$response.metastore_assignment.metastore_id` instead of flat structure - Updated unit test mocks to match actual API response format ' # 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 = '' } |