Support matrix for automation in Azure Backup

You can automate most backup related tasks using programmatic methods in Azure Backup. This article provides information about various scenarios that automation clients support and the corresponding document references.

Supported automation methods by operation types

Azure VM

Category	Operation	PowerShell	CLI	REST API	Azure Policy	ARM Template	Bicep	Terraform
Backup	Create backup policy and configure backup	Supported See the examples.	Supported See the examples	Supported See the examples.	Supported See the examples.	Supported See the examples.	Supported See the examples.	Supported See the examples.
Backup	Selective disk backup	Supported See the examples	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	Currently not supported.
Backup	Run on-demand backup	Supported See the examples.	Supported - See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Restore	Restore disks to primary region	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Restore	Cross-region restore	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Restore	Restore selective disks	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Restore	Create a VM from restored disks	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Restore	Restore files	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Manage	Monitor jobs	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Manage	Modify backup policy	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Manage	Stop protection and retain backup data	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Manage	Stop protection and delete backup data	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Manage	Resume protection	Supported See the examples.	Supported See the examples.	Supported See the examples	N/A	N/A	N/A	N/A

SQL in Azure VM

Category	Operation	PowerShell	CLI	REST API	Azure Policy	ARM Template	Bicep	Terraform
Backup	Create backup policy and configure backup	Supported See the examples.	Supported	Supported	Currently not supported	Supported See the examples.	Supported	Currently not supported
Backup	Enable auto-protection	Supported See the examples	Supported	Supported	N/A	N/A	N/A	Currently not supported
Backup	Run on-demand backup	Supported See the examples.	Supported	Supported	N/A	N/A	N/A	Currently not supported
Restore	Restore to a distinct full/differential recovery point	Supported See the examples.	Supported	Supported	N/A	N/A	N/A	N/A
Restore	Restore to a point in time	Supported See the examples.	Supported	Supported	N/A	N/A	N/A	N/A
Restore	Cross-region restore	Supported See the examples.	Supported	Supported	N/A	N/A	N/A	N/A
Manage	Monitor jobs	Supported See the examples.	Supported	Supported	N/A	N/A	N/A	N/A
Manage	Manage Azure Monitor Alerts (preview)	Supported See the examples.	Supported	Supported	N/A	N/A	N/A	N/A
Manage	Manage Azure Monitor Metrics (preview)	Supported See the examples.	Supported	Supported	N/A	N/A	N/A	N/A
Manage	Modify backup policy	Supported See the examples.	Supported	Supported	N/A	N/A	N/A	N/A
Manage	Stop protection and retain backup data	Supported See the examples.	Supported	Supported	N/A	N/A	N/A	N/A
Manage	Stop protection and delete backup data	Supported See the examples.	Supported	Supported	N/A	N/A	N/A	N/A
Manage	Unregister instance	Supported See the examples.	Supported	Supported	N/A	N/A	N/A	N/A
Manage	Re-register instance	Supported See the examples.	Supported	Supported	N/A	N/A	N/A	N/A

SAP HANA in Azure VM

Category	Operation	PowerShell	CLI	REST API	Azure Policy	ARM Template	Bicep	Terraform
Backup	Create backup policy and configure backup	Currently not supported	Supported See the examples.	Supported	Currently not supported	N/A	Supported	Currently not supported
Backup	Run on-demand backup	Currently not supported	Supported See the examples.	Supported	N/A	Supported – Examples See the examples.	N/A	Currently not supported
Restore	Restore to a distinct full/ differential/ incremental recovery point	Currently not supported	Supported See the examples.	Supported	N/A	N/A	N/A	N/A
Restore	Restore to a point in time	Currently not supported	Supported See the examples.	Supported	N/A	N/A	N/A	N/A
Restore	Cross-region restore	Currently not supported	Supported	Supported	N/A	N/A	N/A	N/A
Manage	Monitor jobs	Currently not supported	Supported	Supported	N/A	N/A	N/A	N/A
Manage	Modify backup policy	Currently not supported	Supported See the examples.	Supported	N/A	N/A	N/A	Currently not supported
Manage	Stop protection and retain backup data	Currently not supported	Supported See the examples	Supported See the examples.	N/A	N/A	N/A	N/A
Manage	Stop protection and delete backup data	Currently not supported	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Manage	Unregister instance	Currently not supported	Supported	Supported	N/A	N/A	N/A	N/A
Manage	Re-register instance	Currently not supported	Supported	Supported	N/A	N/A	N/A	N/A

Azure Files

Category	Operation	PowerShell	CLI	REST API	Azure Policy	ARM Template	Bicep	Terraform
Backup	Create backup policy and configure backup	Supported See the examples.	Supported See the examples.	Supported See the examples.	Currently not supported	Supported See the examples.	Supported	Supported See the examples.
Backup	Run on-demand backup	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Restore	Restore to original or alternate location	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Manage	Monitor jobs	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Manage	Modify backup policy	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Manage	Stop protection and retain backup data	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Manage	Stop protection and delete backup data	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A

Azure Blobs

Category	Operation	PowerShell	CLI	REST API	Azure Policy	ARM Template	Bicep	Terraform
Backup	Create backup policy and configure backup	Supported See the examples.	Supported See the examples.	Supported See the examples.	Currently not supported	Supported	Supported See the examples.	Supported See the examples.
Restore	Restore blobs	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Manage	Monitor jobs	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Manage	Modify backup policy	Currently not supported	Currently not supported	Currently not supported	N/A	N/A	N/A	N/A
Manage	Stop protection and retain backup data	Currently not supported	Currently not supported	Currently not supported	N/A	N/A	N/A	N/A
Manage	Stop protection and delete backup data	Supported	Supported	Supported	N/A	N/A	N/A	N/A
Manage	Resume protection	Currently not supported	Currently not supported	Currently not supported	N/A	N/A	N/A	N/A

Azure Disks

Category	Operation	PowerShell	CLI	REST API	Azure Policy	ARM Template	Bicep	Terraform
Backup	Create backup policy and configure backup	Supported See the examples.	Supported See the examples.	Supported See the examples.	Currently not supported	Supported	Supported See the examples.	Supported See the examples.
Backup	Run on-demand backup	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A	N/A
Restore	Restore to new disk	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Manage	Monitor jobs	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Manage	Modify backup policy	Currently not supported	Currently not supported	Currently not supported	N/A	N/A	N/A	N/A
Manage	Stop protection and retain backup data	Supported	Supported	Supported	N/A	N/A	N/A	N/A
Manage	Stop protection and delete backup data	Supported	Supported	Supported	N/A	N/A	N/A	N/A
Manage	Resume protection	Supported	Supported	Supported	N/A	N/A	N/A	N/A

Azure Database for PostgreSQL Server

Category	Operation	PowerShell	CLI	REST API	Azure Policy	ARM Template	Bicep	Terraform
Backup	Create backup policy and configure backup	Supported See the examples.	Supported See the examples.	Supported See the examples.	Currently not here	Supported	Supported	Supported See the examples.
Backup	Run on-demand backup	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	N/A	N/A	N/A
Restore	Restore database on target storage account	Supported See the examples.	Supported See the examples.	Supported See the examples	N/A	N/A	N/A	N/A
Manage	Modify backup policy	Supported	Supported	Supported	N/A	N/A	N/A	N/A
Manage	Stop protection and delete data	Supported	Supported	Supported	N/A	N/A	N/A	N/A
Manage	Stop protection and retain data	Supported	Supported	Supported	N/A	N/A	N/A	N/A
Manage	Resume protection	Supported	Supported	Supported	N/A	N/A	N/A	N/A

Vault-level configurations

Category	Operation	PowerShell	CLI	REST API	Azure Policy	ARM Template
Manage	Create Recovery Services vault	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	Supported See the examples.
Manage	Create Backup vault	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	Supported
Manage	Move Recovery Services vault	Supported See the examples.	Supported See the examples.	Supported	N/A	N/A
Manage	Move Backup vault	Supported	Supported	Supported	N/A	N/A
Manage	Delete Recovery Services vault	Supported See the examples.	Supported See the examples.	Supported See the examples.	N/A	N/A
Manage	Delete Backup vault	Supported	Here	Here	N/A	N/A
Manage	Configure diagnostics settings	Supported	Supported	Supported	Supported See the examples.	Supported
Manage	Manage Azure Monitor Alerts (preview)	Supported	Supported	Supported	N/A	N/A
Manage	Manage Azure Monitor Metrics (preview)	Supported	Supported	Supported	N/A	N/A
Security	Enable private endpoints for Recovery Services vault	Supported	Supported	Supported	Only audit policy supported currently	Supported
Security	Enable customer-managed keys for Recovery Services vault.	Supported	Supported	Supported	Only audit policy supported currently	Supported
Security	Enable soft-delete for Recovery Services vault	Supported	Supported	Supported	Currently not supported	Supported
Resiliency	Enable cross region restore for Recovery Services vault	Supported	Supported	Supported	Currently not supported	Supported

Next steps

Automation in Azure Backup