| external help file | Module Name | ms.assetid | online version | schema |
|---|---|---|---|---|
Microsoft.Azure.PowerShell.Cmdlets.RecoveryServices.dll-Help.xml |
Az.RecoveryServices |
56074606-28A6-4F91-A56C-4C8A9A31543F |
2.0.0 |
Gets the Azure Site Recovery vault settings file.
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>]
The Get-AzRecoveryServicesVaultSettingsFile cmdlet gets the settings file for an Azure Site Recovery vault.
$Vault01 = Get-AzRecoveryServicesVault -Name "TestVault"
$CredsPath = "C:\Downloads"
$Credsfilename = Get-AzRecoveryServicesVaultSettingsFile -Backup -Vault $Vault01 -Path $CredsPathThe 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.
$Credsfilename = Get-AzRecoveryServicesVaultSettingsFile -SiteRecovery -Vault $Vault01The command gets the vault credentials file for $Vault01 of vault type siteRecovery.
Indicates the vault credentials file is applicable to Azure Backup.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: ForBackupVaultTypeWithCertificate
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{Fill Certificate Description}}
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe credentials, account, tenant, and subscription used for communication with azure.
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the site friendly name. Use this parameter if you are downloading the vault credentials for a Hyper-V site.
Type: System.String
Parameter Sets: ForSiteWithCertificate
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the site identifier. Use this parameter if you are downloading the vault credentials for a Hyper-V site.
Type: System.String
Parameter Sets: ForSiteWithCertificate
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIndicates the vault credentials file is applicable to Azure Site Recovery.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: ForSiteWithCertificate, ByDefaultWithCertificate
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the Azure Site Recovery vault object.
Type: Microsoft.Azure.Commands.RecoveryServices.ARSVault
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.