共用方式為


Spark Job Definition - Get Spark Job Definitions By Workspace

清單 Spark 作業定義。

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

URI 參數

名稱 位於 必要 類型 Description
endpoint
path True

string

uri

工作區開發端點,例如 https://myworkspace.dev.azuresynapse.net

api-version
query True

string

Synapse 用戶端 API 版本。

回應

名稱 類型 Description
200 OK

SparkJobDefinitionsListResponse

正常。

Other Status Codes

CloudError

從Azure Synapse 服務收到的錯誤回應。

範例

SparkJobDefinitions_ListByWorkspace

範例要求

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

範例回覆

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

定義

名稱 Description
BigDataPoolReference

巨量數據集區參考。

BigDataPoolReferenceType

巨量數據集區參考類型。

CloudError

對象,定義 Azure Synapse 錯誤響應的結構。

Folder

此 Spark 作業定義所在的資料夾。 如果未指定,此Spark作業定義將會出現在根層級。

SparkConfigurationReference

Spark 組態參考。

SparkConfigurationReferenceType

Spark 組態參考類型。

SparkJobDefinition

Spark 作業定義。

SparkJobDefinitionResource

Spark 作業定義資源類型。

SparkJobDefinitionsListResponse

Spark 作業定義資源的清單。

SparkJobProperties

Spark 作業的屬性。

BigDataPoolReference

巨量數據集區參考。

名稱 類型 Description
referenceName

string

參考巨量數據集區名稱。

type

BigDataPoolReferenceType

巨量數據集區參考類型。

BigDataPoolReferenceType

巨量數據集區參考類型。

名稱 類型 Description
BigDataPoolReference

string

CloudError

對象,定義 Azure Synapse 錯誤響應的結構。

名稱 類型 Description
error.code

string

錯誤碼。

error.details

CloudError[]

具有其他錯誤詳細數據的陣列。

error.message

string

錯誤訊息。

error.target

string

與錯誤相關聯的要求中的屬性名稱/路徑。

Folder

此 Spark 作業定義所在的資料夾。 如果未指定,此Spark作業定義將會出現在根層級。

名稱 類型 Description
name

string

此 Spark 作業定義所在的資料夾名稱。

SparkConfigurationReference

Spark 組態參考。

名稱 類型 Description
referenceName

string

參考Spark組態名稱。

type

SparkConfigurationReferenceType

Spark 組態參考類型。

SparkConfigurationReferenceType

Spark 組態參考類型。

名稱 類型 Description
SparkConfigurationReference

string

SparkJobDefinition

Spark 作業定義。

名稱 類型 Description
description

string

Spark 作業定義的描述。

folder

Folder

此 Spark 作業定義所在的資料夾。 如果未指定,此Spark作業定義將會出現在根層級。

jobProperties

SparkJobProperties

Spark 作業的屬性。

language

string

Spark 應用程式的語言。

requiredSparkVersion

string

應用程式所需的Spark版本。

targetBigDataPool

BigDataPoolReference

巨量數據集區參考。

targetSparkConfiguration

SparkConfigurationReference

Spark 作業的Spark組態。

SparkJobDefinitionResource

Spark 作業定義資源類型。

名稱 類型 Description
etag

string

資源 Etag。

id

string

資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

資源的名稱

properties

SparkJobDefinition

Spark 作業定義的屬性。

type

string

資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

SparkJobDefinitionsListResponse

Spark 作業定義資源的清單。

名稱 類型 Description
nextLink

string

如果有任何剩餘的結果存在,則為結果下一頁的連結。

value

SparkJobDefinitionResource[]

Spark 作業定義的清單。

SparkJobProperties

Spark 作業的屬性。

名稱 類型 Description
archives

string[]

要用於此作業的封存。

args

string[]

應用程式的命令行自變數。

className

string

Java/Scala 應用程式的主要類別。

conf

object

Spark 組態屬性。

driverCores

integer

要用於驅動程式的核心數目。

driverMemory

string

要用於驅動程式程序的記憶體數量。

executorCores

integer

要用於每個執行程式的核心數目。

executorMemory

string

每個執行程式程序要使用的記憶體數量。

file

string

包含要執行之應用程式的檔案。

files

string[]

要用於此作業的檔案。

jars

string[]

要用於此作業的 Jar。

name

string

作業的名稱。

numExecutors

integer

要啟動此作業的執行程式數目。