Microsoft Azure BackupRestore API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include BackupRestore. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.
This API exposes
29 operations
across 29 paths,
and defines 38 schemas.
It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.
The identity and technical contract details declared by the specification.
PagedBackupInfoList
object
The list of backups. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same qu…
2 properties
PartitionId
string
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is uni…
RetentionPolicyType
string
The type of retention policy. Currently only "Basic" retention policy is supported.
FabricErrorCodes
string
Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are…
BackupInfo
object
Represents a backup point which can be used to trigger a restore.
12 properties
RestoreState
string
Represents the current state of the partition restore operation.
GetBackupByStorageQueryDescription
object
Describes additional filters to be applied, while listing backups, and backup storage details from where to fetch the backups.
5 properties
2 required
BackupProgressInfo
object
Describes the progress of a partition's backup.
7 properties
ServiceName
string
The full name of the service with 'fabric:' URI scheme.
PagedBackupPolicyDescriptionList
object
The list of backup policies configured in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be…
2 properties
BackupScheduleKind
string
The kind of backup schedule, time based or frequency based.
ContinuationToken
string
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the…
FabricErrorError
object
Error object containing error code and error message.
2 properties
1 required
BackupEntityKind
string
The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled.
BackupState
string
Represents the current state of the partition backup operation.
PartitionBackupConfigurationInfo
object
Backup configuration information, for a specific partition, specifying what backup policy is being applied and suspend description, if any.
2 properties
BackupStorageKind
string
The kind of backup storage, where backups are saved.
BackupConfigurationInfo
object
Describes the backup configuration information.
4 properties
1 required
BackupPolicyScope
string
Specifies the scope at which the backup policy is applied.
BackupEntity
object
Describes the Service Fabric entity that is configured for backup.
1 property
1 required
BackupStorageDescription
object
Describes the parameters for the backup storage.
2 properties
1 required
DisableBackupDescription
object
It describes the body parameters while disabling backup of a backup entity(Application/Service/Partition).
1 property
1 required
BackupSuspensionScope
string
Specifies the scope at which the backup suspension was applied.
RetentionPolicyDescription
object
Describes the retention policy configured.
1 property
1 required
PagedBackupEntityList
object
The list of backup entities that are being periodically backed. The list is paged when all of the results cannot fit in a single message. The next set of resul…
2 properties
PartitionInformation
object
Information about the partition identity, partitioning scheme and keys supported by it.
2 properties
1 required
BackupPartitionDescription
object
Describes the parameters for triggering partition's backup.
1 property
RestorePartitionDescription
object
Specifies the parameters needed to trigger a restore of a specific partition.
3 properties
2 required
RestoreProgressInfo
object
Describes the progress of a restore operation on a partition.
5 properties
BackupType
string
Describes the type of backup, whether its full or incremental.
BackupScheduleDescription
object
Describes the backup schedule parameters.
1 property
1 required
EnableBackupDescription
object
Specifies the parameters needed to enable periodic backup.
1 property
1 required
FabricError
object
The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API…
1 property
1 required
PagedBackupConfigurationInfoList
object
The list of backup configuration information. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained…
2 properties
BackupPolicyDescription
object
Describes a backup policy for configuring periodic backup.
6 properties
5 required
BackupSuspensionInfo
object
Describes the backup suspension details.
2 properties
ServicePartitionKind
string
The kind of partitioning scheme used to partition the service.
Epoch
object
An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica change…
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Microsoft Azure publishes across the network.
