Job - Add
將作業新增至指定的帳戶。
Batch 服務支援兩種方式來控制在作業中完成的工作。 在第一種方法中,使用者會指定作業管理員工作。 Batch 服務會在準備好啟動作業時啟動此工作。 作業管理員工作會使用工作 API 控制在此作業下執行的其他所有工作。 在第二種方法中,使用者會使用工作 API,直接控制使用中作業下的工作執行。 另請注意:命名作業時,請避免包含敏感性資訊,例如用戶名稱或秘密項目名稱。 此資訊可能會出現在 Microsoft 支援服務工程師可存取的遙測記錄中。
POST {batchUrl}/jobs?api-version=2023-11-01.18.0
POST {batchUrl}/jobs?timeout={timeout}&api-version=2023-11-01.18.0
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
batch
|
path | True |
string |
所有 Azure Batch 服務要求的基底 URL。 |
api-version
|
query | True |
string |
用戶端 API 版本。 |
timeout
|
query |
integer int32 |
伺服器可以花費在處理要求的最大時間,以秒為單位。 預設值為 30 秒。 |
要求標頭
Media Types: "application/json; odata=minimalmetadata"
名稱 | 必要 | 類型 | Description |
---|---|---|---|
client-request-id |
string uuid |
呼叫端產生的要求識別,格式為不含大括弧的 GUID,例如大括弧,例如 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。 |
|
return-client-request-id |
boolean |
伺服器是否應該在回應中傳回 client-request-id。 |
|
ocp-date |
string date-time-rfc1123 |
發出要求的時間。 用戶端連結庫通常會將此設定為目前的系統時鐘時間;如果您要直接呼叫 REST API,請明確設定它。 |
要求本文
Media Types: "application/json; odata=minimalmetadata"
名稱 | 必要 | 類型 | Description |
---|---|---|---|
id | True |
string |
可唯一識別帳戶內作業的字串。 |
poolInfo | True |
Batch 服務執行作業工作的集區。 |
|
allowTaskPreemption |
boolean |
此作業中的工作是否可以由其他高優先順序工作先佔 |
|
commonEnvironmentSettings |
一般環境變數設定的清單。 這些環境變數會針對作業 (中的所有工作設定,包括作業管理員、作業準備和作業發行工作) 。 |
||
constraints |
作業的執行條件約束。 |
||
displayName |
string |
工作的顯示名稱。 |
|
jobManagerTask |
啟動作業時要啟動之作業管理員工作的詳細數據。 |
||
jobPreparationTask |
作業準備工作。 |
||
jobReleaseTask |
作業發行工作。 |
||
maxParallelTasks |
integer |
工作可以平行執行的工作數目上限。 |
|
metadata |
與作業相關聯的名稱/值組清單做為元數據。 |
||
networkConfiguration |
作業的網路組態。 |
||
onAllTasksComplete |
當作業中的所有工作都處於已完成狀態時,Batch 服務應該採取的動作。 |
||
onTaskFailure |
當作業中的任何工作失敗時,Batch 服務應該採取的動作。 |
||
priority |
integer |
作業的優先順序。 |
|
usesTaskDependencies |
boolean |
作業中的工作是否可以彼此定義相依性。 預設值為 false。 |
回應
名稱 | 類型 | Description |
---|---|---|
201 Created |
Batch 服務的要求成功。 標題
|
|
Other Status Codes |
Batch 服務的錯誤。 |
安全性
azure_auth
Microsoft Entra OAuth 2.0 驗證碼流程
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
Authorization
類型:
apiKey
位於:
header
範例
Add a basic job |
Add a complex job |
Add a basic job
範例要求
POST account.region.batch.azure.com/jobs?api-version=2023-11-01.18.0
{
"id": "jobId",
"priority": 0,
"poolInfo": {
"poolId": "poolId"
}
}
範例回覆
Add a complex job
範例要求
POST account.region.batch.azure.com/jobs?api-version=2023-11-01.18.0
{
"id": "jobId",
"priority": 100,
"constraints": {
"maxWallClockTime": "PT1H",
"maxTaskRetryCount": -1
},
"jobManagerTask": {
"id": "taskId",
"commandLine": "myprogram.exe",
"resourceFiles": [
{
"httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas",
"filePath": "myprogram.exe"
},
{
"storageContainerUrl": "http://mystorage1.blob.core.windows.net/data?sas",
"filePath": "datafolder"
}
],
"environmentSettings": [
{
"name": "myvariable",
"value": "myvalue"
}
],
"constraints": {
"maxWallClockTime": "PT1H",
"maxTaskRetryCount": 0,
"retentionTime": "PT1H"
},
"requiredSlots": 2,
"killJobOnCompletion": false,
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "admin"
}
},
"runExclusive": true
},
"poolInfo": {
"autoPoolSpecification": {
"autoPoolIdPrefix": "mypool",
"poolLifetimeOption": "job",
"pool": {
"vmSize": "small",
"cloudServiceConfiguration": {
"osFamily": "4",
"osVersion": "*"
},
"resizeTimeout": "PT15M",
"targetDedicatedNodes": 3,
"targetLowPriorityNodes": 0,
"taskSlotsPerNode": 2,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"enableAutoScale": false,
"enableInterNodeCommunication": true,
"startTask": {
"commandLine": "myprogram2.exe",
"resourceFiles": [
{
"httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas",
"filePath": "myprogram2.exe"
}
],
"environmentSettings": [
{
"name": "myvariable",
"value": "myvalue"
}
],
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "admin"
}
},
"maxTaskRetryCount": 2,
"waitForSuccess": true
},
"certificateReferences": [
{
"thumbprint": "0123456789abcdef0123456789abcdef01234567",
"thumbprintAlgorithm": "sha1",
"storeLocation": "localmachine",
"storeName": "Root",
"visibility": [
"task"
]
}
],
"metadata": [
{
"name": "myproperty",
"value": "myvalue"
}
],
"targetNodeCommunicationMode": "default"
}
}
},
"metadata": [
{
"name": "myproperty",
"value": "myvalue"
}
]
}
範例回覆
定義
名稱 | Description |
---|---|
Access |
令牌授與存取權的 Batch 資源。 |
Application |
要部署到計算節點之封裝的參考。 |
Authentication |
工作可用來執行 Batch 服務作業的驗證令牌設定。 |
Auto |
指定暫存「自動集區」的特性。 提交作業時,Batch 服務會建立此自動集區。 |
Auto |
自動用戶的範圍 |
Auto |
指定在 Batch 服務上執行工作之自動用戶的參數。 |
Azure |
用來使用 Blobfuse 連線到 Azure 記憶體容器的資訊。 |
Azure |
用來連線到 Azure Fileshare 的資訊。 |
Batch |
從 Azure Batch 服務收到的錯誤回應。 |
Batch |
Azure Batch 錯誤回應中包含的其他信息專案。 |
Caching |
要針對磁碟啟用的快取類型。 |
Certificate |
要安裝在集區中計算節點上之憑證的參考。 |
Certificate |
要在其中安裝憑證之計算節點上的證書存儲位置。 |
Certificate |
計算節點上的哪些用戶帳戶應該可以存取憑證的私人數據。 |
CIFSMount |
用來連線到 CIFS 檔案系統的資訊。 |
Cloud |
以 Azure 雲端服務 平台為基礎的集區中計算節點的組態。 |
Compute |
工作如何分散到集區中的計算節點。 |
Compute |
與計算節點將使用之 Batch 集區相關聯的使用者指派身分識別參考。 |
Container |
已啟用容器的集區組態。 |
Container |
私人容器登錄。 |
Container |
要使用的容器技術。 |
Container |
容器Task工作目錄的位置。 |
Data |
集區中與計算節點相關聯的數據磁碟將使用的設定。 使用連結的資料磁碟時,您必須在 VM 內掛接並格式化磁碟,才能使用這些磁碟。 |
Diff |
指定集區中所有計算節點 (VM) 作業系統磁碟的暫時磁碟位置。 |
Diff |
指定計算節點 (VM) 所使用的作業系統磁碟暫時磁碟設定。 |
Disk |
在集區中的計算節點上套用的磁碟加密組態。 使用 Azure 計算資源庫映像建立的 Linux 集區不支援磁碟加密組態。 |
Disk |
Batch 服務將在計算節點上加密的磁碟目標清單。 |
Dynamic |
動態 vnet 指派的範圍。 |
Elevation |
使用者的提高許可權層級。 |
Environment |
工作進程上要設定的環境變數。 |
Error |
在 Azure Batch 錯誤回應中收到的錯誤訊息。 |
Http |
HTTP 標頭名稱/值組 |
Image |
Azure 虛擬機器 Marketplace 映射或 Azure 計算資源庫映像的參考。 若要取得 Azure Batch 所驗證的所有 Azure Marketplace 影像參考清單,請參閱作業。 |
Inbound |
端點的通訊協定。 |
Inbound |
輸入 NAT 集區,可用來在外部處理 Batch 集區中計算節點上的特定埠。 |
IPAddress |
集區的公用IP位址布建類型。 |
Job |
要新增的 Azure Batch 作業。 |
Job |
作業的執行條件約束。 |
Job |
指定作業管理員工作的詳細數據。 |
Job |
作業的網路組態。 |
Job |
在任何指定計算節點上作業的任何工作之前,要執行的作業準備工作。 |
Job |
作業執行所在的任何計算節點上,要於作業完成時執行的作業發行工作。 |
Linux |
用來在 Linux 計算節點上建立使用者帳戶的屬性。 |
Login |
使用者的登入模式 |
Managed |
|
Metadata |
與 Batch 服務資源相關聯的名稱/值組。 |
Mount |
要掛接在每個節點上的文件系統。 |
Network |
集區的網路組態。 |
Network |
要套用至輸入端點的網路安全組規則。 |
Network |
應針對指定的IP位址、子網範圍或卷標採取的動作。 |
NFSMount |
用來連線到 NFS 檔案系統的資訊。 |
Node |
決定集區如何與 Batch 服務通訊。 |
Node |
集區的節點放置組態。 |
Node |
配置集區中節點的位置原則。 |
On |
當作業中的所有工作都處於已完成狀態時,Batch 服務應該採取的動作。 |
On |
當作業中的任何工作失敗時,Batch 服務應該採取的動作。 |
OSDisk |
計算節點的作業系統磁碟設定 (VM) 。 |
Output |
在 Batch 服務完成執行工作程式之後,將檔案從 Azure Batch 計算節點上傳至另一個位置的規格。 |
Output |
指定 Azure Blob 記憶體容器內的檔案上傳目的地。 |
Output |
檔案應該上傳至其中的目的地。 |
Output |
工作輸出檔案或一組檔案應該上傳的條件。 |
Output |
輸出檔案上傳作業的詳細數據,包括執行上傳的條件。 |
Pool |
集區的端點組態。 |
Pool |
指定如何將作業指派給集區。 |
Pool |
建立的自動集區存留期下限,以及如何依排程將多個作業指派給集區。 |
Pool |
建立新集區的規格。 |
Public |
集區網路設定的公用IP位址組態。 |
Resource |
要下載至計算節點的單一檔案或多個檔案。 |
Security |
指定虛擬機或虛擬機擴展集的安全性配置檔設定。 |
Security |
指定虛擬機的 SecurityType。 它必須設定為任何指定的值,才能啟用 UefiSettings。 |
Service |
指定使用「最新」映像版本時,用來為擴展集中的所有虛擬機設定相同映射版本的服務成品參考標識符。 |
Start |
當節點加入 Azure Batch 服務中的集區,或計算節點重新啟動或重新映射時執行的工作。 |
Storage |
用於建立數據磁碟或 OS 磁碟的記憶體帳戶類型。 |
Task |
要套用至工作的執行條件約束。 |
Task |
工作的容器設定。 |
Task |
指定工作應該如何分散到計算節點。 |
Uefi |
指定安全性設定,例如建立虛擬機時所使用的安全開機和 vTPM。 |
User |
用來建立使用者的屬性,用來在 Azure Batch 計算節點上執行工作。 |
User |
執行工作的使用者身分識別定義。 |
Virtual |
以 Azure 虛擬機器 基礎結構為基礎的集區中計算節點的組態。 |
VMExtension |
虛擬機延伸模組的組態。 |
Windows |
要套用至虛擬機的 Windows 作業系統設定。 |
Windows |
用來在 Windows 計算節點上建立用戶帳戶的屬性。 |
AccessScope
令牌授與存取權的 Batch 資源。
名稱 | 類型 | Description |
---|---|---|
job |
string |
授與存取權,以在包含工作的作業上執行所有作業。 |
ApplicationPackageReference
要部署到計算節點之封裝的參考。
名稱 | 類型 | Description |
---|---|---|
applicationId |
string |
要部署之應用程式的標識碼。 |
version |
string |
要部署的應用程式版本。 如果省略,則會部署預設版本。 |
AuthenticationTokenSettings
工作可用來執行 Batch 服務作業的驗證令牌設定。
名稱 | 類型 | Description |
---|---|---|
access |
令牌授與存取權的 Batch 資源。 |
AutoPoolSpecification
指定暫存「自動集區」的特性。 提交作業時,Batch 服務會建立此自動集區。
名稱 | 類型 | Description |
---|---|---|
autoPoolIdPrefix |
string |
自動建立集區時要新增至唯一標識碼的前置詞。 |
keepAlive |
boolean |
是否要在存留期到期后讓自動集區保持運作。 |
pool |
自動集區的集區規格。 |
|
poolLifetimeOption |
建立的自動集區存留期下限,以及如何依排程將多個作業指派給集區。 |
AutoUserScope
自動用戶的範圍
名稱 | 類型 | Description |
---|---|---|
pool |
string |
指定工作會以在集區中的每個計算節點上建立的一般自動使用者帳戶執行。 |
task |
string |
指定服務應該為 Task 建立新的使用者。 |
AutoUserSpecification
指定在 Batch 服務上執行工作之自動用戶的參數。
名稱 | 類型 | Description |
---|---|---|
elevationLevel |
自動使用者的提高許可權層級。 |
|
scope |
自動用戶的範圍 |
AzureBlobFileSystemConfiguration
用來使用 Blobfuse 連線到 Azure 記憶體容器的資訊。
名稱 | 類型 | Description |
---|---|---|
accountKey |
string |
Azure 記憶體帳戶金鑰。 |
accountName |
string |
Azure 記憶體帳戶名稱。 |
blobfuseOptions |
string |
要傳遞至掛接命令的其他命令行選項。 |
containerName |
string |
Azure Blob 儲存體 容器名稱。 |
identityReference |
用來存取 containerName 之使用者指派身分識別的參考 |
|
relativeMountPath |
string |
將掛接檔系統之計算節點上的相對路徑 |
sasKey |
string |
Azure 記憶體 SAS 令牌。 |
AzureFileShareConfiguration
用來連線到 Azure Fileshare 的資訊。
名稱 | 類型 | Description |
---|---|---|
accountKey |
string |
Azure 儲存體帳戶金鑰。 |
accountName |
string |
Azure 記憶體帳戶名稱。 |
azureFileUrl |
string |
Azure 檔案儲存體 URL。 |
mountOptions |
string |
要傳遞至掛接命令的其他命令行選項。 |
relativeMountPath |
string |
將掛接檔系統之計算節點上的相對路徑 |
BatchError
從 Azure Batch 服務收到的錯誤回應。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤的識別碼。 程式碼不變,且要以程式設計方式使用。 |
message |
描述錯誤的訊息,適用於在使用者介面中顯示。 |
|
values |
索引鍵/值組的集合,其中包含錯誤的其他詳細數據。 |
BatchErrorDetail
Azure Batch 錯誤回應中包含的其他信息專案。
名稱 | 類型 | Description |
---|---|---|
key |
string |
指定 Value 屬性意義的識別碼。 |
value |
string |
錯誤回應中包含的其他資訊。 |
CachingType
要針對磁碟啟用的快取類型。
名稱 | 類型 | Description |
---|---|---|
none |
string |
未啟用磁碟的快取模式。 |
readonly |
string |
磁碟的快取模式是唯讀的。 |
readwrite |
string |
磁碟的快取模式是讀取和寫入。 |
CertificateReference
要安裝在集區中計算節點上之憑證的參考。
名稱 | 類型 | Description |
---|---|---|
storeLocation |
要在其中安裝憑證之計算節點上的證書存儲位置。 |
|
storeName |
string |
要在其中安裝憑證之計算節點上的證書存儲名稱。 |
thumbprint |
string |
憑證的指紋。 |
thumbprintAlgorithm |
string |
指紋相關聯的演算法。 這必須是sha1。 |
visibility |
計算節點上的哪些用戶帳戶應該可以存取憑證的私人數據。 |
CertificateStoreLocation
要在其中安裝憑證之計算節點上的證書存儲位置。
名稱 | 類型 | Description |
---|---|---|
currentuser |
string |
憑證應該安裝到 CurrentUser 證書存儲。 |
localmachine |
string |
憑證應該安裝到 LocalMachine 證書存儲。 |
CertificateVisibility
計算節點上的哪些用戶帳戶應該可以存取憑證的私人數據。
名稱 | 類型 | Description |
---|---|---|
remoteuser |
string |
用戶帳戶應該會看到憑證,用戶可從中遠端訪問計算節點。 |
starttask |
string |
執行 StartTask 的使用者帳戶應該會看到憑證。 請注意,如果 AutoUser 範圍同時是 StartTask 和 Task 的集區,工作也會看到此憑證。 |
task |
string |
執行作業工作的用戶帳戶應該會看到憑證。 |
CIFSMountConfiguration
用來連線到 CIFS 檔案系統的資訊。
名稱 | 類型 | Description |
---|---|---|
mountOptions |
string |
要傳遞至掛接命令的其他命令行選項。 |
password |
string |
要用於對 CIFS 檔案系統進行驗證的密碼。 |
relativeMountPath |
string |
將掛接檔系統之計算節點上的相對路徑 |
source |
string |
要掛接之文件系統的 URI。 |
username |
string |
要用於對 CIFS 檔案系統進行驗證的使用者。 |
CloudServiceConfiguration
以 Azure 雲端服務 平台為基礎的集區中計算節點的組態。
名稱 | 類型 | Description |
---|---|---|
osFamily |
string |
要安裝在集區中虛擬機上的 Azure 客體 OS 系列。 |
osVersion |
string |
要安裝在集區中虛擬機上的 Azure 客體 OS 版本。 |
ComputeNodeFillType
工作如何分散到集區中的計算節點。
名稱 | 類型 | Description |
---|---|---|
pack |
string |
在將任何工作指派給集區中下一個計算節點之前,應盡可能 (taskSlotsPerNode) 指派給集區中的每個計算節點。 |
spread |
string |
工作應該平均指派給集區中的所有計算節點。 |
ComputeNodeIdentityReference
與計算節點將使用之 Batch 集區相關聯的使用者指派身分識別參考。
名稱 | 類型 | Description |
---|---|---|
resourceId |
string |
使用者指派身分識別的 ARM 資源識別碼。 |
ContainerConfiguration
已啟用容器的集區組態。
名稱 | 類型 | Description |
---|---|---|
containerImageNames |
string[] |
容器映像名稱的集合。 |
containerRegistries |
可從中提取容器的其他私人登錄。 |
|
type |
要使用的容器技術。 |
ContainerRegistry
私人容器登錄。
名稱 | 類型 | Description |
---|---|---|
identityReference |
用來存取 Azure Container Registry 而非使用者名稱和密碼的使用者指派身分識別參考。 |
|
password |
string |
登入登錄伺服器的密碼。 |
registryServer |
string |
登錄 URL。 |
username |
string |
要登入登錄伺服器的用戶名稱。 |
ContainerType
要使用的容器技術。
名稱 | 類型 | Description |
---|---|---|
criCompatible |
string |
CRI 型技術將用來啟動容器。 |
dockerCompatible |
string |
Docker 相容的容器技術將用來啟動容器。 |
ContainerWorkingDirectory
容器Task工作目錄的位置。
名稱 | 類型 | Description |
---|---|---|
containerImageDefault |
string |
使用容器映像中定義的工作目錄。 請注意,此目錄不會包含 Batch 下載的資源檔。 |
taskWorkingDirectory |
string |
使用標準 Batch 服務工作工作目錄,其中包含 Batch 填入的工作資源檔。 |
DataDisk
集區中與計算節點相關聯的數據磁碟將使用的設定。 使用連結的資料磁碟時,您必須在 VM 內掛接並格式化磁碟,才能使用這些磁碟。
名稱 | 類型 | Description |
---|---|---|
caching |
要針對數據磁碟啟用的快取類型。 |
|
diskSizeGB |
integer |
以 GB 為單位的初始磁碟大小。 |
lun |
integer |
邏輯單元編號。 |
storageAccountType |
要用於數據磁碟的記憶體帳戶類型。 |
DiffDiskPlacement
指定集區中所有計算節點 (VM) 作業系統磁碟的暫時磁碟位置。
名稱 | 類型 | Description |
---|---|---|
CacheDisk |
string |
暫時OS磁碟會儲存在VM快取上。 |
DiffDiskSettings
指定計算節點 (VM) 所使用的作業系統磁碟暫時磁碟設定。
名稱 | 類型 | Description |
---|---|---|
placement |
指定集區中所有 VM 之作業系統磁碟的暫時磁碟位置。 |
DiskEncryptionConfiguration
在集區中的計算節點上套用的磁碟加密組態。 使用 Azure 計算資源庫映像建立的 Linux 集區不支援磁碟加密組態。
名稱 | 類型 | Description |
---|---|---|
targets |
磁碟目標 Batch 服務會在計算節點上加密。 |
DiskEncryptionTarget
Batch 服務將在計算節點上加密的磁碟目標清單。
名稱 | 類型 | Description |
---|---|---|
osdisk |
string |
計算節點上的OS磁碟會加密。 |
temporarydisk |
string |
計算節點上的暫存磁碟會加密。 在 Linux 上,此加密會套用至其他分割區 (,例如在開機時) 掛接的數據磁碟上的磁碟分區。 |
DynamicVNetAssignmentScope
動態 vnet 指派的範圍。
名稱 | 類型 | Description |
---|---|---|
job |
string |
動態 VNet 指派會依作業完成。 |
none |
string |
未啟用動態 VNet 指派。 |
ElevationLevel
使用者的提高許可權層級。
名稱 | 類型 | Description |
---|---|---|
admin |
string |
使用者是具有提高存取權的用戶,並且會以完整的系統管理員許可權操作。 |
nonadmin |
string |
用戶是沒有提高存取權的標準使用者。 |
EnvironmentSetting
工作進程上要設定的環境變數。
名稱 | 類型 | Description |
---|---|---|
name |
string |
環境變數的名稱。 |
value |
string |
環境變數的值。 |
ErrorMessage
在 Azure Batch 錯誤回應中收到的錯誤訊息。
名稱 | 類型 | Description |
---|---|---|
lang |
string |
錯誤訊息的語言代碼 |
value |
string |
訊息的文字。 |
HttpHeader
HTTP 標頭名稱/值組
名稱 | 類型 | Description |
---|---|---|
name |
string |
上傳輸出檔案時所要使用的標頭不區分大小寫的名稱 |
value |
string |
上傳輸出檔案時要使用的標頭值 |
ImageReference
Azure 虛擬機器 Marketplace 映射或 Azure 計算資源庫映像的參考。 若要取得 Azure Batch 所驗證的所有 Azure Marketplace 影像參考清單,請參閱作業。
名稱 | 類型 | Description |
---|---|---|
exactVersion |
string |
用來建立節點之平臺映像或 Marketplace 映像的特定版本。 只有當建立集區時為 'version' 指定的值是 'latest',這個只讀字段才會與 'version' 不同。 |
offer |
string |
Azure 虛擬機器 Marketplace 映像的供應項目類型。 |
publisher |
string |
Azure 虛擬機器 Marketplace 映像的發行者。 |
sku |
string |
Azure 虛擬機器 Marketplace 映射的 SKU。 |
version |
string |
Azure 虛擬機器 Marketplace 映射的版本。 |
virtualMachineImageId |
string |
Azure 計算資源庫映射的 ARM 資源識別碼。 將會使用此映像標識碼來建立集區中的計算節點。這是 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} 或 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName} 的格式,一律預設為最新的映射版本。 |
InboundEndpointProtocol
端點的通訊協定。
名稱 | 類型 | Description |
---|---|---|
tcp |
string |
針對端點使用 TCP。 |
udp |
string |
針對端點使用UDP。 |
InboundNATPool
輸入 NAT 集區,可用來在外部處理 Batch 集區中計算節點上的特定埠。
名稱 | 類型 | Description |
---|---|---|
backendPort |
integer |
計算節點上的埠號碼。 |
frontendPortRangeEnd |
integer |
外部埠範圍中的最後一個埠號碼,用來提供個別計算節點上 backendPort 的輸入存取權。 |
frontendPortRangeStart |
integer |
外部埠範圍中的第一個埠號碼,用來提供個別計算節點上 backendPort 的輸入存取權。 |
name |
string |
端點的名稱。 |
networkSecurityGroupRules |
將套用至端點的網路安全組規則清單。 |
|
protocol |
端點的通訊協定。 |
IPAddressProvisioningType
集區的公用IP位址布建類型。
名稱 | 類型 | Description |
---|---|---|
batchmanaged |
string |
公用IP將由 Batch 建立和管理。 視集區的大小而定,可能會有多個公用IP。 |
nopublicipaddresses |
string |
將不會建立任何公用IP位址。 |
usermanaged |
string |
公用IP是由使用者提供,並用來布建計算節點。 |
JobAddParameter
要新增的 Azure Batch 作業。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
allowTaskPreemption |
boolean |
此作業中的工作是否可以由其他高優先順序工作先佔 |
|
commonEnvironmentSettings |
一般環境變數設定的清單。 這些環境變數會針對作業 (中的所有工作設定,包括作業管理員、作業準備和作業發行工作) 。 |
||
constraints |
作業的執行條件約束。 |
||
displayName |
string |
工作的顯示名稱。 |
|
id |
string |
可唯一識別帳戶內作業的字串。 |
|
jobManagerTask |
啟動作業時要啟動之作業管理員工作的詳細數據。 |
||
jobPreparationTask |
作業準備工作。 |
||
jobReleaseTask |
作業發行工作。 |
||
maxParallelTasks |
integer |
-1 |
工作可以平行執行的工作數目上限。 |
metadata |
與作業相關聯的名稱/值組清單作為元數據。 |
||
networkConfiguration |
作業的網路組態。 |
||
onAllTasksComplete |
當作業中的所有工作都處於已完成狀態時,Batch 服務應該採取的動作。 |
||
onTaskFailure |
當作業中的任何工作失敗時,Batch 服務應該採取的動作。 |
||
poolInfo |
Batch 服務執行作業工作的集區。 |
||
priority |
integer |
作業的優先順序。 |
|
usesTaskDependencies |
boolean |
作業中的工作是否可以彼此定義相依性。 預設值為 false。 |
JobConstraints
作業的執行條件約束。
名稱 | 類型 | Description |
---|---|---|
maxTaskRetryCount |
integer |
每個工作可能重試的次數上限。 如果 Batch 服務的結束代碼為非零,Batch 服務會重試工作。 |
maxWallClockTime |
string |
作業可能執行的經過時間上限,從建立作業的時間算起。 |
JobManagerTask
指定作業管理員工作的詳細數據。
名稱 | 類型 | Description |
---|---|---|
allowLowPriorityNode |
boolean |
作業管理員工作是否可以在現成/低優先順序計算節點上執行。 |
applicationPackageReferences |
在執行命令行之前,Batch 服務會部署至計算節點的應用程式套件清單。 |
|
authenticationTokenSettings |
工作可用來執行 Batch 服務作業的驗證令牌設定。 |
|
commandLine |
string |
作業管理員工作的命令行。 |
constraints |
套用至作業管理員工作的條件約束。 |
|
containerSettings |
作業管理員工作執行所在容器的設定。 |
|
displayName |
string |
作業管理員工作的顯示名稱。 |
environmentSettings |
作業管理員工作的環境變數設定清單。 |
|
id |
string |
字串,可唯一識別作業內的作業管理員工作。 |
killJobOnCompletion |
boolean |
作業管理員工作是否完成表示整個作業完成。 |
outputFiles |
執行命令行之後,Batch 服務將從計算節點上傳的檔案清單。 |
|
requiredSlots |
integer |
工作需要執行的排程位置數目。 |
resourceFiles |
Batch 服務在執行命令行之前會下載到計算節點的檔案清單。 |
|
runExclusive |
boolean |
作業管理員工作是否需要獨佔使用其執行所在的計算節點。 |
userIdentity |
作業管理員工作執行所在的使用者身分識別。 |
JobNetworkConfiguration
作業的網路組態。
名稱 | 類型 | Description |
---|---|---|
subnetId |
string |
從作業執行工作的計算節點將在工作期間聯結之虛擬網路子網的ARM資源識別碼。 這隻適用於 VirtualMachineConfiguration 集區。 |
JobPreparationTask
在任何指定計算節點上作業的任何工作之前,要執行的作業準備工作。
名稱 | 類型 | Description |
---|---|---|
commandLine |
string |
作業準備工作的命令行。 |
constraints |
套用至作業準備工作的條件約束。 |
|
containerSettings |
作業準備工作執行所在容器的設定。 |
|
environmentSettings |
作業準備工作的環境變數設定清單。 |
|
id |
string |
字串,可唯一識別作業內的作業準備工作。 |
rerunOnNodeRebootAfterSuccess |
boolean |
Batch 服務是否應該在計算節點重新啟動之後重新執行作業準備工作。 |
resourceFiles |
Batch 服務在執行命令行之前會下載到計算節點的檔案清單。 |
|
userIdentity |
工作準備工作執行所在的使用者身分識別。 |
|
waitForSuccess |
boolean |
Batch 服務是否應該等候作業準備工作順利完成,再排程計算節點上作業的任何其他工作。 如果作業準備工作結束且結束代碼為 0,則作業準備工作已順利完成。 |
JobReleaseTask
作業執行所在的任何計算節點上,要於作業完成時執行的作業發行工作。
名稱 | 類型 | Description |
---|---|---|
commandLine |
string |
作業發行工作的命令行。 |
containerSettings |
作業發行工作執行所在容器的設定。 |
|
environmentSettings |
作業發行工作的環境變數設定清單。 |
|
id |
string |
字串,可唯一識別作業內的作業發行工作。 |
maxWallClockTime |
string |
作業發行工作可以在指定的計算節點上執行的最大經過時間,從工作開始的時間開始計算。 如果工作未在時間限制內完成,Batch 服務就會終止它。 預設值為 15 分鐘。 您可能不會指定超過 15 分鐘的逾時。 如果您這麼做,Batch 服務會拒絕它並出現錯誤;如果您直接呼叫 REST API,HTTP 狀態代碼為 400 (不正確的要求) 。 |
resourceFiles |
Batch 服務在執行命令行之前會下載到計算節點的檔案清單。 資源檔案清單的大小上限。 超過大小上限時,要求將會失敗,而回應錯誤碼會是 RequestEntityTooLarge。 如果發生這種情況,ResourceFiles 的集合必須縮小大小。 這可以使用 .zip 檔案、應用程式套件或 Docker 容器來達成。 |
|
retentionTime |
string |
在計算節點上保留作業發行工作的工作目錄的最小時間。 在這段時間之後,Batch 服務可能會刪除Task目錄及其所有內容。 |
userIdentity |
執行作業發行工作的使用者身分識別。 |
LinuxUserConfiguration
用來在 Linux 計算節點上建立使用者帳戶的屬性。
名稱 | 類型 | Description |
---|---|---|
gid |
integer |
用戶帳戶的群組標識碼。 |
sshPrivateKey |
string |
用戶帳戶的 SSH 私鑰。 |
uid |
integer |
用戶帳戶的使用者標識碼。 |
LoginMode
使用者的登入模式
名稱 | 類型 | Description |
---|---|---|
batch |
string |
LOGON32_LOGON_BATCH Win32 登入模式。 建議針對長時間執行的平行進程使用批次登入模式。 |
interactive |
string |
LOGON32_LOGON_INTERACTIVE Win32 登入模式。 Windows VirtualMachineConfiguration 集區上已啟用 UAC。 如果此選項與 Windows VirtualMachineConfiguration 集區中提升許可權的使用者身分識別搭配使用,除非 Task 命令行所執行的應用程式設定為一律需要系統管理許可權或一律需要最大許可權,否則不會提高用戶會話。 |
ManagedDisk
名稱 | 類型 | Description |
---|---|---|
storageAccountType |
受控磁碟的記憶體帳戶類型。 |
MetadataItem
與 Batch 服務資源相關聯的名稱/值組。
名稱 | 類型 | Description |
---|---|---|
name |
string |
元數據項目的名稱。 |
value |
string |
元數據專案的值。 |
MountConfiguration
要掛接在每個節點上的文件系統。
名稱 | 類型 | Description |
---|---|---|
azureBlobFileSystemConfiguration |
在每個節點上使用 Blob FUSE 掛接的 Azure 記憶體容器。 |
|
azureFileShareConfiguration |
要掛接在每個節點上的 Azure 檔案共用。 |
|
cifsMountConfiguration |
要掛接在每個節點上的 CIFS/SMB 文件系統。 |
|
nfsMountConfiguration |
要掛接在每個節點上的NFS文件系統。 |
NetworkConfiguration
集區的網路組態。
名稱 | 類型 | Description |
---|---|---|
dynamicVNetAssignmentScope |
動態 vnet 指派的範圍。 |
|
enableAcceleratedNetworking |
boolean |
此集區是否應該啟用加速網路。 |
endpointConfiguration |
Batch 集區中計算節點上端點的組態。 |
|
publicIPAddressConfiguration |
Batch 集區中計算節點的公用IPAddress組態。 |
|
subnetId |
string |
將聯結集區計算節點之虛擬網路子網的 ARM 資源識別碼。 此格式為 /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}。 |
NetworkSecurityGroupRule
要套用至輸入端點的網路安全組規則。
名稱 | 類型 | Description |
---|---|---|
access |
應針對指定的IP位址、子網範圍或卷標採取的動作。 |
|
priority |
integer |
此規則的優先順序。 |
sourceAddressPrefix |
string |
要符合規則的來源位址前置詞或標記。 |
sourcePortRanges |
string[] |
要符合規則的來源埠範圍。 |
NetworkSecurityGroupRuleAccess
應針對指定的IP位址、子網範圍或卷標採取的動作。
名稱 | 類型 | Description |
---|---|---|
allow |
string |
允許存取。 |
deny |
string |
拒絕存取。 |
NFSMountConfiguration
用來連線到 NFS 檔案系統的資訊。
名稱 | 類型 | Description |
---|---|---|
mountOptions |
string |
要傳遞至掛接命令的其他命令行選項。 |
relativeMountPath |
string |
將掛接檔系統之計算節點上的相對路徑 |
source |
string |
要掛接之文件系統的 URI。 |
NodeCommunicationMode
決定集區如何與 Batch 服務通訊。
名稱 | 類型 | Description |
---|---|---|
classic |
string |
使用傳統通訊模式的節點需要來自 「BatchNodeManagement」 埠 29876 和 29877 上的輸入 TCP 通訊。{region}“ 服務卷標和埠 443 上的輸出 TCP 通訊到 ”Storage.region“ 和 ”BatchNodeManagement“。{region}“ 服務標籤。 |
default |
string |
Batch 服務會自動設定節點通訊模式。 |
simplified |
string |
使用簡化通訊模式的節點需要埠 443 上的輸出 TCP 通訊至 “BatchNodeManagement”。{region}“ 服務標籤。 不需要開啟的輸入埠。 |
NodePlacementConfiguration
集區的節點放置組態。
名稱 | 類型 | Description |
---|---|---|
policy |
節點放置原則類型位於 Batch 集區上。 |
NodePlacementPolicyType
配置集區中節點的位置原則。
名稱 | 類型 | Description |
---|---|---|
regional |
string |
集區中的所有節點都會配置在相同的區域中。 |
zonal |
string |
集區中的節點將會分散到不同的可用性區域,並盡最大努力平衡。 |
OnAllTasksComplete
當作業中的所有工作都處於已完成狀態時,Batch 服務應該採取的動作。
名稱 | 類型 | Description |
---|---|---|
noaction |
string |
什麼都不做。 除非以其他方式終止或停用作業,否則作業會維持使用中狀態。 |
terminatejob |
string |
終止作業。 Job 的 terminateReason 設定為 'AllTasksComplete'。 |
OnTaskFailure
當作業中的任何工作失敗時,Batch 服務應該採取的動作。
名稱 | 類型 | Description |
---|---|---|
noaction |
string |
什麼都不做。 除非以其他方式終止或停用作業,否則作業會維持使用中狀態。 |
performexitoptionsjobaction |
string |
在 Task 的 exitConditions 集合中,採取與 Task 結束條件相關聯的動作。 (如果這是 Task 指定的內容,這仍可能會導致不採取任何動作。) |
OSDisk
計算節點的作業系統磁碟設定 (VM) 。
名稱 | 類型 | Description |
---|---|---|
caching |
指定快取需求。 可能的值為:None、ReadOnly、ReadWrite。 預設值為:標準記憶體為 None。 進階記憶體的 ReadOnly。 |
|
diskSizeGB |
integer |
建立新的 OS 磁碟時,以 GB 為單位的初始磁碟大小。 |
ephemeralOSDiskSettings |
指定計算節點 (VM) 所使用的作業系統磁碟暫時磁碟設定。 |
|
managedDisk |
受控磁碟參數。 |
|
writeAcceleratorEnabled |
boolean |
指定是否應該在磁碟上啟用或停用 writeAccelerator。 |
OutputFile
在 Batch 服務完成執行工作程式之後,將檔案從 Azure Batch 計算節點上傳至另一個位置的規格。
名稱 | 類型 | Description |
---|---|---|
destination |
輸出檔的目的地 (s) 。 |
|
filePattern |
string |
模式,指出要上傳的檔案 () 。 |
uploadOptions |
上傳作業的其他選項,包括執行上傳的條件。 |
OutputFileBlobContainerDestination
指定 Azure Blob 記憶體容器內的檔案上傳目的地。
名稱 | 類型 | Description |
---|---|---|
containerUrl |
string |
要上傳檔案 () Azure Blob 儲存體 內的容器 URL。 |
identityReference |
用來存取 containerUrl 所指定 Azure Blob 儲存體 的使用者指派身分識別參考 |
|
path |
string |
Azure 記憶體容器內的目的地 Blob 或虛擬目錄。 |
uploadHeaders |
用於上傳輸出檔案中標頭的名稱/值組清單 |
OutputFileDestination
檔案應該上傳至其中的目的地。
名稱 | 類型 | Description |
---|---|---|
container |
Azure Blob 記憶體中上傳檔案的位置。 |
OutputFileUploadCondition
工作輸出檔案或一組檔案應該上傳的條件。
名稱 | 類型 | Description |
---|---|---|
taskcompletion |
string |
不論結束代碼為何,在工作程序結束之後,將檔案上傳 () 。 |
taskfailure |
string |
只有在工作進程結束且具有非零結束代碼之後,才能上傳檔案 (s) 。 |
tasksuccess |
string |
只有在工作程序結束且結束代碼為 0 之後,才能上傳檔案 (s) 。 |
OutputFileUploadOptions
輸出檔案上傳作業的詳細數據,包括執行上傳的條件。
名稱 | 類型 | Description |
---|---|---|
uploadCondition |
工作輸出檔案或一組檔案應該上傳的條件。 |
PoolEndpointConfiguration
集區的端點組態。
名稱 | 類型 | Description |
---|---|---|
inboundNATPools |
輸入 NAT 集區清單,可用來在外部尋址個別計算節點上的特定埠。 |
PoolInformation
指定如何將作業指派給集區。
名稱 | 類型 | Description |
---|---|---|
autoPoolSpecification |
暫存「自動集區」的特性。 提交作業時,Batch 服務會建立此自動集區。 |
|
poolId |
string |
現有集區的標識碼。 作業的所有工作都會在指定的集區上執行。 |
PoolLifetimeOption
建立的自動集區存留期下限,以及如何依排程將多個作業指派給集區。
名稱 | 類型 | Description |
---|---|---|
job |
string |
集區存在於專用作業的存留期。 Batch 服務會在建立作業時建立集區。 如果 [作業] 選項套用至作業排程,Batch 服務會針對排程上建立的每個作業建立新的自動集區。 |
jobschedule |
string |
集區存在於作業排程的存留期。 Batch 服務會在排程上建立第一個作業時建立集區。 您只能將此選項套用至作業排程,而不是套用至作業。 |
PoolSpecification
建立新集區的規格。
名稱 | 類型 | Description |
---|---|---|
applicationLicenses |
string[] |
Batch 服務將在集區中的每個計算節點上提供的應用程式授權清單。 |
applicationPackageReferences |
要安裝在集區中每個計算節點上的套件清單。 |
|
autoScaleEvaluationInterval |
string |
根據自動調整公式自動調整集區大小的時間間隔。 |
autoScaleFormula |
string |
集區中所需計算節點數目的公式。 |
certificateReferences |
要安裝在集區中每個計算節點上的憑證清單。 警告:此屬性已被取代,將在 2024 年 2 月之後移除。 請改用 Azure KeyVault 擴充功能 。 |
|
cloudServiceConfiguration |
集區的雲端服務組態。 |
|
displayName |
string |
集區的顯示名稱。 |
enableAutoScale |
boolean |
集區大小是否應該隨著時間自動調整。 |
enableInterNodeCommunication |
boolean |
集區是否允許計算節點之間的直接通訊。 |
metadata |
與集區相關聯的名稱/值組清單作為元數據。 |
|
mountConfiguration |
要掛接在集區中每個節點上的檔案系統清單。 |
|
networkConfiguration |
集區的網路組態。 |
|
resizeTimeout |
string |
將計算節點配置給集區的逾時。 |
resourceTags |
object |
與集區相關聯的使用者指定標籤。 |
startTask |
加入集區時,要在每個計算節點上執行的工作。 當計算節點新增至集區或重新啟動計算節點時,工作就會執行。 |
|
targetDedicatedNodes |
integer |
集區中所需的專用計算節點數目。 |
targetLowPriorityNodes |
integer |
集區中所需的現成/低優先順序計算節點數目。 |
targetNodeCommunicationMode |
集區所需的節點通訊模式。 |
|
taskSchedulingPolicy |
工作如何分散到集區中的計算節點。 |
|
taskSlotsPerNode |
integer |
可用於在集區中單一計算節點上執行並行工作的工作位置數目。 |
userAccounts |
要建立於集區中每個計算節點上的用戶帳戶清單。 |
|
virtualMachineConfiguration |
集區的虛擬機組態。 |
|
vmSize |
string |
集區中虛擬機的大小。 集區中的所有虛擬機大小都相同。 |
PublicIPAddressConfiguration
集區網路設定的公用IP位址組態。
名稱 | 類型 | Description |
---|---|---|
ipAddressIds |
string[] |
布建計算節點時,Batch 服務將使用的公用IP清單。 |
provision |
集區的公用IP位址布建類型。 |
ResourceFile
要下載至計算節點的單一檔案或多個檔案。
名稱 | 類型 | Description |
---|---|---|
autoStorageContainerName |
string |
自動記憶體帳戶中的記憶體容器名稱。 |
blobPrefix |
string |
從 Azure 記憶體容器下載 Blob 時要使用的 Blob 前置詞。 只會下載名稱開頭為指定前置詞的 Blob。 |
fileMode |
string |
八進位格式的檔案許可權模式屬性。 |
filePath |
string |
相對於工作的工作目錄,下載檔案 () 的計算節點上的位置。 |
httpUrl |
string |
要下載的檔案 URL。 |
identityReference |
用來存取 storageContainerUrl 或 HTTPUrl 所指定之 Azure Blob 儲存體 的使用者指派身分識別參考 |
|
storageContainerUrl |
string |
Azure Blob 儲存體 內的 Blob 容器 URL。 |
SecurityProfile
指定虛擬機或虛擬機擴展集的安全性配置檔設定。
名稱 | 類型 | Description |
---|---|---|
encryptionAtHost |
boolean |
這個屬性可由要求中的使用者用來啟用或停用虛擬機或虛擬機擴展集的主機加密。 這會啟用所有磁碟的加密,包括主機本身的資源/暫存磁碟。 |
securityType |
指定虛擬機的 SecurityType。 它必須設定為任何指定的值,才能啟用 UefiSettings。 |
|
uefiSettings |
指定建立虛擬機時所使用的安全開機和 vTPM 等安全性設定。 |
SecurityTypes
指定虛擬機的 SecurityType。 它必須設定為任何指定的值,才能啟用 UefiSettings。
名稱 | 類型 | Description |
---|---|---|
trustedLaunch |
string |
可信啟動會防止進階和持續性攻擊技術侵擾。 |
ServiceArtifactReference
指定使用「最新」映像版本時,用來為擴展集中的所有虛擬機設定相同映射版本的服務成品參考標識符。
名稱 | 類型 | Description |
---|---|---|
id |
string |
ServiceArtifactReference 的服務成品參考標識符 |
StartTask
當節點加入 Azure Batch 服務中的集區,或計算節點重新啟動或重新映射時執行的工作。
名稱 | 類型 | Description |
---|---|---|
commandLine |
string |
StartTask 的命令行。 |
containerSettings |
StartTask 執行所在容器的設定。 |
|
environmentSettings |
StartTask 的環境變數設定清單。 |
|
maxTaskRetryCount |
integer |
工作可能會重試的最大次數。 |
resourceFiles |
Batch 服務在執行命令行之前會下載到計算節點的檔案清單。 資源檔案清單的大小上限。 超過大小上限時,要求將會失敗,而回應錯誤碼將會是 RequestEntityTooLarge。 如果發生這種情況,ResourceFiles 的集合必須縮小大小。 這可以使用 .zip 檔案、應用程式套件或 Docker 容器來達成。 |
|
userIdentity |
StartTask 執行所在的使用者身分識別。 |
|
waitForSuccess |
boolean |
Batch 服務是否應該等候 StartTask 順利完成 (,在排程計算節點上的任何工作之前,先結束結束代碼 0) 。 |
StorageAccountType
用於建立數據磁碟或 OS 磁碟的記憶體帳戶類型。
名稱 | 類型 | Description |
---|---|---|
premium_lrs |
string |
數據磁碟/OS 磁碟應該使用進階本地備援記憶體。 |
standard_lrs |
string |
數據磁碟/OS 磁碟應該使用標準本地備援記憶體。 |
standardssd_lrs |
string |
數據磁碟/OS 磁碟應該使用標準 SSD 本地備援記憶體。 |
TaskConstraints
要套用至工作的執行條件約束。
名稱 | 類型 | Description |
---|---|---|
maxTaskRetryCount |
integer |
工作可能會重試的最大次數。 如果 Batch 服務結束代碼為非零,則會重試工作。 |
maxWallClockTime |
string |
任務可能執行的最大經過時間,從工作開始的時間開始測量。 如果工作未在時間限制內完成,Batch 服務就會終止它。 |
retentionTime |
string |
從執行完成時,在計算節點上保留工作目錄的最小時間。 此時,Batch 服務可能會刪除Task目錄及其所有內容。 |
TaskContainerSettings
工作的容器設定。
名稱 | 類型 | Description |
---|---|---|
containerRunOptions |
string |
容器 create 命令的其他選項。 |
imageName |
string |
要用來建立工作執行所在容器的映像。 |
registry |
包含容器映像的私人登錄。 |
|
workingDirectory |
容器Task工作目錄的位置。 |
TaskSchedulingPolicy
指定工作應該如何分散到計算節點。
名稱 | 類型 | Description |
---|---|---|
nodeFillType |
工作如何分散到集區中的計算節點。 |
UefiSettings
指定安全性設定,例如建立虛擬機時所使用的安全開機和 vTPM。
名稱 | 類型 | Description |
---|---|---|
secureBootEnabled |
boolean |
指定是否應在虛擬機上啟用安全開機。 |
vTpmEnabled |
boolean |
指定是否應在虛擬機上啟用 vTPM。 |
UserAccount
用來建立使用者的屬性,用來在 Azure Batch 計算節點上執行工作。
名稱 | 類型 | Description |
---|---|---|
elevationLevel |
用戶帳戶的提高許可權層級。 |
|
linuxUserConfiguration |
用戶帳戶的 Linux 特定用戶設定。 |
|
name |
string |
用戶帳戶的名稱。 名稱可以包含最多 20 個字元的任何 Unicode 字元。 |
password |
string |
用戶帳戶的密碼。 |
windowsUserConfiguration |
用戶帳戶的 Windows 特定用戶組態。 |
UserIdentity
執行工作的使用者身分識別定義。
名稱 | 類型 | Description |
---|---|---|
autoUser |
執行工作的自動使用者。 |
|
username |
string |
執行工作的使用者身分識別名稱。 |
VirtualMachineConfiguration
以 Azure 虛擬機器 基礎結構為基礎的集區中計算節點的組態。
名稱 | 類型 | Description |
---|---|---|
containerConfiguration |
集區的容器組態。 |
|
dataDisks |
Data |
連結至集區中計算節點的數據磁碟組態。 |
diskEncryptionConfiguration |
集區的磁碟加密組態。 |
|
extensions |
集區的虛擬機擴充功能。 |
|
imageReference |
Azure 虛擬機器 Marketplace 映像或要使用的自定義虛擬機映像參考。 |
|
licenseType |
string |
部署作業系統時要使用的內部部署授權類型。 Windows_Server - 內部部署授權適用於 Windows Server。 Windows_Client - 內部部署授權適用於 Windows 用戶端。 |
nodeAgentSKUId |
string |
要布建在集區中計算節點上的 Batch 計算節點代理程式的 SKU。 |
nodePlacementConfiguration |
集區的節點放置組態。 |
|
osDisk |
虛擬機操作系統磁碟的設定。 |
|
securityProfile |
指定虛擬機或虛擬機擴展集的安全性配置檔設定。 |
|
serviceArtifactReference |
指定使用 'latest' 映射版本時,用來為擴展集中的所有虛擬機設定相同映像版本的服務成品參考標識符。 |
|
windowsConfiguration |
虛擬機上的 Windows 作業系統設定。 |
VMExtension
虛擬機延伸模組的組態。
名稱 | 類型 | Description |
---|---|---|
autoUpgradeMinorVersion |
boolean |
指出擴充功能是否應該在部署時間使用較新的次要版本。 不過,部署之後,除非重新部署延伸模組,否則延伸模組將不會升級次要版本,即使此屬性設定為 true 亦然。 |
enableAutomaticUpgrade |
boolean |
指出如果有較新版本的擴充功能可用,平臺是否應該自動升級延伸模組。 |
name |
string |
虛擬機擴充功能的名稱。 |
protectedSettings |
object |
此延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。 |
provisionAfterExtensions |
string[] |
延伸模組名稱的集合。 |
publisher |
string |
擴充處理程序發行者的名稱。 |
settings |
object |
擴充功能的 JSON 格式化公用設定。 |
type |
string |
延伸的型別。 |
typeHandlerVersion |
string |
腳本處理程式的版本。 |
WindowsConfiguration
要套用至虛擬機的 Windows 作業系統設定。
名稱 | 類型 | Description |
---|---|---|
enableAutomaticUpdates |
boolean |
虛擬機上是否啟用自動更新。 |
WindowsUserConfiguration
用來在 Windows 計算節點上建立用戶帳戶的屬性。
名稱 | 類型 | Description |
---|---|---|
loginMode |
使用者的登入模式 |