Items - List Environments

การอ้างอิง

บริการ:: Environment

เวอร์ชัน API:: v1

แสดงรายการของสภาพแวดล้อมจากพื้นที่ทํางานที่ระบุ
API นี้สนับสนุน การแบ่งหน้า

สิทธิ์

ผู้เรียกต้องมีบทบาท ของผู้ชม หรือสูงกว่าพื้นที่ทํางาน

จําเป็นต้องมีขอบเขตที่ได้รับมอบสิทธิ์

Workspace.Read.All หรือ Workspace.ReadWrite.All

ข้อมูลประจําตัวที่สนับสนุนของ Microsoft Entra

API นี้สนับสนุนข้อมูลประจําตัวของ Microsoft แสดงรายการในส่วนนี้

เอกลักษณ์	สนับสนุน
ผู้ใช้	ใช่
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ	ใช่

อิน เทอร์ เฟซ

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

ด้วยพารามิเตอร์ที่เลือกได้:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments?continuationToken={continuationToken}

พารามิเตอร์ URI

ชื่อ	ใน	จำเป็น	พิมพ์	คำอธิบาย
workspaceId	path	True	string uuid	ID พื้นที่ทํางาน
continuationToken	query		string	โทเค็นสําหรับการเรียกใช้หน้าถัดไปของผลลัพธ์

การตอบสนอง

ชื่อ	พิมพ์	คำอธิบาย
200 OK	Environments	คําขอเสร็จสมบูรณ์
Other Status Codes	ErrorResponse	รหัสข้อผิดพลาดทั่วไป: InvalidItemType - ชนิดรายการไม่ถูกต้อง

ชื่อ

พิมพ์

คำอธิบาย

200 OK

Environments

คําขอเสร็จสมบูรณ์

Other Status Codes

ErrorResponse

รหัสข้อผิดพลาดทั่วไป:

InvalidItemType - ชนิดรายการไม่ถูกต้อง

ตัวอย่าง

List environments in workspace example

คำขอตัวอย่าง

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments

คำตอบตัวอย่าง

รหัสสถานะ:: 200

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Environment_1",
      "description": "A environment description.",
      "type": "Environment",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "publishDetails": {
          "state": "Failed",
          "targetVersion": "14ece8b5-68a1-4130-a9e7-074c04537588",
          "startTime": "2024-03-30T14:17:09.0697022Z",
          "endTime": "2024-03-30T14:48:09.0697022Z",
          "componentPublishInfo": {
            "sparkLibraries": {
              "state": "Failed"
            },
            "sparkSettings": {
              "state": "Success"
            }
          }
        }
      }
    },
    {
      "id": "a8a1bffa-7eea-49dc-a1d2-6281c1d031f1",
      "displayName": "Environment_2",
      "description": "A environment description.",
      "type": "Environment",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "publishDetails": {
          "state": "Success",
          "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
          "startTime": "2024-03-29T14:17:09.0697022Z",
          "endTime": "2024-03-29T14:48:09.0697022Z",
          "componentPublishInfo": {
            "sparkLibraries": {
              "state": "Success"
            },
            "sparkSettings": {
              "state": "Success"
            }
          }
        }
      }
    }
  ]
}

คำจำกัดความ

ชื่อ	คำอธิบาย
ComponentPublishInfo	เผยแพร่ข้อมูลสําหรับแต่ละคอมโพเนนต์ในสภาพแวดล้อม
Environment	รายการสภาพแวดล้อม
EnvironmentPublishInfo	ข้อมูลการเผยแพร่สภาพแวดล้อม
EnvironmentPublishState	เผยแพร่สถานะ คุณสามารถเพิ่มชนิดสถานะเพิ่มเติมเมื่อเวลาผ่านไป
Environments	รายการของสภาพแวดล้อม
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
ItemType	ชนิดของสินค้า คุณสามารถเพิ่มชนิดหน่วยข้อมูลเพิ่มเติมเมื่อเวลาผ่านไป
PublishDetails	รายละเอียดของการดําเนินการเผยแพร่
SparkLibraries	ไลบรารี Spark
SparkSettings	การตั้งค่า Spark

ComponentPublishInfo

ออบเจ็กต์

เผยแพร่ข้อมูลสําหรับแต่ละคอมโพเนนต์ในสภาพแวดล้อม

ชื่อ	พิมพ์	คำอธิบาย
sparkLibraries	SparkLibraries	ไลบรารี Spark จะเผยแพร่ข้อมูล
sparkSettings	SparkSettings	การตั้งค่า Spark เผยแพร่ข้อมูล

Environment

ออบเจ็กต์

รายการสภาพแวดล้อม

ชื่อ	พิมพ์	คำอธิบาย
description	string	คําอธิบายสินค้า
displayName	string	ชื่อที่แสดงของรายการ
id	string uuid	รหัสสินค้า
properties	EnvironmentPublishInfo	คุณสมบัติสภาพแวดล้อม
type	ItemType	ชนิดหน่วยข้อมูล
workspaceId	string uuid	ID พื้นที่ทํางาน

EnvironmentPublishInfo

ออบเจ็กต์

ข้อมูลการเผยแพร่สภาพแวดล้อม

ชื่อ	พิมพ์	คำอธิบาย
publishDetails	PublishDetails	รายละเอียดการดําเนินการเผยแพร่สภาพแวดล้อม

EnvironmentPublishState

การแจงนับ

เผยแพร่สถานะ คุณสามารถเพิ่มชนิดสถานะเพิ่มเติมเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
Cancelled	การเผยแพร่สภาพแวดล้อมอยู่ในสถานะถูกยกเลิก
Cancelling	การเผยแพร่สภาพแวดล้อมอยู่ในสถานะการยกเลิก
Failed	การเผยแพร่สภาพแวดล้อมอยู่ในสถานะล้มเหลว
Running	การเผยแพร่สภาพแวดล้อมอยู่ในสถานะกําลังทํางาน
Success	การเผยแพร่สภาพแวดล้อมอยู่ในสถานะสําเร็จ
Waiting	การเผยแพร่สภาพแวดล้อมอยู่ในสถานะกําลังรอ

Environments

ออบเจ็กต์

รายการของสภาพแวดล้อม

ชื่อ	พิมพ์	คำอธิบาย
continuationToken	string	โทเค็นสําหรับชุดผลลัพธ์ชุดถัดไป ถ้าไม่มีระเบียนเพิ่มเติม จะถูกลบออกจากการตอบสนอง
continuationUri	string	URI ของชุดงานชุดผลลัพธ์ถัดไป ถ้าไม่มีระเบียนเพิ่มเติม จะถูกลบออกจากการตอบสนอง
value	Environment[]	รายการของสภาพแวดล้อม

ErrorRelatedResource

ออบเจ็กต์

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ชื่อ	พิมพ์	คำอธิบาย
resourceId	string	ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType	string	ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

ออบเจ็กต์

การตอบสนองข้อผิดพลาด

ชื่อ	พิมพ์	คำอธิบาย
errorCode	string	ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message	string	การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
moreDetails	ErrorResponseDetails[]	รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
relatedResource	ErrorRelatedResource	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
requestId	string	รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

ออบเจ็กต์

รายละเอียดการตอบสนองข้อผิดพลาด

ชื่อ	พิมพ์	คำอธิบาย
errorCode	string	ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message	string	การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
relatedResource	ErrorRelatedResource	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ItemType

การแจงนับ

ชนิดของสินค้า คุณสามารถเพิ่มชนิดหน่วยข้อมูลเพิ่มเติมเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
Dashboard	แดชบอร์ด PowerBI
DataPipeline	ไปป์ไลน์ข้อมูล
Datamart	Datamart ของ PowerBI
Environment	สภาพแวดล้อม
Eventhouse	อาคารจัดงาน
Eventstream	เหตุการณ์กระแสข้อมูล
GraphQLApi	API สําหรับรายการ GraphQL
KQLDashboard	แดชบอร์ด KQL
KQLDatabase	ฐานข้อมูล KQL
KQLQueryset	ชุดคิวรี KQL
Lakehouse	เลคเฮ้าส์
MLExperiment	การทดลองการเรียนรู้ของเครื่อง
MLModel	แบบจําลองการเรียนรู้ของเครื่อง
MirroredDatabase	ฐานข้อมูลที่มิเรอร์
MirroredWarehouse	คลังสินค้าที่มิเรอร์
MountedDataFactory	เมาท์ DataFactory
Notebook	โน๊ตบุ๊ค
PaginatedReport	รายงานที่มีการแบ่งหน้าของ PowerBI
Reflex	รีเฟล็กซ์
Report	รายงาน PowerBI
SQLDatabase	SQLDatabase
SQLEndpoint	จุดสิ้นสุด SQL
SemanticModel	แบบจําลองความหมายของ PowerBI
SparkJobDefinition	ข้อกําหนดงานแบบประกายไฟ
Warehouse	คลังสินค้า

PublishDetails

ออบเจ็กต์

รายละเอียดของการดําเนินการเผยแพร่

ชื่อ	พิมพ์	คำอธิบาย
componentPublishInfo	ComponentPublishInfo	ข้อมูลการเผยแพร่คอมโพเนนต์ของสภาพแวดล้อม
endTime	string date-time	เวลาสิ้นสุดของการดําเนินการเผยแพร่
startTime	string date-time	เวลาเริ่มต้นของการดําเนินการเผยแพร่
state	EnvironmentPublishState	เผยแพร่สถานะ คุณสามารถเพิ่มชนิดสถานะเพิ่มเติมเมื่อเวลาผ่านไป
targetVersion	string uuid	รุ่นเป้าหมายที่จะเผยแพร่

SparkLibraries

ออบเจ็กต์

ไลบรารี Spark

ชื่อ	พิมพ์	คำอธิบาย
state	EnvironmentPublishState	เผยแพร่สถานะ คุณสามารถเพิ่มชนิดสถานะเพิ่มเติมเมื่อเวลาผ่านไป

SparkSettings

ออบเจ็กต์

การตั้งค่า Spark

ชื่อ	พิมพ์	คำอธิบาย
state	EnvironmentPublishState	เผยแพร่สถานะ คุณสามารถเพิ่มชนิดสถานะเพิ่มเติมเมื่อเวลาผ่านไป

แชร์ผ่าน

Items - List Environments

สิทธิ์

จําเป็นต้องมีขอบเขตที่ได้รับมอบสิทธิ์

ข้อมูลประจําตัวที่สนับสนุนของ Microsoft Entra

อิน เทอร์ เฟซ

พารามิเตอร์ URI

การตอบสนอง

ตัวอย่าง

List environments in workspace example

คำขอตัวอย่าง

คำตอบตัวอย่าง

คำจำกัดความ

ComponentPublishInfo

Environment

EnvironmentPublishInfo

EnvironmentPublishState

Environments

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

PublishDetails

SparkLibraries

SparkSettings

แหล่งทรัพยากรเพิ่มเติม