Backups Long Term Retention - Get

Service:

PostgreSQL

API Version:

2025-08-01

Gets the results of a long retention backup operation for a server.

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

URI Parameters

Name	In	Required	Type	Description
backupName	path	True	string pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*	The name of the backup.
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.

Responses

Name	Type	Description
200 OK	BackupsLongTermRetentionOperation	OK.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

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

Get the results of a long retention backup operation for a server.

Sample request

HTTP

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

Java

/**
 * Samples for BackupsLongTermRetention Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/
     * BackupsLongTermRetentionGet.json
     */
    /**
     * Sample code: Get the results of a long retention backup operation for a server.
     * 
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void getTheResultsOfALongRetentionBackupOperationForAServer(
        com.azure.resourcemanager.postgresqlflexibleserver.PostgreSqlManager manager) {
        manager.backupsLongTermRetentions().getWithResponse("exampleresourcegroup", "exampleserver", "exampleltrbackup",
            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_get.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.get(
        resource_group_name="exampleresourcegroup",
        server_name="exampleserver",
        backup_name="exampleltrbackup",
    )
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/BackupsLongTermRetentionGet.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

JavaScript

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

/**
 * This sample demonstrates how to Gets the results of a long retention backup operation for a server.
 *
 * @summary Gets the results of a long retention backup operation for a server.
 * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/BackupsLongTermRetentionGet.json
 */
async function getTheResultsOfALongRetentionBackupOperationForAServer() {
  const subscriptionId =
    process.env["POSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["POSTGRESQL_RESOURCE_GROUP"] || "exampleresourcegroup";
  const serverName = "exampleserver";
  const backupName = "exampleltrbackup";
  const credential = new DefaultAzureCredential();
  const client = new PostgreSQLManagementFlexibleServerClient(credential, subscriptionId);
  const result = await client.backupsLongTermRetention.get(
    resourceGroupName,
    serverName,
    backupName,
  );
  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": {
    "backupName": "exampleltrbackup",
    "datasourceSizeInBytes": 21,
    "dataTransferredInBytes": 9,
    "backupMetadata": "backupMetadata",
    "status": "Running",
    "percentComplete": 4,
    "startTime": "2025-06-01T18:30:22.123Z",
    "endTime": "2025-06-01T18:35:22.123Z"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver",
  "name": "exampleltrbackup",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers/ltrbackupOperations"
}

Definitions

Name	Description
BackupsLongTermRetentionOperation	Response for the LTR backup Operation API call
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExecutionStatus	Service-set extensible enum indicating the status of operation
systemData	Metadata pertaining to creation and last modification of the resource.

BackupsLongTermRetentionOperation

Object

Response for the LTR backup Operation API call

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
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
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

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.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.