Remove-VBOAmazonS3Account

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
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	True (ByValue)
WhatIf	Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action. Default: False	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. Default: True	SwitchParameter	False	Named	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

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

True (ByValue)

WhatIf

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

Default: False

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.

Default: True

SwitchParameter

False

Named

False

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-VBOAmazonS3Account Example 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:

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

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

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

Get-VBOAmazonS3Account | Remove-VBOAmazonS3Account

Perform the following steps:

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

Related Commands

Get-VBOAmazonS3Account