DeletePool interface

包:

@azure-rest/batch

方法

delete(DeletePoolParameters)	请求删除池时，会发生以下作：池状态设置为删除;正在对池执行的任何调整大小作将停止;Batch 服务开始将池大小调整为零个计算节点;在现有计算节点上运行的任何任务将终止并重新排队（就好像使用默认重新排队选项请求了调整池大小作一样）：最后，将从系统中删除池。 由于重新排队运行的任务，因此用户可以通过将作业更新为面向其他池来重新运行这些任务。 然后，任务可以在新的池上运行。 如果要重写重新排队行为，则应在删除池之前显式调用调整池大小以将池收缩为零大小。 如果在删除状态下对池调用更新、修补或删除 API，它将失败并显示 HTTP 状态代码 409，错误代码为 PoolBeingDeleted。
get(GetPoolParameters)	获取有关指定池的信息。
head(PoolExistsParameters)	获取池的基本属性。
patch(UpdatePoolParameters)	这只会替换请求中指定的池属性。 例如，如果池具有与之关联的 StartTask，并且请求未指定 StartTask 元素，则池将保留现有的 StartTask。

方法详细信息

delete(DeletePoolParameters)

请求删除池时，会发生以下作：池状态设置为删除;正在对池执行的任何调整大小作将停止;Batch 服务开始将池大小调整为零个计算节点;在现有计算节点上运行的任何任务将终止并重新排队（就好像使用默认重新排队选项请求了调整池大小作一样）：最后，将从系统中删除池。 由于重新排队运行的任务，因此用户可以通过将作业更新为面向其他池来重新运行这些任务。 然后，任务可以在新的池上运行。 如果要重写重新排队行为，则应在删除池之前显式调用调整池大小以将池收缩为零大小。 如果在删除状态下对池调用更新、修补或删除 API，它将失败并显示 HTTP 状态代码 409，错误代码为 PoolBeingDeleted。

function delete(options?: DeletePoolParameters): StreamableMethod<DeletePool202Response | DeletePoolDefaultResponse>

参数

options

DeletePoolParameters

返回

StreamableMethod<DeletePool202Response | DeletePoolDefaultResponse>

get(GetPoolParameters)

获取有关指定池的信息。

function get(options?: GetPoolParameters): StreamableMethod<GetPool200Response | GetPoolDefaultResponse>

参数

options

GetPoolParameters

返回

StreamableMethod<GetPool200Response | GetPoolDefaultResponse>

head(PoolExistsParameters)

获取池的基本属性。

function head(options?: PoolExistsParameters): StreamableMethod<PoolExists200Response | PoolExists404Response | PoolExistsDefaultResponse>

参数

options

PoolExistsParameters

返回

StreamableMethod<PoolExists200Response | PoolExists404Response | PoolExistsDefaultResponse>

patch(UpdatePoolParameters)

这只会替换请求中指定的池属性。 例如，如果池具有与之关联的 StartTask，并且请求未指定 StartTask 元素，则池将保留现有的 StartTask。

function patch(options: UpdatePoolParameters): StreamableMethod<UpdatePool200Response | UpdatePoolDefaultResponse>

参数

options

UpdatePoolParameters

返回

StreamableMethod<UpdatePool200Response | UpdatePoolDefaultResponse>