New-AzRecoveryServicesAsrReplicationProtectedItem
Enables replication for an ASR protectable item by creating a replication protected item.
Syntax
EnterpriseToEnterprise (Default)
New-AzRecoveryServicesAsrReplicationProtectedItem
-ProtectableItem <ASRProtectableItem>
-Name <String>
-ProtectionContainerMapping <ASRProtectionContainerMapping>
[-VmmToVmm]
[-WaitForCompletion]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
VMwareToAzureWithDiskType
New-AzRecoveryServicesAsrReplicationProtectedItem
-ProtectableItem <ASRProtectableItem>
-Name <String>
-ProtectionContainerMapping <ASRProtectionContainerMapping>
-Account <ASRRunAsAccount>
-ProcessServer <ASRProcessServer>
-RecoveryResourceGroupId <String>
-DiskType <String>
[-VMwareToAzure]
[-RecoveryVmName <String>]
[-LogStorageAccountId <String>]
[-RecoveryAzureNetworkId <String>]
[-RecoveryAzureSubnetName <String>]
[-ReplicationGroupName <String>]
[-RecoveryAvailabilityZone <String>]
[-RecoveryProximityPlacementGroupId <String>]
[-RecoveryAvailabilitySetId <String>]
[-Size <String>]
[-SqlServerLicenseType <String>]
[-RecoveryVmTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
[-DiskTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
[-RecoveryNicTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
[-WaitForCompletion]
[-DiskEncryptionSetId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
VMwareToAzure
New-AzRecoveryServicesAsrReplicationProtectedItem
-ProtectableItem <ASRProtectableItem>
-Name <String>
-ProtectionContainerMapping <ASRProtectionContainerMapping>
-Account <ASRRunAsAccount>
-ProcessServer <ASRProcessServer>
-RecoveryResourceGroupId <String>
[-VMwareToAzure]
[-RecoveryVmName <String>]
[-LogStorageAccountId <String>]
[-InMageAzureV2DiskInput <AsrInMageAzureV2DiskInput[]>]
[-RecoveryAzureNetworkId <String>]
[-RecoveryAzureSubnetName <String>]
[-ReplicationGroupName <String>]
[-RecoveryAvailabilityZone <String>]
[-RecoveryProximityPlacementGroupId <String>]
[-RecoveryAvailabilitySetId <String>]
[-Size <String>]
[-SqlServerLicenseType <String>]
[-RecoveryVmTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
[-DiskTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
[-RecoveryNicTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
[-WaitForCompletion]
[-DiskEncryptionSetId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
EnterpriseToAzure
New-AzRecoveryServicesAsrReplicationProtectedItem
-ProtectableItem <ASRProtectableItem>
-Name <String>
-ProtectionContainerMapping <ASRProtectionContainerMapping>
-RecoveryAzureStorageAccountId <String>
-RecoveryResourceGroupId <String>
[-HyperVToAzure]
[-RecoveryVmName <String>]
[-UseManagedDisk <String>]
[-UseManagedDisksForReplication <String>]
[-WaitForCompletion]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
HyperVSiteToAzure
New-AzRecoveryServicesAsrReplicationProtectedItem
-ProtectableItem <ASRProtectableItem>
-Name <String>
-ProtectionContainerMapping <ASRProtectionContainerMapping>
-RecoveryAzureStorageAccountId <String>
-OSDiskName <String>
-OS <String>
-RecoveryResourceGroupId <String>
[-HyperVToAzure]
[-RecoveryVmName <String>]
[-LogStorageAccountId <String>]
[-IncludeDiskId <String[]>]
[-RecoveryAzureNetworkId <String>]
[-RecoveryAzureSubnetName <String>]
[-RecoveryAvailabilityZone <String>]
[-RecoveryProximityPlacementGroupId <String>]
[-RecoveryAvailabilitySetId <String>]
[-Size <String>]
[-SqlServerLicenseType <String>]
[-RecoveryVmTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
[-DiskTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
[-RecoveryNicTag <System.Collections.Generic.IDictionary`2[System.String,System.String]>]
[-UseManagedDisk <String>]
[-UseManagedDisksForReplication <String>]
[-WaitForCompletion]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
AzureToAzure
New-AzRecoveryServicesAsrReplicationProtectedItem
-AzureToAzureDiskReplicationConfiguration <ASRAzuretoAzureDiskReplicationConfig[]>
-AzureVmId <String>
-Name <String>
-ProtectionContainerMapping <ASRProtectionContainerMapping>
-RecoveryResourceGroupId <String>
[-AzureToAzure]
[-RecoveryAzureNetworkId <String>]
[-RecoveryAzureSubnetName <String>]
[-ReplicationGroupName <String>]
[-RecoveryCloudServiceId <String>]
[-RecoveryAvailabilityZone <String>]
[-RecoveryProximityPlacementGroupId <String>]
[-RecoveryVirtualMachineScaleSetId <String>]
[-RecoveryCapacityReservationGroupId <String>]
[-RecoveryAvailabilitySetId <String>]
[-RecoveryBootDiagStorageAccountId <String>]
[-DiskEncryptionVaultId <String>]
[-DiskEncryptionSecretUrl <String>]
[-KeyEncryptionKeyUrl <String>]
[-KeyEncryptionVaultId <String>]
[-WaitForCompletion]
[-RecoveryExtendedLocation <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
AzureToAzureWithoutDiskDetails
New-AzRecoveryServicesAsrReplicationProtectedItem
-AzureVmId <String>
-Name <String>
-ProtectionContainerMapping <ASRProtectionContainerMapping>
-LogStorageAccountId <String>
-RecoveryResourceGroupId <String>
[-AzureToAzure]
[-RecoveryAzureStorageAccountId <String>]
[-RecoveryAzureNetworkId <String>]
[-RecoveryAzureSubnetName <String>]
[-ReplicationGroupName <String>]
[-RecoveryAvailabilityZone <String>]
[-RecoveryProximityPlacementGroupId <String>]
[-RecoveryVirtualMachineScaleSetId <String>]
[-RecoveryCapacityReservationGroupId <String>]
[-RecoveryAvailabilitySetId <String>]
[-RecoveryBootDiagStorageAccountId <String>]
[-DiskEncryptionVaultId <String>]
[-DiskEncryptionSecretUrl <String>]
[-KeyEncryptionKeyUrl <String>]
[-KeyEncryptionVaultId <String>]
[-WaitForCompletion]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ReplicateVMwareToAzure
New-AzRecoveryServicesAsrReplicationProtectedItem
-ProtectableItem <ASRProtectableItem>
-Name <String>
-ProtectionContainerMapping <ASRProtectionContainerMapping>
-LogStorageAccountId <String>
-ApplianceName <String>
-Fabric <ASRFabric>
-RecoveryResourceGroupId <String>
-DiskType <String>
[-ReplicateVMwareToAzure]
[-RecoveryVmName <String>]
[-LicenseType <String>]
[-TestNetworkId <String>]
[-TestSubnetName <String>]
[-CredentialsToAccessVm <String>]
[-RecoveryAzureNetworkId <String>]
[-RecoveryAzureSubnetName <String>]
[-ReplicationGroupName <String>]
[-RecoveryAvailabilityZone <String>]
[-RecoveryProximityPlacementGroupId <String>]
[-RecoveryAvailabilitySetId <String>]
[-Size <String>]
[-RecoveryBootDiagStorageAccountId <String>]
[-WaitForCompletion]
[-DiskEncryptionSetId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzRecoveryServicesAsrReplicationProtectedItem
-ProtectableItem <ASRProtectableItem>
-InMageRcmDiskInput <ASRInMageRcmDiskInput[]>
-Name <String>
-ProtectionContainerMapping <ASRProtectionContainerMapping>
-ApplianceName <String>
-Fabric <ASRFabric>
-RecoveryResourceGroupId <String>
[-ReplicateVMwareToAzure]
[-RecoveryVmName <String>]
[-LicenseType <String>]
[-TestNetworkId <String>]
[-TestSubnetName <String>]
[-CredentialsToAccessVm <String>]
[-RecoveryAzureNetworkId <String>]
[-RecoveryAzureSubnetName <String>]
[-ReplicationGroupName <String>]
[-RecoveryAvailabilityZone <String>]
[-RecoveryProximityPlacementGroupId <String>]
[-RecoveryAvailabilitySetId <String>]
[-Size <String>]
[-RecoveryBootDiagStorageAccountId <String>]
[-WaitForCompletion]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The New-AzRecoveryServicesAsrReplicationProtectedItem cmdlet creates a new replication protected item.
Use this cmdlet to enable replication for an ASR protectable item.
Examples
Example 1
$currentJob = New-AzRecoveryServicesAsrReplicationProtectedItem -ProtectableItem $VM -Name $VM.Name -ProtectionContainerMapping $ProtectionContainerMapping
Starts the replication protected item creation operation for the specified ASR protectable item and returns the ASR job used to track the operation.
Example 2
$job = New-AzRecoveryServicesAsrReplicationProtectedItem -VMwareToAzure -Account $fabric.FabricSpecificDetails.RunAsAccounts[0] `
-RecoveryResourceGroupId $RecoveryResourceGroupId -RecoveryAzureNetworkId $RecoveryAzureNetworkId -name $name `
-ProcessServer $fabric.FabricSpecificDetails.ProcessServers[0] -ProtectableItem $protectableItem -ProtectionContainerMapping $pcm `
-RecoveryAzureSubnetName $RecoveryAzureSubnetName -RecoveryVmName $RecoveryVmName -LogStorageAccountId $LogStorageAccountId
Starts the replication protected item creation operation for the specified ASR protectable item and returns the ASR job used to track the operation(vmWare to Azure scenario).
Example 3
$job = New-AzRecoveryServicesAsrReplicationProtectedItem -AzureToAzure -AzureToAzureDiskReplicationConfiguration disk1,disk2 -AzureVmId $vmId `
-Name "a2aprotectedItem" -ProtectionContainerMapping $pcmMapping -RecoveryResourceGroupId $recoveryResourceGroup
Starts the replication protected item creation operation for the specified ASR protectable item and returns the ASR job used to track the operation (Azure to Azure scenario).
Example 4
$disk1 = New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig -vhdUri $diskUri1 -RecoveryAzureStorageAccountId $recoveryAzureStorageAccountId `
-LogStorageAccountId $logStorageAccountId
$disk2 = New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig -vhdUri $diskUri2 -RecoveryAzureStorageAccountId $recoveryAzureStorageAccountId `
-LogStorageAccountId $logStorageAccountId
$enableDRjob = New-AzRecoveryServicesAsrReplicationProtectedItem -AzureToAzure -AzureVmId $vmId -Name $rpiName `
-RecoveryCloudServiceId $recoveryCloudServiceId -ProtectionContainerMapping $pcm -RecoveryResourceGroupId $RecoveryResourceGroupId `
-AzureToAzureDiskReplicationConfiguration $disk1,$disk2 -RecoveryAzureNetworkId $RecoveryAzureNetworkId -RecoveryAzureSubnetName $RecoveryAzureSubnetName
Starts the replication protected item creation operation for the specified VmId and returns the ASR job used to track the operation (Azure to Azure scenario).
Example 5
$disk1 = New-AzRecoveryServicesAsrInMageAzureV2DiskInput -DiskId $diskId -LogStorageAccountId $logStorageAccountId -DiskType $diskType
$disk2 = New-AzRecoveryServicesAsrInMageAzureV2DiskInput -DiskId $diskId2 -LogStorageAccountId $logStorageAccountId -DiskType $diskType2
$job = New-AzRecoveryServicesAsrReplicationProtectedItem -VMwareToAzure -Account $fabric.FabricSpecificDetails.RunAsAccounts[0] -RecoveryResourceGroupId $RecoveryResourceGroupId `
-RecoveryAzureNetworkId $RecoveryAzureNetworkId -name $name -ProcessServer $fabric.FabricSpecificDetails.ProcessServers[0] -ProtectableItem $protectableItem `
-ProtectionContainerMapping $pcm -RecoveryAzureSubnetName $RecoveryAzureSubnetName -RecoveryVmName $RecoveryVmName `
-LogStorageAccountId $LogStorageAccountId -InMageAzureV2DiskInput $disk1,$disk2
Starts the replication protected item creation operation for the specified ASR protectable item including selective disks and returns the ASR job used to track the operation(vmWare to Azure scenario) with selected disks.
Example 6
$job = New-AzRecoveryServicesAsrReplicationProtectedItem -VMwareToAzure -Account $fabric.FabricSpecificDetails.RunAsAccounts[0] -RecoveryResourceGroupId $RecoveryResourceGroupId `
-RecoveryAzureNetworkId $RecoveryAzureNetworkId -name $name -ProcessServer $fabric.FabricSpecificDetails.ProcessServers[0] -ProtectableItem $protectableItem `
-ProtectionContainerMapping $pcm -RecoveryAzureSubnetName $RecoveryAzureSubnetName -RecoveryVmName $RecoveryVmName `
-LogStorageAccountId $LogStorageAccountId -DiskType Standard_LRS
Starts the replication protected item creation operation for the specified ASR protectable item with default disk type and returns the ASR job used to track the operation(vmWare to Azure scenario).
Example 7
$disk1 = New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig -vhdUri $diskUri1 -RecoveryAzureStorageAccountId $recoveryAzureStorageAccountId -LogStorageAccountId $logStorageAccountId
$disk2 = New-AzRecoveryServicesAsrAzureToAzureDiskReplicationConfig -vhdUri $diskUri2 -RecoveryAzureStorageAccountId $recoveryAzureStorageAccountId -LogStorageAccountId $logStorageAccountId
$enableDRjob = New-AzRecoveryServicesAsrReplicationProtectedItem -AzureToAzure -AzureVmId $vmId -Name $rpiName `
-RecoveryCloudServiceId $recoveryCloudServiceId -ProtectionContainerMapping $pcm -RecoveryResourceGroupId $RecoveryResourceGroupId `
-AzureToAzureDiskReplicationConfiguration $disk1,$disk2 -DiskEncryptionVaultId $DiskEncryptionVaultId -DiskEncryptionSecretUrl $DiskEncryptionSecretUrl `
-KeyEncryptionVaultId $KeyEncryptionVaultId -KeyEncryptionKeyUrl $KeyEncryptionKeyUrl
Starts the replication protected item creation operation for the specified VmId and returns the ASR job used to track the operation (Azure to Azure scenario).For the failover VM details passed in cmdlet for encryption will be used .
Example 8
$job = New-AzRecoveryServicesAsrReplicationProtectedItem -AzureToAzure -AzureToAzureDiskReplicationConfiguration disk1,disk2 -AzureVmId $vmId `
-Name "a2aprotectedItem" -ProtectionContainerMapping $pcmMapping -RecoveryResourceGroupId $recoveryResourceGroup -RecoveryProximityPlacementGroupId $ppg
Starts the replication protected item creation operation for a Virtual Machine inside Proximity placement group and returns the ASR job used to track the operation (Azure to Azure scenario).
Example 9
$job = New-AzRecoveryServicesAsrReplicationProtectedItem -AzureToAzure -AzureToAzureDiskReplicationConfiguration disk1,disk2 -AzureVmId $vmId `
-Name "a2aprotectedItem" -ProtectionContainerMapping $pcmMapping -RecoveryResourceGroupId $recoveryResourceGroup -RecoveryVirtualMachineScaleSetId $vmss
Starts the replication protected item creation operation for a Virtual Machine with target virtual machine scale set configured and returns the ASR job used to track the operation (Azure to Azure scenario).
Parameters
-Account
The run as account to be used to push install the Mobility service if needed. Must be one from the list of run as accounts in the ASR fabric.
Parameter properties
Type: ASRRunAsAccount
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
VMwareToAzureWithDiskType
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
VMwareToAzure
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-ApplianceName
Specifies the name of appliance to be used to replicate this machine.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
ReplicateVMwareToAzure
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzureWithDiskInput
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-AzureToAzure
Switch parameter specifies creating the replicated item in azure to azure scenario.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
AzureToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzureWithoutDiskDetails
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-AzureToAzureDiskReplicationConfiguration
Specifies the disk configuration to used Vm for Azure to Azure disaster recovery scenario.
Parameter properties
Parameter sets
AzureToAzure
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-AzureVmId
Specifies the Azure VM id for disaster recovery protection in recovery region.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
AzureToAzure
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzureWithoutDiskDetails
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-Confirm
Prompts for confirmation before starting the operation.
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
-CredentialsToAccessVm
Specifies the name of credentials to be used to push install the Mobility service on source machine if needed.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
ReplicateVMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzureWithDiskInput
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
-DiskEncryptionSecretUrl
Specifies the disk encryption secret URL with version(Azure disk encryption) to be used be recovery VM after failover.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
AzureToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzureWithoutDiskDetails
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-DiskEncryptionSetId
Specifies the resource Id of the disk encryption set, to be used for the encryption of the managed disks.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
VMwareToAzureWithDiskType
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
VMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-DiskEncryptionVaultId
Specifies the disk encryption secret vault ID(Azure disk encryption) to be used be recovery VM after failover.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
AzureToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzureWithoutDiskDetails
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-DiskTag
Specify the tags for the disks of the VM.
Parameter properties
Parameter sets
VMwareToAzureWithDiskType
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
VMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
HyperVSiteToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-DiskType
Specifies the Recovery VM managed disk type.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
VMwareToAzureWithDiskType
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzure
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-Fabric
Specifies the ASR Fabric object.
Parameter properties
Type: ASRFabric
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
ReplicateVMwareToAzure
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzureWithDiskInput
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-HyperVToAzure
Switch parameter to specify the replicated item is a Hyper-V virtual machine that is being replicated to Azure.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
EnterpriseToAzure
Position: 0
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
HyperVSiteToAzure
Position: 0
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-IncludeDiskId
The list of disks to include for replication. By default all disks are included.
Parameter properties
Type: String [ ]
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
HyperVSiteToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
Specifies the disk configuration input for vMWare disk id to protect from specified protectable item.
VMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
Specifies the disk input to be used for VMware to Azure disaster recovery scenario.
ReplicateVMwareToAzureWithDiskInput
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-KeyEncryptionKeyUrl
Specifies the disk encryption key URL with version(Azure disk encryption) to be used be recovery VM after failover.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
AzureToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzureWithoutDiskDetails
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-KeyEncryptionVaultId
Specifies the disk encryption key key-vault ID(Azure disk encryption) to be used be recovery VM after failover.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
AzureToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzureWithoutDiskDetails
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-LicenseType
Specifies the the license type.
The acceptable values for this parameter are: NoLicenseType or WindowsServer.
Parameter properties
Type: String
Default value: None
Accepted values: NoLicenseType, WindowsServer
Supports wildcards: False
DontShow: False
Parameter sets
ReplicateVMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzureWithDiskInput
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-LogStorageAccountId
Specifies the log or cache storage account Id to be used to store replication logs.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
VMwareToAzureWithDiskType
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
VMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
HyperVSiteToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-Name
Specifies a name for the ASR replication protected item. The name must be unique within the vault.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-OS
Specifies the operating system family.
The acceptable values for this parameter are: Windows or Linux.
Parameter properties
Type: String
Default value: None
Accepted values: Windows, Linux
Supports wildcards: False
DontShow: False
Parameter sets
HyperVSiteToAzure
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-OSDiskName
Specifies the name of the operating system disk.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
HyperVSiteToAzure
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-ProcessServer
The Process Server to use to replicate this machine. Use the list of process servers in the ASR fabric corresponding to the Configuration server to specify one.
Parameter properties
Type: ASRProcessServer
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
VMwareToAzureWithDiskType
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
VMwareToAzure
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-ProtectableItem
Specifies the ASR protectable item object for which replication is being enabled.
Parameter properties
Parameter sets
EnterpriseToEnterprise
Position: Named
Mandatory: True
Value from pipeline: True
Value from pipeline by property name: False
Value from remaining arguments: False
VMwareToAzureWithDiskType
Position: Named
Mandatory: True
Value from pipeline: True
Value from pipeline by property name: False
Value from remaining arguments: False
VMwareToAzure
Position: Named
Mandatory: True
Value from pipeline: True
Value from pipeline by property name: False
Value from remaining arguments: False
EnterpriseToAzure
Position: Named
Mandatory: True
Value from pipeline: True
Value from pipeline by property name: False
Value from remaining arguments: False
HyperVSiteToAzure
Position: Named
Mandatory: True
Value from pipeline: True
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzure
Position: Named
Mandatory: True
Value from pipeline: True
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzureWithDiskInput
Position: Named
Mandatory: True
Value from pipeline: True
Value from pipeline by property name: False
Value from remaining arguments: False
-ProtectionContainerMapping
Specifies the ASR protection container mapping object corresponding to the replication policy to be used for replication.
Parameter properties
Parameter sets
(All)
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-RecoveryAvailabilitySetId
The ID of the AvailabilitySet to recover the machine to in the event of a failover.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
VMwareToAzureWithDiskType
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
VMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
HyperVSiteToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzureWithoutDiskDetails
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzureWithDiskInput
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-RecoveryAvailabilityZone
Specifies the recovery VM availability zone after failover.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
VMwareToAzureWithDiskType
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
VMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
HyperVSiteToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzureWithoutDiskDetails
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzureWithDiskInput
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-RecoveryAzureNetworkId
The ID of the Azure virtual network to recover the machine to in the event of a failover.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
VMwareToAzureWithDiskType
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
VMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
HyperVSiteToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzureWithoutDiskDetails
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzureWithDiskInput
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-RecoveryAzureStorageAccountId
Specifies the ID of the Azure storage account to replicate to.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
EnterpriseToAzure
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
HyperVSiteToAzure
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-RecoveryAzureSubnetName
The subnet within the recovery Azure virtual network to which the failed over virtual machine should be attached in the event of a failover.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
VMwareToAzureWithDiskType
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
VMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
HyperVSiteToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzureWithoutDiskDetails
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzureWithDiskInput
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-RecoveryBootDiagStorageAccountId
Specifies the storage account for boot diagnostics for recovery azure VM.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
AzureToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzureWithoutDiskDetails
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzureWithDiskInput
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-RecoveryCapacityReservationGroupId
Specify the capacity reservation group Id to be used by the failover VM in target recovery region.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
AzureToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzureWithoutDiskDetails
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-RecoveryCloudServiceId
Specifies the resource ID of the recovery cloud service to failover this virtual machine to.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
AzureToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-RecoveryExtendedLocation
Specifies Recovery ExtendedLocation in case of EZ-to-EZ.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
AzureToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-RecoveryNicTag
Specify the tags for the target NICs of the VM.
Parameter properties
Parameter sets
VMwareToAzureWithDiskType
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
VMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
HyperVSiteToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-RecoveryProximityPlacementGroupId
Specify the proximity placement group Id to used by the failover Vm in target recovery region.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
VMwareToAzureWithDiskType
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
VMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
HyperVSiteToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzureWithoutDiskDetails
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzureWithDiskInput
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-RecoveryResourceGroupId
Specifies the ARM identifier of the resource group in which the virtual machine will be created in the event of a failover.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
VMwareToAzureWithDiskType
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
VMwareToAzure
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
EnterpriseToAzure
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
HyperVSiteToAzure
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzure
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzureWithoutDiskDetails
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzure
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzureWithDiskInput
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-RecoveryVirtualMachineScaleSetId
Specify the virtual machine scale set Id to used by the failover Vm in target recovery region.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
AzureToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzureWithoutDiskDetails
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-RecoveryVmName
Name of the recovery Vm created after failover.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
VMwareToAzureWithDiskType
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
VMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
EnterpriseToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
HyperVSiteToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzureWithDiskInput
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-RecoveryVmTag
Specify the tags for target VM.
Parameter properties
Parameter sets
VMwareToAzureWithDiskType
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
VMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
HyperVSiteToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-ReplicateVMwareToAzure
Switch parameter to specify the replicated item is a VMware virtual machine that is being replicated to Azure.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
ReplicateVMwareToAzure
Position: 0
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzureWithDiskInput
Position: 0
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-ReplicationGroupName
Specifies the replication group name to use to create multi-VM consistent recovery points. By default each replication protected item is created in a group of its own and multi-VM consistent recovery points are not generated. Use this option only if you need to create multi-VM consistent recovery points across a group of machines by protecting all machines to the same replication group.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
VMwareToAzureWithDiskType
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
VMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
AzureToAzureWithoutDiskDetails
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzureWithDiskInput
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-Size
Specify the recovery virtual machine size.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
VMwareToAzureWithDiskType
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
VMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
HyperVSiteToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzureWithDiskInput
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-SqlServerLicenseType
Specify the SQL Server license type of the VM.
Parameter properties
Type: String
Default value: None
Accepted values: NoLicenseType, PAYG, AHUB
Supports wildcards: False
DontShow: False
Parameter sets
VMwareToAzureWithDiskType
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
VMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
HyperVSiteToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-TestNetworkId
Specifies the test network ARM Id.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
ReplicateVMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzureWithDiskInput
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-TestSubnetName
Specifies the test network subnet name.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
ReplicateVMwareToAzure
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
ReplicateVMwareToAzureWithDiskInput
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-UseManagedDisk
Specifies if the Azure virtual machine that is created on failover should use managed disks. It Accepts either True or False.
Parameter properties
Type: String
Default value: None
Accepted values: True, False
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-UseManagedDisksForReplication
Specifies if the managed disks needs to be used during replication. It Accepts either True or False.
Parameter properties
Type: String
Default value: None
Accepted values: True, False
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-VmmToVmm
Switch parameter to specify the replicated item is a Hyper-V virtual machine that is being replicated between VMM managed Hyper-V sites.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
EnterpriseToEnterprise
Position: 0
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-VMwareToAzure
Switch parameter to specify the replicated item is a VMware virtual machine or physical server that will be replicate to Azure.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
VMwareToAzureWithDiskType
Position: 0
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
VMwareToAzure
Position: 0
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-WaitForCompletion
Specifies that the cmdlet should wait for completion of the operation before returning.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
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 .
Outputs