Suspend-AzMigrateServerReplication
Suspends the ongoing replication.
Syntax
Suspend-AzMigrateServerReplication
-TargetObjectID <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Suspend-AzMigrateServerReplication
[-SubscriptionId <String>]
-InputObject <IMigrationItem>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Suspend-AzMigrateServerReplication suspends the ongoing replication.
Examples
Example 1: By machine id.
Suspend-AzMigrateServerReplication -TargetObjectID "/Subscriptions/xxx-xxx-xxxxxx-xxx-xxx/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoffccyapp3352vault/replicationFabrics/signoffccyappae52replicationfabric/replicationProtectionContainers/signoffccyappae52replicationcontainer/replicationMigrationItems/idclab-vcen67-fareast-corp-micr-0f144e99-ba36-4649-b92b-8b06854aa539_5015f6d8-fc84-afdf-de47-1eab79330f00"
ActivityId : da61a495-48b7-40df-a251-f23f491b2566 ActivityId: e16e0301-be13-4c35-8242-1451cb057994
AllowedAction : {}
CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.JobDetailsAffectedObjectDetails
CustomDetailInstanceType : AsrJobDetails
EndTime :
Error : {}
FriendlyName : Pause replication
Id : /Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoff
ccyapp3352vault/replicationJobs/6ded7417-b939-4c30-b622-d80a63865025
Location :
Name : 6ded7417-b939-4c30-b622-d80a63865025
ScenarioName : PauseReplication
StartTime : 9/25/2022 9:10:42 PM
State : InProgress
StateDescription : InProgress
TargetInstanceType : ProtectionEntity
TargetObjectId : 00001111-aaaa-2222-bbbb-3333cccc4444
TargetObjectName : Win2k16
Task : {PauseReplicationPreflightChecksTask, PauseReplicationTask}
Type : Microsoft.RecoveryServices/vaults/replicationJobs
By machine id.
Example 2: By input object
$obj = Get-AzMigrateServerReplication -ProjectName "signoffccyproj" -ResourceGroupName "cbtsignoff2201rg" -MachineName "Win2k16"
Suspend-AzMigrateServerReplication -InputObject $obj
ActivityId : da61a495-48b7-40df-a251-f23f491b2566 ActivityId: e16e0301-be13-4c35-8242-1451cb057994
AllowedAction : {}
CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.JobDetailsAffectedObjectDetails
CustomDetailInstanceType : AsrJobDetails
EndTime :
Error : {}
FriendlyName : Pause replication
Id : /Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoff
ccyapp3352vault/replicationJobs/6ded7417-b939-4c30-b622-d80a63865025
Location :
Name : 6ded7417-b939-4c30-b622-d80a63865025
ScenarioName : PauseReplication
StartTime : 9/25/2022 9:10:42 PM
State : InProgress
StateDescription : InProgress
TargetInstanceType : ProtectionEntity
TargetObjectId : 00001111-aaaa-2222-bbbb-3333cccc4444
TargetObjectName : Win2k16
Task : {PauseReplicationPreflightChecksTask, PauseReplicationTask}
Type : Microsoft.RecoveryServices/vaults/replicationJobs
By input object.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
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: | PSObject |
Aliases: | AzureRMContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Specifies the replicating server for which the suspend replication needs to be initiated. The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: | IMigrationItem |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SubscriptionId
Azure Subscription ID.
Type: | String |
Position: | Named |
Default value: | (Get-AzContext).Subscription.Id |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TargetObjectID
Specifies the replicating server for which the suspend replication needs to be initiated. The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Outputs
Azure PowerShell