Items - List Spark Job Definitions

Tjeneste:

SparkJobDefinition

API-version:

v1

Returnerer en liste over definitioner af sparkjob fra det angivne arbejdsområde.
Denne API understøtter sideinddeling.

Tilladelser

Den, der ringer op, skal have seer eller en højere rolle i arbejdsområdet.

Påkrævede delegerede områder

Workspace.Read.All eller Workspace.ReadWrite.All

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sparkJobDefinitions

Med valgfrie parametre:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sparkJobDefinitions?continuationToken={continuationToken}

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
workspaceId	path	True	string uuid	Arbejdsområde-id'et.
continuationToken	query		string	Et token til hentning af den næste side med resultater.

Svar

Name	Type	Beskrivelse
200 OK	SparkJobDefinitions	Anmodningen blev fuldført.
Other Status Codes	ErrorResponse	Almindelige fejlkoder: InvalidItemType – Ugyldig elementtype.

Eksempler

List spark job definitions in workspace example

Eksempelanmodning

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/sparkJobDefinitions

Eksempelsvar

Statuskode:

200

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "SparkJobDefinition Name 1",
      "description": "A spark job definition description.",
      "type": "SparkJobDefinition",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
      }
    },
    {
      "id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
      "displayName": "SparkJobDefinition Name 2",
      "description": "A spark job definition description.",
      "type": "SparkJobDefinition",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/d8f6cf16-3aac-4440-9d76-a03d86b7ae3e"
      }
    }
  ]
}

Definitioner

Name	Beskrivelse
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
ItemType	Elementets type. Der kan tilføjes flere elementtyper over tid.
SparkJobDefinition	Et spark jobdefinitionsobjekt.
SparkJobDefinitionProperties	Egenskaber for definition af sparkjob.
SparkJobDefinitions	En liste over definitioner af sparkjob.

ErrorRelatedResource

Object

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Object

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Object

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

ItemType

Optælling

Elementets type. Der kan tilføjes flere elementtyper over tid.

Værdi	Beskrivelse
Dashboard	PowerBI-dashboard.
DataPipeline	En datapipeline.
Datamart	PowerBI-datamart.
Environment	Et miljø.
Eventhouse	Et eventhouse.
Eventstream	En hændelsesstream.
GraphQLApi	En API til GraphQL-element.
KQLDashboard	Et KQL-dashboard.
KQLDatabase	En KQL-database.
KQLQueryset	Et KQL-forespørgselssæt.
Lakehouse	Et søhus.
MLExperiment	Et maskinel indlæringseksperiment.
MLModel	En model til maskinel indlæring.
MirroredDatabase	En spejlet database.
MirroredWarehouse	Et spejlvendt lager.
MountedDataFactory	En MountedDataFactory.
Notebook	En notesbog.
PaginatedReport	Sideinddelt PowerBI-rapport.
Reflex	En refleks.
Report	PowerBI-rapport.
SQLDatabase	En SQLDatabase.
SQLEndpoint	Et SQL-slutpunkt.
SemanticModel	Semantisk PowerBI-model.
SparkJobDefinition	En spark jobdefinition.
Warehouse	Et lager.

SparkJobDefinition

Object

Et spark jobdefinitionsobjekt.

Name	Type	Beskrivelse
description	string	Elementbeskrivelsen.
displayName	string	Det viste elementnavn.
id	string uuid	Element-id'et.
properties	SparkJobDefinitionProperties	Egenskaber for definition af sparkjob.
type	ItemType	Elementtypen.
workspaceId	string uuid	Arbejdsområde-id'et.

SparkJobDefinitionProperties

Object

Egenskaber for definition af sparkjob.

Name	Type	Beskrivelse
oneLakeRootPath	string	OneLake-sti til SparkJobDefinition-rodmappen.

SparkJobDefinitions

Object

En liste over definitioner af sparkjob.

Name	Type	Beskrivelse
continuationToken	string	Tokenet for det næste resultatsætbatch. Hvis der ikke er flere poster, fjernes de fra svaret.
continuationUri	string	URI'en for det næste resultatsætbatch. Hvis der ikke er flere poster, fjernes de fra svaret.
value	SparkJobDefinition[]	En liste over definitioner af sparkjob.