Job Schedule - List

Service:

Batch Service

API Version:

2023-11-01.18.0

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

GET {batchUrl}/jobschedules?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobschedules?$filter={$filter}&$select={$select}&$expand={$expand}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

URI パラメーター

名前	/	必須	型	説明
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"

名前	必須	型	説明
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 を直接呼び出す場合は、明示的に設定します。

応答

名前	型	説明
200 OK	CloudJobScheduleListResult	ジョブ スケジュールの一覧を含む応答。 Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch サービスからのエラー。

セキュリティ

azure_auth

Microsoft Entra OAuth 2.0 認証コード フロー

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

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

Authorization

Type: apiKey
In: header

例

JobSchedule list

Sample Request

HTTP

GET account.region.batch.azure.com/jobschedules?api-version=2023-11-01.18.0

Sample Response

Status code:

200

{
  "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"
      }
    }
  ]
}

定義

名前	説明
AccessScope	トークンがアクセスを許可する Batch リソース。
ApplicationPackageReference	コンピューティング ノードにデプロイするパッケージへの参照。
AuthenticationTokenSettings	Batch サービス操作の実行にタスクが使用できる認証トークンの設定。
AutoPoolSpecification	一時 '自動プール' の特性を指定します。 Batch サービスは、ジョブの送信時にこの自動プールを作成します。
AutoUserScope	自動ユーザーのスコープ
AutoUserSpecification	Batch サービスで Task を実行する自動ユーザーのパラメーターを指定します。
AzureBlobFileSystemConfiguration	Blobfuse を使用して Azure Storage コンテナーに接続するために使用される情報。
AzureFileShareConfiguration	Azure Fileshare への接続に使用される情報。
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batchエラー応答に含まれる追加情報の項目。
CachingType	ディスクに対して有効にするキャッシュの種類。
CertificateReference	プール内のコンピューティング ノードにインストールされる証明書への参照。
CertificateStoreLocation	証明書をインストールするコンピューティング ノード上の証明書ストアの場所。
CertificateVisibility	証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。
CIFSMountConfiguration	CIFS ファイル システムへの接続に使用される情報。
CloudJobSchedule	ジョブを実行するタイミングと各ジョブの作成に使用する仕様を指定して、定期的なジョブを許可するジョブ スケジュール。
CloudJobScheduleListResult	アカウントにジョブ スケジュールを一覧表示した結果。
CloudServiceConfiguration	Azure Cloud Services プラットフォームに基づくプール内のコンピューティング ノードの構成。
ComputeNodeFillType	プール内のコンピューティング ノード間でタスクを分散する方法。
ComputeNodeIdentityReference	コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。
ContainerConfiguration	コンテナーが有効なプールの構成。
ContainerRegistry	プライベート コンテナー レジストリ。
ContainerType	使用するコンテナー テクノロジ。
ContainerWorkingDirectory	コンテナー Task 作業ディレクトリの場所。
DataDisk	プール内のコンピューティング ノードに関連付けられているデータ ディスクによって使用される設定。 添付データ ディスクを含める場合は、それらを使用する VM 内からディスクを マウントおよびフォーマットする必要があります。
DiffDiskPlacement	プール内のすべてのコンピューティング ノード (VM) のオペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。
DiffDiskSettings	コンピューティング ノード (VM) によって使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。
DiskEncryptionConfiguration	プール内のコンピューティング ノードに適用されるディスク暗号化構成。 ディスク暗号化の構成は、Azure Compute Gallery イメージで作成された Linux プールではサポートされていません。
DiskEncryptionTarget	Batch Service がコンピューティング ノードで暗号化するディスク ターゲットの一覧。
DynamicVNetAssignmentScope	動的 vnet 割り当てのスコープ。
ElevationLevel	ユーザーの昇格レベル。
EnvironmentSetting	タスク プロセスで設定する環境変数。
ErrorMessage	Azure Batch エラー応答で受信したエラー メッセージ。
HttpHeader	HTTP ヘッダーの名前と値のペア
ImageReference	Azure Virtual Machines Marketplace イメージまたは Azure Compute Gallery イメージへの参照。 Azure Batchによって検証されたすべてのAzure Marketplaceイメージ参照の一覧を取得するには、「サポートされているイメージの一覧表示」操作を参照してください。
InboundEndpointProtocol	エンドポイントのプロトコル。
InboundNATPool	Batch プール内のコンピューティング ノード上の特定のポートを外部でアドレス指定するために使用できる受信 NAT プール。
IPAddressProvisioningType	プールのパブリック IP アドレスのプロビジョニングの種類。
JobConstraints	ジョブの実行制約。
JobManagerTask	ジョブ マネージャー タスクの詳細を指定します。
JobNetworkConfiguration	ジョブのネットワーク構成。
JobPreparationTask	特定のコンピューティング ノードでジョブのタスクの前に実行するジョブ準備タスク。
JobReleaseTask	ジョブが実行されている任意のコンピューティング ノードでジョブの完了時に実行するジョブ 解放タスク。
JobScheduleExecutionInformation	ジョブ スケジュールで実行され、実行されるジョブに関する情報が含まれます。
JobScheduleState	ジョブ スケジュールの状態。
JobScheduleStatistics	ジョブ スケジュールのリソース使用状況統計。
JobSpecification	スケジュールに従って作成するジョブの詳細を指定します。
LinuxUserConfiguration	Linux コンピューティング ノードでユーザー アカウントを作成するために使用されるプロパティ。
LoginMode	ユーザーのログイン モード
ManagedDisk
MetadataItem	Batch サービス リソースに関連付けられている名前と値のペア。
MountConfiguration	各ノードにマウントするファイル システム。
NetworkConfiguration	プールのネットワーク構成。
NetworkSecurityGroupRule	受信エンドポイントに適用するネットワーク セキュリティ グループ規則。
NetworkSecurityGroupRuleAccess	指定した IP アドレス、サブネット範囲、またはタグに対して実行する必要があるアクション。
NFSMountConfiguration	NFS ファイル システムへの接続に使用される情報。
NodeCommunicationMode	プールが Batch サービスと通信する方法を決定します。
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 にそれぞれ固定され、夏時間の影響を受けません。
SecurityProfile	仮想マシンまたは仮想マシン スケール セットのセキュリティ プロファイル設定を指定します。
SecurityTypes	仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。
ServiceArtifactReference	'latest' イメージ バージョンを使用する場合に、スケール セット内のすべての仮想マシンに同じイメージ バージョンを設定するために使用されるサービス成果物参照 ID を指定します。
StartTask	ノードがAzure Batch サービスのプールに参加するとき、またはコンピューティング ノードが再起動または再イメージ化されたときに実行されるタスク。
StorageAccountType	データ ディスクまたは OS ディスクの作成に使用するストレージ アカウントの種類。
TaskConstraints	タスクに適用する実行制約。
TaskContainerSettings	タスクのコンテナー設定。
TaskSchedulingPolicy	コンピューティング ノード間でタスクを分散する方法を指定します。
UefiSettings	仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。
UserAccount	Azure Batch コンピューティング ノードでタスクを実行するために使用するユーザーの作成に使用されるプロパティ。
UserIdentity	タスクを実行するユーザー ID の定義。
VirtualMachineConfiguration	Azure Virtual Machines インフラストラクチャに基づくプール内のコンピューティング ノードの構成。
VMExtension	仮想マシン拡張機能の構成。
WindowsConfiguration	仮想マシンに適用する Windows オペレーティング システムの設定。
WindowsUserConfiguration	Windows コンピューティング ノードでユーザー アカウントを作成するために使用されるプロパティ。

AccessScope

トークンがアクセスを許可する Batch リソース。

名前	型	説明
job	string	タスクを含むジョブに対するすべての操作を実行するためのアクセス権を付与します。

ApplicationPackageReference

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

名前	型	説明
applicationId	string	デプロイするアプリケーションの ID。 プールを作成する場合、パッケージのアプリケーション ID は完全修飾 (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}) である必要があります。
version	string	デプロイするアプリケーションのバージョン。 省略すると、既定のバージョンがデプロイされます。 プールでこれを省略し、このアプリケーションに既定のバージョンが指定されていない場合、要求はエラー コード InvalidApplicationPackageReferences および HTTP 状態コード 409 で失敗します。 Task でこれを省略し、このアプリケーションに既定のバージョンが指定されていない場合、タスクは前処理エラーで失敗します。

AuthenticationTokenSettings

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

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

AutoPoolSpecification

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

名前	型	説明
autoPoolIdPrefix	string	プールが自動的に作成されるときに一意識別子に追加されるプレフィックス。 Batch サービスは、作成時に各自動プールに一意の識別子を割り当てます。 異なる目的で作成されたプールを区別するために、この要素を指定して、割り当てられている ID にプレフィックスを追加できます。 プレフィックスは 20 文字まで指定できます。
keepAlive	boolean	有効期間が切れた後に自動プールを有効に保つかどうか。 false の場合、Batch サービスは、その有効期間 (poolLifetimeOption 設定によって決定される) の有効期限が切れるとプールを削除します。つまり、ジョブまたはジョブ スケジュールが完了したときです。 true の場合、Batch サービスはプールを自動的に削除しません。 このオプションを使用して作成された自動プールは、ユーザーが削除する必要があります。
pool	PoolSpecification	自動プールのプール仕様。
poolLifetimeOption	PoolLifetimeOption	作成された自動プールの最小有効期間と、スケジュール上の複数のジョブをプールに割り当てる方法。

AutoUserScope

自動ユーザーのスコープ

名前	型	説明
pool	string	タスクが、プール内のすべてのコンピューティング ノードで作成される共通の自動ユーザー アカウントとして実行されるように指定します。
task	string	サービスがタスクの新しいユーザーを作成することを指定します。

AutoUserSpecification

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

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

AzureBlobFileSystemConfiguration

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

名前	型	説明
accountKey	string	Azure Storage アカウント キー。 このプロパティは、sasKey と ID の両方と相互に排他的です。正確に 1 つを指定する必要があります。
accountName	string	Azure Storage アカウント名。
blobfuseOptions	string	mount コマンドに渡す追加のコマンド ライン オプション。 これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。
containerName	string	Azure Blob Storage コンテナー名。
identityReference	ComputeNodeIdentityReference	containerName へのアクセスに使用するユーザー割り当て ID への参照 このプロパティは、accountKey と sasKey の両方と相互に排他的です。正確に 1 つを指定する必要があります。
relativeMountPath	string	ファイル システムがマウントされるコンピューティング ノード上の相対パス すべてのファイル システムは Batch mounts ディレクトリに対して相対的にマウントされ、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできます。
sasKey	string	Azure Storage SAS トークン。 このプロパティは accountKey と ID の両方と相互に排他的です。正確に 1 つを指定する必要があります。

AzureFileShareConfiguration

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

名前	型	説明
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 の "マウント" オプションです。
relativeMountPath	string	ファイル システムがマウントされるコンピューティング ノード上の相対パス すべてのファイル システムは Batch mounts ディレクトリに対して相対的にマウントされ、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできます。

BatchError

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

名前	型	説明
code	string	エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。
message	ErrorMessage	ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。
values	BatchErrorDetail[]	エラーに関する追加の詳細を含むキーと値のペアのコレクション。

BatchErrorDetail

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

名前	型	説明
key	string	Value プロパティの意味を指定する識別子。
value	string	エラー応答に含まれる追加情報。

CachingType

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

名前	型	説明
none	string	ディスクのキャッシュ モードが有効になっていません。
readonly	string	ディスクのキャッシュ モードは読み取り専用です。
readwrite	string	ディスクのキャッシュ モードは読み取りと書き込みです。

CertificateReference

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

名前	型	説明
storeLocation	CertificateStoreLocation	証明書をインストールするコンピューティング ノード上の証明書ストアの場所。 既定値は 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	CertificateVisibility[]	証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。 このコレクションでは、複数の可視性を指定できます。 既定値はすべてのアカウントです。

CertificateStoreLocation

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

名前	型	説明
currentuser	string	証明書は CurrentUser 証明書ストアにインストールする必要があります。
localmachine	string	証明書は LocalMachine 証明書ストアにインストールする必要があります。

CertificateVisibility

証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。

名前	型	説明
remoteuser	string	証明書は、ユーザーがコンピューティング ノードにリモートでアクセスするユーザー アカウントに表示されます。
starttask	string	証明書は、StartTask が実行されているユーザー アカウントに表示されます。 AutoUser スコープが StartTask と Task の両方のプールである場合、この証明書はタスクにも表示されることに注意してください。
task	string	[証明書] は、ジョブ タスクが実行されているユーザー アカウントに表示されます。

CIFSMountConfiguration

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

名前	型	説明
mountOptions	string	mount コマンドに渡す追加のコマンド ライン オプション。 これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。
password	string	CIFS ファイル システムに対する認証に使用するパスワード。
relativeMountPath	string	ファイル システムがマウントされるコンピューティング ノード上の相対パス すべてのファイル システムは Batch mounts ディレクトリに対して相対的にマウントされ、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできます。
source	string	マウントするファイル システムの URI。
username	string	CIFS ファイル システムに対する認証に使用するユーザー。

CloudJobSchedule

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

名前	型	説明
creationTime	string	ジョブ スケジュールの作成時刻。
displayName	string	スケジュールの表示名。
eTag	string	ジョブ スケジュールの ETag。 これは不透明な文字列です。 これを使用して、要求間でジョブ スケジュールが変更されたかどうかを検出できます。 特に、ジョブ スケジュールの更新要求で ETag を渡して、その間に他のユーザーがスケジュールを変更していない場合にのみ変更を有効にするように指定できます。
executionInfo	JobScheduleExecutionInformation	このスケジュールで実行され、実行されるジョブに関する情報。
id	string	アカウント内のスケジュールを一意に識別する文字列。
jobSpecification	JobSpecification	このスケジュールで作成するジョブの詳細。
lastModified	string	ジョブ スケジュールの最終変更時刻。 これは、ジョブの仕様や繰り返し情報などのスケジュール レベルのデータが変更された最後の時刻です。 新しいジョブの作成中やジョブの状態の変更など、ジョブ レベルの変更は考慮されません。
metadata	MetadataItem[]	スケジュールにメタデータとして関連付けられている名前と値のペアの一覧。 Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。
previousState	JobScheduleState	ジョブ スケジュールの以前の状態。 ジョブ スケジュールが初期状態の場合、このプロパティは存在しません。
previousStateTransitionTime	string	ジョブ スケジュールが以前の状態になった時刻。 ジョブ スケジュールが初期状態の場合、このプロパティは存在しません。
schedule	Schedule	ジョブが作成されるスケジュール。 すべての時刻は UTC にそれぞれ固定され、夏時間の影響を受けません。
state	JobScheduleState	ジョブ スケジュールの現在の状態。
stateTransitionTime	string	ジョブ スケジュールが現在の状態に入った時刻。
stats	JobScheduleStatistics	ジョブ スケジュールの有効期間リソース使用状況統計。 統計はすぐには使用できない場合があります。 Batch サービスは、統計の定期的なロールアップを実行します。 一般的な遅延は約 30 分です。
url	string	ジョブ スケジュールの URL。

CloudJobScheduleListResult

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

名前	型	説明
odata.nextLink	string	次の結果セットを取得する URL。
value	CloudJobSchedule[]	ジョブ スケジュールの一覧。

CloudServiceConfiguration

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

名前	型	説明
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 - WINDOWS Server 2019 と同等の OS ファミリ 6。 詳細については、「Azure ゲスト OS リリース (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases)」を参照してください。
osVersion	string	プール内の仮想マシンにインストールされる Azure ゲスト OS バージョン。 既定値は * で、指定した OS ファミリの最新のオペレーティング システム バージョンを指定します。

ComputeNodeFillType

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

名前	型	説明
pack	string	プール内の次のコンピューティング ノードにタスクが割り当てられる前に、可能な限り多くのタスク (taskSlotsPerNode) をプール内の各コンピューティング ノードに割り当てる必要があります。
spread	string	タスクは、プール内のすべてのコンピューティング ノードに均等に割り当てる必要があります。

ComputeNodeIdentityReference

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

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

ContainerConfiguration

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

名前	型	説明
containerImageNames	string[]	コンテナーイメージ名のコレクション。 これは、"docker pull" に指定されているように、完全なイメージ参照です。 イメージが代替レジストリで完全修飾されていない限り、イメージは既定の Docker レジストリから取得されます。
containerRegistries	ContainerRegistry[]	コンテナーをプルできる追加のプライベート レジストリ。 資格情報を必要とするプライベート レジストリからイメージをダウンロードする必要がある場合は、それらの資格情報をここで指定する必要があります。
type	ContainerType	使用するコンテナー テクノロジ。

ContainerRegistry

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

名前	型	説明
identityReference	ComputeNodeIdentityReference	ユーザー名とパスワードではなく、Azure Container Registryへのアクセスに使用するユーザー割り当て ID への参照。 コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。
password	string	レジストリ サーバーにログインするためのパスワード。
registryServer	string	レジストリ URL。 省略すると、既定値は "docker.io" になります。
username	string	レジストリ サーバーにログインするユーザー名。

ContainerType

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

名前	型	説明
criCompatible	string	CRI ベースのテクノロジを使用して、コンテナーを起動します。
dockerCompatible	string	Docker 互換のコンテナー テクノロジを使用してコンテナーを起動します。

ContainerWorkingDirectory

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

名前	型	説明
containerImageDefault	string	コンテナー Image で定義されている作業ディレクトリを使用します。 このディレクトリには、Batch によってダウンロードされたリソース ファイルが含まれていないことに注意してください。
taskWorkingDirectory	string	Batch によって設定されたタスク リソース ファイルが含まれる標準の Batch サービスタスク作業ディレクトリを使用します。

DataDisk

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

名前	型	説明
caching	CachingType	データ ディスクに対して有効にするキャッシュの種類。 キャッシュの既定値は 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	StorageAccountType	データ ディスクに使用するストレージ アカウントの種類。 省略すると、既定値は "standard_lrs" になります。

DiffDiskPlacement

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

名前	型	説明
CacheDisk	string	エフェメラル OS ディスクは VM キャッシュに格納されます。

DiffDiskSettings

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

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

DiskEncryptionConfiguration

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

名前	型	説明
targets	DiskEncryptionTarget[]	Batch Service がコンピューティング ノードで暗号化するディスク ターゲットの一覧。 省略した場合、プール内のコンピューティング ノード上のディスクは暗号化されません。 Linux プールでは、"TemporaryDisk" のみがサポートされます。Windows プールでは、"OsDisk" と "TemporaryDisk" を指定する必要があります。

DiskEncryptionTarget

Batch Service がコンピューティング ノードで暗号化するディスク ターゲットの一覧。

名前	型	説明
osdisk	string	コンピューティング ノード上の OS ディスクは暗号化されます。
temporarydisk	string	コンピューティング ノード上の一時ディスクは暗号化されます。 Linux では、起動時に暗号化が行われると、この暗号化は他のパーティション (マウントされたデータ ディスク上のパーティションなど) に適用されます。

DynamicVNetAssignmentScope

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

名前	型	説明
job	string	動的 VNet の割り当てはジョブごとに行われます。
none	string	動的 VNet 割り当てが有効になっていません。

ElevationLevel

ユーザーの昇格レベル。

名前	型	説明
admin	string	ユーザーは管理者特権のアクセス権を持つユーザーであり、完全な管理者アクセス許可で動作します。
nonadmin	string	ユーザーは、昇格されたアクセス権を持たない標準ユーザーです。

EnvironmentSetting

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

名前	型	説明
name	string	環境変数の名前。
value	string	環境変数の値。

ErrorMessage

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

名前	型	説明
lang	string	エラー メッセージの言語コード
value	string	メッセージのテキストです。

HttpHeader

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

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

ImageReference

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

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

InboundEndpointProtocol

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

名前	型	説明
tcp	string	エンドポイントに TCP を使用します。
udp	string	エンドポイントに UDP を使用します。

InboundNATPool

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

名前	型	説明
backendPort	integer	コンピューティング ノードのポート番号。 これは、バッチ プール内で一意である必要があります。 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	NetworkSecurityGroupRule[]	エンドポイントに適用されるネットワーク セキュリティ グループ規則の一覧。 バッチ プール上のすべてのエンドポイントで指定できるルールの最大数は 25 です。 ネットワーク セキュリティ グループの規則が指定されていない場合は、指定された backendPort への受信アクセスを許可する既定の規則が作成されます。 ネットワーク セキュリティ グループ規則の最大数を超えた場合、要求は HTTP 状態コード 400 で失敗します。
protocol	InboundEndpointProtocol	エンドポイントのプロトコル。

IPAddressProvisioningType

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

名前	型	説明
batchmanaged	string	パブリック IP は Batch によって作成および管理されます。 プールのサイズによっては、複数のパブリック IP が存在する場合があります。
nopublicipaddresses	string	パブリック IP アドレスは作成されません。
usermanaged	string	パブリック IP はユーザーによって提供され、コンピューティング ノードのプロビジョニングに使用されます。

JobConstraints

ジョブの実行制約。

名前	型	説明
maxTaskRetryCount	integer	各タスクを再試行できる最大回数。 終了コードが 0 以外の場合、Batch サービスは Task を再試行します。 この値によって再試行の回数が限定されますのでご注意ください。 Batch サービスは各タスクを 1 回試行し、この制限まで再試行できます。 たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (最初の試行 1 回と 3 回の再試行)。 最大再試行回数が 0 の場合、Batch サービスはタスクを再試行しません。 最大再試行回数が -1 の場合、Batch サービスは制限なくタスクを再試行します。 既定値は 0 (再試行なし) です。
maxWallClockTime	string	ジョブが作成された時点から測定された、ジョブが実行できる最大経過時間。 ジョブが制限時間内に完了しない場合、Batch サービスはジョブを終了し、実行中のすべてのタスクを終了します。 この場合、終了の理由は MaxWallClockTimeExpiry になります。 このプロパティを指定しない場合、ジョブの実行時間に制限はありません。

JobManagerTask

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

名前	型	説明
allowLowPriorityNode	boolean	ジョブ マネージャー タスクがスポット/低優先度のコンピューティング ノードで実行できるかどうか。 既定値は、true です。
applicationPackageReferences	ApplicationPackageReference[]	コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにデプロイするアプリケーション パッケージの一覧。 アプリケーション パッケージは、タスク作業ディレクトリではなく、共有ディレクトリにダウンロードされて展開されます。 したがって、参照先のアプリケーション パッケージが既にコンピューティング ノード上にあり、最新の状態である場合、再ダウンロードされません。コンピューティング ノード上の既存のコピーが使用されます。 参照先のアプリケーション パッケージをインストールできない場合 (たとえば、パッケージが削除されたか、ダウンロードに失敗したため)、タスクは失敗します。
authenticationTokenSettings	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	TaskConstraints	ジョブ マネージャー タスクに適用される制約。
containerSettings	TaskContainerSettings	ジョブ マネージャー タスクを実行するコンテナーの設定。 このタスクを実行するプールに containerConfiguration が設定されている場合は、これも設定する必要があります。 このタスクを実行するプールに containerConfiguration が設定されていない場合は、これを設定しないでください。 これを指定すると、AZ_BATCH_NODE_ROOT_DIRの下にあるすべてのディレクトリ (ノード上のAzure Batchディレクトリのルート) がコンテナーにマップされ、すべての Task 環境変数がコンテナーにマップされ、Task コマンド ラインがコンテナーで実行されます。 AZ_BATCH_NODE_ROOT_DIRの外部のコンテナーで生成されたファイルはホスト ディスクに反映されない可能性があります。つまり、Batch ファイル API はそれらのファイルにアクセスできません。
displayName	string	ジョブ マネージャー タスクの表示名。 一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。
environmentSettings	EnvironmentSetting[]	ジョブ マネージャー タスクの環境変数設定の一覧。
id	string	ジョブ内のジョブ マネージャー タスクを一意に識別する文字列。 ID には、ハイフンやアンダースコアを含む英数字を任意に組み合わせて使用でき、64 文字を超えることはできません。
killJobOnCompletion	boolean	ジョブ マネージャー タスクの完了が、ジョブ全体の完了を示すかどうか。 true の場合、ジョブ マネージャー タスクが完了すると、Batch サービスによってジョブが完了としてマークされます。 この時点で (ジョブ リリース以外の) タスクが引き続き実行されている場合、それらのタスクは終了します。 false の場合、ジョブ マネージャー タスクの完了はジョブの状態に影響しません。 この場合は、onAllTasksComplete 属性を使用してジョブを終了するか、クライアントまたはユーザーにジョブを明示的に終了させる必要があります。 この例は、ジョブ マネージャーが一連のタスクを作成した後、その実行にそれ以上の役割を持たない場合です。 既定値は、true です。 onAllTasksComplete 属性と onTaskFailure 属性を使用してジョブの有効期間を制御し、ジョブ マネージャー タスクのみを使用してジョブのタスクを作成する (進行状況を監視しない) 場合は、killJobOnCompletion を false に設定することが重要です。
outputFiles	OutputFile[]	コマンド ラインの実行後に Batch サービスがコンピューティング ノードからアップロードするファイルの一覧。 複数インスタンスのタスクの場合、ファイルはプライマリ タスクが実行されるコンピューティング ノードからのみアップロードされます。
requiredSlots	integer	タスクの実行に必要なスケジュール スロットの数。 既定値は 1 です。 タスクは、ノードに十分な空きスケジュール スロットがある場合にのみ、コンピューティング ノードで実行するようにスケジュールできます。 複数インスタンスのタスクの場合、このプロパティはサポートされていないため、指定しないでください。
resourceFiles	ResourceFile[]	コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。 この要素の下に一覧表示されるファイルは、タスクの作業ディレクトリにあります。 リソース ファイルの一覧には最大サイズがあります。 最大サイズを超えると、要求は失敗し、応答エラー コードは RequestEntityTooLarge になります。 この場合、ResourceFiles のコレクションのサイズを小さくする必要があります。 これは、.zip ファイル、アプリケーション パッケージ、または Docker コンテナーを使用して実現できます。
runExclusive	boolean	ジョブ マネージャー タスクが実行されているコンピューティング ノードを排他的に使用する必要があるかどうか。 true の場合、ジョブ マネージャーが実行されている限り、同じノードで他のタスクは実行されません。 false の場合、他のタスクはコンピューティング ノード上のジョブ マネージャーと同時に実行できます。 ジョブ マネージャー タスクは通常、コンピューティング ノードの同時実行タスク制限に対してカウントされるため、これは、コンピューティング ノードで複数の同時実行タスクが許可されている場合にのみ関連します。 既定値は、true です。
userIdentity	UserIdentity	ジョブ マネージャー タスクを実行するユーザー ID。 省略すると、Task は Task に固有の非管理ユーザーとして実行されます。

JobNetworkConfiguration

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

名前	型	説明
subnetId	string	ジョブからタスクを実行しているコンピューティング ノードがタスクの期間中参加する仮想ネットワーク サブネットの ARM リソース識別子。 これは、VirtualMachineConfiguration プールでのみ機能します。 仮想ネットワークは、Azure Batch アカウントと同じリージョンとサブスクリプションに存在する必要があります。 指定されたサブネットには、ジョブからタスクを実行するコンピューティング ノードの数に対応できる十分な空き IP アドレスが必要です。 これは、プール内のコンピューティング ノードの数までです。 "MicrosoftAzureBatch" サービス プリンシパルは、Azure Batch サービスがノード上のタスクをスケジュールできるように、指定された VNet の 'クラシック仮想マシン共同作成者' Role-Based Access Control (RBAC) ロールを持っている必要があります。 これは、指定された 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

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

名前	型	説明
commandLine	string	ジョブ準備タスクのコマンド ライン。 コマンド ラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windows では "cmd /c MyCommand" を使用し、Linux では "/bin/sh -c MyCommand" を使用します。 コマンド ラインがファイル パスを参照している場合は、相対パス (タスク作業ディレクトリに対する相対パス) を使用するか、Batch で指定された環境変数 (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) を使用する必要があります。
constraints	TaskConstraints	ジョブ準備タスクに適用される制約。
containerSettings	TaskContainerSettings	ジョブ準備タスクを実行するコンテナーの設定。 これを指定すると、AZ_BATCH_NODE_ROOT_DIRの下にあるすべてのディレクトリ (ノード上のAzure Batchディレクトリのルート) がコンテナーにマップされ、すべての Task 環境変数がコンテナーにマップされ、Task コマンド ラインがコンテナーで実行されます。 AZ_BATCH_NODE_ROOT_DIRの外部のコンテナーで生成されたファイルはホスト ディスクに反映されない可能性があります。つまり、Batch ファイル API はそれらのファイルにアクセスできません。
environmentSettings	EnvironmentSetting[]	ジョブ準備タスクの環境変数設定の一覧。
id	string	ジョブ内のジョブ準備タスクを一意に識別する文字列。 ID には、ハイフンやアンダースコアを含む英数字の任意の組み合わせを含めることができます。また、64 文字を超えることはできません。 このプロパティを指定しない場合、Batch サービスは既定値の 'jobpreparation' を割り当てます。 ジョブ内の他のタスクは、ジョブ準備タスクと同じ ID を持つ必要はありません。 同じ ID のタスクを送信しようとすると、Batch サービスはエラー コード TaskIdSameAsJobPreparationTask を使用して要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 409 (競合) です。
rerunOnNodeRebootAfterSuccess	boolean	コンピューティング ノードの再起動後に Batch サービスでジョブ準備タスクを再実行する必要があるかどうか。 コンピューティング ノードが再イメージ化された場合、またはジョブ準備タスクが完了しなかった場合 (タスクの実行中に再起動が発生したためなど) は、ジョブ準備タスクは常に再実行されます。 そのため、ジョブ準備タスクは常にべき等であり、複数回実行された場合は正しく動作するように記述する必要があります。 既定値は、true です。
resourceFiles	ResourceFile[]	コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。 この要素の下に一覧表示されるファイルは、タスクの作業ディレクトリにあります。 リソース ファイルの一覧には最大サイズがあります。 最大サイズを超えると、要求は失敗し、応答エラー コードは RequestEntityTooLarge になります。 この場合、ResourceFiles のコレクションのサイズを小さくする必要があります。 これは、.zip ファイル、アプリケーション パッケージ、または Docker コンテナーを使用して実現できます。
userIdentity	UserIdentity	ジョブ準備タスクを実行するユーザー ID。 省略した場合、タスクは、Windows コンピューティング ノード上のタスクに固有の管理以外のユーザー、または Linux コンピューティング ノード上のプールに固有の管理以外のユーザーとして実行されます。
waitForSuccess	boolean	Batch サービスがジョブ準備タスクが正常に完了するまで待機してから、コンピューティング ノード上のジョブの他のタスクをスケジュールする必要があるかどうか。 ジョブ準備タスクは、終了コード 0 で終了すると正常に完了しました。 true で、ノードでジョブ準備タスクが失敗した場合、Batch サービスはジョブ準備タスクを最大再試行回数まで再試行します (constraints 要素で指定)。 すべての再試行の後もタスクが正常に完了していない場合、Batch サービスはジョブのタスクをノードにスケジュールしません。 ノードはアクティブなままであり、他のジョブのタスクを実行する資格があります。 false の場合、Batch サービスはジョブ準備タスクの完了を待機しません。 この場合、ジョブ準備タスクがまだ実行中に、ジョブの他のタスクがコンピューティング ノードで実行を開始できます。ジョブ準備タスクが失敗した場合でも、新しいタスクは引き続きコンピューティング ノードでスケジュールされます。 既定値は、true です。

JobReleaseTask

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

名前	型	説明
commandLine	string	ジョブ解放タスクのコマンド ライン。 コマンド ラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windows では "cmd /c MyCommand" を使用し、Linux では "/bin/sh -c MyCommand" を使用します。 コマンド ラインがファイル パスを参照している場合は、相対パス (タスク作業ディレクトリに対する相対パス) を使用するか、Batch で指定された環境変数 (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) を使用する必要があります。
containerSettings	TaskContainerSettings	ジョブ 解放タスクを実行するコンテナーの設定。 これを指定すると、AZ_BATCH_NODE_ROOT_DIRの下にあるすべてのディレクトリ (ノード上のAzure Batchディレクトリのルート) がコンテナーにマップされ、すべての Task 環境変数がコンテナーにマップされ、Task コマンド ラインがコンテナーで実行されます。 AZ_BATCH_NODE_ROOT_DIRの外部のコンテナーで生成されたファイルはホスト ディスクに反映されない可能性があります。つまり、Batch ファイル API はそれらのファイルにアクセスできません。
environmentSettings	EnvironmentSetting[]	ジョブ リリース タスクの環境変数設定の一覧。
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	ResourceFile[]	コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。 リソース ファイルの一覧には最大サイズがあります。 最大サイズを超えると、要求は失敗し、応答エラー コードは RequestEntityTooLarge になります。 この場合、ResourceFiles のコレクションのサイズを小さくする必要があります。 これは、.zip ファイル、アプリケーション パッケージ、または Docker コンテナーを使用して実現できます。 この要素の下に一覧表示されるファイルは、タスクの作業ディレクトリにあります。
retentionTime	string	コンピューティング ノード上のジョブ 解放タスクの Task ディレクトリを保持する最小時間。 この時間が経過すると、Batch サービスによって Task ディレクトリとそのすべての内容が削除される可能性があります。 既定値は 7 日間です。つまり、コンピューティング ノードが削除されるか、ジョブが削除されない限り、タスク ディレクトリは 7 日間保持されます。
userIdentity	UserIdentity	ジョブ解放タスクを実行するユーザー ID。 省略すると、Task は Task に固有の管理ユーザー以外のユーザーとして実行されます。

JobScheduleExecutionInformation

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

名前	型	説明
endTime	string	スケジュールが終了した時刻。 このプロパティは、ジョブ スケジュールが完了状態の場合にのみ設定されます。
nextRunTime	string	このスケジュールの下で次にジョブが作成される時刻。 このプロパティは、スケジュールが時間が来たときにアクティブな状態になっている場合にのみ意味があります。 たとえば、スケジュールが無効になっている場合、その前にジョブが有効になっていない限り、nextRunTime ではジョブは作成されません。
recentJob	RecentJob	[ジョブ スケジュール] の下の最新のジョブに関する情報。 このプロパティは、スケジュールの下で少なくとも 1 つのジョブが実行されている場合にのみ存在します。

JobScheduleState

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

名前	型	説明
active	string	ジョブ スケジュールはアクティブであり、スケジュールに従ってジョブが作成されます。
completed	string	ジョブ スケジュールは、終了時刻に達するか、ユーザーが明示的に終了することによって終了しました。
deleting	string	ユーザーはジョブ スケジュールの削除を要求しましたが、削除操作はまだ進行中です。 スケジューラは、このジョブ スケジュールに対して新しいジョブを開始せず、アクティブなジョブを含め、ジョブ スケジュールに基づく既存のジョブとタスクを削除します。 ジョブ スケジュールの下にあるすべてのジョブとタスクが削除されると、ジョブ スケジュールが削除されます。
disabled	string	ユーザーがジョブ スケジュールを無効にしました。 スケジューラは、このスケジュールに従って新しいジョブを開始しませんが、既存のアクティブなジョブは引き続き実行されます。
terminating	string	ジョブ スケジュールに実行する作業がなくなったか、ユーザーによって明示的に終了されていますが、終了操作はまだ進行中です。 スケジューラは、このジョブ スケジュールに対して新しいジョブを開始せず、既存のジョブもアクティブになりません。

JobScheduleStatistics

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

名前	型	説明
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

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

名前	型	既定値	説明
allowTaskPreemption	boolean		このジョブ内のタスクを他の優先度の高いジョブに割り込むことができるかどうか 値が True に設定されている場合、システムに送信された他の優先度の高いジョブが優先され、このジョブからタスクを再キューできます。 ジョブの allowTaskPreemption は、更新ジョブ API を使用して作成した後に更新できます。
commonEnvironmentSettings	EnvironmentSetting[]		一般的な環境変数設定の一覧。 これらの環境変数は、このスケジュールで作成されたすべてのジョブ (ジョブ マネージャー、ジョブ準備、ジョブ リリース タスクを含む) に設定されます。 個々のタスクは、同じ設定名を別の値で指定することで、ここで指定した環境設定をオーバーライドできます。
constraints	JobConstraints		このスケジュールで作成されたジョブの実行制約。
displayName	string		このスケジュールで作成されたジョブの表示名。 名前は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。
jobManagerTask	JobManagerTask		このスケジュールでジョブが開始されたときに起動されるジョブ マネージャー タスクの詳細。 ジョブでジョブ マネージャー タスクが指定されていない場合、ユーザーは Task API を使用してジョブにタスクを明示的に追加する必要があります。 ジョブでジョブ マネージャー タスクが指定されている場合、Batch サービスはジョブの作成時にジョブ マネージャー タスクを作成し、ジョブ内の他のタスクをスケジュールする前にジョブ マネージャー タスクのスケジュールを設定しようとします。
jobPreparationTask	JobPreparationTask		このスケジュールで作成されたジョブのジョブ準備タスク。 ジョブにジョブ準備タスクがある場合、Batch サービスはノードでジョブ準備タスクを実行してから、そのコンピューティング ノードでそのジョブのタスクを開始します。
jobReleaseTask	JobReleaseTask		このスケジュールで作成されたジョブのジョブ解放タスク。 ジョブ解放タスクの主な目的は、ジョブ準備タスクによって行われたノードの変更を元に戻すことです。 アクティビティの例としては、ローカル ファイルの削除、ジョブ準備の一環として開始されたサービスのシャットダウンなどがあります。 ジョブのジョブ解放タスクは、ジョブのジョブ準備タスクも指定しないと指定できません。 Batch サービスは、ジョブ準備タスクを実行したコンピューティング ノードでジョブ解放タスクを実行します。
maxParallelTasks	integer	-1	ジョブに対して並列に実行できるタスクの最大数。 maxParallelTasks の値は、-1 または指定した場合は 0 より大きくする必要があります。 指定しない場合、既定値は -1 です。つまり、一度に実行できるタスクの数に制限はありません。 ジョブの maxParallelTasks は、更新ジョブ API を使用して作成した後に更新できます。
metadata	MetadataItem[]		このスケジュールでメタデータとして作成された各ジョブに関連付けられている名前と値のペアの一覧。 Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。
networkConfiguration	JobNetworkConfiguration		ジョブのネットワーク構成。
onAllTasksComplete	OnAllTasksComplete		このスケジュールで作成されたジョブ内のすべてのタスクが完了状態の場合に、Batch サービスが実行する必要があるアクション。 ジョブにタスクが含まれない場合、すべてのタスクは完了と見なされることに注意してください。 したがって、このオプションは、ジョブ マネージャー タスクで最も一般的に使用されます。ジョブ マネージャーなしでジョブの自動終了を使用する場合は、最初に onAllTasksComplete を noaction に設定し、タスクの追加が完了したらジョブを終了するように onAllTasksComplete に設定するように Job プロパティを更新する必要があります。 既定値は noaction です。
onTaskFailure	OnTaskFailure		このスケジュールで作成されたジョブでタスクが失敗した場合に、Batch サービスが実行する必要があるアクション。 task が failureInfo を持っている場合、失敗したと見なされます。 failureInfo は、再試行回数を使い果たした後にタスクが 0 以外の終了コードで完了した場合、またはリソース ファイルのダウンロード エラーが原因でタスクを開始中にエラーが発生した場合に設定されます。 既定値は noaction です。
poolInfo	PoolInformation		Batch サービスが、このスケジュールで作成されたジョブのタスクを実行するプール。
priority	integer		このスケジュールで作成されたジョブの優先順位。 優先度の値の範囲は -1000 から 1000 です。-1000 が最も低い優先度で、1000 が最高の優先度です。 既定値は 0 です。 この優先度は、ジョブ スケジュールのすべてのジョブの既定値として使用されます。 ジョブの優先度は、ジョブの更新 API を使用してを使用して作成した後に更新できます。
usesTaskDependencies	boolean		ジョブ内のタスクが相互に依存関係を定義できるかどうか。 既定値は false です。

LinuxUserConfiguration

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

名前	型	説明
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

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

名前	型	説明
batch	string	LOGON32_LOGON_BATCH Win32 ログイン モード。 バッチ ログイン モードは、実行時間の長い並列プロセスに推奨されます。
interactive	string	LOGON32_LOGON_INTERACTIVE Win32 ログイン モード。 UAC は、Windows VirtualMachineConfiguration プールで有効になっています。 このオプションを Windows VirtualMachineConfiguration プールの昇格されたユーザー ID と共に使用する場合、タスク コマンド ラインによって実行されるアプリケーションが常に管理特権を必要とするか、常に最大特権を必要とするように構成されていない限り、ユーザー セッションは昇格されません。

ManagedDisk

名前	型	説明
storageAccountType	StorageAccountType	マネージド ディスクのストレージ アカウントの種類。

MetadataItem

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

名前	型	説明
name	string	メタデータ 項目の名前。
value	string	メタデータ 項目の値。

MountConfiguration

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

名前	型	説明
azureBlobFileSystemConfiguration	AzureBlobFileSystemConfiguration	各ノードで BLOB FUSE を使用してマウントする Azure Storage コンテナー。 このプロパティは、他のすべてのプロパティと相互に排他的です。
azureFileShareConfiguration	AzureFileShareConfiguration	各ノードにマウントする Azure ファイル共有。 このプロパティは、他のすべてのプロパティと相互に排他的です。
cifsMountConfiguration	CIFSMountConfiguration	各ノードにマウントする CIFS/SMB ファイル システム。 このプロパティは、他のすべてのプロパティと相互に排他的です。
nfsMountConfiguration	NFSMountConfiguration	各ノードにマウントする NFS ファイル システム。 このプロパティは、他のすべてのプロパティと相互に排他的です。

NetworkConfiguration

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

名前	型	説明
dynamicVNetAssignmentScope	DynamicVNetAssignmentScope	動的 vnet 割り当てのスコープ。
enableAcceleratedNetworking	boolean	このプールで高速ネットワークを有効にする必要があるかどうか。 高速ネットワークにより、VM への単一ルート I/O 仮想化 (SR-IOV) が可能になり、ネットワーク パフォーマンスが向上する可能性があります。 詳細については、 https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview を参照してください。
endpointConfiguration	PoolEndpointConfiguration	Batch プール内のコンピューティング ノード上のエンドポイントの構成。 プール エンドポイントの構成は、virtualMachineConfiguration プロパティを持つプールでのみサポートされます。
publicIPAddressConfiguration	PublicIPAddressConfiguration	Batch プール内のコンピューティング ノードのパブリック IP アドレス構成。 パブリック 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

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

名前	型	説明
access	NetworkSecurityGroupRuleAccess	指定した 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 アドレス、サブネット範囲、またはタグに対して実行する必要があるアクション。

名前	型	説明
allow	string	アクセスを許可します。
deny	string	アクセスを拒否します。

NFSMountConfiguration

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

名前	型	説明
mountOptions	string	mount コマンドに渡す追加のコマンド ライン オプション。 これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。
relativeMountPath	string	ファイル システムがマウントされるコンピューティング ノード上の相対パス すべてのファイル システムは Batch mounts ディレクトリに対して相対的にマウントされ、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできます。
source	string	マウントするファイル システムの URI。

NodeCommunicationMode

プールが Batch サービスと通信する方法を決定します。

名前	型	説明
classic	string	クラシック通信モードを使用するノードでは、"BatchNodeManagement" からのポート 29876 と 29877 での受信 TCP 通信が必要です。{region}" サービス タグとポート 443 の "Storage.region" と "BatchNodeManagement への送信 TCP 通信。{region}" サービス タグ。
default	string	ノード通信モードは、Batch サービスによって自動的に設定されます。
simplified	string	簡略化された通信モードを使用するノードでは、ポート 443 で "BatchNodeManagement" への送信 TCP 通信が必要です。{region}" サービス タグ。 開いている受信ポートは必要ありません。

NodePlacementConfiguration

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

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

NodePlacementPolicyType

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

名前	型	説明
regional	string	プール内のすべてのノードは、同じリージョンに割り当てられます。
zonal	string	プール内のノードは、ベスト エフォート分散によって異なる可用性ゾーンに分散されます。

OnAllTasksComplete

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

名前	型	説明
noaction	string	何もしない。 他の方法で終了または無効にしない限り、ジョブはアクティブなままです。
terminatejob	string	ジョブを終了します。 ジョブの terminateReason が 'AllTasksComplete' に設定されています。

OnTaskFailure

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

名前	型	説明
noaction	string	何もしない。 他の方法で終了または無効にしない限り、ジョブはアクティブなままです。
performexitoptionsjobaction	string	タスクの exitConditions コレクションの Task 終了条件に関連付けられているアクションを実行します。 (これが Task で指定されている場合は、引き続きアクションが実行されない可能性があります)。

OSDisk

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

名前	型	説明
caching	CachingType	キャッシュの要件を指定します。 使用できる値は、None、ReadOnly、ReadWrite です。 既定値は、Standard Storage の場合は [なし] です。 Premium Storage の ReadOnly。 キャッシュの既定値は none です。 キャッシュ オプションの詳細については、 を参照してください https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/。
diskSizeGB	integer	新しい OS ディスクを作成するときの初期ディスク サイズ (GB)。
ephemeralOSDiskSettings	DiffDiskSettings	コンピューティング ノード (VM) によって使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。
managedDisk	ManagedDisk	マネージド ディスクのパラメーター。
writeAcceleratorEnabled	boolean	ディスクで writeAccelerator を有効または無効にするかどうかを指定します。

OutputFile

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

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

OutputFileBlobContainerDestination

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

名前	型	説明
containerUrl	string	ファイルをアップロードするAzure Blob Storage内のコンテナーの URL。 マネージド ID を使用しない場合、URL にはコンテナーへの書き込みアクセス許可を付与する Shared Access Signature (SAS) を含める必要があります。
identityReference	ComputeNodeIdentityReference	containerUrl で指定されたAzure Blob Storageにアクセスするために使用するユーザー割り当て ID への参照 ID には、Azure Blob Storage コンテナーへの書き込みアクセス権が必要です
path	string	Azure Storage コンテナー内の宛先 BLOB または仮想ディレクトリ。 filePattern が特定のファイルを参照している場合 (つまり、ワイルドカードが含まれない場合)、path はそのファイルをアップロードする BLOB の名前です。 filePattern に 1 つ以上のワイルドカードが含まれている場合 (したがって、複数のファイルと一致する可能性があります)、path は、ファイルをアップロードする BLOB 仮想ディレクトリの名前 (各 BLOB 名の前に付加されます) です。 省略すると、ファイル名と一致する BLOB 名を使用して、コンテナーのルートにファイルがアップロードされます。
uploadHeaders	HttpHeader[]	出力ファイルのアップロードに使用するヘッダーの名前と値のペアの一覧 これらのヘッダーは、Azure Storage にファイルをアップロードするときに指定されます。 BLOB のアップロード時に許可されるヘッダーに関する公式ドキュメント: https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

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

名前	型	説明
container	OutputFileBlobContainerDestination	ファイルがアップロードされる Azure BLOB ストレージ内の場所。

OutputFileUploadCondition

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

名前	型	説明
taskcompletion	string	終了コードが何であったかにかかわらず、タスク プロセスが終了した後にファイルをアップロードします。
taskfailure	string	タスク プロセスが 0 以外の終了コードで終了した後にのみ、ファイルをアップロードします。
tasksuccess	string	タスク プロセスが終了コード 0 で終了した後にのみ、ファイルをアップロードします。

OutputFileUploadOptions

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

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

PoolEndpointConfiguration

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

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

PoolInformation

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

名前	型	説明
autoPoolSpecification	AutoPoolSpecification	一時的な '自動プール' の特性。 Batch サービスは、ジョブの送信時にこの自動プールを作成します。 プールの自動作成が失敗した場合、Batch サービスはジョブを完了状態に移動し、プール作成エラーはジョブのスケジュール エラー プロパティに設定されます。 Batch サービスは、自動プールの有効期間 (keepAlive が指定されていない限り、作成と削除の両方) を管理します。 ジョブがアクティブな間に自動プールの有効期間に影響を与えるユーザー アクションは、予期しない動作になります。 プール ID または自動プール仕様のいずれかを指定する必要がありますが、両方は指定しないでください。
poolId	string	既存のプールの ID。 ジョブのすべてのタスクは、指定されたプールで実行されます。 このプロパティによって参照されるプールが存在することを確認する必要があります。 Batch サービスがジョブのスケジュールを試みる時点でプールが存在しない場合、その ID を持つプールを作成するまで、ジョブのタスクは実行されません。Batch サービスはジョブ要求を拒否しないことに注意してください。プールが存在するまで、タスクは実行されません。 プール ID または自動プール仕様のいずれかを指定する必要がありますが、両方は指定しないでください。

PoolLifetimeOption

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

名前	型	説明
job	string	プールは、専用のジョブの有効期間中存在します。 Batch サービスは、ジョブの作成時にプールを作成します。 "job" オプションがジョブ スケジュールに適用されている場合、Batch サービスはスケジュールに基づいて作成されたすべてのジョブに対して新しい自動プールを作成します。
jobschedule	string	プールはジョブ スケジュールの有効期間中存在します。 Batch サービスは、スケジュールに基づいて最初のジョブを作成するときにプールを作成します。 このオプションは、[ジョブ] ではなく [ジョブ スケジュール] にのみ適用できます。

PoolSpecification

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

名前	型	説明
applicationLicenses	string[]	Batch サービスがプール内の各コンピューティング ノードで使用できるようにするアプリケーション ライセンスの一覧。 アプリケーション ライセンスの一覧は、使用可能な Batch サービス アプリケーション ライセンスのサブセットである必要があります。 サポートされていないライセンスが要求された場合、プールの作成は失敗します。 プールで使用できるライセンスは、'maya'、'vray'、'3dsmax'、'arnold' です。 プールに追加されたアプリケーション ライセンスごとに追加料金が適用されます。
applicationPackageReferences	ApplicationPackageReference[]	プール内の各コンピューティング ノードにインストールするパッケージの一覧。 プールを作成する場合、パッケージのアプリケーション ID は完全修飾 (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}) である必要があります。 パッケージ参照に対する変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、プールに既に存在するコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のパッケージ参照があります。
autoScaleEvaluationInterval	string	自動スケーリング式に従ってプール サイズを自動的に調整する時間間隔。 既定値は 15 分です。 最小値と最大値はそれぞれ 5 分と 168 時間です。 5 分未満または 168 時間を超える値を指定した場合、Batch サービスは無効なプロパティ値エラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
autoScaleFormula	string	プール内のコンピューティング ノードの目的の数の数式。 enableAutoScale が false に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が true に設定されている場合は必須です。 Pool が作成される前に、数式の有効性が確認されます。 式が無効な場合、Batch サービスは詳細なエラー情報を含む要求を拒否します。
certificateReferences	CertificateReference[]	プール内の各コンピューティング ノードにインストールされる証明書の一覧。 Windows ノードの場合、Batch サービスは、指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書は Task 作業ディレクトリ内のディレクトリに格納され、この場所を照会するために環境変数 AZ_BATCH_CERTIFICATES_DIRが Task に提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、証明書がそのディレクトリに配置されます。 警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。 代わりに Azure KeyVault 拡張機能 を使用してください。
cloudServiceConfiguration	CloudServiceConfiguration	プールのクラウド サービス構成。 プールを Azure PaaS VM で作成する必要がある場合は、このプロパティを指定する必要があります。 このプロパティと virtualMachineConfiguration は相互に排他的であり、いずれかのプロパティを指定する必要があります。 どちらも指定されていない場合、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 batch アカウントが poolAllocationMode プロパティを 'UserSubscription' に設定して作成された場合、このプロパティを指定できません。
displayName	string	プールの表示名。 表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。
enableAutoScale	boolean	プール のサイズが時間の経過と同時に自動的に調整されるかどうか。 false の場合、targetDedicatedNodes と targetLowPriorityNodes の少なくとも 1 つを指定する必要があります。 true の場合、autoScaleFormula 要素が必要です。 Pool は、数式に従って自動的にサイズ変更されます。 既定値は false です。
enableInterNodeCommunication	boolean	プールがコンピューティング ノード間の直接通信を許可するかどうか。 ノード間通信を有効にすると、プールのコンピューティング ノードのデプロイ制限により、プールの最大サイズが制限されます。 これにより、プールが目的のサイズに達しない可能性があります。 既定値は false です。
metadata	MetadataItem[]	プールにメタデータとして関連付けられている名前と値のペアの一覧。 Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。
mountConfiguration	MountConfiguration[]	プール内の各ノードにマウントするファイル システムの一覧。 これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。
networkConfiguration	NetworkConfiguration	プールのネットワーク構成。 プールのネットワーク構成。
resizeTimeout	string	プールへのコンピューティング ノードの割り当てのタイムアウト。 このタイムアウトは、手動スケーリングにのみ適用されます。enableAutoScale が true に設定されている場合、効果はありません。 既定値は 15 分です。 最小値は 5 分です。 5 分未満の値を指定した場合、Batch サービスはエラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
resourceTags	object	プールに関連付けられているユーザー指定のタグ。 Azure Batch プールに関連付けるユーザー定義タグ。 これらのタグを指定すると、プールに関連付けられているバッキング Azure リソースにこれらのタグが反映されます。 このプロパティは、poolAllocationMode プロパティが 'UserSubscription' に設定された Batch アカウントが作成された場合にのみ指定できます。
startTask	StartTask	プールに参加する各コンピューティング ノードで実行するタスク。 タスクは、コンピューティング ノードがプールに追加されたとき、またはコンピューティング ノードが再起動されたときに実行されます。 ノードで回復操作がトリガーされると、バッチによってタスクが再試行されます。 復旧操作の例としては、異常なノードが再起動されたときや、ホストの障害によってコンピューティング ノードが消失した場合 (ただし、これらに限定されません) があります。 回復操作による再試行は に依存せず、maxTaskRetryCount に対してカウントされません。 maxTaskRetryCount が 0 の場合でも、回復操作による内部再試行が発生する可能性があります。 このため、すべてのタスクはべき等である必要があります。 つまり、タスクは、破損や重複するデータを引き起こさずに中断および再起動されることを許容する必要があります。 実行時間の長いタスクのベスト プラクティスは、何らかの形式のチェックポイント処理を使用することです。 場合によっては、コンピューティング ノードが再起動されなかった場合でも、StartTask が再実行されることがあります。 StartTask 作業ディレクトリから中断プロセスを作成したり、サービスをインストール/起動したりする StartTasks を回避するには、特に注意する必要があります。これにより、Batch で StartTask を再実行できなくなるためです。
targetDedicatedNodes	integer	プール内の専用コンピューティング ノードの必要な数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。
targetLowPriorityNodes	integer	プール内のスポット/低優先度コンピューティング ノードの必要な数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。
targetNodeCommunicationMode	NodeCommunicationMode	プールの目的のノード通信モード。 省略した場合、既定値は Default です。
taskSchedulingPolicy	TaskSchedulingPolicy	プール内のコンピューティング ノード間でタスクを分散する方法。 指定しない場合、既定値はスプレッドになります。
taskSlotsPerNode	integer	プール内の単一の計算ノードで同時実行タスクを実行するために使用できるタスク スロットの数。 既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。
userAccounts	UserAccount[]	プール内の各コンピューティング ノードに作成するユーザー アカウントの一覧。
virtualMachineConfiguration	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 アドレス構成。

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

RecentJob

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

名前	型	説明
id	string	ジョブの ID。
url	string	ジョブの URL。

ResourceFile

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

名前	型	説明
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 を取得するには、3 つの方法があります。BLOB に対する読み取りアクセス許可を付与する Shared Access Signature (SAS) を含めるか、読み取りアクセス許可を持つマネージド ID を使用するか、BLOB またはそのコンテナーの ACL を設定してパブリック アクセスを許可します。
identityReference	ComputeNodeIdentityReference	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 にそれぞれ固定され、夏時間の影響を受けません。

名前	型	説明
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 (無効な要求) です。

SecurityProfile

仮想マシンまたは仮想マシン スケール セットのセキュリティ プロファイル設定を指定します。

名前	型	説明
encryptionAtHost	boolean	このプロパティは、要求のユーザーが仮想マシンまたは仮想マシン スケール セットの Host Encryption を有効または無効にするために使用できます。 これにより、ホスト自体のリソース/一時ディスクを含むすべてのディスクの暗号化が有効になります。
securityType	SecurityTypes	仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。
uefiSettings	UefiSettings	仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。 仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。

SecurityTypes

仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。

名前	型	説明
trustedLaunch	string	トラステッド起動により、高度で永続的な攻撃手法から保護されます。

ServiceArtifactReference

'latest' イメージ バージョンを使用する場合に、スケール セット内のすべての仮想マシンに同じイメージ バージョンを設定するために使用されるサービス成果物参照 ID を指定します。

名前	型	説明
id	string	ServiceArtifactReference のサービス成果物参照 ID /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} の形式のサービス成果物参照 ID

StartTask

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

名前	型	説明
commandLine	string	StartTask のコマンド ライン。 コマンド ラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windows では "cmd /c MyCommand" を使用し、Linux では "/bin/sh -c MyCommand" を使用します。 コマンド ラインがファイル パスを参照している場合は、相対パス (タスク作業ディレクトリに対する相対パス) を使用するか、Batch で指定された環境変数 (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) を使用する必要があります。
containerSettings	TaskContainerSettings	StartTask を実行するコンテナーの設定。 これを指定すると、AZ_BATCH_NODE_ROOT_DIRの下にあるすべてのディレクトリ (ノード上のAzure Batchディレクトリのルート) がコンテナーにマップされ、すべての Task 環境変数がコンテナーにマップされ、Task コマンド ラインがコンテナーで実行されます。 AZ_BATCH_NODE_ROOT_DIRの外部のコンテナーで生成されたファイルはホスト ディスクに反映されない可能性があります。つまり、Batch ファイル API はそれらのファイルにアクセスできません。
environmentSettings	EnvironmentSetting[]	StartTask の環境変数設定の一覧。
maxTaskRetryCount	integer	タスクを再試行できる最大回数。 終了コードが 0 以外の場合、Batch サービスは Task を再試行します。 この値によって再試行の回数が限定されますのでご注意ください。 Batch サービスはタスクを 1 回試し、この制限まで再試行できます。 たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (最初の再試行が 1 回、再試行回数が 3 回)。 最大再試行回数が 0 の場合、Batch サービスはタスクを再試行しません。 最大再試行回数が -1 の場合、Batch サービスは制限なくタスクを再試行しますが、開始タスクやタスクには推奨されません。 既定値は 0 (再試行なし) です。
resourceFiles	ResourceFile[]	コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。 リソース ファイルの一覧には最大サイズがあります。 最大サイズを超えると、要求は失敗し、応答エラー コードは RequestEntityTooLarge になります。 この場合、ResourceFiles のコレクションのサイズを小さくする必要があります。 これは、.zip ファイル、アプリケーション パッケージ、または Docker コンテナーを使用して実現できます。 この要素の下に一覧表示されるファイルは、タスクの作業ディレクトリにあります。
userIdentity	UserIdentity	StartTask を実行するユーザー ID。 省略すると、Task は Task に固有の非管理ユーザーとして実行されます。
waitForSuccess	boolean	コンピューティング ノードでタスクをスケジュールする前に、Batch サービスが StartTask が正常に完了するまで待機する必要があるかどうか (つまり、終了コード 0 で終了する)。 True で Node で StartTask が失敗した場合、Batch サービスは StartTask を最大再試行回数 (maxTaskRetryCount) まで再試行します。 すべての再試行の後もタスクが正常に完了していない場合、Batch サービスはノードを使用不可としてマークし、タスクをスケジュールしません。 この条件は、コンピューティング ノードの状態とエラー情報の詳細を使用して検出できます。 false の場合、Batch サービスは StartTask の完了を待機しません。 この場合、StartTask がまだ実行されている間に、他のタスクがコンピューティング ノードで実行を開始できます。StartTask が失敗した場合でも、新しいタスクは引き続きコンピューティング ノードでスケジュールされます。 既定値は true です。

StorageAccountType

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

名前	型	説明
premium_lrs	string	データ ディスク/OS ディスクでは、Premium ローカル冗長ストレージを使用する必要があります。
standard_lrs	string	データ ディスク/OS ディスクでは、標準のローカル冗長ストレージを使用する必要があります。
standardssd_lrs	string	データ ディスク/OS ディスクでは、Standard SSD ローカル冗長ストレージを使用する必要があります。

TaskConstraints

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

名前	型	説明
maxTaskRetryCount	integer	タスクを再試行できる最大回数。 終了コードが 0 以外の場合、Batch サービスは Task を再試行します。 この値は、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

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

名前	型	説明
containerRunOptions	string	コンテナー作成コマンドの追加オプション。 これらの追加オプションは、Batch Service によって制御されるオプションに加えて、"docker create" コマンドの引数として提供されます。
imageName	string	タスクを実行するコンテナーの作成に使用するイメージ。 これは、"docker pull" に指定される完全なイメージ参照です。 イメージ名の一部としてタグが指定されていない場合は、タグ ":latest" が既定として使用されます。
registry	ContainerRegistry	コンテナー イメージを含むプライベート レジストリ。 この設定は、プールの作成時に既に指定されている場合は省略できます。
workingDirectory	ContainerWorkingDirectory	コンテナー Task 作業ディレクトリの場所。 既定値は 'taskWorkingDirectory' です。

TaskSchedulingPolicy

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

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

UefiSettings

仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。

名前	型	説明
secureBootEnabled	boolean	仮想マシンでセキュア ブートを有効にするかどうかを指定します。
vTpmEnabled	boolean	仮想マシンで vTPM を有効にするかどうかを指定します。

UserAccount

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

名前	型	説明
elevationLevel	ElevationLevel	ユーザー アカウントの昇格レベル。 既定値は nonAdmin です。
linuxUserConfiguration	LinuxUserConfiguration	ユーザー アカウントの Linux 固有のユーザー構成。 このプロパティは、Windows プールで指定されている場合は無視されます。 指定しない場合、ユーザーは既定のオプションを使用して作成されます。
name	string	ユーザー アカウントの名前。 名前には、最大 20 文字までの任意の Unicode 文字を含めることができます。
password	string	ユーザー アカウントのパスワード。
windowsUserConfiguration	WindowsUserConfiguration	ユーザー アカウントの Windows 固有のユーザー構成。 このプロパティは、ユーザーが Windows プール上にある場合にのみ指定できます。 指定されていない場合、Windows プールでは、既定のオプションを使用してユーザーが作成されます。

UserIdentity

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

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

VirtualMachineConfiguration

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

名前	型	説明
containerConfiguration	ContainerConfiguration	プールのコンテナー構成。 指定した場合、タスクをコンテナーで実行できるように、プール内の各コンピューティング ノードに対してセットアップが実行されます。 このプールで実行されるすべての通常のタスクとジョブ マネージャー タスクは containerSettings プロパティを指定する必要があり、他のすべてのタスクで指定できます。
dataDisks	DataDisk[]	プール内のコンピューティング ノードに接続されているデータ ディスクの構成。 プール内のコンピューティング ノードに空のデータ ディスクが接続されている必要がある場合は、このプロパティを指定する必要があります。 これは更新できません。 各コンピューティング ノードは、独自のディスクを取得します (ディスクはファイル共有ではありません)。 既存のディスクを接続できません。接続されている各ディスクは空です。 コンピューティング ノードがプールから削除されると、ディスクとそれに関連付けられているすべてのデータも削除されます。 ディスクは接続後にフォーマットされません。使用する前にフォーマットする必要があります。詳細については、 と 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	DiskEncryptionConfiguration	プールのディスク暗号化構成。 指定した場合、暗号化は、ノードのプロビジョニング中にプール内の各ノードで実行されます。
extensions	VMExtension[]	プールの仮想マシン拡張機能。 指定した場合、この構成に記載されている拡張機能が各ノードにインストールされます。
imageReference	ImageReference	使用する Azure Virtual Machines Marketplace イメージまたはカスタム仮想マシン イメージへの参照。
licenseType	string	オペレーティング システムの展開時に使用するオンプレミス ライセンスの種類。 これは、Windows オペレーティング システムを含むイメージにのみ適用され、デプロイされるコンピューティング ノードの有効なオンプレミス ライセンスを保持している場合にのみ使用する必要があります。 省略した場合、オンプレミスライセンス割引は適用されません。 値は次のとおりです。 Windows_Server - オンプレミス ライセンスは Windows Server 用です。 Windows_Client - オンプレミス ライセンスは Windows クライアント用です。
nodeAgentSKUId	string	プール内のコンピューティング ノードにプロビジョニングされる Batch コンピューティング ノード エージェントの SKU。 Batch Compute Node エージェントは、プール内の各コンピューティング ノードで実行され、コンピューティング ノードと Batch サービスの間のコマンドと制御インターフェイスを提供するプログラムです。 コンピューティング ノード エージェントの実装は、オペレーティング システムごとに異なります(SKU と呼ばれます)。 選択したイメージ参照と一致するコンピューティング ノード エージェント SKU を指定する必要があります。 サポートされているコンピューティング ノード エージェント SKU の一覧と検証済みイメージ参照の一覧を取得するには、「サポートされているコンピューティング ノード エージェント SKU の一覧」操作を参照してください。
nodePlacementConfiguration	NodePlacementConfiguration	プールのノード配置構成。 この構成では、プール内のノードを物理的に割り当てる方法に関する規則を指定します。
osDisk	OSDisk	仮想マシンのオペレーティング システム ディスクの設定。
securityProfile	SecurityProfile	仮想マシンまたは仮想マシン スケール セットのセキュリティ プロファイル設定を指定します。 仮想マシンまたは仮想マシン スケール セットのセキュリティ プロファイル設定を指定します。
serviceArtifactReference	ServiceArtifactReference	'latest' イメージ バージョンを使用する場合に、スケール セット内のすべての仮想マシンに同じイメージ バージョンを設定するために使用されるサービス成果物参照 ID を指定します。 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} の形式のサービス成果物参照 ID
windowsConfiguration	WindowsConfiguration	仮想マシン上の Windows オペレーティング システムの設定。 imageReference プロパティで Linux OS イメージが指定されている場合は、このプロパティを指定しないでください。

VMExtension

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

名前	型	説明
autoUpgradeMinorVersion	boolean	展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。
enableAutomaticUpgrade	boolean	新しいバージョンの拡張機能が使用可能な場合に、プラットフォームによって拡張機能を自動的にアップグレードするかどうかを示します。
name	string	仮想マシン拡張機能の名前。
protectedSettings	object	拡張機能には、protectedSettings または protectedSettingsFromKeyVault を含めることができます。または、保護された設定をまったく含めなくなります。
provisionAfterExtensions	string[]	拡張名のコレクション。 この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。
publisher	string	拡張ハンドラーの発行元の名前。
settings	object	拡張機能の JSON 形式のパブリック設定。
type	string	拡張機能の型。
typeHandlerVersion	string	スクリプト ハンドラーのバージョン。

WindowsConfiguration

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

名前	型	説明
enableAutomaticUpdates	boolean	仮想マシンで自動更新が有効になっているかどうか。 省略すると、既定値は true になります。

WindowsUserConfiguration

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

名前	型	説明
loginMode	LoginMode	ユーザーのログイン モード VirtualMachineConfiguration プールの既定値は 'batch' で、CloudServiceConfiguration プールの場合は "対話型" です。