Items - Create Spark Job Definition
Hiermee maakt u een Spark-taakdefinitie in de opgegeven werkruimte.
Deze API ondersteunt langlopende bewerkingen (LRO).
Raadpleeg Spark-taakdefinitie artikel om spark-taakdefinitie te maken met een openbare definitie.
Machtigingen
De aanroeper moet inzender hebben of een hogere werkruimterol.
Vereiste gedelegeerde bereiken
SparkJobDefinition.ReadWrite.All of Item.ReadWrite.All
Beperkingen
- Als u een Spark-taakdefinitie wilt maken, moet de werkruimte zich in een ondersteunde Infrastructuurcapaciteit bevinden. Zie voor meer informatie: Microsoft Fabric-licentietypen.
Door Microsoft Entra ondersteunde identiteiten
Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.
Identiteit | Steunen |
---|---|
Gebruiker | Ja |
service-principal en beheerde identiteiten | Ja |
Interface
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sparkJobDefinitions
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
workspace
|
path | True |
string uuid |
De werkruimte-id. |
Aanvraagbody
Name | Vereist | Type | Description |
---|---|---|---|
displayName | True |
string |
De weergavenaam van de Spark-taakdefinitie. De weergavenaam moet de naamgevingsregels volgen op basis van het itemtype. |
definition |
De openbare definitie van de Spark-taak. |
||
description |
string |
De beschrijving van de Spark-taakdefinitie. De maximale lengte is 256 tekens. |
Antwoorden
Name | Type | Description |
---|---|---|
201 Created |
Gemaakt |
|
202 Accepted |
Aanvraag geaccepteerd, inrichting van spark-taakdefinities wordt uitgevoerd. Kopteksten
|
|
Other Status Codes |
Veelvoorkomende foutcodes:
|
Voorbeelden
Create a spark job definition example |
Create a spark job definition with public definition example |
Create a spark job definition example
Voorbeeldaanvraag
POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/sparkJobDefinitions
{
"displayName": "SparkJobDefinition 1",
"description": "A spark job definition description."
}
Voorbeeldrespons
{
"displayName": "SparkJobDefinition 1",
"description": "A spark job definition description.",
"type": "SparkJobDefinition",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
}
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
Voorbeeldaanvraag
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"
}
]
}
}
Voorbeeldrespons
{
"displayName": "SparkJobDefinition 1",
"description": "A spark job definition description.",
"type": "SparkJobDefinition",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
}
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
Definities
Name | Description |
---|---|
Create |
Nettolading voor spark-taakdefinitieaanvragen maken. |
Error |
Het foutgerelateerde resourcedetailsobject. |
Error |
Het foutbericht. |
Error |
De details van het foutbericht. |
Item |
Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd. |
Payload |
Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd. |
Spark |
Een spark-taakdefinitieobject. |
Spark |
De eigenschappen van de Spark-taakdefinitie. |
Spark |
Het openbare definitieobject van de Spark-taakdefinitie. Raadpleeg dit artikel voor meer informatie over het maken van een openbare definitie van een Spark-taakdefinitie. |
Spark |
Taakdefinitieonderdeelobject voor Spark-taakdefinitie. |
CreateSparkJobDefinitionRequest
Nettolading voor spark-taakdefinitieaanvragen maken.
Name | Type | Description |
---|---|---|
definition |
De openbare definitie van de Spark-taak. |
|
description |
string |
De beschrijving van de Spark-taakdefinitie. De maximale lengte is 256 tekens. |
displayName |
string |
De weergavenaam van de Spark-taakdefinitie. De weergavenaam moet de naamgevingsregels volgen op basis van het itemtype. |
ErrorRelatedResource
Het foutgerelateerde resourcedetailsobject.
Name | Type | Description |
---|---|---|
resourceId |
string |
De resource-id die betrokken is bij de fout. |
resourceType |
string |
Het type resource dat betrokken is bij de fout. |
ErrorResponse
Het foutbericht.
Name | Type | Description |
---|---|---|
errorCode |
string |
Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is. |
message |
string |
Een leesbare weergave van de fout. |
moreDetails |
Lijst met aanvullende foutdetails. |
|
relatedResource |
De foutgerelateerde resourcedetails. |
|
requestId |
string |
Id van de aanvraag die is gekoppeld aan de fout. |
ErrorResponseDetails
De details van het foutbericht.
Name | Type | Description |
---|---|---|
errorCode |
string |
Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is. |
message |
string |
Een leesbare weergave van de fout. |
relatedResource |
De foutgerelateerde resourcedetails. |
ItemType
Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.
Waarde | Description |
---|---|
Dashboard |
PowerBI-dashboard. |
DataPipeline |
Een gegevenspijplijn. |
Datamart |
PowerBI-datamart. |
Environment |
Een omgeving. |
Eventhouse |
Een eventhouse. |
Eventstream |
Een eventstream. |
GraphQLApi |
Een API voor GraphQL-item. |
KQLDashboard |
Een KQL-dashboard. |
KQLDatabase |
Een KQL-database. |
KQLQueryset |
Een KQL-queryset. |
Lakehouse |
Een lakehouse. |
MLExperiment |
Een machine learning-experiment. |
MLModel |
Een machine learning-model. |
MirroredDatabase |
Een gespiegelde database. |
MirroredWarehouse |
Een gespiegeld magazijn. |
MountedDataFactory |
Een MountedDataFactory. |
Notebook |
Een notitieblok. |
PaginatedReport |
Gepagineerd Power BI-rapport. |
Reflex |
Een reflex. |
Report |
PowerBI-rapport. |
SQLDatabase |
Een SQLDatabase. |
SQLEndpoint |
Een SQL-eindpunt. |
SemanticModel |
Semantisch Power BI-model. |
SparkJobDefinition |
Een Spark-taakdefinitie. |
Warehouse |
Een magazijn. |
PayloadType
Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.
Waarde | Description |
---|---|
InlineBase64 |
Inline base 64. |
SparkJobDefinition
Een spark-taakdefinitieobject.
Name | Type | Description |
---|---|---|
description |
string |
De beschrijving van het item. |
displayName |
string |
De weergavenaam van het item. |
id |
string uuid |
De item-id. |
properties |
De eigenschappen van de Spark-taakdefinitie. |
|
type |
Het itemtype. |
|
workspaceId |
string uuid |
De werkruimte-id. |
SparkJobDefinitionProperties
De eigenschappen van de Spark-taakdefinitie.
Name | Type | Description |
---|---|---|
oneLakeRootPath |
string |
OneLake-pad naar de hoofdmap SparkJobDefinition. |
SparkJobDefinitionPublicDefinition
Het openbare definitieobject van de Spark-taakdefinitie. Raadpleeg dit artikel voor meer informatie over het maken van een openbare definitie van een Spark-taakdefinitie.
Name | Type | Description |
---|---|---|
format |
string |
De indeling van de itemdefinitie. Ondersteunde indeling: |
parts |
Een lijst met definitieonderdelen. |
SparkJobDefinitionPublicDefinitionPart
Taakdefinitieonderdeelobject voor Spark-taakdefinitie.
Name | Type | Description |
---|---|---|
path |
string |
Het pad van het openbare definitieonderdeel spark-taakdefinitie. |
payload |
string |
De openbare definitie van de spark-taakdefinitie nettolading. |
payloadType |
Het nettoladingstype. |