Connect-VBRAzureDataBoxService

Short Description

Connects to Azure Data Box storage.

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Connect-VBRAzureDataBoxService -Account <VBRAzureBlobAccount> -ServicePoint <String> [-GatewayServer <CHost[]>]

[-ConnectionType <VBRRepositoryConnectionType>] [-Force] [<CommonParameters>]

Detailed Description

This cmdlet connects to Azure Data Box storage.

Important

This cmdlet connects only the Azure Data Box storage that can be used as a capacity extent of the scale-out backup repository.

Note

Consider the following:

It is recommended to disconnect the Microsoft Azure Blob session at the end. Otherwise, the information that you get within the session will not be refreshed when you connect again, and outdated data will be used then. Run the Disconnect-VBRAzureBlobService cmdlet to stop the session.
To get the current session, save the result that you get after you run the Connect-VBRAzureDataBoxService cmdlet to a variable.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Account	Specifies a Microsoft Azure Blob credentials record. The cmdlet will use this credentials record to connect to Azure Data Box storage. Accepts the `VBRAzureBlobAccount` object. To get this object, run the `Connect-VBRAzureBlobService` cmdlet.	`VBRAzureBlobAccount`	True	Named	True (ByValue)
ConnectionType	Specifies how Veeam Backup & Replication will access the object storage repository: `Direct`: Use this option if you want Veeam Backup & Replication to use a proxy server to transfer data from the processed VM to object storage repositories. `Gateway`: Use this option if you want Veeam Backup & Replication to use a gateway server to transfer data from processed VM to object storage repositories. Note: Provide the `GatewayServer` parameter to specify the server. Default: `Direct`.	`VBRRepositoryConnectionType`	False	Named	False
Force	Defines that the cmdlet will skip the certificate check. If you do not provide this parameter, Veeam Backup & Replication will check that the Azure Data Box certificate is valid.	`SwitchParameter`	False	Named	False
GatewayServer	Specifies an array of gateway servers that you want to use to transfer data from processed VM to object storage repositories.	`CHost[]`	False	Named	False
ServicePoint	Specifies the endpoint. The cmdlet will use this endpoint to connect to Azure Data Box object storage.	`String`	True	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

This cmdlet returns the VBRAzureDataBoxService object that contains connection settings to Azure Data Box storage.

Examples

Connecting to Azure Data Box Storage

This example shows how to connect to Azure Data Box storage.

$account = Get-VBRAzureBlobAccount -Name "Microsoft Azure Blob"

$connect = Connect-VBRAzureBlobService -Account $account -RegionType Global -ServiceType CapacityTier

Connect-VBRAzureDataBoxService -Account $connect -ServicePoint "ZTX15910049.microsoftdatabox.com"

Perform the following steps:

Run the Get-VBRAzureBlobAccount cmdlet. Specify the Name parameter value. Save the result to the $account variable.
Run the Connect-VBRAzureBlobService cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType and the ServiceType parameter values. Save the result to the $connect variable.
Run the Connect-VBRAzureDataBoxService cmdlet. Set the $connect variable as the Account parameter value. Specify the ServicePoint parameter value.