Get-AzRecoveryServicesVaultSettingsFile
Gets the Azure Site Recovery vault settings file.
Syntax
ForSiteWithCertificate
Get-AzRecoveryServicesVaultSettingsFile
[-Vault] <ARSVault>
[[-Path] <String>]
-SiteIdentifier <String>
-SiteFriendlyName <String>
[-Certificate <String>]
[-SiteRecovery]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByDefaultWithCertificate
Get-AzRecoveryServicesVaultSettingsFile
[-Vault] <ARSVault>
[[-Path] <String>]
[-Certificate <String>]
[-SiteRecovery]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ForBackupVaultTypeWithCertificate
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.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ForBackupVaultTypeWithCertificate
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Certificate
{{Fill Certificate Description}}
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 2 Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SiteFriendlyName
Specifies the site friendly name.
Use this parameter if you are downloading the vault credentials for a Hyper-V site.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ForSiteWithCertificate
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SiteIdentifier
Specifies the site identifier.
Use this parameter if you are downloading the vault credentials for a Hyper-V site.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ForSiteWithCertificate
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SiteRecovery
Indicates the vault credentials file is applicable to Azure Site Recovery.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ForSiteWithCertificate
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ByDefaultWithCertificate
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Vault
Specifies the Azure Site Recovery vault object.
Parameter properties
Type: ARSVault
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 1 Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
