Published - List Libraries (preview)
获取环境发布的库。
注释
此 API 是预览版的一部分,仅用于评估和开发目的。 它可能会根据反馈进行更改,不建议将其用于生产。 此预览版 API 将于 2026 年 3 月 1 日弃用,并替换为 此处提供的稳定版本。 新版本引入了中断性变更,并且不向后兼容。
调用此 API 时,调用方必须指定 true 为查询参数 preview的值。
弃用通知
引入了新的查询参数 preview ,以促进此转换:
- 查询
preview参数当前默认为true. - 将查询参数的值
preview设置为false使用此 API 的稳定发布版本。 - 从 2026 年 3 月 1 日起,默认值
preview将更改为false。
建议通过指定falsepreview查询参数(查询参数的默认值preview将设置为 false API 的弃用日期)来迁移集成以尽快使用发布版本。
发布版本中引入了以下不兼容的更改:
- 不同的响应格式和架构结构
- 响应中的增强库属性
- 更新了字段名称和数据类型
- 改进了错误处理和消息
此 API 支持 分页。
Permissions
环境项的读取权限。
所需的委派范围
Item.Read.All 或 Item.ReadWrite.All 或 Environment.Read.All 或 Environment.ReadWrite.All
Microsoft Entra 支持的标识
此 API 支持本节中列出的Microsoft 标识。
| 身份 | Support |
|---|---|
| 用户 | 是的 |
| 服务主体和托管标识 | 是的 |
接口
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries?preview={preview}
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
environment
|
path | True |
string (uuid) |
环境 ID。 |
|
workspace
|
path | True |
string (uuid) |
工作区 ID。 |
|
preview
|
query | True |
boolean |
此参数指定要使用的 API 版本。
|
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
请求成功完成。 |
|
| Other Status Codes |
常见错误代码:
|
示例
Get environment published libraries example
示例请求
GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/libraries?preview=True
示例响应
{
"customLibraries": {
"wheelFiles": [
"samplewheel-0.18.0-py2.py3-none-any.whl"
],
"pyFiles": [
"samplepython.py"
],
"jarFiles": [
"samplejar.jar"
],
"rTarFiles": [
"sampleR.tar.gz"
]
},
"environmentYml": "name: sample-environment\ndependencies:\n - fuzzywuzzy==0.0.1\n - matplotlib==0.0.1"
}
定义
| 名称 | 说明 |
|---|---|
|
Custom |
自定义库。 |
|
Error |
与错误相关的资源详细信息对象。 |
|
Error |
错误响应。 |
|
Error |
错误响应详细信息。 |
|
Libraries |
环境库。 |
CustomLibraries
自定义库。
| 名称 | 类型 | 说明 |
|---|---|---|
| jarFiles |
string[] |
Jar 文件的列表。 |
| pyFiles |
string[] |
Python 文件列表。 |
| rTarFiles |
string[] |
R 文件的列表。 |
| wheelFiles |
string[] |
Wheel 文件列表。 |
ErrorRelatedResource
与错误相关的资源详细信息对象。
| 名称 | 类型 | 说明 |
|---|---|---|
| resourceId |
string |
错误中涉及的资源 ID。 |
| resourceType |
string |
错误中涉及的资源的类型。 |
ErrorResponse
错误响应。
| 名称 | 类型 | 说明 |
|---|---|---|
| errorCode |
string |
提供有关错误条件的信息的特定标识符,允许服务与其用户之间的标准化通信。 |
| message |
string |
错误的人工可读表示形式。 |
| moreDetails |
其他错误详细信息的列表。 |
|
| relatedResource |
与错误相关的资源详细信息。 |
|
| requestId |
string |
与错误关联的请求的 ID。 |
ErrorResponseDetails
错误响应详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| errorCode |
string |
提供有关错误条件的信息的特定标识符,允许服务与其用户之间的标准化通信。 |
| message |
string |
错误的人工可读表示形式。 |
| relatedResource |
与错误相关的资源详细信息。 |
LibrariesPreview
环境库。
| 名称 | 类型 | 说明 |
|---|---|---|
| customLibraries |
自定义库(.py、.whl、.jar、.tar.gz)。 |
|
| environmentYml |
string |
源库。 |