@Generated public class AccountClient extends Object
Constructor and Description |
---|
AccountClient() |
AccountClient(boolean mock)
Constructor for mocks
|
AccountClient(DatabricksConfig config) |
Modifier and Type | Method and Description |
---|---|
AccountAccessControlAPI |
accessControl()
These APIs manage access rules on resources in an account.
|
ApiClient |
apiClient() |
BillableUsageAPI |
billableUsage()
This API allows you to download billable usage logs for the specified account and date range.
|
BudgetsAPI |
budgets()
These APIs manage budget configuration including notifications for exceeding a budget for a
period.
|
DatabricksConfig |
config() |
CredentialsAPI |
credentials()
These APIs manage credential configurations for this workspace.
|
CustomAppIntegrationAPI |
customAppIntegration()
These APIs enable administrators to manage custom oauth app integrations, which is required for
adding/using Custom OAuth App Integration like Tableau Cloud for Databricks in AWS cloud.
|
EncryptionKeysAPI |
encryptionKeys()
These APIs manage encryption key configurations for this workspace (optional).
|
WorkspaceClient |
getWorkspaceClient(Workspace workspace) |
AccountGroupsAPI |
groups()
Groups simplify identity management, making it easier to assign access to Databricks account,
data, and other securable objects.
|
AccountIpAccessListsAPI |
ipAccessLists()
The Accounts IP Access List API enables account admins to configure IP access lists for access
to the account console.
|
LogDeliveryAPI |
logDelivery()
These APIs manage log delivery configurations for this account.
|
AccountMetastoreAssignmentsAPI |
metastoreAssignments()
These APIs manage metastore assignments to a workspace.
|
AccountMetastoresAPI |
metastores()
These APIs manage Unity Catalog metastores for an account.
|
NetworkConnectivityAPI |
networkConnectivity()
These APIs provide configurations for the network connectivity of your workspaces for
serverless compute resources.
|
NetworksAPI |
networks()
These APIs manage network configurations for customer-managed VPCs (optional).
|
OAuthPublishedAppsAPI |
oAuthPublishedApps()
These APIs enable administrators to view all the available published OAuth applications in
Databricks.
|
PrivateAccessAPI |
privateAccess()
These APIs manage private access settings for this account.
|
PublishedAppIntegrationAPI |
publishedAppIntegration()
These APIs enable administrators to manage published oauth app integrations, which is required
for adding/using Published OAuth App Integration like Tableau Desktop for Databricks in AWS
cloud.
|
AccountServicePrincipalsAPI |
servicePrincipals()
Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD
platforms.
|
ServicePrincipalSecretsAPI |
servicePrincipalSecrets()
These APIs enable administrators to manage service principal secrets.
|
AccountSettingsAPI |
settings()
Accounts Settings API allows users to manage settings at the account level.
|
StorageAPI |
storage()
These APIs manage storage configurations for this workspace.
|
AccountStorageCredentialsAPI |
storageCredentials()
These APIs manage storage credentials for a particular metastore.
|
AccountUsersAPI |
users()
User identities recognized by Databricks and represented by email addresses.
|
VpcEndpointsAPI |
vpcEndpoints()
These APIs manage VPC endpoint configurations for this account.
|
AccountClient |
withAccessControlAPI(AccountAccessControlAPI accountAccessControl)
Replace the default AccountAccessControlAPI with a custom implementation.
|
AccountClient |
withAccessControlImpl(AccountAccessControlService accountAccessControl)
Replace the default AccountAccessControlService with a custom implementation.
|
AccountClient |
withBillableUsageAPI(BillableUsageAPI billableUsage)
Replace the default BillableUsageAPI with a custom implementation.
|
AccountClient |
withBillableUsageImpl(BillableUsageService billableUsage)
Replace the default BillableUsageService with a custom implementation.
|
AccountClient |
withBudgetsAPI(BudgetsAPI budgets)
Replace the default BudgetsAPI with a custom implementation.
|
AccountClient |
withBudgetsImpl(BudgetsService budgets)
Replace the default BudgetsService with a custom implementation.
|
AccountClient |
withCredentialsAPI(CredentialsAPI credentials)
Replace the default CredentialsAPI with a custom implementation.
|
AccountClient |
withCredentialsImpl(CredentialsService credentials)
Replace the default CredentialsService with a custom implementation.
|
AccountClient |
withCustomAppIntegrationAPI(CustomAppIntegrationAPI customAppIntegration)
Replace the default CustomAppIntegrationAPI with a custom implementation.
|
AccountClient |
withCustomAppIntegrationImpl(CustomAppIntegrationService customAppIntegration)
Replace the default CustomAppIntegrationService with a custom implementation.
|
AccountClient |
withEncryptionKeysAPI(EncryptionKeysAPI encryptionKeys)
Replace the default EncryptionKeysAPI with a custom implementation.
|
AccountClient |
withEncryptionKeysImpl(EncryptionKeysService encryptionKeys)
Replace the default EncryptionKeysService with a custom implementation.
|
AccountClient |
withGroupsAPI(AccountGroupsAPI accountGroups)
Replace the default AccountGroupsAPI with a custom implementation.
|
AccountClient |
withGroupsImpl(AccountGroupsService accountGroups)
Replace the default AccountGroupsService with a custom implementation.
|
AccountClient |
withIpAccessListsAPI(AccountIpAccessListsAPI accountIpAccessLists)
Replace the default AccountIpAccessListsAPI with a custom implementation.
|
AccountClient |
withIpAccessListsImpl(AccountIpAccessListsService accountIpAccessLists)
Replace the default AccountIpAccessListsService with a custom implementation.
|
AccountClient |
withLogDeliveryAPI(LogDeliveryAPI logDelivery)
Replace the default LogDeliveryAPI with a custom implementation.
|
AccountClient |
withLogDeliveryImpl(LogDeliveryService logDelivery)
Replace the default LogDeliveryService with a custom implementation.
|
AccountClient |
withMetastoreAssignmentsAPI(AccountMetastoreAssignmentsAPI accountMetastoreAssignments)
Replace the default AccountMetastoreAssignmentsAPI with a custom implementation.
|
AccountClient |
withMetastoreAssignmentsImpl(AccountMetastoreAssignmentsService accountMetastoreAssignments)
Replace the default AccountMetastoreAssignmentsService with a custom implementation.
|
AccountClient |
withMetastoresAPI(AccountMetastoresAPI accountMetastores)
Replace the default AccountMetastoresAPI with a custom implementation.
|
AccountClient |
withMetastoresImpl(AccountMetastoresService accountMetastores)
Replace the default AccountMetastoresService with a custom implementation.
|
AccountClient |
withNetworkConnectivityAPI(NetworkConnectivityAPI networkConnectivity)
Replace the default NetworkConnectivityAPI with a custom implementation.
|
AccountClient |
withNetworkConnectivityImpl(NetworkConnectivityService networkConnectivity)
Replace the default NetworkConnectivityService with a custom implementation.
|
AccountClient |
withNetworksAPI(NetworksAPI networks)
Replace the default NetworksAPI with a custom implementation.
|
AccountClient |
withNetworksImpl(NetworksService networks)
Replace the default NetworksService with a custom implementation.
|
AccountClient |
withOAuthPublishedAppsAPI(OAuthPublishedAppsAPI oAuthPublishedApps)
Replace the default OAuthPublishedAppsAPI with a custom implementation.
|
AccountClient |
withOAuthPublishedAppsImpl(OAuthPublishedAppsService oAuthPublishedApps)
Replace the default OAuthPublishedAppsService with a custom implementation.
|
AccountClient |
withPrivateAccessAPI(PrivateAccessAPI privateAccess)
Replace the default PrivateAccessAPI with a custom implementation.
|
AccountClient |
withPrivateAccessImpl(PrivateAccessService privateAccess)
Replace the default PrivateAccessService with a custom implementation.
|
AccountClient |
withPublishedAppIntegrationAPI(PublishedAppIntegrationAPI publishedAppIntegration)
Replace the default PublishedAppIntegrationAPI with a custom implementation.
|
AccountClient |
withPublishedAppIntegrationImpl(PublishedAppIntegrationService publishedAppIntegration)
Replace the default PublishedAppIntegrationService with a custom implementation.
|
AccountClient |
withServicePrincipalsAPI(AccountServicePrincipalsAPI accountServicePrincipals)
Replace the default AccountServicePrincipalsAPI with a custom implementation.
|
AccountClient |
withServicePrincipalSecretsAPI(ServicePrincipalSecretsAPI servicePrincipalSecrets)
Replace the default ServicePrincipalSecretsAPI with a custom implementation.
|
AccountClient |
withServicePrincipalSecretsImpl(ServicePrincipalSecretsService servicePrincipalSecrets)
Replace the default ServicePrincipalSecretsService with a custom implementation.
|
AccountClient |
withServicePrincipalsImpl(AccountServicePrincipalsService accountServicePrincipals)
Replace the default AccountServicePrincipalsService with a custom implementation.
|
AccountClient |
withSettingsAPI(AccountSettingsAPI accountSettings)
Replace the default AccountSettingsAPI with a custom implementation.
|
AccountClient |
withSettingsImpl(AccountSettingsService accountSettings)
Replace the default AccountSettingsService with a custom implementation.
|
AccountClient |
withStorageAPI(StorageAPI storage)
Replace the default StorageAPI with a custom implementation.
|
AccountClient |
withStorageCredentialsAPI(AccountStorageCredentialsAPI accountStorageCredentials)
Replace the default AccountStorageCredentialsAPI with a custom implementation.
|
AccountClient |
withStorageCredentialsImpl(AccountStorageCredentialsService accountStorageCredentials)
Replace the default AccountStorageCredentialsService with a custom implementation.
|
AccountClient |
withStorageImpl(StorageService storage)
Replace the default StorageService with a custom implementation.
|
AccountClient |
withUsersAPI(AccountUsersAPI accountUsers)
Replace the default AccountUsersAPI with a custom implementation.
|
AccountClient |
withUsersImpl(AccountUsersService accountUsers)
Replace the default AccountUsersService with a custom implementation.
|
AccountClient |
withVpcEndpointsAPI(VpcEndpointsAPI vpcEndpoints)
Replace the default VpcEndpointsAPI with a custom implementation.
|
AccountClient |
withVpcEndpointsImpl(VpcEndpointsService vpcEndpoints)
Replace the default VpcEndpointsService with a custom implementation.
|
AccountClient |
withWorkspaceAssignmentAPI(WorkspaceAssignmentAPI workspaceAssignment)
Replace the default WorkspaceAssignmentAPI with a custom implementation.
|
AccountClient |
withWorkspaceAssignmentImpl(WorkspaceAssignmentService workspaceAssignment)
Replace the default WorkspaceAssignmentService with a custom implementation.
|
AccountClient |
withWorkspacesAPI(WorkspacesAPI workspaces)
Replace the default WorkspacesAPI with a custom implementation.
|
AccountClient |
withWorkspacesImpl(WorkspacesService workspaces)
Replace the default WorkspacesService with a custom implementation.
|
WorkspaceAssignmentAPI |
workspaceAssignment()
The Workspace Permission Assignment API allows you to manage workspace permissions for
principals in your account.
|
WorkspacesAPI |
workspaces()
These APIs manage workspaces for this account.
|
public AccountClient()
public AccountClient(DatabricksConfig config)
public AccountClient(boolean mock)
public AccountAccessControlAPI accessControl()
public BillableUsageAPI billableUsage()
public BudgetsAPI budgets()
public CredentialsAPI credentials()
public CustomAppIntegrationAPI customAppIntegration()
public EncryptionKeysAPI encryptionKeys()
* Managed services: A key configuration can be used to encrypt a workspace's notebook and secret data in the control plane, as well as Databricks SQL queries and query history. * Storage: A key configuration can be used to encrypt a workspace's DBFS and EBS data in the data plane.
In both of these cases, the key configuration's ID is used when creating a new workspace. This Preview feature is available if your account is on the E2 version of the platform. Updating a running workspace with workspace storage encryption requires that the workspace is on the E2 version of the platform. If you have an older workspace, it might not be on the E2 version of the platform. If you are not sure, contact your Databricks representative.
public AccountGroupsAPI groups()
It is best practice to assign access to workspaces and access-control policies in Unity Catalog to groups, instead of to users individually. All Databricks account identities can be assigned as members of groups, and members inherit permissions that are assigned to their group.
public AccountIpAccessListsAPI ipAccessLists()
Account IP Access Lists affect web application access and REST API access to the account console and account APIs. If the feature is disabled for the account, all access is allowed for this account. There is support for allow lists (inclusion) and block lists (exclusion).
When a connection is attempted: 1. **First, all block lists are checked.** If the connection IP address matches any block list, the connection is rejected. 2. **If the connection was not rejected by block lists**, the IP address is compared with the allow lists.
If there is at least one allow list for the account, the connection is allowed only if the IP address matches an allow list. If there are no allow lists for the account, all IP addresses are allowed.
For all allow lists and block lists combined, the account supports a maximum of 1000 IP/CIDR values, where one CIDR counts as a single value.
After changes to the account-level IP access lists, it can take a few minutes for changes to take effect.
public LogDeliveryAPI logDelivery()
Log delivery works with all account types. However, if your account is on the E2 version of the platform or on a select custom plan that allows multiple workspaces per account, you can optionally configure different storage destinations for each workspace. Log delivery status is also provided to know the latest status of log delivery attempts. The high-level flow of billable usage delivery:
1. **Create storage**: In AWS, [create a new AWS S3 bucket] with a specific bucket policy. Using Databricks APIs, call the Account API to create a [storage configuration object](:method:Storage/Create) that uses the bucket name. 2. **Create credentials**: In AWS, create the appropriate AWS IAM role. For full details, including the required IAM role policies and trust relationship, see [Billable usage log delivery]. Using Databricks APIs, call the Account API to create a [credential configuration object](:method:Credentials/Create) that uses the IAM role"s ARN. 3. **Create log delivery configuration**: Using Databricks APIs, call the Account API to [create a log delivery configuration](:method:LogDelivery/Create) that uses the credential and storage configuration objects from previous steps. You can specify if the logs should include all events of that log type in your account (_Account level_ delivery) or only events for a specific set of workspaces (_workspace level_ delivery). Account level log delivery applies to all current and future workspaces plus account level logs, while workspace level log delivery solely delivers logs related to the specified workspaces. You can create multiple types of delivery configurations per account.
For billable usage delivery: * For more information about billable usage logs, see [Billable
usage log delivery]. For the CSV schema, see the [Usage page]. * The delivery location is
` For audit log delivery: * For more information about about audit log delivery, see [Audit
log delivery], which includes information about the used JSON schema. * The delivery location
is
` [Audit log delivery]:
https://docs.databricks.com/administration-guide/account-settings/audit-logs.html [Billable
usage log delivery]:
https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html
[Usage page]: https://docs.databricks.com/administration-guide/account-settings/usage.html
[create a new AWS S3 bucket]:
https://docs.databricks.com/administration-guide/account-api/aws-storage.html
public AccountMetastoreAssignmentsAPI metastoreAssignments()
public AccountMetastoresAPI metastores()
public NetworkConnectivityAPI networkConnectivity()
public NetworksAPI networks()
public OAuthPublishedAppsAPI oAuthPublishedApps()
public PrivateAccessAPI privateAccess()
public PublishedAppIntegrationAPI publishedAppIntegration()
public ServicePrincipalSecretsAPI servicePrincipalSecrets()
You can use the generated secrets to obtain OAuth access tokens for a service principal, which can then be used to access Databricks Accounts and Workspace APIs. For more information, see [Authentication using OAuth tokens for service principals],
In addition, the generated secrets can be used to configure the Databricks Terraform Provider to authenticate with the service principal. For more information, see [Databricks Terraform Provider].
[Authentication using OAuth tokens for service principals]: https://docs.databricks.com/dev-tools/authentication-oauth.html [Databricks Terraform Provider]: https://github.com/databricks/terraform-provider-databricks/blob/master/docs/index.md#authenticating-with-service-principal
public AccountServicePrincipalsAPI servicePrincipals()
public AccountSettingsAPI settings()
public StorageAPI storage()
public AccountStorageCredentialsAPI storageCredentials()
public AccountUsersAPI users()
Databricks recommends using SCIM provisioning to sync users and groups automatically from your identity provider to your Databricks account. SCIM streamlines onboarding a new employee or team by using your identity provider to create users and groups in Databricks account and give them the proper level of access. When a user leaves your organization or no longer needs access to Databricks account, admins can terminate the user in your identity provider and that user’s account will also be removed from Databricks account. This ensures a consistent offboarding process and prevents unauthorized users from accessing sensitive data.
public VpcEndpointsAPI vpcEndpoints()
public WorkspaceAssignmentAPI workspaceAssignment()
public WorkspacesAPI workspaces()
These endpoints are available if your account is on the E2 version of the platform or on a select custom plan that allows multiple workspaces per account.
public AccountClient withAccessControlImpl(AccountAccessControlService accountAccessControl)
public AccountClient withAccessControlAPI(AccountAccessControlAPI accountAccessControl)
public AccountClient withBillableUsageImpl(BillableUsageService billableUsage)
public AccountClient withBillableUsageAPI(BillableUsageAPI billableUsage)
public AccountClient withBudgetsImpl(BudgetsService budgets)
public AccountClient withBudgetsAPI(BudgetsAPI budgets)
public AccountClient withCredentialsImpl(CredentialsService credentials)
public AccountClient withCredentialsAPI(CredentialsAPI credentials)
public AccountClient withCustomAppIntegrationImpl(CustomAppIntegrationService customAppIntegration)
public AccountClient withCustomAppIntegrationAPI(CustomAppIntegrationAPI customAppIntegration)
public AccountClient withEncryptionKeysImpl(EncryptionKeysService encryptionKeys)
public AccountClient withEncryptionKeysAPI(EncryptionKeysAPI encryptionKeys)
public AccountClient withGroupsImpl(AccountGroupsService accountGroups)
public AccountClient withGroupsAPI(AccountGroupsAPI accountGroups)
public AccountClient withIpAccessListsImpl(AccountIpAccessListsService accountIpAccessLists)
public AccountClient withIpAccessListsAPI(AccountIpAccessListsAPI accountIpAccessLists)
public AccountClient withLogDeliveryImpl(LogDeliveryService logDelivery)
public AccountClient withLogDeliveryAPI(LogDeliveryAPI logDelivery)
public AccountClient withMetastoreAssignmentsImpl(AccountMetastoreAssignmentsService accountMetastoreAssignments)
public AccountClient withMetastoreAssignmentsAPI(AccountMetastoreAssignmentsAPI accountMetastoreAssignments)
public AccountClient withMetastoresImpl(AccountMetastoresService accountMetastores)
public AccountClient withMetastoresAPI(AccountMetastoresAPI accountMetastores)
public AccountClient withNetworkConnectivityImpl(NetworkConnectivityService networkConnectivity)
public AccountClient withNetworkConnectivityAPI(NetworkConnectivityAPI networkConnectivity)
public AccountClient withNetworksImpl(NetworksService networks)
public AccountClient withNetworksAPI(NetworksAPI networks)
public AccountClient withOAuthPublishedAppsImpl(OAuthPublishedAppsService oAuthPublishedApps)
public AccountClient withOAuthPublishedAppsAPI(OAuthPublishedAppsAPI oAuthPublishedApps)
public AccountClient withPrivateAccessImpl(PrivateAccessService privateAccess)
public AccountClient withPrivateAccessAPI(PrivateAccessAPI privateAccess)
public AccountClient withPublishedAppIntegrationImpl(PublishedAppIntegrationService publishedAppIntegration)
public AccountClient withPublishedAppIntegrationAPI(PublishedAppIntegrationAPI publishedAppIntegration)
public AccountClient withServicePrincipalSecretsImpl(ServicePrincipalSecretsService servicePrincipalSecrets)
public AccountClient withServicePrincipalSecretsAPI(ServicePrincipalSecretsAPI servicePrincipalSecrets)
public AccountClient withServicePrincipalsImpl(AccountServicePrincipalsService accountServicePrincipals)
public AccountClient withServicePrincipalsAPI(AccountServicePrincipalsAPI accountServicePrincipals)
public AccountClient withSettingsImpl(AccountSettingsService accountSettings)
public AccountClient withSettingsAPI(AccountSettingsAPI accountSettings)
public AccountClient withStorageImpl(StorageService storage)
public AccountClient withStorageAPI(StorageAPI storage)
public AccountClient withStorageCredentialsImpl(AccountStorageCredentialsService accountStorageCredentials)
public AccountClient withStorageCredentialsAPI(AccountStorageCredentialsAPI accountStorageCredentials)
public AccountClient withUsersImpl(AccountUsersService accountUsers)
public AccountClient withUsersAPI(AccountUsersAPI accountUsers)
public AccountClient withVpcEndpointsImpl(VpcEndpointsService vpcEndpoints)
public AccountClient withVpcEndpointsAPI(VpcEndpointsAPI vpcEndpoints)
public AccountClient withWorkspaceAssignmentImpl(WorkspaceAssignmentService workspaceAssignment)
public AccountClient withWorkspaceAssignmentAPI(WorkspaceAssignmentAPI workspaceAssignment)
public AccountClient withWorkspacesImpl(WorkspacesService workspaces)
public AccountClient withWorkspacesAPI(WorkspacesAPI workspaces)
public ApiClient apiClient()
public DatabricksConfig config()
public WorkspaceClient getWorkspaceClient(Workspace workspace)
Copyright © 2024. All rights reserved.