Set-VBOAmazonS3CompatibleAccount

In this article

    Short Description

    Modifies S3 Compatible storage account credentials.

    Syntax

    Set-VBOAmazonS3CompatibleAccount -Account <VBOAmazonS3CompatibleAccount> [-AccessKey <string>] [-SecurityKey <securestring>] [-Description <string>]  [<CommonParameters>]

    Detailed Description

    This cmdlet modifies account credentials for the following types of object storage:

    • S3 Compatible object storage.
    • IBM Cloud object 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 S3 Compatible storage account credentials that you want to modify.

    Accepts the VBOAmazonS3CompatibleAccount object.

    To get this object, run the Get-VBOAmazonS3CompatibleAccount cmdlet.

    True

    Named

    False

    False

    AccessKey

    Specifies an access key. The cmdlet will use this key to add S3 Compatible storage account credentials to Veeam Backup for Microsoft 365.

    String

    False

    Named

    False

    False

    SecurityKey

    Specifies a secret key. The cmdlet will use this secret key to add the S3 Compatible storage account credentials to Veeam Backup for Microsoft 365.

    SecureString

    False

    Named

    False

    False

    Description

    Specifies a description for S3 Compatible storage account credentials.

    String

    False

    Named

    False

    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 VBOAmazonS3CompatibleAccount object that contains S3 Compatible storage account credentials.

    Examples

    Set-VBOAmazonS3CompatibleAccountExample 1. Modifying Access Key for S3 Compatible Storage Account Credentials

    This example shows how to modify access key for S3 Compatible storage account credentials that are added to Veeam Backup for Microsoft 365.

    $account = Get-VBOAmazonS3CompatibleAccount -AccessKey "?Iqws8NewidZydk"

    Set-VBOAmazonS3CompatibleAccount -Account $account -AccessKey "%92$sQ}i1qblpQb"

    Perform the following steps:

    1. Run the Get-VBOAmazonS3CompatibleAccount cmdlet. Specify the AccessKey parameter value. Save the result to the $account variable.
    2. Run the Set-VBOAmazonS3CompatibleAccount cmdlet. Set the $account variable as the Account parameter value. Specify a new value for the AccessKey parameter.

    Set-VBOAmazonS3CompatibleAccountExample 2. Modifying Security Key for S3 Compatible Storage Account Credentials

    This example shows how to modify security key for S3 Compatible storage account credentials that are added to Veeam Backup for Microsoft 365.

    $account = Get-VBOAmazonS3CompatibleAccount -Id 1dfc5af0-2605-47ac-94d8-13dea4d14608

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

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

    Set-VBOAmazonS3CompatibleAccount -Account $account -AccessKey "?Iqws8NewidZydk" -SecurityKey $securepassword

    Perform the following steps:

    1. Run the Get-VBOAmazonS3CompatibleAccount cmdlet. Specify the Id parameter value. Save the result to the $account variable.
    2. 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.
    3. Enter the password.
    4. Run the Set-VBOAmazonS3CompatibleAccount cmdlet. Specify the following settings:
    • Set the $account variable as the Account parameter value.
    • Specify the AccessKey parameter value.
    • Set the $securepassword variable as the SecurityKey parameter value.

    Set-VBOAmazonS3CompatibleAccountExample 3. Modifying Description for S3 Compatible Storage Account Credentials

    This example shows how to modify description for S3 Compatible storage account credentials that are added to Veeam Backup for Microsoft 365.

    $account = Get-VBOAmazonS3CompatibleAccount -Id 1dfc5af0-2605-47ac-94d8-13dea4d14608

    Set-VBOAmazonS3CompatibleAccount -Account $account -Description "Administrator Credential Records"

    Perform the following steps:

    1. Run the Get-VBOAmazonS3CompatibleAccount cmdlet. Specify the Id parameter value. Save the result to the $account variable.
    2. Run the Set-VBOAmazonS3CompatibleAccount cmdlet. Set the $account variable as the Account parameter value. Specify the Description parameter value.

    Related Commands