你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
TaskListOptions interface
列表操作的其他参数。
属性
client |
调用方生成的请求标识,采用不带修饰(如大括号)的 GUID 形式,例如 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。 |
expand | OData $expand 子句。 |
filter | OData $filter 子句。 有关构造此筛选器的详细信息,请参阅 https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks。 |
max |
响应中要返回的最大项数。 最多可以返回 1000 个任务。 默认值:1000。 |
ocp |
发出请求的时间。 客户端库通常将此设置为当前系统时钟时间;如果直接调用 REST API,请显式设置它。 |
return |
服务器是否应在响应中返回 client-request-id。 默认值:false。 |
select | OData $select 子句。 |
timeout | 服务器可以花费处理请求的最长时间(以秒为单位)。 默认为 30 秒。 默认值:30。 |
属性详细信息
clientRequestId
调用方生成的请求标识,采用不带修饰(如大括号)的 GUID 形式,例如 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。
clientRequestId?: string
属性值
string
expand
OData $expand 子句。
expand?: string
属性值
string
filter
OData $filter 子句。 有关构造此筛选器的详细信息,请参阅 https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks。
filter?: string
属性值
string
maxResults
响应中要返回的最大项数。 最多可以返回 1000 个任务。 默认值:1000。
maxResults?: number
属性值
number
ocpDate
发出请求的时间。 客户端库通常将此设置为当前系统时钟时间;如果直接调用 REST API,请显式设置它。
ocpDate?: Date
属性值
Date
returnClientRequestId
服务器是否应在响应中返回 client-request-id。 默认值:false。
returnClientRequestId?: boolean
属性值
boolean
select
OData $select 子句。
select?: string
属性值
string
timeout
服务器可以花费处理请求的最长时间(以秒为单位)。 默认为 30 秒。 默认值:30。
timeout?: number
属性值
number