Get-AzureRmBackupVaultCredentials

Downloads the vault credentials file for a Backup vault.

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.

Examples

1:

Required Parameters

-TargetLocation

Specifies the destination path where this cmdlet stores the vault credentials file.

Type:String
Position:2
Default value:None
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:Microsoft.Azure.Commands.AzureBackup.Models.AzureRMBackupVault
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

AzureRMBackupVault

Outputs

String

This cmdlet returns the name of the vault credential file.