Items - Create Spark Job Definition

Reference

Tjeneste:: SparkJobDefinition

API-version:: v1

Opretter en sparkjobdefinition i det angivne arbejdsområde.
Denne API understøtter LRO-handlinger (Long Running Operations).

Hvis du vil oprette en sparkjobdefinition med en offentlig definition, skal du se artiklen Spark-jobdefinition.

Tilladelser

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

Påkrævede delegerede områder

SparkJobDefinition.ReadWrite.All eller Item.ReadWrite.All

Begrænsninger

Hvis du vil oprette en definition af et sparkjob, skal arbejdsområdet være på en understøttet Fabric-kapacitet. Du kan få flere oplysninger under: Microsoft Fabric-licenstyper.

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

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
workspaceId	path	True	string uuid	Arbejdsområde-id'et.

Brødtekst for anmodning

Name	Påkrævet	Type	Beskrivelse
displayName	True	string	Det viste navn til definitionen af sparkjobbet. Det viste navn skal følge navngivningsreglerne i henhold til elementtypen.
definition		SparkJobDefinitionPublicDefinition	Definitionen af det offentlige sparkjob.
description		string	Beskrivelsen af definitionen af sparkjobbet. Maksimumlængden er 256 tegn.

Svar

Name	Type	Beskrivelse
201 Created	SparkJobDefinition	Oprettet
202 Accepted		Anmodning accepteret, klargøring af spark-jobdefinition er i gang. Headere Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: InvalidItemType – Elementtypen er ugyldig ItemDisplayNameAlreadyInUse – Det viste navn på elementet bruges allerede. CorruptedPayload – Den angivne nyttedata er beskadiget.

Name

Type

Beskrivelse

201 Created

SparkJobDefinition

Oprettet

202 Accepted

Anmodning accepteret, klargøring af spark-jobdefinition er i gang.

Headere

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

InvalidItemType – Elementtypen er ugyldig
ItemDisplayNameAlreadyInUse – Det viste navn på elementet bruges allerede.
CorruptedPayload – Den angivne nyttedata er beskadiget.

Eksempler

Create a spark job definition example

Create a spark job definition with public definition example

Create a spark job definition example

Eksempelanmodning

HTTP

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

{
  "displayName": "SparkJobDefinition 1",
  "description": "A spark job definition description."
}

Eksempelsvar

Statuskode:: 201

{
  "displayName": "SparkJobDefinition 1",
  "description": "A spark job definition description.",
  "type": "SparkJobDefinition",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Statuskode:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create a spark job definition with public definition example

Eksempelanmodning

HTTP

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

{
  "displayName": "SparkJobDefinition 1",
  "description": "A spark job definition description.",
  "definition": {
    "format": "SparkJobDefinitionV1",
    "parts": [
      {
        "path": "SparkJobDefinitionV1.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Eksempelsvar

Statuskode:: 201

{
  "displayName": "SparkJobDefinition 1",
  "description": "A spark job definition description.",
  "type": "SparkJobDefinition",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Statuskode:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definitioner

Name	Beskrivelse
CreateSparkJobDefinitionRequest	Opret nyttedata for definitionsanmodning for sparkjob.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
ItemType	Elementets type. Der kan tilføjes flere elementtyper over tid.
PayloadType	Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.
SparkJobDefinition	Et spark jobdefinitionsobjekt.
SparkJobDefinitionProperties	Egenskaber for definition af sparkjob.
SparkJobDefinitionPublicDefinition	Spark-jobdefinitionsobjekt for offentlig definition. Se denne artikel for at få flere oplysninger om, hvordan du udformer en offentlig definition af et sparkjob.
SparkJobDefinitionPublicDefinitionPart	Spark jobdefinitionsdelobjekt.

CreateSparkJobDefinitionRequest

Object

Opret nyttedata for definitionsanmodning for sparkjob.

Name	Type	Beskrivelse
definition	SparkJobDefinitionPublicDefinition	Definitionen af det offentlige sparkjob.
description	string	Beskrivelsen af definitionen af sparkjobbet. Maksimumlængden er 256 tegn.
displayName	string	Det viste navn til definitionen af sparkjobbet. Det viste navn skal følge navngivningsreglerne i henhold til elementtypen.

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.

PayloadType

Optælling

Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.

Værdi	Beskrivelse
InlineBase64	Indbygget grundlinje 64.

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.

SparkJobDefinitionPublicDefinition

Object

Spark-jobdefinitionsobjekt for offentlig definition. Se denne artikel for at få flere oplysninger om, hvordan du udformer en offentlig definition af et sparkjob.

Name	Type	Beskrivelse
format	string	Formatet af elementdefinitionen. Understøttet format: `SparkJobDefinitionV1`.
parts	SparkJobDefinitionPublicDefinitionPart[]	En liste over definitionsdele.

SparkJobDefinitionPublicDefinitionPart

Object

Spark jobdefinitionsdelobjekt.

Name	Type	Beskrivelse
path	string	Stien til den offentlige definition af definitionen af sparkjobbet.
payload	string	Nyttedata for definitionen af den offentlige definition af sparkjobbet.
payloadType	PayloadType	Nyttedatatypen.

Del via

Items - Create Spark Job Definition

Tilladelser

Påkrævede delegerede områder

Begrænsninger

Microsoft Entra-understøttede identiteter

Grænseflade

URI-parametre

Brødtekst for anmodning

Svar

Eksempler

Create a spark job definition example

Eksempelanmodning

Eksempelsvar

Create a spark job definition with public definition example

Eksempelanmodning

Eksempelsvar

Definitioner

CreateSparkJobDefinitionRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

PayloadType

SparkJobDefinition

SparkJobDefinitionProperties

SparkJobDefinitionPublicDefinition

SparkJobDefinitionPublicDefinitionPart

Yderligere ressourcer