Microsoft Azure BackupRestore API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Backup Restore API
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: '#/components/parameters/BackupPolicyDescriptionRequiredBodyParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/BackupPolicyNameRequiredPathParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/parameters/ContinuationTokenOptionalQueryParam'
      - $ref: '#/components/parameters/MaxResultsOptionalQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - BackupRestore
      responses:
        '200':
          description: A successful operation will return 200 status code and paged list of backup policies.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedBackupPolicyDescriptionList'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/BackupPolicyNameRequiredPathParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - BackupRestore
      responses:
        '200':
          description: A successful operation will return 200 status code and the backup policy description.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupPolicyDescription'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/BackupPolicyNameRequiredPathParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/parameters/ContinuationTokenOptionalQueryParam'
      - $ref: '#/components/parameters/MaxResultsOptionalQueryParam'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedBackupEntityList'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/BackupPolicyDescriptionRequiredBodyParam'
      - $ref: '#/components/parameters/BackupPolicyNameRequiredPathParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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. <br>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: '#/components/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/components/parameters/EnableBackupDescriptionRequiredBodyParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/parameters/ContinuationTokenOptionalQueryParam'
      - $ref: '#/components/parameters/MaxResultsOptionalQueryParam'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedBackupConfigurationInfoList'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      - $ref: '#/components/parameters/LatestOptionalQueryParam'
      - $ref: '#/components/parameters/StartDateTimeFilterOptionalQueryParam'
      - $ref: '#/components/parameters/EndDateTimeFilterOptionalQueryParam'
      - $ref: '#/components/parameters/ContinuationTokenOptionalQueryParam'
      - $ref: '#/components/parameters/MaxResultsOptionalQueryParam'
      tags:
      - BackupRestore
      responses:
        '200':
          description: A successful operation will return 200 status code and a paged list of backup information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedBackupInfoList'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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).<br>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: '#/components/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/components/parameters/EnableBackupDescriptionRequiredBodyParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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.<br>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: '#/components/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/parameters/DisableBackupDescriptionOptionalBodyParam'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/parameters/ContinuationTokenOptionalQueryParam'
      - $ref: '#/components/parameters/MaxResultsOptionalQueryParam'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedBackupConfigurationInfoList'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      - $ref: '#/components/parameters/LatestOptionalQueryParam'
      - $ref: '#/components/parameters/StartDateTimeFilterOptionalQueryParam'
      - $ref: '#/components/parameters/EndDateTimeFilterOptionalQueryParam'
      - $ref: '#/components/parameters/ContinuationTokenOptionalQueryParam'
      - $ref: '#/components/parameters/MaxResultsOptionalQueryParam'
      tags:
      - BackupRestore
      responses:
        '200':
          description: A successful operation will return 200 status code and a paged list of backup information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedBackupInfoList'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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.<br>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: '#/components/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/components/parameters/EnableBackupDescriptionRequiredBodyParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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. <br>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: '#/components/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/parameters/DisableBackupDescriptionOptionalBodyParam'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - BackupRestore
      responses:
        '200':
          description: A successful operation will return 200 status code and gets the partition's backup configuration information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartitionBackupConfigurationInfo'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      - $ref: '#/components/parameters/LatestOptionalQueryParam'
      - $ref: '#/components/parameters/StartDateTimeFilterOptionalQueryParam'
      - $ref: '#/components/parameters/EndDateTimeFilterOptionalQueryParam'
      tags:
      - BackupRestore
      responses:
        '200':
          description: A successful operation will return 200 status code and a paged list of backup information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedBackupInfoList'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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.

# --- truncated at 32 KB (93 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-backuprestore-api-openapi.yml