Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Value

Description

Type

JobIdidentifies Identifies jobstring

SessionState

 identifies Identifies current state

enum SessionStateContract:

Undefined,
Runnig ,
Completed,
Canceled,
Failed

AccountLoginlogin Login of account who's running the jobstring
CreatedUtcWhen job was created in UTCDateTime
StartedUtcWhen job started in UTCDatreTime
CompletedUtcWhen job completedDateTime, optional
ProgressPercentageExecution progressfloat
ErrorMessageerror Error detailsstring
JobType

enum JobTypeContract: 

None,
Backup,
Recovery,
RefreshRecoveryInfo,

...

Parameter

Description

Type / Validation Rules

Name

Name of file

string
Status

Description of the file status (localized)

string

TotalSizeBytes

Total size of file, bytes

long
CompletedSizeBytesCompleted size, byteslong

Operation: PauseOnlineBackupJobRequest

Pause the current backup session.

Pausing the current backup session, regardless of who launched it.

If there are other requests for backup in the queue, they will be paused too.

In the absence of active sessions, the Pause does nothing.

Parameter

Description

Type / Validation Rules

Identityidentity object with valid tokenIdentityContract

Operation: ResumeOnlineBackupJobRequest

Resume the current backup session (if paused).

Resume the current backup session after pausing, regardless of who launched/paused it.

In the absence of active sessions, the Resume does nothing.

Parameter

Description

Type / Validation Rules

Identityidentity object with valid tokenIdentityContract

Operation: CancelOnlineBackupJobRequest

Cancel the current backup session.

Cancels the current backup session, regardless of who launched it.

If there are other requests for backup in the queue, they will be executed immediately after the current session is canceled.

In the absence of active sessions, the Cancel does nothing.

Parameter

Description

Type / Validation Rules

Identityidentity object with valid tokenIdentityContract