Hoe maakt en werkt je een Spark-taakdefinitie aan met de Microsoft Fabric REST API

De Fabric REST API biedt een service-endpoint voor CRUD-operaties van Fabric-items. In deze tutorial lopen we een end-to-end scenario door hoe je een Spark-taakdefinitie-item aanmaakt en bijwerkt. Er zijn drie stappen op hoog niveau betrokken:

Maak een Spark-taakdefinitie-item aan met een beginstatus.
Upload het hoofddefinitiebestand en andere lib-bestanden.
Werk het Spark-taakdefinitie-item bij met de OneLake-URL van het hoofddefinitiebestand en andere libbestanden.

Vereisten

Er is een Microsoft Entra-token vereist om toegang te krijgen tot de Fabric REST API. De MSAL-bibliotheek wordt aanbevolen om het token op te halen. Zie ondersteuning voor verificatiestromen in MSAL voor meer informatie.
Er is een opslagtoken vereist voor toegang tot de OneLake-API. Zie MSAL voor Python voor meer informatie.

Maak een Spark-taakdefinitie-item aan met de beginstatus

De Fabric REST API definieert een geïntegreerd eindpunt voor CRUD-operaties van Fabric-items. Het eindpunt is https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items.

De itemdetails worden opgegeven in de hoofdtekst van de aanvraag. Hier is een voorbeeld van het verzoeklichaam voor het maken van een Spark-taakdefinitie-item:

{
    "displayName": "SJDHelloWorld",
    "type": "SparkJobDefinition",
    "definition": {
        "format": "SparkJobDefinitionV1",
        "parts": [
            {
                "path": "SparkJobDefinitionV1.json",
                "payload": "<REDACTED>",
                "payloadType": "InlineBase64"
            }
        ]
    }
}

In dit voorbeeld heet SJDHelloWorldhet Spark-taakdefinitie-item . Het payload veld is de base64-gecodeerde inhoud van de gedetailleerde installatie. Na het decoderen is de inhoud:

{
    "executableFile":null,
    "defaultLakehouseArtifactId":"",
    "mainClass":"",
    "additionalLakehouseIds":[],
    "retryPolicy":null,
    "commandLineArguments":"",
    "additionalLibraryUris":[],
    "language":"",
    "environmentArtifactId":null
}

Hier volgen twee helperfuncties voor het coderen en decoderen van de gedetailleerde installatie:

import base64

def json_to_base64(json_data):
    # Serialize the JSON data to a string
    json_string = json.dumps(json_data)
    
    # Encode the JSON string as bytes
    json_bytes = json_string.encode('utf-8')
    
    # Encode the bytes as Base64
    base64_encoded = base64.b64encode(json_bytes).decode('utf-8')
    
    return base64_encoded

def base64_to_json(base64_data):
    # Decode the Base64-encoded string to bytes
    base64_bytes = base64_data.encode('utf-8')
    
    # Decode the bytes to a JSON string
    json_string = base64.b64decode(base64_bytes).decode('utf-8')
    
    # Deserialize the JSON string to a Python dictionary
    json_data = json.loads(json_string)
    
    return json_data

Hier is het codefragment om een Spark-taakdefinitie-item te maken:

import requests

bearerToken = "<REDACTED>"  # Replace this token with the real AAD token

headers = {
    "Authorization": f"Bearer {bearerToken}", 
    "Content-Type": "application/json"  # Set the content type based on your request
}

payload = "<REDACTED>"

# Define the payload data for the POST request
payload_data = {
    "displayName": "SJDHelloWorld",
    "Type": "SparkJobDefinition",
    "definition": {
        "format": "SparkJobDefinitionV1",
        "parts": [
            {
                "path": "SparkJobDefinitionV1.json",
                "payload": payload,
                "payloadType": "InlineBase64"
            }
        ]
    }
}

# Make the POST request with Bearer authentication
sjdCreateUrl = f"https://api.fabric.microsoft.com//v1/workspaces/{workspaceId}/items"
response = requests.post(sjdCreateUrl, json=payload_data, headers=headers)

Het hoofddefinitiebestand en andere lib-bestanden uploaden

Er is een opslagtoken vereist om het bestand te uploaden naar OneLake. Hier volgt een helperfunctie om het opslagtoken op te halen:

import msal

def getOnelakeStorageToken():
    app = msal.PublicClientApplication(
        "<REDACTED>",  # This field should be the client ID 
        authority="https://login.microsoftonline.com/microsoft.com")

    result = app.acquire_token_interactive(scopes=["https://storage.azure.com/.default"])

    print(f"Successfully acquired AAD token with storage audience:{result['access_token']}")

    return result['access_token']

Nu hebben we een Spark-taakdefinitie-item aangemaakt. Om het uit te voeren, moeten we het hoofddefinitiebestand en de vereiste eigenschappen instellen. Het eindpunt voor het uploaden van het bestand voor dit SJD-item is https://onelake.dfs.fabric.microsoft.com/{workspaceId}/{sjditemid}. Dezelfde 'workspaceId' uit de vorige stap moet worden gebruikt. De waarde van "sjditemid" kon worden gevonden in de responsbody van de vorige stap. Hier volgt het codefragment voor het instellen van het hoofddefinitiebestand:

import requests

# Three steps are required: create file, append file, flush file

onelakeEndPoint = "https://onelake.dfs.fabric.microsoft.com/workspaceId/sjditemid"  # Replace the ID of workspace and item with the right one
mainExecutableFile = "main.py"  # The name of the main executable file
mainSubFolder = "Main"  # The sub folder name of the main executable file. Don't change this value


onelakeRequestMainFileCreateUrl = f"{onelakeEndPoint}/{mainSubFolder}/{mainExecutableFile}?resource=file"  # The URL for creating the main executable file via the 'file' resource type
onelakePutRequestHeaders = {
    "Authorization": f"Bearer {onelakeStorageToken}",  # The storage token can be achieved from the helper function above
}

onelakeCreateMainFileResponse = requests.put(onelakeRequestMainFileCreateUrl, headers=onelakePutRequestHeaders)
if onelakeCreateMainFileResponse.status_code == 201:
    # Request was successful
    print(f"Main File '{mainExecutableFile}' was successfully created in OneLake.")

# With the previous step, the main executable file is created in OneLake. Now we need to append the content of the main executable file

appendPosition = 0
appendAction = "append"

### Main File Append.
mainExecutableFileSizeInBytes = 83  # The size of the main executable file in bytes
onelakeRequestMainFileAppendUrl = f"{onelakeEndPoint}/{mainSubFolder}/{mainExecutableFile}?position={appendPosition}&action={appendAction}"
mainFileContents = "<REDACTED>"  # The content of the main executable file, please replace this with the real content of the main executable file
mainExecutableFileSizeInBytes = 83  # The size of the main executable file in bytes, this value should match the size of the mainFileContents

onelakePatchRequestHeaders = {
    "Authorization": f"Bearer {onelakeStorageToken}",
    "Content-Type": "text/plain"
}

onelakeAppendMainFileResponse = requests.patch(onelakeRequestMainFileAppendUrl, data = mainFileContents, headers=onelakePatchRequestHeaders)
if onelakeAppendMainFileResponse.status_code == 202:
    # Request was successful
    print(f"Successfully accepted main file '{mainExecutableFile}' append data.")

# With the previous step, the content of the main executable file is appended to the file in OneLake. Now we need to flush the file

flushAction = "flush"

### Main File flush
onelakeRequestMainFileFlushUrl = f"{onelakeEndPoint}/{mainSubFolder}/{mainExecutableFile}?position={mainExecutableFileSizeInBytes}&action={flushAction}"
print(onelakeRequestMainFileFlushUrl)
onelakeFlushMainFileResponse = requests.patch(onelakeRequestMainFileFlushUrl, headers=onelakePatchRequestHeaders)
if onelakeFlushMainFileResponse.status_code == 200:
    print(f"Successfully flushed main file '{mainExecutableFile}' contents.")
else:
    print(onelakeFlushMainFileResponse.json())

Volg hetzelfde proces om de andere lib-bestanden indien nodig te uploaden.

Werk het Spark-taakdefinitie-item bij met de OneLake-URL van het hoofddefinitiebestand en andere libbestanden

Tot nu toe hebben we een Spark-taakdefinitie-item gemaakt met een beginstatus en het hoofddefinitiebestand en andere libbestanden geüpload. De laatste stap is het bijwerken van het Spark-taakdefinitie-item om de URL-eigenschappen van het hoofddefinitiebestand en andere libbestanden in te stellen. Het eindpunt voor het bijwerken van het Spark-taakdefinitie-item is https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{sjditemid}. Dezelfde "workspaceId" en "sjditemid" als in eerdere stappen moeten worden gebruikt. Hier is het codefragment om het Spark-taakdefinitie-item bij te werken:

mainAbfssPath = f"abfss://{workspaceId}@onelake.dfs.fabric.microsoft.com/{sjditemid}/Main/{mainExecutableFile}"  # The workspaceId and sjditemid are the same as previous steps, the mainExecutableFile is the name of the main executable file
libsAbfssPath = f"abfss://{workspaceId}@onelake.dfs.fabric.microsoft.com/{sjditemid}/Libs/{libsFile}"  # The workspaceId and sjditemid are the same as previous steps, the libsFile is the name of the libs file
defaultLakehouseId = '<REDACTED>'  # Replace this with the real default lakehouse ID

updateRequestBodyJson = {
    "executableFile": mainAbfssPath,
    "defaultLakehouseArtifactId": defaultLakehouseId,
    "mainClass": "",
    "additionalLakehouseIds": [],
    "retryPolicy": None,
    "commandLineArguments": "",
    "additionalLibraryUris": [libsAbfssPath],
    "language": "Python",
    "environmentArtifactId": None}

# Encode the bytes as a Base64-encoded string
base64EncodedUpdateSJDPayload = json_to_base64(updateRequestBodyJson)

# Print the Base64-encoded string
print("Base64-encoded JSON payload for SJD Update:")
print(base64EncodedUpdateSJDPayload)

# Define the API URL
updateSjdUrl = f"https://api.fabric.microsoft.com//v1/workspaces/{workspaceId}/items/{sjditemid}/updateDefinition"

updatePayload = base64EncodedUpdateSJDPayload
payloadType = "InlineBase64"
path = "SparkJobDefinitionV1.json"
format = "SparkJobDefinitionV1"
Type = "SparkJobDefinition"

# Define the headers with Bearer authentication
bearerToken = "<REDACTED>"  # Replace this token with the real AAD token

headers = {
    "Authorization": f"Bearer {bearerToken}", 
    "Content-Type": "application/json"  # Set the content type based on your request
}

# Define the payload data for the POST request
payload_data = {
    "displayName": "sjdCreateTest11",
    "Type": Type,
    "definition": {
        "format": format,
        "parts": [
            {
                "path": path,
                "payload": updatePayload,
                "payloadType": payloadType
            }
        ]
    }
}


# Make the POST request with Bearer authentication
response = requests.post(updateSjdUrl, json=payload_data, headers=headers)
if response.status_code == 200:
    print("Successfully updated SJD.")
else:
    print(response.json())
    print(response.status_code)

Om het hele proces samen te vatten: zowel de Fabric REST API als de OneLake API zijn nodig om een Spark-taakdefinitie-item te maken en bij te werken. De Fabric REST API wordt gebruikt om het Spark-taakdefinitie-item te maken en bij te werken. De OneLake-API wordt gebruikt om het hoofddefinitiebestand en andere lib-bestanden te uploaden. Het hoofddefinitiebestand en andere lib-bestanden worden eerst geüpload naar OneLake. Vervolgens worden de URL-eigenschappen van het hoofddefinitiebestand en andere libbestanden ingesteld in het Spark-taakdefinitie-item.

Een Apache Spark-taakdefinitie plannen en uitvoeren

Feedback

Is deze pagina nuttig?

Last updated on 2026-08-05