Connect-VBRAzureBlobService

In this article

    Short Description

    Connects to Microsoft Azure Blob storage.

    Platform: VMware, Hyper-V

    Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

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

    Detailed Description

    This cmdlet connects to Microsoft Azure Blob storage. It creates the VBRAzureBlobConnection object that contains connection settings for Microsoft Azure Blob storage. You can use these settings to add Microsoft Azure Blob storage into your Veeam Backup & Replication infrastructure as the following types of repositories:

    • An external repository..
    • A capacity extent of a scale-out backup repository.
    • An archive extent of a scale-out backup repository.

    Connect-VBRAzureBlobService Note:

    • 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-VBRAzureBlobService cmdlet to a variable.

    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 Microsoft Azure Blob storage.

    Accepts the VBRAzureBlobAccount object. To get this object, run the Get-VBRAzureBlobAccount cmdlet.

    True

    Named

    True (ByValue)

    RegionType

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

    • Global
    • Germany
    • Government
    • China

    String

    True

    Named

    False

    ServiceType

    Specifies the type of the connection to Microsoft Azure Blob storage:

    • ExternalRepository - use this option to connect to Microsoft Azure Blob storage that will be added as an external backup repository.
    • CapacityTier - use this option to connect to Microsoft Azure Blob storage that will be added as a capacity extent.
    • ArchiveTier - use this option to connect to Microsoft Azure Blob storage that will be added as an archive extent.

    SwitchParameter

    True

    Named

    False

    GatewayServer

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

    CHost

    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

    This cmdlet returns the VBRAzureBlobService object that contains connection settings for Microsoft Azure Blob storage.

    Examples

    Connect-VBRAzureBlobServiceExample 1. Connecting to Microsoft Azure Blob Storage as External Repository

    This example shows how to connect to Microsoft Azure Blob storage that will be added as an external backup repository.

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

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

    Perform the following steps:

    1. Run the Get-VBRAzureBlobAccount cmdlet. Specify the Name parameter value. Save the result to the $account variable.
    2. Run the Connect-VBRAzureBlobService cmdlet. Specify the following settings:
    • Set the $connect variable as the Account parameter value.
    • Specify the RegionType parameter value.
    • Specify the ServiceType parameter value.

    Connect-VBRAzureBlobServiceExample 2. Connecting to Microsoft Azure Blob Storage as Capacity Extent

    This example shows how to connect to Microsoft Azure Blob storage that will be added as a capacity extent.

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

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

    Perform the following steps:

    1. Run the Get-VBRAzureBlobAccount cmdlet. Specify the Name parameter value. Save the result to the $account variable.
    2. Run the Connect-VBRAzureBlobService cmdlet. Specify the following settings:
    • Set the $connect variable as the Account parameter value.
    • Specify the RegionType parameter value.
    • Specify the ServiceType parameter value.

    Connect-VBRAzureBlobServiceExample 3. Connecting to Microsoft Azure Blob Storage Using Specific Gateway Server

    This example shows how to connect to Microsoft Azure Blob storage. Veeam Backup & Replication will use the North.tech.local gateway server to connect to Microsoft Azure Blob storage.

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

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

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

    Perform the following steps:

    1. Run the Get-VBRAzureBlobAccount cmdlet. Specify the Name parameter value. Save the result to the $account variable.
    2. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $gate variable.
    3. Run the Connect-VBRAzureBlobService cmdlet. Specify the following settings:
    • Set the $connect variable as the Account parameter value.
    • Specify the RegionType parameter value.
    • Specify the ServiceType parameter value.

    Connect-VBRAzureBlobServiceExample 4. Connecting to Microsoft Azure Blob Storage as Archive Extent

    This example shows how to connect to Microsoft Azure Blob storage that will be added as an archive extent.

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

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

    Perform the following steps:

    1. Run the Get-VBRAzureBlobAccount cmdlet. Specify the Name parameter value. Save the result to the $account variable.
    2. Run the Connect-VBRAzureBlobService cmdlet. Specify the following settings:
    • Set the $connect variable as the Account parameter value.
    • Specify the RegionType parameter value.
    • Specify the ServiceType parameter value.

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.