共用方式為

建立備份原則

  • 發行項

建立備份原則。

建立備份原則，稍後可以與 Service Fabric 應用程式、服務或分割區建立關聯以進行定期備份。

要求

方法 要求 URI
POST /BackupRestore/BackupPolicies/$/Create?api-version=6.4&timeout={timeout}&ValidateConnection={ValidateConnection}

參數

名稱 類型 必要 Location
api-version 字串 是 查詢
timeout 整數 (int64) No 查詢
ValidateConnection boolean No 查詢
BackupPolicyDescription BackupPolicyDescription 是 body

api-version

類型：字串
必要：是
預設：6.4

API 的版本。 這是必要參數，其值必須是 '6.4'。

Service Fabric REST API 版本是以 API 引進或變更的執行時間版本為基礎。 Service Fabric 執行時間支援多個版本的 API。 此版本是 API 的最新支援版本。 如果傳遞較低的 API 版本，傳回的回應可能會與本規格中所述的回應不同。

此外，執行時間也接受高於最新支援版本的任何版本，最高為目前版本的執行時間。 因此，如果最新的 API 版本是 6.0，而執行時間是 6.1，則執行時間將會接受該 API 的版本 6.1。 不過，API 的行為會根據記載的 6.0 版本。

timeout

類型：整數 (int64)
必要：否
預設：60
InclusiveMaximum： 4294967295
InclusiveMinimum： 1

用來執行作業的伺服器逾時 (以秒為單位)。 此逾時指定了用戶端願意等候要求作業完成的持續時間。 這個參數的預設值是 60 秒。

ValidateConnection

類型：布林值
必要：否
預設：false

指定在建立或更新備份原則之前，是否要驗證儲存體連線和認證。

BackupPolicyDescription

類型： BackupPolicyDescription
必要：是

描述備份原則。

回應

HTTP 狀態碼 描述 回應結構描述
201 (已建立) 成功的作業會傳回 201 狀態碼，並建立新的備份原則。
所有其他狀態碼 詳細的錯誤回應。
 FabricError

範例

使用 Azure 作為備份位置建立以時間為基礎的備份原則

此範例示範如何建立備份原則，以每天上午 9 點和下午 5 點 UTC 進行備份兩次，這在 3 個月之後應刪除，Azure Blob 存放區作為備份位置。

要求

POST http://localhost:19080/BackupRestore/BackupPolicies/$/Create?api-version=6.4
主體
{
  "Name": "DailyAzureBackupPolicy",
  "AutoRestoreOnDataLoss": false,
  "MaxIncrementalBackups": "3",
  "Schedule": {
    "ScheduleKind": "TimeBased",
    "ScheduleFrequencyType": "Daily",
    "RunTimes": [
      "0001-01-01T09:00:00Z",
      "0001-01-01T17:00:00Z"
    ]
  },
  "Storage": {
    "StorageKind": "AzureBlobStore",
    "FriendlyName": "Azure_storagesample",
    "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<PutYourAccountKeyHere>",
    "ContainerName": "BackupContainer"
  },
  "RetentionPolicy": {
    "RetentionPolicyType": "Basic",
    "MinimumNumberOfBackups": "20",
    "RetentionDuration": "P3M"
  }
}

201 回應

主體

回應主體是空的。

使用 Azure 建立以時間為基礎的備份原則，作為使用受控識別存取的備份位置

此範例示範如何建立備份原則，以每天上午 9 點和下午 5 點 UTC 進行備份兩次，這應該會在 3 個月之後刪除，使用 Azure Blob 存放區作為使用受控識別的備份位置。

要求

POST http://localhost:19080/BackupRestore/BackupPolicies/$/Create?api-version=6.4
主體
{
  "Name": "DailyAzureMIBackupPolicy",
  "AutoRestoreOnDataLoss": false,
  "MaxIncrementalBackups": "3",
  "Schedule": {
    "ScheduleKind": "TimeBased",
    "ScheduleFrequencyType": "Daily",
    "RunTimes": [
      "0001-01-01T09:00:00Z",
      "0001-01-01T17:00:00Z"
    ]
  },
  "Storage": {
    "StorageKind": "ManagedIdentityAzureBlobStore",
    "FriendlyName": "AzureMI_storagesample",
    "BlobServiceUri": "https://managedidentitytest.blob.core.windows.net/",
    "ContainerName": "BackupContainer",
    "ManagedIdentityType": "Cluster"
  },
  "RetentionPolicy": {
    "RetentionPolicyType": "Basic",
    "MinimumNumberOfBackups": "20",
    "RetentionDuration": "P3M"
  }
}

201 回應

主體

回應主體是空的。

建立以檔案共用作為備份位置的頻率型備份原則

此範例示範如何建立備份原則，每隔 10 分鐘進行備份一次，該原則會在 20 天后刪除，並將檔案共用作為備份位置。

要求

POST http://localhost:19080/BackupRestore/BackupPolicies/$/Create?api-version=6.4
主體
{
  "Name": "FileShare10MinBackupPolicy",
  "AutoRestoreOnDataLoss": false,
  "MaxIncrementalBackups": "3",
  "Schedule": {
    "ScheduleKind": "FrequencyBased",
    "Interval": "PT10M"
  },
  "Storage": {
    "StorageKind": "FileShare",
    "FriendlyName": "FileShare_myshare",
    "Path": "\\\\myshare\\backupshare",
    "PrimaryUserName": "backupaccount",
    "PrimaryPassword": "abcd1234"
  },
  "RetentionPolicy": {
    "RetentionPolicyType": "Basic",
    "MinimumNumberOfBackups": "20",
    "RetentionDuration": "P20D"
  }
}

201 回應

主體

回應主體是空的。

使用 Dsms Azure 作為備份位置建立以時間為基礎的備份原則

此範例示範如何建立備份原則，以每天上午 9 點和下午 5 點 UTC 進行備份兩次，且 Dsms Azure Blob 存放區作為備份位置後應該刪除。

要求

POST http://localhost:19080/BackupRestore/BackupPolicies/$/Create?api-version=6.4
主體
{
  "Name": "SampleDsmsBackupPolicy",
  "AutoRestoreOnDataLoss": false,
  "MaxIncrementalBackups": "3",
  "Schedule": {
    "ScheduleKind": "TimeBased",
    "ScheduleFrequencyType": "Daily",
    "RunTimes": [
      "0001-01-01T09:00:00Z",
      "0001-01-01T17:00:00Z"
    ]
  },
  "Storage": {
    "StorageKind": "DsmsAzureBlobStore",
    "FriendlyName": "DsmsAzure_storagesample",
    "StorageCredentialsSourceLocation": "https://sample-dsms.dsms.core.winows.net/dsms/samplecredentiallocation/storageaccounts/samplestorageac/servicefabricbackup/samplebackup",
    "ContainerName": "BackupContainer"
  },
  "RetentionPolicy": {
    "RetentionPolicyType": "Basic",
    "MinimumNumberOfBackups": "20",
    "RetentionDuration": "P3M"
  }
}

201 回應

主體

回應主體是空的。