Sdílet prostřednictvím


Spark Job Definition - Get Spark Job Definitions By Workspace

Seznamy definic úloh Sparku

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
endpoint
path True

string

uri

Vývojový koncový bod pracovního prostoru, například https://myworkspace.dev.azuresynapse.net.

api-version
query True

string

Verze rozhraní API klienta Synapse

Odpovědi

Name Typ Description
200 OK

SparkJobDefinitionsListResponse

OK.

Other Status Codes

CloudError

Služba Azure Synapse přijala chybovou odpověď.

Příklady

SparkJobDefinitions_ListByWorkspace

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
BigDataPoolReference

Referenční informace k fondům velkých objemů dat

BigDataPoolReferenceType

Typ odkazu na fond velkých objemů dat.

CloudError

Objekt, který definuje strukturu Azure Synapse chybovou odpověď.

Folder

Složka, ve které je tato definice úlohy Sparku. Pokud tuto definici úlohy Sparku nezadáte, zobrazí se na kořenové úrovni.

SparkConfigurationReference

Referenční informace ke konfiguraci Sparku

SparkConfigurationReferenceType

Referenční typ konfigurace Sparku

SparkJobDefinition

Definice úlohy Sparku

SparkJobDefinitionResource

Typ prostředku definice úlohy Spark.

SparkJobDefinitionsListResponse

Seznam prostředků definic úloh Sparku

SparkJobProperties

Vlastnosti úlohy Sparku

BigDataPoolReference

Referenční informace k fondům velkých objemů dat

Name Typ Description
referenceName

string

Odkaz na název fondu velkých objemů dat

type

BigDataPoolReferenceType

Typ odkazu na fond velkých objemů dat.

BigDataPoolReferenceType

Typ odkazu na fond velkých objemů dat.

Name Typ Description
BigDataPoolReference

string

CloudError

Objekt, který definuje strukturu Azure Synapse chybovou odpověď.

Name Typ Description
error.code

string

Kód chyby

error.details

CloudError[]

Pole s dalšími podrobnostmi o chybě.

error.message

string

Chybová zpráva.

error.target

string

Název vlastnosti nebo cesta v požadavku přidružené k chybě.

Folder

Složka, ve které je tato definice úlohy Sparku. Pokud tuto definici úlohy Sparku nezadáte, zobrazí se na kořenové úrovni.

Name Typ Description
name

string

Název složky, ve které je tato definice úlohy Sparku.

SparkConfigurationReference

Referenční informace ke konfiguraci Sparku

Name Typ Description
referenceName

string

Odkaz na název konfigurace Sparku.

type

SparkConfigurationReferenceType

Referenční typ konfigurace Sparku

SparkConfigurationReferenceType

Referenční typ konfigurace Sparku

Name Typ Description
SparkConfigurationReference

string

SparkJobDefinition

Definice úlohy Sparku

Name Typ Description
description

string

Popis definice úlohy Sparku

folder

Folder

Složka, ve které je tato definice úlohy Sparku. Pokud tuto definici úlohy Sparku nezadáte, zobrazí se na kořenové úrovni.

jobProperties

SparkJobProperties

Vlastnosti úlohy Sparku

language

string

Jazyk aplikace Spark.

requiredSparkVersion

string

Požadovaná verze Sparku aplikace.

targetBigDataPool

BigDataPoolReference

Referenční informace k fondům velkých objemů dat

targetSparkConfiguration

SparkConfigurationReference

Konfigurace sparku úlohy Sparku

SparkJobDefinitionResource

Typ prostředku definice úlohy Spark.

Name Typ Description
etag

string

Značka ETag prostředku.

id

string

Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}

name

string

Název prostředku

properties

SparkJobDefinition

Vlastnosti definice úlohy Sparku

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

SparkJobDefinitionsListResponse

Seznam prostředků definic úloh Sparku

Name Typ Description
nextLink

string

Odkaz na další stránku výsledků, pokud existují nějaké zbývající výsledky.

value

SparkJobDefinitionResource[]

Seznam definic úloh Sparku

SparkJobProperties

Vlastnosti úlohy Sparku

Name Typ Description
archives

string[]

Archivy, které se mají použít v této úloze.

args

string[]

Argumenty příkazového řádku pro aplikaci.

className

string

Hlavní třída pro aplikaci Java/Scala.

conf

object

Vlastnosti konfigurace Sparku.

driverCores

integer

Počet jader, která se mají použít pro ovladač

driverMemory

string

Velikost paměti, která se má použít pro proces ovladače.

executorCores

integer

Počet jader, která se mají použít pro jednotlivé exekutory

executorMemory

string

Velikost paměti, která se má použít na proces exekutoru.

file

string

Soubor obsahující aplikaci, která se má spustit.

files

string[]

soubory, které budou použity v této úloze.

jars

string[]

Soubory JAR, které se mají použít v této úloze.

name

string

Název úlohy.

numExecutors

integer

Počet exekutorů ke spuštění pro tuto úlohu