Get-VBRAzureBlobFolder

Short Description

Returns Microsoft Azure Blob folders.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Get-VBRAzureBlobFolder -Container <VBRAzureBlobContainer[]> -Connection <VBRAzureBlobConnection> [-Name<string[]>]  [<CommonParameters>]

Detailed Description

This cmdlet returns an array of Microsoft Azure Blob folders. You can get the array of all folders from your Microsoft Azure Blob storage or the array of the folders from the particular container.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Container

Specifies an array of Microsoft Azure Blob containers. The cmdlet will return the folders from these containers.

Accepts the VBRBlobContainer[] type.

True

Named

True (ByValue)

 

Connection

Specifies an active session with Microsoft Azure Blob storage.

Accepts the following types:

  • VBRAzureBlobConnection
  • VBRAzureDataBoxConnection

True

Named

False

 

Name

Specifies a name of the Microsoft Azure Blob folder that you want to get.

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 get all folders from Microsoft Azure Blob storage.

  1. Run Get-VBRAzureBlobAccount to get the Microsoft Azure Blob credentials record. Save the result to the $account variable.
  2. Run Connect-VBRAzureBlobService with the $account variable to connect to Microsoft Azure Blob storage. Use the RegionType parameter to specify the type of the region. Save the result to the $connect variable.
  3. Run Get-VBRAzureBlobContainer with the $connect variable to get the Microsoft Azure Blob container. Save the result to the $container variable.
  4. Run Get-VBRAzureBlobFolder with the $container and $connect variables.

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

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

$container = Get-VBRAzureBlobContainer -Connection $connect

Get-VBRAzureBlobFolder -Container $Container -Connection $connect

Example 2

This example shows how to get all folders from a specific Microsoft Azure Blob container.

  1. Run Get-VBRAzureBlobAccount to get the Microsoft Azure Blob credentials record. Save the result to the $account variable.
  2. Run Connect-VBRAzureBlobService to connect to Microsoft Azure Blob storage. Save the result to the $connect variable.
  3. Run Get-VBRAzureBlobContainer with the $connect variable. Use the Name parameter to specify the name of the Microsoft Azure Blob container. Save the result to the $container variable.
  4. Run Get-VBRAzureBlobFolder with the $container and $connect variables.

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

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

$container = Get-VBRAzureBlobContainer -Connection $connect -Name "Container"

Get-VBRAzureBlobFolder -Container $Container -Connection  $connect

Example 3

This example shows how to get a specific folder from Microsoft Azure Blob storage.

  1. Run Get-VBRAzureBlobAccount to get the Microsoft Azure Blob credentials record. Save the result to the $account variable.
  2. Run Connect-VBRAzureBlobService to connect to Microsoft Azure Blob storage. Save the result to the $connect variable.
  3. Run Get-VBRAzureBlobContainer with the $connect variable. Use the Name parameter to specify the name of the Microsoft Azure Blob container. Save the result to the $container variable.
  4. Run Get-VBRAzureBlobFolder with the $container and $connect variables. Use the Name parameter to specify the name of the Microsoft Azure Blob folder that you want to get.

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

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

$container = Get-VBRAzureBlobContainer -Connection $connect

Get-VBRAzureBlobFolder -Container $container -Connection  $connect -Name "New Folder"

Related Commands

Get-VBRAzureBlobAccount

Connect-VBRAzureBlobService

Get-VBRAzureBlobContainer