Microsoft.Azure.Commands.RecoveryServices.ARM.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmRecoveryServicesBackupProperty</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesBackupProperty</command:noun> <maml:description><maml:para>Gets Backup properties. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmRecoveryServicesBackupProperty cmdlet gets backup properties for a Recovery Services vault. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmRecoveryServicesBackupProperty</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the name of the vault. The vault must be an AzureRmRecoveryServicesVault object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ARSVault</command:parameterValue> <dev:type><maml:name>ARSVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the name of the vault. The vault must be an AzureRmRecoveryServicesVault object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ARSVault</command:parameterValue> <dev:type><maml:name>ARSVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.ARSVault</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.ASRVaultBackupProperties</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-AzureRmRecoveryServicesBackupProperty -Vault $vault</dev:code> <dev:remarks><maml:para>Get the backup vault property for vault. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices/get-azurermrecoveryservicesbackupproperty</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmRecoveryServicesVault</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesVault</command:noun> <maml:description><maml:para>Gets a list of Recovery Services vaults. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmRecoveryServicesVault cmdlet gets a list of Recovery Services vaults in the current subscription. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmRecoveryServicesVault</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the vault to query for. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the Azure resource group in which to create or from which to retrieve the specified Recovery Services object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the vault to query for. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the Azure resource group in which to create or from which to retrieve the specified Recovery Services object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>System.Collections.Generic.List`1[Microsoft.Azure.Commands.RecoveryServices.ARSVault]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-AzureRmRecoveryServicesVault</dev:code> <dev:remarks><maml:para>Get the list of vault in selected subscription. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2</maml:title> <dev:code>PS C:\> Get-AzureRmRecoveryServicesVault -ResourceGroupName "resourceGroup"</dev:code> <dev:remarks><maml:para>Get the list of vault in resource group in selected subscription. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 3</maml:title> <dev:code>PS C:\> Get-AzureRmRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName"</dev:code> <dev:remarks><maml:para>Get the vault in resource group with given name. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices/get-azurermrecoveryservicesvault</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesVaultSettingsFile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmRecoveryServicesVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmRecoveryServicesVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmRecoveryServicesVaultSettingsFile</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmRecoveryServicesVaultSettingsFile</command:noun> <maml:description><maml:para>Gets the Azure Site Recovery vault settings file. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmRecoveryServicesVaultSettingsFile cmdlet gets the settings file for an Azure Site Recovery vault. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmRecoveryServicesVaultSettingsFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Azure Site Recovery vault object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ARSVault</command:parameterValue> <dev:type><maml:name>ARSVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Path</maml:name> <maml:Description><maml:para>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. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Backup</maml:name> <maml:Description><maml:para>Indicates the vault credentials file is applicable to Azure Backup. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmRecoveryServicesVaultSettingsFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Azure Site Recovery vault object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ARSVault</command:parameterValue> <dev:type><maml:name>ARSVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Path</maml:name> <maml:Description><maml:para>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. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SiteFriendlyName</maml:name> <maml:Description><maml:para>Specifies the site friendly name. Use this parameter if you are downloading the vault credentials for a Hyper-V site. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SiteIdentifier</maml:name> <maml:Description><maml:para>Specifies the site identifier. Use this parameter if you are downloading the vault credentials for a Hyper-V site. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SiteRecovery</maml:name> <maml:Description><maml:para>Indicates the vault credentials file is applicable to Azure Site Recovery. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmRecoveryServicesVaultSettingsFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Azure Site Recovery vault object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ARSVault</command:parameterValue> <dev:type><maml:name>ARSVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Path</maml:name> <maml:Description><maml:para>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. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SiteRecovery</maml:name> <maml:Description><maml:para>Indicates the vault credentials file is applicable to Azure Site Recovery. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Backup</maml:name> <maml:Description><maml:para>Indicates the vault credentials file is applicable to Azure Backup. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Path</maml:name> <maml:Description><maml:para>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. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SiteFriendlyName</maml:name> <maml:Description><maml:para>Specifies the site friendly name. Use this parameter if you are downloading the vault credentials for a Hyper-V site. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SiteIdentifier</maml:name> <maml:Description><maml:para>Specifies the site identifier. Use this parameter if you are downloading the vault credentials for a Hyper-V site. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SiteRecovery</maml:name> <maml:Description><maml:para>Indicates the vault credentials file is applicable to Azure Site Recovery. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the Azure Site Recovery vault object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ARSVault</command:parameterValue> <dev:type><maml:name>ARSVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>ARSVault</maml:name> </dev:type> <maml:description><maml:para>Parameter 'Vault' accepts value of type 'ARSVault' from the pipeline </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.VaultSettingsFilePath</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Register a Windows Server or DPM machine for Azure Backup</maml:title> <dev:code>PS C:\> $Vault01 = Get-AzureRmRecoveryServicesVault -Name "TestVault" PS C:\> $CredsPath = "C:\Downloads" PS C:\> $Credsfilename = Get-AzureRmRecoveryServicesVaultSettingsFile -Backup -Vault $Vault01 -Path $CredsPath</dev:code> <dev:remarks><maml:para>The first command gets the vault named TestVault, and then stores it in the $Vault01 variable. </maml:para> <maml:para>The second command sets the $CredsPath variable to C:\Downloads. </maml:para> <maml:para>The last command gets the vault credentials file for $Vault01 using the credentials in $CredsPath for Azure Backup. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2:</maml:title> <dev:code>PS C:\> $Credsfilename = Get-AzureRmRecoveryServicesVaultSettingsFile -SiteIdentifier -Vault $Vault01</dev:code> <dev:remarks><maml:para>The command gets the vault credentials file for $Vault01 of vault type siteRecovery. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 3: Register a Windows Server or DPM machine for Azure Backup</maml:title> <dev:code>PS C:\> $Credsfilename = Get-AzureRmRecoveryServicesVaultSettingsFile -SiteIdentifier -Vault $Vault01</dev:code> <dev:remarks><maml:para>The command gets the vault credentials file for $Vault01. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices/get-azurermrecoveryservicesvaultsettingsfile</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmRecoveryServicesVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmRecoveryServicesVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmRecoveryServicesVault</command:name> <command:verb>New</command:verb> <command:noun>AzureRmRecoveryServicesVault</command:noun> <maml:description><maml:para>Creates a new Recovery Services vault. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmRecoveryServicesVault cmdlet creates a new Recovery Services vault. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmRecoveryServicesVault</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Location</maml:name> <maml:Description><maml:para>Specifies the name of the geographic location of the vault. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the vault to create. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the Azure resource group in which to create or from which to retrieve the specified Recovery Services object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Location</maml:name> <maml:Description><maml:para>Specifies the name of the geographic location of the vault. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the vault to create. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the Azure resource group in which to create or from which to retrieve the specified Recovery Services object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.ARSVault</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1</maml:title> <dev:code>PS C:\> New-AzureRmRecoveryServicesVault -Name "vaultName" -ResourceGroupName "rg" -Location "eastasia"</dev:code> <dev:remarks><maml:para>Create recovery service vault in resource group and given location. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices/new-azurermrecoveryservicesvault</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesVaultSettingsFile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmRecoveryServicesVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmRecoveryServicesVault</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmRecoveryServicesVault</command:noun> <maml:description><maml:para>Deletes a Recovery Services vault. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmRecoveryServicesVault cmdlet deletes a Recovery Services vault. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmRecoveryServicesVault</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies an Azure Site Recovery vault object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ARSVault</command:parameterValue> <dev:type><maml:name>ARSVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies an Azure Site Recovery vault object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ARSVault</command:parameterValue> <dev:type><maml:name>ARSVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>ARSVault</maml:name> </dev:type> <maml:description><maml:para>Parameter 'Vault' accepts value of type 'ARSVault' from the pipeline </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.RecoveryServices.VaultOperationOutput</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1</maml:title> <dev:code>PS C:\> Remove-AzureRmRecoveryServicesVault -Vault $vault</dev:code> <dev:remarks><maml:para>Deletes a Recovery Services vault. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices/remove-azurermrecoveryservicesvault</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesVaultSettingsFile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmRecoveryServicesVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmRecoveryServicesBackupProperties</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmRecoveryServicesBackupProperties</command:noun> <maml:description><maml:para>Sets the properties for backup management. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmRecoveryServicesBackupProperties cmdlet sets backup storage properties for a Recovery Services vault. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmRecoveryServicesBackupProperties</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>BackupStorageRedundancy</maml:name> <maml:Description><maml:para>Specifies the backup storage redundancy type. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">GeoRedundant</command:parameterValue> <command:parameterValue required="false" variableLength="false">LocallyRedundant</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">AzureRmRecoveryServicesBackupStorageRedundancyType</command:parameterValue> <dev:type><maml:name>AzureRmRecoveryServicesBackupStorageRedundancyType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the name of the vault. The vault must be an AzureRmRecoveryServicesVault object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ARSVault</command:parameterValue> <dev:type><maml:name>ARSVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>BackupStorageRedundancy</maml:name> <maml:Description><maml:para>Specifies the backup storage redundancy type. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRmRecoveryServicesBackupStorageRedundancyType</command:parameterValue> <dev:type><maml:name>AzureRmRecoveryServicesBackupStorageRedundancyType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the name of the vault. The vault must be an AzureRmRecoveryServicesVault object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ARSVault</command:parameterValue> <dev:type><maml:name>ARSVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>ARSVault</maml:name> </dev:type> <maml:description><maml:para>Parameter 'Vault' accepts value of type 'ARSVault' from the pipeline </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Set GeoRedundant storage for a vault</maml:title> <dev:code>PS C:\> $Vault01 = Get-AzureRmRecoveryServicesVault -Name "TestVault" PS C:\> Set-AzureRmRecoveryServicesBackupProperties -Vault $Vault01 -BackupStorageRedundancy GeoRedundant</dev:code> <dev:remarks><maml:para>The first command gets the vault named TestVault, and then stores it in the $Vault01 variable. </maml:para> <maml:para>The second command sets the backup storage redundancy for $Vault01 to GeoRedundant. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices/set-azurermrecoveryservicesbackupproperties</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesBackupProperties</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmRecoveryServicesVault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmRecoveryServicesVaultContext</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmRecoveryServicesVaultContext</command:noun> <maml:description><maml:para>Sets vault context. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmRecoveryServicesVaultContext cmdlet sets the vault context for Azure Site Recovery services. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmRecoveryServicesVaultContext</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the name of the vault. The vault must be an AzureRmRecoveryServicesVault object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ARSVault</command:parameterValue> <dev:type><maml:name>ARSVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Vault</maml:name> <maml:Description><maml:para>Specifies the name of the vault. The vault must be an AzureRmRecoveryServicesVault object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ARSVault</command:parameterValue> <dev:type><maml:name>ARSVault</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>ARSVault</maml:name> </dev:type> <maml:description><maml:para>Parameter 'Vault' accepts value of type 'ARSVault' from the pipeline </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1</maml:title> <dev:code>PS C:\> Set-AzureRmRecoveryServicesVaultContext -Vault $vault</dev:code> <dev:remarks><maml:para>Sets vault context. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices/set-azurermrecoveryservicesvaultcontext</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |