swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector BackupRestore API schemes: - https tags: - name: BackupRestore paths: /BackupRestore/BackupPolicies/$/Create: post: operationId: microsoftAzureCreatebackuppolicy summary: Microsoft Azure Creates A Backup Policy description: Creates a backup policy which can be associated later with a Service Fabric application, service or a partition for periodic backup. x-ms-examples: Create a time based backup policy with Azure as backup location: $ref: ./examples/CreateBackupPolicy-1.json Create a time based backup policy with Azure as backup location accessed using managed identity: $ref: ./examples/CreateBackupPolicy-4.json Create a frequency based backup policy with file share as backup location: $ref: ./examples/CreateBackupPolicy-2.json Create a time based backup policy with Dsms Azure as backup location: $ref: ./examples/CreateBackupPolicy-3.json parameters: - $ref: '#/parameters/BackupPolicyDescriptionRequiredBodyParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' - $ref: '#/parameters/ValidateConnectionOptionalQueryParam' tags: - BackupRestore responses: '201': description: A successful operation returns 201 status code and creates a new backup policy. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /BackupRestore/BackupPolicies/{backupPolicyName}/$/Delete: post: operationId: microsoftAzureDeletebackuppolicy summary: Microsoft Azure Deletes The Backup Policy description: Deletes an existing backup policy. A backup policy must be created before it can be deleted. A currently active backup policy, associated with any Service Fabric application, service or partition, cannot be deleted without first deleting the mapping. x-ms-examples: Delete backup policy: $ref: ./examples/DeleteBackupPolicy.json parameters: - $ref: '#/parameters/BackupPolicyNameRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - BackupRestore responses: '200': description: A successful operation returns 200 status code and deletes the backup policy. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /BackupRestore/BackupPolicies: get: operationId: microsoftAzureGetbackuppolicylist summary: Microsoft Azure Gets All The Backup Policies Configured description: Get a list of all the backup policies configured. x-ms-examples: Limit maximum results: $ref: ./examples/GetBackupPolicyList-1.json Page using continuation token: $ref: ./examples/GetBackupPolicyList-2.json parameters: - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/ContinuationTokenOptionalQueryParam' - $ref: '#/parameters/MaxResultsOptionalQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - BackupRestore responses: '200': description: A successful operation will return 200 status code and paged list of backup policies. schema: $ref: '#/definitions/PagedBackupPolicyDescriptionList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /BackupRestore/BackupPolicies/{backupPolicyName}: get: operationId: microsoftAzureGetbackuppolicybyname summary: Microsoft Azure Gets A Particular Backup Policy By Name description: Gets a particular backup policy identified by {backupPolicyName} x-ms-examples: Get backup policy by name: $ref: ./examples/GetBackupPolicyByName.json parameters: - $ref: '#/parameters/BackupPolicyNameRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - BackupRestore responses: '200': description: A successful operation will return 200 status code and the backup policy description. schema: $ref: '#/definitions/BackupPolicyDescription' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /BackupRestore/BackupPolicies/{backupPolicyName}/$/GetBackupEnabledEntities: get: operationId: microsoftAzureGetallentitiesbackedupbypolicy summary: Microsoft Azure Gets The List Of Backup Entities That Are Associated With This Policy description: Returns a list of Service Fabric application, service or partition which are associated with this backup policy. x-ms-examples: Limit maximum results: $ref: ./examples/GetAllEntitiesBackedUpByPolicy-1.json Page using continuation token: $ref: ./examples/GetAllEntitiesBackedUpByPolicy-2.json parameters: - $ref: '#/parameters/BackupPolicyNameRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/ContinuationTokenOptionalQueryParam' - $ref: '#/parameters/MaxResultsOptionalQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - BackupRestore responses: '200': description: A successful operation will return 200 status code and a paged list of Service Fabric entities that are associated with this policy. schema: $ref: '#/definitions/PagedBackupEntityList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /BackupRestore/BackupPolicies/{backupPolicyName}/$/Update: post: operationId: microsoftAzureUpdatebackuppolicy summary: Microsoft Azure Updates The Backup Policy description: Updates the backup policy identified by {backupPolicyName} x-ms-examples: Update backup policy: $ref: ./examples/UpdateBackupPolicy.json parameters: - $ref: '#/parameters/BackupPolicyDescriptionRequiredBodyParam' - $ref: '#/parameters/BackupPolicyNameRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' - $ref: '#/parameters/ValidateConnectionOptionalQueryParam' tags: - BackupRestore responses: '200': description: A successful operation returns 200 status code and updates the backup policy description. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Applications/{applicationId}/$/EnableBackup: post: operationId: microsoftAzureEnableapplicationbackup summary: Microsoft Azure Enables Periodic Backup Of Stateful Partitions Under This Service Fabric Application description: Enables periodic backup of stateful partitions which are part of this Service Fabric application. Each partition is backed up individually as per the specified backup policy description.
Note only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup. x-ms-examples: Enable application backup: $ref: ./examples/EnableApplicationBackup.json parameters: - $ref: '#/parameters/ApplicationIdRequiredPathParam' - $ref: '#/parameters/EnableBackupDescriptionRequiredBodyParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - BackupRestore responses: '202': description: A 202 status code indicates the request to enable application backup has been accepted. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Applications/{applicationId}/$/DisableBackup: post: operationId: microsoftAzureDisableapplicationbackup summary: Microsoft Azure Disables Periodic Backup Of Service Fabric Application description: Disables periodic backup of Service Fabric application which was previously enabled. x-ms-examples: Disable application backup: $ref: ./examples/DisableApplicationBackup.json parameters: - $ref: '#/parameters/ApplicationIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' - $ref: '#/parameters/DisableBackupDescriptionOptionalBodyParam' tags: - BackupRestore responses: '202': description: A 202 status code indicates the request to disable application backup has been accepted. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Applications/{applicationId}/$/GetBackupConfigurationInfo: get: operationId: microsoftAzureGetapplicationbackupconfigurationinfo summary: Microsoft Azure Gets The Service Fabric Application Backup Configuration Information description: Gets the Service Fabric backup configuration information for the application and the services and partitions under this application. x-ms-examples: Limit maximum results: $ref: ./examples/GetApplicationBackupConfigurationInfo-1.json Page using continuation token: $ref: ./examples/GetApplicationBackupConfigurationInfo-2.json parameters: - $ref: '#/parameters/ApplicationIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/ContinuationTokenOptionalQueryParam' - $ref: '#/parameters/MaxResultsOptionalQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - BackupRestore responses: '200': description: A successful operation will return 200 status code and a paged list of backup configuration information for the application, and the services and partitions under this application, for which backup configuration has been overridden. schema: $ref: '#/definitions/PagedBackupConfigurationInfoList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Applications/{applicationId}/$/GetBackups: get: operationId: microsoftAzureGetapplicationbackuplist summary: Microsoft Azure Gets The List Of Backups Available For Every Partition In This Application description: Returns a list of backups available for every partition in this Service Fabric application. The server enumerates all the backups available at the backup location configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition. x-ms-examples: Get application backups within a time range: $ref: ./examples/GetApplicationBackupList-1.json Get latest backup: $ref: ./examples/GetApplicationBackupList-2.json Limit maximum results: $ref: ./examples/GetApplicationBackupList-3.json Page using continuation token: $ref: ./examples/GetApplicationBackupList-4.json parameters: - $ref: '#/parameters/ApplicationIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' - $ref: '#/parameters/LatestOptionalQueryParam' - $ref: '#/parameters/StartDateTimeFilterOptionalQueryParam' - $ref: '#/parameters/EndDateTimeFilterOptionalQueryParam' - $ref: '#/parameters/ContinuationTokenOptionalQueryParam' - $ref: '#/parameters/MaxResultsOptionalQueryParam' tags: - BackupRestore responses: '200': description: A successful operation will return 200 status code and a paged list of backup information. schema: $ref: '#/definitions/PagedBackupInfoList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Applications/{applicationId}/$/SuspendBackup: post: operationId: microsoftAzureSuspendapplicationbackup summary: Microsoft Azure Suspends Periodic Backup For The Specified Service Fabric Application description: 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. x-ms-examples: Suspend application backup: $ref: ./examples/SuspendApplicationBackup.json tags: - BackupRestore parameters: - $ref: '#/parameters/ApplicationIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '202': description: A 202 status code indicates the operation request was accepted and application backup will be suspended. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Applications/{applicationId}/$/ResumeBackup: post: operationId: microsoftAzureResumeapplicationbackup summary: Microsoft Azure Resumes Periodic Backup Of A Service Fabric Application Which Was Previously Suspended description: The previously suspended Service Fabric application resumes taking periodic backup as per the backup policy currently configured for the same. x-ms-examples: Resume application backup: $ref: ./examples/ResumeApplicationBackup.json tags: - BackupRestore parameters: - $ref: '#/parameters/ApplicationIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '202': description: A 202 status code indicates the operation request was accepted and application backup will be resumed. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Services/{serviceId}/$/EnableBackup: post: operationId: microsoftAzureEnableservicebackup summary: Microsoft Azure Enables Periodic Backup Of Stateful Partitions Under This Service Fabric Service description: Enables periodic backup of stateful partitions which are part of this Service Fabric service. Each partition is backed up individually as per the specified backup policy description. In case the application, which the service is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup for this service and its partitions (unless explicitly overridden at the partition level).
Note only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup. x-ms-examples: Enable service backup: $ref: ./examples/EnableServiceBackup.json parameters: - $ref: '#/parameters/ServiceIdRequiredPathParam' - $ref: '#/parameters/EnableBackupDescriptionRequiredBodyParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - BackupRestore responses: '202': description: A 202 status code indicates the request to enable service backup has been accepted. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Services/{serviceId}/$/DisableBackup: post: operationId: microsoftAzureDisableservicebackup summary: Microsoft Azure Disables Periodic Backup Of Service Fabric Service Which Was Previously Enabled description: Disables periodic backup of Service Fabric service which was previously enabled. Backup must be explicitly enabled before it can be disabled.
In case the backup is enabled for the Service Fabric application, which this service is part of, this service would continue to be periodically backed up as per the policy mapped at the application level. x-ms-examples: Disable service backup: $ref: ./examples/DisableServiceBackup.json parameters: - $ref: '#/parameters/ServiceIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/DisableBackupDescriptionOptionalBodyParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - BackupRestore responses: '202': description: A 202 status code indicates the request to disable service backup has been accepted. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Services/{serviceId}/$/GetBackupConfigurationInfo: get: operationId: microsoftAzureGetservicebackupconfigurationinfo summary: Microsoft Azure Gets The Service Fabric Service Backup Configuration Information description: Gets the Service Fabric backup configuration information for the service and the partitions under this service. x-ms-examples: Limit maximum results: $ref: ./examples/GetServiceBackupConfigurationInfo-1.json Page using continuation token: $ref: ./examples/GetServiceBackupConfigurationInfo-2.json parameters: - $ref: '#/parameters/ServiceIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/ContinuationTokenOptionalQueryParam' - $ref: '#/parameters/MaxResultsOptionalQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - BackupRestore responses: '200': description: A successful operation will return 200 status code and a paged list of backup configuration information for the service, and the partitions under this service, for which backup configuration has been overridden. schema: $ref: '#/definitions/PagedBackupConfigurationInfoList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Services/{serviceId}/$/GetBackups: get: operationId: microsoftAzureGetservicebackuplist summary: Microsoft Azure Gets The List Of Backups Available For Every Partition In This Service description: Returns a list of backups available for every partition in this Service Fabric service. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition. x-ms-examples: Get application backups within a time range: $ref: ./examples/GetServiceBackupList-1.json Get latest backup: $ref: ./examples/GetServiceBackupList-2.json Limit maximum results: $ref: ./examples/GetServiceBackupList-3.json Page using continuation token: $ref: ./examples/GetServiceBackupList-4.json parameters: - $ref: '#/parameters/ServiceIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' - $ref: '#/parameters/LatestOptionalQueryParam' - $ref: '#/parameters/StartDateTimeFilterOptionalQueryParam' - $ref: '#/parameters/EndDateTimeFilterOptionalQueryParam' - $ref: '#/parameters/ContinuationTokenOptionalQueryParam' - $ref: '#/parameters/MaxResultsOptionalQueryParam' tags: - BackupRestore responses: '200': description: A successful operation will return 200 status code and a paged list of backup information. schema: $ref: '#/definitions/PagedBackupInfoList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Services/{serviceId}/$/SuspendBackup: post: operationId: microsoftAzureSuspendservicebackup summary: Microsoft Azure Suspends Periodic Backup For The Specified Service Fabric Service description: The service which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire service's hierarchy. It means all the partitions under this service are now suspended for backup. x-ms-examples: Suspend service backup: $ref: ./examples/SuspendServiceBackup.json tags: - BackupRestore parameters: - $ref: '#/parameters/ServiceIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '202': description: A 202 status code indicates the operation request was accepted and service backup will be suspended. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Services/{serviceId}/$/ResumeBackup: post: operationId: microsoftAzureResumeservicebackup summary: Microsoft Azure Resumes Periodic Backup Of A Service Fabric Service Which Was Previously Suspended description: The previously suspended Service Fabric service resumes taking periodic backup as per the backup policy currently configured for the same. x-ms-examples: Resume service backup: $ref: ./examples/ResumeServiceBackup.json tags: - BackupRestore parameters: - $ref: '#/parameters/ServiceIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '202': description: A 202 status code indicates the operation request was accepted and service backup will be resumed. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Partitions/{partitionId}/$/EnableBackup: post: operationId: microsoftAzureEnablepartitionbackup summary: Microsoft Azure Enables Periodic Backup Of The Stateful Persisted Partition description: Enables periodic backup of stateful persisted partition. Each partition is backed up as per the specified backup policy description. In case the application or service, which is partition is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup of this partition.
Note only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup. x-ms-examples: Enable partition backup: $ref: ./examples/EnablePartitionBackup.json parameters: - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/EnableBackupDescriptionRequiredBodyParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - BackupRestore responses: '202': description: A 202 status code indicates the request to enable partition backup has been accepted. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Partitions/{partitionId}/$/DisableBackup: post: operationId: microsoftAzureDisablepartitionbackup summary: Microsoft Azure Disables Periodic Backup Of Service Fabric Partition Which Was Previously Enabled description: Disables periodic backup of partition which was previously enabled. Backup must be explicitly enabled before it can be disabled.
In case the backup is enabled for the Service Fabric application or service, which this partition is part of, this partition would continue to be periodically backed up as per the policy mapped at the higher level entity. x-ms-examples: Disable partition backup: $ref: ./examples/DisablePartitionBackup.json parameters: - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/DisableBackupDescriptionOptionalBodyParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - BackupRestore responses: '202': description: A 202 status code indicates the request to disable partition backup has been accepted. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Partitions/{partitionId}/$/GetBackupConfigurationInfo: get: operationId: microsoftAzureGetpartitionbackupconfigurationinfo summary: Microsoft Azure Gets The Partition Backup Configuration Information description: Gets the Service Fabric Backup configuration information for the specified partition. x-ms-examples: Get partition backup configuration information: $ref: ./examples/GetPartitionBackupConfigurationInfo.json parameters: - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - BackupRestore responses: '200': description: A successful operation will return 200 status code and gets the partition's backup configuration information. schema: $ref: '#/definitions/PartitionBackupConfigurationInfo' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Partitions/{partitionId}/$/GetBackups: get: operationId: microsoftAzureGetpartitionbackuplist summary: Microsoft Azure Gets The List Of Backups Available For The Specified Partition description: Returns a list of backups available for the specified partition. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for the partition. x-ms-examples: Get application backups within a time range: $ref: ./examples/GetPartitionBackupList-1.json Get latest backup: $ref: ./examples/GetPartitionBackupList-2.json Limit maximum results: $ref: ./examples/GetPartitionBackupList-3.json Page using continuation token: $ref: ./examples/GetPartitionBackupList-4.json parameters: - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' - $ref: '#/parameters/LatestOptionalQueryParam' - $ref: '#/parameters/StartDateTimeFilterOptionalQueryParam' - $ref: '#/parameters/EndDateTimeFilterOptionalQueryParam' tags: - BackupRestore responses: '200': description: A successful operation will return 200 status code and a paged list of backup information. schema: $ref: '#/definitions/PagedBackupInfoList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Partitions/{partitionId}/$/SuspendBackup: post: operationId: microsoftAzureSuspendpartitionbackup summary: Microsoft Azure Suspends Periodic Backup For The Specified Partition description: The partition which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. x-ms-examples: Suspend partition backup: $ref: ./examples/SuspendPartitionBackup.json tags: - BackupRestore parameters: - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '202': description: A 202 status code indicates the operation request was accepted and partition backup will be suspended. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Partitions/{partitionId}/$/ResumeBackup: post: operationId: microsoftAzureResumepartitionbackup summary: Microsoft Azure Resumes Periodic Backup Of Partition Which Was Previously Suspended description: The previously suspended partition resumes taking periodic backup as per the backup policy currently configured for the same. x-ms-examples: Resume partition backup: $ref: ./examples/ResumePartitionBackup.json tags: - BackupRestore parameters: - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '202': description: A 202 status code indicates the operation request was accepted and partition backup will be resumed. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Partitions/{partitionId}/$/Backup: post: operationId: microsoftAzureBackuppartition summary: Microsoft Azure Triggers Backup Of The Partition S State description: Creates a backup of the stateful persisted partition's state. In case the partition is already being periodically backed up, then by default the new backup is created at the same backup storage. One can also override the same by specifying the backup storage details as part of the request body. Once the backup is initiated, its progress can be tracked using the GetBackupProgress operation.
In case, the operation times out, specify a greater backup timeout value in the query parameter. x-ms-examples: Backup partition: $ref: ./examples/BackupPartition-1.json Backup partition to a specific Azure storage account: $ref: ./examples/BackupPartition-2.json Backup partition to a specific Azure storage location accessed using managed identity: $ref: ./examples/BackupPartition-5.json Backup partition to a specific on-premise file share: $ref: ./examples/BackupPartition-3.json Backup partition to a specific Dsms Azure storage location: $ref: ./examples/BackupPartition-4.json tags: - BackupRestore parameters: - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/BackupPartitionDescriptionOptionalBodyParam' - $ref: '#/parameters/BackupTimeoutOptionalQueryParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '202': description: A 202 status code indicates the operation request was accepted and backup will be initiated. Use GetPartitionBackupProgress operation to get the status of the backup operation. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Partitions/{partitionId}/$/GetBackupProgress: get: operationId: microsoftAzureGetpartitionbackupprogress summary: Microsoft Azure Gets Details For The Latest Backup Triggered For This Partition description: Returns information about the state of the latest backup along with details or failure reason in case of completion. x-ms-examples: Get backup operation progress: $ref: ./examples/GetPartitionBackupProgress.json parameters: - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - BackupRestore responses: '200': description: A successful operation returns 200 status code and backup progress details. schema: $ref: '#/definitions/BackupProgressInfo' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Partitions/{partitionId}/$/Restore: post: operationId: microsoftAzureRestorepartition summary: Microsoft Azure Triggers Restore Of The State Of The Partition Using The Specified Restore Partition Description description: Restores the state of a of the stateful persisted partition using the specified backup point. In case the partition is already being periodically backed up, then by default the backup point is looked for in the storage specified in backup policy. One can also override the same by specifying the backup storage details as part of the restore partition description in body. Once the restore is initiated, its progress can be tracked using the GetRestoreProgress operation.
In case, the operation times out, specify a greater restore timeout value in the query parameter. x-ms-examples: Trigger partition restore: $ref: ./examples/RestorePartition.json parameters: - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/RestorePartitionDescriptionRequiredBodyParam' - $ref: '#/parameters/RestoreTimeoutOptionalQueryParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - BackupRestore responses: '202': description: A 202 status code indicates the operation request was accepted and restore will be initiated. Use GetPartitionRestoreProgress operation to get the status of the restore operation. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Partitions/{partitionId}/$/GetRestoreProgress: get: operationId: microsoftAzureGetpartitionrestoreprogress summary: Microsoft Azure Gets Details For The Latest Restore Operation Triggered For This Partition description: Returns information about the state of the latest restore operation along with details or failure reason in case of completion. x-ms-examples: Get restore operation progress: $ref: ./examples/GetPartitionRestoreProgress.json parameters: - $ref: '#/parameters/PartitionIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - BackupRestore responses: '200': description: A successful operation returns 200 status code and restore progress details. schema: $ref: '#/definitions/RestoreProgressInfo' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /BackupRestore/$/GetBackups: post: operationId: microsoftAzureGetbackupsfrombackuplocation summary: Microsoft Azure Gets The List Of Backups Available For The Specified Backed Up Entity At The Specified Backup Location description: Gets the list of backups available for the specified backed up entity (Application, Service or Partition) at the specified backup location (FileShare or Azure Blob Storage). x-ms-examples: Limit maximum results: $ref: ./examples/GetBackupsFromBackupLocation-1.json Page using continuation token: $ref: ./examples/GetBackupsFromBackupLocation-2.json parameters: - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' - $ref: '#/parameters/ContinuationTokenOptionalQueryParam' - $ref: '#/parameters/MaxResultsOptionalQueryParam' - $ref: '#/parameters/GetBackupByStorageQueryDescriptionRequiredBodyParam' tags: - BackupRestore responses: '200': description: A successful operation will return 200 status code and a paged list of backup information. schema: $ref: '#/definitions/PagedBackupInfoList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' definitions: BackupType: type: string description: Describes the type of backup, whether its full or incremental. enum: - Invalid - Full - Incremental x-ms-enum: name: BackupType modelAsString: true values: - value: Invalid description: Indicates an invalid backup type. All Service Fabric enumerations have the invalid type. - value: Full description: Indicates a full backup. - value: Incremental description: Indicates an incremental backup. A backup chain is comprised of a full backup followed by 0 or more incremental backups. GetBackupByStorageQueryDescription: description: Describes additional filters to be applied, while listing backups, and backup storage details from where to fetch the backups. required: - Storage - BackupEntity properties: StartDateTimeFilter: type: string format: date-time description: Specifies the start date time in ISO8601 from which to enumerate backups. If not specified, backups are enumerated from the beginning. EndDateTimeFilter: type: string format: date-time description: Specifies the end date time in ISO8601 till which to enumerate backups. If not specified, backups are enumerated till the end. Latest: type: boolean default: false description: If specified as true, gets the most recent backup (within the specified time range) for every partition under the specified backup entity. Storage: $ref: '#/definitions/BackupStorageDescription' description: Describes the parameters for the backup storage from where to enumerate backups. This is optional and by default backups are enumerated from the backup storage where this backup entity is currently being backed up (as specified in backup policy). This parameter is useful to be able to enumerate backups from another cluster where you may intend to restore. BackupEntity: $ref: '#/definitions/BackupEntity' description: Indicates the entity for which to enumerate backups. PagedBackupInfoList: description: 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 query with the continuation token provided in this list. properties: ContinuationToken: $ref: '#/definitions/ContinuationToken' description: 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 system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response. Items: type: array description: List of backup information. items: $ref: '#/definitions/BackupInfo' Epoch: description: 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 changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica. properties: ConfigurationVersion: type: string description: The current configuration number of this Epoch. The configuration number is an increasing value that is updated whenever the configuration of this replica set changes. DataLossVersion: type: string description: The current data loss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica. FabricErrorError: description: Error object containing error code and error message. properties: Code: $ref: '#/definitions/FabricErrorCodes' description: "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 the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"FABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"" Message: type: string description: Error message. required: - Code BackupEntity: discriminator: EntityKind description: Describes the Service Fabric entity that is configured for backup. properties: EntityKind: $ref: '#/definitions/BackupEntityKind' description: The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled. required: - EntityKind PartitionBackupConfigurationInfo: description: Backup configuration information, for a specific partition, specifying what backup policy is being applied and suspend description, if any. allOf: - $ref: '#/definitions/BackupConfigurationInfo' properties: ServiceName: $ref: '#/definitions/ServiceName' description: The full name of the service with 'fabric:' URI scheme. PartitionId: $ref: '#/definitions/PartitionId' description: The partition ID identifying the partition. x-ms-discriminator-value: Partition BackupPolicyScope: type: string description: Specifies the scope at which the backup policy is applied. enum: - Invalid - Partition - Service - Application x-ms-enum: name: BackupPolicyScope modelAsString: true values: - value: Invalid description: Indicates an invalid backup policy scope type. All Service Fabric enumerations have the invalid type. - value: Partition description: Indicates the backup policy is applied at partition level. Hence overriding any policy which may have applied at partition's service or application level. - value: Service description: Indicates the backup policy is applied at service level. All partitions of the service inherit this policy unless explicitly overridden at partition level. - value: Application description: Indicates the backup policy is applied at application level. All services and partitions of the application inherit this policy unless explicitly overridden at service or partition level. BackupStorageKind: type: string description: The kind of backup storage, where backups are saved. enum: - Invalid - FileShare - AzureBlobStore - DsmsAzureBlobStore - ManagedIdentityAzureBlobStore x-ms-enum: name: BackupStorageKind modelAsString: true values: - value: Invalid description: Indicates an invalid backup storage kind. All Service Fabric enumerations have the invalid type. - value: FileShare description: Indicates file/ SMB share to be used as backup storage. - value: AzureBlobStore description: Indicates Azure blob store to be used as backup storage. - value: DsmsAzureBlobStore description: Indicates Dsms Azure blob store to be used as backup storage. - value: ManagedIdentityAzureBlobStore description: Indicates Azure blob store to be used as backup storage using managed identity. BackupSuspensionScope: type: string description: Specifies the scope at which the backup suspension was applied. enum: - Invalid - Partition - Service - Application x-ms-enum: name: BackupSuspensionScope modelAsString: true values: - value: Invalid description: Indicates an invalid backup suspension scope type also indicating entity is not suspended. All Service Fabric enumerations have the invalid type. - value: Partition description: Indicates the backup suspension is applied at partition level. - value: Service description: Indicates the backup suspension is applied at service level. All partitions of the service are hence suspended for backup. - value: Application description: Indicates the backup suspension is applied at application level. All services and partitions of the application are hence suspended for backup. PartitionId: type: string format: uuid description: 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 unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different. RestoreState: type: string description: Represents the current state of the partition restore operation. enum: - Invalid - Accepted - RestoreInProgress - Success - Failure - Timeout x-ms-enum: name: RestoreState modelAsString: true values: - value: Invalid description: Indicates an invalid restore state. All Service Fabric enumerations have the invalid type. - value: Accepted description: Operation has been validated and accepted. Restore is yet to be triggered. - value: RestoreInProgress description: Restore operation has been triggered and is under process. - value: Success description: Operation completed with success. - value: Failure description: Operation completed with failure. - value: Timeout description: Operation timed out. ServicePartitionKind: type: string description: The kind of partitioning scheme used to partition the service. enum: - Invalid - Singleton - Int64Range - Named x-ms-enum: name: ServicePartitionKind modelAsString: true values: - value: Invalid description: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. - value: Singleton description: Indicates that there is only one partition, and SingletonPartitionSchemeDescription was specified while creating the service. The value is 1. - value: Int64Range description: Indicates that the partition is based on Int64 key ranges, and UniformInt64RangePartitionSchemeDescription was specified while creating the service. The value is 2. - value: Named description: Indicates that the partition is based on string names, and NamedPartitionInformation was specified while creating the service. The value is 3. RestorePartitionDescription: description: Specifies the parameters needed to trigger a restore of a specific partition. required: - BackupId - BackupLocation properties: BackupId: type: string format: uuid description: Unique backup ID. BackupLocation: type: string description: Location of the backup relative to the backup storage specified/ configured. BackupStorage: $ref: '#/definitions/BackupStorageDescription' description: Location of the backup from where the partition will be restored. BackupPartitionDescription: description: Describes the parameters for triggering partition's backup. properties: BackupStorage: $ref: '#/definitions/BackupStorageDescription' description: Specifies the details of the backup storage where to save the backup. ServiceName: type: string description: The full name of the service with 'fabric:' URI scheme. BackupStorageDescription: required: - StorageKind discriminator: StorageKind properties: StorageKind: $ref: '#/definitions/BackupStorageKind' description: The kind of backup storage, where backups are saved. FriendlyName: type: string description: Friendly name for this backup storage. description: Describes the parameters for the backup storage. BackupScheduleKind: type: string description: The kind of backup schedule, time based or frequency based. enum: - Invalid - TimeBased - FrequencyBased x-ms-enum: name: BackupScheduleKind modelAsString: true values: - value: Invalid description: Indicates an invalid backup schedule kind. All Service Fabric enumerations have the invalid type. - value: TimeBased description: Indicates a time-based backup schedule. - value: FrequencyBased description: Indicates a frequency-based backup schedule. BackupSuspensionInfo: description: Describes the backup suspension details. properties: IsSuspended: type: boolean description: Indicates whether periodic backup is suspended at this level or not. SuspensionInheritedFrom: $ref: '#/definitions/BackupSuspensionScope' description: Specifies the scope at which the backup suspension was applied. BackupScheduleDescription: description: Describes the backup schedule parameters. required: - ScheduleKind discriminator: ScheduleKind properties: ScheduleKind: $ref: '#/definitions/BackupScheduleKind' description: The kind of backup schedule, time based or frequency based. EnableBackupDescription: description: Specifies the parameters needed to enable periodic backup. required: - BackupPolicyName properties: BackupPolicyName: type: string description: Name of the backup policy to be used for enabling periodic backups. BackupState: type: string description: Represents the current state of the partition backup operation. enum: - Invalid - Accepted - BackupInProgress - Success - Failure - Timeout x-ms-enum: name: BackupState modelAsString: true values: - value: Invalid description: Indicates an invalid backup state. All Service Fabric enumerations have the invalid type. - value: Accepted description: Operation has been validated and accepted. Backup is yet to be triggered. - value: BackupInProgress description: Backup operation has been triggered and is under process. - value: Success description: Operation completed with success. - value: Failure description: Operation completed with failure. - value: Timeout description: Operation timed out. RetentionPolicyType: type: string description: The type of retention policy. Currently only "Basic" retention policy is supported. enum: - Basic - Invalid x-ms-enum: name: RetentionPolicyType modelAsString: true values: - value: Basic description: Indicates a basic retention policy type. - value: Invalid description: Indicates an invalid retention policy type. BackupPolicyDescription: description: Describes a backup policy for configuring periodic backup. required: - Name - AutoRestoreOnDataLoss - Schedule - MaxIncrementalBackups - Storage properties: Name: type: string description: The unique name identifying this backup policy. AutoRestoreOnDataLoss: type: boolean description: Specifies whether to trigger restore automatically using the latest available backup in case the partition experiences a data loss event. MaxIncrementalBackups: type: integer minimum: 0 maximum: 255 description: 'Defines the maximum number of incremental backups to be taken between two full backups. This is just the upper limit. A full backup may be taken before specified number of incremental backups are completed in one of the following conditions - The replica has never taken a full backup since it has become primary, - Some of the log records since the last backup has been truncated, or - Replica passed the MaxAccumulatedBackupLogSizeInMB limit.' Schedule: $ref: '#/definitions/BackupScheduleDescription' description: Describes the backup schedule parameters. Storage: $ref: '#/definitions/BackupStorageDescription' description: Describes the details of backup storage where to store the periodic backups. RetentionPolicy: $ref: '#/definitions/RetentionPolicyDescription' description: Describes the policy to retain backups in storage. PagedBackupEntityList: description: 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 results can be obtained by executing the same query with the continuation token provided in this list. properties: ContinuationToken: $ref: '#/definitions/ContinuationToken' description: 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 system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response. Items: type: array description: List of backup entity information. items: $ref: '#/definitions/BackupEntity' BackupEntityKind: type: string description: The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled. enum: - Invalid - Partition - Service - Application x-ms-enum: name: BackupEntityKind modelAsString: true values: - value: Invalid description: Indicates an invalid entity kind. All Service Fabric enumerations have the invalid type. - value: Partition description: Indicates the entity is a Service Fabric partition. - value: Service description: Indicates the entity is a Service Fabric service. - value: Application description: Indicates the entity is a Service Fabric application. FabricErrorCodes: type: string description: "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 the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"FABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"" enum: - FABRIC_E_INVALID_PARTITION_KEY - FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR - FABRIC_E_INVALID_ADDRESS - FABRIC_E_APPLICATION_NOT_UPGRADING - FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR - FABRIC_E_FABRIC_NOT_UPGRADING - FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR - FABRIC_E_INVALID_CONFIGURATION - FABRIC_E_INVALID_NAME_URI - FABRIC_E_PATH_TOO_LONG - FABRIC_E_KEY_TOO_LARGE - FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED - FABRIC_E_INVALID_ATOMIC_GROUP - FABRIC_E_VALUE_EMPTY - FABRIC_E_NODE_NOT_FOUND - FABRIC_E_APPLICATION_TYPE_NOT_FOUND - FABRIC_E_APPLICATION_NOT_FOUND - FABRIC_E_SERVICE_TYPE_NOT_FOUND - FABRIC_E_SERVICE_DOES_NOT_EXIST - FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND - FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND - FABRIC_E_PARTITION_NOT_FOUND - FABRIC_E_REPLICA_DOES_NOT_EXIST - FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST - FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND - FABRIC_E_DIRECTORY_NOT_FOUND - FABRIC_E_FABRIC_VERSION_NOT_FOUND - FABRIC_E_FILE_NOT_FOUND - FABRIC_E_NAME_DOES_NOT_EXIST - FABRIC_E_PROPERTY_DOES_NOT_EXIST - FABRIC_E_ENUMERATION_COMPLETED - FABRIC_E_SERVICE_MANIFEST_NOT_FOUND - FABRIC_E_KEY_NOT_FOUND - FABRIC_E_HEALTH_ENTITY_NOT_FOUND - FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS - FABRIC_E_APPLICATION_ALREADY_EXISTS - FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION - FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS - FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS - FABRIC_E_SERVICE_ALREADY_EXISTS - FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS - FABRIC_E_APPLICATION_TYPE_IN_USE - FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION - FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS - FABRIC_E_FABRIC_VERSION_IN_USE - FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS - FABRIC_E_NAME_ALREADY_EXISTS - FABRIC_E_NAME_NOT_EMPTY - FABRIC_E_PROPERTY_CHECK_FAILED - FABRIC_E_SERVICE_METADATA_MISMATCH - FABRIC_E_SERVICE_TYPE_MISMATCH - FABRIC_E_HEALTH_STALE_REPORT - FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED - FABRIC_E_NODE_HAS_NOT_STOPPED_YET - FABRIC_E_INSTANCE_ID_MISMATCH - FABRIC_E_VALUE_TOO_LARGE - FABRIC_E_NO_WRITE_QUORUM - FABRIC_E_NOT_PRIMARY - FABRIC_E_NOT_READY - FABRIC_E_RECONFIGURATION_PENDING - FABRIC_E_SERVICE_OFFLINE - E_ABORT - FABRIC_E_COMMUNICATION_ERROR - FABRIC_E_OPERATION_NOT_COMPLETE - FABRIC_E_TIMEOUT - FABRIC_E_NODE_IS_UP - E_FAIL - FABRIC_E_BACKUP_IS_ENABLED - FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH - FABRIC_E_INVALID_FOR_STATELESS_SERVICES - FABRIC_E_BACKUP_NOT_ENABLED - FABRIC_E_BACKUP_POLICY_NOT_EXISTING - FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING - FABRIC_E_BACKUP_IN_PROGRESS - FABRIC_E_RESTORE_IN_PROGRESS - FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING - FABRIC_E_INVALID_SERVICE_SCALING_POLICY - E_INVALIDARG - FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS - FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND - FABRIC_E_VOLUME_ALREADY_EXISTS - FABRIC_E_VOLUME_NOT_FOUND - SerializationError - FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR x-ms-enum: name: FabricErrorCodes modelAsString: true values: - value: FABRIC_E_INVALID_PARTITION_KEY - value: FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR - value: FABRIC_E_INVALID_ADDRESS - value: FABRIC_E_APPLICATION_NOT_UPGRADING - value: FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR - value: FABRIC_E_FABRIC_NOT_UPGRADING - value: FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR - value: FABRIC_E_INVALID_CONFIGURATION - value: FABRIC_E_INVALID_NAME_URI - value: FABRIC_E_PATH_TOO_LONG - value: FABRIC_E_KEY_TOO_LARGE - value: FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED - value: FABRIC_E_INVALID_ATOMIC_GROUP - value: FABRIC_E_VALUE_EMPTY - value: FABRIC_E_NODE_NOT_FOUND - value: FABRIC_E_APPLICATION_TYPE_NOT_FOUND - value: FABRIC_E_APPLICATION_NOT_FOUND - value: FABRIC_E_SERVICE_TYPE_NOT_FOUND - value: FABRIC_E_SERVICE_DOES_NOT_EXIST - value: FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND - value: FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND - value: FABRIC_E_PARTITION_NOT_FOUND - value: FABRIC_E_REPLICA_DOES_NOT_EXIST - value: FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST - value: FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND - value: FABRIC_E_DIRECTORY_NOT_FOUND - value: FABRIC_E_FABRIC_VERSION_NOT_FOUND - value: FABRIC_E_FILE_NOT_FOUND - value: FABRIC_E_NAME_DOES_NOT_EXIST - value: FABRIC_E_PROPERTY_DOES_NOT_EXIST - value: FABRIC_E_ENUMERATION_COMPLETED - value: FABRIC_E_SERVICE_MANIFEST_NOT_FOUND - value: FABRIC_E_KEY_NOT_FOUND - value: FABRIC_E_HEALTH_ENTITY_NOT_FOUND - value: FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS - value: FABRIC_E_APPLICATION_ALREADY_EXISTS - value: FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION - value: FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS - value: FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS - value: FABRIC_E_SERVICE_ALREADY_EXISTS - value: FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS - value: FABRIC_E_APPLICATION_TYPE_IN_USE - value: FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION - value: FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS - value: FABRIC_E_FABRIC_VERSION_IN_USE - value: FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS - value: FABRIC_E_NAME_ALREADY_EXISTS - value: FABRIC_E_NAME_NOT_EMPTY - value: FABRIC_E_PROPERTY_CHECK_FAILED - value: FABRIC_E_SERVICE_METADATA_MISMATCH - value: FABRIC_E_SERVICE_TYPE_MISMATCH - value: FABRIC_E_HEALTH_STALE_REPORT - value: FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED - value: FABRIC_E_NODE_HAS_NOT_STOPPED_YET - value: FABRIC_E_INSTANCE_ID_MISMATCH - value: FABRIC_E_VALUE_TOO_LARGE - value: FABRIC_E_NO_WRITE_QUORUM - value: FABRIC_E_NOT_PRIMARY - value: FABRIC_E_NOT_READY - value: FABRIC_E_RECONFIGURATION_PENDING - value: FABRIC_E_SERVICE_OFFLINE - value: E_ABORT - value: FABRIC_E_COMMUNICATION_ERROR - value: FABRIC_E_OPERATION_NOT_COMPLETE - value: FABRIC_E_TIMEOUT - value: FABRIC_E_NODE_IS_UP - value: E_FAIL - value: FABRIC_E_BACKUP_IS_ENABLED - value: FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH - value: FABRIC_E_INVALID_FOR_STATELESS_SERVICES - value: FABRIC_E_BACKUP_NOT_ENABLED - value: FABRIC_E_BACKUP_POLICY_NOT_EXISTING - value: FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING - value: FABRIC_E_BACKUP_IN_PROGRESS - value: FABRIC_E_RESTORE_IN_PROGRESS - value: FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING - value: FABRIC_E_INVALID_SERVICE_SCALING_POLICY - value: E_INVALIDARG - value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS - value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND - value: FABRIC_E_VOLUME_ALREADY_EXISTS - value: FABRIC_E_VOLUME_NOT_FOUND - value: SerializationError - value: FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR BackupInfo: description: Represents a backup point which can be used to trigger a restore. properties: BackupId: type: string format: uuid description: Unique backup ID . BackupChainId: type: string format: uuid description: Unique backup chain ID. All backups part of the same chain has the same backup chain id. A backup chain is comprised of 1 full backup and multiple incremental backups. ApplicationName: type: string description: Name of the Service Fabric application this partition backup belongs to. ServiceName: type: string description: Name of the Service Fabric service this partition backup belongs to. PartitionInformation: $ref: '#/definitions/PartitionInformation' description: Information about the partition to which this backup belongs to BackupLocation: type: string description: Location of the backup, relative to the backup store. BackupType: $ref: '#/definitions/BackupType' description: Describes the type of backup, whether its full or incremental. EpochOfLastBackupRecord: $ref: '#/definitions/Epoch' description: Epoch of the last record in this backup. LsnOfLastBackupRecord: type: string description: LSN of the last record in this backup. CreationTimeUtc: type: string format: date-time description: The date time when this backup was taken. ServiceManifestVersion: type: string description: Manifest Version of the service this partition backup belongs to. FailureError: $ref: '#/definitions/FabricErrorError' description: Denotes the failure encountered in getting backup point information. ContinuationToken: type: string description: 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 system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response. RestoreProgressInfo: description: Describes the progress of a restore operation on a partition. properties: RestoreState: $ref: '#/definitions/RestoreState' description: Represents the current state of the partition restore operation. TimeStampUtc: type: string format: date-time description: Timestamp when operation succeeded or failed. RestoredEpoch: $ref: '#/definitions/Epoch' description: Describes the epoch at which the partition is restored. RestoredLsn: type: string description: Restored LSN. FailureError: $ref: '#/definitions/FabricErrorError' description: Denotes the failure encountered in performing restore operation. PagedBackupConfigurationInfoList: description: 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 by executing the same query with the continuation token provided in this list. properties: ContinuationToken: $ref: '#/definitions/ContinuationToken' description: 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 system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response. Items: type: array description: List of backup configuration information. items: $ref: '#/definitions/BackupConfigurationInfo' FabricError: description: The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful. properties: Error: $ref: '#/definitions/FabricErrorError' description: Error object containing error code and error message. required: - Error PagedBackupPolicyDescriptionList: description: 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 obtained by executing the same query with the continuation token provided in this list. properties: ContinuationToken: $ref: '#/definitions/ContinuationToken' description: 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 system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response. Items: type: array description: The list of backup policies information. items: $ref: '#/definitions/BackupPolicyDescription' RetentionPolicyDescription: description: Describes the retention policy configured. required: - RetentionPolicyType discriminator: RetentionPolicyType properties: RetentionPolicyType: $ref: '#/definitions/RetentionPolicyType' description: The type of retention policy. Currently only "Basic" retention policy is supported. DisableBackupDescription: description: It describes the body parameters while disabling backup of a backup entity(Application/Service/Partition). required: - CleanBackup properties: CleanBackup: type: boolean description: Boolean flag to delete backups. It can be set to true for deleting all the backups which were created for the backup entity that is getting disabled for backup. BackupConfigurationInfo: discriminator: Kind description: Describes the backup configuration information. properties: Kind: $ref: '#/definitions/BackupEntityKind' description: The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled. PolicyName: description: The name of the backup policy which is applicable to this Service Fabric application or service or partition. type: string PolicyInheritedFrom: $ref: '#/definitions/BackupPolicyScope' description: Specifies the scope at which the backup policy is applied. SuspensionInfo: $ref: '#/definitions/BackupSuspensionInfo' description: Describes the backup suspension details. required: - Kind BackupProgressInfo: description: Describes the progress of a partition's backup. properties: BackupState: $ref: '#/definitions/BackupState' description: Represents the current state of the partition backup operation. TimeStampUtc: type: string format: date-time description: TimeStamp in UTC when operation succeeded or failed. BackupId: type: string format: uuid description: Unique ID of the newly created backup. BackupLocation: type: string description: Location, relative to the backup store, of the newly created backup. EpochOfLastBackupRecord: $ref: '#/definitions/Epoch' description: Specifies the epoch of the last record included in backup. LsnOfLastBackupRecord: type: string description: The LSN of last record included in backup. FailureError: $ref: '#/definitions/FabricErrorError' description: Denotes the failure encountered in performing backup operation. PartitionInformation: discriminator: ServicePartitionKind description: Information about the partition identity, partitioning scheme and keys supported by it. required: - ServicePartitionKind properties: ServicePartitionKind: $ref: '#/definitions/ServicePartitionKind' description: The kind of partitioning scheme used to partition the service. Id: $ref: '#/definitions/PartitionId' description: 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 unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different. parameters: StartDateTimeFilterOptionalQueryParam: name: StartDateTimeFilter in: query x-ms-parameter-location: method type: string format: date-time required: false description: Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated. PartitionIdRequiredPathParam: name: partitionId in: path x-ms-parameter-location: method x-ms-skip-url-encoding: true type: string format: uuid required: true description: The identity of the partition. ValidateConnectionOptionalQueryParam: name: ValidateConnection in: query x-ms-parameter-location: method type: boolean description: Specifies whether to validate the storage connection and credentials before creating or updating the backup policies. required: false default: false ApiVersion_6-4_RequiredQueryParam: name: api-version in: query x-ms-parameter-location: method type: string enum: - '6.4' required: true default: '6.4' description: 'The version of the API. This parameter is required and its value must be ''6.4''. Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification. Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.' x-ms-enum: name: ApiVersion_6-4_RequiredQueryParam modelAsString: true values: - value: '6.4' description: The 6.4 version of the API. EndDateTimeFilterOptionalQueryParam: name: EndDateTimeFilter in: query x-ms-parameter-location: method type: string format: date-time required: false description: Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup. DisableBackupDescriptionOptionalBodyParam: name: DisableBackupDescription in: body description: Specifies the parameters to disable backup for any backup entity. required: false x-ms-parameter-location: method schema: $ref: '#/definitions/DisableBackupDescription' BackupPolicyNameRequiredPathParam: name: backupPolicyName in: path description: The name of the backup policy. required: true x-ms-parameter-location: method type: string RestoreTimeoutOptionalQueryParam: name: RestoreTimeout description: Specifies the maximum amount of time to wait, in minutes, for the restore operation to complete. Post that, the operation returns back with timeout error. However, in certain corner cases it could be that the restore operation goes through even though it completes with timeout. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. the default value for the same is 10 minutes. in: query x-ms-parameter-location: method type: integer required: false default: 10 GetBackupByStorageQueryDescriptionRequiredBodyParam: name: GetBackupByStorageQueryDescription in: body required: true x-ms-parameter-location: method description: Describes the filters and backup storage details to be used for enumerating backups. schema: $ref: '#/definitions/GetBackupByStorageQueryDescription' BackupPartitionDescriptionOptionalBodyParam: name: BackupPartitionDescription in: body required: false x-ms-parameter-location: method description: Describes the parameters to backup the partition now. If not present, backup operation uses default parameters from the backup policy current associated with this partition. schema: $ref: '#/definitions/BackupPartitionDescription' TimeoutOptionalQueryParam: name: timeout in: query x-ms-parameter-location: method type: integer format: int64 required: false minimum: 1 maximum: 4294967295 default: 60 description: 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. LatestOptionalQueryParam: name: Latest in: query x-ms-parameter-location: method type: boolean description: Specifies whether to get only the most recent backup available for a partition for the specified time range. required: false default: false EnableBackupDescriptionRequiredBodyParam: name: EnableBackupDescription in: body description: Specifies the parameters for enabling backup. required: true x-ms-parameter-location: method schema: $ref: '#/definitions/EnableBackupDescription' ServiceIdRequiredPathParam: name: serviceId in: path x-ms-parameter-location: method x-ms-skip-url-encoding: true type: string required: true description: 'The identity of the service. This ID is typically the full name of the service without the ''fabric:'' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.' BackupTimeoutOptionalQueryParam: name: BackupTimeout in: query x-ms-parameter-location: method type: integer required: false description: Specifies the maximum amount of time, in minutes, to wait for the backup operation to complete. Post that, the operation completes with timeout error. However, in certain corner cases it could be that though the operation returns back timeout, the backup actually goes through. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. The default value for the same is 10 minutes. default: 10 MaxResultsOptionalQueryParam: name: MaxResults in: query x-ms-parameter-location: method type: integer format: int64 minimum: 0 default: 0 required: false description: The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. ApplicationIdRequiredPathParam: name: applicationId in: path x-ms-parameter-location: method x-ms-skip-url-encoding: true type: string required: true description: '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.' ContinuationTokenOptionalQueryParam: name: ContinuationToken in: query x-ms-parameter-location: method x-ms-skip-url-encoding: true type: string required: false description: The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded. RestorePartitionDescriptionRequiredBodyParam: name: RestorePartitionDescription in: body description: Describes the parameters to restore the partition. required: true x-ms-parameter-location: method schema: $ref: '#/definitions/RestorePartitionDescription' BackupPolicyDescriptionRequiredBodyParam: name: BackupPolicyDescription in: body required: true x-ms-parameter-location: method description: Describes the backup policy. schema: $ref: '#/definitions/BackupPolicyDescription' x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'