Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
PowerShell Reference

Connect-VBRAzureBlobService

Short Description

Connects to Azure Blob storage.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus

Syntax

Connect-VBRAzureBlobService -Account <VBRAzureBlobAccount> -RegionType <VBRAzureBlobRegionType> {Global | Germany | China | Government} [-GatewayServer <CHost>]  [<CommonParameters>]

Detailed Description

This cmdlet connects to Azure Blob storage. It creates the VBRAzureBlobConnection object that contains connection settings for Azure Blob storage. You can use these settings to add Azure Blob storage into your Veeam Backup & Replication infrastructure as an external repository or as an object storage repository.

Connect-VBRAzureBlobService Note:

  • It is recommended to disconnect the 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 Disconnect-VBRAzureBlobService to stop the session.
  • To get the current session, save the result that you get after you run Connect-VBRAzureBlobService to a variable.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Account

Specifies an Azure Blob credentials record. The cmdlet will use this credentials record to connect to Azure Blob storage.

Accepts the VBRAzureBlobAccount type.

True

Named

True (ByValue)

 

RegionType

Specifies the region type of Azure Blob storage. The cmdlet will connect to the selected region type and will set up a connection with Azure Blob storage. You can select the following types of regions:

  • Global
  • Germany
  • Government
  • China

False

Named

False

 

GatewayServer

Specifies a gateway server that you want to use to access Azure Blob storage.

False

Named

False

 

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

Example 1

This example shows how to connect to Azure Blob storage.

  1. Run Get-VBRAzureBlobAccount to get the Azure Blob credentials record. Save the result to the $account variable.
  2. Run Connect-VBRAzureBlobService with the $account variable. Save the result to the $connect variable. You will need this variable to disconnect from Azure Blob storage.

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

$connect = Connect-VBRAzureBlobService -Account $account

Example 2

This example shows how to connect to Azure Blob storage. Veeam Backup & Replication will use a gateway server to connect to Azure Blob storage.

  1. Run Get-VBRAzureBlobAccount to get the Azure Blob credentials record. Save the result to the $account variable.
  2. Run Get-VBRServer to specify the host that you want to use as a gateway server. Save the result to the $gate variable.
  3. Run Connect-VBRAzureBlobService with the $account and $gate variables. Use the RegionType parameter to specify the type of the Azure Blob region. Save the result to the $connect variable. You will need this variable to disconnect from Azure Blob storage.

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

$gate = Get-VBRServer -Name "North.tech.local"

$connect = Connect-VBRAzureBlobService -Account $account -RegionType Global -GatewayServer $gate

Related Commands

Get-VBRAzureBlobAccount

Get-VBRServer

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions Reference

Veeam Availability for Nutanix AHV Documentation

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation