Remove-VBOAmazonS3CompatibleAccount

Short Description

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

Syntax

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

Detailed Description

This cmdlet removes account credentials from the Veeam Backup for Microsoft 365 infrastructure for the following types of object storage:

Amazon S3 Compatible object storage.
IBM Cloud Object Storage.
Wasabi Cloud Object Storage.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Account	Specifies S3 Compatible storage account credentials that you want to remove.	Accepts the VBOAmazonS3CompatibleAccount object. To get this object, run the Get-VBOAmazonS3CompatibleAccount cmdlet.	True	Named	False	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	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	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Account

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

Accepts the VBOAmazonS3CompatibleAccount object.

To get this object, run the Get-VBOAmazonS3CompatibleAccount 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.

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-VBOAmazonS3CompatibleAccount Example 1. Removing S3 Compatible Storage Account Credentials

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

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

Remove-VBOAmazonS3CompatibleAccount -Account $account

Perform the following steps:

Run the Get-VBOAmazonS3CompatibleAccount 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-VBOAmazonS3CompatibleAccount Example 2. Removing S3 Compatible Storage Account Credentials (Using Pipeline)

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

Get-VBOAmazonS3CompatibleAccount | Remove-VBOAmazonS3CompatibleAccount

Perform the following steps:

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

Related Commands

Get-VBOAmazonS3CompatibleAccount