Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Backup-AzureRmRecoveryServicesBackupItem</command:name> <command:verb>Backup</command:verb> <command:noun>AzureRmRecoveryServicesBackupItem</command:noun> <maml:description><maml:para>Starts a backup for a Backup item. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Backup-AzureRmRecoveryServicesBackupItem cmdlet starts a backup for a protected Azure Backup item that is not tied to the backup schedule. You can do an initial backup immediately after you enable protection or start a backup after a scheduled backup fails. </maml:para> <maml:para>Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Backup-AzureRmRecoveryServicesBackupItem</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>ExpiryDateTimeUTC</maml:name> <maml:Description><maml:para>Specifies an expiry time as a DateTime object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>Specifies a Backup item for which this cmdlet starts a backup operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ItemBase</command:parameterValue> <dev:type><maml:name>ItemBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>ExpiryDateTimeUTC</maml:name> <maml:Description><maml:para>Specifies an expiry time as a DateTime object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>Specifies a Backup item for which this cmdlet starts a backup operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ItemBase</command:parameterValue> <dev:type><maml:name>ItemBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>DateTime</maml:name> </dev:type> <maml:description><maml:para>Parameter 'ExpiryDateTimeUTC' accepts value of type 'DateTime' from the pipeline </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>ItemBase</maml:name> </dev:type> <maml:description><maml:para>Parameter 'Item' accepts value of type 'ItemBase' from the pipeline </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Start a backup for a Backup item</maml:title> <dev:code>PS C:\> $NamedContainer = Get-AzureRmRecoveryServicesBackupContainer -ContainerType AzureVM -Status Registered -Name "pstestv2vm1" PS C:\> $Item = Get-AzureRmRecoveryServicesBackupItem -Container $NamedContainer -WorkloadType AzureVM PS C:\> $Job = Backup-AzureRmRecoveryServicesItem -Item $Item Operation Status StartTime EndTime JOBID ------------ --------- ------ --------- ------- pstestv2vm1 Backup InProgress 4/23/2016 5:00:30 PM cf4b3ef5-2fac-4c8e-a215-d2eba4124f27</dev:code> <dev:remarks><maml:para>The first command gets the Backup container of type AzureVM named pstestv2vm1, and then stores it in the $NamedContainer variable. </maml:para> <maml:para>The second command gets the Backup item corresponding to the container in $NamedContainer, and then stores it in the $Item variable. </maml:para> <maml:para>The last command triggers the backup job for the Backup item in $Item. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/backup-azurermrecoveryservicesbackupitem</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupContainer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Restore-AzureRmRecoveryServicesBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Disable-AzureRmRecoveryServicesBackupProtection</command:name> <command:verb>Disable</command:verb> <command:noun>AzureRmRecoveryServicesBackupProtection</command:noun> <maml:description><maml:para>Disables protection for a Backup-protected item. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Disable-AzureRmRecoveryServicesBackupProtection cmdlet disables protection for an Azure Backup-protected item. This cmdlet stops regular scheduled backup of an item. This cmdlet can also delete existing recovery points for the backup item. </maml:para> <maml:para>Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Disable-AzureRmRecoveryServicesBackupProtection</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>Specifies the Backup item for which this cmdlet disables protection. To obtain an AzureRmRecoveryServicesBackupItem , use the Get-AzureRmRecoveryServicesBackupItem cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ItemBase</command:parameterValue> <dev:type><maml:name>ItemBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>RemoveRecoveryPoints</maml:name> <maml:Description><maml:para>Indicates that this cmdlet deletes existing recovery points. To delete stored recovery points later, run this cmdlet again and specify this parameter. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>Specifies the Backup item for which this cmdlet disables protection. To obtain an AzureRmRecoveryServicesBackupItem , use the Get-AzureRmRecoveryServicesBackupItem cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ItemBase</command:parameterValue> <dev:type><maml:name>ItemBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>RemoveRecoveryPoints</maml:name> <maml:Description><maml:para>Indicates that this cmdlet deletes existing recovery points. To delete stored recovery points later, run this cmdlet again and specify this parameter. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>ItemBase</maml:name> </dev:type> <maml:description><maml:para>Parameter 'Item' accepts value of type 'ItemBase' from the pipeline </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Disable Backup protection</maml:title> <dev:code>PS C:\> $Cont = Get-AzureRmRecoveryServicesBackupContainer -ContainerType AzureVM -Status Registered PS C:\> $PI = Get-AzureRmRecoveryServicesBackupItem -Container $Cont[0] -WorkloadType AzureVM PS C:\> Disable-AzureRmRecoveryServicesBackupProtection -Item $PI[0]</dev:code> <dev:remarks><maml:para>The first command gets an array of backup containers, and then stores it in the $Cont array. </maml:para> <maml:para>The second command gets the Backup item corresponding to the first container item, and then stores it in the $PI variable. </maml:para> <maml:para>The last command disables Backup protection for the item in $PI[0], but retains the data. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/disable-azurermrecoveryservicesbackupprotection</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Enable-AzureRmRecoveryServicesBackupProtection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupContainer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Disable-AzureRmRecoveryServicesBackupRPMountScript</command:name> <command:verb>Disable</command:verb> <command:noun>AzureRmRecoveryServicesBackupRPMountScript</command:noun> <maml:description><maml:para>Dismounts all the files of the recovery point. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Disable-AzureRmRecoveryServicesBackupRPMountScript cmdlet dismounts the files of the recovery point which were mounted earlier using the Get-AzureRmRecoveryServicesBackupRPMountScript cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Disable-AzureRmRecoveryServicesBackupRPMountScript</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>RecoveryPoint</maml:name> <maml:Description><maml:para>Recovery point object to be restored </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RecoveryPointBase</command:parameterValue> <dev:type><maml:name>RecoveryPointBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Return the recovery point. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Return the recovery point. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>RecoveryPoint</maml:name> <maml:Description><maml:para>Recovery point object to be restored </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RecoveryPointBase</command:parameterValue> <dev:type><maml:name>RecoveryPointBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>System.Object</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Dismount a recovery point</maml:title> <dev:code>PS C:\> $namedContainer = Get-AzureRmRecoveryServicesBackupContainer -ContainerType "AzureVM" -Status "Registered" -FriendlyName "V2VM" PS C:\> $backupitem = Get-AzureRmRecoveryServicesBackupItem -Container $namedContainer -WorkloadType "AzureVM" PS C:\> $startDate = (Get-Date).AddDays(-7) PS C:\> $endDate = Get-Date PS C:\> $rp = Get-AzureRmRecoveryServicesBackupRecoveryPoint -Item $backupitem -StartDate $startdate.ToUniversalTime() -EndDate $enddate.ToUniversalTime() To mount files of the latest recovery point, obtain the script by PS C:\> Get-AzureRmRecoveryServicesBackupRPMountScript -RecoveryPoint $rp[0] OsType Password Filename ------ -------- -------- Windows e3632984e51f496 V2VM_wus2_8287309959960546283_451516692429_cbd6061f7fc543c489f1974d33659fed07a6e0c2e08740.exe When the script is run, it will mount the files of the recovery point $rp[0] After the relevant files are copied, then you remove the files of the recovery point by running the disable cmdlet PS C:\> Disable-AzureRmRecoveryServicesBackupRPMountScript -RecoveryPoint $rp[0]</dev:code> <dev:remarks><maml:para> </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Enable-AzureRmRecoveryServicesBackupProtection</command:name> <command:verb>Enable</command:verb> <command:noun>AzureRmRecoveryServicesBackupProtection</command:noun> <maml:description><maml:para>Enables backup for an item with a specified Backup protection policy. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Enable-AzureRmRecoveryServicesBackupProtection cmdlet sets Azure Backup protection policy on an item. </maml:para> <maml:para>Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Enable-AzureRmRecoveryServicesBackupProtection</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Policy</maml:name> <maml:Description><maml:para>Specifies protection policy that this cmdlet associates with an item. To obtain an AzureRmRecoveryServicesBackupProtectionPolicy object, use the Get-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PolicyBase</command:parameterValue> <dev:type><maml:name>PolicyBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="4" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>Specifies the Backup item for which this cmdlet enables protection. To obtain an AzureRmRecoveryServicesBackupItem , use the Get-AzureRmRecoveryServicesBackupItem cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ItemBase</command:parameterValue> <dev:type><maml:name>ItemBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Enable-AzureRmRecoveryServicesBackupProtection</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Policy</maml:name> <maml:Description><maml:para>Specifies protection policy that this cmdlet associates with an item. To obtain an AzureRmRecoveryServicesBackupProtectionPolicy object, use the Get-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PolicyBase</command:parameterValue> <dev:type><maml:name>PolicyBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the Backup item. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. Specify this parameter only for ARM virtual machines. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Enable-AzureRmRecoveryServicesBackupProtection</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Policy</maml:name> <maml:Description><maml:para>Specifies protection policy that this cmdlet associates with an item. To obtain an AzureRmRecoveryServicesBackupProtectionPolicy object, use the Get-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PolicyBase</command:parameterValue> <dev:type><maml:name>PolicyBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the Backup item. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"><maml:name>ServiceName</maml:name> <maml:Description><maml:para>Specifies the service name. Specify this parameter only for ASM virtual machines. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="4" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>Specifies the Backup item for which this cmdlet enables protection. To obtain an AzureRmRecoveryServicesBackupItem , use the Get-AzureRmRecoveryServicesBackupItem cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ItemBase</command:parameterValue> <dev:type><maml:name>ItemBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the Backup item. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Policy</maml:name> <maml:Description><maml:para>Specifies protection policy that this cmdlet associates with an item. To obtain an AzureRmRecoveryServicesBackupProtectionPolicy object, use the Get-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PolicyBase</command:parameterValue> <dev:type><maml:name>PolicyBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. Specify this parameter only for ARM virtual machines. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"><maml:name>ServiceName</maml:name> <maml:Description><maml:para>Specifies the service name. Specify this parameter only for ASM virtual machines. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>ItemBase</maml:name> </dev:type> <maml:description><maml:para>Parameter 'Item' accepts value of type 'ItemBase' from the pipeline </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Enable Backup protection for an item</maml:title> <dev:code>PS C:\> $Pol = Get-AzureRmRecoveryServicesBackupProtectionPolicy -Name "DefaultPolicy" PS C:\> Enable-AzureRmRecoveryServicesBackupProtection -Policy $Pol -Name "V2VM" -ResourceGroupName "RGName1" WorkloadName Operation Status StartTime EndTime ------------ --------- ------ --------- ------- co03-vm ConfigureBackup Completed 11-Apr-16 12:19:49 PM 11-Apr-16 12:19:54 PM</dev:code> <dev:remarks><maml:para>The first cmdlet gets a default policy object, and then stores it in the $Pol variable. </maml:para> <maml:para>The second cmdlet sets the Backup protection policy for the ARM virtual machine named V2VM using the policy in $Pol. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/enable-azurermrecoveryservicesbackupprotection</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Disable-AzureRmRecoveryServicesBackupProtection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmRecoveryServicesBackupContainer</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesBackupContainer</command:noun> <maml:description><maml:para>Gets Backup containers. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmRecoveryServicesBackupContainer cmdlet gets a backup container. A Backup container encapsulates data sources that are modelled as backup items. </maml:para> <maml:para>Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmRecoveryServicesBackupContainer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ContainerType</maml:name> <maml:Description><maml:para>Specifies the backup container type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- Windows </maml:para> <maml:para>- AzureSQL </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> <command:parameterValue required="false" variableLength="false">Windows</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureSQL</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ContainerType</command:parameterValue> <dev:type><maml:name>ContainerType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>BackupManagementType</maml:name> <maml:Description><maml:para>Specifies the backup management type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- MARS </maml:para> <maml:para>- AzureSQL </maml:para> <maml:para> </maml:para> <maml:para>This parameter is used to differentiate Windows machines that are backed up using MARS agent or other backup engines. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> <command:parameterValue required="false" variableLength="false">MARS</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureSQL</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>FriendlyName</maml:name> <maml:Description><maml:para>Specifies the friendly name of the container to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the container to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. This parameter is for Azure virtual machines only. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>Status</maml:name> <maml:Description><maml:para>Specifies the container registration status. The acceptable values for this parameter are: </maml:para> <maml:para>- Registered </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Registered</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ContainerRegistrationStatus</command:parameterValue> <dev:type><maml:name>ContainerRegistrationStatus</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>BackupManagementType</maml:name> <maml:Description><maml:para>Specifies the backup management type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- MARS </maml:para> <maml:para>- AzureSQL </maml:para> <maml:para> </maml:para> <maml:para>This parameter is used to differentiate Windows machines that are backed up using MARS agent or other backup engines. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ContainerType</maml:name> <maml:Description><maml:para>Specifies the backup container type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- Windows </maml:para> <maml:para>- AzureSQL </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ContainerType</command:parameterValue> <dev:type><maml:name>ContainerType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>FriendlyName</maml:name> <maml:Description><maml:para>Specifies the friendly name of the container to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the container to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. This parameter is for Azure virtual machines only. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>Status</maml:name> <maml:Description><maml:para>Specifies the container registration status. The acceptable values for this parameter are: </maml:para> <maml:para>- Registered </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ContainerRegistrationStatus</command:parameterValue> <dev:type><maml:name>ContainerRegistrationStatus</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> <command:returnValue><dev:type><maml:name>System.Collections.Generic.IList`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get a specific container</maml:title> <dev:code>PS C:\>Get-AzureRmRecoveryServicesContainer -ContainerType "AzureVM" -Status "Registered" -Name "V2VM";</dev:code> <dev:remarks><maml:para>This command gets the container named V2VM of type AzureVM. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Get all containers of a specific type</maml:title> <dev:code>PS C:\>Get-AzureRmRecoveryServicesBackupContainer -ContainerType Windows -BackupManagementType MARS</dev:code> <dev:remarks><maml:para>This command gets all Windows containers that are protected by Azure Backup agent. The BackupManagementType parameter is only required for Windows containers. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackupcontainer</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupManagementServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Unregister-AzureRmRecoveryServicesBackupContainer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmRecoveryServicesBackupItem</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesBackupItem</command:noun> <maml:description><maml:para>Gets the items from a container in Backup. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmRecoveryServicesBackupItem cmdlet gets the items in a container or a value in Azure Backup and the protection status of the items. </maml:para> <maml:para>A container that is registered to an Azure Recovery Services vault can have one or more items that can be protected. For Azure virtual machines, there can be only one backup item in the virtual machine container. </maml:para> <maml:para>Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmRecoveryServicesBackupItem</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>BackupManagementType</maml:name> <maml:Description><maml:para>Specifies the Backup management type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- MARS </maml:para> <maml:para>- SCDPM </maml:para> <maml:para>- AzureBackupServer </maml:para> <maml:para> AzureSQL </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> <command:parameterValue required="false" variableLength="false">MARS</command:parameterValue> <command:parameterValue required="false" variableLength="false">SCDPM</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureBackupServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureSQL</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">BackupManagementType</command:parameterValue> <dev:type><maml:name>BackupManagementType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the container. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>ProtectionStatus</maml:name> <maml:Description><maml:para>Specifies the overall protection status of an item in the container. The acceptable values for this parameter are: </maml:para> <maml:para>- Healthy </maml:para> <maml:para>- Unhealthy </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Healthy</command:parameterValue> <command:parameterValue required="false" variableLength="false">Unhealthy</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ItemProtectionStatus</command:parameterValue> <dev:type><maml:name>ItemProtectionStatus</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>ProtectionState</maml:name> <maml:Description><maml:para>Specifies the state of protection. The acceptable values for this parameter are: </maml:para> <maml:para>- IRPending. Initial synchronization has not started and there is no recovery point yet. - Protected. Protection is ongoing. - ProtectionError. There is a protection error. - ProtectionStopped. Protection is disabled. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">IRPending</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProtectionError</command:parameterValue> <command:parameterValue required="false" variableLength="false">Protected</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProtectionStopped</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ItemProtectionState</command:parameterValue> <dev:type><maml:name>ItemProtectionState</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>WorkloadType</maml:name> <maml:Description><maml:para>Specifies the workload type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- AzureSQLDatabase </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureSQLDatabase</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WorkloadType</command:parameterValue> <dev:type><maml:name>WorkloadType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmRecoveryServicesBackupItem</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"><maml:name>Container</maml:name> <maml:Description><maml:para>Specifies a container object from which this cmdlet gets backup items. To obtain an AzureRmRecoveryServicesBackupContainer , use the Get-AzureRmRecoveryServicesBackupContainer cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ContainerBase</command:parameterValue> <dev:type><maml:name>ContainerBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the container. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>ProtectionStatus</maml:name> <maml:Description><maml:para>Specifies the overall protection status of an item in the container. The acceptable values for this parameter are: </maml:para> <maml:para>- Healthy </maml:para> <maml:para>- Unhealthy </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Healthy</command:parameterValue> <command:parameterValue required="false" variableLength="false">Unhealthy</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ItemProtectionStatus</command:parameterValue> <dev:type><maml:name>ItemProtectionStatus</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>ProtectionState</maml:name> <maml:Description><maml:para>Specifies the state of protection. The acceptable values for this parameter are: </maml:para> <maml:para>- IRPending. Initial synchronization has not started and there is no recovery point yet. - Protected. Protection is ongoing. - ProtectionError. There is a protection error. - ProtectionStopped. Protection is disabled. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">IRPending</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProtectionError</command:parameterValue> <command:parameterValue required="false" variableLength="false">Protected</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProtectionStopped</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ItemProtectionState</command:parameterValue> <dev:type><maml:name>ItemProtectionState</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>WorkloadType</maml:name> <maml:Description><maml:para>Specifies the workload type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- AzureSQLDatabase </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureSQLDatabase</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WorkloadType</command:parameterValue> <dev:type><maml:name>WorkloadType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>BackupManagementType</maml:name> <maml:Description><maml:para>Specifies the Backup management type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- MARS </maml:para> <maml:para>- SCDPM </maml:para> <maml:para>- AzureBackupServer </maml:para> <maml:para> AzureSQL </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BackupManagementType</command:parameterValue> <dev:type><maml:name>BackupManagementType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"><maml:name>Container</maml:name> <maml:Description><maml:para>Specifies a container object from which this cmdlet gets backup items. To obtain an AzureRmRecoveryServicesBackupContainer , use the Get-AzureRmRecoveryServicesBackupContainer cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ContainerBase</command:parameterValue> <dev:type><maml:name>ContainerBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the container. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>ProtectionState</maml:name> <maml:Description><maml:para>Specifies the state of protection. The acceptable values for this parameter are: </maml:para> <maml:para>- IRPending. Initial synchronization has not started and there is no recovery point yet. - Protected. Protection is ongoing. - ProtectionError. There is a protection error. - ProtectionStopped. Protection is disabled. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ItemProtectionState</command:parameterValue> <dev:type><maml:name>ItemProtectionState</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>ProtectionStatus</maml:name> <maml:Description><maml:para>Specifies the overall protection status of an item in the container. The acceptable values for this parameter are: </maml:para> <maml:para>- Healthy </maml:para> <maml:para>- Unhealthy </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ItemProtectionStatus</command:parameterValue> <dev:type><maml:name>ItemProtectionStatus</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>WorkloadType</maml:name> <maml:Description><maml:para>Specifies the workload type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- AzureSQLDatabase </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">WorkloadType</command:parameterValue> <dev:type><maml:name>WorkloadType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> <command:returnValue><dev:type><maml:name>System.Collections.Generic.IList`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get an item from a Backup container</maml:title> <dev:code>PS C:\>$Container = Get-AzureRmRecoveryServicesBackupContainer -ContainerType AzureVM -Status Registered -Name "V2VM" PS C:\> $BackupItem = Get-AzureRmRecoveryServicesBackupItem -Container $Container -WorkloadType AzureVM</dev:code> <dev:remarks><maml:para>The first command gets the container of type AzureVM, and then stores it in the $Container variable. </maml:para> <maml:para>The second command gets the Backup item named V2VM in $Container, and then stores it in the $BackupItem variable. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackupitem</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Backup-AzureRmRecoveryServicesBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Disable-AzureRmRecoveryServicesBackupProtection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupRecoveryPoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Restore-AzureRmRecoveryServicesBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmRecoveryServicesBackupJob</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesBackupJob</command:noun> <maml:description><maml:para>Gets Backup jobs. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmRecoveryServicesBackupJob cmdlet gets Azure Backup jobs for a specific vault. </maml:para> <maml:para>Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmRecoveryServicesBackupJob</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Status</maml:name> <maml:Description><maml:para>Specifies a status of the jobs that this cmdlet gets. The acceptable values for this parameter are: </maml:para> <maml:para>- InProgress </maml:para> <maml:para>- Failed </maml:para> <maml:para>- Cancelled </maml:para> <maml:para>- Cancelling </maml:para> <maml:para>- Completed </maml:para> <maml:para>- CompletedWithWarnings </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">InProgress</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cancelling</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cancelled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Completed</command:parameterValue> <command:parameterValue required="false" variableLength="false">CompletedWithWarnings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Failed</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobStatus</command:parameterValue> <dev:type><maml:name>JobStatus</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Operation</maml:name> <maml:Description><maml:para>Specifies an operation of the jobs that this cmdlet gets. The acceptable values for this parameter are: </maml:para> <maml:para>- Backup </maml:para> <maml:para>- ConfigureBackup </maml:para> <maml:para>- DeleteBackupData </maml:para> <maml:para>- Register </maml:para> <maml:para>- Restore </maml:para> <maml:para>- UnProtect </maml:para> <maml:para>- Unregister </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Backup</command:parameterValue> <command:parameterValue required="false" variableLength="false">Restore</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfigureBackup</command:parameterValue> <command:parameterValue required="false" variableLength="false">DisableBackup</command:parameterValue> <command:parameterValue required="false" variableLength="false">DeleteBackupData</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobOperation</command:parameterValue> <dev:type><maml:name>JobOperation</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>From</maml:name> <maml:Description><maml:para>Specifies the start, as a DateTime object, of a time range for the jobs that this cmdlet gets. To obtain a DateTime object, use the Get-Date cmdlet. For more information about DateTime objects, type `Get-Help Get-Date`. Use UTC format for dates. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>To</maml:name> <maml:Description><maml:para>Specifies the end, as a DateTime object, of a time range for the jobs that this cmdlet gets. The default value is the current system time. If you specify this parameter, you must also specify the From parameter. Use UTC format for dates. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>JobId</maml:name> <maml:Description><maml:para>Specifies the ID of a job that this cmdlet gets. The ID is the InstanceId property of an AzureRmRecoveryServicesBackupJob object. To obtain an AzureRmRecoveryServicesBackupJob object, use Get-AzureRmRecoveryServicesBackupJob. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>Job</maml:name> <maml:Description><maml:para>Specifies the name of the Backup job to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">JobBase</command:parameterValue> <dev:type><maml:name>JobBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>BackupManagementType</maml:name> <maml:Description><maml:para>Specifies the Backup management type. Currently, only AzureVM is supported. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> <command:parameterValue required="false" variableLength="false">MARS</command:parameterValue> <command:parameterValue required="false" variableLength="false">SCDPM</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureBackupServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureSQL</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">BackupManagementType</command:parameterValue> <dev:type><maml:name>BackupManagementType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>BackupManagementType</maml:name> <maml:Description><maml:para>Specifies the Backup management type. Currently, only AzureVM is supported. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BackupManagementType</command:parameterValue> <dev:type><maml:name>BackupManagementType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>From</maml:name> <maml:Description><maml:para>Specifies the start, as a DateTime object, of a time range for the jobs that this cmdlet gets. To obtain a DateTime object, use the Get-Date cmdlet. For more information about DateTime objects, type `Get-Help Get-Date`. Use UTC format for dates. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>Job</maml:name> <maml:Description><maml:para>Specifies the name of the Backup job to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">JobBase</command:parameterValue> <dev:type><maml:name>JobBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>JobId</maml:name> <maml:Description><maml:para>Specifies the ID of a job that this cmdlet gets. The ID is the InstanceId property of an AzureRmRecoveryServicesBackupJob object. To obtain an AzureRmRecoveryServicesBackupJob object, use Get-AzureRmRecoveryServicesBackupJob. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Operation</maml:name> <maml:Description><maml:para>Specifies an operation of the jobs that this cmdlet gets. The acceptable values for this parameter are: </maml:para> <maml:para>- Backup </maml:para> <maml:para>- ConfigureBackup </maml:para> <maml:para>- DeleteBackupData </maml:para> <maml:para>- Register </maml:para> <maml:para>- Restore </maml:para> <maml:para>- UnProtect </maml:para> <maml:para>- Unregister </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">JobOperation</command:parameterValue> <dev:type><maml:name>JobOperation</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Status</maml:name> <maml:Description><maml:para>Specifies a status of the jobs that this cmdlet gets. The acceptable values for this parameter are: </maml:para> <maml:para>- InProgress </maml:para> <maml:para>- Failed </maml:para> <maml:para>- Cancelled </maml:para> <maml:para>- Cancelling </maml:para> <maml:para>- Completed </maml:para> <maml:para>- CompletedWithWarnings </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">JobStatus</command:parameterValue> <dev:type><maml:name>JobStatus</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>To</maml:name> <maml:Description><maml:para>Specifies the end, as a DateTime object, of a time range for the jobs that this cmdlet gets. The default value is the current system time. If you specify this parameter, you must also specify the From parameter. Use UTC format for dates. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> <command:returnValue><dev:type><maml:name>System.Collections.Generic.IList`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get all in-progress jobs</maml:title> <dev:code>PS C:\>$Joblist = Get-AzureRMRecoveryservicesBackupJob -Status Inprogress PS C:\> $Joblist[0] WorkloadName Operation Status StartTime EndTime ------------ --------- ------ --------- ------- V2VM Backup InProgress 4/23/2016 5:00:30 PM 1/1/2001 12:00:00</dev:code> <dev:remarks><maml:para>The first command gets status of an in-progress job as an array, and then stores it in the $Joblist variable. </maml:para> <maml:para>The second command displays the first item in the $Joblist array. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Get all failed jobs in the last 7 days</maml:title> <dev:code>PS C:\>Get-AzureRmRecoveryServicesBackupJob -From (Get-Date).AddDays(-7).ToUniversalTime() -Status Failed</dev:code> <dev:remarks><maml:para>This command gets failed jobs from the last week in the vault. The From parameter specifies a time seven days in the past specified in UTC. The command does not specify a value for the To parameter. Therefore, it uses the default value of the current time. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 3: Get an in-progress job and wait for completion</maml:title> <dev:code>PS C:\> $Jobs = Get-AzureRmRecoveryServicesBackupJob -Status InProgress $Job = $Jobs[0] while ( $Job.Status -ne Completed ) { Write-Host "Waiting for completion..." Start-Sleep -Seconds 10 $job = Get-AzureRmBackAzureRmRecoveryServicesBackupJob -Job $Job } Write-Host "Done!" Waiting for completion... Waiting for completion... Waiting for completion... Done!</dev:code> <dev:remarks><maml:para>This script polls the first job that is currently in progress until the job has completed. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackupjob</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupJobDetails</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Stop-AzureRmRecoveryServicesBackupJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Wait-AzureRmRecoveryServicesBackupJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmRecoveryServicesBackupJobDetails</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesBackupJobDetails</command:noun> <maml:description><maml:para>Gets details for a Backup job. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmRecoveryServicesBackupJobDetails cmdlet gets Azure Backup job details for a specified job. </maml:para> <maml:para>Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmRecoveryServicesBackupJobDetails</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Job</maml:name> <maml:Description><maml:para>Specifies the job to get. To obtain a BackupJob object, use the Get-AzureRmRecoveryServicesBackupJob cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">JobBase</command:parameterValue> <dev:type><maml:name>JobBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmRecoveryServicesBackupJobDetails</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>JobId</maml:name> <maml:Description><maml:para>Specifies the ID of a Backup job. The ID is the InstanceId property of a BackupJob object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Job</maml:name> <maml:Description><maml:para>Specifies the job to get. To obtain a BackupJob object, use the Get-AzureRmRecoveryServicesBackupJob cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">JobBase</command:parameterValue> <dev:type><maml:name>JobBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>JobId</maml:name> <maml:Description><maml:para>Specifies the ID of a Backup job. The ID is the InstanceId property of a BackupJob object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get Backup job details for failed jobs</maml:title> <dev:code>PS C:\>$Jobs = Get-AzureRmRecoveryServicesBackupJob -Status Failed PS C:\> $JobDetails = Get-AzureRmRecoveryServicesBackupJobDetails -Job $Jobs[0] PS C:\> $JobDetails.ErrorDetails</dev:code> <dev:remarks><maml:para>The first command gets an array of failed jobs in the vault, and then stores them in the $Jobs array. </maml:para> <maml:para>The second command gets the job details for the failed jobs in $Jobs, and then stores them in the $JobDetails variable. </maml:para> <maml:para>The final command displays error details for the failed jobs. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackupjobdetails</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmRecoveryServicesBackupManagementServer</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesBackupManagementServer</command:noun> <maml:description><maml:para>Gets SCDPM and Azure Backup management servers. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmRecoveryServicesBackupManagementServer cmdlet gets a list of Backup management servers that are registered in a vault. </maml:para> <maml:para>There are two types of Backup management servers: System Center Data Protection Manager (SCDPM) and Azure Backup management servers. Backup management servers are installed separately to manage Backup orchestration. </maml:para> <maml:para>Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmRecoveryServicesBackupManagementServer</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the Backup management server to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the Backup management server to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupEngineBase</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> <command:returnValue><dev:type><maml:name>System.Collections.Generic.IList`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupEngineBase]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get all Backup management servers</maml:title> <dev:code>PS C:\>Get-AzureRmRecoveryServicesBackupManagementServer</dev:code> <dev:remarks><maml:para>This command gets all Backup management servers registered with the vault. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackupmanagementserver</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Unregister-AzureRmRecoveryServicesBackupManagementServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmRecoveryServicesBackupProtectionPolicy</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesBackupProtectionPolicy</command:noun> <maml:description><maml:para>Gets Backup protection policies for a vault. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet gets Azure Backup protection policies for a vault. </maml:para> <maml:para>Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmRecoveryServicesBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>WorkloadType</maml:name> <maml:Description><maml:para>Specifies the workload type. Currently, only AzureVM is supported. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureSQLDatabase</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WorkloadType</command:parameterValue> <dev:type><maml:name>WorkloadType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>BackupManagementType</maml:name> <maml:Description><maml:para>Specifies the Backup management type. Currently, only AzureVM is supported. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> <command:parameterValue required="false" variableLength="false">MARS</command:parameterValue> <command:parameterValue required="false" variableLength="false">SCDPM</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureBackupServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureSQL</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">BackupManagementType</command:parameterValue> <dev:type><maml:name>BackupManagementType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmRecoveryServicesBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmRecoveryServicesBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>WorkloadType</maml:name> <maml:Description><maml:para>Specifies the workload type. Currently, only AzureVM is supported. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureSQLDatabase</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WorkloadType</command:parameterValue> <dev:type><maml:name>WorkloadType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>BackupManagementType</maml:name> <maml:Description><maml:para>Specifies the Backup management type. Currently, only AzureVM is supported. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BackupManagementType</command:parameterValue> <dev:type><maml:name>BackupManagementType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>WorkloadType</maml:name> <maml:Description><maml:para>Specifies the workload type. Currently, only AzureVM is supported. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">WorkloadType</command:parameterValue> <dev:type><maml:name>WorkloadType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> <command:returnValue><dev:type><maml:name>System.Collections.Generic.IList`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get all policies in the vault</maml:title> <dev:code>PS C:\> Get-AzureRmRecoveryServicesBackupProtectionPolicy Name WorkloadType BackupManagementType BackupTime DaysOfWeek ---- ------------ -------------------- ---------- ---------- DefaultPolicy AzureVM AzureVM 4/14/2016 5:00:00 PM NewPolicy AzureVM AzureVM 4/23/2016 5:30:00 PM NewPolicy2 AzureVM AzureVM 4/24/2016 1:30:00 AM</dev:code> <dev:remarks><maml:para>This command gets all protection policies created in the vault. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Get a specific policy</maml:title> <dev:code>PS C:\> $Pol= Get-AzureRmRecoveryServicesBackupProtectionPolicy -Name "DefaultPolicy"</dev:code> <dev:remarks><maml:para>This command gets the protection policy named DefaultPolicy, and then stores it in the $Pol variable. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackupprotectionpolicy</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmRecoveryServicesBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmRecoveryServicesBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmRecoveryServicesBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmRecoveryServicesBackupRecoveryPoint</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesBackupRecoveryPoint</command:noun> <maml:description><maml:para>Gets the recovery points for a backed up item. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmRecoveryServicesBackupRecoveryPoint cmdlet gets the recovery points for a backed up Azure Backup item. After an item has been backed up, an AzureRmRecoveryServicesBackupRecoveryPoint object has one or more recovery points. </maml:para> <maml:para>Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmRecoveryServicesBackupRecoveryPoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>StartDate</maml:name> <maml:Description><maml:para>Specifies the start of the date range. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>EndDate</maml:name> <maml:Description><maml:para>Specifies the end of the date range. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>Specifies the item for which this cmdlet gets recovery points. To obtain an AzureRmRecoveryServicesBackupItem object, use the Get-AzureRmRecoveryServicesBackupItem cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ItemBase</command:parameterValue> <dev:type><maml:name>ItemBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmRecoveryServicesBackupRecoveryPoint</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>RecoveryPointId</maml:name> <maml:Description><maml:para>Specifies the recovery point ID. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>Specifies the item for which this cmdlet gets recovery points. To obtain an AzureRmRecoveryServicesBackupItem object, use the Get-AzureRmRecoveryServicesBackupItem cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ItemBase</command:parameterValue> <dev:type><maml:name>ItemBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>KeyFileDownloadLocation</maml:name> <maml:Description><maml:para>Specifies the location to download the input file to restore the KeyVault key for an encrypted virtual machine. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>EndDate</maml:name> <maml:Description><maml:para>Specifies the end of the date range. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>Specifies the item for which this cmdlet gets recovery points. To obtain an AzureRmRecoveryServicesBackupItem object, use the Get-AzureRmRecoveryServicesBackupItem cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ItemBase</command:parameterValue> <dev:type><maml:name>ItemBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>KeyFileDownloadLocation</maml:name> <maml:Description><maml:para>Specifies the location to download the input file to restore the KeyVault key for an encrypted virtual machine. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>RecoveryPointId</maml:name> <maml:Description><maml:para>Specifies the recovery point ID. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>StartDate</maml:name> <maml:Description><maml:para>Specifies the start of the date range. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>ItemBase</maml:name> </dev:type> <maml:description><maml:para>Parameter 'Item' accepts value of type 'ItemBase' from the pipeline </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> <command:returnValue><dev:type><maml:name>System.Collections.Generic.IList`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get recovery points from the last week for an item</maml:title> <dev:code>PS C:\> $StartDate = (Get-Date).AddDays(-7) PS C:\> $EndDate = Get-Date PS C:\> $Container = Get-AzureRmRecoveryServicesBackupContainer -ContainerType AzureVM -Status Registered -Name "V2VM" PS C:\> $BackupItem = Get-AzureRmRecoveryServicesBackupItem -ContainerType AzureVM -WorkloadType AzureVM PS C:\> $RP = Get-AzureRmRecoveryServicesBackupRecoveryPoint -Item $BackupItem -StartDate $Startdate.ToUniversalTime() -EndDate $Enddate.ToUniversalTime()</dev:code> <dev:remarks><maml:para>The first command gets the date from seven days ago, and then stores it in the $StartDate variable. </maml:para> <maml:para>The second command gets today's date, and then stores it in the $EndDate variable. </maml:para> <maml:para>The third command gets AzureVM backup containers, and stores them in the $Containers variable. </maml:para> <maml:para>The fourth command gets the backup item named V2VM, and then stores it in the $BackupItem variable. </maml:para> <maml:para>The last command gets an array of recovery points for the item in $BackupItem, and then stores them in the $RP variable. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackuprecoverypoint</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupContainer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmRecoveryServicesBackupRetentionPolicyObject</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesBackupRetentionPolicyObject</command:noun> <maml:description><maml:para>Gets a base retention policy object. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmRecoveryServicesBackupRetentionPolicyObject cmdlet gets a base AzureRMRecoveryServicesRetentionPolicyObject . This object is not persisted in the system. It is a temporary object that you can manipulate and use with the New-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet to create a new backup policy. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmRecoveryServicesBackupRetentionPolicyObject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>WorkloadType</maml:name> <maml:Description><maml:para>Specifies the workload type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- AzureSQLDatabase </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureSQLDatabase</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WorkloadType</command:parameterValue> <dev:type><maml:name>WorkloadType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>BackupManagementType</maml:name> <maml:Description><maml:para>Specifies the Backup management type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- AzureSQLDatabase </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> <command:parameterValue required="false" variableLength="false">MARS</command:parameterValue> <command:parameterValue required="false" variableLength="false">SCDPM</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureBackupServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureSQL</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">BackupManagementType</command:parameterValue> <dev:type><maml:name>BackupManagementType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>BackupManagementType</maml:name> <maml:Description><maml:para>Specifies the Backup management type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- AzureSQLDatabase </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BackupManagementType</command:parameterValue> <dev:type><maml:name>BackupManagementType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>WorkloadType</maml:name> <maml:Description><maml:para>Specifies the workload type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- AzureSQLDatabase </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">WorkloadType</command:parameterValue> <dev:type><maml:name>WorkloadType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RetentionPolicyBase</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create a backup protection policy</maml:title> <dev:code>PS C:\>$RetPol = Get-AzureRmRecoveryServicesBackupRetentionPolicyObject -WorkloadType AzureVM PS C:\> $RetPol.DailySchedule.DurationCountInDays = 365 PS C:\> $SchPol = Get-AzureRmRecoveryServicesBackupSchedulePolicyObject -WorkloadType AzureVM PS C:\> New-AzureRmRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" -WorkloadType AzureVM -RetentionPolicy $RetPol -SchedulePolicy $SchPol</dev:code> <dev:remarks><maml:para>The first command gets the retention policy object, and then stores it in the $RetPol variable. </maml:para> <maml:para>The second command sets the duration for the retention policy object to 365 days. </maml:para> <maml:para>The third command gets the schedule policy object, and then stores it in the $SchPol variable. </maml:para> <maml:para>The last command creates a backup protection policy using the retention policy and schedule policy created with the previous commands. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackupretentionpolicyobject</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupSchedulePolicyObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmRecoveryServicesBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmRecoveryServicesBackupRPMountScript</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesBackupRPMountScript</command:noun> <maml:description><maml:para>Downloads a script to mount all the files of the recovery point. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmRecoveryServicesBackupRPMountScript cmdlet downloads a script which mounts the volumes of the recovery point on the machine where it is run. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmRecoveryServicesBackupRPMountScript</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>RecoveryPoint</maml:name> <maml:Description><maml:para>Recovery point object to be restored </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RecoveryPointBase</command:parameterValue> <dev:type><maml:name>RecoveryPointBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Path</maml:name> <maml:Description><maml:para>Location where the file should be downloaded in the case of file recovery. If -Path is not provided, the script file will be downloaded in the current directory. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Path</maml:name> <maml:Description><maml:para>Location where the file should be downloaded in the case of file recovery. If -Path is not provided, the script file will be downloaded in the current directory. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>RecoveryPoint</maml:name> <maml:Description><maml:para>Recovery point object to be restored </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RecoveryPointBase</command:parameterValue> <dev:type><maml:name>RecoveryPointBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RecoveryPointBase</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.RPMountScriptDetails</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Mount a recovery point</maml:title> <dev:code>PS C:\> $namedContainer = Get-AzureRmRecoveryServicesBackupContainer -ContainerType "AzureVM" -Status "Registered" -FriendlyName "V2VM" PS C:\> $backupitem = Get-AzureRmRecoveryServicesBackupItem -Container $namedContainer -WorkloadType "AzureVM" PS C:\> $startDate = (Get-Date).AddDays(-7) PS C:\> $endDate = Get-Date PS C:\> $rp = Get-AzureRmRecoveryServicesBackupRecoveryPoint -Item $backupitem -StartDate $startdate.ToUniversalTime() -EndDate $enddate.ToUniversalTime() To mount files of the latest recovery point, obtain the script by PS C:\> Get-AzureRmRecoveryServicesBackupRPMountScript -RecoveryPoint $rp[0] OsType Password Filename ------ -------- -------- Windows e3632984e51f496 V2VM_wus2_8287309959960546283_451516692429_cbd6061f7fc543c489f1974d33659fed07a6e0c2e08740.exe</dev:code> <dev:remarks><maml:para>When the script is run, it will mount the files of the recovery point $rp[0] </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmRecoveryServicesBackupSchedulePolicyObject</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesBackupSchedulePolicyObject</command:noun> <maml:description><maml:para>Gets a base schedule policy object. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmRecoveryServicesBackupSchedulePolicyObject cmdlet gets a base AzureRMRecoveryServicesSchedulePolicyObject . This object is not persisted in the system. It is temporary object that you can manipulate and use with the New-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet to create a new backup protection policy. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmRecoveryServicesBackupSchedulePolicyObject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>WorkloadType</maml:name> <maml:Description><maml:para>Specifies the workload type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- AzureSQLDatabase </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureSQLDatabase</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WorkloadType</command:parameterValue> <dev:type><maml:name>WorkloadType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>BackupManagementType</maml:name> <maml:Description><maml:para>Specifies the Backup management type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- AzureSQLDatabase </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> <command:parameterValue required="false" variableLength="false">MARS</command:parameterValue> <command:parameterValue required="false" variableLength="false">SCDPM</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureBackupServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureSQL</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">BackupManagementType</command:parameterValue> <dev:type><maml:name>BackupManagementType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>BackupManagementType</maml:name> <maml:Description><maml:para>Specifies the Backup management type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- AzureSQLDatabase </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BackupManagementType</command:parameterValue> <dev:type><maml:name>BackupManagementType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>WorkloadType</maml:name> <maml:Description><maml:para>Specifies the workload type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- AzureSQLDatabase </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">WorkloadType</command:parameterValue> <dev:type><maml:name>WorkloadType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.SchedulePolicyBase</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Set the schedule frequency to weekly</maml:title> <dev:code>PS C:\>$RetPol = Get-AzureRmRecoveryServicesBackupRetentionPolicyObject -WorkloadType "AzureVM" PS C:\> $SchPol = Get-AzureRmRecoveryServicesBackupSchedulePolicyObject -WorkloadType "AzureVM" PS C:\> $SchPol.ScheduleRunFrequency = "Weekly" PS C:\> New-AzureRmRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" -WorkloadType AzureVM -RetentionPolicy $RetPol -SchedulePolicy $SchPol</dev:code> <dev:remarks><maml:para>The first command gets the retention policy object, and then stores it in the $RetPol variable. </maml:para> <maml:para>The second command gets the schedule policy object, and then stores it in the $SchPol variable. </maml:para> <maml:para>The third command changes the frequency for the schedule policy to weekly. </maml:para> <maml:para>The last command creates a backup protection policy with the updated schedule. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Set the backup time</maml:title> <dev:code>PS C:\>$SchPol = Get-AzureRmRecoveryServicesBackupSchedulePolicyObject -WorkloadType "AzureVM" PS C:\> $SchPol.ScheduleRunTimes.RemoveAll() PS C:\> $DT = Get-Date PS C:\> $SchPol.ScheduleRunTimes.Add($DT.ToUniversalTime()) PS C:\> New-AzureRmRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" -WorkloadType AzureVM -RetentionPolicy $RetPol -SchedulePolicy $SchPol</dev:code> <dev:remarks><maml:para>The first command gets the schedule policy object, and then stores it in the $SchPol variable. </maml:para> <maml:para>The second command removes all scheduled run times from $SchPol. </maml:para> <maml:para>The third command gets the current date and time, and then stores it in the $DT variable. </maml:para> <maml:para>The fourth command replaces the scheduled run times with the current time. You can only backup AzureVM once per day, so to reset the backup time you must replace the original schedule. </maml:para> <maml:para>The last command creates a backup protection policy using the new schedule. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackupschedulepolicyobject</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmRecoveryServicesBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmRecoveryServicesBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmRecoveryServicesBackupProtectionPolicy</command:name> <command:verb>New</command:verb> <command:noun>AzureRmRecoveryServicesBackupProtectionPolicy</command:noun> <maml:description><maml:para>Creates a Backup protection policy. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet creates a Backup protection policy in a vault. A protection policy is associated with at least one retention policy. The retention policy defines how long a recovery point is kept with Azure Backup. </maml:para> <maml:para>You can use the Get-AzureRmRecoveryServicesBackupRetentionPolicyObject cmdlet to get the default retention policy. And you can use the Get-AzureRmRecoveryServicesBackupSchedulePolicyObject cmdlet to get the default schedule policy. The SchedulePolicy and RetentionPolicy objects are used as inputs to the New-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet. </maml:para> <maml:para>Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmRecoveryServicesBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>WorkloadType</maml:name> <maml:Description><maml:para>Specifies the workload type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- AzureSQLDatabase </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureSQLDatabase</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WorkloadType</command:parameterValue> <dev:type><maml:name>WorkloadType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"><maml:name>BackupManagementType</maml:name> <maml:Description><maml:para>Specifies the Backup management type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- AzureSQLDatabase </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> <command:parameterValue required="false" variableLength="false">MARS</command:parameterValue> <command:parameterValue required="false" variableLength="false">SCDPM</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureBackupServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureSQL</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">BackupManagementType</command:parameterValue> <dev:type><maml:name>BackupManagementType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none"><maml:name>RetentionPolicy</maml:name> <maml:Description><maml:para>Specifies the base RetentionPolicy object. You can use the Get-AzureRmRecoveryServicesBackupRetentionPolicyObject cmdlet to get a RetentionPolicy object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RetentionPolicyBase</command:parameterValue> <dev:type><maml:name>RetentionPolicyBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases="none"><maml:name>SchedulePolicy</maml:name> <maml:Description><maml:para>Specifies the base SchedulePolicy object. You can use the Get-AzureRmRecoveryServicesBackupSchedulePolicyObject cmdlet to get a SchedulePolicy object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SchedulePolicyBase</command:parameterValue> <dev:type><maml:name>SchedulePolicyBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"><maml:name>BackupManagementType</maml:name> <maml:Description><maml:para>Specifies the Backup management type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- AzureSQLDatabase </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BackupManagementType</command:parameterValue> <dev:type><maml:name>BackupManagementType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none"><maml:name>RetentionPolicy</maml:name> <maml:Description><maml:para>Specifies the base RetentionPolicy object. You can use the Get-AzureRmRecoveryServicesBackupRetentionPolicyObject cmdlet to get a RetentionPolicy object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RetentionPolicyBase</command:parameterValue> <dev:type><maml:name>RetentionPolicyBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases="none"><maml:name>SchedulePolicy</maml:name> <maml:Description><maml:para>Specifies the base SchedulePolicy object. You can use the Get-AzureRmRecoveryServicesBackupSchedulePolicyObject cmdlet to get a SchedulePolicy object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SchedulePolicyBase</command:parameterValue> <dev:type><maml:name>SchedulePolicyBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>WorkloadType</maml:name> <maml:Description><maml:para>Specifies the workload type. The acceptable values for this parameter are: </maml:para> <maml:para>- AzureVM </maml:para> <maml:para>- AzureSQLDatabase </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">WorkloadType</command:parameterValue> <dev:type><maml:name>WorkloadType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create a Backup protection policy</maml:title> <dev:code>PS C:\> $SchPol = Get-AzureRmRecoveryServicesBackupSchedulePolicyObject -WorkloadType "AzureVM" PS C:\> $SchPol.ScheduleRunTimes.RemoveAll() PS C:\> $Dt = Get-Date PS C:\> $SchPol.ScheduleRunTimes.Add($Dt.ToUniversalTime()) PS C:\> $RetPol = Get-AzureRmRecoveryServicesBackupRetentionPolicyObject -WorkloadType "AzureVM" PS C:\> $RetPol.DailySchedule.DurationCountInDays = 365 PS C:\> New-AzureRmRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" -WorkloadType AzureVM -RetentionPolicy $RetPol -SchedulePolicy $SchPol</dev:code> <dev:remarks><maml:para>The first command gets a base SchedulePolicyObject , and then stores it in the $SchPol variable. </maml:para> <maml:para>The second command removes all scheduled run times from the schedule policy in $SchPol. </maml:para> <maml:para>The third command uses the Get-Date cmdlet to get the current date and time. </maml:para> <maml:para>The fourth command adds the current date and time in $Dt as the scheduled run time to the schedule policy. </maml:para> <maml:para>The fifth command gets a base RetentionPolicy object, and then stores it in the $RetPol variable. </maml:para> <maml:para>The sixth command sets the retention duration policy to 365 days. </maml:para> <maml:para>The final command creates a BackupProtectionPolicy object based on the schedule and retention policies created by the previous commands. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/new-azurermrecoveryservicesbackupprotectionpolicy</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Enable-AzureRmRecoveryServicesBackupProtection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupRetentionPolicyObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupSchedulePolicyObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmRecoveryServicesBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmRecoveryServicesBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmRecoveryServicesBackupProtectionPolicy</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmRecoveryServicesBackupProtectionPolicy</command:noun> <maml:description><maml:para>Deletes a Backup protection policy from a vault. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet deletes backup policies for a vault. </maml:para> <maml:para>Before you can delete a Backup protection policy, the policy must not have any associated Backup items. Before you delete the policy, make sure that each associated item is associated with some other policy. To associate another policy with a Backup item, use the Enable-AzureRmRecoveryServicesBackupProtection cmdlet. </maml:para> <maml:para>Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmRecoveryServicesBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the Backup protection policy to remove. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Return the policy to be deleted. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Remove-AzureRmRecoveryServicesBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>Policy</maml:name> <maml:Description><maml:para>Specifies the Backup protection policy to remove. To obtain an BackupPolicy object, use the Get-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PolicyBase</command:parameterValue> <dev:type><maml:name>PolicyBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Return the policy to be deleted. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the Backup protection policy to remove. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Return the policy to be deleted. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>Policy</maml:name> <maml:Description><maml:para>Specifies the Backup protection policy to remove. To obtain an BackupPolicy object, use the Get-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PolicyBase</command:parameterValue> <dev:type><maml:name>PolicyBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>PolicyBase</maml:name> </dev:type> <maml:description><maml:para>Parameter 'Policy' accepts value of type 'PolicyBase' from the pipeline </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Remove a policy</maml:title> <dev:code>PS C:\>$Pol= Get-AzureRmRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" PS C:\> Remove-AzureRmRecoveryServicesBackupProtectionPolicy -Policy $Pol</dev:code> <dev:remarks><maml:para>The first command gets the Backup protection policy named NewPolicy, and then stores it in the $Pol variable. </maml:para> <maml:para>The second command removes the policy object in $Pol. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/remove-azurermrecoveryservicesbackupprotectionpolicy</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmRecoveryServicesBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmRecoveryServicesBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Restore-AzureRmRecoveryServicesBackupItem</command:name> <command:verb>Restore</command:verb> <command:noun>AzureRmRecoveryServicesBackupItem</command:noun> <maml:description><maml:para>Restores the data and configuration for a Backup item to a recovery point. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Restore-AzureRmRecoveryServicesBackupItem cmdlet restores the data and configuration for an Azure Backup item to a specified recovery point. This cmdlet starts the restore from the Recovery Services vault to customer's storage account. </maml:para> <maml:para>The restore operation does not restore the full virtual machine. It restores the disk data and configuration information. After the restore operation is finished, you must create the virtual machine and start it. </maml:para> <maml:para>Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Restore-AzureRmRecoveryServicesBackupItem</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>RecoveryPoint</maml:name> <maml:Description><maml:para>Specifies the recovery point to which to restore the virtual machine. To obtain an AzureRmRecoveryServicesBackupRecoveryPoint object, use the Get-AzureRmRecoveryServicesBackupRecoveryPoint cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RecoveryPointBase</command:parameterValue> <dev:type><maml:name>RecoveryPointBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>StorageAccountName</maml:name> <maml:Description><maml:para>Specifies the name of the target Storage account in your subscription. As a part of the restore process, this cmdlet stores the disks and the configuration information in this Storage account. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>StorageAccountResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group that contains the target Storage account in your subscription. As a part of the restore process, this cmdlet stores the disks and the configuration information in this Storage account. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>RecoveryPoint</maml:name> <maml:Description><maml:para>Specifies the recovery point to which to restore the virtual machine. To obtain an AzureRmRecoveryServicesBackupRecoveryPoint object, use the Get-AzureRmRecoveryServicesBackupRecoveryPoint cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RecoveryPointBase</command:parameterValue> <dev:type><maml:name>RecoveryPointBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>StorageAccountName</maml:name> <maml:Description><maml:para>Specifies the name of the target Storage account in your subscription. As a part of the restore process, this cmdlet stores the disks and the configuration information in this Storage account. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>StorageAccountResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group that contains the target Storage account in your subscription. As a part of the restore process, this cmdlet stores the disks and the configuration information in this Storage account. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>RecoveryPointBase</maml:name> </dev:type> <maml:description><maml:para>Parameter 'RecoveryPoint' accepts value of type 'RecoveryPointBase' from the pipeline </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Restore an item to a recovery point</maml:title> <dev:code>PS C:\>$Container = Get-AzureRmRecoveryServicesBackupContainer -ContainerType AzureVM -Status Registered -Name "V2VM" PS C:\> $BackupItem = Get-AzureRmRecoveryServicesBackupItem -ContainerType AzureVM -WorkloadType AzureVM PS C:\> $StartDate = (Get-Date).AddDays(-7) PS C:\> $EndDate = Get-Date PS C:\> $RP = Get-AzureRmRecoveryServicesBackupRecoveryPoint -Item $BackupItem -StartDate $StartDate.ToUniversalTime() -EndDate $EndDate.ToUniversalTime() PS C:\> $RestoreJob = Restore-AzureRmRecoveryServicesBackupItem -RecoveryPoint $RP[0] -StorageAccountName "DestAccount" -StorageAccountResourceGroupName "DestRG" WorkloadName Operation Status StartTime EndTime ------------ --------- ------ --------- ------- V2VM Restore InProgress 26-Apr-16 1:14:01 PM 01-Jan-01 12:00:00 AM</dev:code> <dev:remarks><maml:para>The first command gets the Backup container of type AzureVM, and then stores it in the $Container variable. </maml:para> <maml:para>The second command gets the Backup item named V2VM from $Container, and then stores it in the $BackupItem variable. </maml:para> <maml:para>The third command gets the date from seven days earlier, and then stores it in the $StartDate variable. </maml:para> <maml:para>The fourth command gets the current date, and then stores it in the $EndDate variable. </maml:para> <maml:para>The fifth command gets a list of recovery points for the specific backup item filtered by $StartDate and $EndDate. The date range specified is the last 7 days. </maml:para> <maml:para>The last command restores the disks to the target storage account DestAccount in the DestRG resource group. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/restore-azurermrecoveryservicesbackupitem</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Backup-AzureRmRecoveryServicesBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupRecoveryPoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmRecoveryServicesBackupProtectionPolicy</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmRecoveryServicesBackupProtectionPolicy</command:noun> <maml:description><maml:para>Modifies a Backup protection policy. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmBackupProtectionPolicy cmdlet modifies an existing Azure Backup protection policy. You can modify the Backup schedule and retention policy components. </maml:para> <maml:para>Any changes you make affect the backup and retention of the items associated with the policy. </maml:para> <maml:para>Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmRecoveryServicesBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>Policy</maml:name> <maml:Description><maml:para>Specifies the Backup protection policy that this cmdlet modifies. To obtain a BackupProtectionPolicy object, use the Get-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PolicyBase</command:parameterValue> <dev:type><maml:name>PolicyBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>RetentionPolicy</maml:name> <maml:Description><maml:para>Specifies the base retention policy. To obtain a RetentionPolicy object, use the Get-AzureRmRecoveryServicesBackupRetentionPolicyObject cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RetentionPolicyBase</command:parameterValue> <dev:type><maml:name>RetentionPolicyBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>SchedulePolicy</maml:name> <maml:Description><maml:para>Specifies the base schedule policy object. To obtain a SchedulePolicy object, use the Get-AzureRmRecoveryServicesBackupSchedulePolicyObject object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SchedulePolicyBase</command:parameterValue> <dev:type><maml:name>SchedulePolicyBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>Policy</maml:name> <maml:Description><maml:para>Specifies the Backup protection policy that this cmdlet modifies. To obtain a BackupProtectionPolicy object, use the Get-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PolicyBase</command:parameterValue> <dev:type><maml:name>PolicyBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>RetentionPolicy</maml:name> <maml:Description><maml:para>Specifies the base retention policy. To obtain a RetentionPolicy object, use the Get-AzureRmRecoveryServicesBackupRetentionPolicyObject cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RetentionPolicyBase</command:parameterValue> <dev:type><maml:name>RetentionPolicyBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>SchedulePolicy</maml:name> <maml:Description><maml:para>Specifies the base schedule policy object. To obtain a SchedulePolicy object, use the Get-AzureRmRecoveryServicesBackupSchedulePolicyObject object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SchedulePolicyBase</command:parameterValue> <dev:type><maml:name>SchedulePolicyBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>PolicyBase</maml:name> </dev:type> <maml:description><maml:para>Parameter 'Policy' accepts value of type 'PolicyBase' from the pipeline </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>System.Collections.Generic.List`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Modify a Backup protection policy</maml:title> <dev:code>PS C:\>$SchPol = Get-AzureRmRecoveryServicesBackupSchedulePolicyObject -WorkloadType "AzureVM" PS C:\> $SchPol.ScheduleRunTimes.RemoveAll() PS C:\> $DT = Get-Date PS C:\> $SchPol.ScheduleRunTimes.Add($DT.ToUniversalTime()) PS C:\> $RetPol = Get-AzureRmRecoveryServicesBackupRetentionPolicyObject -WorkloadType "AzureVM" PS C:\> $RetPol.DailySchedule.DurationCountInDays = 365 PS C:\> $Pol = Get-AzureRmRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" PS C:\> Set-AzureRmRecoveryServicesBackupProtectionPolicy -Policy $Pol -SchedulePolicy $SchPol -RetentionPolicy $RetPol</dev:code> <dev:remarks><maml:para>The first command gets a base SchedulePolicy object, and then stores it in the $SchPol variable. </maml:para> <maml:para>The second command removes all scheduled run times from the schedule policy in $SchPol. </maml:para> <maml:para>The third command uses the Get-Date cmdlet to get the current date and time, and then stores it in the $DT variable. </maml:para> <maml:para>The fourth command adds the date and time in $DT to the schedule run time for the schedule policy. </maml:para> <maml:para>The fifth command gets a base retention policy object, and then stores it in the $RetPol variable. </maml:para> <maml:para>The sixth command sets the retention duration to 365 days. </maml:para> <maml:para>The seventh command gets the Backup protection policy named NewPolicy, and then stores it in the $Pol variable. </maml:para> <maml:para>The final command modifies the Backup protection policy in $Pol using schedule policy in $SchPol and the retention policy in $RetPol. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/set-azurermrecoveryservicesbackupprotectionpolicy</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupRetentionPolicyObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmRecoveryServicesBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmRecoveryServicesBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Stop-AzureRmRecoveryServicesBackupJob</command:name> <command:verb>Stop</command:verb> <command:noun>AzureRmRecoveryServicesBackupJob</command:noun> <maml:description><maml:para>Cancels a running job. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Stop-AzureRmRecoveryServicesBackupJob cmdlet cancels an existing Azure Backup job. Use this cmdlet to stop a job that takes too long and blocks other activities. </maml:para> <maml:para>You can cancel only Backup and Restore job types. </maml:para> <maml:para>Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Stop-AzureRmRecoveryServicesBackupJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Job</maml:name> <maml:Description><maml:para>Specifies a job that this cmdlet cancels. To obtain a BackupJob object, use the Get-AzureRmRecoveryServicesBackupJob cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">JobBase</command:parameterValue> <dev:type><maml:name>JobBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Stop-AzureRmRecoveryServicesBackupJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>JobId</maml:name> <maml:Description><maml:para>Specifies the ID of the job to cancel. The ID is the InstanceId property of a BackupJob object. To obtain an BackupJob object, use Get-AzureRmRecoveryServicesBackupJob. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Job</maml:name> <maml:Description><maml:para>Specifies a job that this cmdlet cancels. To obtain a BackupJob object, use the Get-AzureRmRecoveryServicesBackupJob cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">JobBase</command:parameterValue> <dev:type><maml:name>JobBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>JobId</maml:name> <maml:Description><maml:para>Specifies the ID of the job to cancel. The ID is the InstanceId property of a BackupJob object. To obtain an BackupJob object, use Get-AzureRmRecoveryServicesBackupJob. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Stop a backup job</maml:title> <dev:code>PS C:\>$Job = Get-AzureRmRecoveryServicesBackupJob -Operation Backup PS C:\> Stop-AzureRmRecoveryServicesBackupJob -JobID $Job.InstanceId</dev:code> <dev:remarks><maml:para>The first command gets a backup job, and then stores the job in the $Job variable. </maml:para> <maml:para>The last command stops the job by specifying the Instance ID of the backup job in $Job. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/stop-azurermrecoveryservicesbackupjob</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Wait-AzureRmRecoveryServicesBackupJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Unregister-AzureRmRecoveryServicesBackupContainer</command:name> <command:verb>Unregister</command:verb> <command:noun>AzureRmRecoveryServicesBackupContainer</command:noun> <maml:description><maml:para>Unregisters a Windows Server or other container from the vault. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Unregister-AzureRmRecoveryServicesBackupContainer cmdlet unregisters a Windows Server or other Backup container from the vault. This cmdlet removes references to a container from the vault. Before you can unregister a container, you must delete any protected data associated with that container. </maml:para> <maml:para>Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Unregister-AzureRmRecoveryServicesBackupContainer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Container</maml:name> <maml:Description><maml:para>Specifies a Backup container object to unregister. To obtain a BackupContainer object, use the Get-AzureRmRecoveryServicesBackupContainer cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ContainerBase</command:parameterValue> <dev:type><maml:name>ContainerBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Return the container to be deleted. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Container</maml:name> <maml:Description><maml:para>Specifies a Backup container object to unregister. To obtain a BackupContainer object, use the Get-AzureRmRecoveryServicesBackupContainer cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ContainerBase</command:parameterValue> <dev:type><maml:name>ContainerBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Return the container to be deleted. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Unregister a Windows Server from the vault</maml:title> <dev:code>PS C:\>$Cont = Get-AzureRmRecoveryServicesContainer -ContainerType "Windows" -BackupManagementType MARS -Name "server01.contoso.com" PS C:\> Unregister-AzureRmRecoveryServicesBackupContainer -Container $Cont</dev:code> <dev:remarks><maml:para>The first command gets the Windows container named server01.contoso.com that is registered in the vault, and then stores it in the $Cont variable. </maml:para> <maml:para>The second command unregisters the specified Windows Server from the Azure Backup vault. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/unregister-azurermrecoveryservicesbackupcontainer</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupContainer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Unregister-AzureRmRecoveryServicesBackupManagementServer</command:name> <command:verb>Unregister</command:verb> <command:noun>AzureRmRecoveryServicesBackupManagementServer</command:noun> <maml:description><maml:para>Unregisters a SCDPM server or Backup server from the vault. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Unregister-AzureRmRecoveryServicesBackupManagementServer cmdlet unregisters a System Center Data Protection Manager (SCDPM) server or an Azure Backup server from the vault. This cmdlet removes references to the servers that are unregistered from the vault. </maml:para> <maml:para>Before you can unregister a container, you must delete any protected data associated with that container. </maml:para> <maml:para>Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Unregister-AzureRmRecoveryServicesBackupManagementServer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>AzureRmBackupManagementServer</maml:name> <maml:Description><maml:para>Specifies an SCDPM server object to unregister. To obtain an BackupManagementServer object, use the Get-AzureRmRecoveryServicesBackupManagementServer cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BackupEngineBase</command:parameterValue> <dev:type><maml:name>BackupEngineBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Return the Backup Management Server to be deleted. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>AzureRmBackupManagementServer</maml:name> <maml:Description><maml:para>Specifies an SCDPM server object to unregister. To obtain an BackupManagementServer object, use the Get-AzureRmRecoveryServicesBackupManagementServer cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">BackupEngineBase</command:parameterValue> <dev:type><maml:name>BackupEngineBase</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Return the Backup Management Server to be deleted. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Unregister an SCDPM server from the vault</maml:title> <dev:code>PS C:\>$BMS = Get-AzureRmRecoveryServicesBackupManagementServer -Name "dpmserver01.contoso.com" PS C:\> Unregister-AzureRmRecoveryServicesBackupManagementServer -AzureRmBackupManagementServer $BMS</dev:code> <dev:remarks><maml:para>The first command gets the Backup management server named dpmserver01.contoso.com, and then stores it in the $BMS variable. </maml:para> <maml:para>The second command unregisters the SCDPM server from the vault. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/unregister-azurermrecoveryservicesbackupmanagementserver</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupManagementServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Wait-AzureRmRecoveryServicesBackupJob</command:name> <command:verb>Wait</command:verb> <command:noun>AzureRmRecoveryServicesBackupJob</command:noun> <maml:description><maml:para>Waits for a Backup job to finish. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Wait-AzureRmRecoveryServicesBackupJob cmdlet waits for an Azure Backup job to finish. Backup jobs can take a long time. If you run a backup job as part of a script, you may want to force the script to wait for job to finish before it continues to other tasks. </maml:para> <maml:para>A script that includes this cmdlet can be simpler than one that polls the Backup service for the job status. </maml:para> <maml:para>Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Wait-AzureRmRecoveryServicesBackupJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>Job</maml:name> <maml:Description><maml:para>Specifies the job to wait for. To obtain a BackupJob object, use the Get-AzureRmRecoveryServicesBackupJob cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type><maml:name>Object</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Timeout</maml:name> <maml:Description><maml:para>Specifies the maximum time, in seconds, that this cmdlet waits for the job to finish. It is recommended to specify a time-out value. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type><maml:name>Int64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>Job</maml:name> <maml:Description><maml:para>Specifies the job to wait for. To obtain a BackupJob object, use the Get-AzureRmRecoveryServicesBackupJob cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type><maml:name>Object</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Timeout</maml:name> <maml:Description><maml:para>Specifies the maximum time, in seconds, that this cmdlet waits for the job to finish. It is recommended to specify a time-out value. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type><maml:name>Int64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>Object</maml:name> </dev:type> <maml:description><maml:para>Parameter 'Job' accepts value of type 'Object' from the pipeline </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> <command:returnValue><dev:type><maml:name>System.Collections.Generic.IList`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Wait for a job to finish</maml:title> <dev:code>PS C:\> $Jobs = Get-AzureRmRecoveryServicesBackupJob -Status InProgress $Job = $Jobs[0] while ( $Job.Status -ne Completed ) { Write-Host "Waiting for completion..." Start-Sleep -Seconds 10 $Job = Get-AzureRmBackAzureRmRecoveryServicesBackupJob -Job $Job } Write-Host "Done!" Waiting for completion... Waiting for completion... Waiting for completion... Done!</dev:code> <dev:remarks><maml:para>This script polls the first job that is currently in progress until the job has completed. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/wait-azurermrecoveryservicesbackupjob</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |