Az.RecoveryServices

This topic displays help topics for the Azure Recovery Services cmdlets.

Recovery Services

Add-AzRecoveryServicesAsrReplicationProtectedItemDisk

Add the disk for protection for already protected azure virtual machine.

Backup-AzRecoveryServicesBackupItem

Starts a backup for a Backup item.

Disable-AzRecoveryServicesBackupAutoProtection

Disables auto backup for a protectable item.

Disable-AzRecoveryServicesBackupProtection

Disables protection for a Backup-protected item.

Disable-AzRecoveryServicesBackupRPMountScript

Dismounts all the files of the recovery point.

Edit-AzRecoveryServicesAsrRecoveryPlan

Edits a Site Recovery plan.

Enable-AzRecoveryServicesBackupAutoProtection

This commands allows users to automatically protect all existing unprotected DBs and any DB which will be added later with the given policy. Azure backup service will then regularly scan auto-protected containers for any new DBs and automatically protect them.

Enable-AzRecoveryServicesBackupProtection

Enables backup for an item with a specified Backup protection policy.

Get-AzRecoveryServicesAsrAlertSetting

Gets the configured Azure Site Recovery notification settings for the vault.

Get-AzRecoveryServicesAsrEvent

Gets details of Azure Site Recovery events in the vault.

Get-AzRecoveryServicesAsrFabric

Get the details of an Azure Site Recovery Fabric.

Get-AzRecoveryServicesAsrJob

Gets the details of the specified ASR job or the list of recent ASR jobs in the Recovery Services vault.

Get-AzRecoveryServicesAsrNetwork

Gets information about the networks managed by Site Recovery for the current vault.

Get-AzRecoveryServicesAsrNetworkMapping

Gets information about Site Recovery network mappings for the current vault.

Get-AzRecoveryServicesAsrPolicy

Gets ASR replication policies.

Get-AzRecoveryServicesAsrProtectableItem

Get the protectable items in an ASR protection container.

Get-AzRecoveryServicesAsrProtectionContainer

Gets ASR protection containers in the Recovery Services vault.

Get-AzRecoveryServicesAsrProtectionContainerMapping

Gets Azure Site Recovery Protection Container mappings.

Get-AzRecoveryServicesAsrRecoveryPlan

Gets a recovery plan or all the recovery plans in the Recovery Services vault

Get-AzRecoveryServicesAsrRecoveryPoint

Gets the available recovery points for a replication protected item.

Get-AzRecoveryServicesAsrReplicationProtectedItem

Gets the properties of an Azure Site Recovery Replication Protected Items.

Get-AzRecoveryServicesAsrServicesProvider

Gets the details of the ASR recovery services providers registered to the Recovery Services vault.

Get-AzRecoveryServicesAsrStorageClassification

Gets the available(discovered) ASR storage classifications in the Recovery Services vault.

Get-AzRecoveryServicesAsrStorageClassificationMapping

Gets ASR storage classification mappings.

Get-AzRecoveryServicesAsrVaultContext

Gets ASR vault settings information for the Recovery Services vault.

Get-AzRecoveryServicesAsrvCenter

Gets details of the vCenter servers registered for discovery on the Configuration server specified by the ASR fabric.

Get-AzRecoveryServicesBackupContainer

Gets Backup containers.

Get-AzRecoveryServicesBackupItem

Gets the items from a container in Backup.

Get-AzRecoveryServicesBackupJob

Gets Backup jobs.

Get-AzRecoveryServicesBackupJobDetail

Gets details for a Backup job.

Get-AzRecoveryServicesBackupManagementServer

Gets SCDPM and Azure Backup management servers.

Get-AzRecoveryServicesBackupProperty

Gets Backup properties.

Get-AzRecoveryServicesBackupProtectableItem

This command will retrieve all protectable items within a certain container or across all registered containers. It will consist of all the elements of the hierarchy of the application. Returns DBs and their upper tier entities like Instance, AvailabilityGroup etc.

Get-AzRecoveryServicesBackupProtectionPolicy

Gets Backup protection policies for a vault.

Get-AzRecoveryServicesBackupRPMountScript

Downloads a script to mount all the files of the recovery point.

Get-AzRecoveryServicesBackupRecoveryLogChain

This command lists the start and end points of the unbroken log chain of the given backup item. Use it to determine whether the point-in-time, to which the user wants the DB to be restored, is valid or not.

Get-AzRecoveryServicesBackupRecoveryPoint

Gets the recovery points for a backed up item.

Get-AzRecoveryServicesBackupRetentionPolicyObject

Gets a base retention policy object.

Get-AzRecoveryServicesBackupSchedulePolicyObject

Gets a base schedule policy object.

Get-AzRecoveryServicesBackupStatus

Checks whether your ARM resource is backed up or not.

Get-AzRecoveryServicesBackupWorkloadRecoveryConfig

This command constructs the recovery configuration of a backed up item such as SQL DB. The configuration object stores all details such as the recovery mode, target destinations for the restore and application specific parameters like target physical paths for SQL.

Get-AzRecoveryServicesVault

Gets a list of Recovery Services vaults.

Get-AzRecoveryServicesVaultSettingsFile

Gets the Azure Site Recovery vault settings file.

Import-AzRecoveryServicesAsrVaultSettingsFile

Imports the specified ASR vault settings file to set the vault context(PowerShell session context) for subsequent ASR operations in the PowerShell session.

Initialize-AzRecoveryServicesBackupProtectableItem

This command triggers the discovery of any unprotected items of the given workload type in the given container. If the DB application is not auto-protected use this command to discover new DBs whenever they are added and proceed to protect them.

New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig

Creates a disk mapping object for Azure virtual machine disks to be replicated.

New-AzRecoveryServicesAsrFabric

Creates an Azure Site Recovery Fabric.

New-AzRecoveryServicesAsrInMageAzureV2DiskInput

Creates a disk mapping object for vMWare virtual machine disks to be replicated.

New-AzRecoveryServicesAsrNetworkMapping

Creates an ASR network mapping between two networks.

New-AzRecoveryServicesAsrPolicy

Creates an Azure Site Recovery replication policy.

New-AzRecoveryServicesAsrProtectableItem

Add(Discover) a physical server to the list of protectable items.

New-AzRecoveryServicesAsrProtectionContainer

Creates an Azure Site Recovery Protection Container within the specified fabric.

New-AzRecoveryServicesAsrProtectionContainerMapping

Creates an Azure Site Recovery Protection Container mapping by associating the specified replication policy to the specified ASR protection container.

New-AzRecoveryServicesAsrRecoveryPlan

Creates an ASR recovery plan.

New-AzRecoveryServicesAsrReplicationProtectedItem

Enables replication for an ASR protectable item by creating a replication protected item.

New-AzRecoveryServicesAsrStorageClassificationMapping

Creates an ASR storage classification mapping in the Recovery Services vault.

New-AzRecoveryServicesAsrvCenter

Adds a vCenter server to discover protectable items from.

New-AzRecoveryServicesBackupProtectionPolicy

Creates a Backup protection policy.

New-AzRecoveryServicesVault

Creates a new Recovery Services vault.

Register-AzRecoveryServicesBackupContainer

This command allows Azure Backup to convert the �Resource� to a �Backup Container� which is then registered to the given Recovery services vault. The Azure Backup service can then discover workloads of the given workload type within this container to be protected later.

Remove-AzRecoveryServicesAsrFabric

Deletes the specified Azure Site Recovery Fabric from the Recovery Services vault.

Remove-AzRecoveryServicesAsrNetworkMapping

Deletes the specified ASR network mapping from the Recovery Services vault.

Remove-AzRecoveryServicesAsrPolicy

Deletes the specified ASR replication policy from the Recovery Services vault.

Remove-AzRecoveryServicesAsrProtectionContainer

Deletes the specified Protection Container from its Fabric.

Remove-AzRecoveryServicesAsrProtectionContainerMapping

Deletes the specified Azure Site Recovery protection container mapping.

Remove-AzRecoveryServicesAsrRecoveryPlan

Deletes the specified ASR recovery plan from Recovery Services vault.

Remove-AzRecoveryServicesAsrReplicationProtectedItem

Stops/Disables replication for an Azure Site Recovery replication protected item.

Remove-AzRecoveryServicesAsrServicesProvider

Deletes/unregister the specified Azure Site Recovery recovery services provider from the recovery services vault.

Remove-AzRecoveryServicesAsrStorageClassificationMapping

Deletes the specified ASR storage classification mapping.

Remove-AzRecoveryServicesAsrvCenter

Removes the vCenter server from the ASR fabric and stops discovery of virtual machines from the vCenter server.

Remove-AzRecoveryServicesBackupProtectionPolicy

Deletes a Backup protection policy from a vault.

Remove-AzRecoveryServicesVault

Deletes a Recovery Services vault.

Restart-AzRecoveryServicesAsrJob

Restarts an Azure Site Recovery job.

Restore-AzRecoveryServicesBackupItem

Restores the data and configuration for a Backup item to a recovery point.

Resume-AzRecoveryServicesAsrJob

Resumes a suspended Azure Site Recovery job.

Set-AzRecoveryServicesAsrAlertSetting

Configure Azure Site Recovery notification settings (email notification) for the vault.

Set-AzRecoveryServicesAsrReplicationProtectedItem

Sets recovery properties such as target network and virtual machine size for the specified replication protected item.

Set-AzRecoveryServicesAsrVaultContext

Sets the Recovery Services vault context to be used for subsequent Azure Site Recovery operations in the current PowerShell session.

Set-AzRecoveryServicesBackupProperty

Sets the properties for backup management.

Set-AzRecoveryServicesBackupProtectionPolicy

Modifies a Backup protection policy.

Set-AzRecoveryServicesVaultContext

Sets vault context.

Start-AzRecoveryServicesAsrApplyRecoveryPoint

Changes a recovery point for a failed over protected item before committing the failover operation.

Start-AzRecoveryServicesAsrCommitFailoverJob

Starts the commit failover action for a Site Recovery object.

Start-AzRecoveryServicesAsrPlannedFailoverJob

Starts a planned failover operation.

Start-AzRecoveryServicesAsrResynchronizeReplicationJob

Starts replication resynchronization.

Start-AzRecoveryServicesAsrSwitchProcessServerJob

Switch replication from one Process server to another for load balancing.

Start-AzRecoveryServicesAsrTestFailoverCleanupJob

Starts the test failover cleanup operation.

Start-AzRecoveryServicesAsrTestFailoverJob

Starts a test failover operation.

Start-AzRecoveryServicesAsrUnplannedFailoverJob

Starts a unplanned failover operation.

Stop-AzRecoveryServicesAsrJob

Stops an Azure Site Recovery job.

Stop-AzRecoveryServicesBackupJob

Cancels a running job.

Unregister-AzRecoveryServicesBackupContainer

Unregisters a Windows Server or other container from the vault.

Unregister-AzRecoveryServicesBackupManagementServer

Unregisters a SCDPM server or Backup server from the vault.

Update-AzRecoveryServicesAsrMobilityService

Push mobility service agent updates to protected machines.

Update-AzRecoveryServicesAsrNetworkMapping

Updates the specified azure site recovery network mapping.

Update-AzRecoveryServicesAsrPolicy

Updates an Azure Site Recovery replication policy.

Update-AzRecoveryServicesAsrProtectionContainerMapping

Update the Azure site recovery protection container mapping.

Update-AzRecoveryServicesAsrProtectionDirection

Updates the replication direction for the specified replication protected item or recovery plan. Used to re-protect/reverse replicate a failed over replicated item or recovery plan.

Update-AzRecoveryServicesAsrRecoveryPlan

Updates the contents of an Azure Site recovery plan.

Update-AzRecoveryServicesAsrServicesProvider

Refreshes (Refresh server) the information received from the Azure Site Recovery Services Provider.

Update-AzRecoveryServicesAsrvCenter

Update discovery details for a registered vCenter.

Wait-AzRecoveryServicesBackupJob

Waits for a Backup job to finish.