Set-VBREntraIDTenant

Short Description

Modifies a Microsoft Entra ID tenant added to the backup infrastructure.

Applies to

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

Syntax

This cmdlet provides cmdlet sets that allow you to:

Change tenant settings and the current authentication for the password-based authentication.

Set-VBREntraIDTenant -Tenant <VBREntraIDTenant> [-Description <String>] -ApplicationId <String> -SecretKey <SecureString> -CacheRepository <CBackupRepository> [<CommonParameters>]

Change tenant settings and the current authentication for the certificate-based authentication.

Set-VBREntraIDTenant -Tenant <VBREntraIDTenant> [-Description <String>] -ApplicationId <String> -CertificatePath <String> [-Password <SecureString>] -CacheRepository <CBackupRepository> [<CommonParameters>]

Detailed Description

This cmdlet modifies an Entra ID tenant added to the backup infrastructure.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Tenant	Specifies the Entra ID tenant that you want to change.	Accepts the VBREntraIDTenant object. To get this object, run the Get-VBREntraIDTenant cmdlet.	True	Named	False
ApplicationId	Specifies the ID of an application. The cmdlet will use this application to access Entra ID resources.	String	True	Named	False
SecretKey	For the password-based authentication. Specifies an application secret. The cmdlet will use this secret to authenticate to Entra ID.	SecureString	True	Named	False
CacheRepository	Specifies a cache repository. The cmdlet will use this repository to store temporary cache files for log processing.	Accepts the CBackupRepository object. To get this object, run the Get-VBRBackupRepository cmdlet.	True	Named	False
CertificatePath	For the certificate-based authentication. Specifies the path to the certificate. The cmdlet will use this certificate to authenticate to Entra ID.	String	True	Named	False
Description	Specifies the description for the tenant that you want to add.	String	False	Named	False
Password	For the certificate-based authentication. Specifies the password that the cmdlet will use to authenticate to Entra ID.	SecureString	False	Named	False

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

Output Object

The cmdlet returns the VBREntraIdTenant object that contains settings of the added tenant.

Example

This example shows how to modify an Entra ID tenant and change the authentication method for the certificate-based authentication.

$tenant = Get-VBREntraIdTenant -AzureTenantId "xxxxx"

$psswd = Read-Host -Prompt "Enter password" -AsSecureString

$cacheRepo = Get-VBRBackupRepository -Name "Default Backup Repository"

Set-VBREntraIdTenant -Tenant $tenant -ApplicationId $appId -CertificatePath "C:\Users\Administrator\Locked\certificate-3518.pfx" -Password $psswd -CacheRepository $cacheRepo

Perform the following steps:

Run the Get-VBREntraIdTenant cmdlet. Specify the AzureTenantId parameter value. Save the result to the $tenant variable.
Create the $psswd variable. Use the Read-Host cmdlet to get the password and convert it to a secure string.
Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $cacheRepo variable.
Run the Set-VBREntraIdTenant cmdlet. Specify the following settings:

Set the $tenant variable as the Tenant parameter value.
Set the $appId variable as the ApplicationId parameter value.
Specify the CertificatePath parameter value.
Set the $psswd variable as the Password parameter value.
Set the $cacheRepo variable as the CacheRepository parameter value.

Related Commands