Freigeben über

Custom Pools - List Workspace Custom Pools

  • Referenz
Dienst:
Spark
API-Version:
v1

Auflisten von benutzerdefinierten Pools.

Erlaubnisse

Der Anrufer muss Viewer-rolle oder höherer Arbeitsbereichsrolle haben.

Erforderliche delegierte Bereiche

Workspace.Read.All oder Workspace.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität Unterstützung
Benutzer Ja
Dienstprinzipal und verwaltete Identitäten Ja

Schnittstelle

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/spark/pools
Mit optionalen Parametern: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/spark/pools?continuationToken={continuationToken}

URI-Parameter

Name In Erforderlich Typ Beschreibung
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.
continuationToken
 query

string

Fortsetzungstoken. Wird verwendet, um die nächsten Elemente in der Liste abzurufen.

Antworten

Name Typ Beschreibung
200 OK

CustomPools

Die Anforderung wurde erfolgreich abgeschlossen.
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • UnknownError – Ein Fehler ist aufgetreten.

Beispiele

List custom pools example
List custom pools with continuation example

List custom pools example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200 
{
  "value": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Starter Pool",
      "type": "Workspace",
      "nodeFamily": "MemoryOptimized",
      "nodeSize": "Medium",
      "autoScale": {
        "enabled": true,
        "minNodeCount": 1,
        "maxNodeCount": 10
      },
      "dynamicExecutorAllocation": {
        "enabled": true,
        "minExecutors": 1,
        "maxExecutors": 9
      }
    },
    {
      "id": "2367293d-b70b-4b33-97f2-161b8d04a8d7",
      "name": "pool1",
      "type": "Workspace",
      "nodeFamily": "MemoryOptimized",
      "nodeSize": "Small",
      "autoScale": {
        "enabled": true,
        "minNodeCount": 1,
        "maxNodeCount": 4
      },
      "dynamicExecutorAllocation": {
        "enabled": true,
        "minExecutors": 1,
        "maxExecutors": 2
      }
    }
  ]
}

List custom pools with continuation example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200 
{
  "value": [
    {
      "id": "2367293d-b70b-4b33-97f2-161b8d04a8d7",
      "name": "pool1",
      "type": "Workspace",
      "nodeFamily": "MemoryOptimized",
      "nodeSize": "Small",
      "autoScale": {
        "enabled": true,
        "minNodeCount": 1,
        "maxNodeCount": 4
      },
      "dynamicExecutorAllocation": {
        "enabled": true,
        "minExecutors": 1,
        "maxExecutors": 2
      }
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools?continuationToken=LDEsMTAwMDAwLDA%3D"
}

Definitionen

Name Beschreibung
AutoScaleProperties

Autoskaleneigenschaften.
CustomPool

Benutzerdefinierter Pool.
CustomPools
CustomPoolType

Benutzerdefinierter Pooltyp. Zusätzliche CustomPoolType Typen können im Laufe der Zeit hinzugefügt werden.
DynamicExecutorAllocationProperties

Dynamischer Zuweisungsprozeur.
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
NodeFamily

Knotenfamilie. Zusätzliche NodeFamily Typen können im Laufe der Zeit hinzugefügt werden.
NodeSize

Knotengröße. Zusätzliche NodeSize Typen können im Laufe der Zeit hinzugefügt werden.

AutoScaleProperties

Objekt

Autoskaleneigenschaften.

Name Typ Beschreibung
enabled

boolean

Der Status der automatischen Skalierung. False – Deaktiviert, true – Aktiviert.
maxNodeCount

integer (int32)

minimum: 1

Die maximale Knotenanzahl.
minNodeCount

integer (int32)

minimum: 1

Die minimale Knotenanzahl.

CustomPool

Objekt

Benutzerdefinierter Pool.

Name Typ Beschreibung
autoScale

AutoScaleProperties

Autoskalierung.
dynamicExecutorAllocation

DynamicExecutorAllocationProperties

Dynamische Ausführungszuweisung.
id

string (uuid)

Benutzerdefinierte Pool-ID.
name

string

Benutzerdefinierter Poolname.
nodeFamily

NodeFamily

Knotenfamilie.
nodeSize

NodeSize

Knotengröße.
type

CustomPoolType

Benutzerdefinierter Pooltyp.

CustomPools

Objekt
Name Typ Beschreibung
continuationToken

string

Das Token für den nächsten Resultsetbatch. Wenn keine weiteren Datensätze vorhanden sind, wird sie aus der Antwort entfernt.
continuationUri

string

Der URI des nächsten Resultsetbatches. Wenn keine weiteren Datensätze vorhanden sind, wird sie aus der Antwort entfernt.
value

CustomPool[]

Eine Liste von benutzerdefinierten Pools.

CustomPoolType

Enumeration

Benutzerdefinierter Pooltyp. Zusätzliche CustomPoolType Typen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Capacity

Benutzerdefinierter Pool auf Kapazitätsebene
Workspace

Benutzerdefinierter Pool auf Arbeitsbereichsebene

DynamicExecutorAllocationProperties

Objekt

Dynamischer Zuweisungsprozeur.

Name Typ Beschreibung
enabled

boolean

Der Status der dynamischen Executorzuordnung. False – Deaktiviert, true – Aktiviert.
maxExecutors

integer (int32)

minimum: 1

Die maximalen Executoren.
minExecutors

integer (int32)

minimum: 1

Die Minimalausführer.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

NodeFamily

Enumeration

Knotenfamilie. Zusätzliche NodeFamily Typen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
MemoryOptimized

Arbeitsspeicheroptimiert

NodeSize

Enumeration

Knotengröße. Zusätzliche NodeSize Typen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Large

Große Knotengröße
Medium

Mittlere Knotengröße
Small

Kleine Knotengröße
XLarge

XLarge-Knotengröße
XXLarge

Größe des Knotens XXLarge