RebalanceJobPropertiesStatus interface

Package:

@azure/arm-storagecache

The status of the rebalance job.

Properties

balancePercent	The balance percentage (0-100). Represents cumulative progress since the rebalance started. Reported in periodic rebalance status updates. Resets to 0 if the rebalancer node restarts.
bytesMoved	Total number of bytes moved since the rebalance started. Reported in periodic rebalance status updates. Resets to 0 if the rebalancer node restarts.
completionTimeUTC	The time (in UTC) when the rebalance job completed. Only populated when the job reaches a terminal state (Completed, Failed, or Canceled).
dirsMigrated	Total number of directories migrated since the rebalance started. Counts MDT-phase (metadata) work items, reported separately from filesMigrated (OST-phase data migrations). Reported in periodic rebalance status updates. Resets to 0 if the rebalancer node restarts.
estimatedRemainingSeconds	Estimated remaining time in seconds. Omitted during initial assessment before the rebalancer has enough data to estimate.
filesMigrated	Total number of files migrated since the rebalance started. Counts OST-phase (data) work items. Reported in periodic rebalance status updates. Resets to 0 if the rebalancer node restarts.
filesMovedPerSecond	Average files moved per second over the most recent reporting interval.
percentComplete	The percentage of rebalance job completion.
startTimeUTC	The time (in UTC) the rebalance job started.
state	The operational state of the rebalance job. InProgress indicates the rebalance is running on the cluster. Cancelling indicates a cancel has been requested. Canceled indicates the rebalance was cancelled. Completed indicates the rebalance finished successfully. Failed indicates the rebalance was unable to complete due to a fatal error. Deleting indicates the job is being cleaned up during deletion. RollingBack indicates the orchestrator is rolling back provisioned resources after a failure.
statusCode	Server-defined status code for rebalance job.
statusMessage	Server-defined status message for rebalance job.
throughputMiBps	Average throughput in mebibytes per second (1024x1024 bytes per second) over the most recent reporting interval.
totalErrors	Total cumulative non-skip errors since the rebalance started. Reported in periodic rebalance status updates. Resets to 0 if the rebalancer node restarts.
totalSkipped	Total cumulative benign skips since the rebalance started: files intentionally not migrated (for example, a lost migration lease or a stale layout), as distinct from the hard failures counted in totalErrors. Reported in periodic rebalance status updates. Resets to 0 if the rebalancer node restarts.

Property Details

balancePercent

The balance percentage (0-100). Represents cumulative progress since the rebalance started. Reported in periodic rebalance status updates. Resets to 0 if the rebalancer node restarts.

balancePercent?: number

Property Value

number

bytesMoved

Total number of bytes moved since the rebalance started. Reported in periodic rebalance status updates. Resets to 0 if the rebalancer node restarts.

bytesMoved?: number

Property Value

number

completionTimeUTC

The time (in UTC) when the rebalance job completed. Only populated when the job reaches a terminal state (Completed, Failed, or Canceled).

completionTimeUTC?: Date

Property Value

Date

dirsMigrated

Total number of directories migrated since the rebalance started. Counts MDT-phase (metadata) work items, reported separately from filesMigrated (OST-phase data migrations). Reported in periodic rebalance status updates. Resets to 0 if the rebalancer node restarts.

dirsMigrated?: number

Property Value

number

estimatedRemainingSeconds

Estimated remaining time in seconds. Omitted during initial assessment before the rebalancer has enough data to estimate.

estimatedRemainingSeconds?: number

Property Value

number

filesMigrated

Total number of files migrated since the rebalance started. Counts OST-phase (data) work items. Reported in periodic rebalance status updates. Resets to 0 if the rebalancer node restarts.

filesMigrated?: number

Property Value

number

filesMovedPerSecond

Average files moved per second over the most recent reporting interval.

filesMovedPerSecond?: number

Property Value

number

percentComplete

The percentage of rebalance job completion.

percentComplete?: number

Property Value

number

startTimeUTC

The time (in UTC) the rebalance job started.

startTimeUTC?: Date

Property Value

Date

state

The operational state of the rebalance job. InProgress indicates the rebalance is running on the cluster. Cancelling indicates a cancel has been requested. Canceled indicates the rebalance was cancelled. Completed indicates the rebalance finished successfully. Failed indicates the rebalance was unable to complete due to a fatal error. Deleting indicates the job is being cleaned up during deletion. RollingBack indicates the orchestrator is rolling back provisioned resources after a failure.

state?: string

Property Value

string

statusCode

Server-defined status code for rebalance job.

statusCode?: string

Property Value

string

statusMessage

Server-defined status message for rebalance job.

statusMessage?: string

Property Value

string

throughputMiBps

Average throughput in mebibytes per second (1024x1024 bytes per second) over the most recent reporting interval.

throughputMiBps?: number

Property Value

number

totalErrors

Total cumulative non-skip errors since the rebalance started. Reported in periodic rebalance status updates. Resets to 0 if the rebalancer node restarts.

totalErrors?: number

Property Value

number

totalSkipped

Total cumulative benign skips since the rebalance started: files intentionally not migrated (for example, a lost migration lease or a stale layout), as distinct from the hard failures counted in totalErrors. Reported in periodic rebalance status updates. Resets to 0 if the rebalancer node restarts.

totalSkipped?: number

Property Value

number