Get-AzureRmRecoveryServicesVaultSettingsFile

Reference

Module:: AzureRM.RecoveryServices

Gets the Azure Site Recovery vault settings file.

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-AzureRmRecoveryServicesVaultSettingsFile
   [-Vault] <ARSVault>
   -SiteIdentifier <String>
   -SiteFriendlyName <String>
   [[-Path] <String>]
   [-SiteRecovery]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmRecoveryServicesVaultSettingsFile
   [-Vault] <ARSVault>
   [[-Path] <String>]
   [-SiteRecovery]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmRecoveryServicesVaultSettingsFile
   [-Vault] <ARSVault>
   [[-Path] <String>]
   [-Backup]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmRecoveryServicesVaultSettingsFile cmdlet gets the settings file for an Azure Site Recovery vault.

Examples

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.

Parameters

-Backup

Indicates the vault credentials file is applicable to Azure Backup.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-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

-Path

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.

Type:	String
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SiteFriendlyName

Specifies the site friendly name. Use this parameter if you are downloading the vault credentials for a Hyper-V site.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SiteIdentifier

Specifies the site identifier. Use this parameter if you are downloading the vault credentials for a Hyper-V site.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SiteRecovery

Indicates the vault credentials file is applicable to Azure Site Recovery.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Vault

Specifies the Azure Site Recovery vault object.

Type:	ARSVault
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

ARSVault

Parameters: Vault (ByValue)

Outputs

VaultSettingsFilePath