Backups Long Term Retention - Start

Service:

PostgreSQL

API Version:

2025-08-01

Initiates a long term retention backup.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/startLtrBackup?api-version=2025-08-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*	The name of the server.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
backupSettings	True	BackupSettings	Backup Settings
targetDetails	True	BackupStoreDetails	Backup store detail for target server

Responses

Name	Type	Description
200 OK	BackupsLongTermRetentionResponse	OK. Headers x-ms-request-id: string
202 Accepted		Accepted. Headers Retry-After: integer x-ms-request-id: string Location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Error response describing why the operation failed. Headers x-ms-error-code: string x-ms-request-id: string

Security

azure_auth

Microsoft Entra OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Initiate a long term retention backup.

Sample request

HTTP

POST https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver/startLtrBackup?api-version=2025-08-01

{
  "backupSettings": {
    "backupName": "exampleltrbackup"
  },
  "targetDetails": {
    "sasUriList": [
      "sasuri"
    ]
  }
}

Java

import com.azure.resourcemanager.postgresqlflexibleserver.models.BackupSettings;
import com.azure.resourcemanager.postgresqlflexibleserver.models.BackupStoreDetails;
import com.azure.resourcemanager.postgresqlflexibleserver.models.BackupsLongTermRetentionRequest;
import java.util.Arrays;

/**
 * Samples for BackupsLongTermRetention Start.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/
     * BackupsLongTermRetentionStart.json
     */
    /**
     * Sample code: Initiate a long term retention backup.
     * 
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void
        initiateALongTermRetentionBackup(com.azure.resourcemanager.postgresqlflexibleserver.PostgreSqlManager manager) {
        manager.backupsLongTermRetentions().start("exampleresourcegroup", "exampleserver",
            new BackupsLongTermRetentionRequest()
                .withBackupSettings(new BackupSettings().withBackupName("exampleltrbackup"))
                .withTargetDetails(new BackupStoreDetails().withSasUriList(Arrays.asList("sasuri"))),
            com.azure.core.util.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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python backups_long_term_retention_start.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PostgreSQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.backups_long_term_retention.begin_start(
        resource_group_name="exampleresourcegroup",
        server_name="exampleserver",
        parameters={"backupSettings": {"backupName": "exampleltrbackup"}, "targetDetails": {"sasUriList": ["sasuri"]}},
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/BackupsLongTermRetentionStart.json
if __name__ == "__main__":
    main()

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

Go

package armpostgresqlflexibleservers_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/postgresql/armpostgresqlflexibleservers/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e96c24570a484cff13d153fb472f812878866a39/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/BackupsLongTermRetentionStart.json
func ExampleBackupsLongTermRetentionClient_BeginStart() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpostgresqlflexibleservers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewBackupsLongTermRetentionClient().BeginStart(ctx, "exampleresourcegroup", "exampleserver", armpostgresqlflexibleservers.BackupsLongTermRetentionRequest{
		BackupSettings: &armpostgresqlflexibleservers.BackupSettings{
			BackupName: to.Ptr("exampleltrbackup"),
		},
		TargetDetails: &armpostgresqlflexibleservers.BackupStoreDetails{
			SasURIList: []*string{
				to.Ptr("sasuri")},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.BackupsLongTermRetentionResponse = armpostgresqlflexibleservers.BackupsLongTermRetentionResponse{
	// 	Properties: &armpostgresqlflexibleservers.LtrBackupOperationResponseProperties{
	// 		BackupMetadata: to.Ptr("backupmetadata"),
	// 		DataTransferredInBytes: to.Ptr[int64](23),
	// 		DatasourceSizeInBytes: to.Ptr[int64](23),
	// 		EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-06-01T18:35:22.123Z"); return t}()),
	// 		PercentComplete: to.Ptr[float64](100),
	// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-06-01T18:30:22.123Z"); return t}()),
	// 		Status: to.Ptr(armpostgresqlflexibleservers.ExecutionStatusRunning),
	// 	},
	// }
}

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

JavaScript

const { PostgreSQLManagementFlexibleServerClient } = require("@azure/arm-postgresql-flexible");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Initiates a long term retention backup.
 *
 * @summary Initiates a long term retention backup.
 * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/BackupsLongTermRetentionStart.json
 */
async function initiateALongTermRetentionBackup() {
  const subscriptionId =
    process.env["POSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["POSTGRESQL_RESOURCE_GROUP"] || "exampleresourcegroup";
  const serverName = "exampleserver";
  const parameters = {
    backupSettings: { backupName: "exampleltrbackup" },
    targetDetails: { sasUriList: ["sasuri"] },
  };
  const credential = new DefaultAzureCredential();
  const client = new PostgreSQLManagementFlexibleServerClient(credential, subscriptionId);
  const result = await client.backupsLongTermRetention.beginStartAndWait(
    resourceGroupName,
    serverName,
    parameters,
  );
  console.log(result);
}

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

{
  "properties": {
    "datasourceSizeInBytes": 23,
    "dataTransferredInBytes": 23,
    "backupMetadata": "backupmetadata",
    "status": "Running",
    "startTime": "2025-06-01T18:30:22.123Z",
    "endTime": "2025-06-01T18:35:22.123Z",
    "percentComplete": 100
  }
}

Status code:

202

Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westcentralus/operationResults/ffc80e91-03db-4534-b5de-bacb77aa6a81?api-version=2025-06-01-preview
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westcentralus/azureAsyncOperation/ffc80e91-03db-4534-b5de-bacb77aa6a81?api-version=2025-06-01-preview

Definitions

Name	Description
BackupSettings	The settings for the long term backup.
BackupsLongTermRetentionRequest	The request that is made for a long term retention backup.
BackupsLongTermRetentionResponse	Response for the LTR backup API call
BackupStoreDetails	Details about the target where the backup content will be stored.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExecutionStatus	Service-set extensible enum indicating the status of operation

BackupSettings

Object

The settings for the long term backup.

Name	Type	Description
backupName	string	Backup Name for the current backup

BackupsLongTermRetentionRequest

Object

The request that is made for a long term retention backup.

Name	Type	Description
backupSettings	BackupSettings	Backup Settings
targetDetails	BackupStoreDetails	Backup store detail for target server

BackupsLongTermRetentionResponse

Object

Response for the LTR backup API call

Name	Type	Description
properties.backupMetadata	string	Metadata to be stored in RP. Store everything that will be required to perform a successful restore using this Recovery point. e.g. Versions, DataFormat etc
properties.backupName	string	Name of Backup operation
properties.dataTransferredInBytes	integer (int64)	Data transferred in bytes
properties.datasourceSizeInBytes	integer (int64)	Size of datasource in bytes
properties.endTime	string (date-time)	End time of the operation.
properties.errorCode	string	The error code.
properties.errorMessage	string	The error message.
properties.percentComplete	number (double) minimum: 0 maximum: 100	PercentageCompleted
properties.startTime	string (date-time)	Start time of the operation.
properties.status	ExecutionStatus	Service-set extensible enum indicating the status of operation

BackupStoreDetails

Object

Details about the target where the backup content will be stored.

Name	Type	Description
sasUriList	string[]	List of SAS uri of storage containers where backup data is to be streamed/copied.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ExecutionStatus

Enumeration

Service-set extensible enum indicating the status of operation

Value	Description
Running	The operation is currently running.
Cancelled	The operation was cancelled.
Failed	The operation failed.
Succeeded	The operation succeeded.