< Back
Get-AzureRmRecoveryServicesVaultSettingsFile
Post
NAME Get-AzureRmRecoveryServicesVaultSettingsFile
SYNOPSIS
Gets the Azure Site Recovery vault settings file.
SYNTAX
Get-AzureRmRecoveryServicesVaultSettingsFile [-Vault] <ARSVault> [[-Path] <String>] -Backup [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmRecoveryServicesVaultSettingsFile [-Vault] <ARSVault> [[-Path] <String>] -SiteFriendlyName <String> -SiteIdentifier <String>
[-SiteRecovery] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmRecoveryServicesVaultSettingsFile [-Vault] <ARSVault> [[-Path] <String>] [-SiteRecovery] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
DESCRIPTION
The Get-AzureRmRecoveryServicesVaultSettingsFile cmdlet gets the settings file for an Azure Site Recovery vault.
PARAMETERS
-Backup [<SwitchParameter>]
Indicates the vault credentials file is applicable to Azure Backup.
Required? true
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Path <String>
Specifies the path to the Azure Site Recovery vault settings file. You can download this file from the Azure Site Recovery vault portal and
store it locally.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SiteFriendlyName <String>
Specifies the site friendly name. Use this parameter if you are downloading the vault credentials for a Hyper-V site.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SiteIdentifier <String>
Specifies the site identifier. Use this parameter if you are downloading the vault credentials for a Hyper-V site.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SiteRecovery [<SwitchParameter>]
Indicates the vault credentials file is applicable to Azure Site Recovery.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Vault <ARSVault>
Specifies the Azure Site Recovery vault object.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
ARSVault
Parameter 'Vault' accepts value of type 'ARSVault' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.RecoveryServices.VaultSettingsFilePath
NOTES
Example 1: Register a Windows Server or DPM machine for Azure Backup
PS C:\\> $Vault01 = Get-AzureRmRecoveryServicesVault -Name "TestVault"
PS C:\\> $CredsPath = "C:\\Downloads"
PS C:\\> $Credsfilename = Get-AzureRmRecoveryServicesVaultSettingsFile -Backup -Vault $Vault01 -Path $CredsPath
The first command gets the vault named TestVault, and then stores it in the $Vault01 variable.
The second command sets the $CredsPath variable to C:\\Downloads.
The last command gets the vault credentials file for $Vault01 using the credentials in $CredsPath for Azure Backup.
Example 2:
PS C:\\> $Credsfilename = Get-AzureRmRecoveryServicesVaultSettingsFile -SiteIdentifier -Vault $Vault01
The command gets the vault credentials file for $Vault01 of vault type siteRecovery.
Example 3: Register a Windows Server or DPM machine for Azure Backup
PS C:\\> $Credsfilename = Get-AzureRmRecoveryServicesVaultSettingsFile -SiteIdentifier -Vault $Vault01
The command gets the vault credentials file for $Vault01.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ttingsfile
Get-AzureRmRecoveryServicesVault
New-AzureRmRecoveryServicesVault
Remove-AzureRmRecoveryServicesVault
SYNOPSIS
Gets the Azure Site Recovery vault settings file.
SYNTAX
Get-AzureRmRecoveryServicesVaultSettingsFile [-Vault] <ARSVault> [[-Path] <String>] -Backup [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmRecoveryServicesVaultSettingsFile [-Vault] <ARSVault> [[-Path] <String>] -SiteFriendlyName <String> -SiteIdentifier <String>
[-SiteRecovery] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Get-AzureRmRecoveryServicesVaultSettingsFile [-Vault] <ARSVault> [[-Path] <String>] [-SiteRecovery] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
DESCRIPTION
The Get-AzureRmRecoveryServicesVaultSettingsFile cmdlet gets the settings file for an Azure Site Recovery vault.
PARAMETERS
-Backup [<SwitchParameter>]
Indicates the vault credentials file is applicable to Azure Backup.
Required? true
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Path <String>
Specifies the path to the Azure Site Recovery vault settings file. You can download this file from the Azure Site Recovery vault portal and
store it locally.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SiteFriendlyName <String>
Specifies the site friendly name. Use this parameter if you are downloading the vault credentials for a Hyper-V site.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SiteIdentifier <String>
Specifies the site identifier. Use this parameter if you are downloading the vault credentials for a Hyper-V site.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SiteRecovery [<SwitchParameter>]
Indicates the vault credentials file is applicable to Azure Site Recovery.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Vault <ARSVault>
Specifies the Azure Site Recovery vault object.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
ARSVault
Parameter 'Vault' accepts value of type 'ARSVault' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.RecoveryServices.VaultSettingsFilePath
NOTES
Example 1: Register a Windows Server or DPM machine for Azure Backup
PS C:\\> $Vault01 = Get-AzureRmRecoveryServicesVault -Name "TestVault"
PS C:\\> $CredsPath = "C:\\Downloads"
PS C:\\> $Credsfilename = Get-AzureRmRecoveryServicesVaultSettingsFile -Backup -Vault $Vault01 -Path $CredsPath
The first command gets the vault named TestVault, and then stores it in the $Vault01 variable.
The second command sets the $CredsPath variable to C:\\Downloads.
The last command gets the vault credentials file for $Vault01 using the credentials in $CredsPath for Azure Backup.
Example 2:
PS C:\\> $Credsfilename = Get-AzureRmRecoveryServicesVaultSettingsFile -SiteIdentifier -Vault $Vault01
The command gets the vault credentials file for $Vault01 of vault type siteRecovery.
Example 3: Register a Windows Server or DPM machine for Azure Backup
PS C:\\> $Credsfilename = Get-AzureRmRecoveryServicesVaultSettingsFile -SiteIdentifier -Vault $Vault01
The command gets the vault credentials file for $Vault01.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ttingsfile
Get-AzureRmRecoveryServicesVault
New-AzureRmRecoveryServicesVault
Remove-AzureRmRecoveryServicesVault