แชร์ผ่าน

Workspace Settings - Get Spark Settings

บริการ:
Spark
เวอร์ชัน API:
v1

รับการตั้งค่า Spark ของพื้นที่ทํางาน

สิทธิ์

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

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

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

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

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

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

อินเตอร์เฟซ

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

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

ชื่อ ใน จำเป็น พิมพ์ คำอธิบาย
workspaceId
 path True

string (uuid)

ID พื้นที่ทํางาน

การตอบสนอง

ชื่อ พิมพ์ คำอธิบาย
200 OK

WorkspaceSparkSettings

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

ErrorResponse

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

  • UnknownError - เกิดข้อผิดพลาด

ตัวอย่าง

Get workspace Spark settings example

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

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/settings

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

รหัสสถานะ:
200 
{
  "automaticLog": {
    "enabled": true
  },
  "highConcurrency": {
    "notebookInteractiveRunEnabled": true,
    "notebookPipelineRunEnabled": false
  },
  "pool": {
    "customizeComputeEnabled": true,
    "defaultPool": {
      "name": "Starter Pool",
      "type": "Workspace",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    "starterPool": {
      "maxNodeCount": 2,
      "maxExecutors": 1
    }
  },
  "environment": {
    "name": "environment1",
    "runtimeVersion": "1.2"
  },
  "job": {
    "conservativeJobAdmissionEnabled": false,
    "sessionTimeoutInMinutes": 20
  }
}

คำจำกัดความ

ชื่อ คำอธิบาย
AutomaticLogProperties

คุณสมบัติบันทึกอัตโนมัติ
CustomPoolType

ชนิดกลุ่มที่กําหนดเอง ประเภท CustomPoolType เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
EnvironmentProperties

คุณสมบัติของสภาพแวดล้อม
ErrorRelatedResource

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

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

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

คุณสมบัติภาวะพร้อมกันสูง
InstancePool
PoolProperties

คุณสมบัติของพูล
SparkJobsProperties

คุณสมบัติของงาน Spark
StarterPoolProperties

กลุ่มเริ่มต้นแบบกําหนดเอง
WorkspaceSparkSettings

การตั้งค่าพื้นที่ทํางาน Spark

AutomaticLogProperties

ออบเจ็กต์

คุณสมบัติบันทึกอัตโนมัติ

ชื่อ พิมพ์ คำอธิบาย
enabled

boolean

สถานะของบันทึกอัตโนมัติ False - ปิดใช้งาน จริง - เปิดใช้งาน

CustomPoolType

การแจงนับ

ชนิดกลุ่มที่กําหนดเอง ประเภท CustomPoolType เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป

ค่า คำอธิบาย
Workspace

กลุ่มแบบกําหนดเองระดับพื้นที่ทํางาน
Capacity

กลุ่มที่กําหนดเองของระดับกําลังการผลิต

EnvironmentProperties

ออบเจ็กต์

คุณสมบัติของสภาพแวดล้อม

ชื่อ พิมพ์ คำอธิบาย
name

string

ชื่อของสภาพแวดล้อมเริ่มต้น สตริงที่ว่างเปล่าระบุว่าไม่มีสภาพแวดล้อมเริ่มต้นของพื้นที่ทํางาน
runtimeVersion

string

เวอร์ชัน รันไทม์ ตัวอย่างเช่น: 1.3

ErrorRelatedResource

ออบเจ็กต์

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

ชื่อ พิมพ์ คำอธิบาย
resourceId

string

ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType

string

ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

ออบเจ็กต์

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

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
moreDetails

ErrorResponseDetails[]

รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
relatedResource

ErrorRelatedResource

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

string

รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

ออบเจ็กต์

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

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
relatedResource

ErrorRelatedResource

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

HighConcurrencyProperties

ออบเจ็กต์

คุณสมบัติภาวะพร้อมกันสูง

ชื่อ พิมพ์ คำอธิบาย
notebookInteractiveRunEnabled

boolean

สถานะของภาวะพร้อมกันสูงสําหรับการเรียกใช้สมุดบันทึกแบบโต้ตอบ False - ปิดใช้งาน จริง - เปิดใช้งาน
notebookPipelineRunEnabled

boolean

สถานะของภาวะพร้อมกันสูงสําหรับการเรียกใช้ไปป์ไลน์สมุดบันทึก False - ปิดใช้งาน จริง - เปิดใช้งาน

InstancePool

ออบเจ็กต์
ชื่อ พิมพ์ คำอธิบาย
id

string (uuid)

รหัสกลุ่มอินสแตนซ์
name

string

ชื่อพูลอินสแตนซ์
type

CustomPoolType

ชนิดพูลอินสแตนซ์

PoolProperties

ออบเจ็กต์

คุณสมบัติของพูล

ชื่อ พิมพ์ คำอธิบาย
customizeComputeEnabled

boolean

กําหนดการกําหนดค่าการคํานวณสําหรับรายการ False - ปิดใช้งาน จริง - เปิดใช้งาน
defaultPool

InstancePool

กลุ่มเริ่มต้นสําหรับพื้นที่ทํางาน ซึ่งควรเป็นชื่อพูลแบบกําหนดเองที่ถูกต้อง "Starter Pool" หมายถึงใช้พูลตัวเริ่มต้น
starterPool

StarterPoolProperties

กําหนดพูลตัวเริ่มต้น สําหรับข้อมูลเพิ่มเติมเกี่ยวกับการกําหนดค่าพูลตัวเริ่มต้น ให้ดูที่ การกําหนดค่ากลุ่มเริ่มต้น

SparkJobsProperties

ออบเจ็กต์

คุณสมบัติของงาน Spark

ชื่อ พิมพ์ คำอธิบาย
conservativeJobAdmissionEnabled

boolean

จองแกนประมวลผลสูงสุดสําหรับงาน Spark ที่ใช้งานอยู่ เมื่อเปิดใช้งานการตั้งค่านี้ ความจุ Fabric ของคุณจะสงวนจํานวนแกนหลักสูงสุดที่จําเป็นสําหรับงาน Spark ที่ใช้งานอยู่ เพื่อให้มั่นใจถึงความน่าเชื่อถือของงานโดยตรวจสอบให้แน่ใจว่าแกนหลักพร้อมใช้งานถ้างานมีมาตราส่วนขึ้น เมื่อการตั้งค่านี้ถูกปิดใช้งาน งานจะเริ่มต้นตามจํานวนแกนต่ําสุดที่จําเป็น เพื่อให้สามารถเรียกใช้งานเพิ่มเติมในเวลาเดียวกันได้ สําหรับข้อมูลเพิ่มเติม โปรดดู เข้ารับงานและการจัดการ False - ปิดใช้งาน จริง - เปิดใช้งาน
sessionTimeoutInMinutes

integer (int32)

minimum: 1
maximum: 20160

ถึงเวลาสิ้นสุดเซสชัน Spark ที่ไม่ได้ใช้งาน สูงสุดคือ 14 วัน

StarterPoolProperties

ออบเจ็กต์

กลุ่มเริ่มต้นแบบกําหนดเอง

ชื่อ พิมพ์ คำอธิบาย
maxExecutors

integer (int32)

minimum: 1

จํานวนตัวดําเนินการสูงสุด
maxNodeCount

integer (int32)

minimum: 1

จํานวนโหนดสูงสุด

WorkspaceSparkSettings

ออบเจ็กต์

การตั้งค่าพื้นที่ทํางาน Spark

ชื่อ พิมพ์ คำอธิบาย
automaticLog

AutomaticLogProperties

การตั้งค่าการบันทึกอัตโนมัติ
environment

EnvironmentProperties

การตั้งค่าสภาพแวดล้อม
highConcurrency

HighConcurrencyProperties

การตั้งค่าภาวะพร้อมกันสูง
job

SparkJobsProperties

การตั้งค่าการบริหารงาน
pool

PoolProperties

การตั้งค่าพูล