你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

@azure/arm-databricks package

接口

AccessConnector

有关 Azure Databricks 访问连接器的信息。

AccessConnectorProperties

model interface AccessConnectorProperties

AccessConnectorUpdate

Azure Databricks 访问连接器的更新。

AccessConnectorsCreateOrUpdateOptionalParams

可选参数。

AccessConnectorsDeleteOptionalParams

可选参数。

AccessConnectorsGetOptionalParams

可选参数。

AccessConnectorsListByResourceGroupOptionalParams

可选参数。

AccessConnectorsListBySubscriptionOptionalParams

可选参数。

AccessConnectorsOperations

表示 AccessConnectors 操作的接口。

AccessConnectorsUpdateOptionalParams

可选参数。

AddressSpace

AddressSpace 包含虚拟网络子网可以使用的 IP 地址范围的数组。

AutomaticClusterUpdateDefinition

自动群集更新功能的状态。

AzureDatabricksManagementClientOptionalParams

客户端的可选参数。

ComplianceSecurityProfileDefinition

合规性安全配置文件功能的状态。

CreatedBy

提供创建/更新工作区的实体的详细信息。

DefaultCatalogProperties

这些属性允许用户在创建工作区期间指定默认目录属性。 不允许在无服务器计算模式工作区中。

Encryption

包含工作区中使用的加密详细信息的对象。

EncryptionEntitiesDefinition

databricks 工作区资源的加密实体。

EncryptionV2

包含工作区中使用的加密详细信息的对象。

EncryptionV2KeyVaultProperties

用于加密的 密钥保管库 输入属性。

EndpointDependency

工作区正在访问的域名或 IP 地址。

EndpointDetail

将工作区中的信息连接到单个终结点。

EnhancedSecurityComplianceDefinition

与增强的安全性和合规性加载项相关的设置状态。

EnhancedSecurityMonitoringDefinition

增强的安全监视功能的状态。

ErrorDetail

错误详细信息。

ErrorInfo

错误的代码和消息。

ErrorResponse

当响应代码指示错误时,包含详细信息。

GroupIdInformation

用于在工作区上创建专用终结点的组信息

GroupIdInformationProperties

组信息对象的属性

ManagedDiskEncryption

包含工作区中使用的加密详细信息的对象。

ManagedDiskEncryptionKeyVaultProperties

用于加密的 密钥保管库 输入属性。

ManagedIdentityConfiguration

存储帐户的托管标识详细信息。

ManagedServiceIdentity

托管服务标识(系统分配和/或用户分配的标识)

Operation

REST API作

OperationDisplay

表示作的对象。

OperationsListOptionalParams

可选参数。

OperationsOperations

表示作作的接口。

OutboundEnvironmentEndpoint

工作区出于常见目的连接到的出口终结点。

OutboundNetworkDependenciesEndpointsListOptionalParams

可选参数。

OutboundNetworkDependenciesEndpointsOperations

表示出站网络依赖端点操作的接口。

PageSettings

byPage 方法的选项

PagedAsyncIterableIterator

允许异步迭代到完成和逐页迭代的接口。

PrivateEndpoint

专用终结点连接的专用终结点属性。

PrivateEndpointConnection

工作区的专用终结点连接。

PrivateEndpointConnectionProperties

专用终结点连接的属性。

PrivateEndpointConnectionsCreateOptionalParams

可选参数。

PrivateEndpointConnectionsDeleteOptionalParams

可选参数。

PrivateEndpointConnectionsGetOptionalParams

可选参数。

PrivateEndpointConnectionsListOptionalParams

可选参数。

PrivateEndpointConnectionsOperations

表示 PrivateEndpointConnections 操作的接口。

PrivateLinkResourcesGetOptionalParams

可选参数。

PrivateLinkResourcesListOptionalParams

可选参数。

PrivateLinkResourcesOperations

表示 PrivateLinkResources作的接口。

PrivateLinkServiceConnectionState

专用终结点连接的当前状态。

ProxyResource

Azure 资源管理器代理资源的资源模型定义。 它不具有标记和位置

Resource

所有 Azure 资源管理器资源的响应中返回的常见字段

RestorePollerOptions
SimplePollerLike

可用于轮询长时间运行的操作的简单轮询程序。

Sku

资源的 SKU。

SystemData

与创建和上次修改资源相关的元数据。

TrackedResource

Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源

UserAssignedIdentity

用户分配的标识属性

VNetPeeringCreateOrUpdateOptionalParams

可选参数。

VNetPeeringDeleteOptionalParams

可选参数。

VNetPeeringGetOptionalParams

可选参数。

VNetPeeringListByWorkspaceOptionalParams

可选参数。

VNetPeeringOperations

表示VNetPeering操作的接口。

VirtualNetworkPeering

VirtualNetwork 资源中的对等互连

VirtualNetworkPeeringPropertiesFormat

虚拟网络对等互连的属性。

VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork

远程虚拟网络应位于同一区域。 请参阅此处了解详细信息(https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering)。

VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork

远程虚拟网络应位于同一区域。 请参阅此处了解详细信息(https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering)。

Workspace

有关工作区的信息。

WorkspaceCustomBooleanParameter

应用于此字段的值。

WorkspaceCustomObjectParameter

应用于此字段的值。

WorkspaceCustomParameters

用于创建工作区的自定义参数。 不允许在无服务器计算模式工作区中。

WorkspaceCustomStringParameter

值。

WorkspaceEncryptionParameter

包含工作区中使用的加密详细信息的对象。

WorkspaceNoPublicIPBooleanParameter

应用于此字段的值。

WorkspaceProperties

工作区属性。

WorkspacePropertiesAccessConnector

访问将与 Databricks 工作区关联的连接器资源。 不允许在无服务器计算模式工作区中。

WorkspacePropertiesEncryption

databricks 工作区的加密属性。 在无服务器和混合计算模式工作区中均受支持。

WorkspaceProviderAuthorization

工作区提供程序授权。

WorkspaceUpdate

对工作区的更新。

WorkspacesCreateOrUpdateOptionalParams

可选参数。

WorkspacesDeleteOptionalParams

可选参数。

WorkspacesGetOptionalParams

可选参数。

WorkspacesListByResourceGroupOptionalParams

可选参数。

WorkspacesListBySubscriptionOptionalParams

可选参数。

WorkspacesOperations

表示工作区作的接口。

WorkspacesUpdateOptionalParams

可选参数。

类型别名

AutomaticClusterUpdateValue

AutomaticClusterUpdateValue 类型

AzureSupportedClouds

云设置为字符串文字类型的支持值

ComplianceSecurityProfileValue

合规类型安全配置文件值

ComputeMode

工作区计算模式。 创建时需要,无法更改。 可能的数值包括:“无服务器”、“混合型”
KnownComputeMode 可以与 ComputeMode 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

无服务器:无服务器
混合动力:混合动力

ContinuablePage

描述结果页的接口。

CreatedByType

创建资源的实体类型。
KnownCreatedByType 可与 CreatedByType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

用户:实体是由用户创建的。
应用程序:实体是由应用程序创建的。
ManagedIdentity:实体是由托管标识创建的。
密钥:实体是由密钥创建的。

CustomParameterType

工作区的自定义参数。
KnownCustomParameterType 可与 CustomParameterType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

布尔:布尔
物体:物体
字符串:字符串

DefaultStorageFirewall

获取或设置默认存储防火墙配置信息。 不允许在无服务器计算模式工作区中。
KnownDefaultStorageFirewall 可以与 DefaultStorageFirewall 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

禁用:禁用
已启用:已启用

EncryptionKeySource

加密密钥来源(提供程序)。 可能值(不区分大小写):Microsoft。钥匙库
KnownEncryptionKeySource 可与 EncryptionKeySource 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

Microsoft。Keyvault:Microsoft。钥匙库

EnhancedSecurityMonitoringValue

增强安全监控值类型

IdentityType

访问连接器资源的标识类型。
KnownIdentityType 可与 IdentityType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

系统分配:系统分配
用户指定:用户指定

InitialType

定义默认目录的初始类型。 可能值(不区分大小写):HiveMetastore、UnityCatalog
KnownInitialType 可以与 InitialType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

HiveMetastore:HiveMetastore
Unity目录:Unity目录

KeySource

加密密钥来源(提供程序)。 可能的值(不区分大小写):默认,Microsoft。钥匙库
KnownKeySource 可与 KeySource 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

默认:默认
Microsoft。Keyvault:Microsoft。钥匙库

ManagedServiceIdentityType

托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。
KnownManagedServiceIdentityType 可与 ManagedServiceIdentityType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

:没有托管标识。
SystemAssigned:系统分配的托管标识。
UserAssigned:用户分配的托管标识。
SystemAssigned、UserAssigned:系统和用户分配的托管标识。

PeeringProvisioningState

当前预配状态。
KnownPeeringProvisioningState 可与 PeeringProvisioningState 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

成功:成功
更新:更新中
删除:删除
失败:失败

PeeringState

虚拟网络对等互连的状态。
KnownPeeringState 可与 PeeringState 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

启动:启动
连接:连接
断线:断线

PrivateEndpointConnectionProvisioningState

当前预配状态。
KnownPrivateEndpointConnectionProvisioningState 可与 PrivateEndpointConnectionProvisioningState 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

成功:成功
创建:创建
更新:更新中
删除:删除
失败:失败

PrivateLinkServiceConnectionStatus

专用终结点连接的状态
KnownPrivateLinkServiceConnectionStatus 可与 PrivateLinkServiceConnectionStatus 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

待处理:待处理
批准:批准
拒绝:拒绝
断线:断线

ProvisioningState

工作区的预配状态。
KnownProvisioningState 可与 ProvisioningState 互换,此枚举包含服务支持的已知值。

服务支持的已知值

已接受:已接受
跑步:跑步
准备好了:准备好了
创建:创建
创建:创建
删除:删除
已删除:已删除
取消:取消
失败:失败
成功:成功
更新:更新中

PublicNetworkAccess

用于访问工作区的网络访问类型。 将值设置为禁用,以便仅通过专用链接访问工作区。 用于配置无服务器计算模式工作区的前端专用私有链路。
KnownPublicNetworkAccess 可与 PublicNetworkAccess 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

启用:启用
禁用:禁用

RequiredNsgRules

获取或设置一个值,该值指示是否通过专用终结点控制平面通信的数据平面(群集)。 支持的值为“AllRules”和“NoAzureDatabricksRules”。 “NoAzureServiceRules”值仅用于内部使用。 不允许在无服务器计算模式工作区中。
KnownRequiredNsgRules 可与 RequiredNsgRules 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

AllRules:AllRules
NoAzureDatabricksRules: NoAzureDatabricksRules
NoAzureServiceRules: NoAzureServiceRules

枚举

AzureClouds

用于描述 Azure 云环境的枚举。

KnownAutomaticClusterUpdateValue

服务接受的 已知 AutomaticClusterUpdateValue 值。

KnownComplianceSecurityProfileValue

服务接受的已知合规 安全配置文件值

KnownComputeMode

工作区计算模式。 创建时需要,无法更改。 可能的值包括:“Serverless”、“Hybrid”

KnownCreatedByType

创建资源的实体类型。

KnownCustomParameterType

工作区的自定义参数。

KnownDefaultStorageFirewall

获取或设置默认存储防火墙配置信息。 不允许在无服务器计算模式工作区中。

KnownEncryptionKeySource

加密密钥来源(提供程序)。 可能的值(不区分大小写):Microsoft。Keyvault

KnownEnhancedSecurityMonitoringValue

服务接受的 EnhancedSecurityMonitoringValue 已知值。

KnownIdentityType

访问连接器资源的标识类型。

KnownInitialType

定义默认目录的初始类型。 可能的值(不区分大小写):HiveMetastore、UnityCatalog

KnownKeySource

加密密钥来源(提供程序)。 可能的值(不区分大小写):默认值,Microsoft。Keyvault

KnownManagedServiceIdentityType

托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。

KnownPeeringProvisioningState

当前预配状态。

KnownPeeringState

虚拟网络对等互连的状态。

KnownPrivateEndpointConnectionProvisioningState

当前预配状态。

KnownPrivateLinkServiceConnectionStatus

专用终结点连接的状态

KnownProvisioningState

工作区的预配状态。

KnownPublicNetworkAccess

用于访问工作区的网络访问类型。 将值设置为禁用,以便仅通过专用链接访问工作区。 用于配置无服务器计算模式工作区的前端专用私有链路。

KnownRequiredNsgRules

获取或设置一个值,该值指示是否通过专用终结点控制平面通信的数据平面(群集)。 支持的值为“AllRules”和“NoAzureDatabricksRules”。 “NoAzureServiceRules”值仅用于内部使用。 不允许在无服务器计算模式工作区中。

KnownVersions

可用的 API 版本。

函数

isRestError(unknown)

RestError 的 Typeguard

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

从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器,或者在原始轮询器不在范围内后构造轮询器,这非常有用。

变量

RestError

失败管道请求的自定义错误类型。

函数详细信息

isRestError(unknown)

RestError 的 Typeguard

function isRestError(e: unknown): e

参数

e

unknown

catch 子句捕获的内容。

返回

e

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

从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器,或者在原始轮询器不在范围内后构造轮询器,这非常有用。

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

参数

serializedState

string

sourceOperation

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

返回

PollerLike<OperationState<TResult>, TResult>

变量详细信息

RestError

失败管道请求的自定义错误类型。

RestError: RestErrorConstructor

类型