Microsoft.Batch batchAccounts 2023-11-01
Bicep 資源定義
batchAccounts 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Batch/batchAccounts 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.Batch/batchAccounts@2023-11-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
allowedAuthenticationModes: [
'string'
]
autoStorage: {
authenticationMode: 'string'
nodeIdentityReference: {
resourceId: 'string'
}
storageAccountId: 'string'
}
encryption: {
keySource: 'string'
keyVaultProperties: {
keyIdentifier: 'string'
}
}
keyVaultReference: {
id: 'string'
url: 'string'
}
networkProfile: {
accountAccess: {
defaultAction: 'string'
ipRules: [
{
action: 'Allow'
value: 'string'
}
]
}
nodeManagementAccess: {
defaultAction: 'string'
ipRules: [
{
action: 'Allow'
value: 'string'
}
]
}
}
poolAllocationMode: 'string'
publicNetworkAccess: 'string'
}
}
屬性值
batchAccounts
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 （必要） 字元限制：3-24 合法字元： 小寫字母和數位。 |
| 位置 | 要在其中建立帳戶的區域。 | 字串 （必要） |
| 標籤 | 與帳戶相關聯的使用者指定標記。 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
| 身份 | Batch 帳戶的身分識別。 | BatchAccountIdentity |
| 性能 | Batch 帳戶的屬性。 | BatchAccountCreatePropertiesOrBatchAccountProperties |
BatchAccountIdentity
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 用於 Batch 帳戶的身分識別類型。 | 'None' 'SystemAssigned' 'UserAssigned' （必要） |
| userAssignedIdentities | 與 Batch 帳戶相關聯的使用者身分識別清單。 | BatchAccountIdentityUserAssignedIdentities |
BatchAccountIdentityUserAssignedIdentities
| 名字 | 描述 | 價值 |
|---|---|---|
| {自定義屬性} | UserAssignedIdentities |
UserAssignedIdentities
此物件不包含在部署期間設定的任何屬性。 所有屬性都是 ReadOnly。
BatchAccountCreatePropertiesOrBatchAccountProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| allowedAuthenticationModes | Batch 帳戶允許的驗證模式清單，可用來向數據平面進行驗證。 這不會影響控制平面的驗證。 | 包含任何的字串數組： 'AAD' 'SharedKey' 'TaskAuthenticationToken' |
| autoStorage | 與自動記憶體帳戶相關的屬性。 | AutoStorageBasePropertiesOrAutoStorageProperties |
| 加密 | 設定客戶數據在 Batch 帳戶內加密的方式。 根據預設，帳戶會使用Microsoft受控密鑰來加密。 如需其他控制，可以改用客戶管理的密鑰。 | EncryptionProperties |
| keyVaultReference | 與 Batch 帳戶相關聯的 Azure 金鑰保存庫參考。 | KeyVaultReference |
| networkProfile | 只有在啟用 publicNetworkAccess 時，網路配置檔才會生效。 | NetworkProfile |
| poolAllocationMode | 集區配置模式也會影響用戶端如何向 Batch 服務 API 進行驗證。 如果模式為 BatchService，用戶端可以使用存取金鑰或Microsoft Entra 識別碼進行驗證。 如果模式為 UserSubscription，客戶端必須使用Microsoft Entra ID。 預設值為 BatchService。 | 'BatchService' 'UserSubscription' |
| publicNetworkAccess | 如果未指定，預設值為 'enabled'。 | 'Disabled' 'Enabled' |
AutoStorageBasePropertiesOrAutoStorageProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| authenticationMode | Batch 服務將用來管理自動記憶體帳戶的驗證模式。 | 'BatchAccountManagedIdentity' 'StorageKeys' |
| nodeIdentityReference | 此處參考的身分識別必須指派給具有需要存取自動記憶體之計算節點的集區。 | ComputeNodeIdentityReference |
| storageAccountId | 要用於自動記憶體帳戶之記憶體帳戶的記憶體帳戶的資源識別碼。 | 字串 （必要） |
ComputeNodeIdentityReference
| 名字 | 描述 | 價值 |
|---|---|---|
| resourceId | 使用者指派身分識別的 ARM 資源識別碼。 | 字串 |
EncryptionProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| keySource | 金鑰來源的類型。 | 'Microsoft.Batch' 'Microsoft.KeyVault' |
| keyVaultProperties | 使用 Microsoft.KeyVault 時的其他詳細數據 | KeyVaultProperties |
KeyVaultProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| keyIdentifier | 具有或不含版本之秘密的完整路徑。 範例 https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053。 或 https://mykeyvault.vault.azure.net/keys/testkey。 若要可供使用，必須符合下列必要條件：Batch 帳戶具有系統指派的身分識別 帳戶身分識別已獲得金鑰/取得、金鑰/解除包裝和密鑰/包裝許可權 KeyVault 已啟用虛刪除和清除保護 |
字串 |
KeyVaultReference
| 名字 | 描述 | 價值 |
|---|---|---|
| id | 與 Batch 帳戶相關聯的 Azure 金鑰保存庫資源識別碼。 | 字串 （必要） |
| url | 與 Batch 帳戶相關聯的 Azure 金鑰保存庫 URL。 | 字串 （必要） |
NetworkProfile
| 名字 | 描述 | 價值 |
|---|---|---|
| accountAccess | batchAccount 端點的網路存取配置檔（Batch 帳戶數據平面 API）。 | EndpointAccessProfile |
| nodeManagementAccess | nodeManagement 端點的網路存取配置檔（Batch 服務管理 Batch 集區的計算節點）。 | EndpointAccessProfile |
EndpointAccessProfile
| 名字 | 描述 | 價值 |
|---|---|---|
| defaultAction | 端點存取的預設動作。 只有在啟用 publicNetworkAccess 時才適用。 | 'Allow' '拒絕' （必要） |
| ipRules | 篩選用戶端 IP 位址的 IP 範圍數位。 | IPRule[] |
IPRule
| 名字 | 描述 | 價值 |
|---|---|---|
| 行動 | 比對用戶端IP位址時的動作。 | '允許' （必要） |
| 價值 | IPv4 位址或 CIDR 格式的 IPv4 位址範圍。 | 字串 （必要） |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
沒有公用IP位址的 Azure Batch 集區
|
此範本會建立 Azure Batch 簡化的節點通訊集區，而不需要公用 IP 位址。 |
|
使用範本建立 Batch 帳戶
|
此範本會建立 Batch 帳戶和記憶體帳戶。 |
ARM 樣本資源定義
batchAccounts 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Batch/batchAccounts 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.Batch/batchAccounts",
"apiVersion": "2023-11-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"allowedAuthenticationModes": [ "string" ],
"autoStorage": {
"authenticationMode": "string",
"nodeIdentityReference": {
"resourceId": "string"
},
"storageAccountId": "string"
},
"encryption": {
"keySource": "string",
"keyVaultProperties": {
"keyIdentifier": "string"
}
},
"keyVaultReference": {
"id": "string",
"url": "string"
},
"networkProfile": {
"accountAccess": {
"defaultAction": "string",
"ipRules": [
{
"action": "Allow",
"value": "string"
}
]
},
"nodeManagementAccess": {
"defaultAction": "string",
"ipRules": [
{
"action": "Allow",
"value": "string"
}
]
}
},
"poolAllocationMode": "string",
"publicNetworkAccess": "string"
}
}
屬性值
batchAccounts
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 資源類型 | 'Microsoft.Batch/batchAccounts' |
| apiVersion | 資源 API 版本 | '2023-11-01' |
| 名字 | 資源名稱 | 字串 （必要） 字元限制：3-24 合法字元： 小寫字母和數位。 |
| 位置 | 要在其中建立帳戶的區域。 | 字串 （必要） |
| 標籤 | 與帳戶相關聯的使用者指定標記。 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
| 身份 | Batch 帳戶的身分識別。 | BatchAccountIdentity |
| 性能 | Batch 帳戶的屬性。 | BatchAccountCreatePropertiesOrBatchAccountProperties |
BatchAccountIdentity
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 用於 Batch 帳戶的身分識別類型。 | 'None' 'SystemAssigned' 'UserAssigned' （必要） |
| userAssignedIdentities | 與 Batch 帳戶相關聯的使用者身分識別清單。 | BatchAccountIdentityUserAssignedIdentities |
BatchAccountIdentityUserAssignedIdentities
| 名字 | 描述 | 價值 |
|---|---|---|
| {自定義屬性} | UserAssignedIdentities |
UserAssignedIdentities
此物件不包含在部署期間設定的任何屬性。 所有屬性都是 ReadOnly。
BatchAccountCreatePropertiesOrBatchAccountProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| allowedAuthenticationModes | Batch 帳戶允許的驗證模式清單，可用來向數據平面進行驗證。 這不會影響控制平面的驗證。 | 包含任何的字串數組： 'AAD' 'SharedKey' 'TaskAuthenticationToken' |
| autoStorage | 與自動記憶體帳戶相關的屬性。 | AutoStorageBasePropertiesOrAutoStorageProperties |
| 加密 | 設定客戶數據在 Batch 帳戶內加密的方式。 根據預設，帳戶會使用Microsoft受控密鑰來加密。 如需其他控制，可以改用客戶管理的密鑰。 | EncryptionProperties |
| keyVaultReference | 與 Batch 帳戶相關聯的 Azure 金鑰保存庫參考。 | KeyVaultReference |
| networkProfile | 只有在啟用 publicNetworkAccess 時，網路配置檔才會生效。 | NetworkProfile |
| poolAllocationMode | 集區配置模式也會影響用戶端如何向 Batch 服務 API 進行驗證。 如果模式為 BatchService，用戶端可以使用存取金鑰或Microsoft Entra 識別碼進行驗證。 如果模式為 UserSubscription，客戶端必須使用Microsoft Entra ID。 預設值為 BatchService。 | 'BatchService' 'UserSubscription' |
| publicNetworkAccess | 如果未指定，預設值為 'enabled'。 | 'Disabled' 'Enabled' |
AutoStorageBasePropertiesOrAutoStorageProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| authenticationMode | Batch 服務將用來管理自動記憶體帳戶的驗證模式。 | 'BatchAccountManagedIdentity' 'StorageKeys' |
| nodeIdentityReference | 此處參考的身分識別必須指派給具有需要存取自動記憶體之計算節點的集區。 | ComputeNodeIdentityReference |
| storageAccountId | 要用於自動記憶體帳戶之記憶體帳戶的記憶體帳戶的資源識別碼。 | 字串 （必要） |
ComputeNodeIdentityReference
| 名字 | 描述 | 價值 |
|---|---|---|
| resourceId | 使用者指派身分識別的 ARM 資源識別碼。 | 字串 |
EncryptionProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| keySource | 金鑰來源的類型。 | 'Microsoft.Batch' 'Microsoft.KeyVault' |
| keyVaultProperties | 使用 Microsoft.KeyVault 時的其他詳細數據 | KeyVaultProperties |
KeyVaultProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| keyIdentifier | 具有或不含版本之秘密的完整路徑。 範例 https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053。 或 https://mykeyvault.vault.azure.net/keys/testkey。 若要可供使用，必須符合下列必要條件：Batch 帳戶具有系統指派的身分識別 帳戶身分識別已獲得金鑰/取得、金鑰/解除包裝和密鑰/包裝許可權 KeyVault 已啟用虛刪除和清除保護 |
字串 |
KeyVaultReference
| 名字 | 描述 | 價值 |
|---|---|---|
| id | 與 Batch 帳戶相關聯的 Azure 金鑰保存庫資源識別碼。 | 字串 （必要） |
| url | 與 Batch 帳戶相關聯的 Azure 金鑰保存庫 URL。 | 字串 （必要） |
NetworkProfile
| 名字 | 描述 | 價值 |
|---|---|---|
| accountAccess | batchAccount 端點的網路存取配置檔（Batch 帳戶數據平面 API）。 | EndpointAccessProfile |
| nodeManagementAccess | nodeManagement 端點的網路存取配置檔（Batch 服務管理 Batch 集區的計算節點）。 | EndpointAccessProfile |
EndpointAccessProfile
| 名字 | 描述 | 價值 |
|---|---|---|
| defaultAction | 端點存取的預設動作。 只有在啟用 publicNetworkAccess 時才適用。 | 'Allow' '拒絕' （必要） |
| ipRules | 篩選用戶端 IP 位址的 IP 範圍數位。 | IPRule[] |
IPRule
| 名字 | 描述 | 價值 |
|---|---|---|
| 行動 | 比對用戶端IP位址時的動作。 | '允許' （必要） |
| 價值 | IPv4 位址或 CIDR 格式的 IPv4 位址範圍。 | 字串 （必要） |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
|
沒有公用IP位址的 Azure Batch 集區
|
此範本會建立 Azure Batch 簡化的節點通訊集區，而不需要公用 IP 位址。 |
|
使用範本建立 Batch 帳戶
|
此範本會建立 Batch 帳戶和記憶體帳戶。 |
Terraform （AzAPI 提供者） 資源定義
batchAccounts 資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Batch/batchAccounts 資源，請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Batch/batchAccounts@2023-11-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
allowedAuthenticationModes = [
"string"
]
autoStorage = {
authenticationMode = "string"
nodeIdentityReference = {
resourceId = "string"
}
storageAccountId = "string"
}
encryption = {
keySource = "string"
keyVaultProperties = {
keyIdentifier = "string"
}
}
keyVaultReference = {
id = "string"
url = "string"
}
networkProfile = {
accountAccess = {
defaultAction = "string"
ipRules = [
{
action = "Allow"
value = "string"
}
]
}
nodeManagementAccess = {
defaultAction = "string"
ipRules = [
{
action = "Allow"
value = "string"
}
]
}
}
poolAllocationMode = "string"
publicNetworkAccess = "string"
}
})
}
屬性值
batchAccounts
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 資源類型 | “Microsoft.Batch/batchAccounts@2023-11-01” |
| 名字 | 資源名稱 | 字串 （必要） 字元限制：3-24 合法字元： 小寫字母和數位。 |
| 位置 | 要在其中建立帳戶的區域。 | 字串 （必要） |
| parent_id | 若要部署至資源群組，請使用該資源群組的標識碼。 | 字串 （必要） |
| 標籤 | 與帳戶相關聯的使用者指定標記。 | 標記名稱和值的字典。 |
| 身份 | Batch 帳戶的身分識別。 | BatchAccountIdentity |
| 性能 | Batch 帳戶的屬性。 | BatchAccountCreatePropertiesOrBatchAccountProperties |
BatchAccountIdentity
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 用於 Batch 帳戶的身分識別類型。 | “SystemAssigned” “UserAssigned” （必要） |
| identity_ids | 與 Batch 帳戶相關聯的使用者身分識別清單。 | 使用者身分識別標識碼的陣列。 |
BatchAccountIdentityUserAssignedIdentities
| 名字 | 描述 | 價值 |
|---|---|---|
| {自定義屬性} | UserAssignedIdentities |
UserAssignedIdentities
此物件不包含在部署期間設定的任何屬性。 所有屬性都是 ReadOnly。
BatchAccountCreatePropertiesOrBatchAccountProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| allowedAuthenticationModes | Batch 帳戶允許的驗證模式清單，可用來向數據平面進行驗證。 這不會影響控制平面的驗證。 | 包含任何的字串數組： “AAD” “SharedKey” “TaskAuthenticationToken” |
| autoStorage | 與自動記憶體帳戶相關的屬性。 | AutoStorageBasePropertiesOrAutoStorageProperties |
| 加密 | 設定客戶數據在 Batch 帳戶內加密的方式。 根據預設，帳戶會使用Microsoft受控密鑰來加密。 如需其他控制，可以改用客戶管理的密鑰。 | EncryptionProperties |
| keyVaultReference | 與 Batch 帳戶相關聯的 Azure 金鑰保存庫參考。 | KeyVaultReference |
| networkProfile | 只有在啟用 publicNetworkAccess 時，網路配置檔才會生效。 | NetworkProfile |
| poolAllocationMode | 集區配置模式也會影響用戶端如何向 Batch 服務 API 進行驗證。 如果模式為 BatchService，用戶端可以使用存取金鑰或Microsoft Entra 識別碼進行驗證。 如果模式為 UserSubscription，客戶端必須使用Microsoft Entra ID。 預設值為 BatchService。 | “BatchService” “UserSubscription” |
| publicNetworkAccess | 如果未指定，預設值為 'enabled'。 | “Disabled” “Enabled” |
AutoStorageBasePropertiesOrAutoStorageProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| authenticationMode | Batch 服務將用來管理自動記憶體帳戶的驗證模式。 | “BatchAccountManagedIdentity” “StorageKeys” |
| nodeIdentityReference | 此處參考的身分識別必須指派給具有需要存取自動記憶體之計算節點的集區。 | ComputeNodeIdentityReference |
| storageAccountId | 要用於自動記憶體帳戶之記憶體帳戶的記憶體帳戶的資源識別碼。 | 字串 （必要） |
ComputeNodeIdentityReference
| 名字 | 描述 | 價值 |
|---|---|---|
| resourceId | 使用者指派身分識別的 ARM 資源識別碼。 | 字串 |
EncryptionProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| keySource | 金鑰來源的類型。 | “Microsoft.Batch” “Microsoft.KeyVault” |
| keyVaultProperties | 使用 Microsoft.KeyVault 時的其他詳細數據 | KeyVaultProperties |
KeyVaultProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| keyIdentifier | 具有或不含版本之秘密的完整路徑。 範例 https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053。 或 https://mykeyvault.vault.azure.net/keys/testkey。 若要可供使用，必須符合下列必要條件：Batch 帳戶具有系統指派的身分識別 帳戶身分識別已獲得金鑰/取得、金鑰/解除包裝和密鑰/包裝許可權 KeyVault 已啟用虛刪除和清除保護 |
字串 |
KeyVaultReference
| 名字 | 描述 | 價值 |
|---|---|---|
| id | 與 Batch 帳戶相關聯的 Azure 金鑰保存庫資源識別碼。 | 字串 （必要） |
| url | 與 Batch 帳戶相關聯的 Azure 金鑰保存庫 URL。 | 字串 （必要） |
NetworkProfile
| 名字 | 描述 | 價值 |
|---|---|---|
| accountAccess | batchAccount 端點的網路存取配置檔（Batch 帳戶數據平面 API）。 | EndpointAccessProfile |
| nodeManagementAccess | nodeManagement 端點的網路存取配置檔（Batch 服務管理 Batch 集區的計算節點）。 | EndpointAccessProfile |
EndpointAccessProfile
| 名字 | 描述 | 價值 |
|---|---|---|
| defaultAction | 端點存取的預設動作。 只有在啟用 publicNetworkAccess 時才適用。 | “Allow” “拒絕” （必要） |
| ipRules | 篩選用戶端 IP 位址的 IP 範圍數位。 | IPRule[] |
IPRule
| 名字 | 描述 | 價值 |
|---|---|---|
| 行動 | 比對用戶端IP位址時的動作。 | “允許” （必要） |
| 價值 | IPv4 位址或 CIDR 格式的 IPv4 位址範圍。 | 字串 （必要） |