Use a API Livy para enviar e executar trabalhos em lote Livy

Aplica-se a:✅ Engenharia de Dados e Ciência de Dados do Fabric

Saiba como enviar trabalhos em lote do Spark usando a API Livy para Engenharia de Dados do Fabric. Atualmente, a API do Livy não dá suporte ao SPN (Entidade de Serviço Azure).

Pré-requisitos

• Fabric Premium ou capacidade de teste com Lakehouse.

• Um cliente remoto, como Visual Studio Code com Jupyter Notebooks, PySpark e o Biblioteca do Microsoft Authenticator (MSAL) para Python.

• Um token de aplicativo Microsoft Entra é necessário para acessar a API Rest Fabric. Registre um aplicativo na plataforma de identidade da Microsoft.

• Alguns dados em seu lakehouse, este exemplo usa um arquivo parquet green_tripdata_2022_08 NYC Taxi & Limousine Commission carregado no lakehouse.

A API Livy define um ponto de extremidade unificado para operações. Substitua os espaços reservados {Entra_TenantID}, {Entra_ClientID}, {Fabric_WorkspaceID} e {Fabric_LakehouseID} pelos seus valores apropriados ao seguir os exemplos neste artigo.

Configurar Visual Studio Code para o Lote de API do Livy

1. Selecione Lakehouse Settings em seu Fabric Lakehouse.

   

2. Navegue até a seção Ponto de acesso do Livy.

   

3. Copie a cadeia de conexão do trabalho em lote (segunda caixa vermelha na imagem) no seu código.

4. Navegue até centro de administração do Microsoft Entra e copie a ID do aplicativo (cliente) e a ID do diretório (locatário) para seu código.

   

Crie um código em lote do Spark e carregue em seu ambiente Lakehouse

1. Criar um bloco de anotações .ipynb no Visual Studio Code e inserir o código a seguir

   import sys
   import os
   
   from pyspark.sql import SparkSession
   from pyspark.conf import SparkConf
   from pyspark.sql.functions import col
   
   if __name__ == "__main__":
   
       #Spark session builder
       spark_session = (SparkSession
           .builder
           .appName("batch_demo") 
           .getOrCreate())
   
       spark_context = spark_session.sparkContext
       spark_context.setLogLevel("DEBUG")  
   
       tableName = spark_context.getConf().get("spark.targetTable")
   
       if tableName is not None:
           print("tableName: " + str(tableName))
       else:
           print("tableName is None")
   
       df_valid_totalPrice = spark_session.sql("SELECT * FROM green_tripdata_2022 where total_amount > 0")
       df_valid_totalPrice_plus_year = df_valid_totalPrice.withColumn("transaction_year", col("lpep_pickup_datetime").substr(1, 4))
   
   
       deltaTablePath = f"Tables/{tableName}CleanedTransactions"
       df_valid_totalPrice_plus_year.write.mode('overwrite').format('delta').save(deltaTablePath)
   

2. Salve o arquivo Python localmente. Este payload de código Python contém duas instruções Spark que operam em dados em um Lakehouse e precisam ser carregadas no seu Lakehouse. Você precisa do caminho do ABFS (Azure Blob File System) do payload para referenciar na tarefa em lote da Livy API no Visual Studio Code e no nome da tabela do Lakehouse na instrução SQL SELECT.

   

3. Carregue o payload do Python na seção de arquivos do Lakehouse. no Lakehouse Explorer, selecione Arquivos. Em seguida, selecione >Obter dados>Carregar arquivos. Selecione arquivos por meio do seletor de arquivos.

   

4. Depois que o arquivo estiver na seção Arquivos do Lakehouse, selecione os três pontos à direita do nome do arquivo de payload e selecione Propriedades.

   

5. Copie este caminho ABFS para a célula do seu Notebook na etapa 1.

Autenticar uma sessão em lote da API Livy Spark usando um token de usuário Microsoft Entra ou um token SPN Microsoft Entra

Autenticar uma sessão em lote do Spark com a API Livy usando um token SPN do Microsoft Entra

1. Crie um bloco de anotações .ipynb no Visual Studio Code e insira o código a seguir.

   import sys
   from msal import ConfidentialClientApplication
   
   # Configuration - Replace with your actual values
   tenant_id = "Entra_TenantID"  # Microsoft Entra tenant ID
   client_id = "Entra_ClientID"  # Service Principal Application ID
   
   # Certificate paths - Update these paths to your certificate files
   certificate_path = "PATH_TO_YOUR_CERTIFICATE.pem"      # Public certificate file
   private_key_path = "PATH_TO_YOUR_PRIVATE_KEY.pem"      # Private key file
   certificate_thumbprint = "YOUR_CERTIFICATE_THUMBPRINT" # Certificate thumbprint
   
   # OAuth settings
   audience = "https://analysis.windows.net/powerbi/api/.default"
   authority = f"https://login.windows.net/{tenant_id}"
   
   def get_access_token(client_id, audience, authority, certificate_path, private_key_path, certificate_thumbprint=None):
       """
       Get an app-only access token for a Service Principal using OAuth 2.0 client credentials flow.
   
       This function uses certificate-based authentication which is more secure than client secrets.
   
       Args:
           client_id (str): The Service Principal's client ID  
           audience (str): The audience for the token (resource scope)
           authority (str): The OAuth authority URL
           certificate_path (str): Path to the certificate file (.pem format)
           private_key_path (str): Path to the private key file (.pem format)
           certificate_thumbprint (str): Certificate thumbprint (optional but recommended)
   
       Returns:
           str: The access token for API authentication
   
       Raises:
           Exception: If token acquisition fails
       """
       try:
           # Read the certificate from PEM file
           with open(certificate_path, "r", encoding="utf-8") as f:
               certificate_pem = f.read()
   
           # Read the private key from PEM file
           with open(private_key_path, "r", encoding="utf-8") as f:
               private_key_pem = f.read()
   
           # Create the confidential client application
           app = ConfidentialClientApplication(
               client_id=client_id,
               authority=authority,
               client_credential={
                   "private_key": private_key_pem,
                   "thumbprint": certificate_thumbprint,
                   "certificate": certificate_pem
               }
           )
   
           # Acquire token using client credentials flow
           token_response = app.acquire_token_for_client(scopes=[audience])
   
           if "access_token" in token_response:
               print("Successfully acquired access token")
               return token_response["access_token"]
           else:
               raise Exception(f"Failed to retrieve token: {token_response.get('error_description', 'Unknown error')}")
   
       except FileNotFoundError as e:
           print(f"Certificate file not found: {e}")
           sys.exit(1)
       except Exception as e:
           print(f"Error retrieving token: {e}", file=sys.stderr)
           sys.exit(1)
   
   # Get the access token
   token = get_access_token(client_id, audience, authority, certificate_path, private_key_path, certificate_thumbprint)
   

2. Execute a célula do notebook e você deverá ver o token do Microsoft Entra retornado.

   

Autenticar uma sessão spark da API livy usando um token de usuário Microsoft Entra

1. Crie um bloco de anotações .ipynb no Visual Studio Code e insira o código a seguir.

   from msal import PublicClientApplication
   import requests
   import time
   
   # Configuration - Replace with your actual values
   tenant_id = "Entra_TenantID"  # Microsoft Entra tenant ID
   client_id = "Entra_ClientID"  # Application ID (can be the same as above or different)
   
   # Required scopes for Livy API access
   scopes = [
       "https://api.fabric.microsoft.com/Lakehouse.Execute.All",      # Required — execute operations in lakehouses
       "https://api.fabric.microsoft.com/Lakehouse.Read.All",         # Required — read lakehouse metadata
       "https://api.fabric.microsoft.com/Code.AccessFabric.All",      # Required — general Fabric API access from Spark Runtime
       "https://api.fabric.microsoft.com/Code.AccessStorage.All",     # Required — access OneLake and Azure storage from Spark Runtime
   ]
   
   # Optional scopes — add these only if your Spark jobs need access to the corresponding services:
   #    "https://api.fabric.microsoft.com/Code.AccessAzureKeyvault.All"     # Optional — access Azure Key Vault from Spark Runtime
   #    "https://api.fabric.microsoft.com/Code.AccessAzureDataLake.All"     # Optional — access Azure Data Lake Storage Gen1 from Spark Runtime
   #    "https://api.fabric.microsoft.com/Code.AccessAzureDataExplorer.All" # Optional — access Azure Data Explorer from Spark Runtime
   #    "https://api.fabric.microsoft.com/Code.AccessSQL.All"               # Optional — access Azure SQL audience tokens from Spark Runtime
   
   def get_access_token(tenant_id, client_id, scopes):
       """
       Get an access token using interactive authentication.
   
       This method will open a browser window for user authentication.
   
       Args:
           tenant_id (str): The Azure Active Directory tenant ID
           client_id (str): The application client ID
           scopes (list): List of required permission scopes
   
       Returns:
           str: The access token, or None if authentication fails
       """
       app = PublicClientApplication(
           client_id,
           authority=f"https://login.microsoftonline.com/{tenant_id}"
       )
   
       print("Opening browser for interactive authentication...")
       token_response = app.acquire_token_interactive(scopes=scopes)
   
       if "access_token" in token_response:
           print("Successfully authenticated")
           return token_response["access_token"]
       else:
           print(f"Authentication failed: {token_response.get('error_description', 'Unknown error')}")
           return None
   
   # Uncomment the lines below to use interactive authentication
   token = get_access_token(tenant_id, client_id, scopes)
   print("Access token acquired via interactive login")
   

2. Execute a célula do notebook, um pop-up deverá aparecer em seu navegador permitindo que você escolha a identidade para entrar.

   

3. Depois de escolher a identidade com a qual entrar, você precisará aprovar as permissões da API de registro do aplicativo Microsoft Entra.

   

4. Feche a janela do navegador após concluir a autenticação.

   

5. Em Visual Studio Code, você deverá ver o token de Microsoft Entra retornado.

   

Noções básicas sobre os escopos Code.* para a API Livy

Quando seus trabalhos do Spark são executados por meio da API livy, os Code.* escopos controlam quais serviços externos o Spark Runtime pode acessar em nome do usuário autenticado. Dois são necessários; o restante é opcional dependendo da carga de trabalho.

Escopos necessários do Code.*

Escopos opcionais do Code.*

Adicione esses escopos somente se os trabalhos do Spark precisarem acessar os serviços de Azure correspondentes em runtime.

Envie um Batch Livy e monitore o trabalho em batch.

1. Adicione outra célula de notebook e insira este código.

   # submit payload to existing batch session
   
   import requests
   import time
   import json
   
   api_base_url = "https://api.fabric.microsoft.com/v1"  # Base URL for Fabric APIs
   
   # Fabric Resource IDs - Replace with your workspace and lakehouse IDs  
   workspace_id = "Fabric_WorkspaceID"
   lakehouse_id = "Fabric_LakehouseID"
   
   # Construct the Livy Batch API URL
   # URL pattern: {base_url}/workspaces/{workspace_id}/lakehouses/{lakehouse_id}/livyApi/versions/{api_version}/batches
   livy_base_url = f"{api_base_url}/workspaces/{workspace_id}/lakehouses/{lakehouse_id}/livyApi/versions/2023-12-01/batches"
   
   # Set up authentication headers
   headers = {"Authorization": f"Bearer {token}"}
   
   print(f"Livy Batch API URL: {livy_base_url}")
   
   new_table_name = "TABLE_NAME"  # Name for the new table
   
   # Configure the batch job
   print("Configuring batch job parameters...")
   
   # Batch job configuration - Modify these values for your use case
   payload_data = {
       # Job name - will appear in the Fabric UI
       "name": f"livy_batch_demo_{new_table_name}",
   
       # Path to your Python file in the lakehouse
       "file": "<ABFSS_PATH_TO_YOUR_PYTHON_FILE>",  # Replace with your Python file path
   
       # Optional: Spark configuration parameters
       "conf": {
           "spark.targetTable": new_table_name,  # Custom configuration for your application
       },
   }
   
   print("Batch Job Configuration:")
   print(json.dumps(payload_data, indent=2))
   
   try:
       # Submit the batch job
       print("\nSubmitting batch job...")
       post_batch = requests.post(livy_base_url, headers=headers, json=payload_data)
   
       if post_batch.status_code == 202:
           batch_info = post_batch.json()
           print("Livy batch job submitted successfully!")
           print(f"Batch Job Info: {json.dumps(batch_info, indent=2)}")
   
           # Extract batch ID for monitoring
           batch_id = batch_info['id']
           livy_batch_get_url = f"{livy_base_url}/{batch_id}"
   
           print(f"\nBatch Job ID: {batch_id}")
           print(f"Monitoring URL: {livy_batch_get_url}")
   
       else:
           print(f"Failed to submit batch job. Status code: {post_batch.status_code}")
           print(f"Response: {post_batch.text}")
   
   except requests.exceptions.RequestException as e:
       print(f"Network error occurred: {e}")
   except json.JSONDecodeError as e:
       print(f"JSON decode error: {e}")
       print(f"Response text: {post_batch.text}")
   except Exception as e:
       print(f"Unexpected error: {e}")
   

2. Execute a célula do notebook, você deverá ver várias linhas impressas enquanto o trabalho em lotes do Livy é criado e executado.

   

3. Para ver as mudanças, navegue de volta para sua Lakehouse.

Integração com ambientes de Fabric

Por padrão, essa sessão da API livy é executada no pool inicial padrão do workspace. Como alternativa, você pode usar ambientes Fabric Criar, configurar e usar um ambiente no Microsoft Fabric para personalizar o pool do Spark que a sessão da API livy usa para esses trabalhos do Spark. Para usar seu ambiente de Fabric, atualize a célula do notebook anterior com esta única alteração de linha.

payload_data = {
    "name":"livybatchdemo_with"+ newlakehouseName,
    "file":"abfss://YourABFSPathToYourPayload.py", 
    "conf": {
        "spark.targetLakehouse": "Fabric_LakehouseID",
        "spark.fabric.environmentDetails" : "{\"id\" : \""EnvironmentID"\"}"  # remove this line to use starter pools instead of an environment, replace "EnvironmentID" with your environment ID
        }
    }

Exibir seus trabalhos no hub de Monitoramento

Você pode acessar o hub de Monitoramento para visualizar várias atividades do Apache Spark selecionando Monitorar nos links de navegação à esquerda.

1. Quando o trabalho em lote estiver no estado concluído, você pode visualizar o status da sessão navegando até Monitorar.

   

2. Selecione e abra o nome da atividade mais recente.

   

3. Neste caso de sessão da API Livy, você pode ver seu envio de lote anterior, detalhes da execução, versões do Spark e configuração. Observe o status interrompido no canto superior direito.

   

Para recapitular todo o processo, você precisa de um cliente remoto, como Visual Studio Code, um token de aplicativo Microsoft Entra, URL de ponto de extremidade da API Livy, autenticação em seu Lakehouse, uma carga Spark em seu Lakehouse e, por fim, uma sessão em lote da API Livy.

Conteúdo relacionado

• Documentação API REST Apache Livy
• Enviar trabalhos de sessão usando a API Livy
• Visão geral do monitoramento do Apache Spark
• Detalhes do aplicativo Apache Spark