Remove-VBOAmazonS3Account

In this article

    Short Description

    Removes Amazon S3 storage account credentials from Veeam Backup for Microsoft 365.

    Syntax

    Remove-VBOAmazonS3Account -Account <VBOAmazonS3Account> [-WhatIf] [-Confirm]  [<CommonParameters>]

    Detailed Description

    This cmdlet removes Amazon S3 storage account credentials from Veeam Backup for Microsoft 365.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Account

    Specifies Amazon S3 storage account credentials that you want to remove.

    Accepts the VBOAmazonS3Account object.

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

    True

    Named

    False

     

    WhatIf

    Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.

    SwitchParameter

    False

    Named

    False

     

    Confirm

    Defines that the cmdlet will display a prompt that asks if the user is sure that he wants to continue.

    SwitchParameter

    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

    None.

    Examples

    Remove-VBOAmazonS3AccountExample 1. Removing Amazon S3 Storage Account Credentials

    This example shows how to remove Amazon S3 storage account credentials.

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

    Remove-VBOAmazonS3Account -Account $account

    Perform the following steps:

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

    Remove-VBOAmazonS3AccountExample 2. Removing Amazon S3 Storage Account Credentials (Using Pipeline)

    This command removes Amazon S3 storage account credentials.

    Get-VBOAmazonS3Account | Remove-VBOAmazonS3Account

    Perform the following steps:

    1. Run the Get-VBOAmazonS3Account cmdlet.
    2. Pipe the cmdlet output to the Remove-VBOAmazonS3Account cmdlet.

    Related Commands

    Get-VBOAmazonS3Account