Partilhar via


Spark Job Definition - Get Spark Job Definitions By Workspace

Listas definições de tarefas do Spark.

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

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
path True

string

uri

O ponto final de desenvolvimento da área de trabalho, por exemplo https://myworkspace.dev.azuresynapse.net.

api-version
query True

string

A Versão da API de cliente do Synapse.

Respostas

Name Tipo Description
200 OK

SparkJobDefinitionsListResponse

OK.

Other Status Codes

CloudError

Uma resposta de erro recebida do serviço Azure Synapse.

Exemplos

SparkJobDefinitions_ListByWorkspace

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
BigDataPoolReference

Referência do conjunto de macrodados.

BigDataPoolReferenceType

Tipo de referência do conjunto de macrodados.

CloudError

O objeto que define a estrutura de uma resposta de erro Azure Synapse.

Folder

A pasta na qual se encontra esta definição de tarefa do Spark. Se não for especificado, esta definição de tarefa do Spark será apresentada ao nível da raiz.

SparkConfigurationReference

Referência de configuração do Spark.

SparkConfigurationReferenceType

Tipo de referência de configuração do Spark.

SparkJobDefinition

Definição de tarefa do Spark.

SparkJobDefinitionResource

Tipo de recurso de definição de tarefa do Spark.

SparkJobDefinitionsListResponse

Uma lista de recursos de definições de tarefas do Spark.

SparkJobProperties

As propriedades da tarefa do Spark.

BigDataPoolReference

Referência do conjunto de macrodados.

Name Tipo Description
referenceName

string

Nome do conjunto de macrodados de referência.

type

BigDataPoolReferenceType

Tipo de referência do conjunto de macrodados.

BigDataPoolReferenceType

Tipo de referência do conjunto de macrodados.

Name Tipo Description
BigDataPoolReference

string

CloudError

O objeto que define a estrutura de uma resposta de erro Azure Synapse.

Name Tipo Description
error.code

string

Código de erro.

error.details

CloudError[]

Matriz com detalhes de erro adicionais.

error.message

string

Mensagem de erro.

error.target

string

Nome/caminho da propriedade no pedido associado ao erro.

Folder

A pasta na qual se encontra esta definição de tarefa do Spark. Se não for especificado, esta definição de tarefa do Spark será apresentada ao nível da raiz.

Name Tipo Description
name

string

O nome da pasta em que se encontra esta definição de tarefa do Spark.

SparkConfigurationReference

Referência de configuração do Spark.

Name Tipo Description
referenceName

string

Nome de configuração do Apache Spark de referência.

type

SparkConfigurationReferenceType

Tipo de referência de configuração do Spark.

SparkConfigurationReferenceType

Tipo de referência de configuração do Spark.

Name Tipo Description
SparkConfigurationReference

string

SparkJobDefinition

Definição de tarefa do Spark.

Name Tipo Description
description

string

A descrição da definição da tarefa do Spark.

folder

Folder

A pasta na qual se encontra esta definição de tarefa do Spark. Se não for especificado, esta definição de tarefa do Spark será apresentada ao nível da raiz.

jobProperties

SparkJobProperties

As propriedades da tarefa do Spark.

language

string

O idioma da aplicação Spark.

requiredSparkVersion

string

A versão necessária do Spark da aplicação.

targetBigDataPool

BigDataPoolReference

Referência do conjunto de macrodados.

targetSparkConfiguration

SparkConfigurationReference

A configuração do Apache Spark da tarefa do Spark.

SparkJobDefinitionResource

Tipo de recurso de definição de tarefa do Spark.

Name Tipo Description
etag

string

Etag de Recurso.

id

string

ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

O nome do recurso

properties

SparkJobDefinition

Propriedades da definição da tarefa do Apache Spark.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SparkJobDefinitionsListResponse

Uma lista de recursos de definições de tarefas do Spark.

Name Tipo Description
nextLink

string

A ligação para a página seguinte de resultados, se existirem resultados restantes.

value

SparkJobDefinitionResource[]

Lista de definições de tarefas do Spark.

SparkJobProperties

As propriedades da tarefa do Spark.

Name Tipo Description
archives

string[]

Arquivos a utilizar nesta tarefa.

args

string[]

Argumentos da linha de comandos para a aplicação.

className

string

Classe principal para a aplicação Java/Scala.

conf

object

Propriedades de configuração do Spark.

driverCores

integer

Número de núcleos a utilizar para o controlador.

driverMemory

string

Quantidade de memória a utilizar para o processo do controlador.

executorCores

integer

Número de núcleos a utilizar para cada executor.

executorMemory

string

Quantidade de memória a utilizar por processo do executor.

file

string

Ficheiro que contém a aplicação a executar.

files

string[]

ficheiros a utilizar nesta tarefa.

jars

string[]

Jars para serem usados neste trabalho.

name

string

O nome da tarefa.

numExecutors

integer

Número de executores a iniciar para esta tarefa.