Partager via


Spark Job Definition - Get Spark Job Definitions By Workspace

Listes définitions de travail Spark.

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

Paramètres URI

Nom Dans Obligatoire Type Description
endpoint
path True

string

uri

Le point de terminaison du développement de l’espace de travail, par exemple https://myworkspace.dev.azuresynapse.net.

api-version
query True

string

Version de l’API cliente Synapse.

Réponses

Nom Type Description
200 OK

SparkJobDefinitionsListResponse

OK.

Other Status Codes

CloudError

Réponse d’erreur reçue du service Azure Synapse.

Exemples

SparkJobDefinitions_ListByWorkspace

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
BigDataPoolReference

Informations de référence sur le pool Big Data.

BigDataPoolReferenceType

Type de référence du pool Big Data.

CloudError

Objet qui définit la structure d’une réponse d’erreur Azure Synapse.

Folder

Dossier dans lequel se trouve cette définition de travail Spark. Si elle n’est pas spécifiée, cette définition de travail Spark s’affiche au niveau racine.

SparkConfigurationReference

Informations de référence sur la configuration Spark.

SparkConfigurationReferenceType

Type de référence de configuration Spark.

SparkJobDefinition

Définition de travail Spark.

SparkJobDefinitionResource

Type de ressource de définition de travail Spark.

SparkJobDefinitionsListResponse

Liste des ressources de définitions de travail Spark.

SparkJobProperties

Propriétés du travail Spark.

BigDataPoolReference

Informations de référence sur le pool Big Data.

Nom Type Description
referenceName

string

Nom du pool Big Data de référence.

type

BigDataPoolReferenceType

Type de référence du pool Big Data.

BigDataPoolReferenceType

Type de référence du pool Big Data.

Nom Type Description
BigDataPoolReference

string

CloudError

Objet qui définit la structure d’une réponse d’erreur Azure Synapse.

Nom Type Description
error.code

string

Code d’erreur.

error.details

CloudError[]

Tableau avec des détails d’erreur supplémentaires.

error.message

string

Message d’erreur.

error.target

string

Nom de propriété/chemin d’accès dans la requête associée à l’erreur.

Folder

Dossier dans lequel se trouve cette définition de travail Spark. Si elle n’est pas spécifiée, cette définition de travail Spark s’affiche au niveau racine.

Nom Type Description
name

string

Nom du dossier dans lequel se trouve cette définition de travail Spark.

SparkConfigurationReference

Informations de référence sur la configuration Spark.

Nom Type Description
referenceName

string

Référencez le nom de la configuration spark.

type

SparkConfigurationReferenceType

Type de référence de configuration Spark.

SparkConfigurationReferenceType

Type de référence de configuration Spark.

Nom Type Description
SparkConfigurationReference

string

SparkJobDefinition

Définition de travail Spark.

Nom Type Description
description

string

Description de la définition du travail Spark.

folder

Folder

Dossier dans lequel se trouve cette définition de travail Spark. Si elle n’est pas spécifiée, cette définition de travail Spark s’affiche au niveau racine.

jobProperties

SparkJobProperties

Propriétés du travail Spark.

language

string

Langue de l’application Spark.

requiredSparkVersion

string

Version Spark requise de l’application.

targetBigDataPool

BigDataPoolReference

Informations de référence sur le pool Big Data.

targetSparkConfiguration

SparkConfigurationReference

Configuration spark du travail spark.

SparkJobDefinitionResource

Type de ressource de définition de travail Spark.

Nom Type Description
etag

string

Etag de ressources.

id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

nom de la ressource.

properties

SparkJobDefinition

Propriétés de la définition du travail Spark.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

SparkJobDefinitionsListResponse

Liste des ressources de définitions de travail Spark.

Nom Type Description
nextLink

string

Lien vers la page suivante des résultats, s’il existe des résultats restants.

value

SparkJobDefinitionResource[]

Liste des définitions de travail Spark.

SparkJobProperties

Propriétés du travail Spark.

Nom Type Description
archives

string[]

Archives à utiliser dans ce travail.

args

string[]

Arguments de ligne de commande pour l’application.

className

string

Classe principale pour l’application Java/Scala.

conf

object

Propriétés de configuration Spark.

driverCores

integer

Nombre de cœurs à utiliser pour le pilote.

driverMemory

string

Quantité de mémoire à utiliser pour le processus du pilote.

executorCores

integer

Nombre de cœurs à utiliser pour chaque exécuteur.

executorMemory

string

Quantité de mémoire à utiliser par processus d’exécuteur.

file

string

Fichier contenant l’application à exécuter.

files

string[]

fichiers à utiliser dans ce travail.

jars

string[]

Jars à utiliser dans ce travail.

name

string

Nom du travail.

numExecutors

integer

Nombre d’exécuteurs à lancer pour ce travail.