Set-VBOAzureBlobAccount

In this article

    Short Description

    Modifies Microsoft Azure Blob storage account credentials.

    Syntax

    Set-VBOAzureBlobAccount -Account <VBOAzureBlobAccount> [-Name <string>] [-SharedKey <securestring>] [-Description <string>]  [<CommonParameters>]

    Detailed Description

    This cmdlet modifies storage account credentials for Microsoft Azure Blob storage. To modify settings, you need to enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Account

    Specifies Microsoft Azure Blob storage account credentials that you want to modify.

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

    True

    Named

    False

     

    Name

    Specifies the Microsoft Azure Blob login name. The cmdlet will add this login name to Microsoft Azure Blob storage account credentials.

    String

    False

    Named

    False

     

    SharedKey

    Specifies a shared key. The cmdlet will use this shared key to add Microsoft Azure Blob storage account credentials.

    SecureString

    False

    Named

    False

     

    Description

    Specifies a description. The cmdlet will add this description to Microsoft Azure Blob storage account credentials.

    String

    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.

    Output Object

    The cmdlet returns the VBOAzureBlobAccount object that contains storage account credentials for Microsoft Azure Blob storage.

    Examples

    Set-VBOAzureBlobAccountExample 1. Modifying Shared Key of Microsoft Azure Blob Storage Account Credentials

    This example shows how to modify a shared key of the storage account credentials for Microsoft Azure Blob storage.

    $securepassword = Read-Host "Enter your password" -AsSecureString

    Enter your password: **********

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

    Set-VBOAzureBlobAccount -Account $account -SharedKey $securepassword

    Perform the following steps:

    1. Create a new secure password:
    1. Run the Read-Host cmdlet. Specify the message that the console will display as a prompt. Specify the AsSecureString parameter. Save the result to the $securepassword variable.
    2. Enter the password.
    1. Run the Get-VBOAzureBlobAccount cmdlet. Save the result to the $account variable.
    2. Run the Set-VBOAzureBlobAccount cmdlet. Set the $account variable as the Account parameter value. Set the $securepassword as the SharedKey parameter value.

    Set-VBOAzureBlobAccountExample 2. Modifying Login Name of Microsoft Azure Blob Storage Account Credentials

    This example shows how to modify the login name of the storage account credentials for Microsoft Azure Blob storage.

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

    $key =  Get-VBOEncryptionKey

    Set-VBOAzureBlobAccount -Account $account -SharedKey $key -Name "Veeam Azure"

    Perform the following steps:

    1. Run the Get-VBOAzureBlobAccount cmdlet. Save the result to the $account variable.
    2. Run the Get-VBOEncryptionKey cmdlet. Save the result to the $key variable.
    3. Run the Set-VBOAzureBlobAccount cmdlet. Specify the following settings:
    • Set the $account variable as the Account parameter value.
    • Set the $key variable as the SharedKey parameter value.
    • Specify the Name parameter value.

    Set-VBOAzureBlobAccountExample 3. Modifying Description of Microsoft Azure Blob Storage Account Credentials

    This example shows how to modify the description of the storage account credentials for Microsoft Azure Blob storage.

    $account = Get-VBOAzureBlobAccount -Name "Veeam Azure Admin"

    $key =  Get-VBOEncryptionKey

    Set-VBOAzureBlobAccount -Account $account -SharedKey $key -Description "Veeam Azure Administrator"

    Perform the following steps:

    1. Run the Get-VBOAzureBlobAccount cmdlet. Save the result to the $account variable.
    2. Run the Get-VBOEncryptionKey cmdlet. Save the result to the $key variable.
    1. Run the Set-VBOAzureBlobAccount cmdlet. Specify the following settings:
    • Set the $account variable as the Account parameter value.
    • Set the $key variable as the SharedKey parameter value.
    • Specify the Description parameter value.

    Related Commands