AuthScheme Parameter (Connect-Databricks Cmdlet)
The authentication scheme used. Accepted entries are PersonalAccessToken, Basic, OAuthU2M, AzureServicePrincipal and AzureAD.
Syntax
Connect-Databricks -AuthScheme string
Possible Values
PersonalAccessToken, Basic, OAuthU2M, OAuthM2M, AzureServicePrincipal, AzureADData Type
cstr
Default Value
"PersonalAccessToken"
Remarks
The cmdlet supports the following authentication mechanisms. See the Getting Started chapter for authentication guides.
- PersonalAccessToken: Set this to authenticate with Databricks' access token.
- Basic: Set this to authenticate with Databricks' user and access token.
- OAuthU2M: Set this along with OAuthLevel and DatabricksAccountId(optional) to authenticate with Databricks' OAuth user-to-machine (U2M).
- OAuthM2M: Set this along with OAuthLevel, DatabricksAccountId(optional), OAuthClientId and OAuthClientSecret to authenticate with Databricks' OAuth machine-to-machine (M2M). The OAuthClientId and OAuthClientSecret can be generated by creating a Databricks service principal.
- AzureServicePrincipal: Set this along with AzureTenantId, AzureClientId and AzureClientSecret to authenticate with the Azure Service Principal. You should follow the instructions in https://docs.microsoft.com/en-us/azure/databricks/dev-tools/api/latest/aad/service-prin-aad-token#--provision-a-service-principal-in-azure-portal to register an AzureAD application(client), and then follow the instructions in https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal?tabs=current to make sure that the service principal is assigned the Contributor or Owner role on the target Databricks workspace resource in Azure.
- AzureAD: Set this along with AzureTenant, OAuthClientId and CallbackURL to authenticate with the Azure Active Directory OAuth. You should follow the instructions in Configure an app in Azure portal to register an AzureAD application (client).