Get-AzureRmBackupVaultCredentials
Downloads the vault credentials file for a Backup vault.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Get-AzureRmBackupVaultCredentials
[-TargetLocation] <String>
[-Vault] <AzureRMBackupVault>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzureRmBackupVaultCredentials cmdlet downloads the vault credentials file for an Azure Backup vault. Backup uses a vault credential file to connect a server to the Azure Backup vault and register it. You must register a server before Backup can send backup data to the vault.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
Type: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TargetLocation
Specifies the destination path where this cmdlet stores the vault credentials file.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Vault
Specifies the Backup vault for which this cmdlet gets a vault credential file. To obtain an AzureRmBackupVault object, use the Get-AzureRmBackupVault cmdlet.
Type: | AzureRMBackupVault |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
Parameters: Vault (ByValue)
Outputs
This cmdlet returns the name of the vault credential file.