az backup

Manage Azure Backups.

Commands

Name Description Type Status
az backup container

Resource which houses items or applications to be protected.

Core GA
az backup container list

List containers registered to a Recovery services vault.

Core GA
az backup container re-register

Reset the registration details for a given container.

Core GA
az backup container register

Register a Resource to the given Recovery Services Vault.

Core GA
az backup container show

Show details of a container registered to a Recovery services vault.

Core GA
az backup container unregister

Unregister a Backup Container to make the underlying 'resource' be protected by another vault.

Core GA
az backup item

An item which is already protected or backed up to an Azure Recovery services vault with an associated policy.

Core GA
az backup item list

List all backed up items within a container.

Core GA
az backup item set-policy

Update the policy associated with this item. Use this to change policies of the backup item.

Core GA
az backup item show

Show details of a particular backed up item.

Core GA
az backup job

Entity which contains details of the job.

Core GA
az backup job list

List all backup jobs of a Recovery Services vault.

Core GA
az backup job show

Show details of a particular job.

Core GA
az backup job stop

Suspend or terminate a currently running job.

Core GA
az backup job wait

Wait until either the job completes or the specified timeout value is reached.

Core GA
az backup policy

A backup policy defines when you want to take a backup and for how long you would retain each backup copy.

Core GA
az backup policy create

Create a new policy for the given BackupManagementType and workloadType.

Core GA
az backup policy delete

Delete a backup policy which doesn't have any associated backup items.

Core GA
az backup policy get-default-for-vm

Get the default policy with default values to backup a VM.

Core GA
az backup policy list

List all policies for a Recovery services vault.

Core GA
az backup policy list-associated-items

List all items protected by a backup policy.

Core GA
az backup policy set

Update the existing policy with the provided details.

Core GA
az backup policy show

Show details of a particular policy.

Core GA
az backup protectable-item

Manage the item which is yet to be protected or backed up to an Azure Recovery services vault with an associated policy.

Core GA
az backup protectable-item initialize

Trigger the discovery of any unprotected items of the given workload type in the given container.

Core GA
az backup protectable-item list

Retrieve all protectable items within a certain container or across all registered containers.

Core GA
az backup protectable-item show

Retrieve the specified protectable item within the given container.

Core GA
az backup protection

Manage protection of your items, enable protection or disable it, or take on-demand backups.

Core GA
az backup protection auto-disable-for-azurewl

Disable auto-protection for the specified protectable item.

Core GA
az backup protection auto-enable-for-azurewl

Automatically protect all existing unprotected DBs and any DB which will be added later with the given policy.

Core GA
az backup protection backup-now

Perform an on-demand backup of a backed up item.

Core GA
az backup protection check-vm

The command returns null/empty if the specified resource is not protected under any Recovery Services vault in the subscription. When configuring backup fails, it may return vault details. If Azure Backup is failing, then look for the corresponding error code in the Common issues section - https://learn.microsoft.com/en-us/azure/backup/backup-azure-vms-troubleshoot#common-issues. If it is protected, the relevant vault details will be returned.

Core GA
az backup protection disable

Stop protecting a backed up item. Can retain the backed up data forever or choose to delete it.

Core GA
az backup protection enable-for-azurefileshare

Start protecting a previously unprotected Azure File share within an Azure Storage account as per the specified policy to a Recovery services vault.

Core GA
az backup protection enable-for-azurewl

Start protecting a previously unprotected workload within an Azure VM as per the specified policy to a Recovery services vault. Provide the workload details as a protectable item.

Core GA
az backup protection enable-for-vm

Start protecting a previously unprotected Azure VM as per the specified policy to a Recovery services vault.

Core GA
az backup protection resume

Resume backup for the associated backup item. Use this to change the policy associated with the backup item.

Core GA
az backup protection undelete

Rehydrate an item from softdeleted state to stop protection with retained data state.

Core GA
az backup protection update-for-vm

Update disk exclusion settings associated with a backed up VM item.

Core GA
az backup recoveryconfig

Manage recovery configuration of an Azure workload backed up item.

Core GA
az backup recoveryconfig show

Construct the recovery configuration of an Azure workload backed up item.

Core GA
az backup recoverypoint

A snapshot of data at that point-of-time, stored in Recovery Services Vault, from which you can restore information.

Core GA
az backup recoverypoint list

List all recovery points of a backed up item.

Core GA
az backup recoverypoint move

Move a particular recovery point of a backed up item from one tier to another tier.

Core GA
az backup recoverypoint show

Shows details of a particular recovery point.

Core GA
az backup recoverypoint show-log-chain

List the start and end points of the unbroken log chain(s) of the given backup item.

Core GA
az backup restore

Restore backed up items from recovery points in a Recovery Services vault.

Core GA
az backup restore files

Gives access to all files of a recovery point.

Core GA
az backup restore files mount-rp

Download a script which mounts files of a recovery point.

Core GA
az backup restore files unmount-rp

Close access to the recovery point.

Core GA
az backup restore restore-azurefiles

Restore backed up Azure files within a file-share to the same file-share or another file-share in registered storage accounts.

Core GA
az backup restore restore-azurefileshare

Restore backed up Azure file shares to the same file-share or another file-share in registered storage accounts.

Core GA
az backup restore restore-azurewl

Restore backed up Azure Workloads in a Recovery services vault to another registered container or to the same container.

Core GA
az backup restore restore-disks

Restore disks of the backed VM from the specified recovery point.

Core GA
az backup vault

Online storage entity in Azure used to hold data such as backup copies, recovery points and backup policies.

Core GA
az backup vault backup-properties

Properties of the Recovery Services vault.

Core GA
az backup vault backup-properties set

Sets backup related properties of the Recovery Services vault.

Core GA
az backup vault backup-properties show

Gets backup related properties of the Recovery Services vault.

Core GA
az backup vault create

Create a new Recovery Services vault or update an existing one.

Core GA
az backup vault delete

Delete an existing Recovery services vault.

Core GA
az backup vault encryption

Encryption details of a Recovery Services Vault.

Core GA
az backup vault encryption show

Show details of encryption properties of a Recovery Services Vault.

Core GA
az backup vault encryption update

Update encryption properties of a Recovery Services Vault.

Core GA
az backup vault identity

Identity details of a Recovery Services Vault.

Core GA
az backup vault identity assign

Assign Identities to Recovery Services vault.

Core GA
az backup vault identity remove

Remove Identities of Recovery Services vault.

Core GA
az backup vault identity show

Show Identities of Recovery Services vault.

Core GA
az backup vault list

List Recovery service vaults within a subscription.

Core GA
az backup vault list-soft-deleted-containers

List soft-deleted containers within a particular Recovery Services vault.

Core GA
az backup vault resource-guard-mapping

Resource Guard Mapping details of the Recovery Services vault.

Core GA
az backup vault resource-guard-mapping delete

Delete resource guard mapping of the Recovery Services vault.

Core GA
az backup vault resource-guard-mapping show

Get resource guard mapping of the Recovery Services vault.

Core GA
az backup vault resource-guard-mapping update

Create/Update resource guard mapping of the Recovery Services vault.

Core GA
az backup vault show

Show details of a particular Recovery service vault.

Core GA
az backup vault update

Update an existing Recovery Services vault.

Core GA