Windows Azure Online Backup Cmdlets in Windows PowerShell
Applies To: Windows 10, Windows Server Technical Preview
Windows PowerShell® is a task-based command-line shell and scripting language designed especially for system administration. This reference topic for the information technology (IT) professional provides assistance in utilizing the Windows PowerShell cmdlets to script and automate tasks.
This reference provides cmdlet descriptions and syntax for all Online Backup (OB)-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.
| cmdlet | Description |
|---|---|
Adds the OBFileSpec object, which specifies the items to include or exclude from a backup, to the backup policy (OBPolicy object). |
|
Shows the user a list of recovery points for each successful backup that was completed from a specific server. |
|
Gets the array of OBAlternateBackupServer objects, that represents all servers that are associated to the specified backup account except for the local server, upon providing valid credentials. |
|
Gets the list of OBFileSpec objects associated with the specified backup policy (OBPolicy object). |
|
Gets information about how Backup creates the initial backup copy, which can be either over the network, or by using a disk you send to an Azure data center. |
|
Gets a list of operations from a server as OBJob objects. |
|
Gets the OBMachineSetting object for the server with respect to proxy details for accessing the internet, throttling settings and encryption passphrase that will be required to decrypt the files during recovery. |
|
Gets the amount of storage consumed on Windows Azure Online Backup by data backed-up from this server. |
|
Gets array of OBNotification objects which are applicable for the customer. |
|
Gets the current backup policy set for the server. |
|
Gets the PolicyState of the backup policy set for the server. The state can be “Valid” “Deleted” or “paused”. |
|
Gets the array of OBRecoverableItem objects associated with the server. |
|
Specifies the username and password used for authentication to perform the operation. |
|
Gets the current retention policy for backups in the backup policy (OBPolicy object). |
|
Gets the OBSchedule object, which includes the days of the week and times of day to create daily backups, for the specified OBPolicy object. |
|
Creates a new OBFileSpec object based on the parameters that are specified. |
|
Creates a new OBPagingContext object that is used in Get-OBRecoverableItem cmdlet for Search and Browse of paginated recoverable items. |
|
Generates an empty OBPolicy object. |
|
Creates a new OBRecoverableItem for the given path. |
|
Specifies the recovery options that will apply to all the recoverable items during recovery. |
|
Creates a new OBRetentionPolicy specifying the number of days that the backup needs to be retained. |
|
Creates a new OBSchedule object based on the days of the week and times of day to create daily backups. |
|
Removes the list of items to include or exclude from a backup, as specified by the OBFileSpec object, from a backup policy (OBPolicy object). |
|
Removes the currently set backup policy (OBPolicy object). |
|
Maps a backed up volume to its new name after an operating system reinstallation of the backed up server. |
|
Specifies how Backup creates an initial backup copy, which can be either over the network, or by using a disk you send to an Azure data center. |
|
Sets a OBMachineSetting object for the server with respect to proxy details for accessing the internet, throttling settings and encryption passphrase that will be required to decrypt the files during recovery. |
|
Sets the OBPolicy object as the backup policy that will be used for scheduled backups. |
|
Takes a policy input and sets the policy’s state. The state can be “Valid” “Deleted” or “paused”. |
|
Sets the retention policy for the backup policy (OBPolicy object). |
|
Sets the OBSchedule object, which includes the days of the week and times of day to create daily backups, for the backup policy (OBPolicy object). |
|
Starts a one-time backup operation based on the specified OBPolicy. |
|
Recovers the array of OBRecoverableItem objects with the specified recovery options in the OBRecoverableOptions object. |
|
Registers the current computer to the Online Backup Service using the credentials (username and password) created during enrollment. |
|
Stops the specified backup or recovery job. |
Note
To list all the cmdlets that are available, use the Get-Command -Module MSOnlineBackup cmdlet.
For more information about, or for the syntax of, any of the cmdlets, use the Get-Help <cmdlet name> cmdlet, where <cmdlet name> is the name of the cmdlet that you want to research. For more detailed information, you can run any of the following cmdlets:
● Get-Help <cmdlet name> -Detailed
● Get-Help <cmdlet name> -Examples
● Get-Help <cmdlet name> -Full