Set-VBRAzureAccount
Short Description
Edits 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 | Required | Position | Accept | Accept |
|---|---|---|---|---|---|
Account | Specifies the Azure account that you wand to edit. | True | Named | True (ByValue, | False |
ApplicationId | Specifies the ID of the AD application. The cmdlet will use this application to connect to Microsoft Azure. | False | Named | False | 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. | False | Named | False | 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. | False | Named | False | False |
Name | Specifies a name of credentials record for for Microsoft Azure compute account. The cmdlet will add credentials record with this name. | False | Named | False | False |
Description | Specifies a description of credentials record for for Microsoft Azure compute account. The cmdlet will apply this description to credentials record. | False | Named | False | 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. | False | Named | False | False |
ApplicationId | Specifies the ID of the AD application. The cmdlet will use this application to connect to Microsoft Azure. | False | Named | False | False |
SecretKey | For the password-based authentication. Specifies the application secret that the cmdlet will use to authenticate against Microsoft Azure. | False | Named | False | 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. | False | Named | False | False |
Password | For certificate-based authentication. Specifies a password that the cmdlet will use it to authenticate against Microsoft Azure. | False | Named | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Return Type
Example
This example shows how to edit the ID of the AD application for an existing Microsoft Azure compute account.
- Run Get-VBRAzureAccount to get the account. Save the result to the $account variable.
- Run Set-VBRAzureAccount with the $account variable.
$account = Get-VBRAzureAccount -Type ResourceManager -Name RestoreToAzureRM@Veeam.com Set-VBRAzureAccount -Account $account -ApplicationId "42f83f64" |
Related Commands