Skip to content

Commit 3bd9c89

Browse files
committed
edit pass: azure-database-for-postgresql-backup
1 parent a8d1633 commit 3bd9c89

11 files changed

+49
-48
lines changed

articles/backup/backup-azure-data-protection-use-rest-api-backup-postgresql.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The following example uses Bash. Note the secret identifier of the relevant key.
4646

4747
#### Backup vault
4848

49-
A backup vault has to connect to the PostgreSQL server and then access the database via the keys present in the key vault. So, it requires access to the PostgreSQL server and the key vault. Access is granted to the backup vault's managed identity.
49+
A backup vault has to connect to the PostgreSQL server and then access the database via the keys present in the key vault. So, the backup vault requires access to the PostgreSQL server and the key vault. Access is granted to the backup vault's managed identity.
5050

5151
You need to grant permissions to the backup vault's managed identity on the PostgreSQL server and the key vault that stores the keys to the database. [Learn more](./backup-azure-database-postgresql-overview.md#permissions-needed-for-postgresql-database-backup).
5252

@@ -501,7 +501,7 @@ GET "https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx
501501

502502
## Related content
503503

504-
- [Restore PostgreSQL databases by using the Azure Data Protection REST API](restore-postgresql-database-use-rest-api.md)
504+
- [Restore PostgreSQL databases by using the Data Protection REST API](restore-postgresql-database-use-rest-api.md)
505505
- [Azure Backup Data Protection REST API](/rest/api/dataprotection/)
506506
- [Azure REST API reference](/rest/api/azure/)
507507
- [Track backup and restore jobs by using the REST API in Azure Backup](backup-azure-arm-userestapi-managejobs.md)

articles/backup/backup-azure-data-protection-use-rest-api-create-update-postgresql-policy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ The resultant PowerShell object is as follows:
5959
> [!IMPORTANT]
6060
> Currently, updating or modifying an existing policy isn't supported. Instead, create a new policy with the required details and assign it to the relevant backup instance.
6161
62-
To create an Azure Backup policy, use the following `PUT` operation:
62+
To create an backup policy, use the following `PUT` operation:
6363

6464
```http
6565
PUT https://management.azure.com/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies/{policyName}?api-version=2021-01-01
@@ -385,7 +385,7 @@ The backup policy creation or update is a synchronous operation. After the opera
385385

386386
|Name |Type |Description |
387387
|---------|---------|---------|
388-
|`200 OK` | [`BaseBackupPolicyResource`](/rest/api/dataprotection/backup-policies/create-or-update#basebackuppolicyresource) | OK |
388+
|`200 OK` | [`BaseBackupPolicyResource`](/rest/api/dataprotection/backup-policies/create-or-update#basebackuppolicyresource) | The operation is completed. |
389389

390390
### Example response
391391

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

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Azure Backup and Azure database services have come together to build an enterpri
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.
2020

21-
You can use this solution independently or in addition to the [native backup solution in Azure PostgreSQL](/azure/postgresql/concepts-backup), which offers retention up to 35 days. The native solution is suited for operational recoveries, such as when you want to recover from the latest backups. The Azure Backup solution helps you with your compliance needs and provides a more granular and flexible backup/restore capability.
21+
You can use this solution independently or in addition to the [native backup solution in Azure PostgreSQL](/azure/postgresql/concepts-backup), which offers retention for up to 35 days. The native solution is suited for operational recoveries, such as when you want to recover from the latest backups. The Azure Backup solution helps you with your compliance needs and provides a more granular and flexible backup/restore capability.
2222

2323
## <a name = "changes-to-vaulted-backups-for-postgresql-single-server"></a>Changes to vaulted backups for PostgreSQL single servers
2424

@@ -54,7 +54,7 @@ You can restore PostgreSQL single-server databases by using **Restore as Files**
5454

5555
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 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.
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

5959
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

@@ -132,22 +132,23 @@ To grant all the access permissions that Azure Backup needs, use the following s
132132
- To use Azure role-based access control (Azure RBAC) authorization:
133133

134134
1. In **Access policies**, set **Permission model** to **Azure role-based access control**.
135-
1. In **Access control (IAM)**, grant the Azure Backup vault's **Key Vault Secrets User** access for the managed identity on the key vault. Bearers of that role will be able to read secrets.
136135

137-
For more information, see [Provide access to Key Vault keys, certificates, and secrets with Azure role-based access control](/azure/key-vault/general/rbac-guide?tabs=azure-cli).
136+
:::image type="content" source="./media/backup-azure-database-postgresql-overview/key-vault-secrets-user-access-inline.png" alt-text="Screenshot that shows the option to provide Key Vault Secrets User access." lightbox="./media/backup-azure-database-postgresql-overview/key-vault-secrets-user-access-expanded.png":::
138137

139-
:::image type="content" source="./media/backup-azure-database-postgresql-overview/key-vault-secrets-user-access-inline.png" alt-text="Screenshot that shows the option to provide Key Vault Secrets User access." lightbox="./media/backup-azure-database-postgresql-overview/key-vault-secrets-user-access-expanded.png":::
138+
1. In **Access control (IAM)**, grant the Azure Backup vault's **Key Vault Secrets User** access for the managed identity on the key vault. Bearers of that role will be able to read secrets.
140139

141-
:::image type="content" source="./media/backup-azure-database-postgresql-overview/grant-permission-to-applications-azure-rbac-inline.png" alt-text="Screenshot that shows the option to grant the Azure Backup vault's M S I Key Vault Secrets User access on the key vault." lightbox="./media/backup-azure-database-postgresql-overview/grant-permission-to-applications-azure-rbac-expanded.png":::
140+
:::image type="content" source="./media/backup-azure-database-postgresql-overview/grant-permission-to-applications-azure-rbac-inline.png" alt-text="Screenshot that shows the option to grant the Azure Backup vault's M S I Key Vault Secrets User access on the key vault." lightbox="./media/backup-azure-database-postgresql-overview/grant-permission-to-applications-azure-rbac-expanded.png":::
141+
142+
For more information, see [Provide access to Key Vault keys, certificates, and secrets with Azure role-based access control](/azure/key-vault/general/rbac-guide?tabs=azure-cli).
142143

143144
- To use access policies:
144145

145146
1. In **Access policies**, set **Permission model** to **Vault access policy**.
146147
1. Set **Get** and **List** permissions on secrets.
147148

148-
For more information, see [Assign a Key Vault access policy (legacy)](/azure/key-vault/general/assign-access-policy?tabs=azure-portal).
149+
:::image type="content" source="./media/backup-azure-database-postgresql-overview/permission-model-is-set-to-vault-access-policy-inline.png" alt-text="Screenshot that shows the option to grant permission by using access policies." lightbox="./media/backup-azure-database-postgresql-overview/permission-model-is-set-to-vault-access-policy-expanded.png":::
149150

150-
:::image type="content" source="./media/backup-azure-database-postgresql-overview/permission-model-is-set-to-vault-access-policy-inline.png" alt-text="Screenshot that shows the option to grant permission by using access policies." lightbox="./media/backup-azure-database-postgresql-overview/permission-model-is-set-to-vault-access-policy-expanded.png":::
151+
For more information, see [Assign a Key Vault access policy (legacy)](/azure/key-vault/general/assign-access-policy?tabs=azure-portal).
151152

152153
1. Set network line-of-sight access on the key vault by setting **Allow trusted Microsoft services to bypass this firewall?** to **Yes**.
153154

@@ -205,4 +206,4 @@ You can add new databases and database users to the server. For database users,
205206
## Related content
206207

207208
- [Frequently asked questions for Azure Database for PostgreSQL backup](/azure/backup/backup-azure-database-postgresql-server-faq)
208-
- [Azure Database for PostgreSQL backup with long-term retention](backup-azure-database-postgresql.md)
209+
- [Back up Azure Database for PostgreSQL by using the Azure portal](backup-azure-database-postgresql.md)

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This article describes how to back up an Azure Database for PostgreSQL server. B
1414

1515
## <a name = "configure-backup-on-azure-postgresql-databases"></a>Configure a backup on PostgreSQL databases
1616

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:
17+
You can configure a backup on multiple PostgreSQL databases across multiple Azure Database for PostgreSQL servers. To configure this kind of backup by using Azure Backup, follow these steps:
1818

1919
1. Go to **Backup vault**, select a vault, and then select **Backup**.
2020

@@ -55,7 +55,7 @@ You can configure a backup on multiple databases across multiple Azure Database
5555

5656
:::image type="content" source="./media/backup-azure-database-postgresql/enter-secret-uri-inline.png" alt-text="Screenshot that shows how to get a secret U R I." lightbox="./media/backup-azure-database-postgresql/enter-secret-uri-expanded.png":::
5757

58-
However, with this option, Azure Backup has no visibility into the key vault that you referenced. Access permissions on the key vault can't be granted inline. The backup admin, along with the PostgreSQL and/or key vault admin, needs to ensure that the backup vault's [access on the key vault is granted manually](backup-azure-database-postgresql-overview.md#access-permissions-on-the-key-vault) outside the [configure backup](#configure-a-backup-on-postgresql-databases) flow for the backup operation to succeed.
58+
However, with this option, Azure Backup has no visibility into the key vault that you referenced. Access permissions on the key vault can't be granted inline. For the backup operation to succeed, the backup admin, along with the PostgreSQL and/or key vault admin, needs to ensure that the backup vault's [access on the key vault is granted manually](backup-azure-database-postgresql-overview.md#access-permissions-on-the-key-vault) outside the [configure backup](#configure-a-backup-on-postgresql-databases) flow.
5959

6060
- **Select from key vault**: Use this option if you know the key vault and secret names. Then click **Select a key vault and secret** and enter the details.
6161

@@ -87,7 +87,7 @@ You can configure a backup on multiple databases across multiple Azure Database
8787

8888
:::image type="content" source="./media/backup-azure-database-postgresql/role-assignment-not-done-inline.png" alt-text="Screenshot that shows the error about the role assignment not done." lightbox="./media/backup-azure-database-postgresql/role-assignment-not-done-expanded.png":::
8989

90-
1. Select **Assign missing roles** on the action menu and assign roles. After the process starts, the [missing access permissions](backup-azure-database-postgresql-overview.md#azure-backup-authentication-with-the-postgresql-server) on the key vault and/or the Azure Database for PostgreSQL server are granted to the backup vault. In the **Scope** area, you can define the scope at which the access permissions should be granted. When the action is complete, re-validation starts.
90+
1. Select **Assign missing roles** on the action menu and assign roles. After the process starts, the [missing access permissions](backup-azure-database-postgresql-overview.md#azure-backup-authentication-with-the-postgresql-server) on the key vault and/or the Azure Database for PostgreSQL server are granted to the backup vault. In the **Scope** area, you can define the scope at which the access permissions should be granted. When the action is complete, revalidation starts.
9191

9292
:::image type="content" source="./media/backup-azure-database-postgresql/assign-missing-roles-inline.png" alt-text="Screenshot that shows the button for assigning missing roles." lightbox="./media/backup-azure-database-postgresql/assign-missing-roles-expanded.png":::
9393

@@ -127,34 +127,34 @@ You can create a backup policy during the flow for configuring a backup. Alterna
127127

128128
1. Select **Add retention rule** to define retention settings.
129129

130-
You can add one or more retention rules. Each retention rule assumes inputs for specific backups, along with the data store and retention duration for those backups.
130+
You can add one or more retention rules. Each retention rule assumes inputs for specific backups, along with the datastore and retention duration for those backups.
131131

132-
1. To store your backups in one of the two data stores (or tiers), select **Vault-standard** or **Vault-archive (preview)**.
132+
1. To store your backups in one of the two datastores (or tiers), select **Vault-standard** or **Vault-archive (preview)**.
133133

134-
1. To move the backup to the archive data store upon its expiry in the backup data store, select **On-expiry**.
134+
1. To move the backup to the archive datastore upon its expiry in the backup datastore, select **On-expiry**.
135135

136-
:::image type="content" source="./media/backup-azure-database-postgresql/choose-option-to-move-backup-to-archive-data-store-inline.png" alt-text="Screenshot that shows the selected option to move a backup to the archive data store upon its expiry." lightbox="./media/backup-azure-database-postgresql/choose-option-to-move-backup-to-archive-data-store-expanded.png":::
136+
:::image type="content" source="./media/backup-azure-database-postgresql/choose-option-to-move-backup-to-archive-data-store-inline.png" alt-text="Screenshot that shows the selected option to move a backup to the archive datastore upon its expiry." lightbox="./media/backup-azure-database-postgresql/choose-option-to-move-backup-to-archive-data-store-expanded.png":::
137137

138138
> [!NOTE]
139139
> The **Default** retention rule is applied in the absence of any other retention rule. It has a default value of three months.
140140
>
141-
> In the backup data store, retention duration ranges from seven days to 10 years.
141+
> In the backup datastore, retention duration ranges from seven days to 10 years.
142142
>
143-
> In the archive data store, retention duration ranges from six months to 10 years.
143+
> In the archive datastore, retention duration ranges from six months to 10 years.
144144
145145
1. Select **Add**, and then finish the process of reviewing and creating the policy.
146146

147147
Retention rules are evaluated in a predetermined order of priority. The priority is the highest for the yearly rule, followed by the monthly rule, and then the weekly rule.
148148

149-
Default retention settings apply when no other rules qualify. For example, the same recovery point might be the first successful backup taken every week, along with the first successful backup taken every month. However, because the priority of the monthly rule is higher than that of the weekly rule, the retention that corresponds to the first successful backup taken every month applies.
149+
Default retention settings apply when no other rules qualify. For example, the same recovery point might be the first successful backup taken every week, along with the first successful backup taken every month. However, because the priority of the monthly rule is higher than the priority of the weekly rule, the retention that corresponds to the first successful backup taken every month applies.
150150

151151
## <a name = "create-secrets-in-the-key-vault"></a>Create a secret in the key vault
152152

153153
The secret is the Azure Database for PostgreSQL server connection string in *ADO.NET* format. It's updated with the credentials of the database user who's granted the backup privileges on the server.
154154

155155
:::image type="content" source="./media/backup-azure-database-postgresql/pg-server-connection-string-inline.png" alt-text="Screenshot that shows the Azure Database for PostgreSQL server connection string as a secret." lightbox="./media/backup-azure-database-postgresql/pg-server-connection-string-expanded.png":::
156156

157-
Copy the connection string from the Azure Database for PostgreSQL server, and use a text editor to update the user ID and password.
157+
Copy the connection string from the Azure Database for PostgreSQL server. Use a text editor to update the user ID and password.
158158

159159
:::image type="content" source="./media/backup-azure-database-postgresql/create-secret-inline.png" alt-text="Screenshot that shows the pane for creating a secret and a Notepad file that contains a connection string." lightbox="./media/backup-azure-database-postgresql/create-secret-expanded.png":::
160160

@@ -196,7 +196,7 @@ To trigger a backup that's not in the schedule specified in the policy:
196196

197197
## Track a backup job
198198

199-
The Azure Backup service creates a job for scheduled backups or if you trigger an on-demand backup operation for tracking. To view the backup job status:
199+
The Azure Backup service creates a job for scheduled backups or if you trigger an on-demand backup operation for tracking. To view the backup job's status:
200200

201201
1. Go to the **Backup instances** pane. It shows the **Jobs** dashboard with the operations and statuses for the past seven days.
202202

0 commit comments

Comments
 (0)