開始使用適用於 JavaScript 的 Batch SDK

發行項
03/05/2024

了解如何使用 Azure Batch JavaScript SDK，在 JavaScript 中建置 Batch 用戶端的基本概念。我們會逐步了解批次應用程式的情節，然後使用 JavaScript 加以設定。

必要條件

本文假設您已具備 JavaScript 的使用知識並熟悉 Linux。同時假設您的 Azure 帳戶設有存取權限，可建立 Batch 和儲存體服務。

建議您先閱讀 Azure Batch 技術概觀，再進行本文概述的步驟。

了解案例

這裡我們有以 Python 撰寫的簡單指令碼，可從 Azure Blob 儲存體容器下載所有 csv 檔案並將其轉換成 JSON。若要平行處理多個儲存體帳戶容器，我們可以將此指令碼部署為 Azure Batch 作業。

Azure Batch 架構

下圖描述如何使用 Azure Batch 和用戶端調整 Python 指令碼。

Diagram showing scenario architecture.

JavaScript 樣本會使用準備工作部署批次作業 (稍後詳細說明) 以及一組工作 (視儲存體帳戶中容器數目而定)。您可以從 GitHub 存放庫下載指令碼。

提示

指定連結中的 JavaScript 樣本不包含要部署為 Azure 函數應用程式的特定程式碼。您可以參考下列連結，以取得建立函式應用程式的指示。

建置應用程式

現在，我們要依照程序逐步建置 JavaScript 用戶端︰

步驟 1：安裝 Azure Batch SDK

您可以使用 npm 安裝命令來安裝適用於 JavaScript 的 Azure Batch SDK。

npm install @azure/batch

此命令會安裝最新版的 azure-batch JavaScript SDK。

提示

在 Azure Function 應用程式中，您可以移至 Azure Function 的 [設定] 索引標籤中的 [Kudu 主控台] 以執行 npm 安裝命令。在此案例中，安裝適用於 JavaScript 的 Azure Batch SDK。

步驟 2：建立 Azure Batch 帳戶

您可以從 Azure 入口網站或從命令列 (PowerShell /Azure CLI) 加以建立。

以下是透過 Azure CLI 命令建立 Batch 帳戶的命令。

建立資源群組，如果您想要建立 Batch 帳戶的地方已經有一個，請略過此步驟︰

az group create -n "<resource-group-name>" -l "<location>"

接下來，建立 Azure Batch 帳戶。

az batch account create -l "<location>" -g "<resource-group-name>" -n "<batch-account-name>"

每個 Batch 帳戶有其對應的存取金鑰。需要有這些金鑰，才能在 Azure Batch 帳戶中建立進一步的資源。在生產環境中，最好使用 Azure Key Vault 來儲存這些金鑰。然後您可以建立應用程式的服務主體。使用此服務主體，應用程式可以建立 OAuth 權杖以存取 Key Vault 中的金鑰。

az batch account keys list -g "<resource-group-name>" -n "<batch-account-name>"

複製並儲存要在後續步驟中使用的金鑰。

步驟 3︰建立 Azure Batch 服務用戶端

下列程式碼片段會先匯入 azure-batch JavaScript 模組，然後建立 Batch 服務用戶端。您必須先使用從上一個步驟複製的 Batch 帳戶金鑰來建立 SharedKeyCredentials 物件。

// Initializing Azure Batch variables

import { BatchServiceClient, BatchSharedKeyCredentials } from "@azure/batch";

// Replace values below with Batch Account details
const batchAccountName = '<batch-account-name>';
const batchAccountKey = '<batch-account-key>';
const batchEndpoint = '<batch-account-url>';

const credentials = new BatchSharedKeyCredentials(batchAccountName, batchAccountKey);
const batchClient = new BatchServiceClient(credentials, batchEndpoint);

在 Azure 入口網站的 [概觀] 索引標籤中可以找到 Azure Batch URI。其格式如下︰

https://accountname.location.batch.azure.com

請參考螢幕擷取畫面：

Azure batch uri

步驟 4︰建立 Azure Batch 集區

Azure Batch 集區是由多個 VM (也稱為 Batch 節點) 所組成。 Azure Batch 服務會在這些節點上部署工作並加以管理。您可以為您的集區定義下列組態參數。

虛擬機器映像的類型
虛擬機器節點的大小
虛擬機器節點的數目

提示

虛擬機器節點的大小和數目主要取決於您想要平行執行的工作數目以及工作本身。我們建議進行測試，以判斷理想的數目和大小。

下列程式碼片段會建立組態參數物件。

// Creating Image reference configuration for Ubuntu Linux VM
const imgRef = {
    publisher: "Canonical",
    offer: "UbuntuServer",
    sku: "20.04-LTS",
    version: "latest"
}
// Creating the VM configuration object with the SKUID
const vmConfig = {
    imageReference: imgRef,
    nodeAgentSKUId: "batch.node.ubuntu 20.04"
};
// Number of VMs to create in a pool
const numVms = 4;

// Setting the VM size
const vmSize = "STANDARD_D1_V2";

提示

如需 Azure Batch 及其 SKU 識別碼可用的 Linux VM 映像清單，請參閱虛擬機器映像清單。

一旦定義集區組態，您就可以建立 Azure Batch 集區。 Batch 集區命令會建立 Azure 虛擬機器節點，並備妥它們以便用於接收要執行的工作。每個集區都應該有後續步驟中參考的唯一識別碼。

下列程式碼片段會建立 Azure Batch 集區。

// Create a unique Azure Batch pool ID
const now = new Date();
const poolId = `processcsv_${now.getFullYear()}${now.getMonth()}${now.getDay()}${now.getHours()}${now.getSeconds()}`;

const poolConfig = {
    id: poolId,
    displayName: "Processing csv files",
    vmSize: vmSize,
    virtualMachineConfiguration: vmConfig,
    targetDedicatedNodes: numVms,
    enableAutoScale: false
};

// Creating the Pool
var pool = batchClient.pool.add(poolConfig, function (error, result){
    if(error!=null){console.log(error.response)};
});

您可以檢查已建立的集區狀態，先確定狀態處於「作用中」，再繼續將作業提交至該集區。

var cloudPool = batchClient.pool.get(poolId,function(error,result,request,response){
        if(error == null)
        {

            if(result.state == "active")
            {
                console.log("Pool is active");
            }
        }
        else
        {
            if(error.statusCode==404)
            {
                console.log("Pool not found yet returned 404...");

            }
            else
            {
                console.log("Error occurred while retrieving pool data");
            }
        }
        });

以下是 pool.get 函式所傳回的範例結果物件。

{
  id: 'processcsv_2022002321',
  displayName: 'Processing csv files',
  url: 'https://<batch-account-name>.westus.batch.azure.com/pools/processcsv_2022002321',
  eTag: '0x8D9D4088BC56FA1',
  lastModified: 2022-01-10T07:12:21.943Z,
  creationTime: 2022-01-10T07:12:21.943Z,
  state: 'active',
  stateTransitionTime: 2022-01-10T07:12:21.943Z,
  allocationState: 'steady',
  allocationStateTransitionTime: 2022-01-10T07:13:35.103Z,
  vmSize: 'standard_d1_v2',
  virtualMachineConfiguration: {
    imageReference: {
      publisher: 'Canonical',
      offer: 'UbuntuServer',
      sku: '20.04-LTS',
      version: 'latest'
    },
    nodeAgentSKUId: 'batch.node.ubuntu 20.04'
  },
  resizeTimeout: 'PT15M',
  currentDedicatedNodes: 4,
  currentLowPriorityNodes: 0,
  targetDedicatedNodes: 4,
  targetLowPriorityNodes: 0,
  enableAutoScale: false,
  enableInterNodeCommunication: false,
  taskSlotsPerNode: 1,
  taskSchedulingPolicy: { nodeFillType: 'Spread' }}

步驟 4︰提交 Azure Batch 作業

Azure Batch 作業是相似工作的邏輯群組。在我們的案例中，這是「將 csv 處理成 JSON」。這裡的每個工作都可能會處理每個 Azure 儲存體容器中存在的 csv 檔案。

這些工作會以平行方式執行並且部署於多個節點 (由 Azure Batch 服務協調)。

提示

您可以使用 taskSlotsPerNode 屬性來指定可以在單一節點上同時執行的工作數目上限。

準備工作

建立的 VM 節點是空白的 Ubuntu 節點。您通常需要安裝一組程式作為必要條件。一般來說，對於 Linux 節點，您可以有在實際工作執行前安裝先決條件的殼層指令碼。不過，它可能是任何可程式化的可執行檔。

此範例中的殼層指令碼會安裝 Python-pip 和適用於 Python 的 Azure 儲存體 Blob SDK。

您可以在 Azure 儲存體帳戶上傳指令碼，並產生 SAS URI 來存取指令碼。使用 Azure 儲存體 JavaScript SDK 也可以自動執行此程序。

提示

作業的準備工作只會在需要執行特定工作的 VM 節點上執行。如果您想要在所有節點上安裝必要條件 (不管其上執行的工作為何)，可以在新增集區時使用 startTask 屬性。您可以使用下列準備工作定義以供參考。

準備工作是在 Azure Batch 作業提交期間指定。以下是一些可設定的準備工作參數：

識別碼︰準備工作的唯一識別碼
命令列︰要執行工作可執行檔的命令列
resourceFiles︰提供執行此工作所需下載之檔案詳細資料的物件陣列。其選項如下：
- httpUrl：要下載的檔案 URL
- filePath︰要下載並儲存檔案的本機路徑
- fileMode︰僅適用於 Linux 節點，fileMode 為八進位格式 (預設值是 0770)
waitForSuccess︰如果設為 true，此工作不會在準備工作失敗時執行
runElevated︰如果需要提高的權限才能執行工作，請將它設定為 true。

下列程式碼片段顯示準備工作指令碼組態範例︰

var jobPrepTaskConfig = {id:"installprereq",commandLine:"sudo sh startup_prereq.sh > startup.log",resourceFiles: [{ 'httpUrl': 'Blob sh url', 'filePath': 'startup_prereq.sh' }],waitForSuccess:true,runElevated:true, userIdentity: {autoUser: {elevationLevel: "admin", scope: "pool"}}}

如果不需安裝任何必要條件，您的工作即可執行，您可以略過準備工作。下列程式碼會建立一項作業，其顯示名稱為「處理 csv 檔案」。

// Setting Batch Pool ID
const poolInfo = { poolId: poolId };
// Batch job configuration object
const jobId = "processcsvjob";
const jobConfig = {
    id: jobId,
    displayName: "process csv files",
    jobPreparationTask: jobPrepTaskConfig,
    poolInfo: poolInfo
};
// Adding Azure batch job to the pool
const job = batchClient.job.add(jobConfig, function (error, result) {
        if (error !== null) {
            console.log("An error occurred while creating the job...");
            console.log(error.response);
        }
    }
);

步驟 5︰提交作業的 Azure 批次工作

現在已建立處理 csv 作業，讓我們為該作業建立工作。假設我們有四個容器，我們必須建立四項工作，每個容器一項工作。

如果我們查看 Python 指令碼，它接受兩個參數︰

容器名稱︰要從中下載檔案的儲存體容器
模式︰檔案名稱模式的選擇性參數

假設我們有四個容器 "con1"、"con2"、"con3"、"con4"，下列程式碼顯示如何將四個工作提交至我們稍早建立的 Azure 批次作業「處理 csv」。

// storing container names in an array
const containerList = ["con1", "con2", "con3", "con4"];      //Replace with list of blob containers within storage account
containerList.forEach(function (val, index) {
    console.log("Submitting task for container : " + val);
    const containerName = val;
    const taskID = containerName + "_process";
    // Task configuration object
    const taskConfig = {
        id: taskID,
        displayName: 'process csv in ' + containerName,
        commandLine: 'python processcsv.py --container ' + containerName,
        resourceFiles: [{ 'httpUrl': 'Blob script url', 'filePath': 'processcsv.py' }]
    };

    const task = batchClient.task.add(jobId, taskConfig, function (error, result) {
        if (error !== null) {
            console.log("Error occurred while creating task for container " + containerName + ". Details : " + error.response);
        }
        else {
            console.log("Task for container : " + containerName + " submitted successfully");
        }
    });
});

此程式碼會將多個工作新增至集區。而每項工作會在所建立 VM 集區中的節點上執行。如果工作數目超過集區或 taskSlotsPerNode 屬性中的 VM 數目，工作會等到節點可用為止。 Azure Batch 會自動處理此協調流程。

入口網站有工作與作業狀態的詳細檢視。您也可以使用此清單並取得 Azure JavaScript SDK 中的函數。文件連結中會提供詳細資料。

下一步

了解 Batch 服務工作流程和主要資源，例如集區、節點、作業和工作。
請參閱 Batch JavaScript 參考以探索 Batch API。

共用方式為