Custom Pools - List Workspace Custom Pools
Aangepaste pools weergeven.
Machtigingen
De beller moet viewer hebben of een hogere werkruimterol.
Vereiste gedelegeerde bereiken
Workspace.Read.All of Workspace.ReadWrite.All
Door Microsoft Entra ondersteunde identiteiten
Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.
Identiteit | Ondersteuning |
---|---|
Gebruiker | Ja |
service-principal en beheerde identiteiten | Ja |
gebruikersinterface
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/spark/pools
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/spark/pools?continuationToken={continuationToken}
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
workspace
|
path | True |
string (uuid) |
De werkruimte-id. |
continuation
|
query |
string |
Vervolgtoken. Wordt gebruikt om de volgende items in de lijst op te halen. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
De aanvraag is voltooid. |
|
Other Status Codes |
Veelvoorkomende foutcodes:
|
Voorbeelden
List custom pools example |
List custom pools with continuation example |
List custom pools example
Voorbeeldaanvraag
GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools
Voorbeeldrespons
{
"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
Voorbeeldaanvraag
GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools
Voorbeeldrespons
{
"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"
}
Definities
Name | Description |
---|---|
Auto |
Eigenschappen voor automatisch schalen. |
Custom |
Aangepaste pool. |
Custom |
|
Custom |
Aangepast pooltype. Er kunnen in de loop van de tijd extra |
Dynamic |
Dynamische uitvoerprogrammatoewijzingsproxy's. |
Error |
Het foutgerelateerde resourcedetailsobject. |
Error |
Het foutbericht. |
Error |
De details van het foutbericht. |
Node |
Knooppuntfamilie. Er kunnen in de loop van de tijd extra |
Node |
knooppuntgrootte. Er kunnen in de loop van de tijd extra |
AutoScaleProperties
Eigenschappen voor automatisch schalen.
Name | Type | Description |
---|---|---|
enabled |
boolean |
De status van de automatische schaal. False - Disabled, true - Enabled. |
maxNodeCount |
integer (int32) minimum: 1 |
Het maximumaantal knooppunten. |
minNodeCount |
integer (int32) minimum: 1 |
Het minimumaantal knooppunten. |
CustomPool
Aangepaste pool.
Name | Type | Description |
---|---|---|
autoScale |
Automatische schaalaanpassing. |
|
dynamicExecutorAllocation |
Dynamische uitvoerdertoewijzing. |
|
id |
string (uuid) |
Aangepaste pool-id. |
name |
string |
Naam van aangepaste pool. |
nodeFamily |
Knooppuntfamilie. |
|
nodeSize |
Knooppuntgrootte. |
|
type |
Aangepast pooltype. |
CustomPools
Name | Type | Description |
---|---|---|
continuationToken |
string |
Het token voor de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord. |
continuationUri |
string |
De URI van de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord. |
value |
Een lijst met aangepaste pools. |
CustomPoolType
Aangepast pooltype. Er kunnen in de loop van de tijd extra CustomPoolType
typen worden toegevoegd.
Waarde | Description |
---|---|
Capacity |
Aangepaste pool op capaciteitsniveau |
Workspace |
Aangepaste pool op werkruimteniveau |
DynamicExecutorAllocationProperties
Dynamische uitvoerprogrammatoewijzingsproxy's.
Name | Type | Description |
---|---|---|
enabled |
boolean |
De status van de dynamische uitvoerderstoewijzing. False - Disabled, true - Enabled. |
maxExecutors |
integer (int32) minimum: 1 |
De maximale uitvoerders. |
minExecutors |
integer (int32) minimum: 1 |
De minimale uitvoerders. |
ErrorRelatedResource
Het foutgerelateerde resourcedetailsobject.
Name | Type | Description |
---|---|---|
resourceId |
string |
De resource-id die betrokken is bij de fout. |
resourceType |
string |
Het type resource dat betrokken is bij de fout. |
ErrorResponse
Het foutbericht.
Name | Type | Description |
---|---|---|
errorCode |
string |
Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is. |
message |
string |
Een leesbare weergave van de fout. |
moreDetails |
Lijst met aanvullende foutdetails. |
|
relatedResource |
De foutgerelateerde resourcedetails. |
|
requestId |
string |
Id van de aanvraag die is gekoppeld aan de fout. |
ErrorResponseDetails
De details van het foutbericht.
Name | Type | Description |
---|---|---|
errorCode |
string |
Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is. |
message |
string |
Een leesbare weergave van de fout. |
relatedResource |
De foutgerelateerde resourcedetails. |
NodeFamily
Knooppuntfamilie. Er kunnen in de loop van de tijd extra NodeFamily
typen worden toegevoegd.
Waarde | Description |
---|---|
MemoryOptimized |
Geoptimaliseerd voor geheugen |
NodeSize
knooppuntgrootte. Er kunnen in de loop van de tijd extra NodeSize
typen worden toegevoegd.
Waarde | Description |
---|---|
Large |
Grote knooppuntgrootte |
Medium |
Gemiddelde knooppuntgrootte |
Small |
Kleine knooppuntgrootte |
XLarge |
XLarge-knooppuntgrootte |
XXLarge |
XxLarge-knooppuntgrootte |