Long Term Retention Policies - List By Database

Service:

SQL Database

API Version:

2021-11-01

データベースの長期保持ポリシーを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies?api-version=2021-11-01

URI パラメーター

名前	/	必須	型	説明
databaseName	path	True	string	データベースの名前。
resourceGroupName	path	True	string	リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求で使用する API のバージョン。

応答

名前	型	説明
200 OK	LongTermRetentionPolicyListResult	ポリシーが正常に取得されました。
Other Status Codes		エラー応答: *** 400 LTRNotSupportedForPerDBCMK - データベースレベルの CMK がプレビューで構成されている場合、長期バックアップリテンション期間はサポートされません。 400 LongTermRetentionPolicyNotSupported - このデータベースでは、長期保持はサポートされていません。 400 LongTermRetentionPolicyInvalid - 長期保持ポリシーが無効です。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソース グループとサブスクリプションに存在しません。 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。

例

Get the long term retention policy for the database.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup/providers/Microsoft.Sql/servers/testserver/databases/testDatabase/backupLongTermRetentionPolicies?api-version=2021-11-01

Java

import com.azure.core.util.Context;

/** Samples for LongTermRetentionPolicies ListByDatabase. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/LongTermRetentionPolicyListByDatabase
     * .json
     */
    /**
     * Sample code: Get the long term retention policy for the database.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getTheLongTermRetentionPolicyForTheDatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getLongTermRetentionPolicies().listByDatabase("resourceGroup",
            "testserver", "testDatabase", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/resourceGroups/resourceGroup/servers/testserver/databases/testDatabase/backupLongTermRetentionPolicies/default",
      "name": "default",
      "type": "Microsoft.Sql/resourceGroups/servers/databases/backupLongTermRetentionPolicies",
      "properties": {
        "weeklyRetention": "P1M",
        "monthlyRetention": "P1Y",
        "yearlyRetention": "P5Y",
        "weekOfYear": 5
      }
    }
  ]
}

定義

名前	説明
LongTermRetentionPolicy	長期保持ポリシー。
LongTermRetentionPolicyListResult	長期保持ポリシーの一覧。

LongTermRetentionPolicy

長期保持ポリシー。

名前	型	説明
id	string	リソースの ID
name	string	リソース名。
properties.monthlyRetention	string	ISO 8601 形式の LTR バックアップの月単位の保持ポリシー。
properties.weekOfYear	integer	ISO 8601 形式の年単位のバックアップを取得する年の週。
properties.weeklyRetention	string	ISO 8601 形式の LTR バックアップの週単位の保持ポリシー。
properties.yearlyRetention	string	ISO 8601 形式の LTR バックアップの年間保持ポリシー。
type	string	リソースの種類。

LongTermRetentionPolicyListResult

長期保持ポリシーの一覧。

名前	型	説明
nextLink	string	結果の次のページを取得するためのリンク。
value	LongTermRetentionPolicy[]	結果の配列。