Microsoft.Azure.Commands.AzureBackup.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Backup-AzureRmBackupItem</command:name> <command:verb>Backup</command:verb> <command:noun>AzureRmBackupItem</command:noun> <maml:description><maml:para>Starts a backup for a Backup item. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Backup-AzureRmBackupItem 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>If an existing backup job is running, this cmdlet fails. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Backup-AzureRmBackupItem</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>Specifies a Backup item for which this cmdlet starts a backup operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupItem</command:parameterValue> <dev:type><maml:name>AzureRMBackupItem</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>Specifies a Backup item for which this cmdlet starts a backup operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupItem</command:parameterValue> <dev:type><maml:name>AzureRMBackupItem</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>AzureRMBackupItem</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>AzureRmBackupJob</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Start to back up a virtual machine</maml:title> <dev:code>PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" PS C:\> $Container = Get-AzureRmBackupContainer -Vault $Vault -Type AzureVM -Name "DPMSERVER.CONTOSO.COM" PS C:\> Get-AzureRmBackupItem -Container $Container | Backup-AzureRmBackupItem WorkloadName Operation Status StartTime EndTime ------------ --------- ------ --------- ------- co03-vm Backup InProgress 26-Aug-15 12:24:01 PM 01-Jan-01 12:00:00 AM</dev:code> <dev:remarks><maml:para>The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. The command stores that object in the $Vault variable. </maml:para> <maml:para>The second command gets a container that has the specified name in the vault in $Vault by using the Get-AzureRmBackupContainer cmdlet. The command stores that object in the $Container variable. </maml:para> <maml:para>The last command gets the backup items in $Container by using the Get-AzureRmBackupItem cmdlet. The command passes the items to the current cmdlet by using the pipeline operator. The current cmdlet starts backing up the virtual machine in the container. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Restore-AzureRmBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Disable-AzureRmBackupProtection</command:name> <command:verb>Disable</command:verb> <command:noun>AzureRmBackupProtection</command:noun> <maml:description><maml:para>Disables protection for a Backup protected item. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Disable-AzureRmBackupProtection cmdlet disables protection for an Azure Backup protected item. This cmdlet stops regular scheduled backup of an item. This cmdlet can delete existing recovery points for the backup item. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Disable-AzureRmBackupProtection</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>Specifies the Backup item for which this cmdlet disables protection. To obtain an AzureRmBackupItem , use the Get-AzureRmBackupItem cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupItem</command:parameterValue> <dev:type><maml:name>AzureRMBackupItem</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>RemoveRecoveryPoints</maml:name> <maml:Description><maml:para>Indicates that this cmdlet deletes existing recovery points. To delete stored recovery points later, run this cmdlet again and specify this parameter. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>Specifies the Backup item for which this cmdlet disables protection. To obtain an AzureRmBackupItem , use the Get-AzureRmBackupItem cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupItem</command:parameterValue> <dev:type><maml:name>AzureRMBackupItem</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>RemoveRecoveryPoints</maml:name> <maml:Description><maml:para>Indicates that this cmdlet deletes existing recovery points. To delete stored recovery points later, run this cmdlet again and specify this parameter. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>AzureRmBackupItem</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>AzureRmBackupJob</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>1:</maml:title> <dev:code></dev:code> <dev:remarks><maml:para> </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Enable-AzureRmBackupProtection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Enable-AzureRmBackupContainerReregistration</command:name> <command:verb>Enable</command:verb> <command:noun>AzureRmBackupContainerReregistration</command:noun> <maml:description><maml:para>Reregisters a server to connect to a Backup vault. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Enable-AzureRmBackupContainerReregistration cmdlet reregisters a server to connect to an Azure Backup vault and continue the Backup recovery point chain. </maml:para> <maml:para>If you destroy a server, all its cloud backup points remain in the Backup vault. If you create a replacement server and assign it the same fully qualified domain name, you can connect the server back to the same vault. This cmdlet enables Backup to make backups and add new backup points to the existing set. The new the server continues in the backup chain. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Enable-AzureRmBackupContainerReregistration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Container</maml:name> <maml:Description><maml:para>Specifies the container that this cmdlet reregisters. To obtain an AzureRmBackupContainer , use the Get-AzureRmBackupContainer cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupContainer</command:parameterValue> <dev:type><maml:name>AzureRMBackupContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Container</maml:name> <maml:Description><maml:para>Specifies the container that this cmdlet reregisters. To obtain an AzureRmBackupContainer , use the Get-AzureRmBackupContainer cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupContainer</command:parameterValue> <dev:type><maml:name>AzureRMBackupContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>AzureBackupContainer</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>1:</maml:title> <dev:code></dev:code> <dev:remarks><maml:para> </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmBackupContainer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Register-AzureRmBackupContainer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Enable-AzureRmBackupProtection</command:name> <command:verb>Enable</command:verb> <command:noun>AzureRmBackupProtection</command:noun> <maml:description><maml:para>Associates an item with an Azure Backup protection policy. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Enable-AzureRmBackupProtection cmdlet associates an item with an Azure Backup protection policy. To enable a protection policy, you must first have an existing backup item and an existing policy. Both must belong to the same Backup vault. The backup schedule does the full initial copy for the item and the incremental copy for the subsequent backups. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Enable-AzureRmBackupProtection</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>Specifies the Backup item for which this cmdlet enables protection. To obtain an AzureRmBackupItem , use the Get-AzureRmBackupItem cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupContainerContextObject</command:parameterValue> <dev:type><maml:name>AzureRMBackupContainerContextObject</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Policy</maml:name> <maml:Description><maml:para>Specifies protection policy that this cmdlet associates with an item. To obtain an AzureRmBackupProtectionPolicy object, use the Get-AzureRmBackupProtectionPolicy cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupProtectionPolicy</command:parameterValue> <dev:type><maml:name>AzureRMBackupProtectionPolicy</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>Specifies the Backup item for which this cmdlet enables protection. To obtain an AzureRmBackupItem , use the Get-AzureRmBackupItem cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupContainerContextObject</command:parameterValue> <dev:type><maml:name>AzureRMBackupContainerContextObject</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Policy</maml:name> <maml:Description><maml:para>Specifies protection policy that this cmdlet associates with an item. To obtain an AzureRmBackupProtectionPolicy object, use the Get-AzureRmBackupProtectionPolicy cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupProtectionPolicy</command:parameterValue> <dev:type><maml:name>AzureRMBackupProtectionPolicy</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>AzureRmBackupItem</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>AzureRmBackupJob</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Enable protection on an Azure virtual machine</maml:title> <dev:code>PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" PS C:\> $Policy = Get-AzureRmBackupProtectionPolicy -Vault $Vault -Name "DefaultPolicy" PS C:\> Get-AzureRmBackupContainer -Vault $Vault -Type AzureVM -Status Registered | Get-AzureRmBackupItem | Enable-AzureRmBackupProtection -Policy $Policy WorkloadName Operation Status StartTime EndTime ------------ --------- ------ --------- ------- co03-vm ConfigureBackup Completed 26-Aug-15 12:19:49 PM 26-Aug-15 12:19:54 PM</dev:code> <dev:remarks><maml:para>The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. The command stores that object in the $Vault variable. </maml:para> <maml:para>The second command gets the Backup protection policy named DefaultPolicy for the vault in $Vault. The command stores that object in the $Policy variable. </maml:para> <maml:para>The final command uses the pipeline operator to pass values from one cmdlet to the next. It gets a container, by using the Get-AzureRmBackupContainer cmdlet. The command gets the backup item from that container by using the Get-AzureRmBackupItem cmdlet. The current cmdlet enables the policy stored in $Policy for the item that the command passes to that cmdlet. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Backup-AzureRmBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmBackupContainer</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmBackupContainer</command:noun> <maml:description><maml:para>Gets Backup containers. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmBackupContainer cmdlet gets Azure Backup containers. </maml:para> <maml:para>An AzureBackupContainer encapsulates data sources, protected items, and recovery points. An AzureBackupContainer can be one of the following: </maml:para> <maml:para>- A Windows Server computer </maml:para> <maml:para>- A System Center Data Protection Manager (SCDPM) server </maml:para> <maml:para>- An Azure infrastructure as a service (IaaS) virtual machine </maml:para> <maml:para> </maml:para> <maml:para>Before Backup can back up a data source or item, you must register the container that holds it with the Azure Backup service. The container must be authenticated to send backup data to the Backup vault. For Windows Server computers and SCDPM servers, the registration is held with the fully qualified domain name of the server. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmBackupContainer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies a Backup vault from which this cmdlet gets containers. To obtain an AzureRmBackupVault , use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ManagedResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group associated with the container. This name is the same value that you specified for the ServiceName or ResourceGroupName parameter of the Register-AzureRmBackupContainer cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the container that this cmdlet gets. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Status</maml:name> <maml:Description><maml:para>Specifies the current status of the containers that this cmdlet gets. The acceptable values for this parameter are: </maml:para> <maml:para>- NotRegistered </maml:para> <maml:para>- Registered </maml:para> <maml:para>- Registering </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Registered</command:parameterValue> <command:parameterValue required="false" variableLength="false">Registering</command:parameterValue> <command:parameterValue required="false" variableLength="false">NotRegistered</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">AzureBackupContainerRegistrationStatus</command:parameterValue> <dev:type><maml:name>AzureBackupContainerRegistrationStatus</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Type</maml:name> <maml:Description><maml:para>Specifies the type of containers that this cmdlet gets. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Windows</command:parameterValue> <command:parameterValue required="false" variableLength="false">SCDPM</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureBackupServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">Other</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">AzureBackupContainerType</command:parameterValue> <dev:type><maml:name>AzureBackupContainerType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ManagedResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group associated with the container. This name is the same value that you specified for the ServiceName or ResourceGroupName parameter of the Register-AzureRmBackupContainer cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the container that this cmdlet gets. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Status</maml:name> <maml:Description><maml:para>Specifies the current status of the containers that this cmdlet gets. The acceptable values for this parameter are: </maml:para> <maml:para>- NotRegistered </maml:para> <maml:para>- Registered </maml:para> <maml:para>- Registering </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureBackupContainerRegistrationStatus</command:parameterValue> <dev:type><maml:name>AzureBackupContainerRegistrationStatus</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Type</maml:name> <maml:Description><maml:para>Specifies the type of containers that this cmdlet gets. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureBackupContainerType</command:parameterValue> <dev:type><maml:name>AzureBackupContainerType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies a Backup vault from which this cmdlet gets containers. To obtain an AzureRmBackupVault , use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>AzureBackupVault</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>AzureBackupContainer</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para>* None </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: View all servers registered to a vault</maml:title> <dev:code>PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" PS C:\> Get-AzureRmBackupContainer -Vault $Vault -Type Windows Name Type Status ---- ---- ------ SERVER01.CONTOSO.COM Windows Registered SERVER02.CONTOSO.COM Windows Registered</dev:code> <dev:remarks><maml:para>The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. The command stores that object in the $Vault variable. </maml:para> <maml:para>The second command gets all containers of type Windows from the vault in $Vault. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Get a specific container</maml:title> <dev:code>PS C:\>Get-AzureRmBackupContainer -Vault $Vault -Type SCDPM -Name "DPMSERVER.CONTOSO.COM" Name Type Status ---- ---- ------ DPMSERVER.CONTOSO.COM SCDPM Registered</dev:code> <dev:remarks><maml:para>This command gets the container named DPMSERVER.CONTOSO.COM. The command specifies the vault in $Vault and the type of container. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 3: View all registered Azure virtual machines</maml:title> <dev:code>PS C:\>Get-AzureRmBackupContainer -Vault $Vault -Type AzureVM -Status Registered Name Type Status ---- ---- ------ co03-vm AzureVM Registered</dev:code> <dev:remarks><maml:para>This command gets the registered virtual machines from the vault in $Vault. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Register-AzureRmBackupContainer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Unregister-AzureRmBackupContainer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmBackupItem</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmBackupItem</command:noun> <maml:description><maml:para>Gets the items under a container in Backup. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmBackupItem cmdlet gets the items in a container in Azure Backup and the protection status of the items. Enable items for protection by using the Enable-AzureRmBackupProtection cmdlet. </maml:para> <maml:para>A container that is registered to a Backup vault can have one or more items that can be protected. For Azure virtual machines, there can be only one item in the virtual machine container. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmBackupItem</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Container</maml:name> <maml:Description><maml:para>Specifies a container object for which this cmdlet gets backup items. To obtain an AzureRmBackupContainer , use the Get-AzureRmBackupContainer cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupContainer</command:parameterValue> <dev:type><maml:name>AzureRMBackupContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProtectionStatus</maml:name> <maml:Description><maml:para>Specifies the overall protection status of an item in the container. The acceptable values for this parameter are: </maml:para> <maml:para>- Protected </maml:para> <maml:para>- Protecting - NotProtected </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Protected</command:parameterValue> <command:parameterValue required="false" variableLength="false">Protecting</command:parameterValue> <command:parameterValue required="false" variableLength="false">NotProtected</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Status</maml:name> <maml:Description><maml:para>Specifies the backup status for an item. The acceptable values for this parameter are: IRPending, Protected, ProtectionError, and ProtectionStopped. If the ProtectionStatus parameter has the value Protected, you can use the Status parameter value to filter items. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">IRPending</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProtectionStopped</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProtectionError</command:parameterValue> <command:parameterValue required="false" variableLength="false">Protected</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Type</maml:name> <maml:Description><maml:para>Specifies the type of item that this cmdlet gets. Currently, the only supported value is AzureVM. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Container</maml:name> <maml:Description><maml:para>Specifies a container object for which this cmdlet gets backup items. To obtain an AzureRmBackupContainer , use the Get-AzureRmBackupContainer cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupContainer</command:parameterValue> <dev:type><maml:name>AzureRMBackupContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProtectionStatus</maml:name> <maml:Description><maml:para>Specifies the overall protection status of an item in the container. The acceptable values for this parameter are: </maml:para> <maml:para>- Protected </maml:para> <maml:para>- Protecting - NotProtected </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Status</maml:name> <maml:Description><maml:para>Specifies the backup status for an item. The acceptable values for this parameter are: IRPending, Protected, ProtectionError, and ProtectionStopped. If the ProtectionStatus parameter has the value Protected, you can use the Status parameter value to filter items. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Type</maml:name> <maml:Description><maml:para>Specifies the type of item that this cmdlet gets. Currently, the only supported value is AzureVM. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>AzureRmBackupContainer</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>AzureRmBackupItem</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get the items in a container</maml:title> <dev:code>PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" PS C:\> $Container = Get-AzureRmBackupContainer -Vault $Vault -Type AzureVM -Name "DPMSERVER.CONTOSO.COM" PS C:\> Get-AzureRmBackupItem -Container $Container Name ProtectionStatus DataSourceStatus RecoveryPointsCount ProtectionPolicyName ---- ---------------- ---------------- ------------------- -------------------- co03-vm NotProtected 0</dev:code> <dev:remarks><maml:para>The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. The command stores that object in the $Vault variable. </maml:para> <maml:para>The second command gets a container that has the specified name in the vault in $Vault by using the Get-AzureRmBackupContainer cmdlet. The command stores that object in the $Container variable. </maml:para> <maml:para>The final command gets the backup item in the container in $Container. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: View all properties for an item</maml:title> <dev:code>PS C:\>Get-AzureRmBackupItem -Container $Container | Select-Object -Property * Name : co03-vm DataSourceStatus : ProtectionStatus : NotProtected Type : AzureVM ProtectionPolicyName : ProtectionPolicyId : RecoveryPointsCount : 0 ItemName : iaasvmcontainer;co03-vm;co03-vm ContainerType : AzureVM ContainerUniqueName : iaasvmcontainer;co03-vm;co03-vm ResourceGroupName : resourcegroup02 ResourceName : vault03 Location : southeastasia</dev:code> <dev:remarks><maml:para>This command gets the backup item in the container in $Container, and then passes it to the Select-Object cmdlet. That cmdlet returns all properties of the backup item. For more information, type `Get-Help Select-Object`. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Backup-AzureRmBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Disable-AzureRmBackupProtection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Enable-AzureRmBackupProtection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmBackupContainer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Restore-AzureRmBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmBackupJob</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmBackupJob</command:noun> <maml:description><maml:para>Gets Backup jobs. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmBackupJob cmdlet gets Azure Backup jobs for a specific vault. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmBackupJob</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>From</maml:name> <maml:Description><maml:para>Specifies the start, as a DateTime object, of a time range for the jobs that this cmdlet gets. To obtain a DateTime object, use the Get-Date cmdlet. For more information about DateTime objects, type `Get-Help Get-Date`. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>JobId</maml:name> <maml:Description><maml:para>Specifies the ID of a job that this cmdlet gets. The ID is the InstanceId property of an AzureRmBackupJob object. To obtain an AzureRmBackupJob object, use Get-AzureRmBackupJob. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Operation</maml:name> <maml:Description><maml:para>Specifies an operation of the jobs that this cmdlet gets. The acceptable values for this parameter are: </maml:para> <maml:para>- Backup </maml:para> <maml:para>- ConfigureBackup </maml:para> <maml:para>- DeleteBackupData </maml:para> <maml:para>- Register </maml:para> <maml:para>- Restore </maml:para> <maml:para>- UnProtect </maml:para> <maml:para>- Unregister </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Backup</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfigureBackup</command:parameterValue> <command:parameterValue required="false" variableLength="false">DeleteBackupData</command:parameterValue> <command:parameterValue required="false" variableLength="false">Register</command:parameterValue> <command:parameterValue required="false" variableLength="false">Restore</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnProtect</command:parameterValue> <command:parameterValue required="false" variableLength="false">Unregister</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Status</maml:name> <maml:Description><maml:para>Specifies a status of the jobs that this cmdlet gets. The acceptable values for this parameter are: </maml:para> <maml:para>- InProgress </maml:para> <maml:para>- Failed </maml:para> <maml:para>- Cancelled </maml:para> <maml:para>- Cancelling </maml:para> <maml:para>- Completed </maml:para> <maml:para>- CompletedWithWarnings </maml:para> <maml:para> </maml:para> <maml:para>You can specify this parameter to find all in progress jobs or all failed jobs. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Cancelled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cancelling</command:parameterValue> <command:parameterValue required="false" variableLength="false">Completed</command:parameterValue> <command:parameterValue required="false" variableLength="false">CompletedWithWarnings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Failed</command:parameterValue> <command:parameterValue required="false" variableLength="false">InProgress</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>To</maml:name> <maml:Description><maml:para>Specifies the end, as a DateTime object, of a time range for the jobs that this cmdlet gets. The default value is the current system time. If you specify this parameter, you must also specify the From parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Type</maml:name> <maml:Description><maml:para>Specifies the type of container for which this cmdlet gets backup jobs. Currently, the only supported value is AzureVM. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Backup vault for which this cmdlet gets jobs. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmBackupJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Job</maml:name> <maml:Description><maml:para>Specifies a job that this cmdlet gets. To obtain an AzureRmBackupJob object, use the Get-AzureRmBackupJob cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupJob</command:parameterValue> <dev:type><maml:name>AzureRMBackupJob</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>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`. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Job</maml:name> <maml:Description><maml:para>Specifies a job that this cmdlet gets. To obtain an AzureRmBackupJob object, use the Get-AzureRmBackupJob cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupJob</command:parameterValue> <dev:type><maml:name>AzureRMBackupJob</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>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 AzureRmBackupJob object. To obtain an AzureRmBackupJob object, use Get-AzureRmBackupJob. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Operation</maml:name> <maml:Description><maml:para>Specifies an operation of the jobs that this cmdlet gets. The acceptable values for this parameter are: </maml:para> <maml:para>- Backup </maml:para> <maml:para>- ConfigureBackup </maml:para> <maml:para>- DeleteBackupData </maml:para> <maml:para>- Register </maml:para> <maml:para>- Restore </maml:para> <maml:para>- UnProtect </maml:para> <maml:para>- Unregister </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Status</maml:name> <maml:Description><maml:para>Specifies a status of the jobs that this cmdlet gets. The acceptable values for this parameter are: </maml:para> <maml:para>- InProgress </maml:para> <maml:para>- Failed </maml:para> <maml:para>- Cancelled </maml:para> <maml:para>- Cancelling </maml:para> <maml:para>- Completed </maml:para> <maml:para>- CompletedWithWarnings </maml:para> <maml:para> </maml:para> <maml:para>You can specify this parameter to find all in progress jobs or all failed jobs. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>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. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Type</maml:name> <maml:Description><maml:para>Specifies the type of container for which this cmdlet gets backup jobs. Currently, the only supported value is AzureVM. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Backup vault for which this cmdlet gets jobs. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>AzureRmBackupVault</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>AzureRmBackupJob[]</maml:name> </dev:type> <maml:description><maml:para>This cmdlet returns one or more Backup jobs. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para>* None </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get all jobs in a Backup vault</maml:title> <dev:code>PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" PS C:\> Get-AzureRmBackupJob -Vault $Vault WorkloadName Operation Status StartTime EndTime ------------ --------- ------ --------- ------- co03-vm Backup InProgress 26-Aug-15 12:24:01 PM 01-Jan-01 12:00:00 AM co03-vm ConfigureBackup Completed 26-Aug-15 12:19:49 PM 26-Aug-15 12:19:54 PM co03-vm Register Completed 25-Aug-15 3:23:53 PM 25-Aug-15 3:25:00 PM</dev:code> <dev:remarks><maml:para>The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. The command stores that object in the $Vault variable. </maml:para> <maml:para>The second command gets all the jobs for the vault in $Vault. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Get completed jobs</maml:title> <dev:code>PS C:\>Get-AzureRmBackupJob -Vault $Vault -Status Completed WorkloadName Operation Status StartTime EndTime ------------ --------- ------ --------- ------- co03-vm Register Completed 25-Aug-15 3:23:53 PM 25-Aug-15 3:25:00 PM</dev:code> <dev:remarks><maml:para>This command gets completed jobs from the vault in $Vault. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 3: Get failed jobs for the last week</maml:title> <dev:code>PS C:\>Get-AzureRmBackupJob -Vault $Vault -From (Get-Date).AddDays(-7) -Status Failed</dev:code> <dev:remarks><maml:para>This command gets failed jobs from the last week from the vault in $Vault. The From parameter specifies a time seven days in the past. The command does not specify a value for the To parameter. Therefore, it uses the default value of the current time. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 4: Poll Backup for an in progress job that finishes</maml:title> <dev:code>PS C:\>$Jobs = Get-AzureRmBackupJob -Vault $Vault -Status InProgress $Job = $Jobs[0] while ( $Job.Status -ne Completed ) { Write-Host "Waiting for completion..." Start-Sleep -Seconds 10 $job = Get-AzureRmBackupJob -Vault $Vault -Job $Job } Write-Host "Done!" Waiting for completion... Waiting for completion... Waiting for completion... Done!</dev:code> <dev:remarks><maml:para>This script polls the first job that is currently in progress until the job has completed. </maml:para> <maml:para>The first line of the script gets all the jobs in $Vault that are in progress, and then stores those jobs in the $Jobs array variable. </maml:para> <maml:para>The second line stores the first job from the $Jobs array in the $Job variable. </maml:para> <maml:para>The third line starts a while loop that checks the current status of the job until the job is completed. For information about the while keyword, type `Get-Help about_While`. </maml:para> <maml:para>The while loop writes a message to the console, sleeps for ten seconds, and then updates the $Job variable. The script updates the $Job variable by using existing value of $Job and the current cmdlet to get the current status of the job. For information about the Windows PowerShell cmdlets, type `Get-Help Write-Host` and `Get-Help Start-Sleep`. </maml:para> <maml:para>The final line of the script tells you that the script has finished. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Stop-AzureRmBackupJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Wait-AzureRmBackupJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmBackupJobDetails</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmBackupJobDetails</command:noun> <maml:description><maml:para>Gets the details of a Backup job. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmBackupJobDetails cmdlet gets the details of an Azure Backup job. You can use this cmdlet to gather information about a job that fails. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmBackupJobDetails</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Job</maml:name> <maml:Description><maml:para>Specifies a job for which this cmdlet gets details. To obtain an AzureRmBackupJob object, use the Get-AzureRmBackupJob cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupJob</command:parameterValue> <dev:type><maml:name>AzureRMBackupJob</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmBackupJobDetails</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><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 AzureRmBackupJob object. To obtain an AzureRmBackupJob object, use Get-AzureRmBackupJob. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Backup vault for which this cmdlet gets job details. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Job</maml:name> <maml:Description><maml:para>Specifies a job for which this cmdlet gets details. To obtain an AzureRmBackupJob object, use the Get-AzureRmBackupJob cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupJob</command:parameterValue> <dev:type><maml:name>AzureRMBackupJob</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><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 AzureRmBackupJob object. To obtain an AzureRmBackupJob object, use Get-AzureRmBackupJob. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Backup vault for which this cmdlet gets job details. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>AzureRmBackupJobDetails</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para>* None </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Display the details of a failed job</maml:title> <dev:code>PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" PS C:\> $Jobs = Get-AzureRmBackupJob -Vault $Vault -Status Failed PS C:\> $JobDetails = Get-AzureRmBackupJobDetails -Job $Jobs[0] PS C:\> $JobDetails.ErrorDetails ErrorCode ErrorMessage Recommendations --------- ------------ --------------- 400001 Command execution failed. {Another operation is currently in p...</dev:code> <dev:remarks><maml:para>The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. The command stores that object in the $Vault variable. </maml:para> <maml:para>The second command gets failed jobs from the vault in $Vault, and then stores them in the $Jobs array variable. </maml:para> <maml:para>The third job gets details for the first job in the $Jobs variable, and then stores those details in the $JobDetails variable. </maml:para> <maml:para>The final command displays the ErrorDetails property of $JobDetails by using standard dot syntax. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Display the recommended action for a failed job</maml:title> <dev:code>PS C:\>$JobDetails.ErrorDetails.Recommendations Another operation is currently in progress on this item. Please wait until the previous operation is completed, and then retry.</dev:code> <dev:remarks><maml:para>This command displays the recommended action from the $JobDetails variable that was created in the first example. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmBackupJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmBackupProtectionPolicy</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmBackupProtectionPolicy</command:noun> <maml:description><maml:para>Gets backup policies for a Backup vault. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmBackupProtectionPolicy cmdlet gets backup policies for an Azure Backup vault. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Backup vault for which this cmdlet gets policies. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the policy that this cmdlet gets. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the policy that this cmdlet gets. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Backup vault for which this cmdlet gets policies. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>AzureRmBackupVault</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>AzureRmBackupProtectionPolicy</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para>* None </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: View the policies in a vault</maml:title> <dev:code>PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" PS C:\> Get-AzureRmBackupProtectionPolicy -Vault $Vault Name Type ScheduleType BackupTime ---- ---- ------------ ---------- contoso01 AzureVM Daily 26-Aug-15 3:00:00 PM DailyBkp AzureVM Daily 26-Aug-15 3:00:00 PM DefaultPolicy AzureVM Daily 26-Aug-15 12:30:00 AM WeeklyBkp AzureVM Weekly 26-Aug-15 5:00:00 PM contoso02 AzureVM Daily 26-Aug-15 3:00:00 PM</dev:code> <dev:remarks><maml:para>The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. The command stores that object in the $Vault variable. </maml:para> <maml:para>The second command gets all the Backup protection policies for the vault in $Vault. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Get a specific policy from a vault</maml:title> <dev:code>PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" PS C:\> Get-AzureRmBackupProtectionPolicy -Vault $Vault -Name "DefaultPolicy" Name Type ScheduleType BackupTime ---- ---- ------------ ---------- DefaultPolicy AzureVM Daily 26-Aug-15 12:30:00 AM</dev:code> <dev:remarks><maml:para>The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. The command stores that object in the $Vault variable. </maml:para> <maml:para>The second command gets the Backup protection policy named DefaultPolicy for the vault in $Vault. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Enable-AzureRmBackupProtection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmBackupRecoveryPoint</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmBackupRecoveryPoint</command:noun> <maml:description><maml:para>Gets the recovery points for a backed up item. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmBackupRecoveryPoint cmdlet gets the recovery points for a backed up Azure Backup item. After an item has been backed up, Backup stores one or more recovery points. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmBackupRecoveryPoint</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>Specifies the item for which this cmdlet gets recovery points. To obtain an AzureRmBackupItem , use the Get-AzureRmBackupItem cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupItem</command:parameterValue> <dev:type><maml:name>AzureRMBackupItem</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>RecoveryPointId</maml:name> <maml:Description><maml:para>Specifies the ID of a recovery point that this cmdlet gets. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>Specifies the item for which this cmdlet gets recovery points. To obtain an AzureRmBackupItem , use the Get-AzureRmBackupItem cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupItem</command:parameterValue> <dev:type><maml:name>AzureRMBackupItem</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>RecoveryPointId</maml:name> <maml:Description><maml:para>Specifies the ID of a recovery point that this cmdlet gets. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>AzureRmBackupItem</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>AzureRmBackupRecoveryPoint</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get recovery points for an item</maml:title> <dev:code>PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" PS C:\> $Container = Get-AzureRmBackupContainer -Vault $Vault -Type AzureVM -Name "DPMSERVER.CONTOSO.COM" PS C:\> $BackupItem = Get-AzureRmBackupItem -Container $Container PS C:\> Get-AzureRmBackupRecoveryPoint -Item $BackupItem RecoveryPointId RecoveryPointType RecoveryPointTime ContainerName --------------- ----------------- ----------------- ------------- 15273496567119 AppConsistent 26-Aug-15 12:27:38 PM iaasvmcontainer;conto02-vm;conto0...</dev:code> <dev:remarks><maml:para>The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. The command stores that object in the $Vault variable. </maml:para> <maml:para>The second command gets a container that has the specified name in the vault in $Vault by using the Get-AzureRmBackupContainer cmdlet. The command stores that object in the $Container variable. </maml:para> <maml:para>The third command gets the backup item in the container in $Container by using the Get-AzureRmBackupItem cmdlet. The command stores that object in the $BackupItem variable. </maml:para> <maml:para>The final command gets recovery points for the item in $BackupItem. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmBackupContainer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmBackupVault</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmBackupVault</command:noun> <maml:description><maml:para>Gets Backup vaults. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmBackupVault cmdlet gets Azure Backup vaults. This cmdlet returns AzureRmBackupVault objects for use with other cmdlets. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmBackupVault</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of an Azure resource group in which this cmdlet gets a Backup 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the Backup vault that this cmdlet gets. If more than one Backup vault has the same name, this cmdlet returns them all. Specify the ResourceGroupName parameter to get a unique 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the Backup vault that this cmdlet gets. If more than one Backup vault has the same name, this cmdlet returns them all. Specify the ResourceGroupName parameter to get a unique 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of an Azure resource group in which this cmdlet gets a Backup 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>AzureRmBackupVault</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para>* None </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: View all the Backup vaults</maml:title> <dev:code>PS C:\>Get-AzureRmBackupVault</dev:code> <dev:remarks><maml:para>This command gets all the Azure Backup vaults. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: View all vaults created in West US</maml:title> <dev:code>PS C:\>Get-AzureRmBackupVault | Where-Object { $_.Region -eq "westus" }</dev:code> <dev:remarks><maml:para>This command gets all the Backup vaults. The command passes them to the Where-Object cmdlet by using the pipeline operator. That cmdlet filters the results based on the Region property. For more information, type `Get-Help Where-Object`. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 3: Get a specific vault</maml:title> <dev:code>PS C:\>Get-AzureRmBackupVault -Name "Vault03" ResourceId : /subscriptions/4bfbe168-f42a-4a06-8f5a-331cad1f497e/resourceGroups/ResourceGroup011/providers/Microsoft.Backup /BackupVault/Vault Name : Vault03 ResourceGroupName : ResourceGroup01 Region : westus Storage : GeoRedundant</dev:code> <dev:remarks><maml:para>This command gets the vault named Vault03. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 4: Count the number of vaults that have locally redundant storage</maml:title> <dev:code>PS C:\>Get-AzureRmBackupVault | Where-Object { $_.Storage -match "LocallyRedundant" } | Measure-Object Count : 4 Average : Sum : Maximum : Minimum : Property :</dev:code> <dev:remarks><maml:para>This command gets all the Azure Backup vaults. The command passes them to Where-Object , which filters the results based on the Storage property. The command passes the ones that have a value of LocallyRedundant to the Measure-Object cmdlet, which counts the results. For more information, type `Get-Help Measure-Object`. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmBackupContainer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmBackupVaultCredentials</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmBackupVaultCredentials</command:noun> <maml:description><maml:para>Downloads the vault credentials file for a Backup vault. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmBackupVaultCredentials cmdlet downloads the vault credentials file for an Azure Backup vault. </maml:para> <maml:para>Backup uses a vault credential file to connect a server to the Azure Backup vault and register it. You must register a server before Backup can send backup data to the vault. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmBackupVaultCredentials</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Backup vault for which this cmdlet gets a vault credential file. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>TargetLocation</maml:name> <maml:Description><maml:para>Specifies the destination path where this cmdlet stores the vault credentials file. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>TargetLocation</maml:name> <maml:Description><maml:para>Specifies the destination path where this cmdlet stores the vault credentials file. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Backup vault for which this cmdlet gets a vault credential file. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>AzureRMBackupVault</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>String</maml:name> </dev:type> <maml:description><maml:para>This cmdlet returns the name of the vault credential file. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>1:</maml:title> <dev:code></dev:code> <dev:remarks><maml:para> </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmBackupProtectionPolicy</command:name> <command:verb>New</command:verb> <command:noun>AzureRmBackupProtectionPolicy</command:noun> <maml:description><maml:para>Creates a Backup policy. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmBackupProtectionPolicy cmdlet creates an Azure Backup policy as an Azure PowerShell object. </maml:para> <maml:para>A backup policy defines when and how often Backup backs up an item. The Enable-AzureRmBackupProtection cmdlet uses a backup policy. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Azure Backup vault to which the backup policy belongs. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies a name for the backup policy. Select a name that is unique 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>Type</maml:name> <maml:Description><maml:para>Specifies the type of backup item to which the policy applies. Currently, the only supported value is AzureVM. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Daily</maml:name> <maml:Description><maml:para>Indicates that the backup operation runs on a Daily schedule. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases="none"><maml:name>BackupTime</maml:name> <maml:Description><maml:para>Specifies the time of day, as a DateTime object, for the backup operation. To obtain a DateTime , use the Get-Date cmdlet. For information about DateTime objects, type `Get-Help Get-Date`. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="none"><maml:name>RetentionPolicy</maml:name> <maml:Description><maml:para>Specifies an array of retention policies for the backup policy. To obtain an AzureRmBackupRetentionPolicy , use the New-AzureRmBackupRetentionPolicyObject cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupRetentionPolicy[]</command:parameterValue> <dev:type><maml:name>AzureRMBackupRetentionPolicy[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>New-AzureRmBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Azure Backup vault to which the backup policy belongs. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies a name for the backup policy. Select a name that is unique 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>Type</maml:name> <maml:Description><maml:para>Specifies the type of backup item to which the policy applies. Currently, the only supported value is AzureVM. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases="none"><maml:name>BackupTime</maml:name> <maml:Description><maml:para>Specifies the time of day, as a DateTime object, for the backup operation. To obtain a DateTime , use the Get-Date cmdlet. For information about DateTime objects, type `Get-Help Get-Date`. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases="none"><maml:name>DaysOfWeek</maml:name> <maml:Description><maml:para>Specifies an array of days of the week. This policy runs backups on the days specified by this parameter. The acceptable values for this parameter are: </maml:para> <maml:para>- Monday </maml:para> <maml:para>- Tuesday </maml:para> <maml:para>- Wednesday </maml:para> <maml:para>- Thursday </maml:para> <maml:para>- Friday </maml:para> <maml:para>- Saturday </maml:para> <maml:para>- Sunday </maml:para> <maml:para> </maml:para> <maml:para>If you specify the Weekly parameter, specify this parameter. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Monday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tuesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Wednesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thursday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Friday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Saturday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Sunday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Monday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tuesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Wednesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thursday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Friday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Saturday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Sunday</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="none"><maml:name>RetentionPolicy</maml:name> <maml:Description><maml:para>Specifies an array of retention policies for the backup policy. To obtain an AzureRmBackupRetentionPolicy , use the New-AzureRmBackupRetentionPolicyObject cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupRetentionPolicy[]</command:parameterValue> <dev:type><maml:name>AzureRMBackupRetentionPolicy[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>New-AzureRmBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Azure Backup vault to which the backup policy belongs. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies a name for the backup policy. Select a name that is unique 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>Type</maml:name> <maml:Description><maml:para>Specifies the type of backup item to which the policy applies. Currently, the only supported value is AzureVM. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureVM</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Weekly</maml:name> <maml:Description><maml:para>Indicates that the backup policy is triggered weekly on one or more days of the week. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases="none"><maml:name>BackupTime</maml:name> <maml:Description><maml:para>Specifies the time of day, as a DateTime object, for the backup operation. To obtain a DateTime , use the Get-Date cmdlet. For information about DateTime objects, type `Get-Help Get-Date`. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases="none"><maml:name>DaysOfWeek</maml:name> <maml:Description><maml:para>Specifies an array of days of the week. This policy runs backups on the days specified by this parameter. The acceptable values for this parameter are: </maml:para> <maml:para>- Monday </maml:para> <maml:para>- Tuesday </maml:para> <maml:para>- Wednesday </maml:para> <maml:para>- Thursday </maml:para> <maml:para>- Friday </maml:para> <maml:para>- Saturday </maml:para> <maml:para>- Sunday </maml:para> <maml:para> </maml:para> <maml:para>If you specify the Weekly parameter, specify this parameter. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Monday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tuesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Wednesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thursday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Friday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Saturday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Sunday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Monday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tuesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Wednesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thursday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Friday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Saturday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Sunday</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="none"><maml:name>RetentionPolicy</maml:name> <maml:Description><maml:para>Specifies an array of retention policies for the backup policy. To obtain an AzureRmBackupRetentionPolicy , use the New-AzureRmBackupRetentionPolicyObject cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupRetentionPolicy[]</command:parameterValue> <dev:type><maml:name>AzureRMBackupRetentionPolicy[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases="none"><maml:name>BackupTime</maml:name> <maml:Description><maml:para>Specifies the time of day, as a DateTime object, for the backup operation. To obtain a DateTime , use the Get-Date cmdlet. For information about DateTime objects, type `Get-Help Get-Date`. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Daily</maml:name> <maml:Description><maml:para>Indicates that the backup operation runs on a Daily schedule. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases="none"><maml:name>DaysOfWeek</maml:name> <maml:Description><maml:para>Specifies an array of days of the week. This policy runs backups on the days specified by this parameter. The acceptable values for this parameter are: </maml:para> <maml:para>- Monday </maml:para> <maml:para>- Tuesday </maml:para> <maml:para>- Wednesday </maml:para> <maml:para>- Thursday </maml:para> <maml:para>- Friday </maml:para> <maml:para>- Saturday </maml:para> <maml:para>- Sunday </maml:para> <maml:para> </maml:para> <maml:para>If you specify the Weekly parameter, specify this parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies a name for the backup policy. Select a name that is unique 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="none"><maml:name>RetentionPolicy</maml:name> <maml:Description><maml:para>Specifies an array of retention policies for the backup policy. To obtain an AzureRmBackupRetentionPolicy , use the New-AzureRmBackupRetentionPolicyObject cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupRetentionPolicy[]</command:parameterValue> <dev:type><maml:name>AzureRMBackupRetentionPolicy[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>Type</maml:name> <maml:Description><maml:para>Specifies the type of backup item to which the policy applies. Currently, the only supported value is AzureVM. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Azure Backup vault to which the backup policy belongs. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Weekly</maml:name> <maml:Description><maml:para>Indicates that the backup policy is triggered weekly on one or more days of the week. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>AzureRmBackupProtectionPolicy</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para>* None </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create a daily backup policy with daily and monthly retention</maml:title> <dev:code>PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" PS C:\> $Daily = New-AzureRmBackupRetentionPolicyObject -DailyRetention -Retention 30 PS C:\> $Monthly = New-AzureRmBackupRetentionPolicyObject -MonthlyRetentionInDailyFormat -DaysOfMonth (10, 20) -Retention 12 PS C:\> $ProtectionPolicy = New-AzureRmBackupProtectionPolicy -Name DailyBackup01 -Type AzureVM -Daily -BackupTime ([datetime]"3:30 PM") -RetentionPolicy ($Daily,$Monthly) -Vault $Vault Name Type ScheduleType BackupTime ---- ---- ------------ ---------- DailyBkp AzureVM Daily 26-Aug-15 3:00:00 PM</dev:code> <dev:remarks><maml:para>The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. The command stores that object in the $Vault variable. </maml:para> <maml:para>The second command creates a retention policy for 30 days of daily retention, and then stores it in the $Daily variable. </maml:para> <maml:para>The third command creates a retention policy that keeps the backup on the tenth and the twentieth of each month for twelve months. The command stores the retention policy in the $Monthly variable. </maml:para> <maml:para>The final command creates a backup policy for the vault in $Vault that has a daily backup time of 3:00 PM. The command assigns the retention policies stored in $Daily and $Monthly. The command stores the result in the $ProtectionPolicy variable. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Enable-AzureRmBackupProtection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmBackupRetentionPolicyObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmBackupRetentionPolicyObject</command:name> <command:verb>New</command:verb> <command:noun>AzureRmBackupRetentionPolicyObject</command:noun> <maml:description><maml:para>Creates a Backup retention policy. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmBackupRetentionPolicyObject cmdlet creates an Azure Backup retention policy. A retention policy defines how long Backup keeps a recovery point. The types of retention are the following: </maml:para> <maml:para>- Daily </maml:para> <maml:para>- Weekly </maml:para> <maml:para>- Monthly </maml:para> <maml:para>- Yearly </maml:para> <maml:para> </maml:para> <maml:para>Create one retention policy for each type of retention that you plan to use. </maml:para> <maml:para>A backup policy is associated with at least one retention policy. To create a backup policy, use the New-AzureRmBackupProtectionPolicy cmdlet. You can instead provide a retention policy to the Enable-AzureRmBackupProtection cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmBackupRetentionPolicyObject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DailyRetention</maml:name> <maml:Description><maml:para>Indicates that this cmdlet creates a Daily retention policy. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Retention</maml:name> <maml:Description><maml:para>Specifies the retention period, in days, months, or years, for which Backup stores a backup point. The unit depends on whether this cmdlet selects a daily, monthly, or yearly retention option. For example, if specify the DailyRetention parameter, the cmdlet interprets the current parameter as a number of days. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>New-AzureRmBackupRetentionPolicyObject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DaysOfMonth</maml:name> <maml:Description><maml:para>Specifies the days of the month that identify which recovery points Backup retains and for how long. The acceptable values for this parameter are: integers from 1 through 28 and Last. Specify this parameter if you specify the DailyRetention , MonthlyRetentionInDailyFormat , and YearlyRetentionInDailyFormat parameters. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">1</command:parameterValue> <command:parameterValue required="false" variableLength="false">2</command:parameterValue> <command:parameterValue required="false" variableLength="false">3</command:parameterValue> <command:parameterValue required="false" variableLength="false">4</command:parameterValue> <command:parameterValue required="false" variableLength="false">5</command:parameterValue> <command:parameterValue required="false" variableLength="false">6</command:parameterValue> <command:parameterValue required="false" variableLength="false">7</command:parameterValue> <command:parameterValue required="false" variableLength="false">8</command:parameterValue> <command:parameterValue required="false" variableLength="false">9</command:parameterValue> <command:parameterValue required="false" variableLength="false">10</command:parameterValue> <command:parameterValue required="false" variableLength="false">11</command:parameterValue> <command:parameterValue required="false" variableLength="false">12</command:parameterValue> <command:parameterValue required="false" variableLength="false">13</command:parameterValue> <command:parameterValue required="false" variableLength="false">14</command:parameterValue> <command:parameterValue required="false" variableLength="false">15</command:parameterValue> <command:parameterValue required="false" variableLength="false">16</command:parameterValue> <command:parameterValue required="false" variableLength="false">17</command:parameterValue> <command:parameterValue required="false" variableLength="false">18</command:parameterValue> <command:parameterValue required="false" variableLength="false">19</command:parameterValue> <command:parameterValue required="false" variableLength="false">20</command:parameterValue> <command:parameterValue required="false" variableLength="false">21</command:parameterValue> <command:parameterValue required="false" variableLength="false">22</command:parameterValue> <command:parameterValue required="false" variableLength="false">23</command:parameterValue> <command:parameterValue required="false" variableLength="false">24</command:parameterValue> <command:parameterValue required="false" variableLength="false">25</command:parameterValue> <command:parameterValue required="false" variableLength="false">26</command:parameterValue> <command:parameterValue required="false" variableLength="false">27</command:parameterValue> <command:parameterValue required="false" variableLength="false">28</command:parameterValue> <command:parameterValue required="false" variableLength="false">Last</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type><maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>MonthlyRetentionInDailyFormat</maml:name> <maml:Description><maml:para>Indicates that this cmdlet creates a Monthly policy in Daily format. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Retention</maml:name> <maml:Description><maml:para>Specifies the retention period, in days, months, or years, for which Backup stores a backup point. The unit depends on whether this cmdlet selects a daily, monthly, or yearly retention option. For example, if specify the DailyRetention parameter, the cmdlet interprets the current parameter as a number of days. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>New-AzureRmBackupRetentionPolicyObject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DaysOfMonth</maml:name> <maml:Description><maml:para>Specifies the days of the month that identify which recovery points Backup retains and for how long. The acceptable values for this parameter are: integers from 1 through 28 and Last. Specify this parameter if you specify the DailyRetention , MonthlyRetentionInDailyFormat , and YearlyRetentionInDailyFormat parameters. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">1</command:parameterValue> <command:parameterValue required="false" variableLength="false">2</command:parameterValue> <command:parameterValue required="false" variableLength="false">3</command:parameterValue> <command:parameterValue required="false" variableLength="false">4</command:parameterValue> <command:parameterValue required="false" variableLength="false">5</command:parameterValue> <command:parameterValue required="false" variableLength="false">6</command:parameterValue> <command:parameterValue required="false" variableLength="false">7</command:parameterValue> <command:parameterValue required="false" variableLength="false">8</command:parameterValue> <command:parameterValue required="false" variableLength="false">9</command:parameterValue> <command:parameterValue required="false" variableLength="false">10</command:parameterValue> <command:parameterValue required="false" variableLength="false">11</command:parameterValue> <command:parameterValue required="false" variableLength="false">12</command:parameterValue> <command:parameterValue required="false" variableLength="false">13</command:parameterValue> <command:parameterValue required="false" variableLength="false">14</command:parameterValue> <command:parameterValue required="false" variableLength="false">15</command:parameterValue> <command:parameterValue required="false" variableLength="false">16</command:parameterValue> <command:parameterValue required="false" variableLength="false">17</command:parameterValue> <command:parameterValue required="false" variableLength="false">18</command:parameterValue> <command:parameterValue required="false" variableLength="false">19</command:parameterValue> <command:parameterValue required="false" variableLength="false">20</command:parameterValue> <command:parameterValue required="false" variableLength="false">21</command:parameterValue> <command:parameterValue required="false" variableLength="false">22</command:parameterValue> <command:parameterValue required="false" variableLength="false">23</command:parameterValue> <command:parameterValue required="false" variableLength="false">24</command:parameterValue> <command:parameterValue required="false" variableLength="false">25</command:parameterValue> <command:parameterValue required="false" variableLength="false">26</command:parameterValue> <command:parameterValue required="false" variableLength="false">27</command:parameterValue> <command:parameterValue required="false" variableLength="false">28</command:parameterValue> <command:parameterValue required="false" variableLength="false">Last</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type><maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>MonthsOfYear</maml:name> <maml:Description><maml:para>Specifies which months of the year have the recovery points that Backup retains on a yearly basis. The acceptable values for this parameter are: names of months, such as January or February. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">January</command:parameterValue> <command:parameterValue required="false" variableLength="false">February</command:parameterValue> <command:parameterValue required="false" variableLength="false">March</command:parameterValue> <command:parameterValue required="false" variableLength="false">April</command:parameterValue> <command:parameterValue required="false" variableLength="false">May</command:parameterValue> <command:parameterValue required="false" variableLength="false">June</command:parameterValue> <command:parameterValue required="false" variableLength="false">July</command:parameterValue> <command:parameterValue required="false" variableLength="false">August</command:parameterValue> <command:parameterValue required="false" variableLength="false">September</command:parameterValue> <command:parameterValue required="false" variableLength="false">October</command:parameterValue> <command:parameterValue required="false" variableLength="false">November</command:parameterValue> <command:parameterValue required="false" variableLength="false">December</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Retention</maml:name> <maml:Description><maml:para>Specifies the retention period, in days, months, or years, for which Backup stores a backup point. The unit depends on whether this cmdlet selects a daily, monthly, or yearly retention option. For example, if specify the DailyRetention parameter, the cmdlet interprets the current parameter as a number of days. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>YearlyRetentionInDailyFormat</maml:name> <maml:Description><maml:para>Indicates that this cmdlet creates a Yearly retention policy in Daily format. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>New-AzureRmBackupRetentionPolicyObject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DaysOfWeek</maml:name> <maml:Description><maml:para>Specifies an array of days of the week. The days that this cmdlet specifies identify which recovery points that Backup retains and for how long. The acceptable values for this parameter are: </maml:para> <maml:para>- Monday </maml:para> <maml:para>- Tuesday </maml:para> <maml:para>- Wednesday </maml:para> <maml:para>- Thursday </maml:para> <maml:para>- Friday </maml:para> <maml:para>- Saturday </maml:para> <maml:para>- Sunday </maml:para> <maml:para> </maml:para> <maml:para>Specify this parameter if you specify the WeeklyRetention , MonthlyRetentionInWeeklyFormat , and YearlyRetentionInWeeklyFormat parameters. </maml:para> <maml:para>Be sure that the days of the week you select for backup and for retention are aligned. For example, if your backup is set for Saturdays, the retention policies must also use Saturday. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Monday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tuesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Wednesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thursday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Friday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Saturday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Sunday</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Retention</maml:name> <maml:Description><maml:para>Specifies the retention period, in days, months, or years, for which Backup stores a backup point. The unit depends on whether this cmdlet selects a daily, monthly, or yearly retention option. For example, if specify the DailyRetention parameter, the cmdlet interprets the current parameter as a number of days. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>WeeklyRetention</maml:name> <maml:Description><maml:para>Indicates that this cmdlet creates a Weekly retention policy. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>New-AzureRmBackupRetentionPolicyObject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DaysOfWeek</maml:name> <maml:Description><maml:para>Specifies an array of days of the week. The days that this cmdlet specifies identify which recovery points that Backup retains and for how long. The acceptable values for this parameter are: </maml:para> <maml:para>- Monday </maml:para> <maml:para>- Tuesday </maml:para> <maml:para>- Wednesday </maml:para> <maml:para>- Thursday </maml:para> <maml:para>- Friday </maml:para> <maml:para>- Saturday </maml:para> <maml:para>- Sunday </maml:para> <maml:para> </maml:para> <maml:para>Specify this parameter if you specify the WeeklyRetention , MonthlyRetentionInWeeklyFormat , and YearlyRetentionInWeeklyFormat parameters. </maml:para> <maml:para>Be sure that the days of the week you select for backup and for retention are aligned. For example, if your backup is set for Saturdays, the retention policies must also use Saturday. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Monday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tuesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Wednesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thursday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Friday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Saturday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Sunday</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>MonthlyRetentionInWeeklyFormat</maml:name> <maml:Description><maml:para>Indicates that this cmdlet creates a Monthly policy in Weekly format. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Retention</maml:name> <maml:Description><maml:para>Specifies the retention period, in days, months, or years, for which Backup stores a backup point. The unit depends on whether this cmdlet selects a daily, monthly, or yearly retention option. For example, if specify the DailyRetention parameter, the cmdlet interprets the current parameter as a number of days. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>WeekNumber</maml:name> <maml:Description><maml:para>Specifies the weeks of the month that identify which recovery points Backup retains and for how long. The acceptable values for this parameter are: </maml:para> <maml:para>- First </maml:para> <maml:para>- Second </maml:para> <maml:para>- Third </maml:para> <maml:para>- Fourth </maml:para> <maml:para>- Last </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">First</command:parameterValue> <command:parameterValue required="false" variableLength="false">Second</command:parameterValue> <command:parameterValue required="false" variableLength="false">Third</command:parameterValue> <command:parameterValue required="false" variableLength="false">Fourth</command:parameterValue> <command:parameterValue required="false" variableLength="false">Last</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>New-AzureRmBackupRetentionPolicyObject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DaysOfWeek</maml:name> <maml:Description><maml:para>Specifies an array of days of the week. The days that this cmdlet specifies identify which recovery points that Backup retains and for how long. The acceptable values for this parameter are: </maml:para> <maml:para>- Monday </maml:para> <maml:para>- Tuesday </maml:para> <maml:para>- Wednesday </maml:para> <maml:para>- Thursday </maml:para> <maml:para>- Friday </maml:para> <maml:para>- Saturday </maml:para> <maml:para>- Sunday </maml:para> <maml:para> </maml:para> <maml:para>Specify this parameter if you specify the WeeklyRetention , MonthlyRetentionInWeeklyFormat , and YearlyRetentionInWeeklyFormat parameters. </maml:para> <maml:para>Be sure that the days of the week you select for backup and for retention are aligned. For example, if your backup is set for Saturdays, the retention policies must also use Saturday. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Monday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tuesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Wednesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thursday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Friday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Saturday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Sunday</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>MonthsOfYear</maml:name> <maml:Description><maml:para>Specifies which months of the year have the recovery points that Backup retains on a yearly basis. The acceptable values for this parameter are: names of months, such as January or February. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">January</command:parameterValue> <command:parameterValue required="false" variableLength="false">February</command:parameterValue> <command:parameterValue required="false" variableLength="false">March</command:parameterValue> <command:parameterValue required="false" variableLength="false">April</command:parameterValue> <command:parameterValue required="false" variableLength="false">May</command:parameterValue> <command:parameterValue required="false" variableLength="false">June</command:parameterValue> <command:parameterValue required="false" variableLength="false">July</command:parameterValue> <command:parameterValue required="false" variableLength="false">August</command:parameterValue> <command:parameterValue required="false" variableLength="false">September</command:parameterValue> <command:parameterValue required="false" variableLength="false">October</command:parameterValue> <command:parameterValue required="false" variableLength="false">November</command:parameterValue> <command:parameterValue required="false" variableLength="false">December</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Retention</maml:name> <maml:Description><maml:para>Specifies the retention period, in days, months, or years, for which Backup stores a backup point. The unit depends on whether this cmdlet selects a daily, monthly, or yearly retention option. For example, if specify the DailyRetention parameter, the cmdlet interprets the current parameter as a number of days. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>WeekNumber</maml:name> <maml:Description><maml:para>Specifies the weeks of the month that identify which recovery points Backup retains and for how long. The acceptable values for this parameter are: </maml:para> <maml:para>- First </maml:para> <maml:para>- Second </maml:para> <maml:para>- Third </maml:para> <maml:para>- Fourth </maml:para> <maml:para>- Last </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">First</command:parameterValue> <command:parameterValue required="false" variableLength="false">Second</command:parameterValue> <command:parameterValue required="false" variableLength="false">Third</command:parameterValue> <command:parameterValue required="false" variableLength="false">Fourth</command:parameterValue> <command:parameterValue required="false" variableLength="false">Last</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>YearlyRetentionInWeeklyFormat</maml:name> <maml:Description><maml:para>Indicates that this cmdlet creates a Yearly retention policy in Weekly format. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DailyRetention</maml:name> <maml:Description><maml:para>Indicates that this cmdlet creates a Daily retention policy. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DaysOfMonth</maml:name> <maml:Description><maml:para>Specifies the days of the month that identify which recovery points Backup retains and for how long. The acceptable values for this parameter are: integers from 1 through 28 and Last. Specify this parameter if you specify the DailyRetention , MonthlyRetentionInDailyFormat , and YearlyRetentionInDailyFormat parameters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type><maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DaysOfWeek</maml:name> <maml:Description><maml:para>Specifies an array of days of the week. The days that this cmdlet specifies identify which recovery points that Backup retains and for how long. The acceptable values for this parameter are: </maml:para> <maml:para>- Monday </maml:para> <maml:para>- Tuesday </maml:para> <maml:para>- Wednesday </maml:para> <maml:para>- Thursday </maml:para> <maml:para>- Friday </maml:para> <maml:para>- Saturday </maml:para> <maml:para>- Sunday </maml:para> <maml:para> </maml:para> <maml:para>Specify this parameter if you specify the WeeklyRetention , MonthlyRetentionInWeeklyFormat , and YearlyRetentionInWeeklyFormat parameters. </maml:para> <maml:para>Be sure that the days of the week you select for backup and for retention are aligned. For example, if your backup is set for Saturdays, the retention policies must also use Saturday. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>MonthlyRetentionInDailyFormat</maml:name> <maml:Description><maml:para>Indicates that this cmdlet creates a Monthly policy in Daily format. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>MonthlyRetentionInWeeklyFormat</maml:name> <maml:Description><maml:para>Indicates that this cmdlet creates a Monthly policy in Weekly format. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>MonthsOfYear</maml:name> <maml:Description><maml:para>Specifies which months of the year have the recovery points that Backup retains on a yearly basis. The acceptable values for this parameter are: names of months, such as January or February. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Retention</maml:name> <maml:Description><maml:para>Specifies the retention period, in days, months, or years, for which Backup stores a backup point. The unit depends on whether this cmdlet selects a daily, monthly, or yearly retention option. For example, if specify the DailyRetention parameter, the cmdlet interprets the current parameter as a number of days. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>WeeklyRetention</maml:name> <maml:Description><maml:para>Indicates that this cmdlet creates a Weekly retention policy. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>WeekNumber</maml:name> <maml:Description><maml:para>Specifies the weeks of the month that identify which recovery points Backup retains and for how long. The acceptable values for this parameter are: </maml:para> <maml:para>- First </maml:para> <maml:para>- Second </maml:para> <maml:para>- Third </maml:para> <maml:para>- Fourth </maml:para> <maml:para>- Last </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>YearlyRetentionInDailyFormat</maml:name> <maml:Description><maml:para>Indicates that this cmdlet creates a Yearly retention policy in Daily format. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>YearlyRetentionInWeeklyFormat</maml:name> <maml:Description><maml:para>Indicates that this cmdlet creates a Yearly retention policy in Weekly format. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>AzureRmBackupRetentionPolicy</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para>* None </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create a retention policy for daily retention</maml:title> <dev:code>PS C:\>$Daily = New-AzureRmBackupRetentionPolicyObject -DailyRetention -Retention 30 PS C:\> $Daily RetentionType Retention RetentionTimes ------------- --------- -------------- Daily 30</dev:code> <dev:remarks><maml:para>The first command creates a retention policy for 30 days of daily retention, and then stores it in the $Daily variable. </maml:para> <maml:para>The second command displays the contents of $Daily. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Create a monthly retention policy</maml:title> <dev:code>PS C:\>$Monthly = New-AzureRmBackupRetentionPolicyObject -MonthlyRetentionInDailyFormat -DaysOfMonth (10, 20) -Retention 12 PS C:\> $Monthly | select * RetentionFormat : Daily DaysOfMonth : {10, 20} WeekNumber : DaysOfWeek : RetentionType : Monthly Retention : 12 RetentionTimes :</dev:code> <dev:remarks><maml:para>The first command creates a retention policy that keeps the backup on the tenth and the twentieth of each month for twelve months. The command stores the retention policy in the $Monthly variable. </maml:para> <maml:para>The second command displays the contents of $Monthly. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Enable-AzureRmBackupProtection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmBackupVault</command:name> <command:verb>New</command:verb> <command:noun>AzureRmBackupVault</command:noun> <maml:description><maml:para>Creates a Backup vault. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmBackupVault cmdlet creates an Azure Backup vault. This cmdlet returns an AzureRmBackupVault object that acts as a reference to the vault entity. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmBackupVault</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of an existing Azure resource group in which this cmdlet creates a Backup vault. To create a resource group, use the New-AzureRMResourceGroup cmdlet. The resource group and the Azure Backup vault do not have to be in the same region. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies a name for the Azure Backup vault. The name must be unique in a resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Region</maml:name> <maml:Description><maml:para>Specifies an Azure region in which the backup vault exists. For hybrid backup scenarios, we recommend that you create a vault in a region close to the on-premise server to reduce latency. For backup of Azure infrastructure as a service (IaaS) virtual machines, the vault becomes the point of discovery for local virtual machines. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Storage</maml:name> <maml:Description><maml:para>Specifies the storage type for the backup data. The acceptable values for this parameter are: LocallyRedundant and GeoRedundant. The default value is GeoRedundant. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">GeoRedundant</command:parameterValue> <command:parameterValue required="false" variableLength="false">LocallyRedundant</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">AzureBackupVaultStorageType</command:parameterValue> <dev:type><maml:name>AzureBackupVaultStorageType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies a name for the Azure Backup vault. The name must be unique in a resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Region</maml:name> <maml:Description><maml:para>Specifies an Azure region in which the backup vault exists. For hybrid backup scenarios, we recommend that you create a vault in a region close to the on-premise server to reduce latency. For backup of Azure infrastructure as a service (IaaS) virtual machines, the vault becomes the point of discovery for local virtual machines. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of an existing Azure resource group in which this cmdlet creates a Backup vault. To create a resource group, use the New-AzureRMResourceGroup cmdlet. The resource group and the Azure Backup vault do not have to be in the same region. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Storage</maml:name> <maml:Description><maml:para>Specifies the storage type for the backup data. The acceptable values for this parameter are: LocallyRedundant and GeoRedundant. The default value is GeoRedundant. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureBackupVaultStorageType</command:parameterValue> <dev:type><maml:name>AzureBackupVaultStorageType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>AzureRmBackupVault</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para>* None </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create a backup vault</maml:title> <dev:code>PS C:\>New-AzureRmBackupVault -ResourceGroupName "ResourceGroup01" -Name "Vault03" -Region "westus" ResourceId : /subscriptions/4bfbe168-f42a-4a06-8f5a-331cad1f497e/resourceGroups/ResourceGroup01/providers/Microsoft.Backup /BackupVault/Vault03 Name : Vault03 ResourceGroupName : ResourceGroup01 Region : westus Storage : GeoRedundant</dev:code> <dev:remarks><maml:para>This command creates an Azure Backup vault named Vault03. The vault is in the resource group named ResourceGroup01 in the West US region. The vault uses the default GeoRedundant storage type. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Create a backup vault that uses locally redundant storage</maml:title> <dev:code>PS C:\>New-AzureRmBackupVault -ResourceGroupName "ResourceGroup02" -Name "Vault03" -Region "westus" -Storage LocallyRedundant ResourceId : /subscriptions/4bfbe168-f42a-4a06-8f5a-331cad1f497e/resourceGroups/ResourceGroup02/providers/Microsoft.Backup /BackupVault/Vault03 Name : Vault03 ResourceGroupName : ResourceGroup02 Region : westus Storage : LocallyRedundant</dev:code> <dev:remarks><maml:para>This command creates an Azure Backup vault named Vault03. The vault is in the resource group named ResourceGroup02 in the West US region. The vault uses the LocallyRedundant storage type. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Register-AzureRmBackupContainer</command:name> <command:verb>Register</command:verb> <command:noun>AzureRmBackupContainer</command:noun> <maml:description><maml:para>Registers the container with a Backup vault. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Register-AzureRmBackupContainer cmdlet registers the container with an Azure Backup vault. To configure backup by using Azure Backup, first register your server or virtual machine with a Backup vault. This cmdlet registers an infrastructure as a service (IaaS) virtual machine with the specified vault. The register operation associates the Azure virtual machine with the backup vault and tracks the virtual machine through the backup life cycle. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Register-AzureRmBackupContainer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Backup vault to which this cmdlet registers virtual machine. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the virtual machine that this cmdlet registers. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group for the virtual machine. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Register-AzureRmBackupContainer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Backup vault to which this cmdlet registers virtual machine. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the virtual machine that this cmdlet registers. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ServiceName</maml:name> <maml:Description><maml:para>Specifies the service name of the virtual machine that this cmdlet registers. </maml:para> <maml:para>Typically, a cloud service name has a suffix .cloudapp.net. Do not include the suffix when you specify this parameter. </maml:para> <maml:para>To obtain information about a virtual machine, use the Get-AzureRMVM cmdlet. The service name is the DeploymentName property of the virtual machine object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the virtual machine that this cmdlet registers. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group for the virtual machine. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ServiceName</maml:name> <maml:Description><maml:para>Specifies the service name of the virtual machine that this cmdlet registers. </maml:para> <maml:para>Typically, a cloud service name has a suffix .cloudapp.net. Do not include the suffix when you specify this parameter. </maml:para> <maml:para>To obtain information about a virtual machine, use the Get-AzureRMVM cmdlet. The service name is the DeploymentName property of the virtual machine object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Backup vault to which this cmdlet registers virtual machine. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>AzureRmBackupVault</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>AzureRmBackupJob</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Register a virtual machine to a Backup vault</maml:title> <dev:code>PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" PS C:\> Register-AzureRmBackupContainer -Vault $Vault -Name "Contoso03Vm" -ServiceName "ContosoService27"</dev:code> <dev:remarks><maml:para>The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. The command stores the vault in the $Vault variable. </maml:para> <maml:para>The second command registers the virtual machine named Contoso03Vm with the vault in $Vault. That virtual machine belongs to the service named ContosoService27. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmBackupProtectionPolicy</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmBackupProtectionPolicy</command:noun> <maml:description><maml:para>Deletes a policy from a Backup vault. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmBackupProtectionPolicy cmdlet deletes a policy from an Azure Backup vault. </maml:para> <maml:para>Before you can delete a backup protection policy, the policy must not have any associated Backup items. Before you delete the policy, make sure that each associated item is associated with some other policy. To associate another policy with a backup item, use the Enable-AzureRmBackupProtection cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>ProtectionPolicy</maml:name> <maml:Description><maml:para>Specifies protection policy that this cmdlet removes. To obtain an AzureRmBackupProtectionPolicy , use the Get-AzureRmBackupProtectionPolicy cmdlet </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupProtectionPolicy</command:parameterValue> <dev:type><maml:name>AzureRMBackupProtectionPolicy</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Forces the command to run without asking for user confirmation. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>ProtectionPolicy</maml:name> <maml:Description><maml:para>Specifies protection policy that this cmdlet removes. To obtain an AzureRmBackupProtectionPolicy , use the Get-AzureRmBackupProtectionPolicy cmdlet </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupProtectionPolicy</command:parameterValue> <dev:type><maml:name>AzureRMBackupProtectionPolicy</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>AzureRMBackupProtectionPolicy</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Remove a backup protection policy</maml:title> <dev:code>PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" PS C:\> Get-AzureRmBackupProtectionPolicy -Vault $Vault -Name "DailyBackup" | Remove-AzureRmBackupProtectionPolicy</dev:code> <dev:remarks><maml:para>The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. The command stores that object in the $Vault variable. </maml:para> <maml:para>The second command creates a retention policy for 30 days of daily retention, and then stores it in the $Daily variable. </maml:para> <maml:para>The second command gets the protection policy named DailyBackup in the vault in $Vault by using the Get-AzureRmBackupProtectionPolicy cmdlet. The command passes the policy to the current cmdlet. That cmdlet removes the policy. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Enable-AzureRmBackupProtection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmBackupVault</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmBackupVault</command:noun> <maml:description><maml:para>Deletes a Backup vault. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmBackupVault cmdlet deletes an Azure Backup vault. </maml:para> <maml:para>Before you can delete a Backup vault, it must be empty. Use the Remove-AzureRmBackupContainer cmdlet to remove infrastructure as a service (IaaS) virtual machine backup data from the vault. Use the Delete-RegisteredServer cmdlet to remove other registered servers and backup data. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmBackupVault</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies a Backup vault that this cmdlet removes. To obtain an AzureRmBackupVault , use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies a Backup vault that this cmdlet removes. To obtain an AzureRmBackupVault , use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>AzureRMBackupVault</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para>* None </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Delete an Azure Backup vault</maml:title> <dev:code>PS C:\>Get-AzureRmBackupVault -Name "Vault03" | Remove-AzureRmBackupVault</dev:code> <dev:remarks><maml:para>This command gets the Azure Backup vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. The command passes that vault to the current cmdlet by using the pipeline operator. The current cmdlet removes the vault. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Restore-AzureRmBackupItem</command:name> <command:verb>Restore</command:verb> <command:noun>AzureRmBackupItem</command:noun> <maml:description><maml:para>Restores the data and configuration for a Backup item to a recovery point. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Restore-AzureRmBackupItem cmdlet restores the data and configuration for an Azure Backup item to a specified recovery point. This cmdlet starts the restore from the Backup vault to your account. </maml:para> <maml:para>The restore operation does not restore the full virtual machine. It restores the disk data and configuration information. After the restore operation finished, you must create the virtual machine and start it. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Restore-AzureRmBackupItem</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>RecoveryPoint</maml:name> <maml:Description><maml:para>Specifies the recovery point to which to restore the virtual machine. To obtain an AzureRmBackupRecoveryPoint , use the Get-AzureRmBackupRecoveryPoint cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupRecoveryPoint</command:parameterValue> <dev:type><maml:name>AzureRMBackupRecoveryPoint</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>StorageAccountName</maml:name> <maml:Description><maml:para>Specifies the name of the target storage account in your subscription. As a part of the restore process, this cmdlet stores the disks and the configuration information in this storage account. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>RecoveryPoint</maml:name> <maml:Description><maml:para>Specifies the recovery point to which to restore the virtual machine. To obtain an AzureRmBackupRecoveryPoint , use the Get-AzureRmBackupRecoveryPoint cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupRecoveryPoint</command:parameterValue> <dev:type><maml:name>AzureRMBackupRecoveryPoint</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>StorageAccountName</maml:name> <maml:Description><maml:para>Specifies the name of the target storage account in your subscription. As a part of the restore process, this cmdlet stores the disks and the configuration information in this storage account. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>AzureRmBackupRecoveryPoint</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>AzureRmBackupJob</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Restore a virtual machine to a recovery point</maml:title> <dev:code>PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" PS C:\> $Container = Get-AzureRmBackupContainer -Vault $Vault -Type AzureVM -Name "DPMSERVER.CONTOSO.COM" PS C:\> $BackupItem = Get-AzureRmBackupItem -Container $Container PS C:\> $RecoveryPoint = Get-AzureRmBackupRecoveryPoint -Item $BackupItem PS C:\> Restore-AzureRmBackupItem -StorageAccountName "DestinationAccount" -RecoveryPoint $RecoveryPoint WorkloadName Operation Status StartTime EndTime ------------ --------- ------ --------- ------- co03-vm Restore InProgress 26-Aug-15 1:14:01 PM 01-Jan-01 12:00:00 AM</dev:code> <dev:remarks><maml:para>The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. The command stores that object in the $Vault variable. </maml:para> <maml:para>The second command gets a container that has the specified name in the vault in $Vault by using the Get-AzureRmBackupContainer cmdlet. The command stores that object in the $Container variable. </maml:para> <maml:para>The third command gets the backup item in the container in $Container by using the Get-AzureRmBackupItem cmdlet. The command stores that object in the $BackupItem variable. </maml:para> <maml:para>The fourth command gets recovery point for the item in $BackupItem. The command stores that object in the $RecoveryPoint variable. </maml:para> <maml:para>The final command restores the recovery point in $RecoveryPoint for the account named DestinationAccount. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Backup-AzureRmBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmBackupItem</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmBackupRecoveryPoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmBackupProtectionPolicy</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmBackupProtectionPolicy</command:noun> <maml:description><maml:para>Modifies an existing protection policy. </maml:para> </maml:description> </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: </maml:para> <maml:para>- Name </maml:para> <maml:para>- Backup schedule </maml:para> <maml:para>- Retention policies </maml:para> <maml:para> </maml:para> <maml:para>Any change might affect the backup and retention of the items associated with the policy. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>ProtectionPolicy</maml:name> <maml:Description><maml:para>Specifies protection policy that this cmdlet modifies. To obtain an AzureRmBackupProtectionPolicy object, use the Get-AzureRmBackupProtectionPolicy cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupProtectionPolicy</command:parameterValue> <dev:type><maml:name>AzureRMBackupProtectionPolicy</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>NewName</maml:name> <maml:Description><maml:para>Specifies the new name for the policy. This name must be unique in a 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Daily</maml:name> <maml:Description><maml:para>Indicates that the backup operation runs on a Daily schedule. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>BackupTime</maml:name> <maml:Description><maml:para>Specifies the new backup time of day, as a DateTime object, for the policy. To obtain a DateTime object, use the Get-Date cmdlet. For information about DateTime objects, type `Get-Help Get-Date`. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>RetentionPolicy</maml:name> <maml:Description><maml:para>Specifies an array of retention policies for the backup policy. To obtain AzureRmBackupRetentionPolicy objects, use the New-AzureRmBackupRetentionPolicyObject cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupRetentionPolicy[]</command:parameterValue> <dev:type><maml:name>AzureRMBackupRetentionPolicy[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Set-AzureRmBackupProtectionPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>ProtectionPolicy</maml:name> <maml:Description><maml:para>Specifies protection policy that this cmdlet modifies. To obtain an AzureRmBackupProtectionPolicy object, use the Get-AzureRmBackupProtectionPolicy cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupProtectionPolicy</command:parameterValue> <dev:type><maml:name>AzureRMBackupProtectionPolicy</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>NewName</maml:name> <maml:Description><maml:para>Specifies the new name for the policy. This name must be unique in a 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Weekly</maml:name> <maml:Description><maml:para>Indicates that the backup operation runs on a Weekly schedule. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>BackupTime</maml:name> <maml:Description><maml:para>Specifies the new backup time of day, as a DateTime object, for the policy. To obtain a DateTime object, use the Get-Date cmdlet. For information about DateTime objects, type `Get-Help Get-Date`. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>RetentionPolicy</maml:name> <maml:Description><maml:para>Specifies an array of retention policies for the backup policy. To obtain AzureRmBackupRetentionPolicy objects, use the New-AzureRmBackupRetentionPolicyObject cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupRetentionPolicy[]</command:parameterValue> <dev:type><maml:name>AzureRMBackupRetentionPolicy[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>DaysOfWeek</maml:name> <maml:Description><maml:para>Specifies an array of days of the week. This policy runs backups on the days specified by this parameter. The acceptable values for this parameter are: </maml:para> <maml:para>- Monday </maml:para> <maml:para>- Tuesday </maml:para> <maml:para>- Wednesday </maml:para> <maml:para>- Thursday </maml:para> <maml:para>- Friday </maml:para> <maml:para>- Saturday </maml:para> <maml:para>- Sunday </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Monday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tuesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Wednesday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thursday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Friday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Saturday</command:parameterValue> <command:parameterValue required="false" variableLength="false">Sunday</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>BackupTime</maml:name> <maml:Description><maml:para>Specifies the new backup time of day, as a DateTime object, for the policy. To obtain a DateTime object, use the Get-Date cmdlet. For information about DateTime objects, type `Get-Help Get-Date`. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Daily</maml:name> <maml:Description><maml:para>Indicates that the backup operation runs on a Daily schedule. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>DaysOfWeek</maml:name> <maml:Description><maml:para>Specifies an array of days of the week. This policy runs backups on the days specified by this parameter. The acceptable values for this parameter are: </maml:para> <maml:para>- Monday </maml:para> <maml:para>- Tuesday </maml:para> <maml:para>- Wednesday </maml:para> <maml:para>- Thursday </maml:para> <maml:para>- Friday </maml:para> <maml:para>- Saturday </maml:para> <maml:para>- Sunday </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>NewName</maml:name> <maml:Description><maml:para>Specifies the new name for the policy. This name must be unique in a 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>ProtectionPolicy</maml:name> <maml:Description><maml:para>Specifies protection policy that this cmdlet modifies. To obtain an AzureRmBackupProtectionPolicy object, use the Get-AzureRmBackupProtectionPolicy cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupProtectionPolicy</command:parameterValue> <dev:type><maml:name>AzureRMBackupProtectionPolicy</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>RetentionPolicy</maml:name> <maml:Description><maml:para>Specifies an array of retention policies for the backup policy. To obtain AzureRmBackupRetentionPolicy objects, use the New-AzureRmBackupRetentionPolicyObject cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupRetentionPolicy[]</command:parameterValue> <dev:type><maml:name>AzureRMBackupRetentionPolicy[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Weekly</maml:name> <maml:Description><maml:para>Indicates that the backup operation runs on a Weekly schedule. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>AzureRmBackupProtectionPolicy</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>1:</maml:title> <dev:code></dev:code> <dev:remarks><maml:para> </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>New-AzureRmBackupProtectionPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmBackupVault</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmBackupVault</command:noun> <maml:description><maml:para>Changes the storage type of a Backup vault. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmBackupVault cmdlet changes the storage type of an Azure Backup vault. You cannot modify other properties of a vault. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmBackupVault</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies a Backup vault that this cmdlet modifies. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Storage</maml:name> <maml:Description><maml:para>Specifies the storage type for the backup data. The acceptable values for this parameter are: LocallyRedundant and GeoRedundant. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">GeoRedundant</command:parameterValue> <command:parameterValue required="false" variableLength="false">LocallyRedundant</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">AzureBackupVaultStorageType</command:parameterValue> <dev:type><maml:name>AzureBackupVaultStorageType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Storage</maml:name> <maml:Description><maml:para>Specifies the storage type for the backup data. The acceptable values for this parameter are: LocallyRedundant and GeoRedundant. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureBackupVaultStorageType</command:parameterValue> <dev:type><maml:name>AzureBackupVaultStorageType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies a Backup vault that this cmdlet modifies. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>AzureRmBackupVault</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para>* When you register the first server or virtual machine for a vault, the storage type is locked. Subsequently, you cannot change the storage type. </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Change the storage for an existing vault</maml:title> <dev:code>PS C:\>Get-AzureRmBackupVault -Name "Vault03" | Set-AzureRmBackupVault -Storage LocallyRedundant</dev:code> <dev:remarks><maml:para>This command gets the Azure Backup vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. The command passes that vault to the current cmdlet by using the pipeline operator. The current cmdlet changes the storage type to LocallyRedundant. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Stop-AzureRmBackupJob</command:name> <command:verb>Stop</command:verb> <command:noun>AzureRmBackupJob</command:noun> <maml:description><maml:para>Cancels an existing Backup job. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Stop-AzureRmBackupJob cmdlet cancels an existing Azure Backup job. Use this parameter to stop a job that takes too long and blocks other activities. </maml:para> <maml:para>You can cancel only the following types of jobs: </maml:para> <maml:para>- Backup </maml:para> <maml:para>- Restore </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Stop-AzureRmBackupJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Job</maml:name> <maml:Description><maml:para>Specifies a job that this cmdlet cancels. To obtain an AzureRmBackupJob object, use the Get-AzureRmBackupJob cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupJob</command:parameterValue> <dev:type><maml:name>AzureRMBackupJob</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Stop-AzureRmBackupJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>JobID</maml:name> <maml:Description><maml:para>Specifies a job that this cmdlet cancels. To obtain an AzureRmBackupJob object, use the Get-AzureRmBackupJob cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Backup vault in which this cmdlet cancels a job. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Job</maml:name> <maml:Description><maml:para>Specifies a job that this cmdlet cancels. To obtain an AzureRmBackupJob object, use the Get-AzureRmBackupJob cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupJob</command:parameterValue> <dev:type><maml:name>AzureRMBackupJob</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>JobID</maml:name> <maml:Description><maml:para>Specifies a job that this cmdlet cancels. To obtain an AzureRmBackupJob object, use the Get-AzureRmBackupJob cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Backup vault in which this cmdlet cancels a job. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupVault</command:parameterValue> <dev:type><maml:name>AzureRMBackupVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>AzureRmBackupJob</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Stop a backup job by using a job ID</maml:title> <dev:code>PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" PS C:\> $Job = Get-AzureRmBackupJob -Vault $Vault -Operation Backup PS C:\> Stop-AzureRmBackupJob -Vault $Vault -JobID $Job.InstanceId</dev:code> <dev:remarks><maml:para>The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. The command stores that object in the $Vault variable. </maml:para> <maml:para>The second command gets a backup job from the vault in $Vault by using the Get-AzureRmBackupJob cmdlet. The command stores the job in the $Job variable. In this example, there is only one backup operation in the specified vault. </maml:para> <maml:para>The final command stops the job that has the specified ID. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Stop all Restore operations</maml:title> <dev:code>PS C:\>Get-AzureRmBackupJob -Vault $Vault -Operation Restore | Stop-AzureRmBackupJob</dev:code> <dev:remarks><maml:para>This command gets all the restore operations in the vault in $Vault, and then passes them to the current cmdlet by using the pipeline operator. The current cmdlet stops each job. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmBackupJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Wait-AzureRmBackupJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Unregister-AzureRmBackupContainer</command:name> <command:verb>Unregister</command:verb> <command:noun>AzureRmBackupContainer</command:noun> <maml:description><maml:para>Unregisters a container from a Backup vault. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Unregister-AzureRmBackupContainer cmdlet unregisters the Windows Server or Azure virtual machine from an Azure Backup vault. This cmdlet removes references to a container from the Backup vault. Before you can unregister a container, you must delete any protected data associated with that container. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Unregister-AzureRmBackupContainer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Container</maml:name> <maml:Description><maml:para>Specifies the Windows Server or Azure virtual machine that this cmdlet unregisters. To obtain an AzureRmBackupContainer , use the Get-AzureRmBackupContainer cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupContainer</command:parameterValue> <dev:type><maml:name>AzureRMBackupContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Forces the command to run without asking for user confirmation. This parameter is relevant only for AzureBackupContainer objects of type Windows. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Container</maml:name> <maml:Description><maml:para>Specifies the Windows Server or Azure virtual machine that this cmdlet unregisters. To obtain an AzureRmBackupContainer , use the Get-AzureRmBackupContainer cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMBackupContainer</command:parameterValue> <dev:type><maml:name>AzureRMBackupContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Forces the command to run without asking for user confirmation. This parameter is relevant only for AzureBackupContainer objects of type Windows. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>AzureBackupContainer</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>AzureBackupJob</maml:name> </dev:type> <maml:description><maml:para>This cmdlet returns $Null if the container type is Windows Server. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para>* None </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Unregister a Windows Server</maml:title> <dev:code>PS C:\>$Vault = Get-AzureRmBackupVault -Name "Vault03" PS C:\> $Container = Get-AzureRmBackupContainer -Vault $Vault -Type Windows -Name "server01.contoso.com" PS C:\> Unregister-AzureRmBackupContainer -Container $Container[0] Unregister Server This operation will delete all data in the backup vault that is associated with the server. Are you sure you want to unregister the server? [] Yes [] No [?] Help (default is "No"): Yes</dev:code> <dev:remarks><maml:para>The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. The command stores that object in the $Vault variable. </maml:para> <maml:para>The second command gets a container that has the specified name in the vault in $Vault by using the Get-AzureRmBackupContainer cmdlet. The command stores that object in the $Container variable. </maml:para> <maml:para>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:example> <command:example><maml:title>Example 2: Unregister a Windows Server without confirmation</maml:title> <dev:code>PS C:\>Unregister-AzureRmBackupContainer -Container $Container[0] -Force</dev:code> <dev:remarks><maml:para>This command unregisters the specified Windows Server from the Azure Backup vault, just as in the first example. This command specifies the Force parameter. Therefore, the command does not prompt you for confirmation. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmBackupContainer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmBackupVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Register-AzureRmBackupContainer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Wait-AzureRmBackupJob</command:name> <command:verb>Wait</command:verb> <command:noun>AzureRmBackupJob</command:noun> <maml:description><maml:para>Waits for a Backup job to finish. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Wait-AzureRmBackupJob cmdlet waits for an Azure Backup job to finish. Backup jobs can take a long time. If you run a backup job as part of a script, you may want to force the script to wait for job to finish before it continues to other tasks. </maml:para> <maml:para>A script that includes this cmdlet can be simpler than one that polls the Backup service for the job status. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Wait-AzureRmBackupJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Job</maml:name> <maml:Description><maml:para>Specifies a job that this cmdlet cancels. To obtain an AzureRmBackupJob object, use the Get-AzureRmBackupJob cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type><maml:name>Object</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>TimeOut</maml:name> <maml:Description><maml:para>Specifies the maximum time, in seconds, that this cmdlet waits for the job to finish. We recommend that you specify a time-out value. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type><maml:name>Int64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Job</maml:name> <maml:Description><maml:para>Specifies a job that this cmdlet cancels. To obtain an AzureRmBackupJob object, use the Get-AzureRmBackupJob cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type><maml:name>Object</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>TimeOut</maml:name> <maml:Description><maml:para>Specifies the maximum time, in seconds, that this cmdlet waits for the job to finish. We recommend that you specify a time-out value. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type><maml:name>Int64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>AzureRmBackupJob</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>AzureRmBackupJob[]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>1:</maml:title> <dev:code></dev:code> <dev:remarks><maml:para> </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmBackupJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Stop-AzureRmBackupJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |