Freigeben über


Spark Job Definition - Get Spark Job Definitions By Workspace

Listen Spark-Auftragsdefinitionen.

GET {endpoint}/sparkJobDefinitions?api-version=2020-12-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
path True

string

uri

Der Endpunkt zur Arbeitsbereichsentwicklung, Beispiel: https://myworkspace.dev.azuresynapse.net

api-version
query True

string

Die Synapse-Client-API-Version.

Antworten

Name Typ Beschreibung
200 OK

SparkJobDefinitionsListResponse

OK.

Other Status Codes

CloudError

Eine Fehlerantwort, die vom Azure Synapse-Dienst empfangen wurde.

Beispiele

SparkJobDefinitions_ListByWorkspace

Beispielanforderung

GET exampleWorkspace.dev.azuresynapse.net/sparkJobDefinitions?api-version=2020-12-01

Beispiel für eine Antwort

Date: Sat, 16 Jun 2018 00:37:43 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14990
x-ms-request-id: 92292250-c10f-4c47-8eb6-b886b361add7
x-ms-correlation-request-id: 92292250-c10f-4c47-8eb6-b886b361add7
{
  "value": [
    {
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sparkjobdefinitions/exampleSparkJobDefinition",
      "name": "exampleSparkJobDefinition",
      "type": "Microsoft.Synapse/workspaces/sparkjobdefinitions",
      "properties": {
        "description": "A sample spark job definition",
        "targetBigDataPool": {
          "referenceName": "exampleBigDataPool",
          "type": "BigDataPoolReference"
        },
        "requiredSparkVersion": "3.3",
        "jobProperties": {
          "name": "exampleSparkJobDefinition",
          "file": "abfss://test@test.dfs.core.windows.net/artefacts/sample.jar",
          "className": "dev.test.tools.sample.Main",
          "conf": {},
          "args": [
            "exampleArg"
          ],
          "jars": [],
          "pyFiles": [],
          "files": [],
          "archives": [],
          "driverMemory": "28g",
          "driverCores": 4,
          "executorMemory": "28g",
          "executorCores": 4,
          "numExecutors": 2
        }
      },
      "etag": "1500504f-0000-0200-0000-5cbe090f0000"
    }
  ]
}

Definitionen

Name Beschreibung
BigDataPoolReference

Big Data-Poolreferenz.

BigDataPoolReferenceType

Verweistyp des Big Data-Pools.

CloudError

Das -Objekt, das die Struktur einer Azure Synapse Fehlerantwort definiert.

Folder

Der Ordner, in dem sich diese Spark-Auftragsdefinition befindet. Wenn nicht angegeben, wird diese Spark-Auftragsdefinition auf Stammebene angezeigt.

SparkConfigurationReference

Referenz zur Spark-Konfiguration.

SparkConfigurationReferenceType

Spark-Konfigurationsreferenztyp.

SparkJobDefinition

Spark-Auftragsdefinition.

SparkJobDefinitionResource

Ressourcentyp der Spark-Auftragsdefinition.

SparkJobDefinitionsListResponse

Eine Liste der Ressourcen für Spark-Auftragsdefinitionen.

SparkJobProperties

Die Eigenschaften des Spark-Auftrags.

BigDataPoolReference

Big Data-Poolreferenz.

Name Typ Beschreibung
referenceName

string

Verweisen Sie auf den Namen des Big Data-Pools.

type

BigDataPoolReferenceType

Verweistyp des Big Data-Pools.

BigDataPoolReferenceType

Verweistyp des Big Data-Pools.

Name Typ Beschreibung
BigDataPoolReference

string

CloudError

Das -Objekt, das die Struktur einer Azure Synapse Fehlerantwort definiert.

Name Typ Beschreibung
error.code

string

Fehlercode

error.details

CloudError[]

Array mit zusätzlichen Fehlerdetails.

error.message

string

Fehlermeldung.

error.target

string

Eigenschaftsname/Pfad in der Anforderung, die einem Fehler zugeordnet ist.

Folder

Der Ordner, in dem sich diese Spark-Auftragsdefinition befindet. Wenn nicht angegeben, wird diese Spark-Auftragsdefinition auf Stammebene angezeigt.

Name Typ Beschreibung
name

string

Der Name des Ordners, in dem sich diese Spark-Auftragsdefinition befindet.

SparkConfigurationReference

Referenz zur Spark-Konfiguration.

Name Typ Beschreibung
referenceName

string

Verweisen Sie auf den Namen der Spark-Konfiguration.

type

SparkConfigurationReferenceType

Spark-Konfigurationsreferenztyp.

SparkConfigurationReferenceType

Spark-Konfigurationsreferenztyp.

Name Typ Beschreibung
SparkConfigurationReference

string

SparkJobDefinition

Spark-Auftragsdefinition.

Name Typ Beschreibung
description

string

Die Beschreibung der Spark-Auftragsdefinition.

folder

Folder

Der Ordner, in dem sich diese Spark-Auftragsdefinition befindet. Wenn nicht angegeben, wird diese Spark-Auftragsdefinition auf Stammebene angezeigt.

jobProperties

SparkJobProperties

Die Eigenschaften des Spark-Auftrags.

language

string

Die Sprache der Spark-Anwendung.

requiredSparkVersion

string

Die erforderliche Spark-Version der Anwendung.

targetBigDataPool

BigDataPoolReference

Big Data-Poolreferenz.

targetSparkConfiguration

SparkConfigurationReference

Die Spark-Konfiguration des Spark-Auftrags.

SparkJobDefinitionResource

Ressourcentyp der Spark-Auftragsdefinition.

Name Typ Beschreibung
etag

string

Ressourcen-Etag.

id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Der Name der Ressource

properties

SparkJobDefinition

Eigenschaften der Spark-Auftragsdefinition.

type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

SparkJobDefinitionsListResponse

Eine Liste der Ressourcen für Spark-Auftragsdefinitionen.

Name Typ Beschreibung
nextLink

string

Der Link zur nächsten Ergebnisseite, wenn noch vorhandene Ergebnisse vorhanden sind.

value

SparkJobDefinitionResource[]

Liste der Spark-Auftragsdefinitionen.

SparkJobProperties

Die Eigenschaften des Spark-Auftrags.

Name Typ Beschreibung
archives

string[]

Archive, die in diesem Auftrag verwendet werden sollen.

args

string[]

Befehlszeilenargumente für die Anwendung.

className

string

Hauptklasse für Java/Scala-Anwendung.

conf

object

Eigenschaften der Spark-Konfiguration.

driverCores

integer

Anzahl der Kerne, die für den Treiber verwendet werden sollen.

driverMemory

string

Die Menge an Arbeitsspeicher, die für den Treiberprozess verwendet werden soll.

executorCores

integer

Die Anzahl von Kernen, die für jeden Executor verwendet werden sollen.

executorMemory

string

Die Menge an Arbeitsspeicher, die pro Executorprozess verwendet werden soll.

file

string

Datei, die die auszuführende Anwendung enthält.

files

string[]

Dateien, die in diesem Auftrag verwendet werden sollen.

jars

string[]

Jars, die in diesem Auftrag verwendet werden sollen.

name

string

Der Name des Auftrags.

numExecutors

integer

Anzahl der Executors, die für diesen Auftrag gestartet werden sollen.