Remove-AzRecoveryServicesAsrReplicationProtectionCluster
Stops/Disables replication for an Azure Site Recovery replication protection cluster.
Syntax
Default (Default)
Remove-AzRecoveryServicesAsrReplicationProtectionCluster
-InputObject <ASRReplicationProtectionCluster>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-AzRecoveryServicesAsrReplicationProtectionCluster cmdlet disables replication of the specified Azure Site Recovery replication protection cluster. This operation causes replication to stop for the protection cluster.
Examples
Example 1
Remove-AzRecoveryServicesAsrReplicationProtectionCluster -ReplicationProtectionCluster $ClusterToDisable
Starts the disable replication operation for the specified replication protection cluster and returns the ASR job used to track the operation.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | cf |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: | IAzureContextContainer |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-InputObject
Specifies the replication protection cluster object to disable replication.
Parameter properties
Type: | ASRReplicationProtectionCluster |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | ReplicationProtectionCluster |
Parameter sets
(All)
Position: | Named |
Mandatory: | True |
Value from pipeline: | True |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | wi |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.