Set-VBRAzureAccount

Short Description

Modifies Microsoft Azure compute account added to Veeam Backup & Replication.

Applies to

Platform: VMware, Hyper-V

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

Syntax

Set-VBRAzureAccount -Account <VBRAzureAccount> [-ApplicationId <String>] [-AzureCredentials <CCredentials>] [-CertificatePath <String>] [-Description <String>] [-Name <String>] [-Password <String>] [-SecretKey <String>] [-TenantId <String>] [<CommonParameters>]

Detailed Description

This cmdlet modifies an existing Microsoft Azure compute account added to the Veeam Backup & Replication managing console. The cmdlet opens a Microsoft Azure wizard. Follow the steps of the wizard to enter the new settings.

Important

This cmdlet does not support Microsoft Azure compute account with the Azure Service Manager type of a subscription (ASM, also known as a "classic" type subscription).

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Account	Specifies the Azure account that you wand to edit.	Accepts the VBRAzureAccount object. To get this object, run the Get-VBRAzureAccount cmdlet.	True	Named	True (ByValue, ByProperty Name)
ApplicationId	Specifies the ID of the AD application. The cmdlet will use this application to connect to Microsoft Azure.	String	False	Named	False
AzureCredentials	Note: This parameter is obsolete and will be deprecated in next version. Specifies an exiting Azure AD application. Veeam Backup & Replication will use this Azure AD application to connect to Microsoft Azure.	Accepts the CCredentials object. To get this object, run the Get-VBRCredentials cmdlet.	False	Named	False
CertificatePath	For certificate-based authentication. Specifies a path to the folder where the certificate is located. The cmdlet will use it to authenticate against Microsoft Azure.	String	False	Named	False
Name	Specifies a name of credentials record for for Microsoft Azure compute account. The cmdlet will add credentials record with this name.	String	False	Named	False
Description	Specifies a description of credentials record for for Microsoft Azure compute account. The cmdlet will apply this description to credentials record.	String	False	Named	False
TenantId	For existing account connection type. Specifies an ID of a tenant (directory) where the AD application resides. The cmdlet will use this tenant ID to connect to the Azure AD application.	String	False	Named	False
ApplicationId	Specifies the ID of the AD application. The cmdlet will use this application to connect to Microsoft Azure.	String	False	Named	False
SecretKey	For the password-based authentication. Specifies the application secret that the cmdlet will use to authenticate against Microsoft Azure.	String	False	Named	False
CertificatePath	For certificate-based authentication. Specifies a path to the folder where the certificate is located. The cmdlet will use it to authenticate against Microsoft Azure.	String	False	Named	False
Password	For certificate-based authentication. Specifies a password that the cmdlet will use it to authenticate against Microsoft Azure.	String	False	Named	False

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

Output Object

VBRAzureAccount

Examples

Editing ID of AD Application of Microsoft Azure Compute Account

This example shows how to edit the ID of the AD application for an existing Microsoft Azure compute account.

$account = Get-VBRAzureAccount -Type ResourceManager -Name "RestoreToAzureRM@Veeam.com"

Set-VBRAzureAccount -Account $account -ApplicationId "42f83f64"

Perform the following steps:

Run the Get-VBRAzureAccount to get the account. Specify the Type and Name parameter values. Save the result to the $account variable.
Run the Set-VBRAzureAccount cmdlet. Set the $account variable as the Account parameter value. Specify the ApplicationId parameter value.

Related Commands

Get-VBRAzureAccount