バッチサービスREST APIが提供する操作は、APIが進化するにつれて後方互換性のために複数のバージョンを持つことがあります。 呼び出し時に使用するバージョンを指定するために、RESTコールでバージョンを指定する必要があります。 アプリケーションが操作の古いバージョンを呼び出した場合、古いバージョンを引き続き呼び出すか、コードを修正して新しいバージョンを呼び出すかを選択できます。 バージョンが指定されていないか、誤ったバージョンが指定されている場合、エラーが返されます。
どのバージョンを使う操作かを指定するには、 api-version クエリパラメータを設定します。 このバージョンはGroup.Major.Minorの形式で、Groupは YYYY-MM-DD 、メジャーは整数、マイナーは整数です。
最新バージョン:2025-06-01
職務レベルのFIFO
- タイプ
BatchJobDefaultOrder追加。 - ジョブレベルのFIFOスケジューリングをサポートするために新しい
jobDefaultOrderプロパティを備えた拡張バッチタスクスケジューリングポリシー。
- タイプ
プールにおけるCMKサポート
- プール上で顧客管理キー(CMK)サポートのための
DiskCustomerManagedKeyandDiskEncryptionSetParametersを追加しました。 - 新しい
customerManagedKey物件との延長DiskEncryptionConfiguration。 - 新しい
diskEncryptionSet物件との延長ManagedDisk。 - ディスク暗号化シナリオにおける管理対象IDを参照するための追加
BatchPoolIdentityReference。
- プール上で顧客管理キー(CMK)サポートのための
プールにおけるIPv6サポート
-
BatchNodeにipv6Addressを加えました。 -
BatchNodeRemoteLoginSettingsにipv6RemoteLoginIPAddressとipv6RemoteLoginPortを加えました。
-
プールにおけるメタデータセキュリティプロトコルのサポート
-
HostEndpointSettingsとHostEndpointSettingsModeTypesを加えました。 -
ProxyAgentSettingsを追加しました。 - メタデータセキュリティプロトコルサポートのための新しい
proxyAgentSettingsプロパティを備えた拡張SecurityProfile。
-
IPタグサポート
-
IPFamilyとIPTagタイプが追加されました。 - IPタグ対応のための新しい
ipFamiliesとipTagsプロパティを備えた拡張BatchPublicIpAddressConfiguration。
-
[ブレイキング]証明書のサポートが削除されました:
- 削除された証明書API:
Certificate_Add、Certificate_Get、Certificate_List、Certificate_CancelDeletion、Certificate_Delete。 - 削除された証明書モデル/列挙:
Certificate、CertificateDelete、CertificateFormat、CertificateReference、CertificateState、CertificateStoreLocation、およびCertificateVisibility - 削除された証明書関連プロパティ:
PoolSpecification.CertificateReferences、CloudPool.CertificateReferences、PoolAddParameter.CertificateReferences、ComputeNode.CertificateReferences、PoolUpdatePropertiesParameter.CertificateReferences、およびPoolPatchParameter.CertificateReferences。
- 削除された証明書API:
[ブレイキング]削除
DataDisk.StorageAccountType。DataDisk.ManagedDisk.StorageAccountTypeを代わりに使用します。[ブレイキング]
NodeCommunicationModeモデルおよびプロパティCloudPool.targetNodeCommunicationMode、CloudPool.currentNodeCommunicationMode、PoolAddParameter.targetNodeCommunicationMode、PoolUpdatePropertiesParameter.targetNodeCommunicationMode、PoolPatchParameter.targetNodeCommunicationMode、PoolSpecification.targetNodeCommunicationModeを削除しました。[ブレイキング]以下のモデルが名称変更されました:
旧モデル 新しいモデル AccountListSupportedImages結果 BatchAccountListSupportedImagesResult アフィニティ情報 バッチアフィニティ情報 ApplicationListResult バッチアプリケーションリスト結果 ApplicationPackageReference (アプリケーションパッケージ参照) バッチアプリケーションパッケージリファレンス 応募概要 バッチアプリケーション AutomaticOSUpgradePolicy (英語) AutomaticOsUpgradePolicy オートプール仕様 バッチオートプール仕様 CIFSMountConfiguration CifsMountConfiguration の クラウドジョブ バッチジョブ CloudJobListPreparationAndReleaseTaskStatusResult BatchJobPreparationAndReleaseTaskStatusListResult CloudJobListResult BatchJobListResult CloudJobSchedule バッチジョブスケジュール CloudJobScheduleListResult バッチジョブスケジュールリスト結果 クラウドプール バッチプール CloudPoolListResult バッチプールリスト結果 クラウドタスク バッチタスク CloudTaskListResult バッチタスクリスト結果 ComputeNode バッチノード ComputeNodeDeallocationOption BatchNodeDeallocationOption ComputeNodeEndpointConfiguration BatchNodeEndpointConfiguration ComputeNodeError バッチノードエラー ComputeNodeGetRemoteLoginSettingsResult BatchNodeRemoteLoginSettings ComputeNodeIdentityReference (英語) バッチノードアイデンティティ参照 ComputeNodeInformation BatchNodeInfo ComputeNodeListResult バッチノードリスト結果 ComputeNodeUser BatchNodeUserCreateOptions コンテナ構成 バッチコンテナ構成 コンテナレジストリ コンテナレジストリリファレンス DiffDiskSettings (英語) バッチ差異ディスク設定 エラーカテゴリ バッチエラーソースカテゴリ エラーメッセージ バッチエラーメッセージ HttpHeader OutputFileUploadHeader 画像情報 バッチサポート画像 ImageReference バッチVmイメージリファレンス InboundNATPool BatchInboundNatPool IPAddressProvisioningType IpAddressProvisioningType JobAddParameter BatchJobCreateOptions ジョブ制約 BatchJobConstraints JobDisableParameter バッチジョブDisableOptions ジョブ実行情報 BatchJobExecutionInfo JobManagerTask バッチジョブマネージャータスク JobNetworkConfiguration バッチジョブネットワーク構成 JobPatchParameter BatchJobUpdateOptions ジョブ準備とリリースタスク実行情報 BatchJobPreparationAndReleaseTaskStatus ジョブ準備タスク バッチジョブ準備タスク ジョブ準備タスク実行情報 バッチジョブ準備タスク実行情報 ジョブリリースタスク バッチジョブリリースタスク ジョブリリースタスク実行情報 BatchJobReleaseTaskExecutionInfo JobScheduleAddParameter BatchJobScheduleCreateOptions ジョブスケジューション実行情報 バッチジョブスケジュール実行情報 JobSchedulePatchParameter バッチジョブスケジュール更新オプション 仕事スケジュール州 BatchJobScheduleState ジョブスケジュール統計 バッチジョブスケジュール統計 ジョブスケジューリングエラー バッチジョブスケジューリングエラー ジョブ仕様 バッチジョブ仕様 JobState バッチジョブステート 職種統計 バッチジョブ統計 JobTerminateParameter バッチジョブ終端オプション MetadataItem バッチメタデータ項目 NFSMountConfiguration NfsMountConfiguration NodeAgentInformation BatchNodeAgentInfo ノードコミュニケーションモード バッチノード通信モード ノードカウント バッチノードカウント NodeDeallocateParameter BatchNodeDeallocateOptions NodeDisableSchedulingParameter BatchNodeDisableSchedulingOptions NodeFile バッチノードファイル NodeFileListResult BatchNodeFileListResult ノード配置構成 BatchNodePlacementConfiguration NodePlacementPolicyType BatchNodePlacementPolicyType NodeRebootParameter BatchNodeRebootOptions NodeReimageParameter BatchNodeReimageOptions NodeRemoveParameter BatchNodeRemoveOptions NodeUpdateUserParameter BatchNodeUserUpdateOptions NodeVMExtension BatchNodeVMExtension NodeVMExtensionList BatchNodeVMExtensionListResult OnAllTasksComplete(全タスク完了) バッチ全タスク完了モード OnTaskFailure(タスク失敗 バッチタスク失敗モード OSDiskの バッチオスディスク OutputFileUploadOptions(アップロードオプション) OutputFileUploadConfig PoolAddParameter BatchPoolCreateOptions PoolEnableAuto -ScaleParameter [BatchPoolEnableAuto -ScaleOptions](/rest/api/batchservice/pools/enable-auto-scale#batchpoolenableauto -scaleoptions) PoolEndpointConfiguration (プールエンドポイント構成) BatchPoolEndpointConfiguration PoolEvaluateAuto -ScaleParameter [BatchPoolEvaluateAuto -ScaleOptions](/rest/api/batchservice/pools/evaluate-auto-scale#batchpoolevaluateauto -scaleoptions) プール情報 バッチプール情報更新 PoolListUsageMetricsResult BatchPoolListUsageMetricsResult PoolNodeCounts BatchPoolNodeCounts PoolNodeCountsListResult BatchPoolNodeCountsListResult PoolPatchParameter BatchPoolUpdateOptions PoolResizeParameter BatchPoolResizeOptions プール仕様 バッチプール仕様 プール統計 バッチプール統計 PoolUpdatePropertiesParameter BatchPoolReplaceOptions プール使用メトリクス バッチプール使用メトリクス PublicIPAddressConfiguration (英語) バッチPublicIpAddressConfiguration 最近の仕事 RecentBatchJob リソース統計 バッチプールリソース統計 スケジュール バッチジョブスケジュール構成 タスクの開始 バッチスタートタスク StartTaskInformation BatchStartTaskInfo サブタスク情報 バッチサブタスク サブタスクステート バッチSubtask状態 TaskAddCollectionParameter バッチタスクグループ タスクアドコレクション結果 バッチ作成タスクコレクション結果 TaskAddParameter BatchTaskCreateOptions タスク追加結果 バッチタスク作成結果 タスク制約 バッチタスク制約 TaskContainerExecutionInformation BatchTaskContainerExecutionInfo タスクコンテナ設定 バッチタスクコンテナ設定 タスクカウント バッチタスクカウント タスクカウント結果 バッチタスクカウント結果 TaskDependencies バッチタスク依存関係 タスク実行情報 バッチタスク実行情報 タスク実行結果 バッチタスク実行結果 TaskFailureInformation バッチタスク失敗情報 タスクIdレンジ バッチタスクIdレンジ TaskInformation バッチタスク情報 タスクスケジューリングポリシー バッチタスクスケジューリングポリシー タスクスロットカウント バッチタスクスロットカウント タスクステート バッチタスクステート タスク統計 バッチタスク統計 Uefi設定 BatchUefiSettings UploadBatchServiceLogsConfiguration UploadBatchServiceLogsOptions 使用統計 BatchPoolUsageStatistics UserAssignedIdentity バッチユーザー割り当てID(BatchUserAssignedIdentity) VMDiskSecurityProfile (英語) BatchVmDiskSecurityProfile
以前のバージョン
過去のバージョンには以下が含まれます:
- 2024-07-01.20.0
- 2024-02-01.19.0
- 2023-11-01.18.0
- 2023-05-01.17.0
- 2022-10-01.16.0
- 2022-01-01.15.0
- 2021-06-01.14.0
- 2020-09-01.12.0
- 2020-03-01.11.0
- 2019-08-01.10.0
- 2019-06-01.9.0
- 2018-12-01.8.0
- 2018-08-01.7.0
- 2018-03-01.6.1
- 2017-09-01.6.0
- 2017-06-01.5.1
- 2017-05-01.5.0
- 2017-01-01.4.0
- 2016-07-01.3.1
- 2016-02-01.3.0
- 2015-12-01.2.2
- 2015-11-01.2.1
バージョン:2024-07-01.20.0
- 追加された計算ノードの解除および開始操作:
- 新しい
ComputeNode_Deallocate操作(POST /pools/{poolId}/nodes/{nodeId}/deallocate)を追加し、アイドルまたは実行中の計算ノードを解放しました。 - 以前に解除された計算ノードを再起動するための新しい
ComputeNode_Start操作(POST /pools/{poolId}/nodes/{nodeId}/start)を追加しました。 -
nodeDeallocateOptionプロパティで、デアロケーション中のタスク実行をどうするかを指定する新しいNodeDeallocateParameterモデルを追加しました。
- 新しい
- [ブレイキング]
ComputeNode_GetRemoteDesktop操作を廃止しました(GET /pools/{poolId}/nodes/{nodeId}/rdp)。 この操作はクラウドサービス設定プールにのみ適用されました。 - [ブレイキング]クラウドサービス構成プールのサポートを廃止しました:
- モデル
CloudServiceConfiguration削除しました。 -
CloudPool、PoolAddParameter、PoolSpecificationからcloudServiceConfiguration物件を除外しました。
- モデル
- [ブレイキング]
CloudPool、PoolAddParameter、PoolSpecificationからapplicationLicenses物件を除外しました。 - タスクに対するコンテナバインドマウントのサポートが追加されました:
-
sourceとisReadOnlyプロパティを持つ新しいContainerHostBatchBindMountEntryモデルを追加しました。 - 新しい
ContainerHostDataPath列挙(Shared、Startup、VfsMounts、Task、JobPrep、Applicationsの列挙数が追加されました。 -
containerHostBatchBindMountsに新しいTaskContainerSettingsプロパティを追加しました。
-
- 機密VMサポートの追加:
- 新しい
VMDiskSecurityProfileモデルを追加し、securityEncryptionTypeプロパティを付けました。 -
securityProfileに新しいManagedDiskプロパティを追加しました。 -
SecurityProfile.securityTypeの新しい値としてconfidentialVMを追加しました。
- 新しい
-
ComputeNodeStateの新しい値としてdeallocatedとdeallocatingを追加しました。 -
NodeCountsに新たに必要なdeallocatedとdeallocatingプロパティを追加しました。 - 共有ギャラリーおよびコミュニティギャラリー画像参照のサポートを追加:
-
ImageReferenceにsharedGalleryImageIdとcommunityGalleryImageIdプロパティを追加しました。
-
- ジョブ終了後にノードがVNetに接続されたままであるかどうかを制御するプロパティ
skipWithdrawFromVNetJobNetworkConfigurationに追加しました。 -
JobPatchParameternetworkConfiguration不動産を追加しました。 - 拡張されたプールパッチ機能:
displayName、vmSize、taskSlotsPerNode、taskSchedulingPolicy、enableInterNodeCommunication、virtualMachineConfiguration、networkConfiguration、userAccounts、mountConfiguration、upgradePolicy、resourceTagsプロパティを追加PoolPatchParameter。 プールのトポロジーに影響を与えるプロパティは、プールが空の時にのみ更新可能です。 -
Job_Delete、Job_Terminate、JobSchedule_Delete、JobSchedule_Terminate操作にforceブールクエリパラメータを追加し、操作を強制しました。
バージョン:2024-02-01.19.0
- VMプールに対するOSアップグレードポリシーのサポートを追加:
- プロパティ
mode、automaticOSUpgradePolicy、rollingUpgradePolicyを持つ新しいUpgradePolicyモデルを追加しました。mode性質(UpgradeMode)はautomatic、manual、rollingの値を受け入れます。 - 新しい
AutomaticOSUpgradePolicyモデルを追加し、プロパティdisableAutomaticRollback、enableAutomaticOSUpgrade、useRollingUpgradePolicy、osRollingUpgradeDeferral。 - 新しい
RollingUpgradePolicyモデルを追加し、プロパティenableCrossZoneUpgrade、maxBatchInstancePercent、maxUnhealthyInstancePercent、maxUnhealthyUpgradedInstancePercent、pauseTimeBetweenBatches、prioritizeUnhealthyInstances、rollbackFailedInstancesOnPolicyBreachを備えました。 -
CloudPool、PoolAddParameter、PoolSpecificationに新しいupgradePolicyプロパティを追加しました。
- プロパティ
-
ComputeNodeStateの新しい値としてupgradingosを追加しました。 -
upgradingos状態のノード数を報告するためにNodeCountsに新たに必須upgradingOSプロパティを追加しました。
バージョン:2023-11-01.18.0
- VMプールに対するTrusted Launch/セキュリティプロファイルのサポートを追加:
- プロパティ
encryptionAtHost、securityType、uefiSettingsを持つ新しいSecurityProfileモデルを追加しました。 - プロパティ
secureBootEnabledとvTpmEnabledを持つ新しいUefiSettingsモデルを追加しました。 -
securityProfileに新しいVirtualMachineConfigurationプロパティを追加しました。
- プロパティ
- スケールセット向けのサービスアーティファクト参照のサポートが追加されました:
- 必要な
idプロパティ(ARMリソースID)を持つ新しいServiceArtifactReferenceモデルを追加しました。 -
VirtualMachineConfigurationに新しいserviceArtifactReferenceプロパティを追加し、latestイメージバージョンを使う際にすべてのVMに同じイメージバージョンを設定するようにしました。
- 必要な
- 強化OSディスク構成:
- 新しい
ManagedDiskモデルを追加し、storageAccountTypeプロパティを付けました。 -
OSDiskに新しいプロパティを追加しました:caching、diskSizeGB、managedDisk、writeAcceleratorEnabled。
- 新しい
-
StorageAccountTypeの新しい値としてStandardSSDLRS(standardssd_lrs)を追加しました。 -
CloudPool、PoolAddParameter、PoolSpecificationに新しいresourceTagsプロパティを追加し、ユーザー定義タグをバックアップAzureリソースに伝播できるようにしました。poolAllocationModeがUserSubscriptionされている場合にのみ適用されます。 -
VirtualMachineInfoに新しいscaleSetVmResourceIdプロパティを追加し、計算ノードの現在の仮想マシンスケールセットVMのリソースIDを公開しました。 バッチアカウントのpoolAllocationModeがUserSubscriptionされた場合にのみ定義されます。
バージョン:2023-05-01.17.0
- [ブレイキング]バッチジョブ/プールライフタイム統計APIを削除しました:
lifetimejobstatsとlifetimepoolstats。 -
NetworkConfigurationにブール属性enableAcceleratedNetworkingを追加しました。- この性質により、このプールが加速されたネットワークを有効にするかどうかが決まり、デフォルト値はFalseとなります。
- この機能が有効化できるかどうかは、オペレーティングシステムやVMインスタンスがサポートされているかどうかにも関係しており、これはAcceleratedNetworking Policyに準拠しているはずです。
-
VMExtensionにブール属性enableAutomaticUpgradeを追加しました。- この特性により、拡張の新しいバージョンが利用可能な場合に自動的にアップグレードされるかどうかが決定されます。
- この性質
typeContainerConfigurationであり、現在はDockerCompatibleとCriCompatibleの2つの値を支持しています。
バージョン:2022-10-01.16.0
- プールがバッチサービスとどのように通信するかを決定する新しい
NodeCommunicationModeプロパティを追加しました - プール通信モードの現状を示すために、
CloudPoolモデルにNodeCommunicationMode型の新しいcurrentNodeCommunicationModeプロパティを追加しました。 - プールの望ましいノード通信モードを指すために、以下のモデルに
NodeCommunicationMode型の新しいtargetNodeCommunicationMode特性を追加しました。PoolSpecificationCloudPoolPoolAddParameterPoolPatchParameterPoolUpdatePropertiesParameter
バージョン:2022-01-01.15.0
-
OutputFileBlobContainerDestinationモデルに新しいuploadHeadersプロパティを追加し、ユーザーがリソースファイルのアップロード時にカスタムHTTPヘッダーを設定できるようにしました。 - 以下のモデルに新しい
allowTaskPreemptionプロパティを追加し、より優先度の高いタスクのタスクプリペンプション(Comms-Enabled またはシングルテナントプールが必要)をサポートします。JobSpecificationCloudJobJobAddParameterJobPatchParameterJobUpdateParameter
バージョン:2021-06-01.14.0
- ユーザー割り当ての管理IDを
CloudPoolに割り当てる機能を追加。 これらの識別子はプール内の各ノードで公開され、さまざまなリソースへのアクセスに利用できます。 - 管理されたアイデンティティを通じてリソースへのアクセスを支援するために、以下のモデルに
identityReferenceプロパティを追加しました:AzureBlobFileSystemConfigurationOutputFileBlobContainerDestinationContainerRegistryResourceFileUploadBatchServiceLogs
- ノードの仮想マシン拡張を指定するために、
CloudPoolのVirtualMachineConfigurationに新しいextensionsプロパティを追加しました - VirtualMachineConfigurationの新しいプロパティ
nodePlacementConfigurationを使って可用性ゾーンを指定する機能を追加しました - 仮想マシンのオペレーティングシステムディスクの設定を含むVirtualMachineConfigurationに新しい
osDiskプロパティを追加しました。-
DiffDiskSettingsのplacementプロパティは、プール内のすべてのVMのオペレーティングシステムディスクの一時的なディスク配置を指定します。 VMキャッシュに一時的なOSディスクを保存するために「CacheDisk」に設定します。
-
-
CloudJobmaxParallelTasksジョブごとに同時に実行できる最大タスク数を制御するプロパティを追加しました(デフォルトは -1、つまり無制限)。 この物件は現在、プライベートプレビュー中です。 - 仮想マシン
virtualMachineInfo現在の状態に関する情報を含むプロパティを追加ComputeNode、VMが使用しているマーケットプレイスイメージの正確なバージョンも含めました。 - ジョブスケジュールの下で2つの連続するジョブの開始時刻の間隔を制御するプロパティを追加
recurrenceIntervalSchedule。
バージョン:2020-09-01.12.0
- [ブレイキング]プールの
maxTasksPerNodeに敷地のtaskSlotsPerNodeを置き換えました。 この性質をジョブで利用することで、動的なスロット数を消費できるため、リソース消費をより細かく制御できます。 - [ブレイキング]
GetTaskCountsの応答タイプをreturnTaskCountsResultに変更しました。これは、前のTaskCountsオブジェクトと、使用中のスロットの文脈で類似の情報を提供する新しいTaskSlotCountsオブジェクトを含む複雑なオブジェクトです。 - タスクにプロパティ
requiredSlotsを追加し、ユーザーがノード上のスロット数を指定できるようにしました。
バージョン:2020-03-01.11.0
- 新しい
DiskEncryptionConfiguration特性であるVirtualMachineConfigurationを用いてComputeNodeのディスクドライブを暗号化する機能が追加されました。 - [ブレイキング]
ImageReferenceのvirtualMachineImageIdプロパティは、現在Shared Image Gallery画像のみを指すことができます。 - [ブレイキング]
Add Certificate操作のリクエストボディのpasswordプロパティは、PFX形式の証明書では任意です。 - [ブレイキング]新しい
PublicIPAddressConfigurationプロパティNetworkConfigurationを利用して、パブリックIPなしでプールをプロビジョニングできるようになりました。 - [ブレイキング]
NetworkConfigurationのpublicIPs物件もipAddressIdsに改名され、PublicIPAddressConfigurationに入居しました。 この性質は、provision性質がusermanagedである場合にのみ指定できます。
バージョン:2019-08-01.10.0
- プールの新しい
publicIPsプロパティを通じて、NetworkConfiguration上でパブリックIPの集合を指定する機能が追加されました。 これにより、プール内のノードはリスト上のユーザー提供IPからのIPが保証されます。 -
MountConfigurationプロパティを通じてプールの各ノードにリモートファイルシステムをマウントする機能が追加されました。 - 画像Shared Image Gallery、
ImageReferenceのvirtualMachineImageIdプロパティ上で、画像を参照することでAzure Resource Manager IDを参照することで指定できるようになりました。 - [ブレイキング]指定されていない場合、
StartTaskの上waitForSuccessのデフォルト値はtrue(以前はfalseでした)。 - [ブレイキング]指定されていない場合、
AutoUserSpecificationのscopeのデフォルト値は、現在は常にPoolとなります(以前はWindowsノードではTask、LinuxノードではPoolでした)。 - 混乱や不完全な文書を改善しました。
バージョン:2019-06-01.9.0
[ブレイキング]
ListNodeAgentSKUsをListSupportedImagesに置き換えました。ListSupportedImagesListNodeAgentSKUsで最初に提供されていたすべての情報を、より明確な形式で含んでいます。 新たに検証されていない画像も返送されています。CapabilitiesおよびBatchSupportEndOfLifeに関する追加情報はImageInformationを通じて入手可能です。現在は、トラフィックの送信元ポートに基づいてネットワークアクセスをブロックするネットワークセキュリティルールをサポートし、
CloudPoolへのアクセスをブロックするようになりました。 このルールはNetworkSecurityGroupRuleのSourcePortRangesプロパティを通じて行われます。コンテナーを実行する場合、Batch では、コンテナー作業ディレクトリまたは Batch タスク作業ディレクトリでのタスクの実行がサポートされるようになりました。 これは、
WorkingDirectoryのTaskContainerSettingsプロパティによって制御されます。混乱や不完全な文書を改善しました。
バージョン:2018-12-01.8.0
[ブレイキング]
cloudServiceConfigurationプールでのupgradeosサポートを削除しました。-
upgradeosは削除されました。 -
targetOSVersionをosVersionに改名し、CloudPoolcurrentOSVersionを削除しました。 -
upgradingからPoolStateを削除しました。
-
[ブレイキング]
dataEgressGiBとdataIngressGiBをpoolusagemetricsから外しました。 これらの物件は現在サポートされていません。[速報]
ResourceFile改良- ResourceFileでAzure Storageコンテナ全体を指定する機能を追加しました。 現在、ResourceFileには3つのサポートモードがあります:
-
httpUrl単一のHTTP URLを指すResourceFileを作成します。 -
storageContainerUrlは Azure Blob Storage コンテナを指すResourceFileを作成します。 -
autoStorageContainerNameはバッチ登録自動ストレージアカウント内のAzure Blob Storageコンテナを指すResourceFileを作成します。
-
-
httpUrlメソッドで提供ResourceFileされたURLは、現在では任意のHTTP URLで対応可能です。 以前はこれらのURLはAzure Blob Storage URLでなければなりませんでした。 -
blobPrefixストレージコンテナからのダウンロードをプレフィックスに合致するものだけにフィルタリングするために使用できます。
- ResourceFileでAzure Storageコンテナ全体を指定する機能を追加しました。 現在、ResourceFileには3つのサポートモードがあります:
[ブレイキング]
VirtualMachineConfigurationosDisk物件を撤去しました。 この物件は現在はサポートされていません。NetworkConfigurationのdynamicVNetAssignmentScopeをjobに設定したプールは、ジョブs tasks run on. The specific Virtual Network to join the nodes to is specified in the newJobNetworkConfigurationproperty onCloudJobandJobSpecification' の各ノードに動的にVirtual Networkを割り当てることができます。注
この機能はパブリック プレビュー段階にあります。 パイロットへの参加を希望してきたバッチアカウントを除き、すべてのバッチアカウントで無効化されています。
タスクの最大寿命は現在180日(以前は7日)になりました。
LoginModeを通じて特定のログインモード(batchまたはinteractive)でユーザーを作成するためのWindowsプールのサポートを追加しました。すべてのタスクのデフォルトの保持時間は現在7日で、以前は無限でした。
バージョン 2018-08-01.7.0
バージョン2018-08-01.7.0の新機能には以下が含まれます:
- ComputeNodeの新しいNodeAgentInfoプロパティを使って、Azure Batch Node Agentのバージョンを閲覧できます。
- タスクの
ResultにFilterを指定する機能が追加されました。 詳細については、こちらを参照してください。- これにより、サーバー側クエリを実行して失敗したすべてのタスクを見つけるというよく求められるシナリオが可能になります。
-
[ブレイキング] TaskCountsから
ValidationStatusプロパティを削除しました。 -
[ブレイキング]DataDiskとOSDiskのデフォルトのキャッシュタイプは
NoneではなくReadWriteになっています。 -
[ブレイキング] ContainerTypeの唯一の値を
dockerからdockerCompatibleに名前変更しました。
バージョン 2018-03-01.6.1
バージョン2018-03-01.6.1の新機能には以下が含まれます:
- 状態別のプールノードカウント:このバージョンでは、新しいListPoolNodeCounts操作を通じて状態ごとのプールノードカウントを照会する機能が追加されました。 この操作により、バッチアカウント内のすべてのプールにノードの状態を問い合わせることができます。
- Node agent logs:このバージョンでは、UploadBatchServiceLogs操作を通じて特定のノードからAzure Batchのノードエージェントログをアップロードする機能が追加されています。 このログは、ノード上で問題が発生した場合のMicrosoft Supportによるデバッグ用に意図されています。
バージョン 2017-09-01.6.0
Azure Hybrid Use Benefit : Azure Hybrid Use Benefit ライセンスを使用することを指定したバッチ Windows VM プールを作成できるようになりました。 このライセンスを使用する場合、VMの価格に割引が適用されます。 VirtualMachineConfigurationの新しい LicenseType プロパティを使用してください。
プールVMデータディスク:仮想マシン構成の一部である新しいデータディスク構成を使い、空のデータディスクを1つ以上VMプールに接続できます。 VirtualMachineConfigurationの DataDisks プロパティを使いましょう。
(チェンジ)カスタムイメージは現在、ブロブVHDファイルの代わりにAzure Resource Managerのイメージリソースを使って作成・デプロイされます。 バッチは現在、管理ディスクを使ってプールVMを作成し、 イメージ リソースを使用します。 カスタムイメージを使ってプール内で作成できるVMの数に制限はありません。また、大規模なプール用に複数のVHDブロブコピーを用意する必要もありません。 そのため、カスタムイメージプールの作成やスケールがはるかに容易です。 詳細については、「カスタムイメージを使って仮想マシンのプールを作成する」をご覧ください。
ImageReferenceの新しい VirtualMachineImageId プロパティには画像への参照が含まれており、 OSDisk.ImageUris はもはや存在しません。
この変更により、ImageReferenceはVirtualMachineConfigurationの必須プロパティとなりました。
(小銭が破れる)マルチインスタンスタスク(MultiInstanceSettingsで作成)は CoordinationCommandLineを指定する必要があり、 NumberOfInstances はオプションとなり、デフォルトは1です。
Dockerコンテナで動作するタスクのサポートが追加されました。 Dockerコンテナでタスクを実行するには、VirtualMachineConfigurationでプール用のContainerConfigurationを指定し、タスクにTaskContainerSettingsを追加する必要があります。
バージョン 2017-06-01.5.1
ここで説明されているバッチAPIのバージョンは 2017-06-01.5.1です。 可能な限り最新バージョンの使用を推奨します。
バージョン2017-06-01.5.1の新機能には以下が含まれます:
- 新しい「Get Task Counts」操作による効率的なタスクカウントのサポート。 「Get Task Counts」操作を呼び出すことで、進行中のタスク、完了済みのタスク、成功・失敗したタスクの数を取得できます。 詳細については、「州別ジョブのタスク数え(プレビュー)」をご覧ください。
- プールの計算ノード上でインバウンドエンドポイントを指定するサポートは、新しい poolEndpointConfiguration プロパティを通じて実現されました。 このプロパティを設定することで、ノード上の特定のポートを外部アドレスで設定できます。
バージョン 2017-05-01.5.0
以下のセクションでは、バージョン2017-05-01.5.0における新機能および変更点を概説します。
Important
バージョン2017-05-01.5.0にはいくつかの重大な変更が含まれています。 壊れている変更点を確認し、コードを更新してバージョン2017-05-01.5.0に切り替えてください。
低優先度の計算ノード
Azure Batchは現在、バッチワークロードのコスト削減のために低優先度の計算ノードを提供しています。 低優先度VMは、大量の計算能力を提供しつつ経済的に新しい種類のバッチワークロードを可能にします。
低優先度ノード向けのREST APIにはいくつかの変更があります:
- (小銭が破れる)プールやプール仕様の targetDedicated および currentDedicated プロパティは、 targetDedicatedNodes および currentComputeNodesに改名されました。
- (小銭が破れる)プールの resizeError プロパティは、 resizeErrorsという集合になっています。
- コンピュートノードには新しい isDedicated プロパティが付与されました。 この性質は専用ノードでは 真 であり、低優先度ノードでは 偽 です。
- ジョブマネージャーのタスクには新しい allowLowPriorityNode プロパティがあります。 この特性が 成り立つ場合、ジョブマネージャータスクは低優先度のノード上で実行されることがあります。 もし これがfalseであれば、ジョブマネージャータスクは専用のコンピュートノード上で実行されます。
Linuxのネームユーザー
Azure Batchは現在、Linuxノード上で名前付きユーザーを作成するための追加サポートを提供しています。
- 新しい linuxUserConfiguration プロパティは、Linuxユーザーを作成する際に uid (ユーザーID)と gid (グループID)を指定することをサポートしています。
- (小銭が破れる) sshPrivateKey プロパティは userAccount プロパティから新しい linuxUserConfiguration プロパティに移されました。 linuxUserConfigurationプロパティ自体はuserAccountプロパティのプロパティです。
名前付きユーザーアカウントの詳細については、「バッチ内のユーザーアカウント」の「タスク実行」をご覧ください。
タスクデータの出力ファイル
タスク完了後に出力ファイルをアップロードできるようになった。
- 新しい outputFilesプロパティは、Azure Storageにアップロードするタスクファイルの指定をサポートします。
- exitConditionsプロパティの新しいfileUploadErrorプロパティは、出力ファイルのアップロード状況に基づいて取るべきアクションを指定することをサポートします。
タスクエラー報告
タスクエラーの報告を改善するためにいくつかの変更が加えられました。
- executionInfoプロパティの新しい結果プロパティは、タスクが成功したか失敗したかを示します。
- (小銭が破れる)executionInfoプロパティのschedulelingErrorプロパティはfailInfoに名前が変更されました。 failureInfoプロパティはタスク失敗が起きたときに必ず返されます。 これには、過去のすべてのスケジューリングエラー、ゼロでないタスク終了コードが返されたすべてのケース、ファイルアップロード失敗が含まれます。
- (小銭が破れる)exitConditionsプロパティのschedulelingErrorプロパティは、エラーがタスクライフサイクル中にいつ発生したかを明確にするためにpreProcessingErrorに名前変更されました。
- (小銭が破れる) schedulelingErrorCateogry プロパティは errorCategoryに名前が変更されました。
アプリケーションライセンス
現在、プールやプール仕様の新しい applicationLicenses プロパティを通じて、アプリケーションライセンスをプールにプロビジョニングするようリクエストできます。
バージョン 2017-01-01.4.0
このバージョンリリースは、前バージョン2016-07-01.3.1からすべてのサポートを拡張しています。 さらに、以下の機能もサポートしています:
指定されたユーザー識別でタスクを実行します。
タスクリソースの新しい userIdentity プロパティで指定する以下のいずれかのユーザーアイデンティティでタスクやタスクコレクションを実行することができます。
あなたが定義した名前のユーザーアカウントです。
自動で作成されるユーザーアカウント(オートユーザー)。 オートユーザーは管理者ユーザーとしても非管理者ユーザーとしても動作します。 デフォルトではオートユーザーは非管理者ユーザーとして動作します。
Important
userIdentityプロパティはelevationLevelプロパティとともに、タスクやタスクコレクションを追加するリクエストや、タスクに関する情報やタスクリストの応答でrunElevatedプロパティを置き換えます。
バッチサービスのバージョン2017-01-01.4.0に runElevated プロパティを含むリクエストをすると、リクエストは失敗します。
管理ユーザーとして動作させるには、アプリケーションを userIdentity プロパティを使うように更新し、 elevationLevel プロパティを adminに設定します。
非管理者ユーザーとして実行するには、 userIdentity プロパティを使い、 elevationLevel プロパティを nonAdminに設定してアプリケーションを更新してください。 この設定がデフォルトなので、設定を省略することも可能です。
プール内のすべてのノードにわたるユーザーアカウントを定義します。
これで、プールリソース上で自分で定義したユーザーアカウントでタスクやタスクコレクションを実行することができます。 Request to Add Poolの新しい userAccounts プロパティを使ってユーザーアカウントを定義してください。 アカウントを定義する際には、アカウント名、パスワード、権限レベル(管理者か非管理者か)、そしてSSH秘密鍵(Linuxプール用)を指定できます。
ユーザーアカウントを定義したら、タスクやタスクコレクションを追加するリクエストで userIdentity プロパティを指定できます。
タスクが実行された際にバッチサービスに認証するためのトークンをタスクに提供します。
バッチサービスはタスク実行時に認証トークンを提供できるようになりました。 認証トークンにより、タスクはバッチアカウントキーなしでジョブ関連のリクエストをバッチサービスに発行できます。 トークンは、AZ_BATCH_AUTHENTICATION_TOKEN環境変数を介して提供されます。
現在、認証トークンはジョブリソースの呼び出し操作のみにサポートされています。 認証トークンは、タスクを含むジョブ上のすべての操作へのアクセスを許可します。
バッチサービスに認証トークンを提供するには、タスク追加またはタスクコレクション追加のリクエストで、新しい authenticationTokenSettings プロパティとその アクセス プロパティを指定します。
タスクが失敗した場合にタスクの依存関係に対して取るべきアクションを指定します。
依存するタスクが失敗しても、従属タスクは進行するように指定できます。 タスクリソースの新しい dependencyAction プロパティを、親タスクが失敗しても依存タスクを実行することが satif( を満たす)ように設定します。 あるいは、親タスクが失敗した場合に依存タスクの実行を防ぐために、 dependencyAction を ブロック に設定する方法もあります。
タスク追加またはタスクコレクション追加のリクエストで dependencyAction プロパティを指定します。
依存性アクションの使用についての詳細は「依存性アクション」を参照してください。
プールを作成する際にはカスタムOSのディスクイメージを使用してください。
カスタムOSのディスクイメージを使ってプールを作成できるようになりました。
そのためには、バッチアカウントを作成する際に、プールをバッチサービスが管理するサブスクリプションではなく、ユーザーサブスクリプションでプロビジョニングすることを指定する必要があります。 アカウント作成の呼び出しでは、 poolAllocationMode プロパティを UserSubscriptionに設定します。 その後、 osDisk プロパティを使って「Add Pool」へのリクエストでディスクイメージへの参照を指定します。
Important
バッチアカウントを作成する際、ユーザーサブスクリプションでプールをプロビジョニングする指定をしている場合、そのアカウントを通じてのすべてのリクエストに対してAzure Active Directoryベースの認証を使用しなければなりません。
バッチサービスへのリクエストに対してAzure Active Directoryベースの認証を使用。
Azure Active Directory(Azure AD)は、バッチサービスへの呼び出し認証に現在サポートされています。
もしBatchアカウントがユーザーサブスクリプションでプールのプロビジョニングを設定するように設定されている場合、Azure AD認証の使用が必要です。
バージョン 2016-07-01.3.1
このバージョンリリースは、以前のバージョンである2016-02-01.3.0からすべてのサポートを拡張しています。 さらに、以下の機能もサポートしています:
ネットワーク構成でプールとオートプールを作成する機能
- 新しいプロパティネットワーク:プールとオートプールの両方のリソースにConfigurationが追加されました。 このプロパティは、プール
s network configuration, such as the subnet in which the pool計算ノードが作成される箇所を指定するために利用できます。
- 新しいプロパティネットワーク:プールとオートプールの両方のリソースにConfigurationが追加されました。 このプロパティは、プール
すべてのタスクが完了したら自動的にジョブを終了します。
- 新しいプロパティが onAllTasksComplete のジョブリソースに追加されました。 ジョブを作成または更新する際にこのプロパティを指定することができます。
タスクが失敗した際にジョブを自動的に終了または無効化します。
- ジョブリソースに新しいプロパティ onTaskFailure、タスクリソースに新しいプロパティ exitConditionsが追加されました。 jobTaskFailureの設定は、タスク失敗がジョブレベルに影響を与えるかどうかを示し、タスクexitConditionsプロパティはタスクレベルの影響を失敗の性質に合わせて調整できるようにします。
アプリケーションパッケージをタスクやプールと関連付けてください。
- タスクリソースとジョブManagerTask設定に追加された新しいプロパティapplicationPackageReferences。 この特性により、タスクの必要に応じてアプリケーションパッケージをオンデマンドで展開できるようになり、プール作成時に指定する必要がなくなります。 この特性は、生涯にわたって異なる種類のジョブや異なるアプリケーションバージョンを実行する長寿命プールにとって特に価値があります。
失敗したタスクを再活性化する能力。
- 失敗したタスクの状態をアクティブにリセットする新しい操作「Reactivate a task」が追加されました。 これにより、例えば一時的な失敗や原因を修正できた場合でも、タスクを再作成せずに再挑戦が可能です。
バージョン 2016-02-01.3.0
このバージョンリリースは、以前のバージョンである2015-12-01.2.2からすべてのサポートを拡張しています。 さらに、以下の機能もサポートしています:
IaaS VM構成でプールおよびオートプールを作成する機能
既存の物件
osFamily、targetOSVersion、currentOSVersionは、プールおよびオートプール資源の最上層物件から移され、新しい物件として「cloudServiceConfiguration」と呼ばれる建物内に移されます。プールとオートプールの両方のリソースに新しい物件
virtualMachineConfigurationが追加されます。 このプロパティは、IaaS VMでプール/オートプールを設定するために指定できます。バッチサービスでサポートされているすべてのノードエージェントSKUに関する情報を取得するための新しいAPIが追加されました。 リスト対応ノードエージェントSKUを参照してください。
新しいAPIが追加され、IaaS VM構成で作成された計算ノードにリモートでログインできるリモートログイン設定を取得できます。 ノードのリモートログイン設定を入手してください。
新しいAPIが追加され、ジョブにタスクの集合を追加します。 「ジョブにタスクの集合を追加する」を参照してください。
Linuxコンピュートノード上のユーザーの追加・更新に使用できる、新しいオプションプロパティ
sshPublicKeyがユーザーリソースに追加されます。ノードリソースには新しいプロパティ
totalTasksSucceededとrunningTasksCountが追加されます。 これらのプロパティは、ノード情報を取得するか、プール内の計算ノードをリストすることで得られます。ResourceFile複素型に新しい性質fileModeが追加されます。 この特性はLinuxの計算ノードにのみ適用され、Windowsの計算ノードでは無視されます。FileProperties複素型に新しい性質fileModeが追加されます。 このプロパティは、Linuxの計算ノード向けにBatchサービスによってGetFilePropertiesまたはListFileProperties APIの一部として返されます。 また、FileProperties複合体型の既存のプロパティcreationTimeがオプションに変更されます。なぜなら、このプロパティはLinuxのコンピュートノードには返されないからです。既存のプロパティ
visibilityCertificateReference複素型内のデータ型は、コンマ区切られた値を持つ文字列から文字列の集合へと変更されます。 また、既存の可視性の数値の一つが「rdp」から「remoteuser」に名前変更されています。
以下のAPIのURLは、アクション名の「?」を「/」に変更しています:
プールの性質を置き換える
プールの自動スケーリングを無効にしてください
プールの自動スケーリングを有効にする
自動スケーリング式の評価
プールのサイズを変更する
プールのサイズを変えるのはやめましょう
プール内の計算ノードのオペレーティングシステムをアップグレードする
プールから計算ノードを削除する
ノードを再起動する
ノードの再イメージ化
ノードのタスクスケジューリングを無効にする
ノード上でタスクスケジューリングを有効にする
ジョブスケジュールを無効にする
ジョブスケジュールを有効にする
仕事のスケジュールを終了する
ジョブを無効にする
ジョブを有効にする
仕事を終了する
タスクを終了する
証明書の削除をキャンセルしてください
バージョン 2015-12-01.2.2
このバージョンリリースは、以前のバージョンである2015-11-01.2.1からすべてのサポートを拡張しています。 さらに、以下の機能もサポートしています:
アプリケーションはリソースファイルではなくアプリケーションパッケージを使って計算ノードにデプロイできるようになりました。
クライアントが利用可能なアプリケーションやバージョンのリストを閲覧できる新しいAPIも提供されており、例えばユーザーインターフェースでセレクターを表示することができます。
プール関連APIは、プール内のすべてのノードにダウンロードするアプリケーションパッケージを指定できるように変更されます。
タスクは他のタスクに依存して設定できるようになりました。 依存タスクは、依存するすべてのタスクが正常に完了するまで開始されません。
このバージョンリリースには以下の変更点が含まれています:
- デフォルトのプールサイズ変更タイムアウトは15分に変更されました。
バージョン 2015-11-01.2.1
このバージョンリリースは、以前のバージョン2015-06-01.2.0からすべてのサポートを拡張しています。 さらに、以下の機能もサポートしています:
マルチインスタンスタスクの追加および実行機能(例:MPI)
タスクリソースには新しいオプションプロパティ
multiInstanceSettingsが追加され、タスク追加、タスク取得、タスクリストAPIにオプションで含めることができます。新しいAPI:タスクのサブタスクを追加して、サブタスクに関する情報を取得します。
計算ノードに対して新しいオプションプロパティ
subtaskIdがrecentTasksに追加されます。 このプロパティはGet Compute NodeおよびList Compute Nodesの一部として返されます
計算ノード上でタスクスケジューリングを無効化または有効化する機能
コンピュートノードリソースに、ノード上のタスクスケジューリングを無効化するという2つの新しいAPI、ノード上のタスクスケジューリングを有効にする機能が追加されました。
新しい計算ノードの状態
offlineが追加されます。 古いAPIバージョンでは、この状態はunusableにマッピングされています。新しいプロパティ
schedulingStateが計算ノードリソースに追加されます。enabledとdisabledの可能な値。
プール/オートプールで自動 -scale 評価間隔を指定する機能
プール資源に新しい不動産
autoScaleEvaluationIntervalが追加されます。 このプロパティは、Add Pool、Get Pool、Enable Auto -Scale、List Pools APIに含めることができます。同様に、オートプールの場合、新しい物件
autoScaleEvaluationIntervalがautoPoolSpecification物件に追加されます。 このプロパティは、ジョブ追加、ジョブ取得、ジョブリスト、ジョブスケジュール追加、ジョブスケジュール取得、更新ジョブスケジュール、ジョブスケジュール一覧、ジョブスケジュールAPI内のジョブリストに含めることができます。
タスクAPIの強化により、計算ノード上のタスクのルートディレクトリが返されます。
タスクリソースには、タスク情報を得るための「タスク情報取得」「タスク一覧API」の一部として取得可能な2つの新しいプロパティ
taskRootDirectoryとtaskRootDirectoryUrlが追加されました新しいプロパティ
taskRootDirectoryがjobPreparationTaskExecutionInfoおよびjobReleaseTaskExecutionInfoに追加され、ジョブAPIのジョブ準備およびジョブリリースタスクのステータスをリストすることで取得できます。