Set-OBInitialBackupCreationMethod
Set-OBInitialBackupCreationMethod
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 datacenter.
Syntax
Parameter Set: Default
Set-OBInitialBackupCreationMethod -Policy <CBPolicy> [-AzureImportJobName <String> ] [-AzurePublishSettings <String> ] [-AzureStorageAccount <String> ] [-AzureStorageContainer <String> ] [-AzureSubscriptionID <String> ] [-IBMethod <String> ] [-StagingLocation <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-OBInitialBackupCreationMethod cmdlet specifies whether Azure Backup creates an initial backup copy automatically over the network, or offline by using the Azure Import/Export service. To create an offline backup, you use an Azure import job that notifies the Import/Export service that you are shipping hard drives to an Azure data center. If you specify an offline backup, this cmdlet provides parameters to identify the Azure import job and move the backup copy from the storage container to the backup vault.
Parameters
-AzureImportJobName<String>
Specifies the name of the import job.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AzurePublishSettings<String>
Specifies the path to the publish settings file that contains information about the storage account that you use to move the backup copy to the backup vault.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AzureStorageAccount<String>
Specifies an Azure Storage account that the Azure import job uses to copy the initial backup copy from the on-premises installation to an Azure data center.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AzureStorageContainer<String>
Specifies an Azure Storage container that the Azure import job uses to copy the initial backup copy from the on-premises installation to an Azure data center.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AzureSubscriptionID<String>
Specifies an Azure Subscription ID that the Azure import job uses to copy the initial backup copy from the on-premises installation to an Azure data center.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-IBMethod<String>
Specifies the method that Azure Backup uses to create the initial backup copy. This can be either through the network or by using an offline backup to ship a disk to an Azure data center. The acceptable values for this parameter are: Network, OfflineBackup.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Policy<CBPolicy>
Specifies the online backup policy associated with the server.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-StagingLocation<String>
Specifies the path to the staging location at which to create the initial backup copy. This backup copy is then copied from the staging location to the disk and shipped to the Azure data center using an Azure import job.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Specify that Backup creates the initial backup copy over the network
This command specifies that Backup creates the initial backup copy automatically, by using the network. The $Policy01 variable contains the server policy that you can retrieve using Get-OBPolicy.
PS C:\> Set-OBInitialBackupCreationMethod -Policy $Policy01 -IBMethod "Network"
Example 2: Specify that Backup creates the initial backup copy offline
This command specifies that Backup creates the initial backup copy offline, by using an import job named BackupJob01. The parameters also specify the staging location at which to create the initial backup copy, the name of the import job that notifies the Import/Export service that you are shipping hard drives to a data center, and the publish file, Azure Subscription ID, Storage account, and Storage container that the import job uses.
PS C:\> Set-OBInitialBackupCreationMethod -Policy $Policy01 -IBMethod "OfflineBackup" -StagingLocation "D:\SalesData" -AzureImportJobName "BackupJob01" -AzurePublishSettings "C:\Users\Downloads\AzureOrg.publishsettings" -AzureSubscriptionID "a53949b2-82fd-4d4d-853a-509b6e6e07ca" -AzureStorageAccount "BackupFinanceAccount" -AzureStorageContainer "SalesStorage"