通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.Batch BatchAccounts 2020-09-01

  • 项目

Bicep 资源定义

可以使用目标操作部署 batchAccounts 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Batch/batchAccounts 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Batch/batchAccounts@2020-09-01' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    autoStorage: {
      storageAccountId: 'string'
    }
    encryption: {
      keySource: 'string'
      keyVaultProperties: {
        keyIdentifier: 'string'
      }
    }
    keyVaultReference: {
      id: 'string'
      url: 'string'
    }
    poolAllocationMode: 'string'
    publicNetworkAccess: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

AutoStorageBasePropertiesOrAutoStorageProperties

名字 描述 价值
storageAccountId 要用于自动存储帐户的存储帐户的资源 ID。 string （必需）

BatchAccountCreateParametersTags

名字 描述 价值

BatchAccountCreatePropertiesOrBatchAccountProperties

名字 描述 价值
autoStorage 与自动存储帐户相关的属性。 AutoStorageBasePropertiesOrAutoStorageProperties
加密 配置客户数据在 Batch 帐户内加密的方式。 默认情况下，帐户使用Microsoft托管密钥进行加密。 对于其他控制，可以改用客户管理的密钥。 EncryptionProperties
keyVaultReference 对与 Batch 帐户关联的 Azure 密钥保管库的引用。 KeyVaultReference
poolAllocationMode 池分配模式还影响客户端对 Batch 服务 API 进行身份验证的方式。 如果模式为 BatchService，客户端可以使用访问密钥或 Azure Active Directory 进行身份验证。 如果模式为 UserSubscription，客户端必须使用 Azure Active Directory。 默认值为 BatchService。 “BatchService”
“UserSubscription”
publicNetworkAccess 如果未指定，则默认值为“enabled”。 “Disabled”
“Enabled”

BatchAccountIdentity

名字 描述 价值
类型 用于 Batch 帐户的标识类型。 “None”
“SystemAssigned”（必需）

EncryptionProperties

名字 描述 价值
keySource 密钥源的类型。 “Microsoft.Batch”
“Microsoft.KeyVault”
keyVaultProperties 使用 Microsoft.KeyVault 时的更多详细信息 KeyVaultProperties

KeyVaultProperties

名字 描述 价值
keyIdentifier 版本控制机密的完整路径。 示例 https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053。 若要可用，必须满足以下先决条件：

Batch 帐户具有系统分配的标识
帐户标识已被授予密钥/获取、密钥/解包和密钥/包装权限
KeyVault 已启用软删除和清除保护		 字符串

KeyVaultReference

名字 描述 价值
id 与 Batch 帐户关联的 Azure 密钥保管库的资源 ID。 string （必需）
url 与 Batch 帐户关联的 Azure 密钥保管库的 URL。 string （必需）

Microsoft.Batch/batchAccounts

名字 描述 价值
身份 Batch 帐户的标识。 BatchAccountIdentity
位置 在其中创建帐户的区域。 string （必需）
名字 资源名称 字符串

约束：
最小长度 = 3
最大长度 = 3
模式 = ^[a-z0-9]+$ （必需）
性能 Batch 帐户的属性。 BatchAccountCreatePropertiesOrBatchAccountProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件 描述
不带公共 IP 地址的 Azure Batch 池 此模板创建没有公共 IP 地址的 Azure Batch 简化节点通信池。
使用模板创建 Batch 帐户 此模板创建 Batch 帐户和存储帐户。

ARM 模板资源定义

可以使用目标操作部署 batchAccounts 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Batch/batchAccounts 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Batch/batchAccounts",
  "apiVersion": "2020-09-01",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "autoStorage": {
      "storageAccountId": "string"
    },
    "encryption": {
      "keySource": "string",
      "keyVaultProperties": {
        "keyIdentifier": "string"
      }
    },
    "keyVaultReference": {
      "id": "string",
      "url": "string"
    },
    "poolAllocationMode": "string",
    "publicNetworkAccess": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

AutoStorageBasePropertiesOrAutoStorageProperties

名字 描述 价值
storageAccountId 要用于自动存储帐户的存储帐户的资源 ID。 string （必需）

BatchAccountCreateParametersTags

名字 描述 价值

BatchAccountCreatePropertiesOrBatchAccountProperties

名字 描述 价值
autoStorage 与自动存储帐户相关的属性。 AutoStorageBasePropertiesOrAutoStorageProperties
加密 配置客户数据在 Batch 帐户内加密的方式。 默认情况下，帐户使用Microsoft托管密钥进行加密。 对于其他控制，可以改用客户管理的密钥。 EncryptionProperties
keyVaultReference 对与 Batch 帐户关联的 Azure 密钥保管库的引用。 KeyVaultReference
poolAllocationMode 池分配模式还影响客户端对 Batch 服务 API 进行身份验证的方式。 如果模式为 BatchService，客户端可以使用访问密钥或 Azure Active Directory 进行身份验证。 如果模式为 UserSubscription，客户端必须使用 Azure Active Directory。 默认值为 BatchService。 “BatchService”
“UserSubscription”
publicNetworkAccess 如果未指定，则默认值为“enabled”。 “Disabled”
“Enabled”

BatchAccountIdentity

名字 描述 价值
类型 用于 Batch 帐户的标识类型。 “None”
“SystemAssigned”（必需）

EncryptionProperties

名字 描述 价值
keySource 密钥源的类型。 “Microsoft.Batch”
“Microsoft.KeyVault”
keyVaultProperties 使用 Microsoft.KeyVault 时的更多详细信息 KeyVaultProperties

KeyVaultProperties

名字 描述 价值
keyIdentifier 版本控制机密的完整路径。 示例 https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053。 若要可用，必须满足以下先决条件：

Batch 帐户具有系统分配的标识
帐户标识已被授予密钥/获取、密钥/解包和密钥/包装权限
KeyVault 已启用软删除和清除保护		 字符串

KeyVaultReference

名字 描述 价值
id 与 Batch 帐户关联的 Azure 密钥保管库的资源 ID。 string （必需）
url 与 Batch 帐户关联的 Azure 密钥保管库的 URL。 string （必需）

Microsoft.Batch/batchAccounts

名字 描述 价值
apiVersion API 版本 '2020-09-01'
身份 Batch 帐户的标识。 BatchAccountIdentity
位置 在其中创建帐户的区域。 string （必需）
名字 资源名称 字符串

约束：
最小长度 = 3
最大长度 = 3
模式 = ^[a-z0-9]+$ （必需）
性能 Batch 帐户的属性。 BatchAccountCreatePropertiesOrBatchAccountProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Batch/batchAccounts”

快速入门模板

以下快速入门模板部署此资源类型。

模板 描述
不带公共 IP 地址的 Azure Batch 池

部署到 Azure 		此模板创建没有公共 IP 地址的 Azure Batch 简化节点通信池。
使用模板创建 Batch 帐户

部署到 Azure 		此模板创建 Batch 帐户和存储帐户。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 batchAccounts 资源类型：

  • 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Batch/batchAccounts 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Batch/batchAccounts@2020-09-01"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      autoStorage = {
        storageAccountId = "string"
      }
      encryption = {
        keySource = "string"
        keyVaultProperties = {
          keyIdentifier = "string"
        }
      }
      keyVaultReference = {
        id = "string"
        url = "string"
      }
      poolAllocationMode = "string"
      publicNetworkAccess = "string"
    }
  })
}

属性值

AutoStorageBasePropertiesOrAutoStorageProperties

名字 描述 价值
storageAccountId 要用于自动存储帐户的存储帐户的资源 ID。 string （必需）

BatchAccountCreateParametersTags

名字 描述 价值

BatchAccountCreatePropertiesOrBatchAccountProperties

名字 描述 价值
autoStorage 与自动存储帐户相关的属性。 AutoStorageBasePropertiesOrAutoStorageProperties
加密 配置客户数据在 Batch 帐户内加密的方式。 默认情况下，帐户使用Microsoft托管密钥进行加密。 对于其他控制，可以改用客户管理的密钥。 EncryptionProperties
keyVaultReference 对与 Batch 帐户关联的 Azure 密钥保管库的引用。 KeyVaultReference
poolAllocationMode 池分配模式还影响客户端对 Batch 服务 API 进行身份验证的方式。 如果模式为 BatchService，客户端可以使用访问密钥或 Azure Active Directory 进行身份验证。 如果模式为 UserSubscription，客户端必须使用 Azure Active Directory。 默认值为 BatchService。 “BatchService”
“UserSubscription”
publicNetworkAccess 如果未指定，则默认值为“enabled”。 “Disabled”
“Enabled”

BatchAccountIdentity

名字 描述 价值
类型 用于 Batch 帐户的标识类型。 “None”
“SystemAssigned”（必需）

EncryptionProperties

名字 描述 价值
keySource 密钥源的类型。 “Microsoft.Batch”
“Microsoft.KeyVault”
keyVaultProperties 使用 Microsoft.KeyVault 时的更多详细信息 KeyVaultProperties

KeyVaultProperties

名字 描述 价值
keyIdentifier 版本控制机密的完整路径。 示例 https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053。 若要可用，必须满足以下先决条件：

Batch 帐户具有系统分配的标识
帐户标识已被授予密钥/获取、密钥/解包和密钥/包装权限
KeyVault 已启用软删除和清除保护		 字符串

KeyVaultReference

名字 描述 价值
id 与 Batch 帐户关联的 Azure 密钥保管库的资源 ID。 string （必需）
url 与 Batch 帐户关联的 Azure 密钥保管库的 URL。 string （必需）

Microsoft.Batch/batchAccounts

名字 描述 价值
身份 Batch 帐户的标识。 BatchAccountIdentity
位置 在其中创建帐户的区域。 string （必需）
名字 资源名称 字符串

约束：
最小长度 = 3
最大长度 = 3
模式 = ^[a-z0-9]+$ （必需）
性能 Batch 帐户的属性。 BatchAccountCreatePropertiesOrBatchAccountProperties
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Batch/batchAccounts@2020-09-01”