@azure/arm-databricks package

Classes

AzureDatabricksManagementClient

Interfaces

AccessConnector

Information about azure databricks accessConnector.

AccessConnectorListResult

List of azure databricks accessConnector.

AccessConnectorProperties
AccessConnectorUpdate

An update to an azure databricks accessConnector.

AccessConnectors

Interface representing a AccessConnectors.

AccessConnectorsCreateOrUpdateOptionalParams

Optional parameters.

AccessConnectorsDeleteOptionalParams

Optional parameters.

AccessConnectorsGetOptionalParams

Optional parameters.

AccessConnectorsListByResourceGroupNextOptionalParams

Optional parameters.

AccessConnectorsListByResourceGroupOptionalParams

Optional parameters.

AccessConnectorsListBySubscriptionNextOptionalParams

Optional parameters.

AccessConnectorsListBySubscriptionOptionalParams

Optional parameters.

AccessConnectorsUpdateOptionalParams

Optional parameters.

AddressSpace

AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.

AzureDatabricksManagementClientOptionalParams

Optional parameters.

CreatedBy

Provides details of the entity that created/updated the 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.

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.

OperationListResult

Result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

OutboundEnvironmentEndpoint

Egress endpoints which Workspace connects to for common purposes.

OutboundNetworkDependenciesEndpoints

Interface representing a OutboundNetworkDependenciesEndpoints.

OutboundNetworkDependenciesEndpointsListOptionalParams

Optional parameters.

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

PrivateEndpointConnections

Interface representing a PrivateEndpointConnections.

PrivateEndpointConnectionsCreateOptionalParams

Optional parameters.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsList

List of private link connections.

PrivateEndpointConnectionsListNextOptionalParams

Optional parameters.

PrivateEndpointConnectionsListOptionalParams

Optional parameters.

PrivateLinkResources

Interface representing a PrivateLinkResources.

PrivateLinkResourcesGetOptionalParams

Optional parameters.

PrivateLinkResourcesList

The available private link resources for a workspace

PrivateLinkResourcesListNextOptionalParams

Optional parameters.

PrivateLinkResourcesListOptionalParams

Optional parameters.

PrivateLinkServiceConnectionState

The current state of a private endpoint connection

Resource

The core properties of ARM resources

Sku

SKU for the resource.

SystemData

Metadata pertaining to creation and last modification of the resource.

TrackedResource

The resource model definition for a ARM tracked top level resource

UserAssignedIdentity

User assigned identity properties

VNetPeering

Interface representing a VNetPeering.

VNetPeeringCreateOrUpdateOptionalParams

Optional parameters.

VNetPeeringDeleteOptionalParams

Optional parameters.

VNetPeeringGetOptionalParams

Optional parameters.

VNetPeeringListByWorkspaceNextOptionalParams

Optional parameters.

VNetPeeringListByWorkspaceOptionalParams

Optional parameters.

VirtualNetworkPeering

Peerings in a VirtualNetwork resource

VirtualNetworkPeeringList

Gets all virtual network peerings under a workspace.

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 Cluster Creation.

WorkspaceCustomStringParameter

The Value.

WorkspaceEncryptionParameter

The object that contains details of encryption used on the workspace.

WorkspaceListResult

List of workspaces.

WorkspacePropertiesEncryption

Encryption properties for databricks workspace

WorkspaceProviderAuthorization

The workspace provider authorization.

WorkspaceUpdate

An update to a workspace.

Workspaces

Interface representing a Workspaces.

WorkspacesCreateOrUpdateOptionalParams

Optional parameters.

WorkspacesDeleteOptionalParams

Optional parameters.

WorkspacesGetOptionalParams

Optional parameters.

WorkspacesListByResourceGroupNextOptionalParams

Optional parameters.

WorkspacesListByResourceGroupOptionalParams

Optional parameters.

WorkspacesListBySubscriptionNextOptionalParams

Optional parameters.

WorkspacesListBySubscriptionOptionalParams

Optional parameters.

WorkspacesUpdateOptionalParams

Optional parameters.

Type Aliases

AccessConnectorsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

AccessConnectorsGetResponse

Contains response data for the get operation.

AccessConnectorsListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

AccessConnectorsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

AccessConnectorsListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

AccessConnectorsListBySubscriptionResponse

Contains response data for the listBySubscription operation.

AccessConnectorsUpdateResponse

Contains response data for the update operation.

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

CustomParameterType

Defines values for CustomParameterType.
KnownCustomParameterType can be used interchangeably with CustomParameterType, this enum contains the known values that the service supports.

Known values supported by the service

Bool
Object
String

EncryptionKeySource

Defines values for EncryptionKeySource.
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

KeySource

Defines values for KeySource.
KnownKeySource can be used interchangeably with KeySource, this enum contains the known values that the service supports.

Known values supported by the service

Default
Microsoft.Keyvault

ManagedServiceIdentityType

Defines values for ManagedServiceIdentityType.
KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

OutboundNetworkDependenciesEndpointsListResponse

Contains response data for the list operation.

PeeringProvisioningState

Defines values for PeeringProvisioningState.
KnownPeeringProvisioningState can be used interchangeably with PeeringProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Updating
Deleting
Failed

PeeringState

Defines values for PeeringState.
KnownPeeringState can be used interchangeably with PeeringState, this enum contains the known values that the service supports.

Known values supported by the service

Initiated
Connected
Disconnected

PrivateEndpointConnectionProvisioningState

Defines values for PrivateEndpointConnectionProvisioningState.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Creating
Updating
Deleting
Failed

PrivateEndpointConnectionsCreateResponse

Contains response data for the create operation.

PrivateEndpointConnectionsGetResponse

Contains response data for the get operation.

PrivateEndpointConnectionsListNextResponse

Contains response data for the listNext operation.

PrivateEndpointConnectionsListResponse

Contains response data for the list operation.

PrivateLinkResourcesGetResponse

Contains response data for the get operation.

PrivateLinkResourcesListNextResponse

Contains response data for the listNext operation.

PrivateLinkResourcesListResponse

Contains response data for the list operation.

PrivateLinkServiceConnectionStatus

Defines values for PrivateLinkServiceConnectionStatus.
KnownPrivateLinkServiceConnectionStatus can be used interchangeably with PrivateLinkServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Approved
Rejected
Disconnected

ProvisioningState

Defines values for ProvisioningState.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Accepted
Running
Ready
Creating
Created
Deleting
Deleted
Canceled
Failed
Succeeded
Updating

PublicNetworkAccess

Defines values for PublicNetworkAccess.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

RequiredNsgRules

Defines values for RequiredNsgRules.
KnownRequiredNsgRules can be used interchangeably with RequiredNsgRules, this enum contains the known values that the service supports.

Known values supported by the service

AllRules
NoAzureDatabricksRules
NoAzureServiceRules

VNetPeeringCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

VNetPeeringGetResponse

Contains response data for the get operation.

VNetPeeringListByWorkspaceNextResponse

Contains response data for the listByWorkspaceNext operation.

VNetPeeringListByWorkspaceResponse

Contains response data for the listByWorkspace operation.

WorkspacesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

WorkspacesGetResponse

Contains response data for the get operation.

WorkspacesListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

WorkspacesListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

WorkspacesListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

WorkspacesListBySubscriptionResponse

Contains response data for the listBySubscription operation.

WorkspacesUpdateResponse

Contains response data for the update operation.

Enums

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownCustomParameterType

Known values of CustomParameterType that the service accepts.

KnownEncryptionKeySource

Known values of EncryptionKeySource that the service accepts.

KnownKeySource

Known values of KeySource that the service accepts.

KnownManagedServiceIdentityType

Known values of ManagedServiceIdentityType that the service accepts.

KnownPeeringProvisioningState

Known values of PeeringProvisioningState that the service accepts.

KnownPeeringState

Known values of PeeringState that the service accepts.

KnownPrivateEndpointConnectionProvisioningState

Known values of PrivateEndpointConnectionProvisioningState that the service accepts.

KnownPrivateLinkServiceConnectionStatus

Known values of PrivateLinkServiceConnectionStatus that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownPublicNetworkAccess

Known values of PublicNetworkAccess that the service accepts.

KnownRequiredNsgRules

Known values of RequiredNsgRules that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.