Export (0) Print
Expand All

Windows Azure Online Backup Cmdlets in Windows Powershell

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

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.

Windows Azure Online Backup

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

Add-OBFileSpec

Adds the OBFileSpec object, which specifies the items to include or exclude from a backup, to the backup policy (OBPolicy object).

Get-OBAllRecoveryPoints

Shows the user a list of recovery points for each successful backup that was completed from a specific server.

Get-OBAlternateBackupServer

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.

Get-OBFileSpec

Gets the list of OBFileSpec objects associated with the specified backup policy (OBPolicy object).

Get-OBJob

Gets a list of operations from a server as OBJob objects.

Get-OBMachineSetting

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.

Get-OBMachineUsage

Gets the amount of storage consumed on Windows Azure Online Backup by data backed-up from this server.

Get-OBNotification

Gets array of OBNotification objects which are applicable for the customer.

Get-OBPolicy

Gets the current backup policy set for the server.

Get-OBPolicyState

Gets the PolicyState of the backup policy set for the server. The state can be “Valid” “Deleted” or “paused”.

Get-OBRecoverableItem

Gets the array of OBRecoverableItem objects associated with the server.

Get-OBRecoverableSource

Specifies the username and password used for authentication to perform the operation.

Get-OBRetentionPolicy

Gets the current retention policy for backups in the backup policy (OBPolicy object).

Get-OBSchedule

Gets the OBSchedule object, which includes the days of the week and times of day to create daily backups, for the specified OBPolicy object.

New-OBFileSpec

Creates a new OBFileSpec object based on the parameters that are specified.

New-OBPagingContext

Creates a new OBPagingContext object that is used in Get-OBRecoverableItem cmdlet for Search and Browse of paginated recoverable items.

New-OBPolicy

Generates an empty OBPolicy object.

New-OBRecoverableItem

Creates a new OBRecoverableItem for the given path.

New-OBRecoveryOption

Specifies the recovery options that will apply to all the recoverable items during recovery.

New-OBRetentionPolicy

Creates a new OBRetentionPolicy specifying the number of days that the backup needs to be retained.

New-OBSchedule

Creates a new OBSchedule object based on the days of the week and times of day to create daily backups.

Remove-OBFileSpec

Removes the list of items to include or exclude from a backup, as specified by the OBFileSpec object, from a backup policy (OBPolicy object).

Remove-OBPolicy

Removes the currently set backup policy (OBPolicy object).

Rename-OBVolume

Maps a backed up volume to its new name after an operating system reinstallation of the backed up server.

Set-OBMachineSetting

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.

Set-OBPolicy

Sets the OBPolicy object as the backup policy that will be used for scheduled backups.

Set-OBPolicyState

Takes a policy input and sets the policy’s state. The state can be “Valid” “Deleted” or “paused”.

Set-OBRetentionPolicy

Sets the retention policy for the backup policy (OBPolicy object).

Set-OBSchedule

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).

Start-OBBackup

Starts a one-time backup operation based on the specified OBPolicy.

Start-OBRecovery

Recovers the array of OBRecoverableItem objects with the specified recovery options in the OBRecoverableOptions object.

Start-OBRegistration

Registers the current computer to the Online Backup Service using the credentials (username and password) created during enrollment.

Stop-OBJob

Stops the specified backup or recovery job.

noteNote
To list all the cmdlets that are available, use the Get-Command -Module MSOnlineBackup cmdlet.

More Information

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft