Skip to content

Commit ce5304c

Browse files
committed
azure-database-for-postgresql-backup
2 parents fe060ee + 2f9ca14 commit ce5304c

9 files changed

+44
-44
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ For information on the supported scenarios, limitations, and authentication mech
1717

1818
## Prerequisites
1919

20-
- [Create a backup vault](backup-azure-dataprotection-use-rest-api-create-update-backup-vault.md)
20+
- [Create a Backup vault](backup-azure-dataprotection-use-rest-api-create-update-backup-vault.md)
2121
- [Create a PostgreSQL backup policy](backup-azure-data-protection-use-rest-api-create-update-postgresql-policy.md)
2222

2323
## Configure backup
@@ -46,9 +46,9 @@ 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, the backup vault 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

51-
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).
51+
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

5353
### Prepare the request
5454

@@ -291,7 +291,7 @@ GET https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
291291

292292
### Configure a backup request
293293

294-
After the request is validated, you can submit the request to the [Create Backup Instance API](/rest/api/dataprotection/backup-instances/create-or-update). One of the Azure Backup data protection services helps protect the backup instance within the backup vault. Here, the PostgreSQL database is the backup instance. Use the previously validated request body with minor additions.
294+
After the request is validated, you can submit the request to the [Create Backup Instance API](/rest/api/dataprotection/backup-instances/create-or-update). One of the Azure Backup data protection services helps protect the backup instance within the Backup vault. Here, the PostgreSQL database is the backup instance. Use the previously validated request body with minor additions.
295295

296296
Use a unique name for the backup instance. We recommend that you use a combination of the resource name and a unique identifier. For example, the following operation uses `testpostgresql-empdb11-957d23b1-c679-4c94-ade6-c4d34635e149` and marks it as the name of the backup instance.
297297

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 backup policy, use the following `PUT` operation:
62+
To create a 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
@@ -147,7 +147,7 @@ The policy says:
147147
```
148148

149149
> [!IMPORTANT]
150-
> The time formats support only `DateTime`. `Time` is not supported. The time of the day indicates the backup start time, not the finish time.
150+
> The time formats support only `DateTime`. `Time` is not supported. The time of the day indicates the backup start time, not the end time.
151151
152152
Let's update the preceding JSON with two changes:
153153

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: What Is Azure Database for PostgreSQL Backup?
2+
title: Overview of Azure Database for PostgreSQL Backup
33
description: Get an overview of the Azure Database for PostgreSQL backup solution.
44
ms.topic: overview
55
ms.date: 03/18/2025

articles/backup/backup-postgresql-cli.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
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.
3+
description: Learn how to back up PostgreSQL databases in Azure Virtual Machines by using the Azure CLI.
44
ms.topic: how-to
55
ms.date: 03/18/2025
66
ms.custom: devx-track-azurecli
@@ -11,17 +11,17 @@ ms.author: jsuri
1111

1212
# Back up PostgreSQL databases by using the Azure CLI
1313

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.
14+
This article describes how to back up PostgreSQL databases in [Azure Virtual Machines](/azure/postgresql/overview#azure-database-for-postgresql---single-server) by using the Azure CLI.
1515

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) for backing up PostgreSQL databases in Azure Database for PostgreSQL.
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) for backing up Azure Database for PostgreSQL.
1717

18-
## Create a backup vault
18+
## Create a Backup vault
1919

20-
A backup vault is a storage entity in Azure. It stores the backup data for new workloads that Azure Backup supports, such as Azure Database for PostgreSQL servers, blobs in a storage account, and Azure disks. Backup vaults help to organize your backup data, while minimizing management overhead. Backup vaults are based on the Azure Resource Manager model of Azure, which provides enhanced capabilities to help secure backup data.
20+
A Backup vault is a storage entity in Azure. It stores the backup data for new workloads that Azure Backup supports, such as Azure Database for PostgreSQL servers, blobs in a storage account, and Azure disks. Backup vaults help to organize your backup data, while minimizing management overhead. Backup vaults are based on the Azure Resource Manager model of Azure, which provides enhanced capabilities to help secure backup data.
2121

22-
Before you create a backup vault, choose the storage redundancy of the data within the vault. Then proceed to create the backup vault with that storage redundancy and the location.
22+
Before you create a Backup vault, choose the storage redundancy of the data within the vault. Then proceed to create the Backup vault with that storage redundancy and the location.
2323

24-
In this article, you create a backup vault names `TestBkpVault`, in the `westus` region, under the resource group `testBkpVaultRG`. Use the [`az dataprotection vault create`](/cli/azure/dataprotection/backup-vault#az-dataprotection-backup-vault-create) command to create a backup vault. [Learn more about creating a backup vault](./create-manage-backup-vault.md#create-a-backup-vault).
24+
In this article, you create a Backup vault with the name `TestBkpVault`, in the `westus` region, under the resource group `testBkpVaultRG`. Use the [`az dataprotection vault create`](/cli/azure/dataprotection/backup-vault#az-dataprotection-backup-vault-create) command to create a Backup vault. [Learn more about creating a Backup vault](./create-manage-backup-vault.md#create-a-backup-vault).
2525

2626
```azurecli-interactive
2727
az dataprotection backup-vault create -g testBkpVaultRG --vault-name TestBkpVault -l westus --type SystemAssigned --storage-settings datastore-type="VaultStore" type="LocallyRedundant"
@@ -293,9 +293,9 @@ keyURI="https://testkeyvaulteus.vault.azure.net/secrets/ossdbkey"
293293

294294
#### Backup vault
295295

296-
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.
296+
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.
297297

298-
[Read about the permissions](./backup-azure-database-postgresql-overview.md#permissions-needed-for-postgresql-database-backup) that you should grant to the backup vault's managed identity on the PostgreSQL server and the key vault that stores the keys to the database.
298+
[Read about the permissions](./backup-azure-database-postgresql-overview.md#permissions-needed-for-postgresql-database-backup) that you should grant to the Backup vault's managed identity on the PostgreSQL server and the key vault that stores the keys to the database.
299299

300300
### Prepare the request
301301

@@ -435,7 +435,7 @@ az dataprotection backup-instance adhoc-backup --name "ossrg-empdb11" --rule-nam
435435

436436
Track all jobs by using the [`az dataprotection job list`](/cli/azure/dataprotection/job#az-dataprotection-job-list) command. You can list all jobs and fetch a particular job detail.
437437

438-
You can also use `Az.ResourceGraph` to track all jobs across all backup vaults. Use the [`az dataprotection job list-from-resourcegraph`](/cli/azure/dataprotection/job#az-dataprotection-job-list-from-resourcegraph) command to fetch the relevant jobs across backup vaults:
438+
You can also use `Az.ResourceGraph` to track all jobs across all Backup vaults. Use the [`az dataprotection job list-from-resourcegraph`](/cli/azure/dataprotection/job#az-dataprotection-job-list-from-resourcegraph) command to fetch the relevant jobs across Backup vaults:
439439

440440
```azurecli
441441
az dataprotection job list-from-resourcegraph --datasource-type AzureDatabaseForPostgreSQL --status Completed

articles/backup/backup-postgresql-ps.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Back Up PostgreSQL Databases by Using Azure PowerShell
3-
description: Learn how to back up databases in Azure Database for PostgreSQL by using Azure PowerShell.
3+
description: Learn how to back up Azure Database for PostgreSQL by using Azure PowerShell.
44
ms.topic: how-to
55
ms.date: 03/18/2025
66
ms.custom: devx-track-azurepowershell
@@ -11,17 +11,17 @@ ms.author: jsuri
1111

1212
# Back up PostgreSQL databases by using Azure PowerShell
1313

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 Azure PowerShell.
14+
This article describes how to back up [Azure Database for PostgreSQL](/azure/postgresql/overview#azure-database-for-postgresql---single-server) by using Azure PowerShell.
1515

1616
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) for backing up PostgreSQL databases in Azure Database for PostgreSQL.
1717

18-
## Create a backup vault
18+
## Create a Backup vault
1919

20-
A backup vault is a storage entity in Azure. It stores the backup data for various new workloads that Azure Backup supports, such as Azure Database for PostgreSQL servers, Azure disks, and Azure blobs. Backup vaults help to organize your backup data, while minimizing management overhead. Backup vaults are based on the Azure Resource Manager model of Azure, which provides enhanced capabilities to help secure backup data.
20+
A Backup vault is a storage entity in Azure. It stores the backup data for various new workloads that Azure Backup supports, such as Azure Database for PostgreSQL servers, Azure disks, and Azure blobs. Backup vaults help to organize your backup data, while minimizing management overhead. Backup vaults are based on the Azure Resource Manager model of Azure, which provides enhanced capabilities to help secure backup data.
2121

22-
Before you create a backup vault, choose the storage redundancy of the data within the vault. Then proceed to create the backup vault with that storage redundancy and the location.
22+
Before you create a Backup vault, choose the storage redundancy of the data within the vault. Then proceed to create the Backup vault with that storage redundancy and the location.
2323

24-
In this article, you create a backup vault named `TestBkpVault`, in the `westus` region, under the resource group `testBkpVaultRG`. Use the [`New-AzDataProtectionBackupVault`](/powershell/module/az.dataprotection/new-azdataprotectionbackupvault) command to create a backup vault. [Learn more about creating a backup vault](./create-manage-backup-vault.md#create-a-backup-vault).
24+
In this article, you create a Backup vault named `TestBkpVault`, in the `westus` region, under the resource group `testBkpVaultRG`. Use the [`New-AzDataProtectionBackupVault`](/powershell/module/az.dataprotection/new-azdataprotectionbackupvault) command to create a Backup vault. [Learn more about creating a Backup vault](./create-manage-backup-vault.md#create-a-backup-vault).
2525

2626
```azurepowershell-interactive
2727
$storageSetting = New-AzDataProtectionBackupVaultStorageSettingObject -Type LocallyRedundant/GeoRedundant -DataStoreType VaultStore
@@ -236,9 +236,9 @@ $keyURI = "https://testkeyvaulteus.vault.azure.net/secrets/ossdbkey"
236236

237237
#### Backup vault
238238

239-
You need to connect the backup vault 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.
239+
You need to connect the Backup vault 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.
240240

241-
[Read about the appropriate permissions](./backup-azure-database-postgresql-overview.md#permissions-needed-for-postgresql-database-backup) that you should grant to the backup vault's managed identity on the PostgreSQL server and Azure Key Vault, where the keys to the database are stored.
241+
[Read about the appropriate permissions](./backup-azure-database-postgresql-overview.md#permissions-needed-for-postgresql-database-backup) that you should grant to the Backup vault's managed identity on the PostgreSQL server and Azure Key Vault, where the keys to the database are stored.
242242

243243
### Prepare the request
244244

@@ -297,7 +297,7 @@ Backup-AzDataProtectionBackupInstanceAdhoc -BackupInstanceName $AllInstances[0].
297297

298298
Track all jobs by using the [`Get-AzDataProtectionJob`](/powershell/module/az.dataprotection/get-azdataprotectionjob) command. You can list all jobs and fetch a particular job detail.
299299

300-
You can also use `Az.ResourceGraph` to track all jobs across all backup vaults. Use the [`Search-AzDataProtectionJobInAzGraph`](/powershell/module/az.dataprotection/search-azdataprotectionjobinazgraph) command to fetch the relevant jobs across any backup vault:
300+
You can also use `Az.ResourceGraph` to track all jobs across all Backup vaults. Use the [`Search-AzDataProtectionJobInAzGraph`](/powershell/module/az.dataprotection/search-azdataprotectionjobinazgraph) command to fetch the relevant jobs across any Backup vault:
301301

302302
```azurepowershell-interactive
303303
$job = Search-AzDataProtectionJobInAzGraph -Subscription $sub -ResourceGroupName "testBkpVaultRG" -Vault $TestBkpVault.Name -DatasourceType AzureDisk -Operation OnDemandBackup

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,11 @@ You can restore a database to any Azure Database for PostgreSQL server of a diff
6363

6464
## Restore permissions on the target storage account
6565

66-
Give the backup vault's managed identity permission to access the storage account containers:
66+
To assign the Backup vault's managed identity permission to access the storage account containers, follow these steps:
6767

6868
1. In the Azure portal, go to **Storage Account** > **Access Control (IAM)**, and then select **Add**.
6969

70-
1. On the **Add role assignment** pane, in the **Role** dropdown list, select the **Storage Blob Data Contributor** role for the backup vault's managed identity.
70+
1. On the **Add role assignment** pane, in the **Role** dropdown list, select the **Storage Blob Data Contributor** role for the Backup vault's managed identity.
7171

7272
:::image type="content" source="./media/restore-azure-database-postgresql/assign-vault-msi-permission-to-access-storage-account-containers-azure-portal-inline.png" alt-text="Screenshot that shows selections for adding a role assignment in the Azure portal." lightbox="./media/restore-azure-database-postgresql/assign-vault-msi-permission-to-access-storage-account-containers-azure-portal-expanded.png":::
7373

@@ -79,7 +79,7 @@ az role assignment create --assignee $VaultMSI_AppId --role "Storage Blob Data
7979

8080
Replace the `assignee` parameter's value with the application ID of the vault's managed identity. For the value of the `scope` parameter, refer to your specific container. To get the application ID of the vault's managed identity, select **All applications** under **Application type**. Search for the vault name and copy the **Application ID** value.
8181

82-
:::image type="content" source="./media/restore-azure-database-postgresql/select-application-type-for-id-inline.png" alt-text="Screenshot that shows selections to get the application ID of a backup vault's managed service identity." lightbox="./media/restore-azure-database-postgresql/select-application-type-for-id-expanded.png":::
82+
:::image type="content" source="./media/restore-azure-database-postgresql/select-application-type-for-id-inline.png" alt-text="Screenshot that shows selections to get the application ID of a Backup vault's managed service identity." lightbox="./media/restore-azure-database-postgresql/select-application-type-for-id-expanded.png":::
8383

8484
:::image type="content" source="./media/restore-azure-database-postgresql/copy-vault-id-inline.png" alt-text="Screenshot that shows the process to copy the application ID of the vault." lightbox="./media/restore-azure-database-postgresql/copy-vault-id-expanded.png":::
8585

0 commit comments

Comments
 (0)