Compartir a través de


Spark Job Definition - Get Spark Job Definitions By Workspace

Listas definiciones de trabajos de Spark.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
path True

string

uri

Punto de conexión de desarrollo del área de trabajo, por ejemplo https://myworkspace.dev.azuresynapse.net.

api-version
query True

string

Versión de la API de cliente de Synapse.

Respuestas

Nombre Tipo Description
200 OK

SparkJobDefinitionsListResponse

Aceptar.

Other Status Codes

CloudError

Respuesta de error recibida del servicio Azure Synapse.

Ejemplos

SparkJobDefinitions_ListByWorkspace

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
BigDataPoolReference

Referencia del grupo de macrodatos.

BigDataPoolReferenceType

Tipo de referencia del grupo de macrodatos.

CloudError

Objeto que define la estructura de una respuesta de error Azure Synapse.

Folder

La carpeta en la que se encuentra esta definición de trabajo de Spark. Si no se especifica, esta definición de trabajo de Spark aparecerá en el nivel raíz.

SparkConfigurationReference

Referencia de configuración de Spark.

SparkConfigurationReferenceType

Tipo de referencia de configuración de Spark.

SparkJobDefinition

Definición del trabajo de Spark.

SparkJobDefinitionResource

Tipo de recurso de definición de trabajo de Spark.

SparkJobDefinitionsListResponse

Lista de recursos de definiciones de trabajos de Spark.

SparkJobProperties

Propiedades del trabajo de Spark.

BigDataPoolReference

Referencia del grupo de macrodatos.

Nombre Tipo Description
referenceName

string

Haga referencia al nombre del grupo de macrodatos.

type

BigDataPoolReferenceType

Tipo de referencia del grupo de macrodatos.

BigDataPoolReferenceType

Tipo de referencia del grupo de macrodatos.

Nombre Tipo Description
BigDataPoolReference

string

CloudError

Objeto que define la estructura de una respuesta de error Azure Synapse.

Nombre Tipo Description
error.code

string

Código de error.

error.details

CloudError[]

Matriz con detalles de error adicionales.

error.message

string

Mensaje de error.

error.target

string

Nombre o ruta de acceso de propiedad en la solicitud asociada al error.

Folder

La carpeta en la que se encuentra esta definición de trabajo de Spark. Si no se especifica, esta definición de trabajo de Spark aparecerá en el nivel raíz.

Nombre Tipo Description
name

string

Nombre de la carpeta en la que se encuentra esta definición de trabajo de Spark.

SparkConfigurationReference

Referencia de configuración de Spark.

Nombre Tipo Description
referenceName

string

Haga referencia al nombre de la configuración de Spark.

type

SparkConfigurationReferenceType

Tipo de referencia de configuración de Spark.

SparkConfigurationReferenceType

Tipo de referencia de configuración de Spark.

Nombre Tipo Description
SparkConfigurationReference

string

SparkJobDefinition

Definición del trabajo de Spark.

Nombre Tipo Description
description

string

Descripción de la definición del trabajo de Spark.

folder

Folder

La carpeta en la que se encuentra esta definición de trabajo de Spark. Si no se especifica, esta definición de trabajo de Spark aparecerá en el nivel raíz.

jobProperties

SparkJobProperties

Propiedades del trabajo de Spark.

language

string

Lenguaje de la aplicación Spark.

requiredSparkVersion

string

La versión de Spark necesaria de la aplicación.

targetBigDataPool

BigDataPoolReference

Referencia del grupo de macrodatos.

targetSparkConfiguration

SparkConfigurationReference

Configuración de Spark del trabajo de Spark.

SparkJobDefinitionResource

Tipo de recurso de definición de trabajo de Spark.

Nombre Tipo Description
etag

string

Etag de recursos.

id

string

Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nombre del recurso.

properties

SparkJobDefinition

Propiedades de la definición del trabajo de Spark.

type

string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SparkJobDefinitionsListResponse

Lista de recursos de definiciones de trabajos de Spark.

Nombre Tipo Description
nextLink

string

Vínculo a la página siguiente de resultados, si existen resultados restantes.

value

SparkJobDefinitionResource[]

Lista de definiciones de trabajos de Spark.

SparkJobProperties

Propiedades del trabajo de Spark.

Nombre Tipo Description
archives

string[]

Archivos que se usarán en este trabajo.

args

string[]

Argumentos de la línea de comandos para la aplicación.

className

string

Clase principal para la aplicación Java/Scala.

conf

object

Propiedades de configuración de Spark.

driverCores

integer

Número de núcleos que se van a usar para el controlador.

driverMemory

string

Cantidad de memoria que se usará para el proceso del controlador.

executorCores

integer

Número de núcleos que se usará para cada ejecutor.

executorMemory

string

Cantidad de memoria que se usará por proceso de ejecutor.

file

string

Archivo que contiene la aplicación que se va a ejecutar.

files

string[]

archivos que se usarán en este trabajo.

jars

string[]

Archivos Jar que se usarán en este trabajo.

name

string

Nombre del trabajo.

numExecutors

integer

Número de ejecutores que se van a iniciar para este trabajo.