Создание и обновление определения задания Spark с помощью REST API Microsoft Fabric

Статья
11/15/2023

REST API Microsoft Fabric предоставляет конечную точку службы для операций CRUD элементов Fabric. В этом руководстве мы рассмотрим комплексный сценарий создания и обновления артефакта определения задания Spark. Участвуют три этапа высокого уровня:

создание элемента определения задания Spark с некоторым начальным состоянием
отправка файла основного определения и других файлов lib
обновите элемент определения задания Spark с URL-адресом OneLake основного файла определения и других файлов lib

Необходимые компоненты

Для доступа к REST API Fabric требуется маркер Microsoft Entra. Для получения маркера рекомендуется получить библиотеку MSAL. Дополнительные сведения см. в статье о поддержке потока проверки подлинности в MSAL.
Для доступа к API OneLake требуется маркер хранилища. Дополнительные сведения см. в статье MSAL для Python.

Создание элемента определения задания Spark с начальным состоянием

REST API Microsoft Fabric определяет единую конечную точку для операций CRUD элементов Fabric. Конечная точка имеет значение https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items.

Сведения об элементе указываются внутри текста запроса. Ниже приведен пример текста запроса для создания элемента определения задания Spark:

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

В этом примере элемент определения задания Spark называется как SJDHelloWorld. Поле payload — это содержимое в кодировке Base64 настройки сведений после декодирования содержимого:

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

Ниже приведены две вспомогательные функции для кодирования и декодирования подробной настройки:

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

Ниже приведен фрагмент кода для создания элемента определения задания Spark:

import requests

bearerToken = "breadcrumb"; # 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 = "eyJleGVjdXRhYmxlRmlsZSI6bnVsbCwiZGVmYXVsdExha2Vob3VzZUFydGlmYWN0SWQiOiIiLCJtYWluQ2xhc3MiOiIiLCJhZGRpdGlvbmFsTGFrZWhvdXNlSWRzIjpbXSwicmV0cnlQb2xpY3kiOm51bGwsImNvbW1hbmRMaW5lQXJndW1lbnRzIjoiIiwiYWRkaXRpb25hbExpYnJhcnlVcmlzIjpbXSwibGFuZ3VhZ2UiOiIiLCJlbnZpcm9ubWVudEFydGlmYWN0SWQiOm51bGx9"

# 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)

Отправка файла основного определения и других файлов lib

Для отправки файла в OneLake требуется маркер хранилища. Ниже приведена вспомогательные функции для получения маркера хранения:


import msal

def getOnelakeStorageToken():
    app = msal.PublicClientApplication(
        "{client id}", # this filed 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']

Теперь у нас есть созданный элемент определения задания Spark, чтобы сделать его запущенным, необходимо настроить основной файл определения и необходимые свойства. Конечная точка для отправки файла для этого элемента https://onelake.dfs.fabric.microsoft.com/{workspaceId}/{sjdartifactid}SJD . Тот же "workspaceId" из предыдущего шага должен использоваться, значение sjdartifactid можно найти в тексте ответа предыдущего шага. Ниже приведен фрагмент кода для настройки основного файла определения:

import requests

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

onelakeEndPoint = "https://onelake.dfs.fabric.microsoft.com/workspaceId/sjdartifactid"; # replace the id of workspace and artifact 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 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 = "filename = 'Files/' + Constant.filename; tablename = 'Tables/' + Constant.tablename"; # 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 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())

Выполните тот же процесс, чтобы отправить другие файлы lib при необходимости.

Обновите элемент определения задания Spark с URL-адресом OneLake основного файла определения и других файлов lib

До сих пор мы создали элемент определения задания Spark с некоторым начальным состоянием, отправив основной файл определения и другие файлы lib, последний шаг — обновить элемент определения задания Spark, чтобы задать свойства URL-адреса файла основного определения и других файлов lib. Конечная точка для обновления элемента определения задания Spark .https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{sjdartifactid} Следует использовать те же "workspaceId" и "sjdartifactid" из предыдущих шагов. Ниже приведен фрагмент кода для обновления элемента определения задания Spark:


mainAbfssPath = f"abfss://{workspaceId}@onelake.dfs.fabric.microsoft.com/{sjdartifactid}/Main/{mainExecutableFile}" # the workspaceId and sjdartifactid 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/{sjdartifactid}/Libs/{libsFile}"  # the workspaceId and sjdartifactid are the same as previous steps, the libsFile is the name of the libs file
defaultLakehouseId = 'defaultLakehouseid'; # 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/{sjdartifactid}/updateDefinition"

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

# Define the headers with Bearer authentication
bearerToken = "breadcrumb"; # 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)

Чтобы восстановить весь процесс, необходимо создать и обновить элемент определения задания Spark как REST API Fabric, так и API OneLake. REST API Fabric используется для создания и обновления элемента определения задания Spark, API OneLake используется для отправки основного файла определения и других файлов lib. Файл основного определения и другие файлы lib сначала передаются в OneLake. Затем свойства URL-адреса основного файла определения и других файлов lib задаются в элементе определения задания Spark.

Планирование и запуск определения задания Apache Spark

Поделиться через

Создание и обновление определения задания Spark с помощью REST API Microsoft Fabric

Необходимые компоненты

Создание элемента определения задания Spark с начальным состоянием

Отправка файла основного определения и других файлов lib

Обновите элемент определения задания Spark с URL-адресом OneLake основного файла определения и других файлов lib

Обратная связь

Дополнительные ресурсы

Поделиться через

Создание и обновление определения задания Spark с помощью REST API Microsoft Fabric

Необходимые компоненты

Создание элемента определения задания Spark с начальным состоянием

Отправка файла основного определения и других файлов lib

Обновите элемент определения задания Spark с URL-адресом OneLake основного файла определения и других файлов lib

Связанный контент

Обратная связь

Дополнительные ресурсы