@azure/arm-databricks package

Classes

Interfaces

AccessConnector	Information about Azure Databricks Access Connector.
AccessConnectorProperties	model interface AccessConnectorProperties
AccessConnectorUpdate	An update to an Azure Databricks Access Connector.
AccessConnectorsCreateOrUpdateOptionalParams	Optional parameters.
AccessConnectorsDeleteOptionalParams	Optional parameters.
AccessConnectorsGetOptionalParams	Optional parameters.
AccessConnectorsListByResourceGroupOptionalParams	Optional parameters.
AccessConnectorsListBySubscriptionOptionalParams	Optional parameters.
AccessConnectorsOperations	Interface representing a AccessConnectors operations.
AccessConnectorsUpdateOptionalParams	Optional parameters.
AddressSpace	AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.
AutomaticClusterUpdateDefinition	Status of automated cluster updates feature.
AzureDatabricksManagementClientOptionalParams	Optional parameters for the client.
ComplianceSecurityProfileDefinition	Status of Compliance Security Profile feature.
CreatedBy	Provides details of the entity that created/updated the workspace.
DefaultCatalogProperties	These properties lets user specify default catalog properties during workspace creation. Not allowed in Serverless ComputeMode workspace.
Encryption	The object that contains details of encryption used on the workspace.
EncryptionEntitiesDefinition	Encryption entities for databricks workspace resource.
EncryptionV2	The object that contains details of encryption used on the workspace.
EncryptionV2KeyVaultProperties	Key Vault input properties for encryption.
EndpointDependency	A domain name or IP address the Workspace is reaching at.
EndpointDetail	Connect information from the Workspace to a single endpoint.
EnhancedSecurityComplianceDefinition	Status of settings related to the Enhanced Security and Compliance Add-On.
EnhancedSecurityMonitoringDefinition	Status of Enhanced Security Monitoring feature.
ErrorDetail	Error details.
ErrorInfo	The code and message for an error.
ErrorResponse	Contains details when the response code indicates an error.
GroupIdInformation	The group information for creating a private endpoint on a workspace
GroupIdInformationProperties	The properties for a group information object
ManagedDiskEncryption	The object that contains details of encryption used on the workspace.
ManagedDiskEncryptionKeyVaultProperties	Key Vault input properties for encryption.
ManagedIdentityConfiguration	The Managed Identity details for storage account.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
Operation	REST API operation
OperationDisplay	The object that represents the operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
OutboundEnvironmentEndpoint	Egress endpoints which Workspace connects to for common purposes.
OutboundNetworkDependenciesEndpointsListOptionalParams	Optional parameters.
OutboundNetworkDependenciesEndpointsOperations	Interface representing a OutboundNetworkDependenciesEndpoints operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PrivateEndpoint	The private endpoint property of a private endpoint connection.
PrivateEndpointConnection	The private endpoint connection of a workspace.
PrivateEndpointConnectionProperties	The properties of a private endpoint connection.
PrivateEndpointConnectionsCreateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListOptionalParams	Optional parameters.
PrivateEndpointConnectionsOperations	Interface representing a PrivateEndpointConnections operations.
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListOptionalParams	Optional parameters.
PrivateLinkResourcesOperations	Interface representing a PrivateLinkResources operations.
PrivateLinkServiceConnectionState	The current state of a private endpoint connection.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
SimplePollerLike	A simple poller that can be used to poll a long running operation.
Sku	SKU for the resource.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UserAssignedIdentity	User assigned identity properties
VNetPeeringCreateOrUpdateOptionalParams	Optional parameters.
VNetPeeringDeleteOptionalParams	Optional parameters.
VNetPeeringGetOptionalParams	Optional parameters.
VNetPeeringListByWorkspaceOptionalParams	Optional parameters.
VNetPeeringOperations	Interface representing a VNetPeering operations.
VirtualNetworkPeering	Peerings in a VirtualNetwork resource
VirtualNetworkPeeringPropertiesFormat	Properties of the virtual network peering.
VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork	The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering).
VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork	The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering).
Workspace	Information about workspace.
WorkspaceCustomBooleanParameter	The value which should be used for this field.
WorkspaceCustomObjectParameter	The value which should be used for this field.
WorkspaceCustomParameters	Custom Parameters used for Workspace Creation. Not allowed in Serverless ComputeMode workspace.
WorkspaceCustomStringParameter	The Value.
WorkspaceEncryptionParameter	The object that contains details of encryption used on the workspace.
WorkspaceNoPublicIPBooleanParameter	The value which should be used for this field.
WorkspaceProperties	The workspace properties.
WorkspacePropertiesAccessConnector	Access Connector Resource that is going to be associated with Databricks Workspace. Not allowed in Serverless ComputeMode workspace.
WorkspacePropertiesEncryption	Encryption properties for databricks workspace. Supported in both Serverless and Hybrid ComputeMode workspace.
WorkspaceProviderAuthorization	The workspace provider authorization.
WorkspaceUpdate	An update to a workspace.
WorkspacesCreateOrUpdateOptionalParams	Optional parameters.
WorkspacesDeleteOptionalParams	Optional parameters.
WorkspacesGetOptionalParams	Optional parameters.
WorkspacesListByResourceGroupOptionalParams	Optional parameters.
WorkspacesListBySubscriptionOptionalParams	Optional parameters.
WorkspacesOperations	Interface representing a Workspaces operations.
WorkspacesUpdateOptionalParams	Optional parameters.

Type Aliases

AutomaticClusterUpdateValue	Type of AutomaticClusterUpdateValue
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ComplianceSecurityProfileValue	Type of ComplianceSecurityProfileValue
ComputeMode	The workspace compute mode. Required on create, cannot be changed. Possible values include: 'Serverless', 'Hybrid' KnownComputeMode can be used interchangeably with ComputeMode, this enum contains the known values that the service supports. Known values supported by the service Serverless: Serverless Hybrid: Hybrid
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
CustomParameterType	The workspace's custom parameters. KnownCustomParameterType can be used interchangeably with CustomParameterType, this enum contains the known values that the service supports. Known values supported by the service Bool: Bool Object: Object String: String
DefaultStorageFirewall	Gets or Sets Default Storage Firewall configuration information. Not allowed in Serverless ComputeMode workspace. KnownDefaultStorageFirewall can be used interchangeably with DefaultStorageFirewall, this enum contains the known values that the service supports. Known values supported by the service Disabled: Disabled Enabled: Enabled
EncryptionKeySource	The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault KnownEncryptionKeySource can be used interchangeably with EncryptionKeySource, this enum contains the known values that the service supports. Known values supported by the service Microsoft.Keyvault: Microsoft.Keyvault
EnhancedSecurityMonitoringValue	Type of EnhancedSecurityMonitoringValue
IdentityType	The identity type of the Access Connector Resource. KnownIdentityType can be used interchangeably with IdentityType, this enum contains the known values that the service supports. Known values supported by the service SystemAssigned: SystemAssigned UserAssigned: UserAssigned
InitialType	Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog KnownInitialType can be used interchangeably with InitialType, this enum contains the known values that the service supports. Known values supported by the service HiveMetastore: HiveMetastore UnityCatalog: UnityCatalog
KeySource	The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault KnownKeySource can be used interchangeably with KeySource, this enum contains the known values that the service supports. Known values supported by the service Default: Default Microsoft.Keyvault: Microsoft.Keyvault
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed identity. SystemAssigned: System assigned managed identity. UserAssigned: User assigned managed identity. SystemAssigned,UserAssigned: System and user assigned managed identity.
PeeringProvisioningState	The current provisioning state. KnownPeeringProvisioningState can be used interchangeably with PeeringProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Succeeded Updating: Updating Deleting: Deleting Failed: Failed
PeeringState	The status of the virtual network peering. KnownPeeringState can be used interchangeably with PeeringState, this enum contains the known values that the service supports. Known values supported by the service Initiated: Initiated Connected: Connected Disconnected: Disconnected
PrivateEndpointConnectionProvisioningState	The current provisioning state. KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Succeeded Creating: Creating Updating: Updating Deleting: Deleting Failed: Failed
PrivateLinkServiceConnectionStatus	The status of a private endpoint connection KnownPrivateLinkServiceConnectionStatus can be used interchangeably with PrivateLinkServiceConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending: Pending Approved: Approved Rejected: Rejected Disconnected: Disconnected
ProvisioningState	Provisioning status of the workspace. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Accepted: Accepted Running: Running Ready: Ready Creating: Creating Created: Created Deleting: Deleting Deleted: Deleted Canceled: Canceled Failed: Failed Succeeded: Succeeded Updating: Updating
PublicNetworkAccess	The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to configure front-end only private link for Serverless ComputeMode workspace. KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports. Known values supported by the service Enabled: Enabled Disabled: Disabled
RequiredNsgRules	Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only. Not allowed in Serverless ComputeMode workspace. KnownRequiredNsgRules can be used interchangeably with RequiredNsgRules, this enum contains the known values that the service supports. Known values supported by the service AllRules: AllRules NoAzureDatabricksRules: NoAzureDatabricksRules NoAzureServiceRules: NoAzureServiceRules

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAutomaticClusterUpdateValue	Known values of AutomaticClusterUpdateValue that the service accepts.
KnownComplianceSecurityProfileValue	Known values of ComplianceSecurityProfileValue that the service accepts.
KnownComputeMode	The workspace compute mode. Required on create, cannot be changed. Possible values include: 'Serverless', 'Hybrid'
KnownCreatedByType	The kind of entity that created the resource.
KnownCustomParameterType	The workspace's custom parameters.
KnownDefaultStorageFirewall	Gets or Sets Default Storage Firewall configuration information. Not allowed in Serverless ComputeMode workspace.
KnownEncryptionKeySource	The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault
KnownEnhancedSecurityMonitoringValue	Known values of EnhancedSecurityMonitoringValue that the service accepts.
KnownIdentityType	The identity type of the Access Connector Resource.
KnownInitialType	Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog
KnownKeySource	The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownPeeringProvisioningState	The current provisioning state.
KnownPeeringState	The status of the virtual network peering.
KnownPrivateEndpointConnectionProvisioningState	The current provisioning state.
KnownPrivateLinkServiceConnectionStatus	The status of a private endpoint connection
KnownProvisioningState	Provisioning status of the workspace.
KnownPublicNetworkAccess	The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Used to configure front-end only private link for Serverless ComputeMode workspace.
KnownRequiredNsgRules	Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only. Not allowed in Serverless ComputeMode workspace.
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(AzureDatabricksManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e: unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(AzureDatabricksManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: AzureDatabricksManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client: AzureDatabricksManagementClient

serializedState: string

sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor

@azure/arm-databricks package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Variables

Function Details

isRestError(unknown)

Parameters

Returns

restorePoller<TResponse, TResult>(AzureDatabricksManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Parameters

Returns

Variable Details

RestError

Type