Items - Create Spark Job Definition

Palvelu:: SparkJobDefinition

Ohjelmointirajapinnan versio:: v1

Luo spark-työn määrityksen määritettyyn työtilaan.
Tämä ohjelmointirajapinta tukee pitkäkestoisia toimintoja.

Jos haluat luoda spark-työn määrityksen julkisella määrityksellä, katso artikkelia Spark-työn määritelmä.

Käyttöoikeudet

Kutsujalla on oltava osallistujan työtilan rooli.

Vaaditut delegoidut vaikutusalueet

SparkJobDefinition.ReadWrite.All tai Item.ReadWrite.All

Rajoitukset

Spark job -määrityksen luomiseksi työtilan on oltava tuetussa Fabric-kapasiteetissa. Lisätietoja on ohjeaiheessa Microsoft Fabric -käyttöoikeustyypit.

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identiteetti	Tuki
Käyttäjä	Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen	Kyllä

Rajapinta

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Description
workspaceId	path	True	string (uuid)	Työtilan tunnus.

Pyynnön leipäteksti

Nimi	Pakollinen	Tyyppi	Description
displayName	True	string	Spark-työn määrityksen näyttönimi. Näyttönimen on noudatettava nimeämissääntöjä kohdetyypin mukaan.
definition		SparkJobDefinitionPublicDefinition	Spark-työn määritelmä, julkinen määritelmä.
description		string	Spark-työn määrityksen kuvaus. Enimmäispituus on 256 merkkiä.
folderId		string (uuid)	Kansion tunnus. Jos sitä ei määritetä tai se on tyhjäarvo, spark-työn määritys luodaan niin, että työtila on sen kansio.

Vastaukset

Nimi	Tyyppi	Description
201 Created	SparkJobDefinition	Luonti onnistui
202 Accepted		Pyydä hyväksyttyä, spark-työn määrityksen valmistelua on meneillään. Otsikot Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Yleiset virhekoodit: InvalidItemType – Kohdetyyppi on virheellinen ItemDisplayNameAlreadyInUse – Kohteen näyttönimi on jo käytössä. VioittunutPayload – Annetut tiedot ovat vioittuneet. WorkspaceItemsLimitExceeded – Työtilan kohteen raja ylitetty.

Nimi

Tyyppi

Description

201 Created

SparkJobDefinition

Luonti onnistui

202 Accepted

Pyydä hyväksyttyä, spark-työn määrityksen valmistelua on meneillään.

Otsikot

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

Other Status Codes

ErrorResponse

Yleiset virhekoodit:

InvalidItemType – Kohdetyyppi on virheellinen
ItemDisplayNameAlreadyInUse – Kohteen näyttönimi on jo käytössä.
VioittunutPayload – Annetut tiedot ovat vioittuneet.
WorkspaceItemsLimitExceeded – Työtilan kohteen raja ylitetty.

Esimerkit

Create a spark job definition example

Create a spark job definition with public definition example

Create a spark job definition example

Mallipyyntö

HTTP

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

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

Mallivastaus

Tilakoodi:: 201

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

Tilakoodi:: 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

Mallipyyntö

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

Mallivastaus

Tilakoodi:: 201

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

Tilakoodi:: 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

Määritelmät

Nimi	Description
CreateSparkJobDefinitionRequest	Luo spark-työmääritelmäpyynnön hyötykuorma.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
ItemTag	Edustaa kohteelle käytettyä tunnistetta.
ItemType	Kohteen tyyppi. Muita kohdetyyppejä voidaan lisätä ajan kuluessa.
PayloadType	Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.
SparkJobDefinition	Spark-työn määritelmäobjekti.
SparkJobDefinitionProperties	Spark-työn määrityksen ominaisuudet.
SparkJobDefinitionPublicDefinition	Spark-työn määrittelyn julkisen määritelmän objekti. Katso artikkelista lisätietoja spark-työmääritelmän julkisesta määritelmästä.
SparkJobDefinitionPublicDefinitionPart	Spark-työn määrittelyn osaobjekti.

CreateSparkJobDefinitionRequest

Object

Luo spark-työmääritelmäpyynnön hyötykuorma.

Nimi	Tyyppi	Description
definition	SparkJobDefinitionPublicDefinition	Spark-työn määritelmä, julkinen määritelmä.
description	string	Spark-työn määrityksen kuvaus. Enimmäispituus on 256 merkkiä.
displayName	string	Spark-työn määrityksen näyttönimi. Näyttönimen on noudatettava nimeämissääntöjä kohdetyypin mukaan.
folderId	string (uuid)	Kansion tunnus. Jos sitä ei määritetä tai se on tyhjäarvo, spark-työn määritys luodaan niin, että työtila on sen kansio.

ErrorRelatedResource

Object

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Description
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Object

Virhevastaus.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Object

Virheen vastauksen tiedot.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

ItemTag

Object

Edustaa kohteelle käytettyä tunnistetta.

Nimi	Tyyppi	Description
displayName	string	Tunnisteen nimi.
id	string (uuid)	Tunnisteen tunnus.

ItemType

Luettelointi

Kohteen tyyppi. Muita kohdetyyppejä voidaan lisätä ajan kuluessa.

Arvo	Description
ApacheAirflowJob	An ApacheAirflowJob.
CopyJob	Kopiotyö.
Dashboard	Power BI -koontinäyttö.
DataPipeline	Tietoputki.
Dataflow	Tietovuo.
Datamart	PowerBI -tietomarssi.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Digital Twin Builder -työnkulku.
Environment	Ympäristö.
Eventhouse	Tapahtumatalo.
Eventstream	Tapahtumavirta.
GraphQLApi	Ohjelmointirajapinta GraphQL-kohteelle.
KQLDashboard	KQL-koontinäyttö.
KQLDatabase	KQL-tietokanta.
KQLQueryset	KQL-kyselyjoukko.
Lakehouse	Tämä on lakehouse.
MLExperiment	Koneoppimisen kokeilu.
MLModel	Koneoppimismalli.
MirroredAzureDatabricksCatalog	Peilattu Azure Databricks -luettelo.
MirroredDatabase	Peilattu tietokanta.
MirroredWarehouse	Peilattu varasto.
MountedDataFactory	A MountedDataFactory.
Notebook	Muistikirja.
PaginatedReport	PowerBI:n sivutettu raportti.
Reflex	Refleksi.
Report	PowerBI -raportti.
SQLDatabase	A SQLDatabase.
SQLEndpoint	SQL-päätepiste.
SemanticModel	PowerBI:n semanttinen malli.
SparkJobDefinition	Spark-työn määritelmä.
VariableLibrary	MuuttujaLibrary.
Warehouse	Varasto.
WarehouseSnapshot	Varastotilannevedos.

PayloadType

Luettelointi

Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.

Arvo	Description
InlineBase64	Inline Base 64.

SparkJobDefinition

Object

Spark-työn määritelmäobjekti.

Nimi	Tyyppi	Description
description	string	Kohteen kuvaus.
displayName	string	Kohteen näyttönimi.
folderId	string (uuid)	Kansion tunnus.
id	string (uuid)	Kohdetunnus.
properties	SparkJobDefinitionProperties	Spark-työn määrityksen ominaisuudet.
tags	ItemTag[]	Luettelo käytössä olevista tunnisteista.
type	ItemType	Kohdetyyppi.
workspaceId	string (uuid)	Työtilan tunnus.

SparkJobDefinitionProperties

Object

Spark-työn määrityksen ominaisuudet.

Nimi	Tyyppi	Description
oneLakeRootPath	string	OneLake-polku SparkJobDefinition-päähakemistoon.

SparkJobDefinitionPublicDefinition

Object

Spark-työn määrittelyn julkisen määritelmän objekti. Katso artikkelista lisätietoja spark-työmääritelmän julkisesta määritelmästä.

Nimi	Tyyppi	Description
format	string	Kohteen määrityksen muoto. Tuettu muoto: `SparkJobDefinitionV1`.
parts	SparkJobDefinitionPublicDefinitionPart[]	Luettelo määritysosista.

SparkJobDefinitionPublicDefinitionPart

Object

Spark-työn määrittelyn osaobjekti.

Nimi	Tyyppi	Description
path	string	Spark-työn määrityksen julkisen määritelmän osan polku.
payload	string	Spark-työn määrittelyn julkisen määritelmän osakuorma.
payloadType	PayloadType	Hyötykuorman tyyppi.

Jaa

Items - Create Spark Job Definition

Käyttöoikeudet

Vaaditut delegoidut vaikutusalueet

Rajoitukset

Microsoft Entran tukemat käyttäjätiedot

Rajapinta

URI-parametrit

Pyynnön leipäteksti

Vastaukset

Esimerkit

Create a spark job definition example

Mallipyyntö

Mallivastaus

Create a spark job definition with public definition example

Mallipyyntö

Mallivastaus

Määritelmät

CreateSparkJobDefinitionRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType

SparkJobDefinition

SparkJobDefinitionProperties

SparkJobDefinitionPublicDefinition

SparkJobDefinitionPublicDefinitionPart