Items - List Spark Job Definitions

Dienst:

SparkJobDefinition

API-Version:

v1

Gibt eine Liste der Sparkauftragsdefinitionen aus dem angegebenen Arbeitsbereich zurück.
Diese API unterstützt Paginierung.

Erlaubnisse

Der Aufrufer muss über eine Rolle des Viewer-Arbeitsbereichs verfügen.

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ützen
Benutzer	Ja
Dienstprinzipal und verwaltete Identitäten	Ja

Schnittstelle

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.
continuationToken	query		string	Ein Token zum Abrufen der nächsten Seite mit Ergebnissen.

Antworten

Name	Typ	Beschreibung
200 OK	SparkJobDefinitions	Die Anforderung wurde erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Häufige Fehlercodes: InvalidItemType – Ungültiger Elementtyp.

Beispiele

List spark job definitions in workspace example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "SparkJobDefinition Name 1",
      "description": "A spark job definition description.",
      "type": "SparkJobDefinition",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
      }
    },
    {
      "id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
      "displayName": "SparkJobDefinition Name 2",
      "description": "A spark job definition description.",
      "type": "SparkJobDefinition",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/d8f6cf16-3aac-4440-9d76-a03d86b7ae3e"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
ItemTag	Stellt ein Tag dar, das auf ein Element angewendet wird.
ItemType	Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.
SparkJobDefinition	Ein Sparkauftragsdefinitionsobjekt.
SparkJobDefinitionProperties	Die Eigenschaften der Sparkauftragsdefinition.
SparkJobDefinitions	Eine Liste der Sparkauftragsdefinitionen.

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.

ItemTag

Objekt

Stellt ein Tag dar, das auf ein Element angewendet wird.

Name	Typ	Beschreibung
displayName	string	Der Name des Tags.
id	string (uuid)	Die Tag-ID.

ItemType

Enumeration

Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
ApacheAirflowJob	Ein ApacheAirflowJob.
CopyJob	Ein Kopierauftrag.
Dashboard	PowerBI-Dashboard.
DataPipeline	Eine Datenpipeline.
Dataflow	Ein Datenfluss.
Datamart	PowerBI datamart.
DigitalTwinBuilder	Ein DigitalTwinBuilder.
DigitalTwinBuilderFlow	Ein Digital Twin Builder Flow.
Environment	Eine Umgebung.
Eventhouse	Ein Eventhouse.
Eventstream	Ein Ereignisstream.
GraphQLApi	Eine API für GraphQL-Element.
KQLDashboard	Ein KQL-Dashboard.
KQLDatabase	Eine KQL-Datenbank.
KQLQueryset	Ein KQL-Abfrageset.
Lakehouse	Ein Seehaus.
MLExperiment	Ein Machine Learning-Experiment.
MLModel	Ein Machine Learning-Modell.
MirroredAzureDatabricksCatalog	Ein gespiegelter Azure Databricks-Katalog.
MirroredDatabase	Eine gespiegelte Datenbank.
MirroredWarehouse	Ein gespiegeltes Lager.
MountedDataFactory	Eine MountedDataFactory.
Notebook	Ein Notizbuch.
PaginatedReport	PowerBI-Paginated-Bericht.
Reflex	Ein Reflex.
Report	PowerBI-Bericht.
SQLDatabase	Eine SQLDatabase.
SQLEndpoint	Ein SQL-Endpunkt.
SemanticModel	PowerBI-Semantikmodell.
SparkJobDefinition	Eine Sparkauftragsdefinition.
VariableLibrary	Eine VariableLibrary.
Warehouse	Ein Lagerhaus.
WarehouseSnapshot	Eine Warehouse-Momentaufnahme.

SparkJobDefinition

Objekt

Ein Sparkauftragsdefinitionsobjekt.

Name	Typ	Beschreibung
description	string	Die Elementbeschreibung.
displayName	string	Der Anzeigename des Elements.
folderId	string (uuid)	Die Ordner-ID.
id	string (uuid)	Die Element-ID.
properties	SparkJobDefinitionProperties	Die Eigenschaften der Sparkauftragsdefinition.
tags	ItemTag[]	Liste der angewendeten Tags.
type	ItemType	Der Elementtyp.
workspaceId	string (uuid)	Die Arbeitsbereichs-ID.

SparkJobDefinitionProperties

Objekt

Die Eigenschaften der Sparkauftragsdefinition.

Name	Typ	Beschreibung
oneLakeRootPath	string	OneLake-Pfad zum SparkJobDefinition-Stammverzeichnis.

SparkJobDefinitions

Objekt

Eine Liste der Sparkauftragsdefinitionen.

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	SparkJobDefinition[]	Eine Liste der Sparkauftragsdefinitionen.