< Back
Set-AzureRmRecoveryServicesAsrReplicationProtectedItem
Post
NAME Set-AzureRmRecoveryServicesAsrReplicationProtectedItem
SYNOPSIS
Sets recovery properties such as target network and virtual machine size for the specified replication protected item.
SYNTAX
Set-AzureRmRecoveryServicesAsrReplicationProtectedItem [-Confirm] [-DefaultProfile <IAzureContextContainer>] -InputObject
<ASRReplicationProtectedItem> [-LicenseType {NoLicenseType | WindowsServer}] [-Name <String>] [-NicSelectionType {NotSelected | SelectedByUser}]
[-PrimaryNic <String>] [-RecoveryAvailabilitySet <String>] [-RecoveryCloudServiceId <String>] [-RecoveryNetworkId <String>]
[-RecoveryNicStaticIPAddress <String>] [-RecoveryNicSubnetName <String>] [-RecoveryResourceGroupId <String>] [-Size <String>] [-UseManagedDisk
{True | False}] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmRecoveryServicesAsrReplicationProtectedItem cmdlet sets the recovery properties for a Replication Protected Item.
PARAMETERS
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with Azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <ASRReplicationProtectedItem>
The input object to the cmdlet: The ASR replication protected item object corresponding to the replication protected item to update.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-LicenseType <String>
Specifiy the license type selection to be used for Windows Server virtual machines. If you are entitled to use the Azure Hybrid Use Benefit
(HUB) for migrations and would like to specify that the HUB setting be used while failing over this protected item set the license type to be
WindowsServer.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the recovery virtual machine that will be created on failover.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-NicSelectionType <String>
Specifies the network interface card (NIC) properties set by user or set by default. You can specify NotSelected to go back to the default
values.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PrimaryNic <String>
Specifies the NIC of the virtual machine for which this cmdlet sets the recovery network property.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RecoveryAvailabilitySet <String>
Availability set for replication protected item after failover.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RecoveryCloudServiceId <String>
The resource ID of the recovery cloud service to failover this virtual machine to.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RecoveryNetworkId <String>
Specifies the ID of the Azure virtual network to which the protected item should be failed over.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RecoveryNicStaticIPAddress <String>
Specifies the static IP address that should be assigned to primary NIC on recovery.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RecoveryNicSubnetName <String>
Specifies the name of the subnet on the recovery Azure virtual network to which this NIC of the protected item should be connected to on
failover.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RecoveryResourceGroupId <String>
The ID of the Azure resource group in the recovery region in which the protected item will be recovered on failover.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Size <String>
Specifies the recovery virtual machine size. The value should be from the set of sizes supported by Azure virtual machines.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-UseManagedDisk <String>
Specifies if the Azure virtual machine that is created on failover should use managed disks.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem
OUTPUTS
Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob
NOTES
Example 1
PS C:\\> $currentJob = Set-AzureRmRecoveryServicesAsrReplicationProtectedItem -ReplicationProtectedItem $RPI -PrimaryNic $NicId -RecoveryNetworkId
$AzureNetworkID -RecoveryNicSubnetName $subnetName
Starts the operation of updating the replication protect item settings using the specified parameters and returns the ASR job used to track the
operation.
RELATED LINKS
Online Version:
https://docs.microsoft.com/en-us/powers ... tecteditem
Get-AzureRmRecoveryServicesAsrReplicationProtectedItem
New-AzureRmRecoveryServicesAsrReplicationProtectedItem
Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem
SYNOPSIS
Sets recovery properties such as target network and virtual machine size for the specified replication protected item.
SYNTAX
Set-AzureRmRecoveryServicesAsrReplicationProtectedItem [-Confirm] [-DefaultProfile <IAzureContextContainer>] -InputObject
<ASRReplicationProtectedItem> [-LicenseType {NoLicenseType | WindowsServer}] [-Name <String>] [-NicSelectionType {NotSelected | SelectedByUser}]
[-PrimaryNic <String>] [-RecoveryAvailabilitySet <String>] [-RecoveryCloudServiceId <String>] [-RecoveryNetworkId <String>]
[-RecoveryNicStaticIPAddress <String>] [-RecoveryNicSubnetName <String>] [-RecoveryResourceGroupId <String>] [-Size <String>] [-UseManagedDisk
{True | False}] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmRecoveryServicesAsrReplicationProtectedItem cmdlet sets the recovery properties for a Replication Protected Item.
PARAMETERS
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with Azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <ASRReplicationProtectedItem>
The input object to the cmdlet: The ASR replication protected item object corresponding to the replication protected item to update.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-LicenseType <String>
Specifiy the license type selection to be used for Windows Server virtual machines. If you are entitled to use the Azure Hybrid Use Benefit
(HUB) for migrations and would like to specify that the HUB setting be used while failing over this protected item set the license type to be
WindowsServer.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the recovery virtual machine that will be created on failover.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-NicSelectionType <String>
Specifies the network interface card (NIC) properties set by user or set by default. You can specify NotSelected to go back to the default
values.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PrimaryNic <String>
Specifies the NIC of the virtual machine for which this cmdlet sets the recovery network property.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RecoveryAvailabilitySet <String>
Availability set for replication protected item after failover.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RecoveryCloudServiceId <String>
The resource ID of the recovery cloud service to failover this virtual machine to.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RecoveryNetworkId <String>
Specifies the ID of the Azure virtual network to which the protected item should be failed over.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RecoveryNicStaticIPAddress <String>
Specifies the static IP address that should be assigned to primary NIC on recovery.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RecoveryNicSubnetName <String>
Specifies the name of the subnet on the recovery Azure virtual network to which this NIC of the protected item should be connected to on
failover.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RecoveryResourceGroupId <String>
The ID of the Azure resource group in the recovery region in which the protected item will be recovered on failover.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Size <String>
Specifies the recovery virtual machine size. The value should be from the set of sizes supported by Azure virtual machines.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-UseManagedDisk <String>
Specifies if the Azure virtual machine that is created on failover should use managed disks.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem
OUTPUTS
Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob
NOTES
Example 1
PS C:\\> $currentJob = Set-AzureRmRecoveryServicesAsrReplicationProtectedItem -ReplicationProtectedItem $RPI -PrimaryNic $NicId -RecoveryNetworkId
$AzureNetworkID -RecoveryNicSubnetName $subnetName
Starts the operation of updating the replication protect item settings using the specified parameters and returns the ASR job used to track the
operation.
RELATED LINKS
Online Version:
https://docs.microsoft.com/en-us/powers ... tecteditem
Get-AzureRmRecoveryServicesAsrReplicationProtectedItem
New-AzureRmRecoveryServicesAsrReplicationProtectedItem
Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem