Get-AzureRmSiteRecoveryVaultSettingsFile

Gets the Site Recovery vault settings file.

Syntax

Get-AzureRmSiteRecoveryVaultSettingsFile
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmSiteRecoveryVaultSettingsFile
   -Vault <ASRVault>
   [-Path <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmSiteRecoveryVaultSettingsFile
   -Vault <ASRVault>
   -SiteIdentifier <String>
   -SiteFriendlyName <String>
   [-Path <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

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

Required Parameters

-SiteFriendlyName

Specifies the site friendly name for the vault when the site is a Hyper-V site.

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

Specifies the site identifier for the vault when the site is a Hyper-V site.

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

Specifies the vault object for the site.

Type:Microsoft.Azure.Commands.SiteRecovery.ASRVault
Position:Named
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
-Path

Specifies the path to the Site Recovery vault settings file. To store this file locally, download it from the Site Recovery vault portal once the command completes.

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

Inputs

ASRVault

Parameter 'Vault' accepts value of type 'ASRVault' from the pipeline

Outputs

Microsoft.Azure.Commands.SiteRecovery.VaultSettingsFilePath