ListTasksOptionalParams interface
省略可能なパラメーター。
- Extends
プロパティ
| client |
呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (例: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)。 |
| expand | OData $expand 句。 |
| filter | OData $filter 句。 このフィルターの構築についての詳細は https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-tasksを参照してください。 |
| maxresults | 応答で返される項目の最大数。 最大1000件の申請書を返送できます。 |
| ocpdate | 要求が発行された時刻。 通常、クライアント ライブラリはこれを現在のシステム クロック時間に設定します。REST API を直接呼び出す場合は、明示的に設定します。 |
| return |
サーバーが応答で client-request-id を返す必要があるかどうか。 |
| select | OData $select 句。 |
| time |
サーバーが要求の処理に費やすことができる最大時間 (秒単位)。 既定値は 30 秒です。 値が30より大きい場合は、デフォルトが使われます。」 |
継承されたプロパティ
| abort |
要求を中止するために使用できるシグナル。 |
| on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
| request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
| tracing |
トレースが有効な場合に使用されるオプション。 |
プロパティの詳細
clientRequestId
呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (例: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)。
clientRequestId?: stringプロパティ値
string
expand
OData $expand 句。
expand?: string[]プロパティ値
string[]
filter
OData $filter 句。 このフィルターの構築についての詳細は https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-tasksを参照してください。
filter?: stringプロパティ値
string
maxresults
応答で返される項目の最大数。 最大1000件の申請書を返送できます。
maxresults?: numberプロパティ値
number
ocpdate
要求が発行された時刻。 通常、クライアント ライブラリはこれを現在のシステム クロック時間に設定します。REST API を直接呼び出す場合は、明示的に設定します。
ocpdate?: Dateプロパティ値
Date
returnClientRequestId
サーバーが応答で client-request-id を返す必要があるかどうか。
returnClientRequestId?: booleanプロパティ値
boolean
select
OData $select 句。
select?: string[]プロパティ値
string[]
timeOutInSeconds
サーバーが要求の処理に費やすことができる最大時間 (秒単位)。 既定値は 30 秒です。 値が30より大きい場合は、デフォルトが使われます。」
timeOutInSeconds?: numberプロパティ値
number
継承されたプロパティの詳細
abortSignal
要求を中止するために使用できるシグナル。
abortSignal?: AbortSignalLikeプロパティ値
OperationOptions.abortSignal から継承された
onResponse
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
onResponse?: RawResponseCallbackプロパティ値
OperationOptions.onResponse から継承された
requestOptions
この操作の HTTP 要求を作成および送信するときに使用されるオプション。
requestOptions?: OperationRequestOptionsプロパティ値
OperationOptions.requestOptions から継承された
tracingOptions
トレースが有効な場合に使用されるオプション。
tracingOptions?: OperationTracingOptionsプロパティ値
OperationOptions.tracingOptions から継承された
