Skip to content

Commit 1a1ab79

Browse files
committed
edit pass: azure-database-for-postgresql-backup
1 parent 4d0ec20 commit 1a1ab79

File tree

2 files changed

+89
-83
lines changed

2 files changed

+89
-83
lines changed

articles/backup/backup-azure-database-postgresql-overview.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: jsuri
1313
Azure Backup and Azure database services have come together to build an enterprise-class backup solution for Azure Database for PostgreSQL servers that retains backups for up to 10 years. Besides long-term retention, the solution offers the following capabilities:
1414

1515
- Customer-controlled scheduled and on-demand backups at the individual database level.
16-
- Database-level restores to any PostgreSQL server or to any type of blob storage.
16+
- Database-level restores to any Azure Database for PostgreSQL server or to any type of blob storage.
1717
- Central monitoring of all operations and jobs.
1818
- Storage of backups in separate security and fault domains. If the source server or subscription becomes compromised, the backups remain safe in the [Azure Backup vault](./backup-vault-overview.md) (in Azure Backup managed storage accounts).
1919
- Use of `pg_dump` for greater flexibility in restores. You can restore across database versions.
@@ -52,23 +52,23 @@ You can restore PostgreSQL single-server databases by using **Restore as Files**
5252

5353
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.
5454

55-
1. The Azure Backup service validates that it has [appropriate permissions to authenticate](#azure-backup-authentication-with-the-postgresql-server) with the specified PostgreSQL server and to back up its databases.
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.
5656

57-
1. Azure Backup spins up a worker role (virtual machine) with a backup extension installed in it to communicate with the protected PostgreSQL server. This extension consists of a coordinator and a PostgreSQL plugin. The coordinator triggers workflows for various operations, such as backup and restore. The plugin manages the actual data flow.
57+
1. Azure Backup spins up a worker role (virtual machine) with a backup extension installed in it to communicate with the protected Azure Database for PostgreSQL server. This extension consists of a coordinator and a PostgreSQL plugin. The coordinator triggers workflows for various operations, such as backup and restore. The plugin manages the actual data flow.
5858

59-
1. At the scheduled time, the coordinator instructs the plugin to start streaming the backup data from the PostgreSQL server by using `pg_dump` (custom).
59+
1. At the scheduled time, the coordinator instructs the plugin to start streaming the backup data from the Azure Database for PostgreSQL server by using `pg_dump` (custom).
6060

6161
1. The plugin sends the data directly to the Azure Backup managed storage accounts (masked by the Azure Backup vault), eliminating the need for a staging location. The data is encrypted through Microsoft-managed keys. The Azure Backup service stores the data in storage accounts.
6262

6363
:::image type="content" source="./media/backup-azure-database-postgresql-overview/backup-process.png" alt-text="Diagram that shows the backup process.":::
6464

65-
## Azure Backup authentication with the PostgreSQL server
65+
## Azure Backup authentication with the Azure Database for PostgreSQL server
6666

6767
Azure Backup follows strict security guidelines from Azure. Permissions on the resource to be backed up aren't assumed. The user needs to explicitly give those permissions.
6868

6969
### Key Vault-based authentication model
7070

71-
The Azure Backup service needs to connect to the PostgreSQL server while taking each backup. Although a username and password (or a connection string) that correspond to the database are used to make this connection, these credentials aren't stored with Azure Backup. Instead, the database admin needs to securely seed these credentials in [Azure Key Vault as a secret](/azure/key-vault/secrets/about-secrets).
71+
The Azure Backup service needs to connect to the Azure Database for PostgreSQL server while taking each backup. Although a username and password (or a connection string) that correspond to the database are used to make this connection, these credentials aren't stored with Azure Backup. Instead, the database admin needs to securely seed these credentials in [Azure Key Vault as a secret](/azure/key-vault/secrets/about-secrets).
7272

7373
The workload admin is responsible for managing and rotating credentials. Azure Backup calls for the most recent secret details from Key Vault to take the backup.
7474

@@ -78,12 +78,12 @@ The workload admin is responsible for managing and rotating credentials. Azure B
7878

7979
1. Grant the following access permissions to the Azure Backup vault's managed service identity (MSI):
8080

81-
- **Reader** access on the PostgreSQL server.
81+
- **Reader** access on the Azure Database for PostgreSQL server.
8282
- **Key Vault Secrets User** access on Key Vault (**Get** and **List** permissions on secrets).
8383

8484
1. Set network line-of-sight access on:
8585

86-
- PostgreSQL server: Set **Allow access to Azure services** to **Yes**.
86+
- Azure Database for PostgreSQL server: Set **Allow access to Azure services** to **Yes**.
8787
- Key Vault: Set **Allow trusted Microsoft services** to **Yes**.
8888

8989
1. Set the database user's backup privileges on the database.
@@ -93,7 +93,7 @@ The workload admin is responsible for managing and rotating credentials. Azure B
9393
9494
#### Permissions needed for Azure PostgreSQL database restore
9595

96-
Permissions for restore are similar to the ones that you need for backup. You need to [manually grant the permissions on the target PostgreSQL server and the corresponding key vault](#steps-for-manually-granting-access-on-the-postgresql-server-and-on-key-vault). Unlike in the [configure backup](backup-azure-database-postgresql.md#configure-backup-on-azure-postgresql-databases) flow, the experience to grant these permissions inline is currently not available.
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-backup-on-azure-postgresql-databases) flow, the experience to grant these permissions inline is currently not available.
9797

9898
Ensure that the database user (corresponding to the credentials stored in the key vault) has the following restore privileges on the database:
9999

@@ -106,26 +106,26 @@ Ensure that the database user (corresponding to the credentials stored in the ke
106106

107107
An earlier authentication model was entirely based on Microsoft Entra ID. The Key Vault-based authentication model (as explained earlier) is now available as an alternative option to ease the configuration process.
108108

109-
To get an automated script and related instructions to use the Microsoft Entra ID-based authentication model, [download this document](https://download.microsoft.com/download/7/4/d/74d689aa-909d-4d3e-9b18-f8e465a7ebf5/OSSbkpprep_automated.docx). It grants an appropriate set of permissions to a PostgreSQL server for backup and restore.
109+
To get an automated script and related instructions to use the Microsoft Entra ID-based authentication model, [download this document](https://download.microsoft.com/download/7/4/d/74d689aa-909d-4d3e-9b18-f8e465a7ebf5/OSSbkpprep_automated.docx). It grants an appropriate set of permissions to an Azure Database for PostgreSQL server for backup and restore.
110110

111111
> [!NOTE]
112112
> All the newly configured protection takes place with the new Key Vault authentication model only. However, all the existing backup instances with protection configured through Microsoft Entra ID-based authentication will continue to exist and have regular backups taken. To restore these backups, you need to follow the Microsoft Entra ID-based authentication.
113113
114-
## Steps for manually granting access on the PostgreSQL server and on Key Vault
114+
## Steps for manually granting access on the Azure Database for PostgreSQL server and on Key Vault
115115

116116
To grant all the access permissions that Azure Backup needs, use the following steps.
117117

118-
### Access permissions for the PostgreSQL server
118+
### Access permissions for the Azure Database for PostgreSQL server
119119

120-
1. Set the Azure Backup vault's MSI **Reader** access on the PostgreSQL server.
120+
1. Set the Azure Backup vault's MSI **Reader** access on the Azure Database for PostgreSQL server.
121121

122-
:::image type="content" source="./media/backup-azure-database-postgresql-overview/set-reader-access-on-azure-postgresql-server-inline.png" alt-text="Screenshot that shows the option to set an Azure Backup vault's M S I Reader access on an Azure PostgreSQL server." lightbox="./media/backup-azure-database-postgresql-overview/set-reader-access-on-azure-postgresql-server-expanded.png":::
122+
:::image type="content" source="./media/backup-azure-database-postgresql-overview/set-reader-access-on-azure-postgresql-server-inline.png" alt-text="Screenshot that shows the option to set an Azure Backup vault's M S I Reader access on an Azure Database for PostgreSQL server." lightbox="./media/backup-azure-database-postgresql-overview/set-reader-access-on-azure-postgresql-server-expanded.png":::
123123

124-
1. Set network line-of-sight access on the PostgreSQL server by setting **Allow access to Azure services** to **Yes**.
124+
1. Set network line-of-sight access on the Azure Database for PostgreSQL server by setting **Allow access to Azure services** to **Yes**.
125125

126-
:::image type="content" source="./media/backup-azure-database-postgresql-overview/network-line-of-sight-access-on-azure-postgresql-server.png" alt-text="Screenshot that shows the option to set network line-of-sight access on an Azure PostgreSQL server." lightbox="./media/backup-azure-database-postgresql-overview/network-line-of-sight-access-on-azure-postgresql-server.png":::
126+
:::image type="content" source="./media/backup-azure-database-postgresql-overview/network-line-of-sight-access-on-azure-postgresql-server.png" alt-text="Screenshot that shows the option to set network line-of-sight access on an Azure Database for PostgreSQL server." lightbox="./media/backup-azure-database-postgresql-overview/network-line-of-sight-access-on-azure-postgresql-server.png":::
127127

128-
### Access permissions for Key Vault (associated with the PostgreSQL server)
128+
### Access permissions for Key Vault (associated with the Azure Database for PostgreSQL server)
129129

130130
1. Set the Azure Backup vault's MSI **Key Vault Secrets User** access on Key Vault (**Get** and **List** permissions on secrets). To assign permissions, you can use role assignments or access policies. You don't need to add the permissions by using both options, because it doesn't help.
131131

@@ -180,9 +180,9 @@ $do$
180180
181181
## Use the PG admin tool
182182

183-
[Download the PG admin tool](https://www.pgadmin.org/download/) if you don't have it already. You can connect to the PostgreSQL server through this tool. Also, you can add databases and new users to this server.
183+
[Download the PG admin tool](https://www.pgadmin.org/download/) if you don't have it already. You can connect to the Azure Database for PostgreSQL server through this tool. Also, you can add databases and new users to this server.
184184

185-
:::image type="content" source="./media/backup-azure-database-postgresql-overview/connect-to-azure-postgresql-server-using-pg-admin-tool-inline.png" alt-text="Screenshot that shows the process to connect to a PostgreSQL server by using the P G admin tool." lightbox="./media/backup-azure-database-postgresql-overview/connect-to-azure-postgresql-server-using-pg-admin-tool-expanded.png":::
185+
:::image type="content" source="./media/backup-azure-database-postgresql-overview/connect-to-azure-postgresql-server-using-pg-admin-tool-inline.png" alt-text="Screenshot that shows the process to connect to an Azure Database for PostgreSQL server by using the P G admin tool." lightbox="./media/backup-azure-database-postgresql-overview/connect-to-azure-postgresql-server-using-pg-admin-tool-expanded.png":::
186186

187187
Create a new server with a name of your choice. Enter the host name/address. It's the same as the **Server name** value displayed in the Azure PostgreSQL resource view in the Azure portal.
188188

0 commit comments

Comments
 (0)