Document Details
Api Management Howto Disaster Recovery Backup Restore
❌
This page contains Windows bias
About This Page
This page is part of the Azure documentation. It contains code examples and configuration instructions for working with Azure services.
Bias Analysis
Bias Types:
⚠️
powershell_heavy
⚠️
windows_first
Summary:
The documentation demonstrates a moderate Windows bias by prioritizing PowerShell examples and instructions before CLI (Bash) and REST alternatives. PowerShell is a Windows-centric tool, and its prominence may disadvantage Linux or cross-platform users. However, the inclusion of Azure CLI (Bash) and REST API examples does provide Linux parity, though these are consistently presented after PowerShell, reinforcing a 'Windows-first' pattern.
Recommendations:
- Present Azure CLI (Bash) examples before or alongside PowerShell examples to better serve Linux and cross-platform users.
- Explicitly state that Azure CLI commands are cross-platform and can be used on Windows, Linux, and macOS.
- Where possible, provide examples in a neutral scripting language (such as Bash or Python) or clarify that PowerShell Core is available cross-platform.
- Review and balance the order of example tabs so that no single OS is consistently prioritized.
- Add a brief section or note highlighting tool availability and parity across platforms.
Create pull request
Scan History
| Date | Scan ID | Status | Bias Status |
|---|---|---|---|
| 2025-09-14 00:00 | #111 | completed | ❌ Biased |
| 2025-08-14 00:01 | #80 | in_progress | ❌ Biased |
| 2025-07-13 21:25 | #47 | cancelled | ❌ Biased |
| 2025-07-13 20:48 | #44 | cancelled | ❌ Biased |
| 2025-07-09 13:09 | #3 | cancelled | ✅ Clean |
| 2025-07-08 04:23 | #2 | cancelled | ❌ Biased |
Flagged Code Snippets
$apiManagementName="myapim";
$apiManagementResourceGroup="apimresourcegroup";
$storageAccountName="backupstorageaccount";
$storageResourceGroup="storageresourcegroup";
$containerName="backups";
$blobName="ContosoBackup.apimbackup"
$storageKey = (Get-AzStorageAccountKey -ResourceGroupName $storageResourceGroup -StorageAccountName $storageAccountName)[0].Value
$storageContext = New-AzStorageContext -StorageAccountName $storageAccountName -StorageAccountKey $storageKey
Backup-AzApiManagement -ResourceGroupName $apiManagementResourceGroup -Name $apiManagementName `
-StorageContext $storageContext -TargetContainerName $containerName -TargetBlobName $blobName
$storageContext = New-AzStorageContext -StorageAccountName $storageAccountName
Backup-AzApiManagement -ResourceGroupName $apiManagementResourceGroup -Name $apiManagementName `
-StorageContext $storageContext -TargetContainerName $containerName `
-TargetBlobName $blobName -AccessType "SystemAssignedManagedIdentity"
$identityName = "myidentity";
$identityResourceGroup = "identityresourcegroup";
$identityId = (Get-AzUserAssignedIdentity -Name $identityName -ResourceGroupName $identityResourceGroup).ClientId
$storageContext = New-AzStorageContext -StorageAccountName $storageAccountName
Backup-AzApiManagement -ResourceGroupName $apiManagementResourceGroup -Name $apiManagementName `
-StorageContext $storageContext -TargetContainerName $containerName `
-TargetBlobName $blobName -AccessType "UserAssignedManagedIdentity" ` -identityClientId $identityid
Set the value of the `Content-Type` request header to `application/json`.
Backup is a long-running operation that may take several minutes to complete. If the request succeeded and the backup process began, you receive a `202 Accepted` response status code with a `Location` header. Make `GET` requests to the URL in the `Location` header to find out the status of the operation. While the backup is in progress, you continue to receive a `202 Accepted` status code. During this time the API gateway continues to handle requests, but the state of the service is Updating. A Response code of `200 OK` indicates successful completion of the backup operation.
---
## Restore an API Management service
> [!CAUTION]
> Avoid changes to the service configuration (for example, APIs, policies, developer portal appearance) while restore operation is in progress. Changes **could be overwritten**.
### [PowerShell](#tab/powershell)
In the following examples,
* An API Management instance named *myapim* is restored from the backup blob named *ContosoBackup.apimbackup* in storage account *backupstorageaccount*.
* The backup blob is in a container named *backups*.
Set variables in PowerShell: