SnapshotUpdateOptionalParams interface
Optional Parameters.
- Extends
Properties
apply |
Array of the target Face subscription ids for the snapshot, specified by the user who created the snapshot when calling Snapshot - Take. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it. |
user |
User specified data about the snapshot for any purpose. Length should not exceed 16KB. |
Inherited Properties
abort |
The signal which can be used to abort requests. |
custom |
User defined custom request headers that will be applied before the request is sent. |
on |
Callback which fires upon download progress. |
on |
Callback which fires upon upload progress. |
timeout | The number of milliseconds a request can take before automatically being terminated. |
Property Details
applyScope
Array of the target Face subscription ids for the snapshot, specified by the user who created the snapshot when calling Snapshot - Take. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.
applyScope?: string[]
Property Value
string[]
userData
User specified data about the snapshot for any purpose. Length should not exceed 16KB.
userData?: string
Property Value
string
Inherited Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLike
Property Value
Inherited From msRest.RequestOptionsBase.abortSignal
customHeaders
User defined custom request headers that will be applied before the request is sent.
customHeaders?: {[key: string]: string}
Property Value
{[key: string]: string}
Inherited From msRest.RequestOptionsBase.customHeaders
onDownloadProgress
Callback which fires upon download progress.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Property Value
(progress: TransferProgressEvent) => void
Inherited From msRest.RequestOptionsBase.onDownloadProgress
onUploadProgress
Callback which fires upon upload progress.
onUploadProgress?: (progress: TransferProgressEvent) => void
Property Value
(progress: TransferProgressEvent) => void
Inherited From msRest.RequestOptionsBase.onUploadProgress
timeout
The number of milliseconds a request can take before automatically being terminated.
timeout?: number
Property Value
number
Inherited From msRest.RequestOptionsBase.timeout