Set-VBOAzureBlobAccount

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

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
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.	`VBOAzureBlobAccount`	True	Named	False
Description	Specifies a description. The cmdlet will add this description to Microsoft Azure Blob Storage account credentials.	`String`	False	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

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Learn.

Output Object

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

Examples

Set-VBOAzureBlobAccount Example 1: Modifying Shared Key for 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:

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

Set-VBOAzureBlobAccount Example 2: Modifying Login Name for Microsoft Azure Blob Storage Account Credentials

This example shows how to modify a 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:

Run the Get-VBOAzureBlobAccount cmdlet. Save the result to the $account variable.
Run the Get-VBOEncryptionKey cmdlet. Save the result to the $key variable.
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-VBOAzureBlobAccount Example 3: Modifying Description for Microsoft Azure Blob Storage Account Credentials

This example shows how to modify a 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:

Run the Get-VBOAzureBlobAccount cmdlet. Save the result to the $account variable.
Run the Get-VBOEncryptionKey cmdlet. Save the result to the $key variable.
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.