次の方法で共有


Pool class

プールを表すクラス。

コンストラクター

Pool(BatchServiceClientContext)

プールを作成します。

メソッド

add(PoolAddParameter, PoolAddOptionalParams)

プールに名前を付ける場合は、ユーザー名やシークレット プロジェクト名などの機密情報を含めないでください。 この情報は、Microsoft サポート エンジニアがアクセスできるテレメトリ ログに表示される場合があります。

add(PoolAddParameter, PoolAddOptionalParams, ServiceCallback<void>)
add(PoolAddParameter, ServiceCallback<void>)
deleteMethod(string, PoolDeleteMethodOptionalParams)

プールの削除を要求すると、プールの状態が削除に設定されているアクションが発生します。プールで進行中のサイズ変更操作は停止されます。Batch サービスは、プールのサイズを 0 個のコンピューティング ノードに変更し始めます。既存のコンピューティング ノードで実行されているタスクはすべて終了して再キューされます (既定の requeue オプションを使用してプールのサイズ変更操作が要求された場合と同様)。最後に、プールがシステムから削除されます。 実行中のタスクは再キューされるため、ユーザーはジョブを更新して別のプールをターゲットにすることで、これらのタスクを再実行できます。 その後、タスクは新しいプールで実行できます。 再キューの動作をオーバーライドする場合は、プールを削除する前に、サイズ変更プールを明示的に呼び出してプールを 0 サイズに縮小する必要があります。 削除中の状態のプールで Update、Patch、または Delete API を呼び出すと、エラー コード PoolBeingDeleted で HTTP 状態コード 409 で失敗します。

deleteMethod(string, PoolDeleteMethodOptionalParams, ServiceCallback<void>)
deleteMethod(string, ServiceCallback<void>)
disableAutoScale(string, PoolDisableAutoScaleOptionalParams)
disableAutoScale(string, PoolDisableAutoScaleOptionalParams, ServiceCallback<void>)
disableAutoScale(string, ServiceCallback<void>)
enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams)

プールでサイズ変更操作が進行中の場合、プールで自動スケーリングを有効にすることはできません。 プールの自動スケーリングが現在無効になっている場合は、要求の一部として有効な自動スケール式を指定する必要があります。 プールの自動スケーリングが既に有効になっている場合は、新しい自動スケール式または新しい評価間隔を指定できます。 同じプールに対してこの API を 30 秒ごとに複数回呼び出すことはできません。

enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams, ServiceCallback<void>)
enableAutoScale(string, PoolEnableAutoScaleParameter, ServiceCallback<void>)
evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams)

この API は、プールに数式を適用せずに結果を返すだけなので、主に自動スケール式を検証するための API です。 数式を評価するには、プールで自動スケーリングが有効になっている必要があります。

evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams, ServiceCallback<AutoScaleRun>)
evaluateAutoScale(string, string, ServiceCallback<AutoScaleRun>)
exists(string, PoolExistsOptionalParams)

プールの基本プロパティを取得します。

exists(string, PoolExistsOptionalParams, ServiceCallback<boolean>)
exists(string, ServiceCallback<boolean>)
get(string, PoolGetOptionalParams)

指定したプールに関する情報を取得します。

get(string, PoolGetOptionalParams, ServiceCallback<CloudPool>)
get(string, ServiceCallback<CloudPool>)
getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams)

統計は、アカウントの作成から統計の最後の更新時刻まで、アカウントに存在したすべてのプールで集計されます。 統計をすぐに使用できない場合があります。 Batch サービスは、統計の定期的なロールアップを実行します。 一般的な遅延は約 30 分です。

getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams, ServiceCallback<PoolStatistics>)
getAllLifetimeStatistics(ServiceCallback<PoolStatistics>)
list(PoolListOptionalParams)
list(PoolListOptionalParams, ServiceCallback<CloudPoolListResult>)
list(ServiceCallback<CloudPoolListResult>)
listNext(string, PoolListNextOptionalParams)
listNext(string, PoolListNextOptionalParams, ServiceCallback<CloudPoolListResult>)
listNext(string, ServiceCallback<CloudPoolListResult>)
listUsageMetrics(PoolListUsageMetricsOptionalParams)

poolId を含む$filter句を指定しない場合、応答には、返された集計間隔の時間範囲内のアカウントに存在していたすべてのプールが含まれます。 startTime または endTime を含む$filter句を指定しない場合、これらのフィルターは、現在使用可能な最後の集計間隔の開始時刻と終了時刻に既定で設定されます。つまり、最後の集計間隔のみが返されます。

listUsageMetrics(PoolListUsageMetricsOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)
listUsageMetrics(ServiceCallback<PoolListUsageMetricsResult>)
listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams)

poolId を含む$filter句を指定しない場合、応答には、返された集計間隔の時間範囲内のアカウントに存在していたすべてのプールが含まれます。 startTime または endTime を含む$filter句を指定しない場合、これらのフィルターは、現在使用可能な最後の集計間隔の開始時刻と終了時刻に既定で設定されます。つまり、最後の集計間隔のみが返されます。

listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)
listUsageMetricsNext(string, ServiceCallback<PoolListUsageMetricsResult>)
patch(string, PoolPatchParameter, PoolPatchOptionalParams)

これにより、要求で指定された Pool プロパティのみが置き換えられます。 たとえば、プールに StartTask が関連付けられている場合、要求で StartTask 要素が指定されていない場合、プールは既存の StartTask を保持します。

patch(string, PoolPatchParameter, PoolPatchOptionalParams, ServiceCallback<void>)
patch(string, PoolPatchParameter, ServiceCallback<void>)
removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams)

この操作は、プールの割り当て状態が安定している場合にのみ実行できます。 この操作を実行すると、割り当ての状態が安定状態からサイズ変更に変わります。

removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams, ServiceCallback<void>)
removeNodes(string, NodeRemoveParameter, ServiceCallback<void>)
resize(string, PoolResizeParameter, PoolResizeOptionalParams)

プールのサイズを変更できるのは、その割り当て状態が安定している場合のみです。 プールのサイズが既に変更されている場合、要求は状態コード 409 で失敗します。 プールのサイズを変更すると、プールの割り当ての状態が安定した状態からサイズ変更に変わります。 自動スケーリング用に構成されているプールのサイズを変更することはできません。 これを行おうとすると、Batch サービスからエラー 409 が返されます。 プールのサイズを下方向に変更すると、削除するコンピューティング ノードが Batch サービスによって選択されます。 特定のコンピューティング ノードを削除するには、代わりにプールのコンピューティング ノードの削除 API を使用します。

resize(string, PoolResizeParameter, PoolResizeOptionalParams, ServiceCallback<void>)
resize(string, PoolResizeParameter, ServiceCallback<void>)
stopResize(string, PoolStopResizeOptionalParams)

これにより、サイズ変更操作の前にプールが以前の状態に復元されることはありません。それ以降の変更が停止されるだけで、プールは現在の状態を維持します。 停止後、プールは停止操作が完了した時点のコンピューティング ノードの数で安定します。 停止操作中、プール割り当ての状態は最初に停止状態に変わり、次に安定状態に変わります。 サイズ変更操作は、明示的なサイズ変更プール要求である必要はありません。この API は、作成時にプールの初期サイズ設定を停止するためにも使用できます。

stopResize(string, PoolStopResizeOptionalParams, ServiceCallback<void>)
stopResize(string, ServiceCallback<void>)
updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams)

これにより、プールのすべての更新可能なプロパティが完全に置き換えられます。 たとえば、プールに StartTask が関連付けられている場合、この要求で StartTask が指定されていない場合、Batch サービスは既存の StartTask を削除します。

updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams, ServiceCallback<void>)
updateProperties(string, PoolUpdatePropertiesParameter, ServiceCallback<void>)

コンストラクターの詳細

Pool(BatchServiceClientContext)

プールを作成します。

new Pool(client: BatchServiceClientContext)

パラメーター

client
BatchServiceClientContext

サービス クライアントへの参照。

メソッドの詳細

add(PoolAddParameter, PoolAddOptionalParams)

プールに名前を付ける場合は、ユーザー名やシークレット プロジェクト名などの機密情報を含めないでください。 この情報は、Microsoft サポート エンジニアがアクセスできるテレメトリ ログに表示される場合があります。

function add(pool: PoolAddParameter, options?: PoolAddOptionalParams): Promise<PoolAddResponse>

パラメーター

pool
PoolAddParameter

追加するプール。

options
PoolAddOptionalParams

省略可能なパラメーター

戻り値

Promise<PoolAddResponse>

Promise<Models.PoolAddResponse応答>

add(PoolAddParameter, PoolAddOptionalParams, ServiceCallback<void>)

function add(pool: PoolAddParameter, options: PoolAddOptionalParams, callback: ServiceCallback<void>)

パラメーター

pool
PoolAddParameter

追加するプール。

options
PoolAddOptionalParams

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

add(PoolAddParameter, ServiceCallback<void>)

function add(pool: PoolAddParameter, callback: ServiceCallback<void>)

パラメーター

pool
PoolAddParameter

追加するプール。

callback

ServiceCallback<void>

コールバック

deleteMethod(string, PoolDeleteMethodOptionalParams)

プールの削除を要求すると、プールの状態が削除に設定されているアクションが発生します。プールで進行中のサイズ変更操作は停止されます。Batch サービスは、プールのサイズを 0 個のコンピューティング ノードに変更し始めます。既存のコンピューティング ノードで実行されているタスクはすべて終了して再キューされます (既定の requeue オプションを使用してプールのサイズ変更操作が要求された場合と同様)。最後に、プールがシステムから削除されます。 実行中のタスクは再キューされるため、ユーザーはジョブを更新して別のプールをターゲットにすることで、これらのタスクを再実行できます。 その後、タスクは新しいプールで実行できます。 再キューの動作をオーバーライドする場合は、プールを削除する前に、サイズ変更プールを明示的に呼び出してプールを 0 サイズに縮小する必要があります。 削除中の状態のプールで Update、Patch、または Delete API を呼び出すと、エラー コード PoolBeingDeleted で HTTP 状態コード 409 で失敗します。

function deleteMethod(poolId: string, options?: PoolDeleteMethodOptionalParams): Promise<PoolDeleteResponse>

パラメーター

poolId

string

削除するプールの ID。

options
PoolDeleteMethodOptionalParams

省略可能なパラメーター

戻り値

Promise<Models.PoolDeleteResponse応答>

deleteMethod(string, PoolDeleteMethodOptionalParams, ServiceCallback<void>)

function deleteMethod(poolId: string, options: PoolDeleteMethodOptionalParams, callback: ServiceCallback<void>)

パラメーター

poolId

string

削除するプールの ID。

options
PoolDeleteMethodOptionalParams

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

deleteMethod(string, ServiceCallback<void>)

function deleteMethod(poolId: string, callback: ServiceCallback<void>)

パラメーター

poolId

string

削除するプールの ID。

callback

ServiceCallback<void>

コールバック

disableAutoScale(string, PoolDisableAutoScaleOptionalParams)

function disableAutoScale(poolId: string, options?: PoolDisableAutoScaleOptionalParams): Promise<PoolDisableAutoScaleResponse>

パラメーター

poolId

string

自動スケーリングを無効にするプールの ID。

options
PoolDisableAutoScaleOptionalParams

省略可能なパラメーター

戻り値

Promise<Models.PoolDisableAutoScaleResponse>

disableAutoScale(string, PoolDisableAutoScaleOptionalParams, ServiceCallback<void>)

function disableAutoScale(poolId: string, options: PoolDisableAutoScaleOptionalParams, callback: ServiceCallback<void>)

パラメーター

poolId

string

自動スケーリングを無効にするプールの ID。

options
PoolDisableAutoScaleOptionalParams

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

disableAutoScale(string, ServiceCallback<void>)

function disableAutoScale(poolId: string, callback: ServiceCallback<void>)

パラメーター

poolId

string

自動スケーリングを無効にするプールの ID。

callback

ServiceCallback<void>

コールバック

enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams)

プールでサイズ変更操作が進行中の場合、プールで自動スケーリングを有効にすることはできません。 プールの自動スケーリングが現在無効になっている場合は、要求の一部として有効な自動スケール式を指定する必要があります。 プールの自動スケーリングが既に有効になっている場合は、新しい自動スケール式または新しい評価間隔を指定できます。 同じプールに対してこの API を 30 秒ごとに複数回呼び出すことはできません。

function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, options?: PoolEnableAutoScaleOptionalParams): Promise<PoolEnableAutoScaleResponse>

パラメーター

poolId

string

自動スケーリングを有効にするプールの ID。

poolEnableAutoScaleParameter
PoolEnableAutoScaleParameter

要求のパラメーター。

options
PoolEnableAutoScaleOptionalParams

省略可能なパラメーター

戻り値

Promise<Models.PoolEnableAutoScaleResponse>

enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams, ServiceCallback<void>)

function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, options: PoolEnableAutoScaleOptionalParams, callback: ServiceCallback<void>)

パラメーター

poolId

string

自動スケーリングを有効にするプールの ID。

poolEnableAutoScaleParameter
PoolEnableAutoScaleParameter

要求のパラメーター。

options
PoolEnableAutoScaleOptionalParams

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

enableAutoScale(string, PoolEnableAutoScaleParameter, ServiceCallback<void>)

function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, callback: ServiceCallback<void>)

パラメーター

poolId

string

自動スケーリングを有効にするプールの ID。

poolEnableAutoScaleParameter
PoolEnableAutoScaleParameter

要求のパラメーター。

callback

ServiceCallback<void>

コールバック

evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams)

この API は、プールに数式を適用せずに結果を返すだけなので、主に自動スケール式を検証するための API です。 数式を評価するには、プールで自動スケーリングが有効になっている必要があります。

function evaluateAutoScale(poolId: string, autoScaleFormula: string, options?: PoolEvaluateAutoScaleOptionalParams): Promise<PoolEvaluateAutoScaleResponse>

パラメーター

poolId

string

自動スケーリング式を評価するプールの ID。

autoScaleFormula

string

プール内のコンピューティング ノードの目的の数の数式。 数式が検証され、その結果が計算されますが、プールには適用されません。 プールに数式を適用するには、"プールでの自動スケーリングを有効にする" を選択します。 この数式の指定の詳細については、「Azure Batch プール内のコンピューティング ノードを自動的にスケーリングする (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling)」を参照してください。

options
PoolEvaluateAutoScaleOptionalParams

省略可能なパラメーター

戻り値

Promise<Models.PoolEvaluateAutoScaleResponse>

evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams, ServiceCallback<AutoScaleRun>)

function evaluateAutoScale(poolId: string, autoScaleFormula: string, options: PoolEvaluateAutoScaleOptionalParams, callback: ServiceCallback<AutoScaleRun>)

パラメーター

poolId

string

自動スケーリング式を評価するプールの ID。

autoScaleFormula

string

プール内のコンピューティング ノードの目的の数の数式。 数式が検証され、その結果が計算されますが、プールには適用されません。 プールに数式を適用するには、"プールでの自動スケーリングを有効にする" を選択します。 この数式の指定の詳細については、「Azure Batch プール内のコンピューティング ノードを自動的にスケーリングする (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling)」を参照してください。

options
PoolEvaluateAutoScaleOptionalParams

省略可能なパラメーター

callback

ServiceCallback<AutoScaleRun>

コールバック

evaluateAutoScale(string, string, ServiceCallback<AutoScaleRun>)

function evaluateAutoScale(poolId: string, autoScaleFormula: string, callback: ServiceCallback<AutoScaleRun>)

パラメーター

poolId

string

自動スケーリング式を評価するプールの ID。

autoScaleFormula

string

プール内のコンピューティング ノードの目的の数の数式。 数式が検証され、その結果が計算されますが、プールには適用されません。 プールに数式を適用するには、"プールでの自動スケーリングを有効にする" を選択します。 この数式の指定の詳細については、「Azure Batch プール内のコンピューティング ノードを自動的にスケーリングする (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling)」を参照してください。

callback

ServiceCallback<AutoScaleRun>

コールバック

exists(string, PoolExistsOptionalParams)

プールの基本プロパティを取得します。

function exists(poolId: string, options?: PoolExistsOptionalParams): Promise<PoolExistsResponse>

パラメーター

poolId

string

取得するプールの ID。

options
PoolExistsOptionalParams

省略可能なパラメーター

戻り値

Promise<Models.PoolExistsレスポンス>

exists(string, PoolExistsOptionalParams, ServiceCallback<boolean>)

function exists(poolId: string, options: PoolExistsOptionalParams, callback: ServiceCallback<boolean>)

パラメーター

poolId

string

取得するプールの ID。

options
PoolExistsOptionalParams

省略可能なパラメーター

callback

ServiceCallback<boolean>

コールバック

exists(string, ServiceCallback<boolean>)

function exists(poolId: string, callback: ServiceCallback<boolean>)

パラメーター

poolId

string

取得するプールの ID。

callback

ServiceCallback<boolean>

コールバック

get(string, PoolGetOptionalParams)

指定したプールに関する情報を取得します。

function get(poolId: string, options?: PoolGetOptionalParams): Promise<PoolGetResponse>

パラメーター

poolId

string

取得するプールの ID。

options
PoolGetOptionalParams

省略可能なパラメーター

戻り値

Promise<PoolGetResponse>

Promise<Models.PoolGetResponse>

get(string, PoolGetOptionalParams, ServiceCallback<CloudPool>)

function get(poolId: string, options: PoolGetOptionalParams, callback: ServiceCallback<CloudPool>)

パラメーター

poolId

string

取得するプールの ID。

options
PoolGetOptionalParams

省略可能なパラメーター

callback

ServiceCallback<CloudPool>

コールバック

get(string, ServiceCallback<CloudPool>)

function get(poolId: string, callback: ServiceCallback<CloudPool>)

パラメーター

poolId

string

取得するプールの ID。

callback

ServiceCallback<CloudPool>

コールバック

getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams)

統計は、アカウントの作成から統計の最後の更新時刻まで、アカウントに存在したすべてのプールで集計されます。 統計をすぐに使用できない場合があります。 Batch サービスは、統計の定期的なロールアップを実行します。 一般的な遅延は約 30 分です。

function getAllLifetimeStatistics(options?: PoolGetAllLifetimeStatisticsOptionalParams): Promise<PoolGetAllLifetimeStatisticsResponse>

パラメーター

options
PoolGetAllLifetimeStatisticsOptionalParams

省略可能なパラメーター

戻り値

Promise<Models.PoolGetAllLifetimeStatisticsResponse>

getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams, ServiceCallback<PoolStatistics>)

function getAllLifetimeStatistics(options: PoolGetAllLifetimeStatisticsOptionalParams, callback: ServiceCallback<PoolStatistics>)

パラメーター

options
PoolGetAllLifetimeStatisticsOptionalParams

省略可能なパラメーター

callback

ServiceCallback<PoolStatistics>

コールバック

getAllLifetimeStatistics(ServiceCallback<PoolStatistics>)

function getAllLifetimeStatistics(callback: ServiceCallback<PoolStatistics>)

パラメーター

callback

ServiceCallback<PoolStatistics>

コールバック

list(PoolListOptionalParams)

function list(options?: PoolListOptionalParams): Promise<PoolListResponse>

パラメーター

options
PoolListOptionalParams

省略可能なパラメーター

戻り値

Promise<PoolListResponse>

Promise<Models.PoolListResponse応答>

list(PoolListOptionalParams, ServiceCallback<CloudPoolListResult>)

function list(options: PoolListOptionalParams, callback: ServiceCallback<CloudPoolListResult>)

パラメーター

options
PoolListOptionalParams

省略可能なパラメーター

callback

ServiceCallback<CloudPoolListResult>

コールバック

list(ServiceCallback<CloudPoolListResult>)

function list(callback: ServiceCallback<CloudPoolListResult>)

パラメーター

callback

ServiceCallback<CloudPoolListResult>

コールバック

listNext(string, PoolListNextOptionalParams)

function listNext(nextPageLink: string, options?: PoolListNextOptionalParams): Promise<PoolListResponse>

パラメーター

nextPageLink

string

List 操作に対する前回の正常な呼び出しからの NextLink。

options
PoolListNextOptionalParams

省略可能なパラメーター

戻り値

Promise<PoolListResponse>

Promise<Models.PoolListResponse応答>

listNext(string, PoolListNextOptionalParams, ServiceCallback<CloudPoolListResult>)

function listNext(nextPageLink: string, options: PoolListNextOptionalParams, callback: ServiceCallback<CloudPoolListResult>)

パラメーター

nextPageLink

string

List 操作に対する前回の正常な呼び出しからの NextLink。

options
PoolListNextOptionalParams

省略可能なパラメーター

callback

ServiceCallback<CloudPoolListResult>

コールバック

listNext(string, ServiceCallback<CloudPoolListResult>)

function listNext(nextPageLink: string, callback: ServiceCallback<CloudPoolListResult>)

パラメーター

nextPageLink

string

List 操作に対する前回の正常な呼び出しからの NextLink。

callback

ServiceCallback<CloudPoolListResult>

コールバック

listUsageMetrics(PoolListUsageMetricsOptionalParams)

poolId を含む$filter句を指定しない場合、応答には、返された集計間隔の時間範囲内のアカウントに存在していたすべてのプールが含まれます。 startTime または endTime を含む$filter句を指定しない場合、これらのフィルターは、現在使用可能な最後の集計間隔の開始時刻と終了時刻に既定で設定されます。つまり、最後の集計間隔のみが返されます。

function listUsageMetrics(options?: PoolListUsageMetricsOptionalParams): Promise<PoolListUsageMetricsResponse>

パラメーター

options
PoolListUsageMetricsOptionalParams

省略可能なパラメーター

戻り値

Promise<Models.PoolListUsageMetricsResponse>

listUsageMetrics(PoolListUsageMetricsOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)

function listUsageMetrics(options: PoolListUsageMetricsOptionalParams, callback: ServiceCallback<PoolListUsageMetricsResult>)

パラメーター

options
PoolListUsageMetricsOptionalParams

省略可能なパラメーター

callback

ServiceCallback<PoolListUsageMetricsResult>

コールバック

listUsageMetrics(ServiceCallback<PoolListUsageMetricsResult>)

function listUsageMetrics(callback: ServiceCallback<PoolListUsageMetricsResult>)

パラメーター

callback

ServiceCallback<PoolListUsageMetricsResult>

コールバック

listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams)

poolId を含む$filter句を指定しない場合、応答には、返された集計間隔の時間範囲内のアカウントに存在していたすべてのプールが含まれます。 startTime または endTime を含む$filter句を指定しない場合、これらのフィルターは、現在使用可能な最後の集計間隔の開始時刻と終了時刻に既定で設定されます。つまり、最後の集計間隔のみが返されます。

function listUsageMetricsNext(nextPageLink: string, options?: PoolListUsageMetricsNextOptionalParams): Promise<PoolListUsageMetricsResponse>

パラメーター

nextPageLink

string

List 操作に対する前回の正常な呼び出しからの NextLink。

options
PoolListUsageMetricsNextOptionalParams

省略可能なパラメーター

戻り値

Promise<Models.PoolListUsageMetricsResponse>

listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)

function listUsageMetricsNext(nextPageLink: string, options: PoolListUsageMetricsNextOptionalParams, callback: ServiceCallback<PoolListUsageMetricsResult>)

パラメーター

nextPageLink

string

List 操作に対する前回の正常な呼び出しからの NextLink。

options
PoolListUsageMetricsNextOptionalParams

省略可能なパラメーター

callback

ServiceCallback<PoolListUsageMetricsResult>

コールバック

listUsageMetricsNext(string, ServiceCallback<PoolListUsageMetricsResult>)

function listUsageMetricsNext(nextPageLink: string, callback: ServiceCallback<PoolListUsageMetricsResult>)

パラメーター

nextPageLink

string

List 操作に対する前回の正常な呼び出しからの NextLink。

callback

ServiceCallback<PoolListUsageMetricsResult>

コールバック

patch(string, PoolPatchParameter, PoolPatchOptionalParams)

これにより、要求で指定された Pool プロパティのみが置き換えられます。 たとえば、プールに StartTask が関連付けられている場合、要求で StartTask 要素が指定されていない場合、プールは既存の StartTask を保持します。

function patch(poolId: string, poolPatchParameter: PoolPatchParameter, options?: PoolPatchOptionalParams): Promise<PoolPatchResponse>

パラメーター

poolId

string

更新するプールの ID。

poolPatchParameter
PoolPatchParameter

要求のパラメーター。

options
PoolPatchOptionalParams

省略可能なパラメーター

戻り値

Promise<Models.PoolPatchResponseです。>

patch(string, PoolPatchParameter, PoolPatchOptionalParams, ServiceCallback<void>)

function patch(poolId: string, poolPatchParameter: PoolPatchParameter, options: PoolPatchOptionalParams, callback: ServiceCallback<void>)

パラメーター

poolId

string

更新するプールの ID。

poolPatchParameter
PoolPatchParameter

要求のパラメーター。

options
PoolPatchOptionalParams

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

patch(string, PoolPatchParameter, ServiceCallback<void>)

function patch(poolId: string, poolPatchParameter: PoolPatchParameter, callback: ServiceCallback<void>)

パラメーター

poolId

string

更新するプールの ID。

poolPatchParameter
PoolPatchParameter

要求のパラメーター。

callback

ServiceCallback<void>

コールバック

removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams)

この操作は、プールの割り当て状態が安定している場合にのみ実行できます。 この操作を実行すると、割り当ての状態が安定状態からサイズ変更に変わります。

function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, options?: PoolRemoveNodesOptionalParams): Promise<PoolRemoveNodesResponse>

パラメーター

poolId

string

コンピューティング ノードを削除するプールの ID。

nodeRemoveParameter
NodeRemoveParameter

要求のパラメーター。

options
PoolRemoveNodesOptionalParams

省略可能なパラメーター

戻り値

Promise<Models.PoolRemoveNodesレスポンス>

removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams, ServiceCallback<void>)

function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, options: PoolRemoveNodesOptionalParams, callback: ServiceCallback<void>)

パラメーター

poolId

string

コンピューティング ノードを削除するプールの ID。

nodeRemoveParameter
NodeRemoveParameter

要求のパラメーター。

options
PoolRemoveNodesOptionalParams

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

removeNodes(string, NodeRemoveParameter, ServiceCallback<void>)

function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, callback: ServiceCallback<void>)

パラメーター

poolId

string

コンピューティング ノードを削除するプールの ID。

nodeRemoveParameter
NodeRemoveParameter

要求のパラメーター。

callback

ServiceCallback<void>

コールバック

resize(string, PoolResizeParameter, PoolResizeOptionalParams)

プールのサイズを変更できるのは、その割り当て状態が安定している場合のみです。 プールのサイズが既に変更されている場合、要求は状態コード 409 で失敗します。 プールのサイズを変更すると、プールの割り当ての状態が安定した状態からサイズ変更に変わります。 自動スケーリング用に構成されているプールのサイズを変更することはできません。 これを行おうとすると、Batch サービスからエラー 409 が返されます。 プールのサイズを下方向に変更すると、削除するコンピューティング ノードが Batch サービスによって選択されます。 特定のコンピューティング ノードを削除するには、代わりにプールのコンピューティング ノードの削除 API を使用します。

function resize(poolId: string, poolResizeParameter: PoolResizeParameter, options?: PoolResizeOptionalParams): Promise<PoolResizeResponse>

パラメーター

poolId

string

サイズ変更するプールの ID。

poolResizeParameter
PoolResizeParameter

要求のパラメーター。

options
PoolResizeOptionalParams

省略可能なパラメーター

戻り値

Promise<Models.PoolResizeResponse応答>

resize(string, PoolResizeParameter, PoolResizeOptionalParams, ServiceCallback<void>)

function resize(poolId: string, poolResizeParameter: PoolResizeParameter, options: PoolResizeOptionalParams, callback: ServiceCallback<void>)

パラメーター

poolId

string

サイズ変更するプールの ID。

poolResizeParameter
PoolResizeParameter

要求のパラメーター。

options
PoolResizeOptionalParams

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

resize(string, PoolResizeParameter, ServiceCallback<void>)

function resize(poolId: string, poolResizeParameter: PoolResizeParameter, callback: ServiceCallback<void>)

パラメーター

poolId

string

サイズ変更するプールの ID。

poolResizeParameter
PoolResizeParameter

要求のパラメーター。

callback

ServiceCallback<void>

コールバック

stopResize(string, PoolStopResizeOptionalParams)

これにより、サイズ変更操作の前にプールが以前の状態に復元されることはありません。それ以降の変更が停止されるだけで、プールは現在の状態を維持します。 停止後、プールは停止操作が完了した時点のコンピューティング ノードの数で安定します。 停止操作中、プール割り当ての状態は最初に停止状態に変わり、次に安定状態に変わります。 サイズ変更操作は、明示的なサイズ変更プール要求である必要はありません。この API は、作成時にプールの初期サイズ設定を停止するためにも使用できます。

function stopResize(poolId: string, options?: PoolStopResizeOptionalParams): Promise<PoolStopResizeResponse>

パラメーター

poolId

string

サイズ変更を停止するプールの ID。

options
PoolStopResizeOptionalParams

省略可能なパラメーター

戻り値

Promise<Models.PoolStopResizeResponse>

stopResize(string, PoolStopResizeOptionalParams, ServiceCallback<void>)

function stopResize(poolId: string, options: PoolStopResizeOptionalParams, callback: ServiceCallback<void>)

パラメーター

poolId

string

サイズ変更を停止するプールの ID。

options
PoolStopResizeOptionalParams

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

stopResize(string, ServiceCallback<void>)

function stopResize(poolId: string, callback: ServiceCallback<void>)

パラメーター

poolId

string

サイズ変更を停止するプールの ID。

callback

ServiceCallback<void>

コールバック

updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams)

これにより、プールのすべての更新可能なプロパティが完全に置き換えられます。 たとえば、プールに StartTask が関連付けられている場合、この要求で StartTask が指定されていない場合、Batch サービスは既存の StartTask を削除します。

function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, options?: PoolUpdatePropertiesOptionalParams): Promise<PoolUpdatePropertiesResponse>

パラメーター

poolId

string

更新するプールの ID。

poolUpdatePropertiesParameter
PoolUpdatePropertiesParameter

要求のパラメーター。

options
PoolUpdatePropertiesOptionalParams

省略可能なパラメーター

戻り値

Promise<Models.PoolUpdatePropertiesResponseレスポンス>

updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams, ServiceCallback<void>)

function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, options: PoolUpdatePropertiesOptionalParams, callback: ServiceCallback<void>)

パラメーター

poolId

string

更新するプールの ID。

poolUpdatePropertiesParameter
PoolUpdatePropertiesParameter

要求のパラメーター。

options
PoolUpdatePropertiesOptionalParams

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

updateProperties(string, PoolUpdatePropertiesParameter, ServiceCallback<void>)

function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, callback: ServiceCallback<void>)

パラメーター

poolId

string

更新するプールの ID。

poolUpdatePropertiesParameter
PoolUpdatePropertiesParameter

要求のパラメーター。

callback

ServiceCallback<void>

コールバック