Microsoft.Azure.Commands.RecoveryServices.Backup.dll-help.xml
|
<?xml version="1.0" encoding="utf-8"?><helpItems 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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Backup-AzureRmRecoveryServicesBackupItem</command:name> <maml:description> <maml:para>Starts a backup for a Backup item.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Backup</command:verb> <command:noun>AzureRmRecoveryServicesBackupItem</command:noun> <dev:version /> </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 before getting started Set-AzureRmRecoveryServicesVaultContext </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Backup-AzureRmRecoveryServicesBackupItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$namedContainer = Get-AzureRmRecoveryServicesContainer -ContainerType "AzureVM" -Status "Registered" -Name "pstestv2vm1"; $item = Get-AzureRmRecoveryServicesBackupItem -Container $namedContainer -WorkloadType "AzureVM"; $job = Backup-AzureRmRecoveryServicesItem -Item $item; </dev:code> <dev:remarks> <maml:para>The first command gets the container of type AzureVM of a specific name The second command gets the backup item corresponding to the container The last command triggers the backup job for the specific backup item</maml:para> <maml:para /> <maml:para /> <maml:para>WorkloadName Operation Status StartTime EndTime InstanceID ------------ --------- ------ --------- ------- ---------- pstestv2vm1 Backup InProgress 4/23/2016 5:00:30 PM cf4b3ef5-2fac-4c8e-a215-d2eba4124f27 </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmRecoveryServicesBackupItem</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>Set-AzureRmRecoveryServicesVaultContext</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Disable-AzureRmRecoveryServicesBackupProtection</command:name> <maml:description> <maml:para>Disables protection for a Backup protected item.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>AzureRmRecoveryServicesBackupProtection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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 before getting started Set-AzureRmRecoveryServicesVaultContext </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-AzureRmRecoveryServicesBackupProtection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$cont = Get-AzureRmRecoveryServicesBackupContainer -ContainerType AzureVM -Status Registered $pi = Get-AzureRmRecoveryServicesBackupItem -Container $cont[0] -WorkloadType AzureVM Disable-AzureRmRecoveryServicesBackupProtection -Item $pi[0]</dev:code> <dev:remarks> <maml:para>The first command gets an array of backup containers The second command gets the backup item corresponding to the first container item The last command disables backup protection but retains the data</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmRecoveryServicesBackupItem</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>Set-AzureRmRecoveryServicesVaultContext </maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Enable-AzureRmRecoveryServicesBackupProtection</command:name> <maml:description> <maml:para>Enables backup for an item with specified Azure Backup protection policy.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>AzureRmRecoveryServicesBackupProtection</command:noun> <dev:version /> </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 before getting started Set-AzureRmRecoveryServicesVaultContext </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AzureRmRecoveryServicesBackupProtection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the backup item. Specify this </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Applicable only for ARM VMs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Enable-AzureRmRecoveryServicesBackupProtection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the backup item. Specify this </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Applicable only for ASM VMs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Enable-AzureRmRecoveryServicesBackupProtection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the backup item. Specify this </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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Applicable only for ARM VMs</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Applicable only for ASM VMs</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> $pol=Get-AzureRmRecoveryServicesBackupProtectionPolicy -Name "DefaultPolicy" PS C:\> Enable-AzureRmRecoveryServicesBackupProtection -Policy $pol -Name "V2VM" -ResourceGroupName "RGName1" </dev:code> <dev:remarks> <maml:para>The first cmdlet gets a default policy object. The second cmdlet enables protection for ARM VM using the specified policy</maml:para> <maml:para /> <maml:para /> <maml:para>WorkloadName Operation Status StartTime EndTime ------------ --------- ------ --------- ------- co03-vm ConfigureBackup Completed 11-Apr-16 12:19:49 PM 11-Apr-16 12:19:54 PM</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-AzureRmRecoveryServicesVaultContext </maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmRecoveryServicesBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmRecoveryServicesBackupContainer</command:name> <maml:description> <maml:para>Gets Backup containers. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesBackupContainer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>A backup container AzureRmRecoveryServicesBackupContainer encapsulates data sources which are modelled as backup items AzureRmRecoveryServicesBackupItem. </maml:para> <maml:para>Set the vault context before getting started Set-AzureRmRecoveryServicesVaultContext </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmRecoveryServicesBackupContainer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ContainerType</maml:name> <maml:description> <maml:para>Specifies the backup container type. Supported types are AzureVM or Windows</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ContainerType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>BackupManagementType</maml:name> <maml:description> <maml:para>Specifies the backup container type. Supported types are AzureVM or MARS. This 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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the container</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Name of the resourcegroup. Applicable only for Azure resources, namely, Azure VMs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies the state of registration</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ContainerRegistrationStatus</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ContainerType</maml:name> <maml:description> <maml:para>Specifies the backup container type. Supported types are AzureVM or Windows</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>BackupManagementType</maml:name> <maml:description> <maml:para>Specifies the backup container type. Supported types are AzureVM or MARS. This 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Name</maml:name> <maml:description> <maml:para>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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Name of the resourcegroup. Applicable only for Azure resources, namely, Azure VMs.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies the state of registration</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get a specific container --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Get-AzureRmRecoveryServicesContainer -ContainerType "AzureVM" -Status "Registered" -Name "V2VM"; </dev:code> <dev:remarks> <maml:para>Returns a specific container object of type AzureVM and Name "V2VM"</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Get all containers of a specific type --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmRecoveryServicesBackupContainer –ContainerType Windows -BackupManagementType MARS </dev:code> <dev:remarks> <maml:para>Returns all Windows Containers that are protected by Azure Backup agent. BackupManagementType is only required for Windows Containers</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unregister-AzureRmRecoveryServicesBackupContainer</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>Get-AzureRmRecoveryServicesBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmRecoveryServicesBackupItem</command:name> <maml:description> <maml:para>Gets the items under a container in Backup.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesBackupItem</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureRmRecoveryServicesBackupItem cmdlet gets the items in a container in Azure Backup and the protection status of the items. A container that is registered to a 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 before getting started Set-AzureRmRecoveryServicesVaultContext </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmRecoveryServicesBackupItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Container</maml:name> <maml:description> <maml:para>Specifies a container object for 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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the container</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ProtectionStatus</maml:name> <maml:description> <maml:para>Specifies the overall protection status of an item in the container i.e. Healthy and Unhealthy</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ItemProtectionStatus</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ProtectionState</maml:name> <maml:description> <maml:para>Describes the state of protection: IRPending -> Initial synchronization has not started and no recovery point yet Protected -> protection ongoing ProtectionError -> Error ProtectionStopped -> Disabled</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ItemProtectionState</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>WorkloadType</maml:name> <maml:description> <maml:para>Currently supports AzureVM alone</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">WorkloadType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmRecoveryServicesBackupItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>BackupManagementType</maml:name> <maml:description> <maml:para>Used to filter backup items of a certain backup management type. Currently supports AzureVM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BackupManagementType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the container</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ProtectionStatus</maml:name> <maml:description> <maml:para>Specifies the overall protection status of an item in the container i.e. Healthy and Unhealthy</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ItemProtectionStatus</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ProtectionState</maml:name> <maml:description> <maml:para>Describes the state of protection: IRPending -> Initial synchronization has not started and no recovery point yet Protected -> protection ongoing ProtectionError -> Error ProtectionStopped -> Disabled</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ItemProtectionState</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>WorkloadType</maml:name> <maml:description> <maml:para>Currently supports AzureVM alone</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">WorkloadType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ProtectionStatus</maml:name> <maml:description> <maml:para>Specifies the overall protection status of an item in the container i.e. Healthy and 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ProtectionState</maml:name> <maml:description> <maml:para>Describes the state of protection: IRPending -> Initial synchronization has not started and no recovery point yet Protected -> protection ongoing ProtectionError -> Error ProtectionStopped -> 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>WorkloadType</maml:name> <maml:description> <maml:para>Currently supports AzureVM alone</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>BackupManagementType</maml:name> <maml:description> <maml:para>Used to filter backup items of a certain backup management type. Currently supports AzureVM</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Container</maml:name> <maml:description> <maml:para>Specifies a container object for 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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> $Container = Get-AzureRmRecoveryServicesBackupContainer -ContainerType AzureVM –Status Registered PS C:\> $backupitem=Get-AzureRmRecoveryServicesBackupItem –ContainerType AzureVM –WorkloadType AzureVM –Name ‘V2VM’ </dev:code> <dev:remarks> <maml:para>The first command gets the container of type AzureVM The second command gets a specific backup item for the corresponding container</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRecoveryServicesBackupContainer</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> <maml:navigationLink> <maml:linkText>Disable-AzureRmRecoveryServicesBackupProtection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmRecoveryServicesBackupJob</command:name> <maml:description> <maml:para>Gets Backup jobs.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesBackupJob</command:noun> <dev:version /> </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 before getting started Set-AzureRmRecoveryServicesVaultContext </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"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies a status of the jobs that this cmdlet gets. Valid values are: -- InProgress -- Failed -- Cancelled -- Cancelling -- Completed -- CompletedWithWarnings</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[JobStatus]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Operation</maml:name> <maml:description> <maml:para> Specifies an operation of the jobs that this cmdlet gets. Valid values are: -- Backup -- ConfigureBackup -- DeleteBackupData -- Register -- Restore -- UnProtect -- Unregister</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[JobOperation]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="3"> <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="true">Nullable`1[DateTime]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="4"> <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="true">Nullable`1[DateTime]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Job</maml:name> <maml:description> <maml:para> Specifies a job that this cmdlet gets. To obtain an AzureRmRecoveryServicesBackupJob object, use the Get-AzureRmRecoveryServicesBackupJob cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JobBase</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupManagementType</maml:name> <maml:description> <maml:para>Used to filter backup jobs of a certain backup management type. Currently supports AzureVM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[BackupManagementType]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies a status of the jobs that this cmdlet gets. Valid values are: -- InProgress -- Failed -- Cancelled -- Cancelling -- Completed -- CompletedWithWarnings</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[JobStatus]</command:parameterValue> <dev:type> <maml:name>Nullable`1[JobStatus]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Operation</maml:name> <maml:description> <maml:para> Specifies an operation of the jobs that this cmdlet gets. Valid values are: -- Backup -- ConfigureBackup -- DeleteBackupData -- Register -- Restore -- UnProtect -- Unregister</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[JobOperation]</command:parameterValue> <dev:type> <maml:name>Nullable`1[JobOperation]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="3"> <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="true">Nullable`1[DateTime]</command:parameterValue> <dev:type> <maml:name>Nullable`1[DateTime]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="4"> <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="true">Nullable`1[DateTime]</command:parameterValue> <dev:type> <maml:name>Nullable`1[DateTime]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupManagementType</maml:name> <maml:description> <maml:para>Used to filter backup jobs of a certain backup management type. Currently supports AzureVM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[BackupManagementType]</command:parameterValue> <dev:type> <maml:name>Nullable`1[BackupManagementType]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Job</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">AzureRmRecoveryServicesBackupJobBase</command:parameterValue> <dev:type> <maml:name>AzureRmRecoveryServicesBackupJobBase</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Job</maml:name> <maml:description> <maml:para> Specifies a job that this cmdlet gets. To obtain an AzureRmRecoveryServicesBackupJob 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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get all in-progress jobs --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\ > $joblist = Get-AzureRMRecoveryservicesBackupJob –Status Inprogress PS C:\ > $joblist[0] </dev:code> <dev:remarks> <maml:para>To get the latest status of an In-progress job, use the Get-AzureRMRecoveryservicesBackupJob cmdlet.</maml:para> <maml:para /> <maml:para /> <maml:para>WorkloadName Operation Status StartTime EndTime ------------ --------- ------ --------- ------- V2VM Backup InProgress 4/23/2016 5:00:30 PM 1/1/2001 12:00:00 </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Get all failed jobs in the last 7 days --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <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:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3: Get an inprogress job and wait for completion --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <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!"</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> Waiting for completion... Waiting for completion... Waiting for completion... Done!</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmRecoveryServicesBackupJobDetails</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmRecoveryServicesBackupJobDetails</command:name> <maml:description> <maml:para>Gets Backup job details for a specific job.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesBackupJobDetails</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> The Get-AzureRmRecoveryServicesBackupJobDetails cmdlet gets Azure Backup jobs details for a specific vault. Set the vault context before getting started Set-AzureRmRecoveryServicesVaultContext </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmRecoveryServicesBackupJobDetails</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Job</maml:name> <maml:description> <maml:para> Specifies a job for which this cmdlet gets details. To obtain an AzureRmRecoveryServicesBackupJob object, use the Get-AzureRmRecoveryServicesBackupJob cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JobBase</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmRecoveryServicesBackupJobDetails</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the ID of a job for which this cmdlet gets details. 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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the ID of a job for which this cmdlet gets details. 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Job</maml:name> <maml:description> <maml:para> Specifies a job for which this cmdlet gets details. To obtain an AzureRmRecoveryServicesBackupJob 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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <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. The second command returns the error details of the first failed job. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmRecoveryServicesBackupJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmRecoveryServicesBackupManagementServer</command:name> <maml:description> <maml:para>Gets a list of backup management servers.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesBackupManagementServer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List of Backup management servers that are registered in the vault. The two types of backup management servers are SCDPM or Azure Backup Servers that are installed separately to manage backup orchestration.</maml:para> <maml:para>Set the vault context before getting started Set-AzureRmRecoveryServicesVaultContext </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmRecoveryServicesBackupManagementServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the BackupManagementServer</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the BackupManagementServer</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmRecoveryServicesBackupManagementServer</dev:code> <dev:remarks> <maml:para>List all backup management servers registered with the vault</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unregister-AzureRmRecoveryServicesBackupManagementServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmRecoveryServicesBackupProtectionPolicy</command:name> <maml:description> <maml:para>Gets backup policies for the vault.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesBackupProtectionPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> The Get-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet gets backup policies for given vault.</maml:para> <maml:para>Set the vault context before getting started Set-AzureRmRecoveryServicesVaultContext </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmRecoveryServicesBackupProtectionPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmRecoveryServicesBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para> Specifies the name of the policy as stored in the vault</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmRecoveryServicesBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="2"> <maml:name>WorkloadType</maml:name> <maml:description> <maml:para>Specifies the WorkloadType. Specify AzureVM for VM backup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[WorkloadType]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3"> <maml:name>BackupManagementType</maml:name> <maml:description> <maml:para>Specifies the BackupManagementType. Specify AzureVM for VM backup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[BackupManagementType]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmRecoveryServicesBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="2"> <maml:name>WorkloadType</maml:name> <maml:description> <maml:para>Specifies the WorkloadType. Specify AzureVM for VM backup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[WorkloadType]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para> Specifies the name of the policy as stored in the vault</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="2"> <maml:name>WorkloadType</maml:name> <maml:description> <maml:para>Specifies the WorkloadType. Specify AzureVM for VM backup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[WorkloadType]</command:parameterValue> <dev:type> <maml:name>Nullable`1[WorkloadType]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3"> <maml:name>BackupManagementType</maml:name> <maml:description> <maml:para>Specifies the BackupManagementType. Specify AzureVM for VM backup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[BackupManagementType]</command:parameterValue> <dev:type> <maml:name>Nullable`1[BackupManagementType]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get all policies in the vault --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\WINDOWS\system32> Get-AzureRmRecoveryServicesBackupProtectionPolicy </dev:code> <dev:remarks> <maml:para> Lists all protection policies created in the vault.</maml:para> <maml:para /> <maml:para /> <maml:para>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 </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Get a specific policy --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\WINDOWS\system32> $pol= Get-AzureRmRecoveryServicesBackupProtectionPolicy -Name "DefaultPolicy"</dev:code> <dev:remarks> <maml:para>Extracts a specific protection policy in $pol object</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <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> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmRecoveryServicesBackupRecoveryPoint</command:name> <maml:description> <maml:para> Gets the recovery points for a backed up item.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesBackupRecoveryPoint</command:noun> <dev:version /> </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, AzureRmRecoveryServicesBackupRecoveryPoint object has one or more recovery points.</maml:para> <maml:para>Set the vault context before getting started Set-AzureRmRecoveryServicesVaultContext </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmRecoveryServicesBackupRecoveryPoint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Item</maml:name> <maml:description> <maml:para> Specifies the item for which this cmdlet gets recovery points. To obtain an AzureRmRecoveryServicesBackupItem, use the Get-AzureRmRecoveryServicesBackupItem cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ItemBase</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmRecoveryServicesBackupRecoveryPoint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Item</maml:name> <maml:description> <maml:para> Specifies the item for which this cmdlet gets recovery points. To obtain an AzureRmRecoveryServicesBackupItem, use the Get-AzureRmRecoveryServicesBackupItem cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ItemBase</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RecoveryPointId</maml:name> <maml:description> <maml:para>Specifies the recovery point id as an input</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RecoveryPointId</maml:name> <maml:description> <maml:para>Specifies the recovery point id as an input</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Item</maml:name> <maml:description> <maml:para> Specifies the item for which this cmdlet gets recovery points. 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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> $startDate = (Get-Date).AddDays(-7) PS C:\> $endDate = Get-Date PS C:\> $Container = Get-AzureRmRecoveryServicesBackupContainer -ContainerType AzureVM –Status Registered PS C:\> $backupitem=Get-AzureRmRecoveryServicesBackupItem –ContainerType AzureVM –WorkloadType AzureVM –Name ‘V2VM’ PS C:\> $rp = Get-AzureRmRecoveryServicesBackupRecoveryPoint -Item $backupitem -StartDate $startdate.ToUniversalTime() -EndDate $enddate.ToUniversalTime() </dev:code> <dev:remarks> <maml:para>The first and second command sets the date range of last seven days. The third command gets the backup containers of type AzureVM The fourth command gets the backup item V2VM The last command gets an array of recovery points for the given backup item</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Restore-AzureRmRecoveryServicesBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmRecoveryServicesBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmRecoveryServicesBackupRetentionPolicyObject</command:name> <maml:description> <maml:para>Returns a base AzureRMRecoveryServicesRetentionPolicyObject </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesBackupRetentionPolicyObject</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns a base AzureRMRecoveryServicesRetentionPolicyObject. This object is not persisted in the system. It is temporary object can be manipulated and used to create a new backup policy with New-AzureRmRecoveryServicesBackupProtectionPolicy</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmRecoveryServicesBackupRetentionPolicyObject</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkloadType</maml:name> <maml:description> <maml:para>Specifies the workload type. Only applicable to AzureVM workloadtype currently</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">WorkloadType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>BackupManagementType</maml:name> <maml:description> <maml:para>Specifies the Backupmanagement type. Only applicable to AzureVM type currently</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[BackupManagementType]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkloadType</maml:name> <maml:description> <maml:para>Specifies the workload type. Only applicable to AzureVM workloadtype currently</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>BackupManagementType</maml:name> <maml:description> <maml:para>Specifies the Backupmanagement type. Only applicable to AzureVM type currently</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[BackupManagementType]</command:parameterValue> <dev:type> <maml:name>Nullable`1[BackupManagementType]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <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>First command gets the retention policy object. The second command manipulates the retention policy object and sets the retentiontime The third command gets the schedule policy object. The last command creates the Backup protection policy object that is persisted in the system. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <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> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmRecoveryServicesBackupSchedulePolicyObject</command:name> <maml:description> <maml:para>Returns a base AzureRMRecoveryServicesSchedulePolicyObject</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesBackupSchedulePolicyObject</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns a base AzureRMRecoveryServicesSchedulePolicyObject. This object is not persisted in the system. It is temporary object can be manipulated and used to create a new backup policy with New-AzureRMRecoveryServicesSchedulePolicyObject</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmRecoveryServicesBackupSchedulePolicyObject</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkloadType</maml:name> <maml:description> <maml:para>Specifies the workload type. Only applicable to AzureVM workloadtype currently</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">WorkloadType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>BackupManagementType</maml:name> <maml:description> <maml:para>Specifies the backupmanagementtype. Only applicable to AzureVM workloadtype currently</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[BackupManagementType]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkloadType</maml:name> <maml:description> <maml:para>Specifies the workload type. Only applicable to AzureVM workloadtype currently</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>BackupManagementType</maml:name> <maml:description> <maml:para>Specifies the backupmanagementtype. Only applicable to AzureVM workloadtype currently</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[BackupManagementType]</command:parameterValue> <dev:type> <maml:name>Nullable`1[BackupManagementType]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Set the schedule frequency to weekly --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <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>First command gets the retention policy object</maml:para> <maml:para>The second command gets the schedule policy object</maml:para> <maml:para>The third command changes the frequency to weekly</maml:para> <maml:para>Last command creates a new AzureRmRecoveryServicesBackupProtectionPolicy with the specified schedule that is persisted in the system.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Set the backup time --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <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>First command gets a base AzureRmRecoveryServicesBackupSchedulePolicyObject </maml:para> <maml:para>The fourth command replaces the ScheduleRunTimes with current time. Note VM backup supports only once a day backup hence it has to original schedule has to be removed. </maml:para> <maml:para>Last command creates a new AzureRmRecoveryServicesBackupProtectionPolicy with the specified schedule that is persisted in the system.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <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> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureRmRecoveryServicesBackupProtectionPolicy</command:name> <maml:description> <maml:para>Creates a Backup policy with in the vault</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureRmRecoveryServicesBackupProtectionPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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. The default retention policy can be obtained from Get-AzureRmRecoveryServicesBackupRetentionPolicyObject. Similarly the default schedule policy can be obtained from Get-AzureRmRecoveryServicesBackupSchedulePolicyObject. These schedule and retention policy objects are used as inputs to the New-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet</maml:para> <maml:para>Set the vault context before getting started Set-AzureRmRecoveryServicesVaultContext </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmRecoveryServicesBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the policy as stored in the system</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>WorkloadType</maml:name> <maml:description> <maml:para>Specifies the WorkloadType. The specified set of policy parameters are validated against the WorkloadType. Specify AzureVM for VM backup </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">WorkloadType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>BackupManagementType</maml:name> <maml:description> <maml:para>Specifies the BackupManagementType. The specified set of policy parameters are validated against the BackupManagementType. Specify AzureVM for VM backup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[BackupManagementType]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>RetentionPolicy</maml:name> <maml:description> <maml:para>Specifies the base Retention policy object obtained from Get-AzureRmRecoveryServicesBackupRetentionPolicyObject </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RetentionPolicyBase</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>SchedulePolicy</maml:name> <maml:description> <maml:para>Specifies the base Schedule policy object obtained from Get-AzureRmRecoveryServicesBackupSchedulePolicyObject </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SchedulePolicyBase</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the policy as stored in the system</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>WorkloadType</maml:name> <maml:description> <maml:para>Specifies the WorkloadType. The specified set of policy parameters are validated against the WorkloadType. Specify AzureVM for VM backup </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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>BackupManagementType</maml:name> <maml:description> <maml:para>Specifies the BackupManagementType. The specified set of policy parameters are validated against the BackupManagementType. Specify AzureVM for VM backup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[BackupManagementType]</command:parameterValue> <dev:type> <maml:name>Nullable`1[BackupManagementType]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>RetentionPolicy</maml:name> <maml:description> <maml:para>Specifies the base Retention policy object obtained from Get-AzureRmRecoveryServicesBackupRetentionPolicyObject </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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>SchedulePolicy</maml:name> <maml:description> <maml:para>Specifies the base Schedule policy object obtained from Get-AzureRmRecoveryServicesBackupSchedulePolicyObject </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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <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 set of commands retrieve a base AzureRmRecoveryServicesBackupSchedulePolicyObject and sets the schedule to current time</maml:para> <maml:para>The second set of commands retrieves a base AzureRmRecoveryServicesBackupRetentionPolicyObject and sets the retention duration to 365</maml:para> <maml:para>The last command creates a new AzureRmRecoveryServicesBackupProtectionPolicy based on the schedule and retention policies and persists in the vault</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-AzureRMRecoveryServicesBackupProtection </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>Get-AzureRmRecoveryServicesBackupRetentionPolicyObject</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>Remove-AzureRmRecoveryServicesBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmRecoveryServicesBackupProtectionPolicy</command:name> <maml:description> <maml:para>Deletes a policy from the vault.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureRmRecoveryServicesProtectionPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> The remove-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet deletes backup policies for given vault. 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 before getting started Set-AzureRmRecoveryServicesVaultContext </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmRecoveryServicesBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>name of the AzureRmRecoveryServicesBackupProtectionPolicy </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmRecoveryServicesBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Policy</maml:name> <maml:description> <maml:para> Specifies protection policy that this cmdlet removes. To obtain an AzureRMRecoveryServicesBackupProtectionPolicy, use the Get-AzureRMRecoveryServicesBackupProtectionPolicy cmdlet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PolicyBase</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>name of the AzureRmRecoveryServicesBackupProtectionPolicy </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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Policy</maml:name> <maml:description> <maml:para> Specifies protection policy that this cmdlet removes. To obtain an AzureRMRecoveryServicesBackupProtectionPolicy, 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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\WINDOWS\system32> $pol= Get-AzureRmRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" PS C:\WINDOWS\system32> Remove-AzureRmRecoveryServicesBackupProtectionPolicy -Policy $pol</dev:code> <dev:remarks> <maml:para>Removes policy object from the vault. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmRecoveryServicesBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Restore-AzureRmRecoveryServicesBackupItem</command:name> <maml:description> <maml:para>Restores the data and configuration for a Backup item to a recovery point.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Restore</command:verb> <command:noun>AzureRmRecoveryServicesBackupItem</command:noun> <dev:version /> </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. The restore operation does not restore the full virtual machine. It restores the disk data and configuration information. After the restore operation finished, you must create the virtual machine and start it.</maml:para> <maml:para>Set the vault context before getting started Set-AzureRmRecoveryServicesVaultContext </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Restore-AzureRmRecoveryServicesBackupItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>RecoveryPoint</maml:name> <maml:description> <maml:para>Specifies the recovery point to which to restore the virtual machine. To obtain an AzureRmRecoveryServicesBackupRecoveryPoint, use the Get-AzureRmRecoveryServicesBackupRecoveryPoint cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RecoveryPointBase</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>StorageAccountResourceGroupName</maml:name> <maml:description> <maml:para> Specifies the resource group name holding 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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>StorageAccountResourceGroupName</maml:name> <maml:description> <maml:para> Specifies the resource group name holding 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>RecoveryPoint</maml:name> <maml:description> <maml:para>Specifies the recovery point to which to restore the virtual machine. To obtain an AzureRmRecoveryServicesBackupRecoveryPoint, 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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> $Container = Get-AzureRmRecoveryServicesBackupContainer -ContainerType AzureVM –Status Registered PS C:\> $backupitem=Get-AzureRmRecoveryServicesBackupItem –ContainerType AzureVM –WorkloadType AzureVM –Name ‘V2VM’ 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 </dev:code> <dev:remarks> <maml:para>The first and second command get a specific backup item. The fifth command gets a list of recovery points for the specific backup item filtered by start and end date. The date range specified is last 7 days. The last command restores the disks to target storage account DestAccount in DestRG (resource group). </maml:para> <maml:para /> <maml:para /> <maml:para> WorkloadName Operation Status StartTime EndTime ------------ --------- ------ --------- ------- V2VM Restore InProgress 26-Apr-16 1:14:01 PM 01-Jan-01 12:00:00 AM</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <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> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmRecoveryServicesBackupProtectionPolicy</command:name> <maml:description> <maml:para> Modifies an existing protection policy.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureRmRecoveryServicesBackupProtectionPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> The Set-AzureRmBackupProtectionPolicy cmdlet modifies an existing protection policy in Azure Backup. You can modify the following protection policy components: -- Backup schedule -- Retention policies Any change might affect the backup and retention of the items associated with the policy. Set the vault context before getting started Set-AzureRmRecoveryServicesVaultContext </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmRecoveryServicesBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Policy</maml:name> <maml:description> <maml:para> Specifies protection policy that this cmdlet modifies. To obtain an AzureRMRecoveryServicesBackupProtectionPolicy, use the Get-AzureRMRecoveryServicesBackupProtectionPolicy cmdlet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PolicyBase</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>RetentionPolicy</maml:name> <maml:description> <maml:para>Specifies the base Retention policy object obtained from Get-AzureRmRecoveryServicesBackupRetentionPolicyObject </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RetentionPolicyBase</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>SchedulePolicy</maml:name> <maml:description> <maml:para>Specifies the base Schedule policy object obtained from Get-AzureRmRecoveryServicesBackupSchedulePolicyObject </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SchedulePolicyBase</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Policy</maml:name> <maml:description> <maml:para> Specifies protection policy that this cmdlet modifies. To obtain an AzureRMRecoveryServicesBackupProtectionPolicy, 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>RetentionPolicy</maml:name> <maml:description> <maml:para>Specifies the base Retention policy object obtained from Get-AzureRmRecoveryServicesBackupRetentionPolicyObject </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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>SchedulePolicy</maml:name> <maml:description> <maml:para>Specifies the base Schedule policy object obtained from Get-AzureRmRecoveryServicesBackupSchedulePolicyObject </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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <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 set of commands retrieve a base AzureRmRecoveryServicesBackupSchedulePolicyObject and sets the schedule to current time</maml:para> <maml:para>The second set of commands retrieves a base AzureRmRecoveryServicesBackupRetentionPolicyObject and sets the retention duration to 365</maml:para> <maml:para>The last command modifies the specific AzureRmRecoveryServicesBackupProtectionPolicy based on the schedule and retention policies and persists in the vault</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmRecoveryServicesBackupProtectionPolicy</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>Get-AzureRmRecoveryServicesBackupRetentionPolicyObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Stop-AzureRmRecoveryServicesBackupJob</command:name> <maml:description> <maml:para> Cancels an existing Backup job.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>AzureRmRecoveryServicesBackupJob</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> The Stop-AzureRmRecoveryServicesBackupJob cmdlet cancels an existing Azure Backup job. Use this parameter to stop a job that takes too long and blocks other activities. You can cancel only the following types of jobs: -- Backup -- Restore</maml:para> <maml:para>Set the vault context before getting started Set-AzureRmRecoveryServicesVaultContext </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-AzureRmRecoveryServicesBackupJob</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Job</maml:name> <maml:description> <maml:para> Specifies a job that this cmdlet cancels. To obtain an AzureRmRecoveryServicesBackupJob object, use the Get-AzureRmRecoveryServicesBackupJob cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JobBase</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Stop-AzureRmRecoveryServicesBackupJob</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>JobId</maml:name> <maml:description> <maml:para> Specifies the ID of a job that this cmdlet cancels. 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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>JobId</maml:name> <maml:description> <maml:para> Specifies the ID of a job that this cmdlet cancels. 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Job</maml:name> <maml:description> <maml:para> Specifies a job that this cmdlet cancels. To obtain an AzureRmRecoveryServicesBackupJob 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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Stop a backup job --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <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. The command stores the job in the $Job variable. The final command stops the job that has the specified ID.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmRecoveryServicesBackupJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Unregister-AzureRmRecoveryServicesBackupContainer</command:name> <maml:description> <maml:para> Unregisters a Windows Server or other containers from the vault.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Unregister</command:verb> <command:noun>AzureRmRecoveryServicesBackupContainer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> The Unregister-AzureRmRecoveryServicesBackupContainer cmdlet unregisters the Windows Server 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 before getting started Set-AzureRmRecoveryServicesVaultContext </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unregister-AzureRmRecoveryServicesBackupContainer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Container</maml:name> <maml:description> <maml:para>Specifies a container object to unregister. To obtain an AzureRmRecoveryServicesBackupContainer, use the Get-AzureRmRecoveryServicesBackupContainer cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ContainerBase</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Container</maml:name> <maml:description> <maml:para>Specifies a container object to unregister. 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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Unregister Windows Server from the vault --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> $cont=Get-AzureRmRecoveryServicesContainer -ContainerType "Windows" -BackupManagementType MARS -Name "server01.contoso.com" PS C:\> Unregister-AzureRmRecoveryServiceBackupContainer -Container $cont </dev:code> <dev:remarks> <maml:para> The first command gets a specific container reference that is registered in the vault. The final command unregisters the specified Windows Server from the Azure Backup vault.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmRecoveryServicesBackupContainer </maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Unregister-AzureRmRecoveryServicesBackupManagementServer</command:name> <maml:description> <maml:para> Unregisters a SCDPM server or Azure Backup Server from the vault.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Unregister</command:verb> <command:noun>AzureRmRecoveryServicesBackupManagementServer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> The Unregister-AzureRmRecoveryServicesBackupManagementServer cmdlet unregisters the SCDPM or Azure Backup Server from the vault. This cmdlet removes references to a backup management server 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 before getting started Set-AzureRmRecoveryServicesVaultContext </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unregister-AzureRmRecoveryServicesBackupManagementServer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>AzureRmBackupManagementServer</maml:name> <maml:description> <maml:para>Specifies a DPM server object to unregister. To obtain an AzureRmRecoveryServicesBackupManagementServer, use the Get-AzureRmRecoveryServicesBackupManagementServer cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BackupEngineBase</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>AzureRmBackupManagementServer</maml:name> <maml:description> <maml:para>Specifies a DPM server object to unregister. To obtain an AzureRmRecoveryServicesBackupManagementServer, 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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Unregister a specific DPM server from the vault --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> $bms=Get-AzureRmRecoveryServicesBackupManagementServer -Name "dpmserver01.contoso.com" PS C:\> Unregister-AzureRmRecoveryServicesBackupManagementServer -AzureRmRecoveryServicesBackupManagementServer $bms </dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmRecoveryServicesBackupManagementServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Wait-AzureRmRecoveryServicesBackupJob</command:name> <maml:description> <maml:para>Waits for a Backup job to finish.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Wait</command:verb> <command:noun>AzureRmRecoveryServicesBackupJob</command:noun> <dev:version /> </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. 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 before getting started Set-AzureRmRecoveryServicesVaultContext </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Wait-AzureRmRecoveryServicesBackupJob</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Job</maml:name> <maml:description> <maml:para> Specifies a job that this cmdlet cancels. To obtain an AzureRmRecoveryServicesBackupJob object, use the Get-AzureRmRecoveryServicesBackupJob cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Timeout</maml:name> <maml:description> <maml:para> Specifies the maximum time, in seconds, that this cmdlet waits for the job to finish. We recommend that you specify a time-out value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int64]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Job</maml:name> <maml:description> <maml:para> Specifies a job that this cmdlet cancels. To obtain an AzureRmRecoveryServicesBackupJob 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Timeout</maml:name> <maml:description> <maml:para> Specifies the maximum time, in seconds, that this cmdlet waits for the job to finish. We recommend that you specify a time-out value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <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!"</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> Waiting for completion... Waiting for completion... Waiting for completion... Done!</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmRecoveryServicesBackupJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |