< Back

Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem

Tue Jan 29, 2019 10:01 pm

NAME Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem



SYNOPSIS

Stops/Disables replication for an Azure Site Recovery replication protected item.





SYNTAX

Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem [-Confirm] [-DefaultProfile <IAzureContextContainer>] [-Force] -InputObject

<ASRReplicationProtectedItem> [-WaitForCompletion] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem cmdlet disables replication of the specified Azure Site Recovery replication

protected item. This operation causes replication to stop for the protected item.





PARAMETERS

-Confirm [<SwitchParameter>]

Specify if confirmation is required. Set the value of the confirm parameter to $false in order to skip confirmation.



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



-Force [<SwitchParameter>]

Force the command to run without providing an additional warning.



Required? false

Position? named

Default value False

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 for which

replication is to be disabled.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-WaitForCompletion [<SwitchParameter>]

Indicates that the cmdlet should wait for the operation to complete before returning.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet is executed without actually executing the cmdlet.



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 = Remove-AzureRmRecoveryServicesAsrReplicationProtectedItem -ReplicationProtectedItem $ReplicationProtectedItem



Starts the disable replication operation for the specified replication protected item 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

Set-AzureRmRecoveryServicesAsrReplicationProtectedItem