Suspend Application Backup

Suspends periodic backup for the specified Service Fabric application.

The application which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire application's hierarchy. It means all the services and partitions under this application are now suspended for backup.

Request

Method Request URI
POST /Applications/{applicationId}/$/SuspendBackup?api-version=6.2-preview&timeout={timeout}

Parameters

Name Type Required Location
applicationId string Yes Path
api-version string Yes Query
timeout integer (int64) No Query

applicationId

Type: string
Required: Yes

The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.


api-version

Type: string
Required: Yes
Default: 6.2-preview

The version of the API. This parameter is required and its value must be '6.2-preview'.


timeout

Type: integer (int64)
Required: No
Default: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

Responses

HTTP Status Code Description Response Schema
202 (Accepted) A 202 status code indicates the operation request was accepted and application backup will be suspended.
All other status codes The detailed error response.
FabricError

Examples

Suspend application backup

This example shows how to suspend backup for a stateful application which is configured for periodic backup.

Request

POST http://localhost:19080/Applications/CalcApp/$/SuspendBackup?api-version=6.2-preview

202 Response

Body

The response body is empty.