你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
ExamplesListOptionalParams interface
可选参数。
- Extends
属性
enable |
切换嵌套/平面格式。 默认值:false。 |
skip | 要跳过的条目数。 默认值为 0。 默认值:0。 |
take | 要返回的条目数。 最大页面大小为 500。 默认值为 100。 默认值:100。 |
继承属性
abort |
可用于中止请求的信号。 |
custom |
用户定义的自定义请求标头,将在发送请求之前应用这些标头。 |
on |
下载进度时触发的回调。 |
on |
上传进度时触发的回调。 |
timeout | 请求在自动终止之前可以花费的毫秒数。 |
属性详细信息
enableNestedChildren
切换嵌套/平面格式。 默认值:false。
enableNestedChildren?: boolean
属性值
boolean
skip
要跳过的条目数。 默认值为 0。 默认值:0。
skip?: number
属性值
number
take
要返回的条目数。 最大页面大小为 500。 默认值为 100。 默认值:100。
take?: number
属性值
number
继承属性详细信息
abortSignal
可用于中止请求的信号。
abortSignal?: AbortSignalLike
属性值
继承自 msRest.RequestOptionsBase.abortSignal
customHeaders
用户定义的自定义请求标头,将在发送请求之前应用这些标头。
customHeaders?: {[key: string]: string}
属性值
{[key: string]: string}
继承自 msRest.RequestOptionsBase.customHeaders
onDownloadProgress
下载进度时触发的回调。
onDownloadProgress?: (progress: TransferProgressEvent) => void
属性值
(progress: TransferProgressEvent) => void
继承自 msRest.RequestOptionsBase.onDownloadProgress
onUploadProgress
上传进度时触发的回调。
onUploadProgress?: (progress: TransferProgressEvent) => void
属性值
(progress: TransferProgressEvent) => void
继承自 msRest.RequestOptionsBase.onUploadProgress
timeout
请求在自动终止之前可以花费的毫秒数。
timeout?: number
属性值
number
继承自 msRest.RequestOptionsBase.timeout