ServiceFabricClientGetPartitionBackupListOptionalParams interface

パッケージ:

@azure/servicefabric

省略可能なパラメーター。

Extends

RequestOptionsBase

プロパティ

endDateTimeFilter	バックアップを列挙するまでの終了日時を datetime 形式で指定します。 日時はISO8601形式で指定する必要があります。 これは省略可能なパラメーターです。 指定しない場合、列挙は最新のバックアップまで実行されます。
latest	指定した時間範囲のパーティションで使用できる最新のバックアップのみを取得するかどうかを指定します。 既定値: false。
startDateTimeFilter	バックアップを列挙する開始日時を datetime 形式で指定します。 日時はISO8601形式で指定する必要があります。 これは省略可能なパラメーターです。 指定しない場合、先頭からのすべてのバックアップが列挙されます。
timeoutParameter	操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求された操作が完了するまでクライアントが待機する期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値: 60。

継承されたプロパティ

abortSignal	要求を中止するために使用できるシグナル。
customHeaders	要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。
onDownloadProgress	ダウンロードの進行状況時に発生するコールバック。
onUploadProgress	アップロードの進行状況時に発生するコールバック。
timeout	要求が自動的に終了するまでの時間 (ミリ秒)。

プロパティの詳細

endDateTimeFilter

バックアップを列挙するまでの終了日時を datetime 形式で指定します。 日時はISO8601形式で指定する必要があります。 これは省略可能なパラメーターです。 指定しない場合、列挙は最新のバックアップまで実行されます。

endDateTimeFilter?: Date

プロパティ値

Date

latest

指定した時間範囲のパーティションで使用できる最新のバックアップのみを取得するかどうかを指定します。 既定値: false。

latest?: boolean

プロパティ値

boolean

startDateTimeFilter

バックアップを列挙する開始日時を datetime 形式で指定します。 日時はISO8601形式で指定する必要があります。 これは省略可能なパラメーターです。 指定しない場合、先頭からのすべてのバックアップが列挙されます。

startDateTimeFilter?: Date

プロパティ値

Date

timeoutParameter

操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求された操作が完了するまでクライアントが待機する期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値: 60。

timeoutParameter?: number

プロパティ値

number

継承されたプロパティの詳細

abortSignal

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

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

inherited From msRest.RequestOptionsBase.onUploadProgress

timeout

要求が自動的に終了するまでの時間 (ミリ秒)。

timeout?: number

プロパティ値

number

msRest.RequestOptionsBase.timeout から継承された