Реализация аварийного восстановления с помощью функций резервного копирования и восстановления службы в Azure API Management

Выполните вход в Azure PowerShell.

В примерах ниже сделайте следующее:

• Экземпляр Управления API под названием myapim находится в группе ресурсов apimresourcegroup.
• Учетная запись хранения под названием backupstorageaccount находится в группе ресурсов storageresourcegroup. В учетной записи хранения содержится контейнер под названием backups.
• Будет создан BLOB-объект архивации под названием ContosoBackup.apimbackup.

Определите переменные в PowerShell:

$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

Доступ с помощью управляемого удостоверения

Чтобы настроить управляемое удостоверение в экземпляре Управления API для доступа к учетной записи хранения, см. раздел Настройка управляемого удостоверения Управления API, описанный выше в этой статье.

Доступ с помощью управляемого удостоверения, назначаемого системой

$storageContext = New-AzStorageContext -StorageAccountName $storageAccountName

Backup-AzApiManagement -ResourceGroupName $apiManagementResourceGroup -Name $apiManagementName `
    -StorageContext $storageContext -TargetContainerName $containerName `
    -TargetBlobName $blobName -AccessType "SystemAssignedManagedIdentity"

Доступ с помощью управляемого удостоверения, назначаемого пользователем

В этом примере управляемое удостоверение, назначаемое пользователем, под названием myidentity находится в группе ресурсов identityresourcegroup.

$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

Резервное копирование — это длительная операция, которая может занять несколько минут. В течение этого времени шлюз API продолжает обрабатывать запросы, но состояние службы обновляется.

Войдите с помощью Azure CLI.

В примерах ниже сделайте следующее:

• Экземпляр Управления API под названием myapim находится в группе ресурсов apimresourcegroup.
• Учетная запись хранения под названием backupstorageaccount находится в группе ресурсов storageresourcegroup. В учетной записи хранения содержится контейнер под названием backups.
• Будет создан BLOB-объект архивации под названием ContosoBackup.apimbackup.

Задайте переменные в Bash:

apiManagementName="myapim";
apiManagementResourceGroup="apimresourcegroup";
storageAccountName="backupstorageaccount";
storageResourceGroup="storageresourcegroup";
containerName="backups";
backupName="ContosoBackup.apimbackup";

Доступ с помощью ключа доступа к хранилищу

storageKey=$(az storage account keys list --resource-group $storageResourceGroup --account-name $storageAccountName --query [0].value --output tsv)

az apim backup --resource-group $apiManagementResourceGroup --name $apiManagementName \
    --storage-account-name $storageAccountName --storage-account-key $storageKey --storage-account-container $containerName --backup-name $backupName

Резервное копирование — это длительная операция, которая может занять несколько минут. В течение этого времени шлюз API продолжает обрабатывать запросы, но состояние службы обновляется.

Сведения о проверке подлинности и вызове REST API Azure см. в справочнике по REST API Azure.

Чтобы создать резервную копию службы Управления API, создайте следующий HTTP-запрос:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup?api-version={api-version}

где:

• subscriptionId — идентификатор подписки, содержащей службу управления API, для которой вы пытаетесь выполнить резервное копирование;
• resourceGroupName — имя группы ресурсов службы управления API Azure
• serviceName — имя службы управления API, резервное копирование которой вы выполняете, на момент ее создания;
• api-version— допустимая версия REST API, например 2021-08-01 или 2021-04-01-preview.

В тексте запроса укажите целевую учетную запись хранения, имя контейнера BLOB-объектов, имя резервной копии и тип доступа к хранилищу. Если контейнер хранилища не существует, операция резервного копирования создаст его.

Доступ с помощью ключа доступа к хранилищу

{
    "storageAccount": "{storage account name for the backup}",
    "containerName": "{backup container name}",
    "backupName": "{backup blob name}",
    "accessKey": "{access key for the account}"
}

Доступ с помощью управляемого удостоверения

Доступ с помощью управляемого удостоверения, назначаемого системой

{
    "storageAccount": "{storage account name for the backup}",
    "containerName": "{backup container name}",
    "backupName": "{backup blob name}",
    "accessType": "SystemAssignedManagedIdentity"
}

Доступ с помощью управляемого удостоверения, назначаемого пользователем

{
    "storageAccount": "{storage account name for the backup}",
    "containerName": "{backup container name}",
    "backupName": "{backup blob name}",
    "accessType": "UserAssignedManagedIdentity",
    "clientId": "{client ID of user-assigned identity}"
}

Для заголовка запроса Content-Type установите значение application/json.

Резервное копирование — это длительная операция, которая может занять несколько минут. Если запрос выполнен успешно и запущен процесс резервного копирования, вы получите код состояния ответа 202 Accepted с заголовком Location. Чтобы отслеживать состояние операции, отправляйте запросы GET на URL-адрес, указанный в заголовке Location. Пока резервное копирование выполняется, вы получаете код состояния 202 Accepted. В течение этого времени шлюз API продолжает обрабатывать запросы, но состояние службы обновляется. Код ответа 200 OK указывает на то, что резервное копирование успешно завершено.

В следующих примерах заданы следующие условия:

• Экземпляр Управления API под названием myapim восстановлен из BLOB-объекта архивации ContosoBackup.apimbackup в учетной записи хранения backupstorageaccount.
• BLOB-объект архивации находится в контейнере под названием backups.

Определите переменные в PowerShell:

$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

Restore-AzApiManagement -ResourceGroupName $apiManagementResourceGroup -Name $apiManagementName `
    -StorageContext $storageContext -SourceContainerName $containerName -SourceBlobName $blobName

Доступ с помощью управляемого удостоверения

Чтобы настроить управляемое удостоверение в экземпляре Управления API для доступа к учетной записи хранения, см. раздел Настройка управляемого удостоверения Управления API, описанный выше в этой статье.

Доступ с помощью управляемого удостоверения, назначаемого системой

$storageContext = New-AzStorageContext -StorageAccountName $storageAccountName

Restore-AzApiManagement -ResourceGroupName $apiManagementResourceGroup -Name $apiManagementName `
    -StorageContext $storageContext -SourceContainerName $containerName `
    -SourceBlobName $blobName -AccessType "SystemAssignedManagedIdentity"

Доступ с помощью управляемого удостоверения, назначаемого пользователем

В этом примере управляемое удостоверение, назначаемое пользователем, под названием myidentity находится в группе ресурсов identityresourcegroup.

$identityName = "myidentity";
$identityResourceGroup = "identityresourcegroup";

$identityId = (Get-AzUserAssignedIdentity -Name $identityName -ResourceGroupName $identityResourceGroup).ClientId

$storageContext = New-AzStorageContext -StorageAccountName $storageAccountName

Restore-AzApiManagement -ResourceGroupName $apiManagementResourceGroup -Name $apiManagementName `
    -StorageContext $storageContext -SourceContainerName $containerName `
    -SourceBlobName $blobName -AccessType "UserAssignedManagedIdentity" ` -identityClientId $identityid

Восстановление — это длительная операция, которая может занять более 45 минут.

В следующих примерах заданы следующие условия:

• Экземпляр Управления API под названием myapim восстановлен из BLOB-объекта архивации ContosoBackup.apimbackup в учетной записи хранения backupstorageaccount.
• BLOB-объект архивации находится в контейнере под названием backups.

Задайте переменные в Bash:

apiManagementName="myapim";
apiManagementResourceGroup="apimresourcegroup";
storageAccountName="backupstorageaccount";
storageResourceGroup="storageresourcegroup";
containerName="backups";
backupName="ContosoBackup.apimbackup"

Доступ с помощью ключа доступа к хранилищу

storageKey=$(az storage account keys list --resource-group $storageResourceGroup --account-name $storageAccountName --query [0].value --output tsv)

az apim restore --resource-group $apiManagementResourceGroup --name $apiManagementName \
    --storage-account-name $storageAccountName --storage-account-key $storageKey --storage-account-container $containerName --backup-name $backupName

Восстановление — это длительная операция, которая может занять более 45 минут.

Чтобы восстановить службу управления API из ранее созданной резервной копии, отправьте следующий HTTP-запрос:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/restore?api-version={api-version}

где:

• subscriptionId — идентификатор подписки, включающей в себя службу управления API, которую нужно восстановить из резервной копии;
• resourceGroupName — имя группы ресурсов, включающей в себя службу управления API Azure, в которую нужно восстановить резервную копию;
• serviceName — имя восстанавливаемой службы управления API на момент ее создания;
• api-version — допустимая версия REST API, например 2021-08-01 или 2021-04-01-preview.

В тексте запроса укажите существующую учетную запись хранения, имя контейнера BLOB-объектов, имя резервной копии и тип доступа к хранилищу.

Доступ с помощью ключа доступа к хранилищу

{
    "storageAccount": "{storage account name for the backup}",
    "containerName": "{backup container name}",
    "backupName": "{backup blob name}",
    "accessKey": "{access key for the account}"
}

Доступ с помощью управляемого удостоверения

Доступ с помощью управляемого удостоверения, назначаемого системой

{
    "storageAccount": "{storage account name for the backup}",
    "containerName": "{backup container name}",
    "backupName": "{backup blob name}",
    "accessType": "SystemAssignedManagedIdentity"
}

Доступ с помощью управляемого удостоверения, назначаемого пользователем

{
    "storageAccount": "{storage account name for the backup}",
    "containerName": "{backup container name}",
    "backupName": "{backup blob name}",
    "accessType": "UserAssignedManagedIdentity",
    "clientId": "{client ID of user-assigned identity}"
}

Для заголовка запроса Content-Type установите значение application/json.

Восстановление — это длительная операция, которая может занять до 30 минут и более. Если запрос выполнен успешно и процесс восстановления инициирован, вы получите код состояния ответа 202 Accepted с заголовком Location. Чтобы отслеживать состояние операции, отправляйте запросы GET на URL-адрес, указанный в заголовке Location. Пока восстановление выполняется, вы получаете код состояния 202 Accepted. Код ответа 200 OK указывает на то, что восстановление успешно завершено.