Microsoft.Batch batchAccounts

  • [アーティクル]

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

名前 説明 値
name リソース名 string (必須)

文字制限: 3 から 24

有効な文字:
小文字と数字。
location アカウントを作成するリージョン。 string (必須)
tags アカウントに関連付けられているユーザー指定のタグ。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
identity Batch アカウントの ID。 BatchAccountIdentity
properties Batch アカウントのプロパティ。 BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountIdentity

名前 説明 値
type Batch アカウントに使用される ID の種類。 'None'
'SystemAssigned'
'UserAssigned' (必須)
userAssignedIdentities Batch アカウントに関連付けられているユーザー ID の一覧。 BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

名前 説明 値
{カスタマイズされたプロパティ} UserAssignedIdentities

UserAssignedIdentities

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

BatchAccountCreatePropertiesOrBatchAccountProperties

名前 説明 値
allowedAuthenticationModes データ プレーンで認証するために使用できる Batch アカウントで許可される認証モードの一覧。 コントロール プレーンでの認証には影響しません。 次のいずれかを含む文字列配列:
'AAD'
'SharedKey'
'TaskAuthenticationToken'
autoStorage 自動ストレージ アカウントに関連するプロパティ。 AutoStorageBasePropertiesOrAutoStorageProperties
暗号化 (encryption) Batch アカウント内で顧客データを暗号化する方法を構成します。 既定では、アカウントは Microsoft マネージド キーを使用して暗号化されます。 追加の制御のために、代わりにカスタマー マネージド キーを使用できます。 EncryptionProperties
keyVaultReference Batch アカウントに関連付けられている Azure キー コンテナーへの参照。 KeyVaultReference
networkProfile ネットワーク プロファイルは、publicNetworkAccess が有効になっている場合にのみ有効になります。 NetworkProfile
poolAllocationMode プール割り当てモードは、クライアントが Batch Service API に対して認証する方法にも影響します。 モードが BatchService の場合、クライアントはアクセス キーまたはMicrosoft Entra IDを使用して認証できます。 モードが UserSubscription の場合、クライアントは Microsoft Entra IDを使用する必要があります。 既定値は BatchService です。 'BatchService'
'UserSubscription'
publicNetworkAccess 指定しない場合、既定値は 'enabled' です。 'Disabled'
'Enabled'

AutoStorageBasePropertiesOrAutoStorageProperties

名前 説明 値
authenticationMode Batch サービスが自動ストレージ アカウントの管理に使用する認証モード。 'BatchAccountManagedIdentity'
'StorageKeys'
nodeIdentityReference ここで参照される ID は、自動ストレージへのアクセスを必要とするコンピューティング ノードを持つプールに割り当てる必要があります。 ComputeNodeIdentityReference
storageAccountId 自動ストレージ アカウントに使用するストレージ アカウントのリソース ID。 string (必須)

ComputeNodeIdentityReference

名前 説明 値
resourceId ユーザー割り当て ID の ARM リソース ID。 string

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 アカウントにシステム割り当て ID がある
アカウント ID には、キー/取得、キー/ラップ解除、キー/ラップの各アクセス許可が付与されています
KeyVault で論理的な削除と消去の保護が有効になっている
 string

KeyVaultReference

名前 説明 値
id Batch アカウントに関連付けられている Azure キー コンテナーのリソース ID。 string (必須)
url Batch アカウントに関連付けられている Azure キー コンテナーの URL。 string (必須)

NetworkProfile

名前 説明 値
accountAccess batchAccount エンドポイントのネットワーク アクセス プロファイル (Batch アカウント データ プレーン API)。 EndpointAccessProfile
nodeManagementAccess nodeManagement エンドポイントのネットワーク アクセス プロファイル (Batch プールのコンピューティング ノードを管理する Batch サービス)。 EndpointAccessProfile

EndpointAccessProfile

名前 説明 値
defaultAction エンドポイント アクセスの既定のアクション。 publicNetworkAccess が有効になっている場合にのみ適用されます。 'Allow'
'Deny' (必須)
ipRules クライアント IP アドレスをフィルター処理する IP 範囲の配列。 IPRule[]

IPRule

名前 説明 値
action クライアント IP アドレスが一致した場合のアクション。 'Allow' (必須)
value IPv4 アドレス、または CIDR 形式の IPv4 アドレス範囲。 string (必須)

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
パブリック IP アドレスのないAzure Batch プール

Azure にデプロイする		 このテンプレートでは、パブリック IP アドレスAzure Batch含まない簡略化されたノード通信プールが作成されます。
テンプレートを使用して Batch アカウントを作成する

Azure にデプロイする		 このテンプレートでは、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

名前 説明 値
type リソースの種類 'Microsoft.Batch/batchAccounts'
apiVersion リソース API のバージョン '2023-11-01'
name リソース名 string (必須)

文字制限: 3 から 24

有効な文字:
小文字と数字。
location アカウントを作成するリージョン。 string (必須)
tags アカウントに関連付けられているユーザー指定のタグ。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
identity Batch アカウントの ID。 BatchAccountIdentity
properties Batch アカウントのプロパティ。 BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountIdentity

名前 説明 値
type Batch アカウントに使用される ID の種類。 'None'
'SystemAssigned'
'UserAssigned' (必須)
userAssignedIdentities Batch アカウントに関連付けられているユーザー ID の一覧。 BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

名前 説明 値
{カスタマイズされたプロパティ} UserAssignedIdentities

UserAssignedIdentities

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

BatchAccountCreatePropertiesOrBatchAccountProperties

名前 説明 値
allowedAuthenticationModes データ プレーンで認証するために使用できる Batch アカウントで許可される認証モードの一覧。 コントロール プレーンでの認証には影響しません。 次のいずれかを含む文字列配列:
'AAD'
'SharedKey'
'TaskAuthenticationToken'
autoStorage 自動ストレージ アカウントに関連するプロパティ。 AutoStorageBasePropertiesOrAutoStorageProperties
暗号化 (encryption) Batch アカウント内で顧客データを暗号化する方法を構成します。 既定では、アカウントは Microsoft マネージド キーを使用して暗号化されます。 追加の制御のために、代わりにカスタマー マネージド キーを使用できます。 EncryptionProperties
keyVaultReference Batch アカウントに関連付けられている Azure キー コンテナーへの参照。 KeyVaultReference
networkProfile ネットワーク プロファイルは、publicNetworkAccess が有効になっている場合にのみ有効になります。 NetworkProfile
poolAllocationMode プール割り当てモードは、クライアントが Batch Service API に対して認証する方法にも影響します。 モードが BatchService の場合、クライアントはアクセス キーまたはMicrosoft Entra IDを使用して認証できます。 モードが UserSubscription の場合、クライアントは Microsoft Entra IDを使用する必要があります。 既定値は BatchService です。 'BatchService'
'UserSubscription'
publicNetworkAccess 指定しない場合、既定値は 'enabled' です。 'Disabled'
'Enabled'

AutoStorageBasePropertiesOrAutoStorageProperties

名前 説明 値
authenticationMode Batch サービスが自動ストレージ アカウントの管理に使用する認証モード。 'BatchAccountManagedIdentity'
'StorageKeys'
nodeIdentityReference ここで参照される ID は、自動ストレージへのアクセスを必要とするコンピューティング ノードを持つプールに割り当てる必要があります。 ComputeNodeIdentityReference
storageAccountId 自動ストレージ アカウントに使用するストレージ アカウントのリソース ID。 string (必須)

ComputeNodeIdentityReference

名前 説明 値
resourceId ユーザー割り当て ID の ARM リソース ID。 string

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 アカウントにシステム割り当て ID がある
アカウント ID には、キー/取得、キー/ラップ解除、キー/ラップのアクセス許可が付与されています
KeyVault で論理的な削除と消去の保護が有効になっている
 string

KeyVaultReference

名前 説明 値
id Batch アカウントに関連付けられている Azure キー コンテナーのリソース ID。 string (必須)
url Batch アカウントに関連付けられている Azure キー コンテナーの URL。 string (必須)

NetworkProfile

名前 説明 値
accountAccess batchAccount エンドポイントのネットワーク アクセス プロファイル (Batch アカウント データ プレーン API)。 EndpointAccessProfile
nodeManagementAccess nodeManagement エンドポイントのネットワーク アクセス プロファイル (Batch プールのコンピューティング ノードを管理する Batch サービス)。 EndpointAccessProfile

EndpointAccessProfile

名前 説明 値
defaultAction エンドポイント アクセスの既定のアクション。 publicNetworkAccess が有効になっている場合にのみ適用されます。 'Allow'
'Deny' (必須)
ipRules クライアント IP アドレスをフィルター処理する IP 範囲の配列。 IPRule[]

IPRule

名前 説明 値
action クライアント IP アドレスが一致したときのアクション。 'Allow' (必須)
value IPv4 アドレス、または CIDR 形式の IPv4 アドレス範囲。 string (必須)

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
パブリック 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@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

名前 説明 値
type リソースの種類 "Microsoft.Batch/batchAccounts@2023-11-01"
name リソース名 string (必須)

文字数制限: 3 から 24

有効な文字:
小文字と数字。
location アカウントを作成するリージョン。 string (必須)
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
tags アカウントに関連付けられているユーザー指定のタグ。 タグ名と値のディクショナリ。
identity Batch アカウントの ID。 BatchAccountIdentity
properties Batch アカウントのプロパティ。 BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountIdentity

名前 説明 値
type Batch アカウントに使用される ID の種類。 "SystemAssigned"
"UserAssigned" (必須)
identity_ids Batch アカウントに関連付けられているユーザー ID の一覧。 ユーザー ID ID の配列。

BatchAccountIdentityUserAssignedIdentities

名前 説明 値
{カスタマイズされたプロパティ} UserAssignedIdentities

UserAssignedIdentities

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

BatchAccountCreatePropertiesOrBatchAccountProperties

名前 説明 値
allowedAuthenticationModes データ プレーンでの認証に使用できる Batch アカウントで許可される認証モードの一覧。 これは、コントロール プレーンでの認証には影響しません。 次のいずれかを含む文字列配列:
"AAD"
"SharedKey"
"TaskAuthenticationToken"
autoStorage 自動ストレージ アカウントに関連するプロパティ。 AutoStorageBasePropertiesOrAutoStorageProperties
暗号化 (encryption) Batch アカウント内で顧客データを暗号化する方法を構成します。 既定では、アカウントは Microsoft マネージド キーを使用して暗号化されます。 追加の制御のために、代わりにカスタマー マネージド キーを使用できます。 EncryptionProperties
keyVaultReference Batch アカウントに関連付けられている Azure キー コンテナーへの参照。 KeyVaultReference
networkProfile ネットワーク プロファイルは、publicNetworkAccess が有効になっている場合にのみ有効になります。 NetworkProfile
poolAllocationMode プール割り当てモードは、クライアントが Batch Service API に対して認証する方法にも影響します。 モードが BatchService の場合、クライアントはアクセス キーまたはMicrosoft Entra IDを使用して認証できます。 モードが UserSubscription の場合、クライアントは Microsoft Entra IDを使用する必要があります。 既定値は BatchService です。 "BatchService"
"UserSubscription"
publicNetworkAccess 指定しない場合、既定値は 'enabled' です。 "無効"
"有効"

AutoStorageBasePropertiesOrAutoStorageProperties

名前 説明 値
authenticationMode Batch サービスが自動ストレージ アカウントの管理に使用する認証モード。 "BatchAccountManagedIdentity"
"StorageKeys"
nodeIdentityReference ここで参照される ID は、自動ストレージへのアクセスを必要とするコンピューティング ノードを持つプールに割り当てる必要があります。 ComputeNodeIdentityReference
storageAccountId 自動ストレージ アカウントに使用するストレージ アカウントのリソース ID。 string (必須)

ComputeNodeIdentityReference

名前 説明 値
resourceId ユーザー割り当て ID の ARM リソース ID。 string

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 アカウントにシステム割り当て ID がある
アカウント ID には、キー/取得、キー/ラップ解除、キー/ラップのアクセス許可が付与されています
KeyVault で論理的な削除と消去の保護が有効になっている
 string

KeyVaultReference

名前 説明 値
id Batch アカウントに関連付けられている Azure キー コンテナーのリソース ID。 string (必須)
url Batch アカウントに関連付けられている Azure キー コンテナーの URL。 string (必須)

NetworkProfile

名前 説明 値
accountAccess batchAccount エンドポイントのネットワーク アクセス プロファイル (Batch アカウント データ プレーン API)。 EndpointAccessProfile
nodeManagementAccess nodeManagement エンドポイントのネットワーク アクセス プロファイル (Batch プールのコンピューティング ノードを管理する Batch サービス)。 EndpointAccessProfile

EndpointAccessProfile

名前 説明 値
defaultAction エンドポイント アクセスの既定のアクション。 publicNetworkAccess が有効になっている場合にのみ適用されます。 "許可"
"Deny" (必須)
ipRules クライアント IP アドレスをフィルター処理する IP 範囲の配列。 IPRule[]

IPRule

名前 説明 値
action クライアント IP アドレスが一致したときのアクション。 "許可" (必須)
value IPv4 アドレス、または CIDR 形式の IPv4 アドレス範囲。 string (必須)