Set-VBRAzureADAccount

Short Description

Modifies settings of Azure Entra ID-based storage accounts.

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

Syntax

This cmdlet provides the following parameter sets:

SecretKey (Default)

Set-VBRAzureADAccount -Account <VBRAzureADAccount> [-StorageAccountName <String>] [-Description <String>]

[-TenantId <String>] [-ApplicationId <String>] [-SecretKey <String>] [<CommonParameters>]

Certificate

Set-VBRAzureADAccount -Account <VBRAzureADAccount> [-StorageAccountName <String>] [-Description <String>]

[-TenantId <String>] [-ApplicationId <String>] [-CertificatePath <String>] [-Password <String>] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of Azure Entra ID-based storage accounts.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Account	Specifies the Azure Entra ID-based storage account which settings you want to modify. Accepts the `VBRAzureADAccount` object. To create this object, run the `Get-VBRAzureADAccount` cmdlet.	`VBRAzureADAccount`	True	Named	False
ApplicationId	Specifies the ID of Microsoft Entra ID application.	`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 Entra.	`String`	False	Named	False
Description	Specifies a description of an Azure Entra ID-based storage account. The cmdlet will modify this description.	`String`	False	Named	False
Password	For certificate-based authentication. Specifies a password that the cmdlet will use it to authenticate against Microsoft Entra.	`String`	False	Named	False
SecretKey	For password-based authentication. Specifies an application secret that the cmdlet will use to authenticate against Microsoft Entra.	`String`	False	Named	False
StorageAccountName	Specifies a name of an Azure Entra ID-based storage account. The cmdlet will modify this name.	`String`	False	Named	False
TenantId	For existing account connection type. Specifies an ID of a tenant (directory) where the Microsoft Entra ID application resides.	`String`	False	Named	False

<CommonParameters>

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

Output Object

VBRAzureADAccount

Examples

Set-VBRAzureADAccount Example 1. Modifying Microsoft Entra ID Application for Azure Entra ID-Based Storage Accounts

This example shows how to modify the ID of Microsoft Entra ID application of the Azure Entra ID-based storage account.

$account = Get-VBRAzureADAccount -Name "EntraID"

Set-VBRAzureADAccount -Account $account -ApplicationId "YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY"

Perform the following steps:

Run the Get-VBRAzureADAccount cmdlet. Specify the Name parameter value. Save the result to the $account variable.
Run the Set-VBRAzureADAccount cmdlet. Set the $account variable as the Account parameter value. Specify the ApplicationId parameter value.

Set-VBRAzureADAccount Example 2. Modifying Application Secret for Azure Entra ID-Based Storage Accounts

This example shows how to modify application secret settings of the Azure Entra ID-based storage account.

$account = Get-VBRAzureADAccount -Name "EntraID"

Set-VBRAzureADAccount -Account $account -SecretKey "YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY"

Perform the following steps:

Run the Get-VBRAzureADAccount cmdlet. Specify the Name parameter value. Save the result to the $account variable.
Run the Set-VBRAzureADAccount cmdlet. Set the $account variable as the Account parameter value. Specify the SecretKey parameter value.

Get-VBRAzureADAccount