DatabricksPS

1.9.9.3

Public/WorkspaceConfig.ps1


$script:WorkspaceCconfigKeys = @("enableTokensConfig", "maxTokenLifetimeDays", "enableIpAccessLists", "enableProjectTypeInWorkspace")
Function Get-DatabricksWorkspaceConfig {
  <#
      .SYNOPSIS
      This request gets different information based on what you pass to keys parameter.
      .DESCRIPTION
      This request gets different information based on what you pass to keys parameter.
      Official API Documentation: https://docs.databricks.com/dev-tools/api/latest/token-management.html#operation/get-configuration
      .PARAMETER Keys
      List of keys to retrieve from the workspace config.
      .EXAMPLE
      Get-DatabricksWorkspaceConfig -Keys "enableTokensConfig"
      .EXAMPLE
      Get-DatabricksWorkspaceConfig -Keys "enableIpAccessLists"
  #>
  [CmdletBinding()]
  param
  (
    #[Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [ValidateSet({$script:configKeys})] [Alias("Config", "Key")] [string[]] $Keys
  )
  DynamicParam {
    #Create the RuntimeDefinedParameterDictionary
    $Dictionary = New-Object System.Management.Automation.RuntimeDefinedParameterDictionary
      
    New-DynamicParam -Name Keys -Type string[] -ValidateSet $script:WorkspaceCconfigKeys -Alias "Key" -ValueFromPipelineByPropertyName -DPDictionary $Dictionary
        
    #return RuntimeDefinedParameterDictionary
    return $Dictionary
  }
  begin {
    $requestMethod = "GET"
    $apiEndpoint = "/2.0/workspace-conf"
  }
    
  process {
    if(-not $PSBoundParameters.ContainsKey('Keys'))
    {
      $Keys = $script:WorkspaceCconfigKeys
    }
    else
    {
      $Keys = $PSBoundParameters.Keys
    }
    Write-Verbose "Building Body/Parameters for final API call ..."

    #Set parameters
    $parameters = @{
      keys = $Keys -join ","
    }

    $result = Invoke-DatabricksApiRequest -Method $requestMethod -EndPoint $apiEndpoint -Body $parameters

    return $result
  }
}


Function Set-DatabricksWorkspaceConfig {
  <#
            .SYNOPSIS
            This request sets different workspace settings based on the parameters that you set. For example, enable or disable personal access tokens, or set maximum token lifetime for new tokens. See parameters for details.
            .DESCRIPTION
            This request sets different workspace settings based on the parameters that you set. For example, enable or disable personal access tokens, or set maximum token lifetime for new tokens. See parameters for details.
            Official API Documentation: https://docs.databricks.com/dev-tools/api/latest/token-management.html#operation/set-configuration
            .PARAMETER EnableTokensConfig
            Enable or disable personal access tokens for this workspace.
      .PARAMETER MaxTokenLifetimeDays
            Maximum token lifetime of new tokens in days, as an integer. If zero, new tokens are permitted to have no lifetime limit. Negative numbers are unsupported. WARNING: This limit only applies to new tokens, so there may be tokens with lifetimes longer than this value, including unlimited lifetime. Such tokens may have been created before the current maximum token lifetime was set. To review existing tokens, see the get tokens API.
      .PARAMETER EnableIpAccessLists
            The IP access list feature is enabled for the workspace if true and it is disabled if false. Note that these are String values, not booleans.
      .PARAMETER CustomConfig
      A dictionary containing the settings you want to use.
            .EXAMPLE
            Set-DatabricksWorkspaceConfig -EnableTokensConfig $true
      .EXAMPLE
            Set-DatabricksWorkspaceConfig -MaxTokenLifetimeDays 90
      .EXAMPLE
            Set-DatabricksWorkspaceConfig -EnableIpAccessLists $false
    #>
  [CmdletBinding()]
  param
  (
    [Parameter(ParameterSetName = "Predefined", Mandatory = $false, ValueFromPipelineByPropertyName = $true)] [bool] $EnableTokensConfig,
    [Parameter(ParameterSetName = "Predefined", Mandatory = $false, ValueFromPipelineByPropertyName = $true)] [string] $MaxTokenLifetimeDays,
    [Parameter(ParameterSetName = "Predefined", Mandatory = $false, ValueFromPipelineByPropertyName = $true)] [bool] $EnableIpAccessLists,
    [Parameter(ParameterSetName = "Predefined", Mandatory = $false, ValueFromPipelineByPropertyName = $true)] [bool] $EnableProjectTypeInWorkspace,
    [Parameter(ParameterSetName = "CustomConfig", Mandatory = $true, ValueFromPipelineByPropertyName = $true, ValueFromPipeline = $true)] [hashtable] $CustomConfig
  )
    
  begin {
    $requestMethod = "PATCH"
    $apiEndpoint = "/2.0/workspace-conf"
  }
    
  process {
    Write-Verbose "Building Body/Parameters for final API call ..."

    #Set parameters
    if ($PSCmdlet.ParameterSetName -eq "CustomConfig") {
      $parameters = $CustomConfig
    }
    else {
      $parameters = @{ }

      if($PSBoundParameters.ContainsKey('EnableTokensConfig'))
      { 
        $parameters | Add-Property -Name "enableTokensConfig" -Value $EnableTokensConfig -Force
      }
      if($PSBoundParameters.ContainsKey('MaxTokenLifetimeDays'))
      { 
        $parameters | Add-Property -Name "maxTokenLifetimeDays" -Value $MaxTokenLifetimeDays -Force
      }
      if($PSBoundParameters.ContainsKey('EnableIpAccessLists'))
      { 
        $parameters | Add-Property -Name "enableIpAccessLists" -Value $EnableIpAccessLists.toString().toLower() -Force # has to be a string
      }
      if($PSBoundParameters.ContainsKey('EnableProjectTypeInWorkspace'))
      { 
        $parameters | Add-Property -Name "enableProjectTypeInWorkspace" -Value $EnableProjectTypeInWorkspace
      }
    }

    $result = Invoke-DatabricksApiRequest -Method $requestMethod -EndPoint $apiEndpoint -Body $parameters

    return $result
  }
}