Remove-AzRecoveryServicesAsrReplicationProtectedItem
Stops/Disables replication for an Azure Site Recovery replication protected item.
Syntax
Remove-AzRecoveryServicesAsrReplicationProtectedItem
-InputObject <ASRReplicationProtectedItem>
[-WaitForCompletion]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-AzRecoveryServicesAsrReplicationProtectedItem cmdlet disables replication of the specified Azure Site Recovery replication protected item. This operation causes replication to stop for the protected item.
Examples
Example 1
$currentJob = Remove-AzRecoveryServicesAsrReplicationProtectedItem -ReplicationProtectedItem $ReplicationProtectedItem
Starts the disable replication operation for the specified replication protected item and returns the ASR job used to track the operation.
Parameters
-Confirm
Specify if confirmation is required. Set the value of the confirm parameter to $false in order to skip confirmation.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Force the command to run without providing an additional warning.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
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.
Type: | ASRReplicationProtectedItem |
Aliases: | ReplicationProtectedItem |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WaitForCompletion
Indicates that the cmdlet should wait for the operation to complete before returning.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet is executed without actually executing the cmdlet.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Outputs
Related Links
Azure PowerShell