Job Schedule - List

指定したアカウントのすべてのジョブ スケジュールを一覧表示します。

GET {batchUrl}/jobschedules?api-version=2022-01-01.15.0
GET {batchUrl}/jobschedules?$filter={$filter}&$select={$select}&$expand={$expand}&maxresults={maxresults}&timeout={timeout}&api-version=2022-01-01.15.0

URI パラメーター

Name In Required Type Description
batchUrl
path True
  • string

すべてのAzure Batch サービス要求のベース URL。

api-version
query True
  • string

クライアント API のバージョン。

$expand
query
  • string

OData $expand句。

$filter
query
  • string

OData $filter句。 このフィルターの構築の詳細については、次を参照してください https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules

$select
query
  • string

OData $select句。

maxresults
query
  • integer
int32

応答で返される項目の最大数。 最大 1,000 個のジョブ スケジュールを返すことができます。

timeout
query
  • integer
int32

サーバーが要求の処理に費やすことができる最大時間 (秒単位)。 既定値は 30 秒です。

要求ヘッダー

Media Types: "application/json; odata=minimalmetadata"

Name Required Type Description
client-request-id
  • string
uuid

呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (例: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)。

return-client-request-id
  • boolean

サーバーが応答で client-request-id を返す必要があるかどうか。

ocp-date
  • string
date-time-rfc1123

要求が発行された時刻。 クライアント ライブラリは通常、これを現在のシステム クロック時刻に設定します。REST API を直接呼び出す場合は、明示的に設定します。

応答

Name Type Description
200 OK

ジョブ スケジュールの一覧を含む応答。

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
Other Status Codes

Batch サービスからのエラー。

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryする

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザー アカウントの借用

Authorization

Type: apiKey
In: header

JobSchedule list

Sample Request

GET account.region.batch.azure.com/jobschedules?api-version=2022-01-01.15.0


Sample Response

{
  "value": [
    {
      "id": "jobSchedule1",
      "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule1",
      "eTag": "0x8D40FFD2E10996A",
      "lastModified": "2016-11-18T21:52:24.0064874Z",
      "creationTime": "2016-11-18T21:52:22.5431125Z",
      "state": "active",
      "stateTransitionTime": "2016-11-18T21:52:24.0064874Z",
      "previousState": "disabled",
      "previousStateTransitionTime": "2016-11-18T21:52:23.6471782Z",
      "jobSpecification": {
        "priority": 0,
        "maxParallelTasks": -1,
        "allowTaskPreemption": false,
        "usesTaskDependencies": false,
        "onAllTasksComplete": "noaction",
        "onTaskFailure": "noaction",
        "constraints": {
          "maxWallClockTime": "P10675199DT2H48M5.4775807S",
          "maxTaskRetryCount": 0
        },
        "poolInfo": {
          "poolId": "poolId"
        }
      },
      "executionInfo": {
        "recentJob": {
          "url": "https://account.region.batch.azure.com/jobs/jobSchedule1:job-1",
          "id": "jobSchedule1:job-1"
        }
      }
    },
    {
      "id": "jobSchedule2",
      "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule2",
      "eTag": "0x8D40FFCFF760B51",
      "lastModified": "2016-11-18T21:51:05.8184017Z",
      "creationTime": "2016-11-18T21:51:05.8184017Z",
      "state": "active",
      "stateTransitionTime": "2016-11-18T21:51:05.8184017Z",
      "schedule": {
        "doNotRunUntil": "2020-01-01T12:30:00Z"
      },
      "jobSpecification": {
        "priority": 0,
        "maxParallelTasks": -1,
        "usesTaskDependencies": false,
        "onAllTasksComplete": "noaction",
        "onTaskFailure": "noaction",
        "constraints": {
          "maxWallClockTime": "P10675199DT2H48M5.4775807S",
          "maxTaskRetryCount": 0
        },
        "poolInfo": {
          "poolId": "testPool2"
        }
      },
      "executionInfo": {
        "nextRunTime": "2020-01-01T12:30:00Z"
      }
    }
  ]
}

定義

ApplicationPackageReference

コンピューティング ノードにデプロイするパッケージへの参照。

AuthenticationTokenSettings

タスクが Batch サービス操作の実行に使用できる認証トークンの設定。

AutoPoolSpecification

一時 '自動プール' の特性を指定します。 Batch サービスは、ジョブの送信時にこの自動プールを作成します。

AutoUserScope

自動ユーザーのスコープ

AutoUserSpecification

Batch サービスでタスクを実行する自動ユーザーのパラメーターを指定します。

AzureBlobFileSystemConfiguration

Blobfuse を使用してAzure Storage コンテナーに接続するために使用される情報。

AzureFileShareConfiguration

Azure Fileshare への接続に使用される情報。

BatchError

Azure Batch サービスから受信したエラー応答。

BatchErrorDetail

Azure Batchエラー応答に含まれる追加情報の項目。

CachingType

ディスクに対して有効にするキャッシュの種類。

CertificateReference

プール内のコンピューティング ノードにインストールする証明書への参照。

CertificateStoreLocation

証明書をインストールするコンピューティング ノード上の証明書ストアの場所。

CIFSMountConfiguration

CIFS ファイル システムへの接続に使用される情報。

CloudJobSchedule

ジョブを実行するタイミングと、各ジョブの作成に使用する仕様を指定して、定期的なジョブを許可するジョブ スケジュール。

CloudJobScheduleListResult

アカウントにジョブ スケジュールを一覧表示した結果。

CloudServiceConfiguration

Azure Cloud Services プラットフォームに基づくプール内のコンピューティング ノードの構成。

ComputeNodeFillType

プール内のコンピューティング ノード間でタスクを分散する方法。

ComputeNodeIdentityReference

コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。

ContainerConfiguration

コンテナーが有効なプールの構成。

ContainerRegistry

プライベート コンテナー レジストリ。

ContainerType

使用するコンテナー テクノロジ。

ContainerWorkingDirectory

コンテナータスク作業ディレクトリの場所。

DataDisk

設定プール内のコンピューティング ノードに関連付けられているデータ ディスクによって使用されます。 添付データ ディスクを含める場合は、それらを使用する VM 内からディスクを マウントおよびフォーマットする必要があります。

DiffDiskPlacement

プール内のすべてのコンピューティング ノード (VM) のオペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。

DiffDiskSettings

コンピューティング ノード (VM) によって使用されるオペレーティング システム ディスクのエフェメラル ディスク 設定を指定します。

DiskEncryptionConfiguration

プール内のコンピューティング ノードに適用されるディスク暗号化構成。 Shared Image Gallery イメージで作成された Linux プールでは、ディスク暗号化の構成はサポートされていません。

DynamicVNetAssignmentScope

動的 vnet 割り当てのスコープ。

ElevationLevel

ユーザーの昇格レベル。

EnvironmentSetting

タスク プロセスに設定する環境変数。

ErrorMessage

Azure Batchエラー応答で受信したエラー メッセージ。

HttpHeader

HTTP ヘッダーの名前と値のペア

ImageReference

Azure Virtual Machines Marketplace イメージまたは Shared Image Gallery イメージへの参照。 Azure Batchによって検証されたすべてのAzure Marketplaceイメージ参照の一覧を取得するには、「サポートされているイメージの一覧表示」操作を参照してください。

InboundEndpointProtocol

エンドポイントのプロトコル。

InboundNATPool

Batch プール内のコンピューティング ノード上の特定のポートに外部からアドレス指定するために使用できる受信 NAT プール。

IPAddressProvisioningType

プールのパブリック IP アドレスのプロビジョニングの種類。

JobConstraints

ジョブの実行制約。

JobManagerTask

ジョブ マネージャー タスクの詳細を指定します。

JobNetworkConfiguration

ジョブのネットワーク構成。

JobPreparationTask

特定のコンピューティング ノード上のジョブのタスクの前に実行するジョブ準備タスク。

JobReleaseTask

ジョブが実行されている任意のコンピューティング ノードでジョブの完了時に実行するジョブ リリース タスク。

JobScheduleExecutionInformation

ジョブ スケジュールで実行されたジョブと実行されるジョブに関する情報が含まれます。

JobScheduleState

ジョブ スケジュールの状態。

JobScheduleStatistics

ジョブ スケジュールのリソース使用状況の統計情報。

JobSpecification

スケジュールに従って作成するジョブの詳細を指定します。

LinuxUserConfiguration

Linux コンピューティング ノードでユーザー アカウントを作成するために使用されるプロパティ。

LoginMode

ユーザーのログイン モード

MetadataItem

Batch サービス リソースに関連付けられている名前と値のペア。

MountConfiguration

各ノードにマウントするファイル システム。

NetworkConfiguration

プールのネットワーク構成。

NetworkSecurityGroupRule

受信エンドポイントに適用するネットワーク セキュリティ グループ規則。

NetworkSecurityGroupRuleAccess

指定した IP アドレス、サブネット範囲、またはタグに対して実行する必要があるアクション。

NFSMountConfiguration

NFS ファイル システムへの接続に使用される情報。

NodePlacementConfiguration

プールのノード配置の構成。

NodePlacementPolicyType

プール内のノードを割り当てる配置ポリシー。

OnAllTasksComplete

ジョブ内のすべてのタスクが完了状態のときに Batch サービスが実行する必要があるアクション。

OnTaskFailure

ジョブ内のタスクが失敗したときに Batch サービスが実行する必要があるアクション。

OSDisk

コンピューティング ノード (VM) のオペレーティング システム ディスクの設定。

OutputFile

Batch サービスがタスク プロセスの実行を完了した後、Azure Batch コンピューティング ノードから別の場所にファイルをアップロードするための仕様。

OutputFileBlobContainerDestination

Azure BLOB ストレージ コンテナー内のファイルアップロード先を指定します。

OutputFileDestination

ファイルのアップロード先。

OutputFileUploadCondition

タスク出力ファイルまたは一連のファイルをアップロードする条件。

OutputFileUploadOptions

アップロードを実行する条件を含む、出力ファイルのアップロード操作に関する詳細。

PoolEndpointConfiguration

プールのエンドポイント構成。

PoolInformation

ジョブをプールに割り当てる方法を指定します。

PoolLifetimeOption

作成された自動プールの最小有効期間と、スケジュール上の複数のジョブをプールに割り当てる方法。

PoolSpecification

新しいプールを作成するための仕様。

PublicIPAddressConfiguration

プールのネットワーク構成のパブリック IP アドレス構成。

RecentJob

ジョブ スケジュールで実行する最新のジョブに関する情報。

ResourceFile

コンピューティング ノードにダウンロードする 1 つのファイルまたは複数のファイル。

Schedule

ジョブが作成されるスケジュール。 すべての時刻は UTC にそれぞれ固定され、夏時間の影響を受けません。

StartTask

ノードがAzure Batch サービスのプールに参加するとき、またはコンピューティング ノードが再起動または再イメージ化されたときに実行されるタスク。

StorageAccountType

データ ディスクの作成に使用するストレージ アカウントの種類。

TaskConstraints

タスクに適用する実行制約。

TaskContainerSettings

タスクのコンテナー設定。

TaskSchedulingPolicy

コンピューティング ノード間でタスクを分散する方法を指定します。

UserAccount

Azure Batch コンピューティング ノードでタスクを実行するために使用するユーザーの作成に使用されるプロパティ。

UserIdentity

タスクを実行するユーザー ID の定義。

VirtualMachineConfiguration

Azure Virtual Machines インフラストラクチャに基づくプール内のコンピューティング ノードの構成。

VMExtension

仮想マシン拡張機能の構成。

WindowsConfiguration

仮想マシンに適用するオペレーティング システムの設定をWindowsします。

WindowsUserConfiguration

Windowsコンピューティング ノードでユーザー アカウントを作成するために使用されるプロパティ。

ApplicationPackageReference

コンピューティング ノードにデプロイするパッケージへの参照。

Name Type Description
applicationId
  • string

デプロイするアプリケーションの ID。

version
  • string

デプロイするアプリケーションのバージョン。 省略すると、既定のバージョンがデプロイされます。
プールでこれを省略し、このアプリケーションに既定のバージョンが指定されていない場合、要求はエラー コード InvalidApplicationPackageReferences と HTTP 状態コード 409 で失敗します。 タスクでこれを省略し、このアプリケーションに既定のバージョンが指定されていない場合、タスクは前処理エラーで失敗します。

AuthenticationTokenSettings

タスクが Batch サービス操作の実行に使用できる認証トークンの設定。

Name Type Description
access
  • string[]

トークンがアクセスを許可する Batch リソース。
認証トークンは、限られた一連の Batch サービス操作へのアクセスを許可します。 現在、アクセス プロパティでサポートされている値は "job" のみです。この値は、Task を含むジョブに関連するすべての操作へのアクセスを許可します。

AutoPoolSpecification

一時 '自動プール' の特性を指定します。 Batch サービスは、ジョブの送信時にこの自動プールを作成します。

Name Type Description
autoPoolIdPrefix
  • string

プールが自動的に作成されるときに一意の識別子に追加されるプレフィックス。
Batch サービスは、作成時に各自動プールに一意の識別子を割り当てます。 さまざまな目的で作成されたプールを区別するために、この要素を指定して、割り当てられている ID にプレフィックスを追加できます。 プレフィックスは 20 文字まで指定できます。

keepAlive
  • boolean

有効期間が切れた後も自動プールを有効に保つかどうか。
false の場合、Batch サービスは、その有効期間 (poolLifetimeOption 設定によって決定) の有効期限が切れるとプールを削除します。つまり、ジョブまたはジョブ スケジュールが完了したときです。 true の場合、Batch サービスはプールを自動的に削除しません。 このオプションを使用して作成された自動プールは、ユーザーが削除する必要があります。

pool

自動プールのプール仕様。

poolLifetimeOption

作成された自動プールの最小有効期間と、スケジュール上の複数のジョブをプールに割り当てる方法。

AutoUserScope

自動ユーザーのスコープ

Name Type Description
pool
  • string

タスクが、プール内のすべてのコンピューティング ノードで作成される共通の自動ユーザー アカウントとして実行されるように指定します。

task
  • string

サービスがタスクの新しいユーザーを作成することを指定します。

AutoUserSpecification

Batch サービスでタスクを実行する自動ユーザーのパラメーターを指定します。

Name Type Description
elevationLevel

自動ユーザーの昇格レベル。
既定値は nonAdmin です。

scope

自動ユーザーのスコープ
既定値は pool です。 プールが実行中の場合Windowsタスク間のより厳密な分離が必要な場合は、Task の値を指定する必要があります。 たとえば、タスクが他のタスクに影響を与える可能性のある方法でレジストリを変更する場合や、通常のタスクではアクセスできないが StartTasks からアクセスできる必要があるプールで証明書が指定されている場合などです。

AzureBlobFileSystemConfiguration

Blobfuse を使用してAzure Storage コンテナーに接続するために使用される情報。

Name Type Description
accountKey
  • string

Azure Storage アカウント キー。
このプロパティは、sasKey と ID の両方と相互に排他的です。正確に 1 つを指定する必要があります。

accountName
  • string

Azure Storage アカウント名。

blobfuseOptions
  • string

mount コマンドに渡す追加のコマンド ライン オプション。
これらは、Windowsの 'net use' オプションと Linux の 'mount' オプションです。

containerName
  • string

Azure Blob Storage コンテナー名。

identityReference

containerName へのアクセスに使用するユーザー割り当て ID への参照
このプロパティは、accountKey と sasKey の両方で相互に排他的です。正確に 1 つを指定する必要があります。

relativeMountPath
  • string

ファイル システムがマウントされるコンピューティング ノード上の相対パス
すべてのファイル システムは Batch マウント ディレクトリに対して相対的にマウントされ、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできます。

sasKey
  • string

Azure Storage SAS トークン。
このプロパティは、accountKey と ID の両方で相互に排他的です。正確に 1 つを指定する必要があります。

AzureFileShareConfiguration

Azure Fileshare への接続に使用される情報。

Name Type Description
accountKey
  • string

Azure Storage アカウント キー。

accountName
  • string

Azure Storage のアカウント名。

azureFileUrl
  • string

Azure Files URL。
これは "https://{account}.file.core.windows.net/" という形式です。

mountOptions
  • string

mount コマンドに渡す追加のコマンド ライン オプション。
これらは、Windowsの 'net use' オプションと Linux の 'mount' オプションです。

relativeMountPath
  • string

ファイル システムがマウントされるコンピューティング ノード上の相対パス
すべてのファイル システムは Batch マウント ディレクトリに対して相対的にマウントされ、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできます。

BatchError

Azure Batch サービスから受信したエラー応答。

Name Type Description
code
  • string

エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。

message

ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。

values

エラーに関する追加の詳細を含むキーと値のペアのコレクション。

BatchErrorDetail

Azure Batchエラー応答に含まれる追加情報の項目。

Name Type Description
key
  • string

Value プロパティの意味を指定する識別子。

value
  • string

エラー応答に含まれる追加情報。

CachingType

ディスクに対して有効にするキャッシュの種類。

Name Type Description
none
  • string

ディスクのキャッシュ モードが有効になっていません。

readonly
  • string

ディスクのキャッシュ モードは読み取り専用です。

readwrite
  • string

ディスクのキャッシュ モードは読み取りと書き込みです。

CertificateReference

プール内のコンピューティング ノードにインストールする証明書への参照。

Name Type Description
storeLocation

証明書をインストールするコンピューティング ノード上の証明書ストアの場所。
既定値は currentuser です。 このプロパティは、Windows コンピューティング ノードで構成されたプール (つまり、cloudServiceConfiguration を使用して作成されたプール、または Windows イメージ参照を使用した virtualMachineConfiguration) にのみ適用されます。 Linux コンピューティング ノードの場合、証明書は Task 作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、証明書がそのディレクトリに配置されます。

storeName
  • string

証明書をインストールするコンピューティング ノード上の証明書ストアの名前。
このプロパティは、Windows コンピューティング ノードで構成されたプール (つまり、cloudServiceConfiguration を使用して作成されたプール、または Windows イメージ参照を使用した virtualMachineConfiguration) にのみ適用されます。 一般的なストア名には、My、Root、CA、Trust、Disallowed、TrustedPeople、TrustedPublisher、AuthRoot、AddressBook などがありますが、任意のカスタム ストア名も使用できます。 既定値は、My です。

thumbprint
  • string

証明書の拇印。

thumbprintAlgorithm
  • string

拇印が関連付けられているアルゴリズム。 これは sha1 である必要があります。

visibility
  • string[]

コンピューティング ノード上のどのユーザー アカウントが、証明書のプライベート データにアクセスできる必要があります。
このコレクションでは、複数の可視性を指定できます。 既定値は、すべてのアカウントです。

CertificateStoreLocation

証明書をインストールするコンピューティング ノード上の証明書ストアの場所。

Name Type Description
currentuser
  • string

CurrentUser 証明書ストアに証明書をインストールする必要があります。

localmachine
  • string

証明書は LocalMachine 証明書ストアにインストールする必要があります。

CIFSMountConfiguration

CIFS ファイル システムへの接続に使用される情報。

Name Type Description
mountOptions
  • string

mount コマンドに渡す追加のコマンド ライン オプション。
これらは、Windowsの 'net use' オプションと Linux の 'mount' オプションです。

password
  • string

CIFS ファイル システムに対する認証に使用するパスワード。

relativeMountPath
  • string

ファイル システムがマウントされるコンピューティング ノード上の相対パス
すべてのファイル システムは Batch マウント ディレクトリに対して相対的にマウントされ、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできます。

source
  • string

マウントするファイル システムの URI。

username
  • string

CIFS ファイル システムに対する認証に使用するユーザー。

CloudJobSchedule

ジョブを実行するタイミングと、各ジョブの作成に使用する仕様を指定して、定期的なジョブを許可するジョブ スケジュール。

Name Type Description
creationTime
  • string

ジョブ スケジュールの作成時刻。

displayName
  • string

スケジュールの表示名。

eTag
  • string

ジョブ スケジュールの ETag。
これは不透明な文字列です。 これを使用して、ジョブ スケジュールが要求間で変更されたかどうかを検出できます。 特に、ETag にジョブ スケジュールの更新要求を渡して、その間に他のユーザーがスケジュールを変更していない場合にのみ変更を有効にするように指定できます。

executionInfo

このスケジュールで実行され、実行されるジョブに関する情報。

id
  • string

アカウント内のスケジュールを一意に識別する文字列。

jobSpecification

このスケジュールで作成するジョブの詳細。

lastModified
  • string

ジョブ スケジュールの最終変更時刻。
これは、ジョブの仕様や繰り返し情報など、スケジュール レベルのデータが変更された最後の時刻です。 新しいジョブの作成やジョブの状態の変更など、ジョブ レベルの変更は考慮されません。

metadata

スケジュールにメタデータとして関連付けられている名前と値のペアの一覧。
Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。

previousState

ジョブ スケジュールの以前の状態。
ジョブ スケジュールが初期状態の場合、このプロパティは存在しません。

previousStateTransitionTime
  • string

ジョブ スケジュールが以前の状態になった時刻。
ジョブ スケジュールが初期状態の場合、このプロパティは存在しません。

schedule

ジョブが作成されるスケジュール。
すべての時刻は UTC にそれぞれ固定され、夏時間の影響を受けません。

state

ジョブ スケジュールの現在の状態。

stateTransitionTime
  • string

ジョブ スケジュールが現在の状態になった時刻。

stats

ジョブ スケジュールの有効期間リソース使用状況統計。 統計はすぐには使用できない場合があります。 Batch サービスは、統計の定期的なロールアップを実行します。 一般的な遅延は約 30 分です。

url
  • string

ジョブ スケジュールの URL。

CloudJobScheduleListResult

アカウントにジョブ スケジュールを一覧表示した結果。

Name Type Description
odata.nextLink
  • string

次の結果セットを取得する URL。

value

ジョブ スケジュールの一覧。

CloudServiceConfiguration

Azure Cloud Services プラットフォームに基づくプール内のコンピューティング ノードの構成。

Name Type Description
osFamily
  • string

プール内の仮想マシンにインストールする Azure ゲスト OS ファミリ。
使用可能な値は、2 - OS ファミリ 2 で、Windows Server 2008 R2 SP1 と同等です。 3 - OS ファミリ 3。Windows Server 2012に相当します。 4 - WINDOWS SERVER 2012 R2 と同等の OS ファミリ 4。 5 - OS ファミリ 5(Windows Server 2016と同等)。 6 - OS ファミリ 6。Windows Server 2019 と同等です。 詳細については、「Azure ゲスト OS リリース (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases)」を参照してください。

osVersion
  • string

プール内の仮想マシンにインストールされる Azure ゲスト OS バージョン。
既定値は *で、指定した OS ファミリの最新のオペレーティング システム バージョンを指定します。

ComputeNodeFillType

プール内のコンピューティング ノード間でタスクを分散する方法。

Name Type Description
pack
  • string

プール内の次のコンピューティング ノードにタスクが割り当てられる前に、できるだけ多くのタスク (taskSlotsPerNode) をプール内の各コンピューティング ノードに割り当てる必要があります。

spread
  • string

タスクは、プール内のすべてのコンピューティング ノードに均等に割り当てる必要があります。

ComputeNodeIdentityReference

コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。

Name Type Description
resourceId
  • string

ユーザー割り当て ID の ARM リソース ID。

ContainerConfiguration

コンテナーが有効なプールの構成。

Name Type Description
containerImageNames
  • string[]

コンテナーイメージ名のコレクション。
これは、"docker pull" に指定されているように、完全なイメージ参照です。 イメージが代替レジストリで完全修飾されていない限り、イメージは既定の Docker レジストリから取得されます。

containerRegistries

コンテナーをプルできる追加のプライベート レジストリ。
資格情報を必要とするプライベート レジストリからイメージをダウンロードする必要がある場合は、これらの資格情報をここで指定する必要があります。

type

使用するコンテナー テクノロジ。

ContainerRegistry

プライベート コンテナー レジストリ。

Name Type Description
identityReference

ユーザー名とパスワードの代わりにAzure Container Registryにアクセスするために使用するユーザー割り当て ID への参照。
コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。

password
  • string

レジストリ サーバーにログインするためのパスワード。

registryServer
  • string

レジストリ URL。
省略すると、既定値は "docker.io" になります。

username
  • string

レジストリ サーバーにログインするユーザー名。

ContainerType

使用するコンテナー テクノロジ。

Name Type Description
dockerCompatible
  • string

Docker 互換のコンテナー テクノロジを使用してコンテナーを起動します。

ContainerWorkingDirectory

コンテナータスク作業ディレクトリの場所。

Name Type Description
containerImageDefault
  • string

コンテナー イメージで定義されている作業ディレクトリを使用します。 このディレクトリには、Batch によってダウンロードされたリソース ファイルが含まれていないことに注意してください。

taskWorkingDirectory
  • string

標準の Batch サービスタスク作業ディレクトリを使用します。このディレクトリには、Batch によって設定されたタスク リソース ファイルが含まれます。

DataDisk

設定プール内のコンピューティング ノードに関連付けられているデータ ディスクによって使用されます。 添付データ ディスクを含める場合は、それらを使用する VM 内からディスクを マウントおよびフォーマットする必要があります。

Name Type Description
caching

データ ディスクに対して有効にするキャッシュの種類。
キャッシュの既定値は readwrite です。 キャッシュ オプションの詳細については、次 https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/を参照してください。

diskSizeGB
  • integer

初期ディスク サイズ (ギガバイト単位)。

lun
  • integer

論理単位番号。
lun は、各データ ディスクを一意に識別するために使用されます。 複数のディスクを接続する場合は、それぞれに個別の lun が必要です。 値は、0 から 63 の範囲で指定する必要があります。

storageAccountType

データ ディスクに使用するストレージ アカウントの種類。
省略すると、既定値は "standard_lrs" になります。

DiffDiskPlacement

プール内のすべてのコンピューティング ノード (VM) のオペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。

Name Type Description
CacheDisk
  • string

エフェメラル OS ディスクは VM キャッシュに格納されます。

DiffDiskSettings

コンピューティング ノード (VM) によって使用されるオペレーティング システム ディスクのエフェメラル ディスク 設定を指定します。

Name Type Description
placement

プール内のすべての VM のオペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。
このプロパティは、要求のユーザーが、エフェメラル OS ディスク プロビジョニング用のキャッシュ ディスク領域などの場所を選択するために使用できます。 エフェメラル OS ディスク サイズの要件の詳細については、「Windows VM のエフェメラル OS ディスク サイズ要件」および「Linux VMhttps://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirementshttps://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirementsを参照してください。

DiskEncryptionConfiguration

プール内のコンピューティング ノードに適用されるディスク暗号化構成。 Shared Image Gallery イメージで作成された Linux プールでは、ディスク暗号化の構成はサポートされていません。

Name Type Description
targets
  • string[]

Batch Service がコンピューティング ノードで暗号化するディスク ターゲットの一覧。
省略すると、プール内のコンピューティング ノード上のディスクは暗号化されません。 Linux プールでは、"TemporaryDisk" のみがサポートされています。Windows プールでは、"OsDisk" と "TemporaryDisk" を指定する必要があります。

DynamicVNetAssignmentScope

動的 vnet 割り当てのスコープ。

Name Type Description
job
  • string

動的 VNet の割り当てはジョブごとに実行されます。

none
  • string

動的 VNet の割り当ては有効になっていません。

ElevationLevel

ユーザーの昇格レベル。

Name Type Description
admin
  • string

ユーザーは、管理者特権のアクセス権を持つユーザーであり、完全な管理者アクセス許可を使用して操作します。

nonadmin
  • string

ユーザーは、昇格されたアクセス権を持たない標準ユーザーです。

EnvironmentSetting

タスク プロセスに設定する環境変数。

Name Type Description
name
  • string

環境変数の名前。

value
  • string

環境変数の値。

ErrorMessage

Azure Batchエラー応答で受信したエラー メッセージ。

Name Type Description
lang
  • string

エラー メッセージの言語コード

value
  • string

メッセージのテキストです。

HttpHeader

HTTP ヘッダーの名前と値のペア

Name Type Description
name
  • string

出力ファイルのアップロード時に使用するヘッダーの大文字と小文字を区別しない名前

value
  • string

出力ファイルのアップロード時に使用するヘッダーの値

ImageReference

Azure Virtual Machines Marketplace イメージまたは Shared Image Gallery イメージへの参照。 Azure Batchによって検証されたすべてのAzure Marketplaceイメージ参照の一覧を取得するには、「サポートされているイメージの一覧表示」操作を参照してください。

Name Type Description
exactVersion
  • string

ノードの作成に使用されるプラットフォーム イメージまたはマーケットプレース イメージの特定のバージョン。 この読み取り専用フィールドは、プールの作成時に 'version' に指定された値が 'latest' の場合にのみ、'version' と異なります。

offer
  • string

Azure Virtual Machines Marketplace イメージのオファーの種類。
たとえば、UbuntuServer や WindowsServer などです。

publisher
  • string

Azure Virtual Machines Marketplace イメージの発行元。
たとえば、Canonical または MicrosoftWindowsServer です。

sku
  • string

Azure Virtual Machines Marketplace イメージの SKU。
たとえば、18.04-LTS や 2019-Datacenter などです。

version
  • string

Azure Virtual Machines Marketplace イメージのバージョン。
'latest' の値を指定して、イメージの最新バージョンを選択できます。 省略した場合、既定値は 'latest' です。

virtualMachineImageId
  • string

Shared Image Gallery イメージの ARM リソース識別子。 プール内のコンピューティング ノードは、このイメージ ID を使用して作成されます。これは、常に最新のイメージ バージョンに既定で設定される /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleryName}/images/{imageDefinitionName}/versions/{VersionId} または /subscriptions/{subscriptionId}/resourceGroup}/providers/Microsoft.Compute/gallerys/galleryName}/images/{imageDefinitionName} の形式です。
このプロパティは、他の ImageReference プロパティと相互に排他的です。 Shared Image Gallery イメージは、同じリージョンにレプリカがあり、Azure Batch アカウントと同じサブスクリプションに存在する必要があります。 イメージのバージョンが imageId で指定されていない場合は、最新バージョンが使用されます。 Batch サービスと通信する Batch コンピューティング ノード エージェントのファイアウォール設定の詳細については、次を参照してください https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

InboundEndpointProtocol

エンドポイントのプロトコル。

Name Type Description
tcp
  • string

エンドポイントに TCP を使用します。

udp
  • string

エンドポイントに UDP を使用します。

InboundNATPool

Batch プール内のコンピューティング ノード上の特定のポートに外部からアドレス指定するために使用できる受信 NAT プール。

Name Type Description
backendPort
  • integer

コンピューティング ノードのポート番号。
これは、Batch プール内で一意である必要があります。 22、3389、29876、29877 を除き、使用可能な値は 1 から 65535 です。これらは予約されています。 予約された値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。

frontendPortRangeEnd
  • integer

個々のコンピューティング ノードの backendPort への受信アクセスを提供するために使用される外部ポートの範囲内の最後のポート番号。
使用可能な値の範囲は 1 ~ 65534 です。ただし、Batch サービスによって予約されているポートは 50000 ~ 55000 です。 プール内のすべての範囲は個別である必要があり、重複することはできません。 各範囲には、少なくとも 40 個のポートが含まれている必要があります。 予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。

frontendPortRangeStart
  • integer

個々のコンピューティング ノードの backendPort への受信アクセスを提供するために使用される外部ポートの範囲内の最初のポート番号。
使用可能な値の範囲は 1 ~ 65534 です。ただし、予約されているポートは 50000 ~ 55000 です。 プール内のすべての範囲は個別である必要があり、重複することはできません。 各範囲には、少なくとも 40 個のポートが含まれている必要があります。 予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。

name
  • string

エンドポイントの名前。
名前は Batch プール内で一意である必要があり、文字、数字、アンダースコア、ピリオド、ハイフンを含めることができます。 名前は、文字または数字で始まる必要があり、文字、数字、またはアンダースコアで終わる必要があり、77 文字を超えることはできません。 無効な値が指定された場合、要求は HTTP 状態コード 400 で失敗します。

networkSecurityGroupRules

エンドポイントに適用されるネットワーク セキュリティ グループ規則の一覧。
Batch プール上のすべてのエンドポイントで指定できるルールの最大数は 25 です。 ネットワーク セキュリティ グループ規則が指定されていない場合は、指定した backendPort への受信アクセスを許可する既定の規則が作成されます。 ネットワーク セキュリティ グループ規則の最大数を超えた場合、要求は HTTP 状態コード 400 で失敗します。

protocol

エンドポイントのプロトコル。

IPAddressProvisioningType

プールのパブリック IP アドレスのプロビジョニングの種類。

Name Type Description
batchmanaged
  • string

パブリック IP は Batch によって作成および管理されます。 プールのサイズによっては、複数のパブリック IP が存在する場合があります。

nopublicipaddresses
  • string

パブリック IP アドレスは作成されません。

usermanaged
  • string

パブリック IP はユーザーによって提供され、コンピューティング ノードのプロビジョニングに使用されます。

JobConstraints

ジョブの実行制約。

Name Type Description
maxTaskRetryCount
  • integer

各タスクを再試行できる最大回数。 終了コードが 0 以外の場合、Batch サービスは Task を再試行します。
この値によって再試行の回数が限定されますのでご注意ください。 Batch サービスは各タスクを 1 回試し、この制限まで再試行できます。 たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (1 回の最初の再試行と 3 回の再試行)。 最大再試行回数が 0 の場合、Batch サービスはタスクを再試行しません。 最大再試行回数が -1 の場合、Batch サービスは制限なくタスクを再試行しますが、開始タスクまたはタスクには推奨されません。 既定値は 0 です (再試行なし)

maxWallClockTime
  • string

ジョブが作成された時点から測定された、ジョブが実行できる最大経過時間。
ジョブが制限時間内に完了しない場合、Batch サービスはジョブを終了し、実行中のすべてのタスクを終了します。 この場合、終了の理由は MaxWallClockTimeExpiry になります。 このプロパティを指定しない場合、ジョブの実行時間に時間制限はありません。

JobManagerTask

ジョブ マネージャー タスクの詳細を指定します。

Name Type Description
allowLowPriorityNode
  • boolean

ジョブ マネージャー タスクがスポット/低優先度コンピューティング ノードで実行できるかどうかを指定します。
既定値は、true です。

applicationPackageReferences

コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにデプロイするアプリケーション パッケージの一覧。
アプリケーション パッケージは、タスク作業ディレクトリではなく、共有ディレクトリにダウンロードされ、デプロイされます。 したがって、参照されているアプリケーション パッケージが既にコンピューティング ノード上にあり、最新の状態である場合、再ダウンロードされません。コンピューティング ノード上の既存のコピーが使用されます。 参照先のアプリケーション パッケージをインストールできない場合 (たとえば、パッケージが削除されたか、ダウンロードに失敗したため)、タスクは失敗します。

authenticationTokenSettings

Batch サービス操作の実行にタスクが使用できる認証トークンの設定。
このプロパティが設定されている場合、Batch サービスは、アカウント アクセス キーを必要とせずに Batch サービス操作を認証するために使用できる認証トークンを Task に提供します。 トークンは、AZ_BATCH_AUTHENTICATION_TOKEN環境変数を介して提供されます。 タスクがトークンを使用して実行できる操作は、設定によって異なります。 たとえば、タスクは、ジョブに他のタスクを追加したり、ジョブまたはその他のタスクの状態を確認したりするために、ジョブのアクセス許可を要求できます。

commandLine
  • string

ジョブ マネージャー タスクのコマンド ライン。
コマンド ラインはシェルでは実行されないため、環境変数の展開などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windowsの "cmd /c MyCommand" や Linux の "/bin/sh -c MyCommand" を使用します。 コマンド ラインがファイル パスを参照する場合は、相対パス (Task 作業ディレクトリに対する相対パス) を使用するか、Batch で指定された環境変数 (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) を使用する必要があります。

constraints

ジョブ マネージャー タスクに適用される制約。

containerSettings

ジョブ マネージャー タスクを実行するコンテナーの設定。
このタスクを実行するプールに containerConfiguration が設定されている場合は、これも設定する必要があります。 このタスクを実行するプールに containerConfiguration が設定されていない場合は、これを設定しないでください。 これを指定すると、AZ_BATCH_NODE_ROOT_DIRの下にあるすべてのディレクトリ (ノード上の Azure Batch ディレクトリのルート) がコンテナーにマップされ、すべての Task 環境変数がコンテナーにマップされ、タスク コマンド ラインがコンテナーで実行されます。 AZ_BATCH_NODE_ROOT_DIR外のコンテナーで生成されたファイルはホスト ディスクに反映されない可能性があります。つまり、Batch ファイル API はそれらのファイルにアクセスできません。

displayName
  • string

ジョブ マネージャー タスクの表示名。
一意である必要はありません。最大長が 1024 の Unicode 文字を含めることができます。

environmentSettings

ジョブ マネージャー タスクの環境変数設定の一覧。

id
  • string

ジョブ内のジョブ マネージャー タスクを一意に識別する文字列。
ID には、ハイフンやアンダースコアを含む任意の英数字を組み合わせて使用でき、64 文字を超えることはできません。

killJobOnCompletion
  • boolean

ジョブ マネージャー タスクの完了が、ジョブ全体の完了を示すかどうか。
true の場合、ジョブ マネージャー タスクが完了すると、Batch サービスによってジョブが完了としてマークされます。 現時点で (ジョブ リリース以外の) タスクがまだ実行されている場合、それらのタスクは終了します。 false の場合、ジョブ マネージャー タスクの完了はジョブの状態に影響しません。 この場合は、onAllTasksComplete 属性を使用してジョブを終了するか、クライアントまたはユーザーにジョブを明示的に終了させる必要があります。 この例は、ジョブ マネージャーが一連のタスクを作成し、その実行にそれ以上の役割を果たさない場合です。 既定値は、true です。 onAllTasksComplete 属性と onTaskFailure 属性を使用してジョブの有効期間を制御し、ジョブ マネージャー タスクを使用してジョブのタスクを作成する (進行状況を監視しない) 場合は、killJobOnCompletion を false に設定することが重要です。

outputFiles

コマンド ラインの実行後に Batch サービスがコンピューティング ノードからアップロードするファイルの一覧。
複数インスタンスのタスクの場合、ファイルは、プライマリ タスクが実行されているコンピューティング ノードからのみアップロードされます。

requiredSlots
  • integer

タスクの実行に必要なスケジュール スロットの数。
既定値は 1 です。 タスクは、ノードに使用可能な十分な空きスケジュール スロットがある場合にのみ、コンピューティング ノードで実行するようにスケジュールできます。 複数インスタンスのタスクの場合、このプロパティはサポートされていないため、指定しないでください。

resourceFiles

コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。
この要素の下に一覧表示されるファイルは、タスクの作業ディレクトリにあります。 リソース ファイルの一覧には最大サイズがあります。 最大サイズを超えると、要求は失敗し、応答エラー コードは RequestEntityTooLarge になります。 この場合、ResourceFiles のコレクションのサイズを小さくする必要があります。 これは、.zip ファイル、アプリケーション パッケージ、または Docker コンテナーを使用して実現できます。

runExclusive
  • boolean

ジョブ マネージャー タスクが実行されているコンピューティング ノードを排他的に使用する必要があるかどうか。
true の場合、ジョブ マネージャーが実行されている限り、同じノードで他のタスクは実行されません。 false の場合、他のタスクはコンピューティング ノード上のジョブ マネージャーと同時に実行できます。 ジョブ マネージャー タスクは通常、コンピューティング ノードの同時実行タスク制限に対してカウントされるため、これは、コンピューティング ノードが複数の同時実行タスクを許可する場合にのみ関連します。 既定値は、true です。

userIdentity

ジョブ マネージャー タスクを実行するユーザー ID。
省略すると、タスクはタスクに固有の非管理ユーザーとして実行されます。

JobNetworkConfiguration

ジョブのネットワーク構成。

Name Type Description
subnetId
  • string

ジョブからタスクを実行しているコンピューティング ノードがタスクの期間中参加する仮想ネットワーク サブネットの ARM リソース識別子。 これは、VirtualMachineConfiguration プールでのみ機能します。
仮想ネットワークは、Azure Batch アカウントと同じリージョンとサブスクリプションに存在する必要があります。 指定されたサブネットには、ジョブからタスクを実行するコンピューティング ノードの数に対応できる十分な空き IP アドレスが必要です。 これは、プール内のコンピューティング ノードの数までです。 "MicrosoftAzureBatch" サービス プリンシパルには、指定された VNet の "クラシック仮想マシン共同作成者" Role-Based Access Control (RBAC) ロールが必要です。これにより、Azure Batch サービスはノード上のタスクをスケジュールできます。 これは、指定された VNet にネットワーク セキュリティ グループ (NSG) が関連付けられているかどうかを確認することで確認できます。 指定したサブネット内のノードへの通信が NSG によって拒否された場合、Batch サービスはコンピューティング ノードの状態を使用不可に設定します。 これは、/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}の形式です。 指定した VNet にネットワーク セキュリティ グループ (NSG) が関連付けられている場合は、Azure Batch サービスからの受信通信のために、いくつかの予約済みシステム ポートを有効にする必要があります。 仮想マシン構成で作成されたプールの場合は、ポート 29876 と 29877、Linux の場合はポート 22、Windowsの場合はポート 3389 を有効にします。 ポート 443 は、Azure Storageへの通信の送信接続にも開いている必要があります。 詳細については、次を参照してください。 https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

JobPreparationTask

特定のコンピューティング ノード上のジョブのタスクの前に実行するジョブ準備タスク。

Name Type Description
commandLine
  • string

ジョブ準備タスクのコマンド ライン。
コマンド ラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windowsの "cmd /c MyCommand" や Linux の "/bin/sh -c MyCommand" を使用します。 コマンド ラインがファイル パスを参照している場合は、相対パス (Task 作業ディレクトリに対する相対パス) を使用するか、Batch で指定された環境変数 (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) を使用する必要があります。

constraints

ジョブ準備タスクに適用される制約。

containerSettings

ジョブ準備タスクが実行されるコンテナーの設定。
これを指定すると、AZ_BATCH_NODE_ROOT_DIRの下にあるすべてのディレクトリ (ノード上の Azure Batch ディレクトリのルート) がコンテナーにマップされ、すべての Task 環境変数がコンテナーにマップされ、タスク コマンド ラインがコンテナーで実行されます。 AZ_BATCH_NODE_ROOT_DIR外のコンテナーで生成されたファイルはホスト ディスクに反映されない可能性があります。つまり、Batch ファイル API はそれらのファイルにアクセスできません。

environmentSettings

ジョブ準備タスクの環境変数設定の一覧。

id
  • string

ジョブ内のジョブ準備タスクを一意に識別する文字列。
ID には、ハイフンやアンダースコアを含む任意の英数字を組み合わせて使用でき、64 文字を超えることはできません。 このプロパティを指定しない場合、Batch サービスは既定値 'jobpreparation' を割り当てます。 ジョブ内の他のタスクは、ジョブ準備タスクと同じ ID を持つ必要はありません。 同じ ID のタスクを送信しようとすると、Batch サービスはエラー コード TaskIdSameAsJobPreparationTask を使用して要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 409 (競合) です。

rerunOnNodeRebootAfterSuccess
  • boolean

コンピューティング ノードの再起動後に Batch サービスでジョブ準備タスクを再実行する必要があるかどうか。
コンピューティング ノードが再イメージ化された場合、またはジョブ準備タスクが完了しなかった場合 (タスクの実行中に再起動が発生したためなど) は、ジョブ準備タスクは常に再実行されます。 そのため、ジョブ準備タスクを常にべき等にし、複数回実行した場合に正しく動作するように記述する必要があります。 既定値は、true です。

resourceFiles

コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。
この要素の下に一覧表示されるファイルは、タスクの作業ディレクトリにあります。 リソース ファイルの一覧には最大サイズがあります。 最大サイズを超えると、要求は失敗し、応答エラー コードは RequestEntityTooLarge になります。 この場合、ResourceFiles のコレクションのサイズを小さくする必要があります。 これは、.zip ファイル、アプリケーション パッケージ、または Docker コンテナーを使用して実現できます。

userIdentity

ジョブ準備タスクを実行するユーザー ID。
省略すると、タスクは、Windows コンピューティング ノード上のタスクに固有の管理ユーザー以外のユーザー、または Linux コンピューティング ノード上のプールに固有の非管理ユーザーとして実行されます。

waitForSuccess
  • boolean

Batch サービスがジョブ準備タスクが正常に完了するまで待機してから、コンピューティング ノード上のジョブの他のタスクをスケジュールする必要があるかどうか。 終了コード 0 で終了した場合、ジョブ準備タスクは正常に完了しました。
true でノードでジョブ準備タスクが失敗した場合、Batch サービスはジョブ準備タスクを最大再試行回数 (制約要素で指定) まで再試行します。 すべての再試行の後もタスクがまだ正常に完了していない場合、Batch サービスはジョブのタスクをノードにスケジュールしません。 ノードはアクティブなままであり、他のジョブのタスクを実行できます。 false の場合、Batch サービスはジョブ準備タスクの完了を待機しません。 この場合、ジョブ準備タスクがまだ実行中に、ジョブの他のタスクがコンピューティング ノードで実行を開始できます。ジョブ準備タスクが失敗した場合でも、新しいタスクはコンピューティング ノードで引き続きスケジュールされます。 既定値は、true です。

JobReleaseTask

ジョブが実行されている任意のコンピューティング ノードでジョブの完了時に実行するジョブ リリース タスク。

Name Type Description
commandLine
  • string

ジョブ解放タスクのコマンド ライン。
コマンド ラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windowsの "cmd /c MyCommand" や Linux の "/bin/sh -c MyCommand" を使用します。 コマンド ラインがファイル パスを参照している場合は、相対パス (Task 作業ディレクトリに対する相対パス) を使用するか、Batch で指定された環境変数 (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) を使用する必要があります。

containerSettings

ジョブ リリース タスクが実行されるコンテナーの設定。
これを指定すると、AZ_BATCH_NODE_ROOT_DIRの下にあるすべてのディレクトリ (ノード上の Azure Batch ディレクトリのルート) がコンテナーにマップされ、すべての Task 環境変数がコンテナーにマップされ、タスク コマンド ラインがコンテナーで実行されます。 AZ_BATCH_NODE_ROOT_DIR外のコンテナーで生成されたファイルはホスト ディスクに反映されない可能性があります。つまり、Batch ファイル API はそれらのファイルにアクセスできません。

environmentSettings

ジョブ解放タスクの環境変数設定の一覧。

id
  • string

ジョブ内のジョブ リリース タスクを一意に識別する文字列。
ID には、ハイフンやアンダースコアを含む任意の英数字を組み合わせて使用でき、64 文字を超えることはできません。 このプロパティを指定しない場合、Batch サービスは既定値 'jobrelease' を割り当てます。 ジョブ内の他のタスクは、ジョブ解放タスクと同じ ID を持つ必要はありません。 同じ ID のタスクを送信しようとすると、Batch サービスはエラー コード TaskIdSameAsJobReleaseTask で要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 409 (競合) です。

maxWallClockTime
  • string

特定のコンピューティング ノードでジョブ 解放タスクを実行できる最大経過時間。タスクの開始時から測定されます。 タスクが期限内に完了しない場合は、Batch サービスによって終了されます。 既定値は 15 分です。 タイムアウトを 15 分より長く指定することはできません。 その場合、Batch サービスはエラーで拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。

resourceFiles

コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。 リソース ファイルの一覧には最大サイズがあります。 最大サイズを超えると、要求は失敗し、応答エラー コードは RequestEntityTooLarge になります。 この場合、ResourceFiles のコレクションのサイズを小さくする必要があります。 これは、.zip ファイル、アプリケーション パッケージ、または Docker コンテナーを使用して実現できます。
この要素の下に一覧表示されるファイルは、タスクの作業ディレクトリにあります。

retentionTime
  • string

コンピューティング ノード上のジョブ リリース タスクの Task ディレクトリを保持する最小時間。 この時間が経過すると、Batch サービスによって Task ディレクトリとそのすべての内容が削除される可能性があります。
既定値は 7 日間です。つまり、コンピューティング ノードが削除されるか、ジョブが削除されない限り、タスク ディレクトリは 7 日間保持されます。

userIdentity

ジョブ解放タスクを実行するユーザー ID。
省略すると、タスクはタスクに固有の非管理ユーザーとして実行されます。

JobScheduleExecutionInformation

ジョブ スケジュールで実行されたジョブと実行されるジョブに関する情報が含まれます。

Name Type Description
endTime
  • string

スケジュールが終了した時刻。
このプロパティは、ジョブ スケジュールが完了状態の場合にのみ設定されます。

nextRunTime
  • string

このスケジュールで次にジョブが作成される時刻。
このプロパティは、スケジュールが時間が来たときにアクティブな状態にある場合にのみ意味があります。 たとえば、スケジュールが無効になっている場合、その前にジョブが有効になっていない限り、nextRunTime ではジョブは作成されません。

recentJob

ジョブ スケジュールの下の最新のジョブに関する情報。
このプロパティは、少なくとも 1 つのジョブがスケジュールの下で実行されている場合にのみ存在します。

JobScheduleState

ジョブ スケジュールの状態。

Name Type Description
active
  • string

ジョブ スケジュールはアクティブであり、スケジュールに従ってジョブが作成されます。

completed
  • string

ジョブ スケジュールは、終了時刻に達するか、ユーザーが明示的に終了することによって終了しました。

deleting
  • string

ユーザーはジョブ スケジュールの削除を要求しましたが、削除操作はまだ進行中です。 スケジューラは、このジョブ スケジュールの新しいジョブを開始せず、アクティブなジョブを含め、ジョブ スケジュールの下にある既存のジョブとタスクを削除します。 ジョブ スケジュールの下にあるすべてのジョブとタスクが削除されると、ジョブ スケジュールが削除されます。

disabled
  • string

ユーザーがジョブ スケジュールを無効にしました。 スケジューラはこのスケジュールで新しいジョブを開始しませんが、既存のアクティブなジョブはすべて引き続き実行されます。

terminating
  • string

ジョブ スケジュールに実行する作業がなくなったか、ユーザーによって明示的に終了されましたが、終了操作はまだ進行中です。 スケジューラは、このジョブ スケジュールに対して新しいジョブを開始せず、既存のジョブもアクティブになりません。

JobScheduleStatistics

ジョブ スケジュールのリソース使用状況の統計情報。

Name Type Description
kernelCPUTime
  • string

スケジュールに従って作成されたすべてのジョブのすべてのタスクによって消費されるカーネル モード CPU 時間の合計 (すべてのコアとすべてのコンピューティング ノードで合計)。

lastUpdateTime
  • string

統計が最後に更新された時刻。 すべての統計は、startTime と lastUpdateTime の間の範囲に制限されます。

numFailedTasks
  • integer

スケジュールに従って作成されたジョブの特定の時間範囲内に失敗したタスクの合計数。 終了コード 0 を返さずに最大再試行回数を使い果たした場合、タスクは失敗します。

numSucceededTasks
  • integer

スケジュールに従って作成されたジョブの特定の時間範囲内に正常に完了したタスクの合計数。 終了コード 0 が返された場合、タスクは正常に完了します。

numTaskRetries
  • integer

スケジュールに従って作成されたすべてのジョブのすべてのタスクに対する、指定された時間範囲の再試行の合計数。

readIOGiB
  • number

スケジュールに従って作成されたすべてのジョブのすべてのタスクによってディスクから読み取られた合計ジビバイト数。

readIOps
  • integer

スケジュールに従って作成されたすべてのジョブのすべてのタスクによって行われたディスク読み取り操作の合計数。

startTime
  • string

統計の対象となる時間範囲の開始時刻。

url
  • string

統計の URL。

userCPUTime
  • string

スケジュールに従って作成されたすべてのジョブのすべてのタスクによって消費される合計ユーザー モードの CPU 時間 (すべてのコアとすべてのコンピューティング ノードで合計)。

waitTime
  • string

スケジュールに従って作成されたすべてのジョブのすべてのタスクの合計待機時間。 タスクの待機時間は、タスクの作成からタスク実行の開始までの経過時間として定義されます。 (失敗が原因でタスクが再試行された場合、待機時間は最新のタスク実行までの時間です)。
この値は、アカウントの有効期間の統計情報でのみ報告されます。ジョブ統計には含まれません。

wallClockTime
  • string

スケジュールに従って作成されたすべてのジョブのすべてのタスクの合計ウォール クロック時間。
ウォール クロック時間は、タスクがコンピューティング ノードで実行を開始してから完了するまでの経過時間です (それまでにタスクが完了していない場合は、統計が最後に更新された時刻まで)。 タスクが再試行された場合、これにはすべてのタスク再試行のウォール クロック時間が含まれます。

writeIOGiB
  • number

スケジュールに従って作成されたすべてのジョブのすべてのタスクによってディスクに書き込まれた合計ジビバイト数。

writeIOps
  • integer

スケジュールに従って作成されたすべてのジョブのすべてのタスクによって行われたディスク書き込み操作の合計数。

JobSpecification

スケジュールに従って作成するジョブの詳細を指定します。

Name Type Default Value Description
allowTaskPreemption
  • boolean

このジョブのタスクを他の優先度の高いジョブに割り込むことができるかどうか
値が True に設定されている場合、システムに送信された他の優先度の高いジョブが優先され、このジョブからタスクを再キューできます。 ジョブの allowTaskPreemption は、更新ジョブ API を使用して作成された後で更新できます。

commonEnvironmentSettings

一般的な環境変数設定の一覧。 これらの環境変数は、このスケジュールで作成されたジョブ内のすべてのタスク (ジョブ マネージャー、ジョブ準備タスク、ジョブ 解放タスクを含む) に設定されます。
個々のタスクは、同じ設定名を別の値で指定することで、ここで指定した環境設定をオーバーライドできます。

constraints

このスケジュールで作成されたジョブの実行制約。

displayName
  • string

このスケジュールで作成されたジョブの表示名。
名前は一意である必要はありません。最大長が 1024 の Unicode 文字を含めることができます。

jobManagerTask

このスケジュールでジョブが開始されたときに起動されるジョブ マネージャー タスクの詳細。
ジョブでジョブ マネージャー タスクが指定されていない場合、ユーザーは Task API を使用してジョブにタスクを明示的に追加する必要があります。 ジョブがジョブ マネージャー タスクを指定した場合、Batch サービスはジョブの作成時にジョブ マネージャー タスクを作成し、ジョブ内の他のタスクをスケジュールする前にジョブ マネージャー タスクのスケジュールを設定しようとします。

jobPreparationTask

このスケジュールで作成されたジョブのジョブ準備タスク。
ジョブにジョブ準備タスクがある場合、Batch サービスは、そのコンピューティング ノードでそのジョブのタスクを開始する前に、ノードでジョブ準備タスクを実行します。

jobReleaseTask

このスケジュールで作成されたジョブのジョブ解放タスク。
ジョブ解放タスクの主な目的は、ジョブ準備タスクによって行われたノードに対する変更を元に戻すことです。 アクティビティの例としては、ローカル ファイルの削除や、ジョブの準備の一環として開始されたサービスのシャットダウンなどがあります。 ジョブ解放タスクは、ジョブのジョブ準備タスクも指定しないと指定できません。 Batch サービスは、ジョブ準備タスクを実行したコンピューティング ノードでジョブ 解放タスクを実行します。

maxParallelTasks
  • integer
-1

ジョブに対して並列で実行できるタスクの最大数。
maxParallelTasks の値は、-1 または指定した場合は 0 より大きい値にする必要があります。 指定しない場合、既定値は -1 です。つまり、一度に実行できるタスクの数に制限はありません。 ジョブの maxParallelTasks は、更新ジョブ API を使用して作成された後で更新できます。

metadata

このスケジュールでメタデータとして作成された各ジョブに関連付けられている名前と値のペアの一覧。
Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。

networkConfiguration

ジョブのネットワーク構成。

onAllTasksComplete

このスケジュールで作成されたジョブのすべてのタスクが完了状態の場合に Batch サービスが実行する必要があるアクション。
ジョブにタスクが含まれている場合、すべてのタスクは完了と見なされることに注意してください。 したがって、このオプションは、ジョブ マネージャー タスクで最もよく使用されます。ジョブ マネージャーなしでジョブの自動終了を使用する場合は、最初に onAllTasksComplete を noaction に設定し、タスクの追加が完了したらジョブを終了するように onAllTasksComplete に設定するように Job プロパティを更新する必要があります。 既定値は noaction です。

onTaskFailure

このスケジュールで作成されたジョブでタスクが失敗したときに Batch サービスが実行する必要があるアクション。 タスクは、failureInfo がある場合に失敗したと見なされます。 failureInfo は、再試行回数を使い果たした後にタスクが 0 以外の終了コードで完了した場合、またはリソース ファイルのダウンロード エラーなどによってタスクの開始エラーが発生した場合に設定されます。
既定値は noaction です。

poolInfo

Batch サービスがこのスケジュールで作成されたジョブのタスクを実行するプール。

priority
  • integer

このスケジュールで作成されたジョブの優先順位。
優先度の値の範囲は -1000 から 1000 です。-1000 が最も低い優先度で、1000 が最高の優先度です。 既定値は 0 です。 この優先順位は、ジョブ スケジュールのすべてのジョブの既定値として使用されます。 ジョブの優先度は、ジョブの更新 API を使用して作成した後に更新できます。

usesTaskDependencies
  • boolean

ジョブ内のタスクが相互に依存関係を定義できるかどうか。 既定値は false です。

LinuxUserConfiguration

Linux コンピューティング ノードでユーザー アカウントを作成するために使用されるプロパティ。

Name Type Description
gid
  • integer

ユーザー アカウントのグループ ID。
uid プロパティと gid プロパティは、一緒に指定するか、まったく指定しない必要があります。 指定しない場合、基になるオペレーティング システムは gid を選択します。

sshPrivateKey
  • string

ユーザー アカウントの SSH 秘密キー。
秘密キーはパスワードで保護しないでください。 プールの enableInterNodeCommunication プロパティが true の場合 (enableInterNodeCommunication が false の場合は無視されます)、Linux プール内のコンピューティング ノード間で SSH の非対称キー ベースの認証を自動的に構成するために秘密キーが使用されます。 これを行うには、キー ペアをユーザーの .ssh ディレクトリに配置します。 指定しない場合、コンピューティング ノード間でパスワードレス SSH は構成されません (ユーザーの .ssh ディレクトリの変更は行われません)。

uid
  • integer

ユーザー アカウントのユーザー ID。
uid プロパティと gid プロパティは、一緒に指定するか、まったく指定しない必要があります。 指定しない場合、基になるオペレーティング システムは uid を選択します。

LoginMode

ユーザーのログイン モード

Name Type Description
batch
  • string

LOGON32_LOGON_BATCH Win32 ログイン モード。 バッチ ログイン モードは、実行時間の長い並列プロセスに推奨されます。

interactive
  • string

LOGON32_LOGON_INTERACTIVE Win32 ログイン モード。 WINDOWS VirtualMachineConfiguration プールで UAC が有効になっています。 このオプションを Windows VirtualMachineConfiguration プール内の管理者特権ユーザー ID と共に使用する場合、タスク コマンド ラインによって実行されるアプリケーションが常に管理特権を必要とするか、常に最大特権を必要とするように構成されていない限り、ユーザー セッションは昇格されません。

MetadataItem

Batch サービス リソースに関連付けられている名前と値のペア。

Name Type Description
name
  • string

メタデータ項目の名前。

value
  • string

メタデータ項目の値。

MountConfiguration

各ノードにマウントするファイル システム。

Name Type Description
azureBlobFileSystemConfiguration

各ノードで BLOB FUSE を使用してマウントするAzure Storage コンテナー。
このプロパティは、他のすべてのプロパティと相互に排他的です。

azureFileShareConfiguration

各ノードにマウントする Azure ファイル共有。
このプロパティは、他のすべてのプロパティと相互に排他的です。

cifsMountConfiguration

各ノードにマウントする CIFS/SMB ファイル システム。
このプロパティは、他のすべてのプロパティと相互に排他的です。

nfsMountConfiguration

各ノードにマウントする NFS ファイル システム。
このプロパティは、他のすべてのプロパティと相互に排他的です。

NetworkConfiguration

プールのネットワーク構成。

Name Type Description
dynamicVNetAssignmentScope

動的 vnet 割り当てのスコープ。

endpointConfiguration

Batch プール内のコンピューティング ノード上のエンドポイントの構成。
プール エンドポイントの構成は、virtualMachineConfiguration プロパティを持つプールでのみサポートされます。

publicIPAddressConfiguration

Batch プール内のコンピューティング ノードのパブリック IPAddress 構成。
パブリック IP 構成プロパティは、virtualMachineConfiguration プロパティを持つプールでのみサポートされます。

subnetId
  • string

プールのコンピューティング ノードが参加する仮想ネットワーク サブネットの ARM リソース識別子。 これは、/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}という形式です。
仮想ネットワークは、Azure Batch アカウントと同じリージョンとサブスクリプションに存在する必要があります。 指定されたサブネットには、プール内のコンピューティング ノードの数に対応できる十分な空き IP アドレスが必要です。 サブネットに十分な空き IP アドレスがない場合、プールは部分的にノードを割り当て、サイズ変更エラーが発生します。 "MicrosoftAzureBatch" サービス プリンシパルには、指定された VNet の "クラシック仮想マシン共同作成者" Role-Based Access Control (RBAC) ロールが必要です。 指定したサブネットは、ノードでタスクをスケジュールできるようにするために、Azure Batch サービスからの通信を許可する必要があります。 これは、指定された VNet にネットワーク セキュリティ グループ (NSG) が関連付けられているかどうかを確認することで確認できます。 指定したサブネット内のノードへの通信が NSG によって拒否された場合、Batch サービスはコンピューティング ノードの状態を使用不可に設定します。 virtualMachineConfiguration で作成されたプールでは ARM 仮想ネットワーク ('Microsoft.Network/virtualNetworks') のみがサポートされますが、cloudServiceConfiguration で作成されたプールでは ARM とクラシック仮想ネットワークの両方がサポートされます。 指定した VNet にネットワーク セキュリティ グループ (NSG) が関連付けられている場合、予約されているいくつかのシステム ポートの受信通信を有効にする必要があります。 仮想マシン構成で作成されたプールの場合は、ポート 29876 と 29877、Linux の場合はポート 22、Windowsの場合はポート 3389 を有効にします。 クラウド サービス構成で作成されたプールの場合は、ポート 10100、20100、および 30100 を有効にします。 また、ポート 443 でAzure Storageへの送信接続を有効にします。 詳細については、次を参照してください。 https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

受信エンドポイントに適用するネットワーク セキュリティ グループ規則。

Name Type Description
access

指定した IP アドレス、サブネット範囲、またはタグに対して実行する必要があるアクション。

priority
  • integer

このルールの優先度。
プール内の優先順位は一意である必要があり、優先順位の順に評価されます。 数値が低いほど、優先度は高くなります。 たとえば、順序番号が 150、250、350 のルールを指定できます。 順序番号が 150 のルールは、順序が 250 のルールよりも優先されます。 許可される優先順位は 150 から 4096 です。 予約済み値または重複値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。

sourceAddressPrefix
  • string

ルールに一致するソース アドレス プレフィックスまたはタグ。
有効な値は、1 つの IP アドレス (つまり、10.10.10.10)、IP サブネット (192.168.1.0/24)、既定のタグ、または * (すべてのアドレスの場合) です。 他の値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。

sourcePortRanges
  • string[]

ルールに一致するソース ポート範囲。
有効な値は、'' (すべてのポート 0 から 65535)、特定のポート (つまり 22) またはポート範囲 (つまり 100 から 200) です。ポートは 0 から 65535 の範囲である必要があります。このコレクション内の各エントリは、他のエントリ (範囲または個々のポート) と重複してはなりません。他の値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。既定値は '' です。

NetworkSecurityGroupRuleAccess

指定した IP アドレス、サブネット範囲、またはタグに対して実行する必要があるアクション。

Name Type Description
allow
  • string

アクセスを許可します。

deny
  • string

アクセスを拒否します。

NFSMountConfiguration

NFS ファイル システムへの接続に使用される情報。

Name Type Description
mountOptions
  • string

mount コマンドに渡す追加のコマンド ライン オプション。
これらは、Windowsの 'net use' オプションと Linux の 'mount' オプションです。

relativeMountPath
  • string

ファイル システムがマウントされるコンピューティング ノード上の相対パス
すべてのファイル システムは Batch マウント ディレクトリに対して相対的にマウントされ、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできます。

source
  • string

マウントするファイル システムの URI。

NodePlacementConfiguration

プールのノード配置の構成。

Name Type Description
policy

Batch プールでのノード配置ポリシーの種類。
Batch Service がノードをプロビジョニングするために使用する割り当てポリシー。 指定しない場合、Batch はリージョン ポリシーを使用します。

NodePlacementPolicyType

プール内のノードを割り当てる配置ポリシー。

Name Type Description
regional
  • string

プール内のすべてのノードは、同じリージョンに割り当てられます。

zonal
  • string

プール内のノードは、ベスト エフォート分散を使用して異なる可用性ゾーンに分散されます。

OnAllTasksComplete

ジョブ内のすべてのタスクが完了状態のときに Batch サービスが実行する必要があるアクション。

Name Type Description
noaction
  • string

何もしない。 他の方法で終了または無効にされない限り、ジョブはアクティブなままになります。

terminatejob
  • string

ジョブを終了します。 ジョブの terminateReason が 'AllTasksComplete' に設定されています。

OnTaskFailure

ジョブ内のタスクが失敗したときに Batch サービスが実行する必要があるアクション。

Name Type Description
noaction
  • string

何もしない。 他の方法で終了または無効にされない限り、ジョブはアクティブなままになります。

performexitoptionsjobaction
  • string

タスクの exitConditions コレクションの Task 終了条件に関連付けられているアクションを実行します。 (タスクで指定されている場合は、引き続きアクションが実行されない可能性があります)。

OSDisk

コンピューティング ノード (VM) のオペレーティング システム ディスクの設定。

Name Type Description
ephemeralOSDiskSettings

コンピューティング ノード (VM) によって使用されるオペレーティング システム ディスクのエフェメラル ディスク 設定を指定します。

OutputFile

Batch サービスがタスク プロセスの実行を完了した後、Azure Batch コンピューティング ノードから別の場所にファイルをアップロードするための仕様。

Name Type Description
destination

出力ファイルの保存先。

filePattern
  • string

アップロードするファイルを示すパターン。
相対パスと絶対パスの両方がサポートされています。 相対パスは、Task 作業ディレクトリに対する相対パスです。 次のワイルドカードがサポートされています。 * は 0 個以上の文字に一致します (たとえば、パターン abc* は abc または abcdef と一致します)、** は任意のディレクトリに一致します。? は任意の 1 文字に一致し、[abc] は角かっこ内の 1 文字に一致し、[a-c] は範囲内の 1 文字と一致します。 角かっこには、指定されていない任意の文字に一致する否定を含めることができます (例: [!abc] は、a、b、または c 以外の任意の文字と一致します)。 ファイル名が "." で始まる場合、既定では無視されますが、明示的に指定することで一致する場合があります (たとえば 、.gif は .a.gif と一致しませんが、..gif は一致 します)。 簡単な例: ***.txt は、'.' で始まらないファイルと一致し、タスク作業ディレクトリまたはサブディレクトリ内の.txtで終わります。 ファイル名にワイルドカード文字が含まれている場合は、角かっこを使用してエスケープできます (たとえば、abc[] は abc という名前のファイルと一致します)。 \ と / の両方は、Windowsではディレクトリ区切り記号として扱われますが、Linux 上では /のみであることに注意してください。 環境変数 (Windows の場合は %var%、Linux では $var) は、パターンが適用される前に展開されます。

uploadOptions

アップロード操作の追加オプション (アップロードを実行する条件を含む)。

OutputFileBlobContainerDestination

Azure BLOB ストレージ コンテナー内のファイルアップロード先を指定します。

Name Type Description
containerUrl
  • string

ファイルをアップロードするAzure Blob Storage内のコンテナーの URL。
マネージド ID を使用しない場合、URL には、コンテナーへの書き込みアクセス許可を付与する Shared Access Signature (SAS) が含まれている必要があります。

identityReference

containerUrl で指定されたAzure Blob Storageへのアクセスに使用するユーザー割り当て ID への参照
ID には、Azure Blob Storage コンテナーへの書き込みアクセス権が必要です

path
  • string

Azure Storage コンテナー内のターゲット BLOB または仮想ディレクトリ。
filePattern が特定のファイルを参照している場合 (つまり、ワイルドカードが含まれています)、パスはそのファイルをアップロードする BLOB の名前です。 filePattern に 1 つ以上のワイルドカードが含まれている場合 (したがって、複数のファイルと一致する場合があります)、パスは、ファイルをアップロードする BLOB 仮想ディレクトリの名前 (各 BLOB 名の前に付加されます) です。 省略すると、ファイル名と一致する BLOB 名を使用して、コンテナーのルートにファイルがアップロードされます。

uploadHeaders

出力ファイルのアップロードに使用するヘッダーの名前と値のペアの一覧
これらのヘッダーは、ファイルをAzure Storageにアップロードするときに指定されます。 詳細については、「 要求ヘッダー (すべての BLOB の種類)」を参照してください

OutputFileDestination

ファイルのアップロード先。

Name Type Description
container

ファイルのアップロード先となる Azure BLOB ストレージ内の場所。

OutputFileUploadCondition

タスク出力ファイルまたは一連のファイルをアップロードする条件。

Name Type Description
taskcompletion
  • string

終了コードが何であったかにかかわらず、タスク プロセスが終了した後にファイルをアップロードします。

taskfailure
  • string

タスク プロセスが 0 以外の終了コードで終了した後にのみ、ファイルをアップロードします。

tasksuccess
  • string

タスク プロセスが終了コード 0 で終了した後にのみ、ファイルをアップロードします。

OutputFileUploadOptions

アップロードを実行する条件を含む、出力ファイルのアップロード操作に関する詳細。

Name Type Description
uploadCondition

タスク出力ファイルまたは一連のファイルをアップロードする条件。
既定値は taskcompletion です。

PoolEndpointConfiguration

プールのエンドポイント構成。

Name Type Description
inboundNATPools

個々のコンピューティング ノードの特定のポートを外部でアドレス指定するために使用できる受信 NAT プールの一覧。
バッチ プールあたりの受信 NAT プールの最大数は 5 です。 受信 NAT プールの最大数を超えた場合、要求は HTTP 状態コード 400 で失敗します。 IPAddressProvisioningType が NoPublicIPAddresses の場合、これは指定できません。

PoolInformation

ジョブをプールに割り当てる方法を指定します。

Name Type Description
autoPoolSpecification

一時 '自動プール' の特性。 Batch サービスは、ジョブの送信時にこの自動プールを作成します。
プールの自動作成が失敗した場合、Batch サービスはジョブを完了状態に移動し、プール作成エラーはジョブのスケジューリング エラー プロパティに設定されます。 Batch サービスは、自動プールの有効期間 (keepAlive が指定されていない場合は削除) を管理します。 ジョブがアクティブな間に自動プールの有効期間に影響を与えるユーザー アクションは、予期しない動作になります。 プール ID または自動プール仕様を指定する必要がありますが、両方は指定しないでください。

poolId
  • string

既存のプールの ID。 ジョブのすべてのタスクは、指定されたプールで実行されます。
このプロパティによって参照されるプールが存在することを確認する必要があります。 Batch サービスがジョブをスケジュールしようとしたときにプールが存在しない場合、その ID を持つプールを作成するまで、ジョブのタスクは実行されません。Batch サービスはジョブ要求を拒否しないことに注意してください。プールが存在するまでタスクは実行されません。 プール ID または自動プール仕様を指定する必要がありますが、両方は指定しないでください。

PoolLifetimeOption

作成された自動プールの最小有効期間と、スケジュール上の複数のジョブをプールに割り当てる方法。

Name Type Description
job
  • string

プールは、専用のジョブの有効期間中存在します。 Batch サービスは、ジョブの作成時にプールを作成します。 ジョブ スケジュールに "job" オプションが適用されている場合、Batch サービスは、スケジュールに従って作成されたすべてのジョブに対して新しい自動プールを作成します。

jobschedule
  • string

プールはジョブ スケジュールの有効期間中存在します。 Batch サービスは、スケジュールに基づいて最初のジョブを作成するときにプールを作成します。 このオプションは、ジョブではなくジョブ スケジュールにのみ適用できます。

PoolSpecification

新しいプールを作成するための仕様。

Name Type Description
applicationLicenses
  • string[]

Batch サービスがプール内の各コンピューティング ノードで使用できるアプリケーション ライセンスの一覧。
アプリケーション ライセンスの一覧は、使用可能な Batch サービス アプリケーション ライセンスのサブセットである必要があります。 サポートされていないライセンスが要求された場合、プールの作成は失敗します。 プールで使用できるライセンスは、'maya'、'vray'、'3dsmax'、'arnold' です。 プールに追加されるアプリケーション ライセンスごとに追加料金が適用されます。

applicationPackageReferences

プール内の各コンピューティング ノードにインストールするパッケージの一覧。
パッケージ参照への変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、プールに既に存在するコンピューティング ノードには影響しません。 特定のプールには最大 10 個のパッケージ参照があります。

autoScaleEvaluationInterval
  • string

自動スケールの数式に従ってプール サイズを自動的に調整する時間間隔。
既定値は 15 分です。 最小値と最大値はそれぞれ 5 分と 168 時間です。 5 分未満または 168 時間を超える値を指定した場合、Batch サービスは無効なプロパティ値エラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。

autoScaleFormula
  • string

プール内のコンピューティング ノードの目的の数の数式。
enableAutoScale が false に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が true に設定されている場合は必須です。 プールが作成される前に、数式の有効性がチェックされます。 式が無効な場合、Batch サービスは詳細なエラー情報を含む要求を拒否します。

certificateReferences

プール内の各コンピューティング ノードにインストールする証明書の一覧。
Windows ノードの場合、Batch サービスは指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、証明書がそのディレクトリに配置されます。

cloudServiceConfiguration

プールのクラウド サービス構成。
プールを Azure PaaS VM で作成する必要がある場合は、このプロパティを指定する必要があります。 このプロパティと virtualMachineConfiguration は相互に排他的であり、プロパティの 1 つを指定する必要があります。 どちらも指定されていない場合、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 batch アカウントが poolAllocationMode プロパティを 'UserSubscription' に設定して作成された場合、このプロパティを指定できません。

displayName
  • string

プールの表示名。
表示名は一意である必要はありません。最大長が 1024 の Unicode 文字を含めることができます。

enableAutoScale
  • boolean

プール サイズが時間の経過と同時に自動的に調整されるかどうか。
false の場合、targetDedicatedNodes と targetLowPriorityNodes の少なくとも 1 つを指定する必要があります。 true の場合、autoScaleFormula 要素が必要です。 プールは、数式に従って自動的にサイズ変更されます。 既定値は false です。

enableInterNodeCommunication
  • boolean

プールがコンピューティング ノード間の直接通信を許可するかどうか。
ノード間通信を有効にすると、プールのコンピューティング ノードのデプロイ制限により、プールの最大サイズが制限されます。 これにより、プールが目的のサイズに達しない可能性があります。 既定値は false です。

metadata

メタデータとしてプールに関連付けられている名前と値のペアの一覧。
Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。

mountConfiguration

プール内の各ノードにマウントするファイル システムの一覧。
これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。

networkConfiguration

プールのネットワーク構成。
プールのネットワーク構成。

resizeTimeout
  • string

プールへのコンピューティング ノードの割り当てタイムアウト。
このタイムアウトは、手動スケーリングにのみ適用されます。enableAutoScale が true に設定されている場合は影響しません。 既定値は 15 分です。 最小値は 5 分です。 5 分未満の値を指定した場合、Batch サービスはエラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。

startTask

プールに参加する各コンピューティング ノードで実行するタスク。 このタスクは、コンピューティング ノードがプールに追加されたとき、またはコンピューティング ノードが再起動されたときに実行されます。
Batch は、ノードで復旧操作がトリガーされたときにタスクを再試行します。 復旧操作の例としては、異常なノードが再起動されたときや、ホストの障害によってコンピューティング ノードが消えた場合 (ただし、これらに限定されません) があります。 回復操作による再試行は独立しており、maxTaskRetryCount に対してカウントされません。 maxTaskRetryCount が 0 の場合でも、復旧操作による内部再試行が発生する可能性があります。 このため、すべてのタスクはべき等である必要があります。 つまり、タスクは、破損や重複データを発生させることなく、中断および再起動を許容する必要があります。 実行時間の長いタスクのベスト プラクティスは、何らかの形式のチェックポイント処理を使用することです。 場合によっては、コンピューティング ノードが再起動されなかった場合でも、StartTask が再実行されることがあります。 中断プロセスを作成したり、StartTask 作業ディレクトリからサービスをインストール/起動したりする StartTask を回避するには、特別な注意が必要です。これにより、Batch が StartTask を再実行できなくなります。

targetDedicatedNodes
  • integer

プール内の専用コンピューティング ノードの必要な数。
enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。

targetLowPriorityNodes
  • integer

プール内のスポット/優先順位の低いコンピューティング ノードの必要な数。
enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。

taskSchedulingPolicy

プール内のコンピューティング ノード間でタスクを分散する方法。
指定しない場合、既定値はスプレッドです。

taskSlotsPerNode
  • integer

プール内の単一の計算ノードで同時実行タスクを実行するために使用できるタスク スロットの数。
既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。

userAccounts

プール内の各コンピューティング ノードに作成するユーザー アカウントの一覧。

virtualMachineConfiguration

プールの仮想マシンの構成。
プールを Azure IaaS VM で作成する必要がある場合は、このプロパティを指定する必要があります。 このプロパティと cloudServiceConfiguration は相互に排他的であり、いずれかのプロパティを指定する必要があります。 どちらも指定されていない場合、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。

vmSize
  • string

プール内の仮想マシンのサイズ。 プール内のすべての仮想マシンのサイズは同じです。
プール内の仮想マシンの使用可能なサイズについては、「Azure Batch プール内のコンピューティング ノードの VM サイズの選択 ()https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes」を参照してください。

PublicIPAddressConfiguration

プールのネットワーク構成のパブリック IP アドレス構成。

Name Type Description
ipAddressIds
  • string[]

コンピューティング ノードのプロビジョニング時に Batch サービスが使用するパブリック IP の一覧。
ここで指定する IP の数によって、プールの最大サイズが制限されます。パブリック IP ごとに 100 個の専用ノードまたは 100 個のスポット/低優先度ノードを割り当てることができます。 たとえば、250 個の専用 VM を必要とするプールでは、少なくとも 3 つのパブリック IP が指定されている必要があります。 このコレクションの各要素は、/subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}という形式です。

provision

プールのパブリック IP アドレスのプロビジョニングの種類。
既定値は BatchManaged です。

RecentJob

ジョブ スケジュールで実行する最新のジョブに関する情報。

Name Type Description
id
  • string

ジョブの ID。

url
  • string

ジョブの URL。

ResourceFile

コンピューティング ノードにダウンロードする 1 つのファイルまたは複数のファイル。

Name Type Description
autoStorageContainerName
  • string

自動ストレージ アカウントのストレージ コンテナー名。
autoStorageContainerName、storageContainerUrl、httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。

blobPrefix
  • string

Azure Storage コンテナーから BLOB をダウンロードするときに使用する BLOB プレフィックス。 指定したプレフィックスで始まる名前の BLOB のみがダウンロードされます。
このプロパティは、autoStorageContainerName または storageContainerUrl が使用されている場合にのみ有効です。 このプレフィックスには、部分的なファイル名またはサブディレクトリを指定できます。 プレフィックスが指定されていない場合、コンテナー内のすべてのファイルがダウンロードされます。

fileMode
  • string

ファイルアクセス許可モード属性 (8 進数形式)。
このプロパティは、Linux コンピューティング ノードにダウンロードされるファイルにのみ適用されます。 Windowsコンピューティング ノードにダウンロードされる resourceFile に対して指定されている場合は無視されます。 Linux コンピューティング ノードにこのプロパティが指定されていない場合、既定値の 0770 がファイルに適用されます。

filePath
  • string

タスクの作業ディレクトリを基準にして、ファイルをダウンロードするコンピューティング ノード上の場所。
httpUrl プロパティが指定されている場合、filePath が必要であり、ファイル名を含む、ファイルのダウンロード先のパスが記述されます。 それ以外の場合、autoStorageContainerName または storageContainerUrl プロパティが指定されている場合、filePath は省略可能であり、ファイルをダウンロードするディレクトリです。 filePath をディレクトリとして使用する場合、入力データに既に関連付けられているディレクトリ構造は完全に保持され、指定された filePath ディレクトリに追加されます。 指定した相対パスは、タスクの作業ディレクトリから抜け出すことはできません (たとえば、'..' を使用)。

httpUrl
  • string

ダウンロードするファイルの URL。
autoStorageContainerName、storageContainerUrl、httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。 URL がAzure Blob Storageを指している場合は、コンピューティング ノードから読み取ることができる必要があります。 Azure Storage 内の BLOB のこのような URL を取得するには、BLOB に対する読み取りアクセス許可を付与する Shared Access Signature (SAS) を含めるか、読み取りアクセス許可を持つマネージド ID を使用するか、BLOB またはそのコンテナーの ACL を設定してパブリック アクセスを許可するという 3 つの方法があります。

identityReference

storageContainerUrl または httpUrl で指定されたAzure Blob Storageにアクセスするために使用するユーザー割り当て ID への参照
コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。

storageContainerUrl
  • string

Azure Blob Storage内の BLOB コンテナーの URL。
autoStorageContainerName、storageContainerUrl、httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。 この URL は、コンピューティング ノードから読み取り可能でリスト可能である必要があります。 Azure Storage 内のコンテナーのこのような URL を取得するには、3 つの方法があります。コンテナーに対する読み取りとリストのアクセス許可を付与する Shared Access Signature (SAS) を含めるか、読み取りとリストのアクセス許可を持つマネージド ID を使用するか、コンテナーの ACL を設定してパブリック アクセスを許可します。

Schedule

ジョブが作成されるスケジュール。 すべての時刻は UTC にそれぞれ固定され、夏時間の影響を受けません。

Name Type Description
doNotRunAfter
  • string

このジョブ スケジュールの下にジョブが作成されない時間。 スケジュールは、この期限が過ぎ、このジョブ スケジュールの下にアクティブなジョブがないとすぐに完了状態に移行します。
doNotRunAfter 時刻を指定せず、定期的なジョブ スケジュールを作成する場合、ジョブ スケジュールは明示的に終了するまでアクティブなままになります。

doNotRunUntil
  • string

このジョブ スケジュールの下でジョブを作成できる最も早い時刻。
doNotRunUntil 時間を指定しない場合、スケジュールはすぐにジョブを作成する準備が整います。

recurrenceInterval
  • string

ジョブ スケジュールの下の 2 つの連続するジョブの開始時刻の時間間隔。 ジョブ スケジュールには、任意の時点でアクティブなジョブを 1 つまで指定できます。
ジョブ スケジュールは、ジョブ スケジュールで新しいジョブを作成する場合に、ジョブ スケジュールの下にアクティブなジョブを 1 つまで保持できるため、前のジョブがまだ実行されている場合、Batch サービスは前のジョブが完了するまで新しいジョブを作成しません。 前のジョブが新しい recurrenceInterval の startWindow 期間内に終了しない場合、その期間に新しいジョブはスケジュールされません。 定期的なジョブの場合は、通常、jobSpecification で jobManagerTask を指定する必要があります。 jobManagerTask を使用しない場合は、ジョブの作成時を監視し、タスクをジョブに追加して、次の繰り返しの準備ができたジョブを終了する外部プロセスが必要になります。 既定では、スケジュールは繰り返されません。doNotRunUntil 時間の後に startWindow 内に 1 つのジョブが作成され、ジョブが完了するとすぐにスケジュールが完了します。 最小値は 1 分です。 小さい値を指定すると、Batch サービスはエラーでスケジュールを拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。

startWindow
  • string

スケジュールがジョブを作成する必要があることを示す時刻から開始する時間間隔。その中でジョブを作成する必要があります。
startWindow 期間内にジョブが作成されない場合、"営業案件" は失われます。スケジュールの次の繰り返しまでジョブは作成されません。 スケジュールが定期的で、startWindow が繰り返し間隔よりも長い場合、これは無限の startWindow に相当します。これは、1 つの recurrenceInterval の "期限" のジョブが次の繰り返し間隔に繰り返されないためです。 既定値は infinite です。 最小値は 1 分です。 小さい値を指定すると、Batch サービスはエラーでスケジュールを拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。

StartTask

ノードがAzure Batch サービスのプールに参加するとき、またはコンピューティング ノードが再起動または再イメージ化されたときに実行されるタスク。

Name Type Description
commandLine
  • string

StartTask のコマンド ライン。
コマンド ラインはシェルでは実行されないため、環境変数の展開などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windowsの "cmd /c MyCommand" や Linux の "/bin/sh -c MyCommand" を使用します。 コマンド ラインがファイル パスを参照する場合は、相対パス (Task 作業ディレクトリに対する相対パス) を使用するか、Batch で指定された環境変数 (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) を使用する必要があります。

containerSettings

StartTask を実行するコンテナーの設定。
これを指定すると、AZ_BATCH_NODE_ROOT_DIRの下にあるすべてのディレクトリ (ノード上のAzure Batch ディレクトリのルート) がコンテナーに再帰的にマップされ、すべての Task 環境変数がコンテナーにマップされ、タスク コマンド ラインがコンテナーで実行されます。 AZ_BATCH_NODE_ROOT_DIR外のコンテナーで生成されたファイルはホスト ディスクに反映されない可能性があります。つまり、Batch ファイル API はそれらのファイルにアクセスできません。

environmentSettings

StartTask の環境変数設定の一覧。

maxTaskRetryCount
  • integer

タスクを再試行できる最大回数。
終了コードが 0 以外の場合、Batch サービスは Task を再試行します。 この値によって再試行の回数が限定されますのでご注意ください。 Batch サービスはタスクを 1 回試し、この制限まで再試行できます。 たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (1 回の最初の再試行と 3 回の再試行)。 最大再試行回数が 0 の場合、Batch サービスはタスクを再試行しません。 最大再試行回数が -1 の場合、Batch サービスは制限なくタスクを再試行しますが、開始タスクまたはタスクには推奨されません。 既定値は 0 です (再試行なし)

resourceFiles

コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。 リソース ファイルの一覧には最大サイズがあります。 最大サイズを超えると、要求は失敗し、応答エラー コードは RequestEntityTooLarge になります。 この場合、ResourceFiles のコレクションのサイズを小さくする必要があります。 これは、.zip ファイル、アプリケーション パッケージ、または Docker コンテナーを使用して実現できます。
この要素の下に一覧表示されるファイルは、タスクの作業ディレクトリにあります。

userIdentity

StartTask を実行するユーザー ID。
省略した場合、タスクはタスクに固有の管理以外のユーザーとして実行されます。

waitForSuccess
  • boolean

コンピューティング ノードでタスクをスケジュールする前に、Batch サービスが StartTask が正常に完了するまで (つまり、終了コード 0 で終了する) のを待つ必要があるかどうか。
True の場合、StartTask がノードで失敗すると、Batch サービスは StartTask を最大再試行回数 (maxTaskRetryCount) まで再試行します。 すべての再試行の後もタスクが正常に完了していない場合、Batch サービスはノードを使用不能としてマークし、タスクをスケジュールしません。 この条件は、コンピューティング ノードの状態とエラー情報の詳細を使用して検出できます。 false の場合、Batch サービスは StartTask の完了を待機しません。 この場合、StartTask がまだ実行されている間に、コンピューティング ノードで他のタスクの実行を開始できます。StartTask が失敗した場合でも、新しいタスクはコンピューティング ノードで引き続きスケジュールされます。 既定値は true です。

StorageAccountType

データ ディスクの作成に使用するストレージ アカウントの種類。

Name Type Description
premium_lrs
  • string

データ ディスクでは、Premium ローカル冗長ストレージを使用する必要があります。

standard_lrs
  • string

データ ディスクでは、標準のローカル冗長ストレージを使用する必要があります。

TaskConstraints

タスクに適用する実行制約。

Name Type Description
maxTaskRetryCount
  • integer

タスクを再試行できる最大回数。 終了コードが 0 以外の場合、Batch サービスはタスクを再試行します。
この値は、0 以外の終了コードが原因で Task 実行可能ファイルの再試行回数を特に制御します。 Batch サービスはタスクを 1 回試し、この制限まで再試行できます。 たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (初回試行 1 回、再試行回数 3 回)。 最大再試行回数が 0 の場合、Batch サービスは最初の試行後にタスクを再試行しません。 最大再試行回数が -1 の場合、Batch サービスは制限なしでタスクを再試行しますが、開始タスクまたはタスクには推奨されません。 既定値は 0 です (再試行なし)

maxWallClockTime
  • string

タスクが実行できる最大経過時間。タスクが開始された時間から測定されます。 タスクが期限内に完了しない場合は、Batch サービスによって終了されます。
これが指定されていない場合、タスクの実行時間に時間制限はありません。

retentionTime
  • string

実行が完了した時点から、実行されたコンピューティング ノードに Task ディレクトリを保持する最小時間。 この時間が経過すると、Batch サービスによって Task ディレクトリとそのすべての内容が削除される可能性があります。
既定値は 7 日間です。つまり、コンピューティング ノードが削除されるか、ジョブが削除されない限り、タスク ディレクトリは 7 日間保持されます。

TaskContainerSettings

タスクのコンテナー設定。

Name Type Description
containerRunOptions
  • string

コンテナー作成コマンドの追加オプション。
これらの追加オプションは、Batch サービスによって制御されるオプションに加えて、"docker create" コマンドの引数として提供されます。

imageName
  • string

タスクが実行されるコンテナーの作成に使用するイメージ。
これは、"docker pull" に指定されているように、完全なイメージ参照です。 イメージ名の一部としてタグが指定されていない場合は、タグ ":latest" が既定として使用されます。

registry

コンテナー イメージを含むプライベート レジストリ。
プールの作成時に既に指定されている場合は、この設定を省略できます。

workingDirectory

コンテナータスク作業ディレクトリの場所。
既定値は 'taskWorkingDirectory' です。

TaskSchedulingPolicy

コンピューティング ノード間でタスクを分散する方法を指定します。

Name Type Description
nodeFillType

プール内のコンピューティング ノード間でタスクを分散する方法。
指定しない場合、既定値はスプレッドです。

UserAccount

Azure Batch コンピューティング ノードでタスクを実行するために使用するユーザーの作成に使用されるプロパティ。

Name Type Description
elevationLevel

ユーザー アカウントの昇格レベル。
既定値は nonAdmin です。

linuxUserConfiguration

ユーザー アカウントの Linux 固有のユーザー構成。
Windows プールで指定した場合、このプロパティは無視されます。 指定しない場合、ユーザーは既定のオプションで作成されます。

name
  • string

ユーザー アカウントの名前。

password
  • string

ユーザー アカウントのパスワード。

windowsUserConfiguration

ユーザー アカウントのWindows固有のユーザー構成。
このプロパティは、ユーザーが Windows プールに存在する場合にのみ指定できます。 Windows プールで指定されていない場合は、既定のオプションを使用してユーザーが作成されます。

UserIdentity

タスクを実行するユーザー ID の定義。

Name Type Description
autoUser

タスクを実行する自動ユーザー。
userName プロパティと autoUser プロパティは相互に排他的です。1 つを指定する必要がありますが、両方を指定する必要はありません。

username
  • string

タスクを実行するユーザー ID の名前。
userName プロパティと autoUser プロパティは相互に排他的です。1 つを指定する必要がありますが、両方を指定する必要はありません。

VirtualMachineConfiguration

Azure Virtual Machines インフラストラクチャに基づくプール内のコンピューティング ノードの構成。

Name Type Description
containerConfiguration

プールのコンテナー構成。
指定した場合、タスクをコンテナーで実行できるように、プール内の各コンピューティング ノードに対してセットアップが実行されます。 このプールで実行されるすべての通常のタスクとジョブ マネージャー タスクは containerSettings プロパティを指定する必要があり、他のすべてのタスクで指定できます。

dataDisks

プール内のコンピューティング ノードに接続されているデータ ディスクの構成。
プール内のコンピューティング ノードに空のデータ ディスクが接続されている必要がある場合は、このプロパティを指定する必要があります。 これは更新できません。 各コンピューティング ノードは、独自のディスクを取得します (ディスクはファイル共有ではありません)。 既存のディスクは接続できません。接続されている各ディスクは空です。 コンピューティング ノードがプールから削除されると、ディスクとそのノードに関連付けられているすべてのデータも削除されます。 ディスクは接続後にフォーマットされません。使用する前にフォーマットする必要があります。詳細については、以下をhttps://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine参照してくださいhttps://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux

diskEncryptionConfiguration

プールのディスク暗号化構成。
指定した場合、暗号化は、ノードのプロビジョニング中にプール内の各ノードで実行されます。

extensions

プールの仮想マシン拡張機能。
指定した場合、この構成で説明されている拡張機能が各ノードにインストールされます。

imageReference

使用する Azure Virtual Machines Marketplace イメージまたはカスタム仮想マシン イメージへの参照。

licenseType
  • string

オペレーティング システムの展開時に使用するオンプレミス ライセンスの種類。
これは、Windows オペレーティング システムを含むイメージにのみ適用され、デプロイされるコンピューティング ノードに対して有効なオンプレミス ライセンスを保持している場合にのみ使用する必要があります。 省略した場合、オンプレミスのライセンス割引は適用されません。 値は次のとおりです。

Windows_Server - オンプレミス ライセンスは Windows Server 用です。 Windows_Client - オンプレミス ライセンスは、Windows クライアント用です。

nodeAgentSKUId
  • string

プール内のコンピューティング ノードにプロビジョニングされる Batch コンピューティング ノード エージェントの SKU。
Batch コンピューティング ノード エージェントは、プール内の各コンピューティング ノードで実行され、コンピューティング ノードと Batch サービスの間のコマンドと制御インターフェイスを提供するプログラムです。 コンピューティング ノード エージェントの実装は、SKU と呼ばれ、オペレーティング システムごとに異なります。 選択したイメージ参照に一致するコンピューティング ノード エージェント SKU を指定する必要があります。 サポートされているコンピューティング ノード エージェント SKU の一覧と検証済みイメージ参照の一覧を取得するには、「サポートされているコンピューティング ノード エージェント SKU の一覧」操作を参照してください。

nodePlacementConfiguration

プールのノード配置の構成。
この構成では、プール内のノードを物理的に割り当てる方法に関する規則を指定します。

osDisk

仮想マシンのオペレーティング システム ディスクの設定。

windowsConfiguration

仮想マシンのオペレーティング システム設定をWindowsします。
imageReference プロパティで Linux OS イメージが指定されている場合は、このプロパティを指定しないでください。

VMExtension

仮想マシン拡張機能の構成。

Name Type Description
autoUpgradeMinorVersion
  • boolean

展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。

name
  • string

仮想マシン拡張機能の名前。

protectedSettings
  • object

拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。

provisionAfterExtensions
  • string[]

拡張機能名のコレクション。
この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。

publisher
  • string

拡張機能ハンドラーの発行元の名前。

settings
  • object

拡張機能の JSON 形式のパブリック設定。

type
  • string

拡張機能の型。

typeHandlerVersion
  • string

スクリプト ハンドラーのバージョン。

WindowsConfiguration

仮想マシンに適用するオペレーティング システムの設定をWindowsします。

Name Type Description
enableAutomaticUpdates
  • boolean

仮想マシンで自動更新が有効になっているかどうか。
省略した場合、既定値は true です。

WindowsUserConfiguration

Windowsコンピューティング ノードでユーザー アカウントを作成するために使用されるプロパティ。

Name Type Description
loginMode

ユーザーのログイン モード
VirtualMachineConfiguration プールの既定値は "batch" で、CloudServiceConfiguration プールの既定値は "対話型" です。