Edit

Get-AzRecoveryServicesVaultSettingsFile

  • Reference
Module:
Az.RecoveryServices

Gets the Azure Site Recovery vault settings file.

Syntax

Get-AzRecoveryServicesVaultSettingsFile
   [-Vault] <ARSVault>
   [[-Path] <String>]
   -SiteIdentifier <String>
   [-Certificate <String>]
   -SiteFriendlyName <String>
   [-SiteRecovery]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzRecoveryServicesVaultSettingsFile
   [-Vault] <ARSVault>
   [[-Path] <String>]
   [-Certificate <String>]
   [-SiteRecovery]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzRecoveryServicesVaultSettingsFile
   [-Vault] <ARSVault>
   [[-Path] <String>]
   [-Certificate <String>]
   [-Backup]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

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

Examples

Example 1: Register a Windows Server or DPM machine for Azure Backup

$Vault01 = Get-AzRecoveryServicesVault -Name "TestVault"
$CredsPath = "C:\Downloads"
$Credsfilename = Get-AzRecoveryServicesVaultSettingsFile -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

$Credsfilename = Get-AzRecoveryServicesVaultSettingsFile -SiteRecovery -Vault $Vault01

The command gets the vault credentials file for $Vault01 of vault type siteRecovery.

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

-Certificate

{{Fill Certificate Description}}

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

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, 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

Outputs

VaultSettingsFilePath