バッチ管理 REST API バージョン管理

バッチ管理REST APIが提供する操作は、APIが進化するにつれて後方互換性のために複数のバージョンを持つことがあります。 呼び出し時に使用するバージョンを指定するために、RESTコールでバージョンを指定する必要があります。 アプリケーションが操作の古いバージョンを呼び出した場合、古いバージョンを引き続き呼び出すか、コードを修正して新しいバージョンを呼び出すかを選択できます。 バージョンが指定されていないか、誤ったバージョンが指定されている場合、エラーが返されます。

どのバージョンを使う操作かを指定するには、 api-version クエリパラメータを設定します。 このバージョンは YYYY-MM-DDのフォーマットです。

最新バージョン:2025-06-01

  • 職務レベルのFIFO

    • タイプ JobDefaultOrder 追加しました。
    • 新しいjobDefaultOrderプロパティで拡張TaskSchedulingPolicy、ジョブレベルのFIFOスケジューリングを支援しました。

  • プールにおけるCMKサポート

  • プールにおけるIPv6サポート

  • プールにおけるメタデータセキュリティプロトコルのサポート

  • IPタグサポート

    • タイプ IPTag 追加しました。
    • IPタグサポートのための新しいipTagsプロパティを用いた拡張PublicIPAddressConfiguration。

  • [ブレイキング]証明書のサポートが削除されました:

    • 削除された証明書API: Certificate_ListByBatchAccount、 Certificate_Get、 Certificate_Create、 Certificate_Update、 Certificate_Delete、 Certificate_CancelDeletion。
    • 削除された証明書モデル: Certificate、 CertificateCreateOrUpdateParameters、 CertificateBaseProperties、 CertificateCreateOrUpdateProperties、 CertificateProperties、 CertificateFormat、 CertificateProvisioningState、 CertificateReference、 CertificateStoreLocation、 CertificateVisibility、 DeleteCertificateError。
    • プールから certificates 物件を削除しました。

  • [ブレイキング]Poolから NodeCommunicationMode モデルとプロパティ targetNodeCommunicationMode および currentNodeCommunicationMode を削除しました。

  • [ブレイキング]プールから applicationLicenses 物件を削除しました。

  • [ブレイキング]DataDiskからstorageAccountTypeを削除しました。 ManagedDisk.storageAccountType を代わりに使用します。

  • [ブレイキング]プールから resourceTags を削除しました。

以前のバージョン

過去のバージョンには以下が含まれます:

バージョン:2024年7月1日

  • ネットワークセキュリティペリメーター(NSP)サポートの追加:

    • バッチアカウント NetworkSecurityPerimeter_ListConfigurations すべてのNSP設定をリストアップする操作を追加しました。
    • 特定のNSP構成を取得するための NetworkSecurityPerimeter_GetConfiguration 操作を追加しました。
    • NSP構成を調整するための NetworkSecurityPerimeter_ReconcileConfiguration 操作を追加しました。
    • 列挙 SecuredByPerimeter 価値 PublicNetworkAccessType 加えました。

  • 機密VMサポートの追加:

    • securityEncryptionTypeプロパティVMDiskSecurityProfileモデルを追加しました。
    • securityProfile ManagedDisk不動産を追加しました。
    • 列挙の新しい値として confidentialVM を追加 SecurityTypes 。

  • 共有ギャラリーおよびコミュニティギャラリー画像参照のサポートを追加:

    • sharedGalleryImageIdにcommunityGalleryImageIdとImageReferenceプロパティを追加しました。

  • タスクに対するコンテナバインドマウントのサポートが追加されました:

  • [ブレイキング]クラウドサービス構成プールのサポートを廃止しました:

    • モデル CloudServiceConfiguration 削除しました。
    • cloudServiceConfigurationからDeploymentConfigurationプロパティを削除しました。
    • 操作 Location_ListSupportedCloudServiceSkus 外した。

バージョン:2024-02-01

  • VMプールに対するOSアップグレードポリシーのサポートを追加:

    • プロパティmode、automaticOSUpgradePolicy、rollingUpgradePolicyUpgradePolicyモデルを追加しました。
    • プロパティdisableAutomaticRollback、enableAutomaticOSUpgrade、useRollingUpgradePolicy、osRollingUpgradeDeferralを持つモデルAutomaticOSUpgradePolicy追加。
    • RollingUpgradePolicy、プロパティenableCrossZoneUpgrade、maxBatchInstancePercent、maxUnhealthyInstancePercent、maxUnhealthyUpgradedInstancePercent、pauseTimeBetweenBatches、prioritizeUnhealthyInstances、rollbackFailedInstancesOnPolicyBreachを持つモデルを追加しました。
    • プールに upgradePolicy 物件を追加しました。
    • UpgradeMode automatic、manual、rollingの値を持つ列挙が追加されました。

  • batchSupportEndOfLife SupportedSku不動産を追加しました。

バージョン:2023年11月1日

  • VMプールに対するTrusted Launch/セキュリティプロファイルのサポートを追加:

    • プロパティencryptionAtHost、securityType、uefiSettingsSecurityProfileモデルを追加しました。
    • プロパティsecureBootEnabledとvTpmEnabledを持つUefiSettingsモデルを追加しました。
    • 値 SecurityTypestrustedLaunch の列挙が追加されました。
    • securityProfile VirtualMachineConfiguration不動産を追加しました。

  • スケールセット向けのサービスアーティファクト参照のサポートが追加されました:

    • 必要なidプロパティServiceArtifactReferenceモデルを追加しました。
    • serviceArtifactReference VirtualMachineConfiguration不動産を追加しました。

  • 強化OSディスク構成:

    • storageAccountTypeプロパティManagedDiskモデルを追加しました。
    • caching、diskSizeGB、managedDisk、writeAcceleratorEnabledプロパティを追加OSDisk。

  • StandardSSD_LRSの新しい値としてStorageAccountTypeを追加しました。

  • Poolにユーザー定義タグをAzureのバックアップリソースに伝播させるためのプロパティ resourceTags 追加しました。 poolAllocationMode が UserSubscriptionされている場合にのみ適用されます。

バージョン:2023-05-01

  • enableAcceleratedNetworkingにブール属性NetworkConfigurationを追加しました。

    • この性質により、このプールが加速されたネットワークを有効にするかどうかが決定され、デフォルト値はfalseとなります。
    • この機能が有効化できるかどうかは、オペレーティングシステムやVMインスタンスがサポートされているかどうかにも関係しており、これはAcceleratedNetworking Policyに準拠しているはずです。

  • enableAutomaticUpgradeにブール属性VMExtensionを追加しました。

    • この特性により、拡張の新しいバージョンが利用可能な場合に自動的にアップグレードされるかどうかが決定されます。

  • ContainerConfigurationのプロパティtypeは現在、DockerCompatibleとCriCompatibleの2つの値を支持しています。

バージョン:2022年10月1日

  • NodeCommunicationMode、Default、Classic、Simplifiedの値を付けたenumを追加し、プールがバッチサービスとどのように通信するかを決定します。
  • プール currentNodeCommunicationMode 現在の通信モードの状態を参照するプロパティを追加しました。
  • プール targetNodeCommunicationMode 希望するノード通信モードを参照するプロパティを追加しました。

バージョン:2022-06-01

  • プライベートエンドポイント接続を削除する操作 PrivateEndpointConnection_Delete 追加しました。
  • 認証モードを制御するためのBatchAccountCreatePropertiesおよびBatchAccountUpdatePropertiesにallowedAuthenticationModesプロパティを追加しました。
  • 列挙の新しい値として TaskAuthenticationToken を追加 AuthenticationMode 。

バージョン:2022-01-01

  • 特定の場所でサポートされているVM SKUを一覧表示する Location_ListSupportedVirtualMachineSkus 操作を追加しました。
  • プロパティname、familyName、capabilitiesSupportedSkuモデルを追加しました。
  • モデル SupportedSkusResult 追加しました。
  • モデル SkuCapability 追加しました。

バージョン:2021-06-01

  • ユーザー割り当ての管理IDを BatchPoolIdentityに割り当てる機能が追加されました。
  • マネージドID経由でリソースにアクセスするために、AzureBlobFileSystemConfiguration、ContainerRegistry、ResourceFileにidentityReferenceプロパティを追加しました。
  • VM拡張機能のサポート追加:
  • 新しいプロパティ nodePlacementConfiguration を用いて VirtualMachineConfigurationで可用性ゾーンを指定する機能を追加しました。
  • VirtualMachineConfiguration osDisk一時的なOSディスクサポートをDiffDiskSettingsでサポートするプロパティを追加しました。

バージョン:2021-01-01

バージョン:2020-09-01

  • Poolに taskSlotsPerNode プロパティを追加し、固定されたノードごとのタスク動作を置き換えました。
  • 公共ネットワークアクセスを制御するための BatchAccountProperties.publicNetworkAccess を追加しました。
  • エンドポイントごとのネットワークアクセスルールを制御するモデル NetworkProfile 追加しました。

バージョン:2020-05-01

バージョン:2020-03-01

バージョン:2019-08-01

バージョン:2019-04-01

バージョン:2018年12月1日

  • コンテナ対応プール containerConfigurationVirtualMachineConfiguration にプロパティを追加しました。
  • Poolに完全なStartTaskモデルサポート付きプロパティを追加startTask。
  • データディスクの接続 dataDisks プロパティを追加 VirtualMachineConfiguration 。
  • Azure Hybrid Use Benefit のために licenseType プロパティを追加 VirtualMachineConfiguration 。
  • 値StorageKeysとBatchAccountManagedIdentityのエナギュAutoStorageAuthenticationModeを追加しました。
  • nodeIdentityReference AutoStorageBaseProperties不動産を追加しました。
  • subnetId、endpointConfiguration、dynamicVnetAssignmentScopeプロパティを持つモデルを追加NetworkConfiguration。
  • インバウンドエンドポイントを指定するための PoolEndpointConfiguration モデルおよび InboundNatPool モデルを追加しました。

バージョン:2017-09-01

  • ARMを通じたプール管理サポートの追加:
    • Pool_ListByBatchAccount、Pool_Get、Pool_Create、Pool_Update、Pool_Deleteの操作が追加されました。
    • Pool_DisableAutoScaleとPool_StopResizeの作戦が追加されました。
    • 包括的なプール施設 Pool 資源モデルを追加しました。
  • ARMによる証明書管理の追加:
    • Certificate_ListByBatchAccount、Certificate_Get、Certificate_Create、Certificate_Update、Certificate_Delete、Certificate_CancelDeletionの操作が追加されました。
  • アプリケーションおよびアプリケーションパッケージ管理の追加:
    • Application_List、Application_Get、Application_Create、Application_Update、Application_Deleteの操作が追加されました。
    • ApplicationPackage_List、ApplicationPackage_Get、ApplicationPackage_Create、ApplicationPackage_Delete、ApplicationPackage_Activateの操作が追加されました。
  • IaaS VMベースのプール構成 VirtualMachineConfiguration モデルを追加しました。
  • プールサイズ ScaleSettings 制御用の FixedScaleSettings と AutoScaleSettings を備えたモデルを追加しました。

バージョン:2017年5月1日

  • Azure Key Vault KeyVaultReference バッチアカウントとの統合モデルを追加しました。
  • BatchServiceモードとUserSubscriptionモードpoolAllocationMode Channel BatchAccountCreatePropertiesのプロパティを追加しました。
  • dedicatedCoreQuotaPerVMFamilyにdedicatedCoreQuotaPerVMFamilyEnforcedとBatchAccountPropertiesプロパティを追加しました。
  • lowPriorityCoreQuota BatchAccountProperties不動産を追加しました。

バージョン:2017-01-01

  • 自動ストレージ設定によるユーザー割り当てストレージアカウントのサポートを追加。
  • storageAccountId AutoStorageBaseProperties不動産を追加しました。
  • lastKeySyncプロパティAutoStoragePropertiesモデルを追加しました。
  • 手術 BatchAccount_SynchronizeAutoStorageKeys 追加。

バージョン:2015年12月1日

これはバッチ管理REST APIの初期バージョンです。 以下のコア機能を提供します:

  • バッチアカウント管理:
    • BatchAccount_Create - 指定されたパラメータで新しいバッチアカウントを作成する。
    • BatchAccount_Update - 既存のバッチアカウントのプロパティを更新します。
    • BatchAccount_Delete - 指定されたバッチアカウントを削除します。
    • BatchAccount_Get - 指定されたバッチアカウントに関する情報を取得する。
    • BatchAccount_List - サブスクリプションの下にあるすべてのバッチアカウントを一覧化します。
    • BatchAccount_ListByResourceGroup - リソースグループの下にあるすべてのバッチアカウントを一覧表示します。
    • BatchAccount_GetKeys - 指定されたバッチアカウントのアカウントキーを取得する。
    • BatchAccount_RegenerateKey - バッチアカウントの指定されたアカウントキーを再生成します。
  • ロケーション運営:
    • Location_GetQuotas - 指定されたサブスクリプションのバッチサービスクォータを指定された場所で取得します。
  • 運営:
    • Operations_List - バッチプロバイダーの利用可能な操作を一覧化します。
  • Last updated on