Condividi tramite


Spark Job Definition - Get Spark Job Definitions By Workspace

Elenchi definizioni di processo spark.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
path True

string

uri

Endpoint di sviluppo dell'area di lavoro, ad esempio https://myworkspace.dev.azuresynapse.net.

api-version
query True

string

Versione dell'API client Synapse.

Risposte

Nome Tipo Descrizione
200 OK

SparkJobDefinitionsListResponse

OK.

Other Status Codes

CloudError

Risposta di errore ricevuta dal servizio Azure Synapse.

Esempio

SparkJobDefinitions_ListByWorkspace

Esempio di richiesta

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

Risposta di esempio

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"
    }
  ]
}

Definizioni

Nome Descrizione
BigDataPoolReference

Informazioni di riferimento sul pool Big Data.

BigDataPoolReferenceType

Tipo di riferimento del pool Big Data.

CloudError

Oggetto che definisce la struttura di una risposta di errore Azure Synapse.

Folder

Cartella in cui si trova la definizione del processo Spark. Se non specificato, questa definizione del processo Spark verrà visualizzata a livello radice.

SparkConfigurationReference

Informazioni di riferimento sulla configurazione di Spark.

SparkConfigurationReferenceType

Tipo di riferimento di configurazione Spark.

SparkJobDefinition

Definizione del processo Spark.

SparkJobDefinitionResource

Tipo di risorsa di definizione del processo Spark.

SparkJobDefinitionsListResponse

Elenco delle risorse delle definizioni dei processi spark.

SparkJobProperties

Proprietà del processo Spark.

BigDataPoolReference

Informazioni di riferimento sul pool Big Data.

Nome Tipo Descrizione
referenceName

string

Fare riferimento al nome del pool Big Data.

type

BigDataPoolReferenceType

Tipo di riferimento del pool Big Data.

BigDataPoolReferenceType

Tipo di riferimento del pool Big Data.

Nome Tipo Descrizione
BigDataPoolReference

string

CloudError

Oggetto che definisce la struttura di una risposta di errore Azure Synapse.

Nome Tipo Descrizione
error.code

string

Codice di errore.

error.details

CloudError[]

Matrice con dettagli di errore aggiuntivi.

error.message

string

Messaggio di errore.

error.target

string

Nome della proprietà/percorso nella richiesta associata all'errore.

Folder

Cartella in cui si trova la definizione del processo Spark. Se non specificato, questa definizione del processo Spark verrà visualizzata a livello radice.

Nome Tipo Descrizione
name

string

Nome della cartella in cui si trova la definizione del processo Spark.

SparkConfigurationReference

Informazioni di riferimento sulla configurazione di Spark.

Nome Tipo Descrizione
referenceName

string

Nome di configurazione spark di riferimento.

type

SparkConfigurationReferenceType

Tipo di riferimento di configurazione Spark.

SparkConfigurationReferenceType

Tipo di riferimento di configurazione Spark.

Nome Tipo Descrizione
SparkConfigurationReference

string

SparkJobDefinition

Definizione del processo Spark.

Nome Tipo Descrizione
description

string

Descrizione della definizione del processo Spark.

folder

Folder

Cartella in cui si trova la definizione del processo Spark. Se non specificato, questa definizione del processo Spark verrà visualizzata a livello radice.

jobProperties

SparkJobProperties

Proprietà del processo Spark.

language

string

Lingua dell'applicazione Spark.

requiredSparkVersion

string

Versione spark richiesta dell'applicazione.

targetBigDataPool

BigDataPoolReference

Informazioni di riferimento sul pool Big Data.

targetSparkConfiguration

SparkConfigurationReference

Configurazione spark del processo spark.

SparkJobDefinitionResource

Tipo di risorsa di definizione del processo Spark.

Nome Tipo Descrizione
etag

string

Resource Etag.

id

string

ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

nome della risorsa.

properties

SparkJobDefinition

Proprietà della definizione del processo Spark.

type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SparkJobDefinitionsListResponse

Elenco delle risorse delle definizioni dei processi spark.

Nome Tipo Descrizione
nextLink

string

Collegamento alla pagina successiva dei risultati, se esistono risultati rimanenti.

value

SparkJobDefinitionResource[]

Elenco delle definizioni dei processi spark.

SparkJobProperties

Proprietà del processo Spark.

Nome Tipo Descrizione
archives

string[]

Archivi da usare in questo processo.

args

string[]

Argomenti della riga di comando per l'applicazione.

className

string

Classe principale per l'applicazione Java/Scala.

conf

object

Proprietà di configurazione di Spark.

driverCores

integer

Numero di core da usare per il driver.

driverMemory

string

Quantità di memoria da usare per il processo del driver.

executorCores

integer

Numero di core da usare per ogni executor.

executorMemory

string

Quantità di memoria da usare per un processo executor.

file

string

File contenente l'applicazione da eseguire.

files

string[]

file da usare in questo processo.

jars

string[]

Jar da usare in questo processo.

name

string

Nome del processo.

numExecutors

integer

Numero di executor da avviare per questo processo.