TaskListOptions interface

套件:

@azure/batch

清單作業的其他參數。

屬性

clientRequestId	呼叫端產生的要求身分識別，格式為 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。
maxResults	回應中要傳回的項目數目上限。 最多可以傳回 1000 個工作。 預設值：1000。
ocpDate	發出要求的時間。 用戶端連結庫通常會將此設定為目前的系統時鐘時間;如果您要直接呼叫 REST API，請明確設定它。
returnClientRequestId	伺服器是否應該在回應中傳回 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