AutoPoolSpecification interface
AutoPoolSpecification を表すインターフェイス。
プロパティ
| auto |
プールが自動的に作成されるときに一意の識別子に追加されるプレフィックス。 Batch サービスは、作成時に各自動プールに一意の識別子を割り当てます。 さまざまな目的で作成されたプールを区別するために、この要素を指定して、割り当てられている ID にプレフィックスを追加できます。 プレフィックスは最大 20 文字です。 |
| keep |
自動プールの有効期間が切れた後も有効な状態を維持するかどうかを指定します。 false の場合、Batch サービスは、(poolLifetimeOption 設定によって決定される) 有効期間が経過するとプールを削除します。つまり、ジョブまたはジョブ スケジュールが完了したときです。 true の場合、Batch サービスはプールを自動的に削除しません。 このオプションで作成された自動プールは、ユーザーが削除する必要があります。 |
| pool | 自動プールのプール仕様。 |
| pool |
作成された自動プールの最小有効期間、およびスケジュール上の複数のジョブをプールに割り当てる方法。 指定できる値は、'jobSchedule'、'job' です。 |
プロパティの詳細
autoPoolIdPrefix
プールが自動的に作成されるときに一意の識別子に追加されるプレフィックス。 Batch サービスは、作成時に各自動プールに一意の識別子を割り当てます。 さまざまな目的で作成されたプールを区別するために、この要素を指定して、割り当てられている ID にプレフィックスを追加できます。 プレフィックスは最大 20 文字です。
autoPoolIdPrefix?: stringプロパティ値
string
keepAlive
自動プールの有効期間が切れた後も有効な状態を維持するかどうかを指定します。 false の場合、Batch サービスは、(poolLifetimeOption 設定によって決定される) 有効期間が経過するとプールを削除します。つまり、ジョブまたはジョブ スケジュールが完了したときです。 true の場合、Batch サービスはプールを自動的に削除しません。 このオプションで作成された自動プールは、ユーザーが削除する必要があります。
keepAlive?: booleanプロパティ値
boolean
pool
poolLifetimeOption
作成された自動プールの最小有効期間、およびスケジュール上の複数のジョブをプールに割り当てる方法。 指定できる値は、'jobSchedule'、'job' です。
poolLifetimeOption: PoolLifetimeOption