< Back
New-AzureDatabricksConnection
Post
NAME New-AzureDatabricksConnection
SYNOPSIS
Extablishes a connection to an Azure Databricks instance via a predefined access token and base API URL.
SYNTAX
New-AzureDatabricksConnection [-BaseURI] <Uri> [-AccessToken] <String> [[-Protocol] <String>] [-UseBasicParsing]
[<CommonParameters>]
DESCRIPTION
This function returns a connection object that is required for all other functions in this module, and this
function should be the first thing you
call to return a connection object. Supports PS5 and PSCore 6, and different TLS configurations for HTTPS.
PARAMETERS
-BaseURI <Uri>
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AccessToken <String>
Your Azure Databricks access token. You'll need one of these before you start. Details here:
https://docs.databricks.com/api/latest/ ... te-a-token
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Protocol <String>
If needed you can specify a TLS or SSL protocol, or "All." Use this if you receive certificate and/or HTTPS
errors with your current security settings.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UseBasicParsing [<SwitchParameter>]
A pass-thru parameter for the underlying Invoke-WebRequest functions these functions rely on. Use if needed.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Author: Drew Furgiuele (@pittfurg), http://www.port1433.com
Website: https://www.igs.com
Copyright: (c) 2019 by IGS, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$Connection = New-AzureDatabricksConnection -BaseURI https://eastus2.azuredatabricks.net -AccessToken x
Creates a new connection object in $Connection that contains your base URI and API key for all other functions in
the module.
RELATED LINKS
SYNOPSIS
Extablishes a connection to an Azure Databricks instance via a predefined access token and base API URL.
SYNTAX
New-AzureDatabricksConnection [-BaseURI] <Uri> [-AccessToken] <String> [[-Protocol] <String>] [-UseBasicParsing]
[<CommonParameters>]
DESCRIPTION
This function returns a connection object that is required for all other functions in this module, and this
function should be the first thing you
call to return a connection object. Supports PS5 and PSCore 6, and different TLS configurations for HTTPS.
PARAMETERS
-BaseURI <Uri>
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AccessToken <String>
Your Azure Databricks access token. You'll need one of these before you start. Details here:
https://docs.databricks.com/api/latest/ ... te-a-token
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Protocol <String>
If needed you can specify a TLS or SSL protocol, or "All." Use this if you receive certificate and/or HTTPS
errors with your current security settings.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UseBasicParsing [<SwitchParameter>]
A pass-thru parameter for the underlying Invoke-WebRequest functions these functions rely on. Use if needed.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Author: Drew Furgiuele (@pittfurg), http://www.port1433.com
Website: https://www.igs.com
Copyright: (c) 2019 by IGS, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$Connection = New-AzureDatabricksConnection -BaseURI https://eastus2.azuredatabricks.net -AccessToken x
Creates a new connection object in $Connection that contains your base URI and API key for all other functions in
the module.
RELATED LINKS