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. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Backup-AzRecoveryServicesBackupItem |
Starts a backup for a Backup item. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Copy-AzRecoveryServicesVault |
Copies data from a vault in one region to a vault in another region. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Disable-AzRecoveryServicesBackupAutoProtection |
Disables auto backup for a protectable item. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Disable-AzRecoveryServicesBackupProtection |
Disables protection for a Backup-protected item. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Disable-AzRecoveryServicesBackupRPMountScript |
Dismounts all the files of the recovery point. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Edit-AzRecoveryServicesAsrRecoveryPlan |
Edits a Site Recovery plan. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Enable-AzRecoveryServicesBackupAutoProtection |
The Enable-AzRecoveryServicesBackupAutoProtection cmdlet sets up automatic protection of current and any future SQL DBs within the given instance with the supplied policy. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Enable-AzRecoveryServicesBackupProtection |
Enables or resumes backup for an item with a specified Backup protection policy. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesAsrAlertSetting |
Gets the configured Azure Site Recovery notification settings for the vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesAsrEvent |
Gets details of Azure Site Recovery events in the vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesAsrFabric |
Get the details of an Azure Site Recovery Fabric. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesAsrJob |
Gets the details of the specified ASR job or the list of recent ASR jobs in the Recovery Services vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesAsrNetwork |
Gets information about the networks managed by Site Recovery for the current vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesAsrNetworkMapping |
Gets information about Site Recovery network mappings for the current vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesAsrPolicy |
Gets ASR replication policies. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesAsrProtectableItem |
Get the protectable items in an ASR protection container. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesAsrProtectionContainer |
Gets ASR protection containers in the Recovery Services vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesAsrProtectionContainerMapping |
Gets Azure Site Recovery Protection Container mappings. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesAsrRecoveryPlan |
Gets a recovery plan or all the recovery plans in the Recovery Services vault Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesAsrRecoveryPoint |
Gets the available recovery points for a replication protected item. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesAsrReplicationProtectedItem |
Gets the properties of an Azure Site Recovery Replication Protected Items. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesAsrServicesProvider |
Gets the details of the ASR recovery services providers registered to the Recovery Services vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesAsrStorageClassification |
Gets the available(discovered) ASR storage classifications in the Recovery Services vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesAsrStorageClassificationMapping |
Gets ASR storage classification mappings. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesAsrVaultContext |
Gets ASR vault settings information for the Recovery Services vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesAsrvCenter |
Gets details of the vCenter servers registered for discovery on the Configuration server specified by the ASR fabric. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesBackupContainer |
Gets Backup containers. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesBackupItem |
Gets the items from a container in Backup. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesBackupJob |
Gets Backup jobs. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesBackupJobDetail |
Gets details for a Backup job. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesBackupManagementServer |
Gets SCDPM and Azure Backup management servers. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesBackupProperty |
Gets Backup properties. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| 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. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesBackupProtectionPolicy |
Gets Backup protection policies for a vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesBackupRecommendedArchivableRPGroup |
Gets the recovery points which are recommended to be moved together to VaultArchive tier. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| 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. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesBackupRecoveryPoint |
Gets the recovery points for a backed up item. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesBackupRetentionPolicyObject |
Gets a base retention policy object. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesBackupRPMountScript |
Downloads a script to mount all the files of the recovery point. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesBackupSchedulePolicyObject |
Gets a base schedule policy object. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesBackupStatus |
Checks whether your ARM resource is backed up or not. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| 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. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesVault |
Gets a list of Recovery Services vaults. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesVaultProperty |
Returns the properties of a Recovery Services Vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Get-AzRecoveryServicesVaultSettingsFile |
Gets the Azure Site Recovery vault settings file. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| 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. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| 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. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Initialize-AzRecoveryServicesDSMove |
Initializes DS move for Copy-AzRecoveryServicesVault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Move-AzRecoveryServicesBackupRecoveryPoint |
Moves the recovery point from source tier to destination tier. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig |
Creates a disk mapping object for Azure virtual machine disks to be replicated. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| New-AzRecoveryServicesAsrFabric |
Creates an Azure Site Recovery Fabric. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| New-AzRecoveryServicesAsrInMageAzureV2DiskInput |
Creates a disk mapping object for vMWare virtual machine disks to be replicated. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| New-AzRecoveryServicesAsrInMageRcmDiskInput |
Creates Azure Site Recovery Disk replication configuration for VMware To Azure replication. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| New-AzRecoveryServicesAsrNetworkMapping |
Creates an ASR network mapping between two networks. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| New-AzRecoveryServicesAsrPolicy |
Creates an Azure Site Recovery replication policy. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| New-AzRecoveryServicesAsrProtectableItem |
Add(Discover) a physical server to the list of protectable items. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| New-AzRecoveryServicesAsrProtectionContainer |
Creates an Azure Site Recovery Protection Container within the specified fabric. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| New-AzRecoveryServicesAsrProtectionContainerMapping |
Creates an Azure Site Recovery Protection Container mapping by associating the specified replication policy to the specified ASR protection container. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| New-AzRecoveryServicesAsrRecoveryPlan |
Creates an ASR recovery plan. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| New-AzRecoveryServicesAsrReplicationProtectedItem |
Enables replication for an ASR protectable item by creating a replication protected item. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| New-AzRecoveryServicesAsrStorageClassificationMapping |
Creates an ASR storage classification mapping in the Recovery Services vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| New-AzRecoveryServicesAsrvCenter |
Adds a vCenter server to discover protectable items from. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| New-AzRecoveryServicesAsrVMNicConfig |
Creates an ASR NIC config that contains the failover and test failover related configuration details. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| New-AzRecoveryServicesAsrVMNicIPConfig |
Creates an ASR NIC IP config that contains the failover and test failover configuration details for each IP Config (Primary and Secondary) of the NIC. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| New-AzRecoveryServicesBackupProtectionPolicy |
Creates a Backup protection policy. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| New-AzRecoveryServicesVault |
Creates a new Recovery Services vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Register-AzRecoveryServicesBackupContainer |
The Register-AzRecoveryServicesBackupContainer cmdlet registers an Azure VM for AzureWorkloads with specific workloadType. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Remove-AzRecoveryServicesAsrFabric |
Deletes the specified Azure Site Recovery Fabric from the Recovery Services vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Remove-AzRecoveryServicesAsrNetworkMapping |
Deletes the specified ASR network mapping from the Recovery Services vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Remove-AzRecoveryServicesAsrPolicy |
Deletes the specified ASR replication policy from the Recovery Services vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Remove-AzRecoveryServicesAsrProtectionContainer |
Deletes the specified Protection Container from its Fabric. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Remove-AzRecoveryServicesAsrProtectionContainerMapping |
Deletes the specified Azure Site Recovery protection container mapping. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Remove-AzRecoveryServicesAsrRecoveryPlan |
Deletes the specified ASR recovery plan from Recovery Services vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Remove-AzRecoveryServicesAsrReplicationProtectedItem |
Stops/Disables replication for an Azure Site Recovery replication protected item. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Remove-AzRecoveryServicesAsrReplicationProtectedItemDisk |
Removes disks to replication protected item. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Remove-AzRecoveryServicesAsrServicesProvider |
Deletes/unregister the specified Azure Site Recovery recovery services provider from the recovery services vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Remove-AzRecoveryServicesAsrStorageClassificationMapping |
Deletes the specified ASR storage classification mapping. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Remove-AzRecoveryServicesAsrvCenter |
Removes the vCenter server from the ASR fabric and stops discovery of virtual machines from the vCenter server. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Remove-AzRecoveryServicesBackupProtectionPolicy |
Deletes a Backup protection policy from a vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Remove-AzRecoveryServicesVault |
Deletes a Recovery Services vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Restart-AzRecoveryServicesAsrJob |
Restarts an Azure Site Recovery job. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Restore-AzRecoveryServicesBackupItem |
Restores the data and configuration for a Backup item to the specified recovery point. The required parameters vary with the backup item type. The same command is used to restore Azure Virtual machines, databases running within Azure Virtual machines and Azure file shares as well. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Resume-AzRecoveryServicesAsrJob |
Resumes a suspended Azure Site Recovery job. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Set-AzRecoveryServicesAsrAlertSetting |
Configure Azure Site Recovery notification settings (email notification) for the vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Set-AzRecoveryServicesAsrReplicationProtectedItem |
Sets recovery properties such as target network and virtual machine size for the specified replication protected item. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Set-AzRecoveryServicesAsrVaultContext |
Sets the Recovery Services vault context to be used for subsequent Azure Site Recovery operations in the current PowerShell session. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Set-AzRecoveryServicesBackupProperty |
Sets the properties for backup management. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Set-AzRecoveryServicesBackupProtectionPolicy |
Modifies a Backup protection policy. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Set-AzRecoveryServicesVaultContext |
Sets vault context. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Set-AzRecoveryServicesVaultProperty |
Updates properties of a Vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Start-AzRecoveryServicesAsrApplyRecoveryPoint |
Changes a recovery point for a failed over protected item before committing the failover operation. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Start-AzRecoveryServicesAsrCancelFailoverJob |
Starts the cancel failover action for a Site Recovery object. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Start-AzRecoveryServicesAsrCommitFailoverJob |
Starts the commit failover action for a Site Recovery object. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Start-AzRecoveryServicesAsrPlannedFailoverJob |
Starts a planned failover operation. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Start-AzRecoveryServicesAsrResynchronizeReplicationJob |
Starts replication resynchronization. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Start-AzRecoveryServicesAsrSwitchAppliance |
Starts the switch appliance action for a Site Recovery object. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Start-AzRecoveryServicesAsrSwitchProcessServerJob |
Switch replication from one Process server to another for load balancing. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Start-AzRecoveryServicesAsrTestFailoverCleanupJob |
Starts the test failover cleanup operation. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Start-AzRecoveryServicesAsrTestFailoverJob |
Starts a test failover operation. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Start-AzRecoveryServicesAsrUnplannedFailoverJob |
Starts an unplanned failover operation. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Stop-AzRecoveryServicesAsrJob |
Stops an Azure Site Recovery job. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Stop-AzRecoveryServicesBackupJob |
Cancels a running job. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Test-AzRecoveryServicesDSMove |
This cmdlet performs necessary validations for DS Move. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Undo-AzRecoveryServicesBackupItemDeletion |
If a backup item is deleted and present in a soft-deleted state, this command brings the item back to a state where the data is retained forever Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Unregister-AzRecoveryServicesBackupContainer |
Unregisters a Windows Server or other container from the vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Unregister-AzRecoveryServicesBackupManagementServer |
Unregisters a SCDPM server or Backup server from the vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Update-AzRecoveryServicesAsrMobilityService |
Push mobility service agent updates to protected machines. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Update-AzRecoveryServicesAsrNetworkMapping |
Updates the specified azure site recovery network mapping. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Update-AzRecoveryServicesAsrPolicy |
Updates an Azure Site Recovery replication policy. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Update-AzRecoveryServicesAsrProtectionContainerMapping |
Update the Azure site recovery protection container mapping. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| 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. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Update-AzRecoveryServicesAsrRecoveryPlan |
Updates the contents of an Azure Site recovery plan. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Update-AzRecoveryServicesAsrServicesProvider |
Refreshes (Refresh server) the information received from the Azure Site Recovery Services Provider. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Update-AzRecoveryServicesAsrvCenter |
Update discovery details for a registered vCenter. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Update-AzRecoveryServicesVault |
Updates MSIdentity to the recovery services vault. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |
| Wait-AzRecoveryServicesBackupJob |
Waits for a Backup job to finish. Note This is the previous version of our documentation. Please consult the most recent version for up-to-date information. |