Parameters (Connect-Databricks Cmdlet)
The following is the full list of the parameters of the cmdlet with short descriptions. Click the links for further details.
| Property | Description |
| AuthScheme | Specifies the authentication scheme that the provider uses to connect to Databricks. |
| Server | Specifies the host name of your Databricks workspace or SQL warehouse endpoint. |
| ProtocolVersion | Specifies the protocol version used by the provider when authenticating and exchanging data with Databricks. |
| Database | Specifies the name of the database in Databricks that the provider uses for the connection. |
| HTTPPath | Specifies the HTTP path for the compute resource in Databricks that the provider connects to. |
| Token | Specifies the personal access token used by the provider to authenticate to Databricks. |
| Property | Description |
| AWSAccessKey | Specifies your AWS account access key. This value is accessible from your AWS security credentials page. |
| AWSSecretKey | Your AWS account secret key. This value is accessible from your AWS security credentials page. |
| AWSRegion | The hosting region for your Amazon Web Services. |
| AWSS3Bucket | Specifies the name of the AWS S3 bucket that the provider uses for staging or transferring data when connecting to Databricks. |
| Property | Description |
| AzureStorageAccount | The name of your Azure storage account. |
| AzureAccessKey | The storage key associated with your Azure account. |
| AzureTenant | Identifies the Databricks tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID. |
| AzureBlobContainer | Specifies the name of the Azure Blob Storage container that the provider uses for staging or transferring data when connecting to Databricks. |
AzureServicePrincipalAuthentication
| Property | Description |
| AzureTenantId | Specifies the directory (tenant) ID of your Microsoft Entra ID that the provider uses to authenticate to Databricks. |
| AzureClientId | Specifies the application (client) ID of the Microsoft Entra ID application that the provider uses to authenticate to Databricks. |
| AzureClientSecret | Specifies the client secret for the Microsoft Entra ID application that the provider uses to authenticate to Databricks. |
| Property | Description |
| InitiateOAuth | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| OAuthAccessToken | Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange. |
| OAuthSettingsLocation | Specifies the location of the settings file where OAuth values are saved. |
| CallbackURL | Identifies the URL users return to after authenticating to Databricks via OAuth (Custom OAuth applications only). |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
| OAuthVerifier | Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set. |
| OAuthRefreshToken | Specifies the OAuth refresh token used to request a new access token after the original has expired. |
| OAuthExpiresIn | Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working. |
| OAuthTokenTimestamp | Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created. |
| OAuthLevel | Specifies whether the provider performs OAuth authentication at the workspace level or at the account level in Databricks. |
| DatabricksAccountId | Specifies the unique account ID for your Databricks account. |
| Property | Description |
| SSLClientCert | Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection. |
| SSLClientCertType | Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source. |
| SSLClientCertPassword | Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access. |
| SSLClientCertSubject | Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store. |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| Logfile | Specifes the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details. |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| MaxLogFileSize | Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name. |
| MaxLogFileCount | Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Catalog | Specifies the default catalog that the provider uses when connecting to Databricks. |
| PrimaryKeyIdentifiers | Specifies primary keys for tables in the hive_metastore catalog. |
| Property | Description |
| AutoCache | Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | Notes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True. |
| Offline | Gets the data from the specified cache database instead of live Databricks data. |
| CacheMetadata | Determines whether the provider caches table metadata to a file-based cache database. |
| Property | Description |
| CloudStorageType | Specifies which cloud storage service the provider uses for staging or transferring data. |
| StoreTableInCloud | Specifies whether the Databricks server creates and stores new tables in external cloud storage instead of the Databricks File System (DBFS). |
| QueryTableDetails | Specifies whether the provider uses the DESCRIBE FORMATTED command in Databricks to retrieve detailed table metadata. |
| UseUploadApi | Specifies whether the provider uses the Databricks Upload API to optimize Bulk INSERT operations. |
| UseCloudFetch | Specifies whether the provider uses CloudFetch to optimize data transfer for large query result sets in Databricks. |
| SupportMultiCatalog | Specifies whether the provider enables multi-catalog support for Unity Catalog in Databricks. |
| QueryAllMetadata | Specifies whether the provider retrieves metadata from all available catalogs and schemas in Databricks or only from those specified in the connection. |
| CheckSQLWarehouseAvailability | Specifies whether the provider checks the availability of the SQL Warehouse in Databricks before establishing a connection. |
| Property | Description |
| AllowPreparedStatement | Specifies whether the provider prepares SQL statements before executing them to improve performance on repeated queries. |
| ConnectRetryWaitTime | Specifies the number of seconds the provider waits before retrying a connection request. |
| ApplicationName | Specifies the application name that the provider includes in the HTTP User-Agent header when connecting to Databricks. |
| AsyncQueryTimeout | Specifies the number of seconds the provider waits for asynchronous requests that retrieve large result sets before timing out. |
| DefaultColumnSize | Specifies the default length, in characters, of string fields when the provider cannot determine a size from metadata. |
| DescribeCommand | Specifies which command the provider uses to retrieve metadata from Databricks. |
| DetectView | Specifies whether the provider uses the DESCRIBE FORMATTED command to determine whether an object in Databricks is a table or a view. |
| IncludeSystemSchemas | Specifies whether to include the system catalog 'system' and system schema 'information_schema'. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| QueryPassthrough | This option passes the query to the Databricks server as is. |
| Readonly | Toggles read-only access to Databricks from the provider. |
| RTK | Specifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key. |
| ServerConfigurations | Specifies configuration variables to override the default settings on the Databricks server. |
| ServerTimeZone | Specifies how the provider interprets datetime values returned from Databricks. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UseDescTableQuery | Specifies whether the provider retrieves table column metadata using a DESC TABLE query instead of the Thrift API. |
| UseInsertSelectSyntax | DEPRECATED. This property is no longer supported, and should not be used. It will be removed in a future release. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |