Pool - Update Properties

Batch 服務的要求成功。

標題

• client-request-id: string
• request-id: string
• ETag: string
• Last-Modified: string
• DataServiceId: string

BatchError

Batch 服務的錯誤。

string

要部署之應用程式的標識碼。
建立集區時，套件的應用程式標識碼必須完整 （/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}）。

string

要部署的應用程式版本。 如果省略，則會部署預設版本。
如果在集區上省略此專案，而且此應用程式未指定預設版本，要求會失敗，錯誤碼 InvalidApplicationPackageReferences 和 HTTP 狀態代碼 409。 如果在 Task 上省略此專案，而且此應用程式未指定預設版本，則工作會失敗，並出現前置處理錯誤。

string

指定工作會以在集區中的每個計算節點上建立的通用自動使用者帳戶執行。

string

指定服務應該為工作建立新的使用者。

ElevationLevel

自動使用者的提高許可權層級。
預設值為 nonAdmin。

AutoUserScope

自動用戶的範圍
預設值為集區。 如果集區正在執行 Windows，則當需要更嚴格的工作隔離時，應該指定 Task 的值。 例如，如果工作以可能會影響其他工作的方式變動登錄，或已在集區上指定憑證，而該集區上不應該由一般工作存取，但應該可供 StartTasks 存取。

string

錯誤的識別碼。 程序代碼是不變的，而且是要以程序設計方式取用。

ErrorMessage

描述錯誤的訊息，適用於在使用者介面中顯示。

BatchErrorDetail[]

索引鍵/值組的集合，其中包含錯誤的其他詳細數據。

string

指定 Value 屬性意義的識別碼。

string

錯誤回應隨附的其他資訊。

CertificateStoreLocation

要安裝憑證之計算節點上的證書存儲位置。
默認值為 currentuser。 此屬性僅適用於使用 Windows 計算節點設定的集區。 針對 Linux 計算節點，憑證會儲存在工作工作目錄內的目錄中，而環境變數AZ_BATCH_CERTIFICATES_DIR會提供給工作來查詢此位置。 對於可見度為 『remoteUser』 的憑證，會在使用者的主目錄中建立 『certs』 目錄（例如 /home/{user-name}/certs）和憑證放在該目錄中。

string

要安裝憑證之計算節點上的證書存儲名稱。
此屬性僅適用於使用 Windows 計算節點設定的集區。 常見的存放區名稱包括：My、Root、CA、Trust、Disallowed、TrustedPeople、TrustedPublisher、AuthRoot、AddressBook，但也可以使用任何自定義存放區名稱。 預設值為 My。

string

憑證的指紋。

string

指紋相關聯的演算法。 這必須是sha1。

CertificateVisibility[]

計算節點上的哪些用戶帳戶應該可以存取憑證的私用數據。
您可以在此集合中指定多個可見度。 預設值為 [所有帳戶]。

string

憑證應該安裝到 CurrentUser 證書存儲。

string

憑證應該安裝到 LocalMachine 證書存儲。

string

用戶從遠端訪問計算節點的用戶帳戶應該可以看到憑證。

string

執行 StartTask 的用戶帳戶應該可以看到憑證。 請注意，如果 AutoUser 範圍同時為 StartTask 和 Task 的集區，工作也會看到此憑證。

string

執行作業工作的用戶帳戶應該可以看到憑證。

string

使用者指派身分識別的 ARM 資源識別碼。

boolean

將此來源路徑掛接為唯讀模式或否。 默認值為 false （讀取/寫入模式）。
針對 Linux，如果您將此路徑掛接為讀取/寫入模式，這並不表示容器中的所有使用者都有路徑的讀取/寫入存取權，這取決於主機 VM 中的存取權。 如果此路徑是只讀掛接，容器內的所有使用者將無法修改路徑。

ContainerHostDataPath

掛接至容器客戶的路徑可以選取。

string

應用程式路徑。

string

作業準備工作路徑。

string

要共用其檔案之多重實例工作的路徑。

string

開始工作的路徑。

string

工作路徑。

string

路徑包含此節點上掛接的所有虛擬檔案系統。

ComputeNodeIdentityReference

使用者指派身分識別的參考，用來存取 Azure Container Registry，而不是使用者名稱和密碼。
與計算節點將使用的 Batch 集區相關聯的使用者指派身分識別參考。

string

登入登錄伺服器的密碼。

string

登錄 URL。
如果省略，預設值為 「docker.io」。。

string

要登入登錄伺服器的用戶名稱。

string

使用容器映像中定義的工作目錄。 請注意，此目錄不會包含 Batch 下載的資源檔。

string

使用標準 Batch 服務工作工作目錄，其中包含 Batch 填入的工作資源檔。

string

使用者是具有較高存取權的使用者，且會以完整的系統管理員許可權運作。

string

使用者是標準使用者，沒有提升許可權的存取權。

string

環境變數的名稱。

string

環境變數的值。

string

錯誤訊息的語言代碼

string

訊息的文字。

string

元數據項目的名稱。

string

元數據專案的值。

string

使用傳統通訊模式的節點需要來自 「BatchNodeManagement」 埠 29876 和 29877 上的輸入 TCP 通訊。{region}“ 服務卷標和埠 443 上的輸出 TCP 通訊至 ”Storage.region“ 和 ”BatchNodeManagement“。{region}“ 服務標籤。

string

節點通訊模式會自動由 Batch 服務設定。

string

使用簡化通訊模式的節點需要埠 443 上的輸出 TCP 通訊至 “BatchNodeManagement”。{region}“ 服務標籤。 不需要開啟的輸入埠。

ApplicationPackageReference[]

要安裝在集區中每個計算節點上的應用程式套件清單。
此清單會取代集區上任何現有的應用程式套件參考。 應用程式套件參考的變更會影響聯結集區的所有新計算節點，但在重新啟動或重新映像之前，不會影響已在集區中的計算節點。 在任何指定的集區上，最多有10個應用程式套件參考。 如果省略，或如果您指定空集合，則會從集區中移除任何現有的應用程式套件參考。 在指定的集區上最多可以指定10個參考。

CertificateReference[]

要安裝在集區中每個計算節點上的憑證清單。
此清單會取代集區上設定的任何現有憑證參考。 如果您指定空集合，則會從集區中移除任何現有的憑證參考。 針對 Windows 節點，Batch 服務會將憑證安裝至指定的證書存儲和位置。 針對 Linux 計算節點，憑證會儲存在工作工作目錄內的目錄中，而環境變數AZ_BATCH_CERTIFICATES_DIR會提供給工作來查詢此位置。 對於可見度為 『remoteUser』 的憑證，會在使用者的主目錄中建立 『certs』 目錄（例如 /home/{user-name}/certs）和憑證放在該目錄中。

警告：這個屬性已被取代，將在 2024 年 2 月之後移除。 請改用 Azure KeyVault 擴充功能。

MetadataItem[]

與集區相關聯的名稱/值組清單做為元數據。
此清單會取代集區上設定的任何現有元數據。 如果省略，或如果您指定空集合，則會從集區中移除任何現有的元數據。

StartTask

在聯結集區時，要在每個計算節點上執行的工作。 當計算節點新增至集區或計算節點重新啟動時，工作就會執行。
如果此元素存在，則會覆寫任何現有的 StartTask。 如果省略，則會從集區中移除任何現有的 StartTask。

NodeCommunicationMode

集區所需的節點通訊模式。
此設定會取代集區上任何現有的 targetNodeCommunication 設定。 如果省略，則現有的設定為預設值。

string

自動記憶體帳戶中的記憶體容器名稱。
autoStorageContainerName、storageContainerUrl 和 httpUrl 屬性互斥，其中一個必須指定。

string

從 Azure 記憶體容器下載 Blob 時要使用的 Blob 前置詞。 只會下載名稱開頭為指定前置詞的 Blob。
只有在使用 autoStorageContainerName 或 storageContainerUrl 時，屬性才有效。 此前置詞可以是部分檔名或子目錄。 如果未指定前置詞，則會下載容器中的所有檔案。

string

以八進位格式的檔案許可權模式屬性。
此屬性僅適用於下載至 Linux 計算節點的檔案。 如果針對將下載至 Windows 計算節點的 resourceFile 指定，則會忽略它。 如果未為 Linux 計算節點指定這個屬性，則會將預設值 0770 套用至檔案。

string

要下載檔案的計算節點位置，相對於工作的工作目錄。
如果指定 HTTPUrl 屬性，則需要 filePath，並描述將下載檔案的路徑，包括檔名。 否則，如果指定 autoStorageContainerName 或 storageContainerUrl 屬性，則 filePath 是選擇性的，而且是要下載檔案的目錄。 在 filePath 當做目錄使用的情況下，任何已經與輸入數據相關聯的目錄結構都會完整保留，並附加至指定的 filePath 目錄。 指定的相對路徑無法脫離 Task 的工作目錄（例如，使用 '..'）。

string

要下載之檔案的 URL。
autoStorageContainerName、storageContainerUrl 和 httpUrl 屬性互斥，其中一個必須指定。 如果 URL 指向 Azure Blob 記憶體，則必須從計算節點讀取它。 在 Azure 記憶體中取得 Blob 的這類 URL 有三種方式：包括授與 Blob 讀取許可權的共用存取簽章（SAS），使用具有讀取許可權的受控識別，或設定 Blob 或其容器的 ACL 以允許公用存取。

ComputeNodeIdentityReference

使用者指派身分識別的參考，用來存取 storageContainerUrl 或 HTTPUrl 所指定的 Azure Blob 記憶體
與計算節點將使用的 Batch 集區相關聯的使用者指派身分識別參考。

string

Azure Blob 記憶體中 Blob 容器的 URL。
autoStorageContainerName、storageContainerUrl 和 httpUrl 屬性互斥，其中一個必須指定。 此 URL 必須可從計算節點讀取和列出。 有三種方式可以取得 Azure 記憶體中容器的這類 URL：包括授與容器讀取和清單許可權的共用存取簽章（SAS），使用具有讀取和清單許可權的受控識別，或為容器設定 ACL 以允許公用存取。

string

StartTask 的命令行。
命令行不會在殼層下執行，因此無法利用殼層功能，例如環境變數擴充。 如果您想要利用這些功能，您應該在命令行中叫用殼層，例如在 Windows 中使用 “cmd /c MyCommand”，或在 Linux 中使用 “/bin/sh -c MyCommand”。 如果命令行參考檔案路徑，它應該使用相對路徑（相對於Task工作目錄），或使用 Batch 提供的環境變數 （https://zcusa.951200.xyz/azure/batch/batch-compute-node-environment-variables）。

TaskContainerSettings

StartTask 執行所在的容器設定。
指定此專案時，AZ_BATCH_NODE_ROOT_DIR下方的所有目錄都會遞歸地對應到容器中（節點上的 Azure Batch 目錄根目錄），所有工作環境變數都會對應到容器中，而工作命令行則會在容器中執行。 AZ_BATCH_NODE_ROOT_DIR外部容器中產生的檔案可能不會反映到主機磁碟，這表示 Batch 檔案 API 將無法存取這些檔案。

EnvironmentSetting[]

StartTask 的環境變數設定清單。

integer

重試工作的最大次數。
如果 Batch 服務結束代碼為非零，則會重試工作。 請注意，這個值會特別控制重試次數。 Batch 服務會嘗試工作一次，然後可能會重試到此限制。 例如，如果重試計數上限為 3，Batch 會嘗試工作最多 4 次（一次初始嘗試，3 次重試）。 如果重試計數上限為0，Batch服務就不會重試工作。 如果重試計數上限為 -1，Batch 服務會不限制地重試工作，但不建議用於啟動工作或任何工作。 預設值為 0（沒有重試）。

ResourceFile[]

Batch 服務在執行命令行之前，會先下載至計算節點的檔案清單。 資源檔案清單的大小上限。 超過大小上限時，要求將會失敗，而回應錯誤碼會是 RequestEntityTooLarge。 如果發生這種情況，ResourceFiles 的集合必須縮小大小。 這可以使用 .zip 檔案、應用程式套件或 Docker 容器來達成。
此元素底下列出的檔案位於工作的工作目錄中。

UserIdentity

StartTask 執行的使用者身分識別。
如果省略，工作會以工作唯一的非系統管理使用者身分執行。

boolean

在排程計算節點上的任何工作之前，Batch 服務是否應該等候 StartTask 順利完成（也就是結束代碼 0）。
如果 True 且 StartTask 在節點上失敗，Batch 服務會重試 StartTask，最多重試計數上限 （maxTaskRetryCount）。 如果工作在所有重試之後仍未順利完成，則 Batch 服務會將節點標示為無法使用，且不會排程工作。 您可以透過計算節點狀態和失敗資訊詳細資料來偵測此狀況。 如果為 false，Batch 服務將不會等候 StartTask 完成。 在此情況下，當 StartTask 仍在執行時，其他工作可以在計算節點上開始執行;即使 StartTask 失敗，新的工作仍會繼續排程在計算節點上。 默認值為 true。

ContainerHostBatchBindMountEntry[]

您要掛接至容器工作的路徑。
如果此陣列為 Null 或不存在，容器工作將會在 Windows 中掛接整個暫存磁碟驅動器（或 Linux 中的AZ_BATCH_NODE_ROOT_DIR）。 如果此陣列設定為空白，它就不會將任何數據路徑掛接至容器。

string

容器 create 命令的其他選項。
除了 Batch 服務所控制的自變數之外，這些額外的選項也會提供為 「docker create」 命令的自變數。

string

用來建立要在其中執行工作之容器的映像。
這是完整的映像參考，如同指定為 “docker pull”。 如果未提供任何標記做為 Image 名稱的一部分，則會使用標記 「：latest」 做為預設值。

ContainerRegistry

包含容器映像的私人登錄。
如果已在建立集區時提供，則可以省略此設定。

ContainerWorkingDirectory

容器工作工作目錄的位置。
默認值為 『taskWorkingDirectory』。

AutoUserSpecification

工作執行所在的自動使用者。
userName 和 autoUser 屬性互斥;您必須指定一個，但不能同時指定兩者。

string

執行工作的使用者身分識別名稱。
userName 和 autoUser 屬性互斥;您必須指定一個，但不能同時指定兩者。