You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/backup/backup-azure-data-protection-use-rest-api-backup-postgresql.md
+12-15Lines changed: 12 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
-
title: Back up Azure PostgreSQL databases using Azure data protection REST API
3
-
description: In this article, learn how to configure, initiate, and manage backup operations of Azure PostgreSQL databases using REST API.
2
+
title: Back Up PostgreSQL Databases by Using the Azure Data Protection REST API
3
+
description: In this article, learn how to configure, initiate, and manage backup operations of PostgreSQL databases in Azure Database for PostgreSQL by using the REST API.
4
4
ms.topic: how-to
5
5
ms.date: 02/09/2025
6
6
ms.service: azure-backup
@@ -9,11 +9,11 @@ author: jyothisuri
9
9
ms.author: jsuri
10
10
---
11
11
12
-
# Back up Azure PostgreSQL databases using Azure data protection via REST API
12
+
# Back up PostgreSQL databases by using the Azure data protection REST API
13
13
14
-
This article describes how to manage backups for Azure PostgreSQL databases via REST API.
14
+
This article describes how to manage backups for PostgreSQL databases in Azure Database for PostgreSQL by using the REST API.
15
15
16
-
For information on the Azure PostgreSQL database backup supported scenarios, limitations, and authentication mechanisms, see the [overview](backup-azure-database-postgresql-overview.md) document.
16
+
For information on the supported scenarios, limitations, and authentication mechanisms for PostgreSQL database backup in Azure Database for PostgreSQL, see the [overview](backup-azure-database-postgresql-overview.md) document.
17
17
18
18
## Prerequisites
19
19
@@ -23,7 +23,7 @@ For information on the Azure PostgreSQL database backup supported scenarios, lim
23
23
24
24
## Configure backup
25
25
26
-
Once the vault and policy are created, there're three critical points that you need to consider to protect an Azure PostgreSQL database.
26
+
Once the vault and policy are created, there're three critical points that you need to consider to protect a PostgreSQL database.
27
27
28
28
### Key entities involved
29
29
@@ -51,7 +51,7 @@ You need to grant permissions to back up vault's MSI on the PostgreSQL server an
51
51
52
52
### Prepare the request to configure backup
53
53
54
-
After you set the relevant permissions to the vault and PostgreSQL database, and configure the vault and policy, prepare the request to configure backup. See the following request body to configure backup for an Azure PostgreSQL database. The Azure Resource Manager ID (ARM ID) of the Azure PostgreSQL database and its details are present in the _datasourceinfo_ section. The policy information is present in the _policyinfo_ section.
54
+
After you set the relevant permissions to the vault and PostgreSQL database, and configure the vault and policy, prepare the request to configure backup. See the following request body to configure backup for a PostgreSQL database. The Azure Resource Manager ID (ARM ID) of the PostgreSQL database and its details are present in the _datasourceinfo_ section. The policy information is present in the _policyinfo_ section.
55
55
56
56
```json
57
57
{
@@ -99,7 +99,7 @@ For example, this API translates to:
99
99
POST https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/TestBkpVaultRG/providers/Microsoft.DataProtection/backupVaults/testBkpVault/validateForBackup?api-version=2021-01-01
100
100
```
101
101
102
-
The [request body](#prepare-the-request-to-configure-backup) that we prepared earlier will be used to provide details of the Azure PostgreSQL database to be protected.
102
+
The [request body](#prepare-the-request-to-configure-backup) that we prepared earlier will be used to provide details of the PostgreSQL database to be protected.
103
103
104
104
#### Example request body
105
105
@@ -292,7 +292,7 @@ GET https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
292
292
293
293
### Configure backup request
294
294
295
-
Once the request is validated, you can submit the same to the [create backup instance API](/rest/api/dataprotection/backup-instances/create-or-update). One of the Azure Backup data protection services protects the Backup instance within the Backup vault. Here, the Azure PostgreSQL database is the backup instance. Use the above-validated request body with minor additions.
295
+
Once the request is validated, you can submit the same to the [create backup instance API](/rest/api/dataprotection/backup-instances/create-or-update). One of the Azure Backup data protection services protects the Backup instance within the Backup vault. Here, the PostgreSQL database is the backup instance. Use the above-validated request body with minor additions.
296
296
297
297
Use a unique name for the backup instance. So, we recommend you use a combination of the resource name and a unique identifier. For example, in the following operation, we'll use _testpostgresql-empdb11-957d23b1-c679-4c94-ade6-c4d34635e149_ and mark it as the backup instance name.
298
298
@@ -446,7 +446,7 @@ Once the operation completes, it returns 200 (OK) with the success message in th
446
446
447
447
### Stop protection and delete data
448
448
449
-
To remove the protection on an Azure PostgreSQL database and delete the backup data as well, perform a [delete operation](/rest/api/dataprotection/backup-instances/delete).
449
+
To remove the protection on a PostgreSQL database and delete the backup data as well, perform a [delete operation](/rest/api/dataprotection/backup-instances/delete).
450
450
451
451
Stopping protection and deleting data is a *DELETE* operation.
452
452
@@ -508,12 +508,9 @@ GET "https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx
508
508
}
509
509
```
510
510
511
-
## Next steps
512
-
513
-
[Restore data from an Azure PostGreSQL database backup](restore-postgresql-database-use-rest-api.md)
514
-
515
-
For more information on the Azure Backup REST APIs, see the following articles:
511
+
## Related content
516
512
513
+
-[Restore data from a PostGreSQL database backup](restore-postgresql-database-use-rest-api.md)
517
514
-[Get started with Azure Data Protection Provider REST API](/rest/api/dataprotection/)
518
515
-[Get started with Azure REST API](/rest/api/azure/)
519
516
-[Manage backup jobs using REST API](backup-azure-arm-userestapi-managejobs.md).
Copy file name to clipboardExpand all lines: articles/backup/backup-azure-data-protection-use-rest-api-create-update-postgresql-policy.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
1
---
2
-
title: Create backup policies for Azure PostgreSQL databases using data protection REST API
3
-
description: In this article, you'll learn how to create and manage backup policies for Azure PostgreSQL databases using REST API.
2
+
title: Create Backup Policies for PostgreSQL Databases by Using the Data Protection REST API
3
+
description: In this article, you learn how to create and manage backup policies for PostgreSQL databases in Azure Database for PostgreSQL by using the REST API.
4
4
ms.topic: how-to
5
5
ms.date: 02/09/2025
6
6
ms.assetid: 759ee63f-148b-464c-bfc4-c9e640b7da6b
7
7
author: jyothisuri
8
8
ms.author: jsuri
9
9
---
10
10
11
-
# Create Azure Data Protection backup policies for Azure PostgreSQL databases using REST API
11
+
# Create Azure Data Protection backup policies for PostgreSQL databases by using the REST API
12
12
13
-
A backup policy governs the retention and schedule of your backups. Azure PostgreSQL database Backup offers long-term retention and supports a backup per day.
13
+
A backup policy governs the retention and schedule of your PostgreSQL database backups in Azure Database for PostgreSQL. Azure Database for PostgreSQL database backup offers long-term retention and supports a backup per day.
14
14
15
15
You can reuse an existing backup policy to configure backup for PostgreSQL databases to a vault, or [create a backup policy for an Azure Recovery Services vault using REST API](/rest/api/dataprotection/backup-policies/create-or-update).
Copy file name to clipboardExpand all lines: articles/backup/backup-azure-database-postgresql-overview.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,7 +50,7 @@ You can restore PostgreSQL single-server databases by using **Restore as Files**
50
50
51
51
## Backup process
52
52
53
-
1. As a backup admin, you can specify the Azure PostgreSQL databases that you intend to back up. You can also specify the details of Azure Key Vault, which stores the credentials needed to connect to the specified databases. The database admin securely seeds these credentials in Key Vault.
53
+
1. As a backup admin, you can specify the PostgreSQL databases that you intend to back up. You can also specify the details of Azure Key Vault, which stores the credentials needed to connect to the specified databases. The database admin securely seeds these credentials in Key Vault.
54
54
55
55
1. The Azure Backup service validates that it has [appropriate permissions to authenticate](#azure-backup-authentication-with-the-azure-database-for-postgresql-server) with the specified Azure Database for PostgreSQL server and to back up its databases.
56
56
@@ -74,7 +74,7 @@ The workload admin is responsible for managing and rotating credentials. Azure B
74
74
75
75
:::image type="content" source="./media/backup-azure-database-postgresql-overview/key-vault-based-authentication-model.png" alt-text="Diagram that shows the workload or database flow.":::
76
76
77
-
#### Permissions needed for Azure PostgreSQL database backup
77
+
#### Permissions needed for PostgreSQL database backup
78
78
79
79
1. Grant the following access permissions to the Azure Backup vault's managed service identity (MSI):
80
80
@@ -91,7 +91,7 @@ The workload admin is responsible for managing and rotating credentials. Azure B
91
91
> [!NOTE]
92
92
> You can grant these permissions within the [configure backup](backup-azure-database-postgresql.md##configure-a-backup-on-azure-postgresql-databases) flow with a single click if you, as the backup admin, have write access on the intended resources. If you don't have the required permissions (when multiple personas are involved), use an Azure Resource Manager template.
93
93
94
-
#### Permissions needed for Azure PostgreSQL database restore
94
+
#### Permissions needed for PostgreSQL database restore
95
95
96
96
Permissions for restore are similar to the ones that you need for backup. You need to [manually grant the permissions on the target Azure Database for PostgreSQL server and the corresponding key vault](#steps-for-manually-granting-access-on-the-azure-database-for-postgresql-server-and-on-key-vault). Unlike in the [configure backup](backup-azure-database-postgresql.md##configure-a-backup-on-azure-postgresql-databases) flow, the experience to grant these permissions inline is currently not available.
Copy file name to clipboardExpand all lines: articles/backup/backup-azure-database-postgresql.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,18 @@
1
1
---
2
-
title: Back up Azure Database for PostgreSQL
3
-
description: Learn about Azure Database for PostgreSQL backup with long-term retention.
2
+
title: Back Up Azure Database for PostgreSQL by Using the Azure Portal
3
+
description: Learn how to back up Azure Database for PostgreSQL by using the Azure portal.
4
4
ms.topic: how-to
5
5
ms.date: 03/18/2025
6
6
ms.service: azure-backup
7
7
author: jyothisuri
8
8
ms.author: jsuri
9
9
---
10
10
11
-
# Back up Azure Database for PostgreSQL with long-term retention
11
+
# Back up Azure Database for PostgreSQL by using the Azure portal
12
12
13
13
This article describes how to back up an Azure Database for PostgreSQL server. Before you begin, review the [supported configurations, feature considerations, and known limitations](./backup-azure-database-postgresql-support-matrix.md), along with [frequently asked questions](/azure/backup/backup-azure-database-postgresql-server-faq).
14
14
15
-
## Configure a backup on Azure PostgreSQL databases
15
+
## Configure a backup on PostgreSQL databases
16
16
17
17
You can configure a backup on multiple databases across multiple Azure Database for PostgreSQL servers. To configure this kind of backup by using Azure Backup, follow these steps:
18
18
@@ -32,7 +32,7 @@ You can configure a backup on multiple databases across multiple Azure Database
32
32
33
33
1. On the **Datasources** tab, select **Add/Edit**.
34
34
35
-
:::image type="content" source="./media/backup-azure-database-postgresql/select-azure-postgresql-databases-to-back-up-inline.png" alt-text="Screenshot that shows the button for adding or editing an Azure PostgreSQL database." lightbox="./media/backup-azure-database-postgresql/select-azure-postgresql-databases-to-back-up-expanded.png":::
35
+
:::image type="content" source="./media/backup-azure-database-postgresql/select-azure-postgresql-databases-to-back-up-inline.png" alt-text="Screenshot that shows the button for adding or editing a PostgreSQL database." lightbox="./media/backup-azure-database-postgresql/select-azure-postgresql-databases-to-back-up-expanded.png":::
36
36
37
37
1. On the **Select resources to backup** pane, choose one of the Azure Database for PostgreSQL servers across subscriptions if they're in the same region as that of the vault. Select the arrow to show the list of databases within a server.
Copy file name to clipboardExpand all lines: articles/backup/backup-postgresql-cli.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
-
title: Back up Azure Database for PostgreSQL with long-term-retention using Azure CLI
3
-
description: Learn how to back up Azure Database for PostgreSQL using Azure CLI.
2
+
title: Back Up a PostgreSQL Databases by Using the Azure CLI
3
+
description: Learn how to back up PostgreSQL databases in Azure Database for PostgreSQL by using the Azure CLI.
4
4
ms.topic: how-to
5
5
ms.date: 03/18/2025
6
6
ms.custom: devx-track-azurecli
@@ -9,11 +9,11 @@ author: jyothisuri
9
9
ms.author: jsuri
10
10
---
11
11
12
-
# Back up Azure PostgreSQL databases using Azure CLI
12
+
# Back up PostgreSQL databases by using the Azure CLI
13
13
14
-
This article explains how to back up [Azure PostgreSQL database](/azure/postgresql/overview#azure-database-for-postgresql---single-server) using Azure CLI.
14
+
This article explains how to back up PostgreSQL databases in [Azure Database for PostgreSQL](/azure/postgresql/overview#azure-database-for-postgresql---single-server)by using the Azure CLI.
15
15
16
-
Learn more about the [supported scenarios](backup-azure-database-postgresql-support-matrix.md) and [frequently asked questions](/azure/backup/backup-azure-database-postgresql-server-faq) to back up Azure Database for PostgreSQL Database.
16
+
Learn more about the [supported scenarios](backup-azure-database-postgresql-support-matrix.md) and [frequently asked questions](/azure/backup/backup-azure-database-postgresql-server-faq) to back up PostgreSQL databases in Azure Database for PostgreSQL.
After the vault is created, let's create a Backup policy to protect Azure PostgreSQL databases.
55
+
After the vault is created, let's create a Backup policy to protect PostgreSQL databases.
56
56
57
57
## Create a Backup policy
58
58
@@ -94,7 +94,7 @@ The resultant PowerShell object is as follows:
94
94
95
95
### Retrieve the policy template
96
96
97
-
To understand the inner components of a Backup policy for Azure PostgreSQL database backup, retrieve the policy template using the [`az dataprotection backup-policy get-default-policy-template`](/cli/azure/dataprotection/backup-policy#az-dataprotection-backup-policy-get-default-policy-template) command. This command returns a default policy template for a given datasource type. Use this policy template to create a new policy.
97
+
To understand the inner components of a Backup policy for PostgreSQL database backup, retrieve the policy template using the [`az dataprotection backup-policy get-default-policy-template`](/cli/azure/dataprotection/backup-policy#az-dataprotection-backup-policy-get-default-policy-template) command. This command returns a default policy template for a given datasource type. Use this policy template to create a new policy.
98
98
99
99
```azurecli-interactive
100
100
az dataprotection backup-policy get-default-policy-template --datasource-type AzureDatabaseForPostgreSQL
@@ -158,7 +158,7 @@ az dataprotection backup-policy get-default-policy-template --datasource-type Az
158
158
}
159
159
```
160
160
161
-
The policy template consists of a trigger (which decides what triggers the backup) and a lifecycle (which decides when to delete/copy/move the backup). In Azure PostgreSQL database backup, the default value for trigger is a scheduled Weekly trigger (one backup every seven days) and to retain each backup for three months.
161
+
The policy template consists of a trigger (which decides what triggers the backup) and a lifecycle (which decides when to delete/copy/move the backup). In PostgreSQL database backup, the default value for trigger is a scheduled Weekly trigger (one backup every seven days) and to retain each backup for three months.
0 commit comments