Remove-VBRCloudProviderCredentials

Short Description

Removes cloud provider credentials records from Veeam Backup & Replication.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Remove-VBRCloudProviderCredentials -Credentials <VBRCloudProviderCredentials> [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet removes cloud provider credentials records from Veeam Backup & Replication.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Credentials	Specifies cloud provider credentials records that you want to remove.	Accepts the VBRCloudProviderCredentials object. To get this object, run the Get-VBRCloudProviderCredentials cmdlet.	True	0	True (ByValue)
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 you want to continue running the command. Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false.	SwitchParameter	False	Named	False

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Credentials

Specifies cloud provider credentials records that you want to remove.

Accepts the VBRCloudProviderCredentials object. To get this object, run the Get-VBRCloudProviderCredentials cmdlet.

True

True (ByValue)

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 you want to continue running the command.

Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false.

SwitchParameter

False

Named

False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

None.

Examples

Removing Cloud Provider Credentials Records

This example shows how to remove cloud provider credentials records.

$creds = Get-VBRCloudProviderCredentials -Name "Cloud credentials"

Remove-VBRCloudProviderCredentials -Credentials $creds -Confirm

Perform the following steps:

Run the Get-VBRCloudProviderCredentials cmdlet. Specify the Name parameter value. Save the result to the $creds variable.
Run the Remove-VBRCloudProviderCredentials cmdlet. Set the $creds variable as the Credentials parameter value. Provide the Confirm parameter.

Related Commands

Get-VBRCloudProviderCredentials