OneLake Settings - Get Settings

服务:
Core
API 版本:
v1

获取工作区 OneLake 设置。

Permissions

调用方必须具有 管理员 工作区角色。

所需的委派范围

OneLake.Read.All 或 OneLake.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份 Support
用户 是的
服务主体和托管标识 是的

接口

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/onelake/settings

URI 参数

名称 在 必需 类型 说明
workspaceId
 path True

string (uuid)

工作区 ID。

响应

名称 类型 说明
200 OK

GetOneLakeSettingsResponse

请求成功完成。
429 Too Many Requests

ErrorResponse

超出服务速率限制。 服务器返回一个 Retry-After 标头，指示客户端在发送其他请求之前必须等待的时间（以秒为单位）。

标头

Retry-After: integer
Other Status Codes

ErrorResponse

常见错误代码：

  • UnknownError - 发生错误。

  • WorkspaceNotFound - 找不到工作区。

  • UserNotAuthorizedSourceWorkspace - 用户未获得工作区的授权。

示例

Get OneLake Setting for workspace with diagnostic setting example
Get OneLake Setting for workspace without diagnostic setting example
Get OneLake Settings with immutability policy example
Get OneLake Settings without immutability policy example

Get OneLake Setting for workspace with diagnostic setting example

示例请求

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227/onelake/settings

示例响应

状态代码:
200 
{
  "diagnostics": {
    "status": "Enabled",
    "destination": {
      "type": "Lakehouse",
      "lakehouse": {
        "referenceType": "ById",
        "itemId": "33d48b2c-5b7c-42e2-8467-87fecb105fdd",
        "workspaceId": "85173301-af01-49c9-b667-03edc44517da"
      }
    }
  }
}

Get OneLake Setting for workspace without diagnostic setting example

示例请求

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227/onelake/settings

示例响应

状态代码:
200 
{
  "diagnostics": {
    "status": "Disabled"
  }
}

Get OneLake Settings with immutability policy example

示例请求

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227/onelake/settings

示例响应

状态代码:
200 
{
  "diagnostics": {
    "status": "Enabled",
    "destination": {
      "type": "Lakehouse",
      "lakehouse": {
        "referenceType": "ById",
        "itemId": "33d48b2c-5b7c-42e2-8467-87fecb105fdd",
        "workspaceId": "85173301-af01-49c9-b667-03edc44517da"
      }
    }
  },
  "immutabilityPolicies": [
    {
      "scope": "DiagnosticLogs",
      "retentionDays": 30
    }
  ]
}

Get OneLake Settings without immutability policy example

示例请求

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227/onelake/settings

示例响应

状态代码:
200 
{
  "diagnostics": {
    "status": "Disabled"
  }
}

定义

名称 说明
ErrorRelatedResource

与错误相关的资源详细信息对象。
ErrorResponse

错误响应。
ErrorResponseDetails

错误响应详细信息。
GetOneLakeSettingsResponse

OneLake 设置响应。
ImmutabilityPolicy

不可变性策略对象。
ImmutabilityScope

不可变性策略的范围。 可能会随着时间的推移添加其他不可变性范围类型。
ItemReferenceById

按 ID 对象引用项。
ItemReferenceByVariable

按变量引用项。
ItemReferenceType

项引用类型。 可能会随着时间的推移添加其他 ItemReferenceType 类型。
LakehouseOneLakeDiagnosticSettingsDestination

OneLake 诊断日志的 Lakehouse 目标。
OneLakeDiagnosticSettings

OneLake 诊断设置对象。

ErrorRelatedResource

对象

与错误相关的资源详细信息对象。

名称 类型 说明
resourceId

string

错误中涉及的资源 ID。
resourceType

string

错误中涉及的资源的类型。

ErrorResponse

对象

错误响应。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
moreDetails

ErrorResponseDetails[]

其他错误详细信息的列表。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。
requestId

string (uuid)

与错误关联的请求的 ID。

ErrorResponseDetails

对象

错误响应详细信息。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。

GetOneLakeSettingsResponse

对象

OneLake 设置响应。

名称 类型 说明
diagnostics

OneLakeDiagnosticSettings

OneLake 诊断设置对象。
immutabilityPolicies

ImmutabilityPolicy[]

工作区的不可变性设置。

ImmutabilityPolicy

对象

不可变性策略对象。

名称 类型 说明
retentionDays

integer

minimum: 1

配置的保留天数的值。
scope

ImmutabilityScope

不可变性策略的范围。

ImmutabilityScope

枚举

不可变性策略的范围。 可能会随着时间的推移添加其他不可变性范围类型。

值 说明
DiagnosticLogs

诊断日志的不可变性策略。

ItemReferenceById

对象

按 ID 对象引用项。

名称 类型 说明
itemId

string (uuid)

项的 ID。
referenceType string:

ById

项引用类型。
workspaceId

string (uuid)

项的工作区 ID。

ItemReferenceByVariable

对象

按变量引用项。

名称 类型 说明
referenceType string:

ByVariable

项引用类型。
variableReference

string

一个变量引用字符串，指定变量库及其内的变量名称。 格式： $(/**/_VarLibrary_/_VarName_) 对于名为 VarLibrary 的变量库和名为 VarName 的变量。

ItemReferenceType

枚举

项引用类型。 可能会随着时间的推移添加其他 ItemReferenceType 类型。

值 说明
ById

该项的 ID 引用。
ByVariable

该项由变量引用。

LakehouseOneLakeDiagnosticSettingsDestination

对象

OneLake 诊断日志的 Lakehouse 目标。

名称 类型 说明
lakehouse ItemReference:

对目标湖屋的引用。
type string:

Lakehouse

目标的项类型。

OneLakeDiagnosticSettings

对象

OneLake 诊断设置对象。

名称 类型 说明
destination OneLakeDiagnosticSettingsDestinationInfo:

LakehouseOneLakeDiagnosticSettingsDestination

存储 OneLake 诊断日志的目标。 如果禁用，则不需要这样做。
status

string

诊断设置的状态。