diff --git a/src/Migrate/Migrate.Autorest/README.md b/src/Migrate/Migrate.Autorest/README.md index 682c2f2b5635..0ae172534f20 100644 --- a/src/Migrate/Migrate.Autorest/README.md +++ b/src/Migrate/Migrate.Autorest/README.md @@ -3,7 +3,6 @@ This directory contains the PowerShell module for the Migrate service. --- - ## Info - Modifiable: yes - Generated: all diff --git a/src/Migrate/Migrate/Az.Migrate.psd1 b/src/Migrate/Migrate/Az.Migrate.psd1 index e2ed32489022..a14024f0c26c 100644 --- a/src/Migrate/Migrate/Az.Migrate.psd1 +++ b/src/Migrate/Migrate/Az.Migrate.psd1 @@ -3,7 +3,7 @@ # # Generated by: Microsoft Corporation # -# Generated on: 1/30/2024 +# Generated on: 3/17/2024 # @{ @@ -51,16 +51,16 @@ DotNetFrameworkVersion = '4.7.2' # ProcessorArchitecture = '' # Modules that must be imported into the global environment prior to importing this module -RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '2.15.1'; }) +RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '2.16.0'; }) # Assemblies that must be loaded prior to importing this module RequiredAssemblies = 'Migrate.Autorest/bin/Az.Migrate.private.dll' # Script files (.ps1) that are run in the caller's environment prior to importing this module. -# ScriptsToProcess = @() +ScriptsToProcess = @() # Type files (.ps1xml) to be loaded when importing this module -# TypesToProcess = @() +TypesToProcess = @() # Format files (.ps1xml) to be loaded when importing this module FormatsToProcess = 'Migrate.Autorest/Az.Migrate.format.ps1xml' @@ -123,7 +123,7 @@ PrivateData = @{ PSData = @{ # Tags applied to this module. These help with module discovery in online galleries. - Tags = 'Azure','ResourceManager','ARM','PSModule','Migrate' + Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'Migrate' # A URL to the license for this module. LicenseUri = 'https://aka.ms/azps-license' @@ -148,7 +148,7 @@ PrivateData = @{ } # End of PSData hashtable - } # End of PrivateData hashtable +} # End of PrivateData hashtable # HelpInfo URI of this module # HelpInfoURI = '' diff --git a/src/Migrate/Migrate/help/Az.Migrate.md b/src/Migrate/Migrate/help/Az.Migrate.md index f212b3a21e02..c3af3fde38d1 100644 --- a/src/Migrate/Migrate/help/Az.Migrate.md +++ b/src/Migrate/Migrate/help/Az.Migrate.md @@ -14,6 +14,15 @@ Microsoft Azure PowerShell: Migrate cmdlets ### [Get-AzMigrateDiscoveredServer](Get-AzMigrateDiscoveredServer.md) Get All discovered servers in a migrate project. +### [Get-AzMigrateHCIJob](Get-AzMigrateHCIJob.md) +Retrieves the status of an Azure Migrate job. + +### [Get-AzMigrateHCIReplicationFabric](Get-AzMigrateHCIReplicationFabric.md) +Gets the details of the fabric. + +### [Get-AzMigrateHCIServerReplication](Get-AzMigrateHCIServerReplication.md) +Retrieves the details of the replicating server. + ### [Get-AzMigrateJob](Get-AzMigrateJob.md) Retrieves the status of an Azure Migrate job. @@ -47,12 +56,24 @@ Method to get a site. ### [Get-AzMigrateSolution](Get-AzMigrateSolution.md) Gets a solution in the migrate project. +### [Initialize-AzMigrateHCIReplicationInfrastructure](Initialize-AzMigrateHCIReplicationInfrastructure.md) +Initializes the infrastructure for the migrate project. + ### [Initialize-AzMigrateReplicationInfrastructure](Initialize-AzMigrateReplicationInfrastructure.md) Initialises the infrastructure for the migrate project. ### [New-AzMigrateDiskMapping](New-AzMigrateDiskMapping.md) Creates a new disk mapping +### [New-AzMigrateHCIDiskMappingObject](New-AzMigrateHCIDiskMappingObject.md) +Creates a new disk mapping + +### [New-AzMigrateHCINicMappingObject](New-AzMigrateHCINicMappingObject.md) +Creates an object to update NIC properties of a replicating server. + +### [New-AzMigrateHCIServerReplication](New-AzMigrateHCIServerReplication.md) +Starts replication for the specified server. + ### [New-AzMigrateNicMapping](New-AzMigrateNicMapping.md) Creates an object to update NIC properties of a replicating server. @@ -74,6 +95,9 @@ Creates an object to update NIC properties of a test migrating server. ### [Register-AzMigrateProjectTool](Register-AzMigrateProjectTool.md) Registers a tool with the migrate project. +### [Remove-AzMigrateHCIServerReplication](Remove-AzMigrateHCIServerReplication.md) +Stops replication for the migrated server. + ### [Remove-AzMigrateProject](Remove-AzMigrateProject.md) Delete the migrate project. Deleting non-existent project is a no-operation. @@ -90,9 +114,15 @@ Starts the replication that has been suspended. ### [Set-AzMigrateDiskMapping](Set-AzMigrateDiskMapping.md) Updates disk mapping +### [Set-AzMigrateHCIServerReplication](Set-AzMigrateHCIServerReplication.md) +Updates the target properties for the replicating server. + ### [Set-AzMigrateServerReplication](Set-AzMigrateServerReplication.md) Updates the target properties for the replicating server. +### [Start-AzMigrateHCIServerMigration](Start-AzMigrateHCIServerMigration.md) +Starts the migration for the replicating server. + ### [Start-AzMigrateServerMigration](Start-AzMigrateServerMigration.md) Starts the migration for the replicating server. diff --git a/src/Migrate/Migrate/help/Get-AzMigrateDiscoveredServer.md b/src/Migrate/Migrate/help/Get-AzMigrateDiscoveredServer.md index 1160433cf5a7..c505318c0a97 100644 --- a/src/Migrate/Migrate/help/Get-AzMigrateDiscoveredServer.md +++ b/src/Migrate/Migrate/help/Get-AzMigrateDiscoveredServer.md @@ -15,26 +15,29 @@ Get All discovered servers in a migrate project. ### List (Default) ``` Get-AzMigrateDiscoveredServer -ProjectName -ResourceGroupName [-DisplayName ] - [-SourceMachineType ] [-SubscriptionId ] [-WhatIf] [-Confirm] [] + [-SourceMachineType ] [-SubscriptionId ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ### ListInSite ``` Get-AzMigrateDiscoveredServer -ProjectName -ResourceGroupName [-DisplayName ] - [-SourceMachineType ] [-SubscriptionId ] -ApplianceName [-WhatIf] [-Confirm] - [] + [-SourceMachineType ] [-SubscriptionId ] -ApplianceName + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### Get ``` Get-AzMigrateDiscoveredServer -ProjectName -ResourceGroupName [-SourceMachineType ] - [-SubscriptionId ] -Name [-WhatIf] [-Confirm] [] + [-SubscriptionId ] -Name [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### GetInSite ``` Get-AzMigrateDiscoveredServer -ProjectName -ResourceGroupName [-SourceMachineType ] - [-SubscriptionId ] -Name -ApplianceName [-WhatIf] [-Confirm] [] + [-SubscriptionId ] -Name -ApplianceName [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -42,7 +45,7 @@ Get Azure migrate server commandlet fetches all servers in a migrate project. ## EXAMPLES -### Example 1: List +### Example 1: List VMware machines ```powershell Get-AzMigrateDiscoveredServer -SubscriptionId xxx-xxx-xxx -ResourceGroupName julytest -ProjectName julytest ``` @@ -64,7 +67,7 @@ idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029cc18-ef Get All servers in a migrate project. -### Example 2: Get +### Example 2: Get VMware machine ```powershell Get-AzMigrateDiscoveredServer -Name idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029e62c-31d2-a6c3-5316-aa39f47c49fc -SubscriptionId xxx-xxx-xxx -ResourceGroupName julytest -ProjectName julytest ``` @@ -78,7 +81,7 @@ idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029e62c-31 Get a server in a migrate project by name. Name is a unique paramenter for a server. -### Example 3: List in an appliance +### Example 3: List VMware machines in an appliance ```powershell Get-AzMigrateDiscoveredServer -ApplianceName BBVMwareAVS -SubscriptionId xxx-xxx-xxx -ResourceGroupName julytest -ProjectName julytest ``` @@ -100,7 +103,7 @@ idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029cc18-ef List all servers for an appliance in a project. -### Example 4: Get in an appliance +### Example 4: Get VMware machine in an appliance ```powershell Get-AzMigrateDiscoveredServer -Name idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029e62c-31d2-a6c3-5316-aa39f47c49fc -ApplianceName BBVMwareAVS -SubscriptionId xxx-xxx-xxx -ResourceGroupName julytest -ProjectName julytest ``` @@ -114,7 +117,7 @@ idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029e62c-31 Get a server for an appliance in a project. Name is a unique paramenter for a server. -### Example 5: List and filter by display name +### Example 5: List and filter VMware machines by display name ```powershell Get-AzMigrateDiscoveredServer -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -ProjectName BugBashAVSVMware -DisplayName Contoso | Format-Table DisplayName,Name,Type ``` @@ -133,7 +136,7 @@ ContosoAppSrv1 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_5 List servers in a migrate project and filter responses with display name. -### Example 6: List in an appliance and filter by display name +### Example 6: List VMware machines in an appliance and filter by display name ```powershell Get-AzMigrateDiscoveredServer -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -ProjectName BugBashAVSVMware -ApplianceName BBVMwareAVS -DisplayName Contoso | Format-Table DisplayName,Name,Type ``` @@ -153,6 +156,23 @@ Contoso-DataTier3 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_5 List servers for an appliance in a migrate project and filter responses with display name. +### Example 7: List HyperV machines +```powershell +Get-AzMigrateDiscoveredServer -SubscriptionId xxx-xxx-xxx -ResourceGroupName "test-rg" -ProjectName "testproj" -SourceMachineType "HyperV" | Format-Table DisplayName,Name,Type +``` + +```output +DisplayName Name Type +----------- ---- ---- +testvm1 291b6c67-8793-4e21-887e-1e6c3bd00a60 Microsoft.OffAzure/HyperVSites/machines +testvm2 0fbd6ccb-7133-4e72-b18e-5ec98c9c628f Microsoft.OffAzure/HyperVSites/machines +testvm3 e6390dfa-6125-431c-871d-f407bdecb571 Microsoft.OffAzure/HyperVSites/machines +testvm4 af83b64b-2314-48e2-8d0f-fd44ab5142ba Microsoft.OffAzure/HyperVSites/machines +``` + +Get All HyperV servers in a migrate project. +Similarly, specify "HyperV" for -SourceMachineType in all the above examples can retrieve HyperV machine(s) in different ways. + ## PARAMETERS ### -ApplianceName @@ -172,7 +192,7 @@ Accept wildcard characters: False ``` ### -DisplayName -Specifies the VMware machine display name. +Specifies the source machine display name. ```yaml Type: System.String @@ -187,7 +207,7 @@ Accept wildcard characters: False ``` ### -Name -Specifies the VMware machine name. +Specifies the source machine name. This is an internal Name. For users, use display name. @@ -203,6 +223,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProjectName Specifies the migrate project name. @@ -302,10 +337,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202001.IHyperVMachine + ### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202001.IVMwareMachine ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Get-AzMigrateHCIJob.md b/src/Migrate/Migrate/help/Get-AzMigrateHCIJob.md index 04e23d70ef8f..c4d45df4ec63 100644 --- a/src/Migrate/Migrate/help/Get-AzMigrateHCIJob.md +++ b/src/Migrate/Migrate/help/Get-AzMigrateHCIJob.md @@ -15,30 +15,31 @@ Retrieves the status of an Azure Migrate job. ### ListByName (Default) ``` Get-AzMigrateHCIJob -ResourceGroupName -ProjectName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetByName ``` Get-AzMigrateHCIJob -ResourceGroupName -ProjectName [-SubscriptionId ] -Name - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetById ``` -Get-AzMigrateHCIJob [-SubscriptionId ] -ID [-DefaultProfile ] [] +Get-AzMigrateHCIJob [-SubscriptionId ] -ID [-DefaultProfile ] + [-ProgressAction ] [] ``` ### GetByInputObject ``` Get-AzMigrateHCIJob [-SubscriptionId ] -InputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ### ListById ``` Get-AzMigrateHCIJob [-SubscriptionId ] -ResourceGroupID -ProjectID - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -46,42 +47,279 @@ The Get-AzMigrateHCIJob cmdlet retrives the status of an Azure Migrate job. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Get by job Id +```powershell Get-AzMigrateHCIJob -ID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/jobs/0203aa1b-1dff-4653-89a9-b90a76d1601a" ``` -### EXAMPLE 2 +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {Cancel} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelCustomPropertiesAffectedObjectDetails +CustomPropertyInstanceType : WorkflowDetails +DisplayName : Delete protected item +EndTime : +Error : {} +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication + /replicationVaults/testproj1234replicationvault/jobs/0203aa1b-1dff-4653-89a9-b90a76d1601a +Name : 0203aa1b-1dff-4653-89a9-b90a76d1601a +ObjectId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication + /replicationVaults/testproj1234replicationvault/protectedItems/testsite-0000-0000-00000001 +ObjectInternalId : 13436868-1f4c-5d4e-a252-c666179bf4df +ObjectInternalName : testmachine1 +ObjectName : testsite-0000-0000-00000001 +ObjectType : ProtectedItem +ReplicationProviderId : 0a870516-56c7-4460-998c-f267bd579f16 +SourceFabricProviderId : a2793d98-d4f1-427f-a5a6-2d694f4a1bf7 +StartTime : 8/14/2023 7:09:10 PM +State : Started +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelTags +TargetFabricProviderId : 22f00372-a1b7-467f-87ce-d95e17a6e7c7 +Task : {Prerequisite check, Deleting protected item} +Type : Microsoft.DataReplication/replicationVaults/jobs ``` + +Retrieves a job by its Id. + +### Example 2: Get by job name +```powershell Get-AzMigrateHCIJob -ResourceGroupName "test-rg" -ProjectName "testproj" -Name "0203aa1b-1dff-4653-89a9-b90a76d1601a" ``` -### EXAMPLE 3 +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {Cancel} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelCustomPropertiesAffectedObjectDetails +CustomPropertyInstanceType : WorkflowDetails +DisplayName : Delete protected item +EndTime : +Error : {} +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication + /replicationVaults/testproj1234replicationvault/jobs/0203aa1b-1dff-4653-89a9-b90a76d1601a +Name : 0203aa1b-1dff-4653-89a9-b90a76d1601a +ObjectId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication + /replicationVaults/testproj1234replicationvault/protectedItems/testsite-0000-0000-00000001 +ObjectInternalId : 13436868-1f4c-5d4e-a252-c666179bf4df +ObjectInternalName : testmachine1 +ObjectName : testsite-0000-0000-00000001 +ObjectType : ProtectedItem +ReplicationProviderId : 0a870516-56c7-4460-998c-f267bd579f16 +SourceFabricProviderId : a2793d98-d4f1-427f-a5a6-2d694f4a1bf7 +StartTime : 8/14/2023 7:09:10 PM +State : Started +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelTags +TargetFabricProviderId : 22f00372-a1b7-467f-87ce-d95e17a6e7c7 +Task : {Prerequisite check, Deleting protected item} +Type : Microsoft.DataReplication/replicationVaults/jobs ``` + +Retrieves a job by its name. + +### Example 3: Get by job input object +```powershell $InputObject = Get-AzMigrateHCIJob -ID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/jobs/0203aa1b-1dff-4653-89a9-b90a76d1601a" -``` Get-AzMigrateHCIJob -InputObject $InputObject $InputObject | Get-AzMigrateHCIJob +``` -### EXAMPLE 4 +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {Cancel} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelCustomPropertiesAffectedObjectDetails +CustomPropertyInstanceType : WorkflowDetails +DisplayName : Delete protected item +EndTime : +Error : {} +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication + /replicationVaults/testproj1234replicationvault/jobs/0203aa1b-1dff-4653-89a9-b90a76d1601a +Name : 0203aa1b-1dff-4653-89a9-b90a76d1601a +ObjectId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication + /replicationVaults/testproj1234replicationvault/protectedItems/testsite-0000-0000-00000001 +ObjectInternalId : 13436868-1f4c-5d4e-a252-c666179bf4df +ObjectInternalName : testmachine1 +ObjectName : testsite-0000-0000-00000001 +ObjectType : ProtectedItem +ReplicationProviderId : 0a870516-56c7-4460-998c-f267bd579f16 +SourceFabricProviderId : a2793d98-d4f1-427f-a5a6-2d694f4a1bf7 +StartTime : 8/14/2023 7:09:10 PM +State : Started +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelTags +TargetFabricProviderId : 22f00372-a1b7-467f-87ce-d95e17a6e7c7 +Task : {Prerequisite check, Deleting protected item} +Type : Microsoft.DataReplication/replicationVaults/jobs ``` + +Retrieves a job by the job itself as an input object. + +### Example 4: List by resource group Id and project Id. +```powershell Get-AzMigrateHCIJob -ResourceGroupID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg" -ProjectID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.Migrate/MigrateProjects/testproj" ``` -### EXAMPLE 5 +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {Cancel} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelCustomPropertiesAffectedObjectDetails +CustomPropertyInstanceType : WorkflowDetails +DisplayName : Delete protected item +EndTime : +Error : {} +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication + /replicationVaults/testproj1234replicationvault/jobs/0203aa1b-1dff-4653-89a9-b90a76d1601a +Name : 0203aa1b-1dff-4653-89a9-b90a76d1601a +ObjectId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication + /replicationVaults/testproj1234replicationvault/protectedItems/testsite-0000-0000-00000001 +ObjectInternalId : 13436868-1f4c-5d4e-a252-c666179bf4df +ObjectInternalName : testmachine1 +ObjectName : testsite-0000-0000-00000001 +ObjectType : ProtectedItem +ReplicationProviderId : 0a870516-56c7-4460-998c-f267bd579f16 +SourceFabricProviderId : a2793d98-d4f1-427f-a5a6-2d694f4a1bf7 +StartTime : 8/14/2023 7:09:10 PM +State : Started +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelTags +TargetFabricProviderId : 22f00372-a1b7-467f-87ce-d95e17a6e7c7 +Task : {Prerequisite check, Deleting protected item} +Type : Microsoft.DataReplication/replicationVaults/jobs + +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelCustomPropertiesAffectedObjectDetails +CustomPropertyInstanceType : +DisplayName : Planned failover +EndTime : 8/11/2023 10:09:18 PM +Error : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication + /replicationVaults/testproj1234replicationvault/jobs/f2ebb932-fa4a-47a7-b1fa-ff5aa877d5ed +Name : f2ebb932-fa4a-47a7-b1fa-ff5aa877d5ed +ObjectId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication + /replicationVaults/testproj1234replicationvault/protectedItems/testsite-0000-0000-00000000/plannedFailover +ObjectInternalId : 4ef231a3-0774-5e44-8317-bed903d297a2 +ObjectInternalName : testmachine2 +ObjectName : testsite-0000-0000-00000000 +ObjectType : ProtectedItem +ReplicationProviderId : 0a870516-56c7-4460-998c-f267bd579f16 +SourceFabricProviderId : a2793d98-d4f1-427f-a5a6-2d694f4a1bf7 +StartTime : 8/11/2023 9:53:48 PM +State : Succeeded +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelTags +TargetFabricProviderId : 22f00372-a1b7-467f-87ce-d95e17a6e7c7 +Task : +Type : Microsoft.DataReplication/replicationVaults/jobs ``` + +Retrieves all the jobs from a project in some resource group by Ids. + +### Example 5: List by resource group name and project name. +```powershell Get-AzMigrateHCIJob -ResourceGroupName "test-rg" -ProjectName "testproj" ``` +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {Cancel} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelCustomPropertiesAffectedObjectDetails +CustomPropertyInstanceType : WorkflowDetails +DisplayName : Delete protected item +EndTime : +Error : {} +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication + /replicationVaults/testproj1234replicationvault/jobs/0203aa1b-1dff-4653-89a9-b90a76d1601a +Name : 0203aa1b-1dff-4653-89a9-b90a76d1601a +ObjectId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication + /replicationVaults/testproj1234replicationvault/protectedItems/testsite-0000-0000-00000001 +ObjectInternalId : 13436868-1f4c-5d4e-a252-c666179bf4df +ObjectInternalName : testmachine1 +ObjectName : testsite-0000-0000-00000001 +ObjectType : ProtectedItem +ReplicationProviderId : 0a870516-56c7-4460-998c-f267bd579f16 +SourceFabricProviderId : a2793d98-d4f1-427f-a5a6-2d694f4a1bf7 +StartTime : 8/14/2023 7:09:10 PM +State : Started +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelTags +TargetFabricProviderId : 22f00372-a1b7-467f-87ce-d95e17a6e7c7 +Task : {Prerequisite check, Deleting protected item} +Type : Microsoft.DataReplication/replicationVaults/jobs + +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelCustomPropertiesAffectedObjectDetails +CustomPropertyInstanceType : +DisplayName : Planned failover +EndTime : 8/11/2023 10:09:18 PM +Error : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication + /replicationVaults/testproj1234replicationvault/jobs/f2ebb932-fa4a-47a7-b1fa-ff5aa877d5ed +Name : f2ebb932-fa4a-47a7-b1fa-ff5aa877d5ed +ObjectId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication + /replicationVaults/testproj1234replicationvault/protectedItems/testsite-0000-0000-00000000/plannedFailover +ObjectInternalId : 4ef231a3-0774-5e44-8317-bed903d297a2 +ObjectInternalName : testmachine2 +ObjectName : testsite-0000-0000-00000000 +ObjectType : ProtectedItem +ReplicationProviderId : 0a870516-56c7-4460-998c-f267bd579f16 +SourceFabricProviderId : a2793d98-d4f1-427f-a5a6-2d694f4a1bf7 +StartTime : 8/11/2023 9:53:48 PM +State : Succeeded +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelTags +TargetFabricProviderId : 22f00372-a1b7-467f-87ce-d95e17a6e7c7 +Task : +Type : Microsoft.DataReplication/replicationVaults/jobs +``` + +Retrieves all the jobs from a project in some resource group by names. + ## PARAMETERS ### -DefaultProfile The credentials, account, tenant, and subscription used for communication with Azure. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -96,7 +334,7 @@ Accept wildcard characters: False Specifies the job id for which the details needs to be retrieved. ```yaml -Type: String +Type: System.String Parameter Sets: GetById Aliases: @@ -112,7 +350,7 @@ Specifies the job object of the replicating server. To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml -Type: IMigrateIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity Parameter Sets: GetByInputObject Aliases: @@ -127,7 +365,7 @@ Accept wildcard characters: False Job identifier ```yaml -Type: String +Type: System.String Parameter Sets: GetByName Aliases: @@ -138,11 +376,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProjectID Specifies the Azure Migrate Project in which servers are replicating. ```yaml -Type: String +Type: System.String Parameter Sets: ListById Aliases: @@ -157,7 +410,7 @@ Accept wildcard characters: False The name of the migrate project. ```yaml -Type: String +Type: System.String Parameter Sets: ListByName, GetByName Aliases: @@ -172,7 +425,7 @@ Accept wildcard characters: False Specifies the Resource Group of the Azure Migrate Project in the current subscription. ```yaml -Type: String +Type: System.String Parameter Sets: ListById Aliases: @@ -187,7 +440,7 @@ Accept wildcard characters: False The name of the resource group where the recovery services vault is present. ```yaml -Type: String +Type: System.String Parameter Sets: ListByName, GetByName Aliases: @@ -202,13 +455,13 @@ Accept wildcard characters: False Azure Subscription ID. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -219,64 +472,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.IWorkflowModel + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Specifies the job object of the replicating server. - \[AccountName \\]: Run as account ARM name. - \[AlertSettingName \\]: The name of the email notification configuration. - \[ClusterName \\]: Cluster ARM name. - \[DatabaseInstanceName \\]: Unique name of a database instance in Azure migration hub. - \[DatabaseName \\]: Unique name of a database in Azure migration hub. - \[DeploymentId \\]: Deployment Id. - \[EmailConfigurationName \\]: The email configuration name. - \[EventName \\]: Unique name of an event within a migrate project. - \[FabricAgentName \\]: The fabric agent (Dra) name. - \[FabricName \\]: Fabric name. - \[HostName \\]: Host ARM name. - \[Id \\]: Resource identity path - \[IntentObjectName \\]: Replication protection intent name. - \[JobName \\]: Job ARM name. - \[Location \\]: The name of the Azure region. - \[LogicalNetworkName \\]: Logical network name. - \[MachineName \\]: Machine ARM name. - \[MappingName \\]: Protection Container mapping name. - \[MigrateProjectName \\]: Name of the Azure Migrate project. - \[MigrationItemName \\]: Migration item name. - \[MigrationRecoveryPointName \\]: The migration recovery point name. - \[NetworkMappingName \\]: Network mapping name. - \[NetworkName \\]: Primary network name. - \[OperationId \\]: The ID of an ongoing async operation. - \[OperationStatusName \\]: Operation status ARM name. - \[PolicyName \\]: Replication policy name. - \[ProtectableItemName \\]: Protectable item name. - \[ProtectedItemName \\]: The protected item name. - \[ProtectionContainerName \\]: Protection container name. - \[ProviderName \\]: Recovery services provider name. - \[RecoveryPlanName \\]: Name of the recovery plan. - \[RecoveryPointName \\]: The recovery point name. - \[ReplicatedProtectedItemName \\]: Replication protected item name. - \[ReplicationExtensionName \\]: The replication extension name. - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ResourceName \\]: The name of the recovery services vault. - \[SiteName \\]: Site name. - \[SolutionName \\]: Unique name of a migration solution within a migrate project. - \[StorageClassificationMappingName \\]: Storage classification mapping name. - \[StorageClassificationName \\]: Storage classification name. - \[SubscriptionId \\]: The ID of the target subscription. - \[VaultName \\]: The vault name. - \[VaultSettingName \\]: Vault setting name. - \[VcenterName \\]: VCenter ARM name. - \[VirtualMachineName \\]: Virtual Machine name. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratehcijob](https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratehcijob) - diff --git a/src/Migrate/Migrate/help/Get-AzMigrateHCIReplicationFabric.md b/src/Migrate/Migrate/help/Get-AzMigrateHCIReplicationFabric.md index a8a1e8d60628..369d7f04f81f 100644 --- a/src/Migrate/Migrate/help/Get-AzMigrateHCIReplicationFabric.md +++ b/src/Migrate/Migrate/help/Get-AzMigrateHCIReplicationFabric.md @@ -15,25 +15,26 @@ Gets the details of the fabric. ### List (Default) ``` Get-AzMigrateHCIReplicationFabric [-SubscriptionId ] [-ContinuationToken ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzMigrateHCIReplicationFabric -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### List1 ``` Get-AzMigrateHCIReplicationFabric -ResourceGroupName [-SubscriptionId ] - [-ContinuationToken ] [-DefaultProfile ] [] + [-ContinuationToken ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### GetViaIdentity ``` Get-AzMigrateHCIReplicationFabric -InputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -41,37 +42,133 @@ Gets the details of the fabric. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Get by fabric name +```powershell Get-AzMigrateHCIReplicationFabric -ResourceGroupName "test-rg" -Name "testsrcappreplicationfabric" ``` -### EXAMPLE 2 +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationFabrics/testsrcappreplicationfabric +Location : southeastasia +Name : testsrcappreplicationfabric +Property : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.FabricModelProperties +SystemDataCreatedAt : 8/11/2023 6:39:04 PM +SystemDataCreatedBy : testuser@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 8/11/2023 6:48:29 PM +SystemDataLastModifiedBy : testuser@example.com +SystemDataLastModifiedByType : User +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.FabricModelTags +Type : Microsoft.DataReplication/replicationFabrics ``` + +Retrieves a fabric by its name. + +### Example 2: Get by fabric input object +```powershell $InputObject = Get-AzMigrateHCIReplicationFabric -ResourceGroupName "test-rg" -Name "testsrcappreplicationfabric" -``` Get-AzMigrateHCIReplicationFabric -InputObject $InputObject $InputObject | Get-AzMigrateHCIReplicationFabric +``` -### EXAMPLE 3 +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationFabrics/testsrcappreplicationfabric +Location : southeastasia +Name : testsrcappreplicationfabric +Property : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.FabricModelProperties +SystemDataCreatedAt : 8/11/2023 6:39:04 PM +SystemDataCreatedBy : testuser@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 8/11/2023 6:48:29 PM +SystemDataLastModifiedBy : testuser@example.com +SystemDataLastModifiedByType : User +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.FabricModelTags +Type : Microsoft.DataReplication/replicationFabrics ``` + +Retrieves a fabric by the fabric itself as an input object. + +### Example 3: List by resource group name +```powershell Get-AzMigrateHCIReplicationFabric -ResourceGroupName "test-rg" ``` -### EXAMPLE 4 +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationFabrics/testsrcappreplicationfabric +Location : southeastasia +Name : testsrcappreplicationfabric +Property : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.FabricModelProperties +SystemDataCreatedAt : 8/11/2023 6:39:04 PM +SystemDataCreatedBy : testuser@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 8/11/2023 6:48:29 PM +SystemDataLastModifiedBy : testuser@example.com +SystemDataLastModifiedByType : User +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.FabricModelTags +Type : Microsoft.DataReplication/replicationFabrics + +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationFabrics/testtgtappreplicationfabric +Location : southeastasia +Name : testtgtappreplicationfabric +Property : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.FabricModelProperties +SystemDataCreatedAt : 8/11/2023 9:16:46 PM +SystemDataCreatedBy : testuser@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 8/11/2023 9:16:46 PM +SystemDataLastModifiedBy : testuser@example.com +SystemDataLastModifiedByType : User +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.FabricModelTags +Type : Microsoft.DataReplication/replicationFabrics ``` + +Retrieves all fabrics from a resource group by name. + +### Example 4: List all fabircs +```powershell Get-AzMigrateHCIReplicationFabric ``` +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationFabrics/testsrcappreplicationfabric +Location : southeastasia +Name : testsrcappreplicationfabric +Property : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.FabricModelProperties +SystemDataCreatedAt : 8/11/2023 6:39:04 PM +SystemDataCreatedBy : testuser@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 8/11/2023 6:48:29 PM +SystemDataLastModifiedBy : testuser@example.com +SystemDataLastModifiedByType : User +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.FabricModelTags +Type : Microsoft.DataReplication/replicationFabrics + +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationFabrics/testtgtappreplicationfabric +Location : southeastasia +Name : testtgtappreplicationfabric +Property : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.FabricModelProperties +SystemDataCreatedAt : 8/11/2023 9:16:46 PM +SystemDataCreatedBy : testuser@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 8/11/2023 9:16:46 PM +SystemDataLastModifiedBy : testuser@example.com +SystemDataLastModifiedByType : User +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.FabricModelTags +Type : Microsoft.DataReplication/replicationFabrics + +... +``` + +Retrieves all fabrics from a subscription. + ## PARAMETERS ### -ContinuationToken Continuation token from the previous call. ```yaml -Type: String +Type: System.String Parameter Sets: List, List1 Aliases: @@ -87,7 +184,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -103,7 +200,7 @@ Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml -Type: IMigrateIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity Parameter Sets: GetViaIdentity Aliases: @@ -118,7 +215,7 @@ Accept wildcard characters: False The fabric name. ```yaml -Type: String +Type: System.String Parameter Sets: Get Aliases: FabricName @@ -129,12 +226,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: Get, List1 Aliases: @@ -149,13 +261,13 @@ Accept wildcard characters: False Azure Subscription Id in which migrate project was created. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: List, Get, List1 Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -166,64 +278,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.IFabricModel + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[AccountName \\]: Run as account ARM name. - \[AlertSettingName \\]: The name of the email notification configuration. - \[ClusterName \\]: Cluster ARM name. - \[DatabaseInstanceName \\]: Unique name of a database instance in Azure migration hub. - \[DatabaseName \\]: Unique name of a database in Azure migration hub. - \[DeploymentId \\]: Deployment Id. - \[EmailConfigurationName \\]: The email configuration name. - \[EventName \\]: Unique name of an event within a migrate project. - \[FabricAgentName \\]: The fabric agent (Dra) name. - \[FabricName \\]: Fabric name. - \[HostName \\]: Host ARM name. - \[Id \\]: Resource identity path - \[IntentObjectName \\]: Replication protection intent name. - \[JobName \\]: Job ARM name. - \[Location \\]: The name of the Azure region. - \[LogicalNetworkName \\]: Logical network name. - \[MachineName \\]: Machine ARM name. - \[MappingName \\]: Protection Container mapping name. - \[MigrateProjectName \\]: Name of the Azure Migrate project. - \[MigrationItemName \\]: Migration item name. - \[MigrationRecoveryPointName \\]: The migration recovery point name. - \[NetworkMappingName \\]: Network mapping name. - \[NetworkName \\]: Primary network name. - \[OperationId \\]: The ID of an ongoing async operation. - \[OperationStatusName \\]: Operation status ARM name. - \[PolicyName \\]: Replication policy name. - \[ProtectableItemName \\]: Protectable item name. - \[ProtectedItemName \\]: The protected item name. - \[ProtectionContainerName \\]: Protection container name. - \[ProviderName \\]: Recovery services provider name. - \[RecoveryPlanName \\]: Name of the recovery plan. - \[RecoveryPointName \\]: The recovery point name. - \[ReplicatedProtectedItemName \\]: Replication protected item name. - \[ReplicationExtensionName \\]: The replication extension name. - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ResourceName \\]: The name of the recovery services vault. - \[SiteName \\]: Site name. - \[SolutionName \\]: Unique name of a migration solution within a migrate project. - \[StorageClassificationMappingName \\]: Storage classification mapping name. - \[StorageClassificationName \\]: Storage classification name. - \[SubscriptionId \\]: The ID of the target subscription. - \[VaultName \\]: The vault name. - \[VaultSettingName \\]: Vault setting name. - \[VcenterName \\]: VCenter ARM name. - \[VirtualMachineName \\]: Virtual Machine name. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratehcireplicationfabric](https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratehcireplicationfabric) - diff --git a/src/Migrate/Migrate/help/Get-AzMigrateHCIServerReplication.md b/src/Migrate/Migrate/help/Get-AzMigrateHCIServerReplication.md index e06ef22f412b..82d5a684aa93 100644 --- a/src/Migrate/Migrate/help/Get-AzMigrateHCIServerReplication.md +++ b/src/Migrate/Migrate/help/Get-AzMigrateHCIServerReplication.md @@ -15,37 +15,37 @@ Retrieves the details of the replicating server. ### ListByName (Default) ``` Get-AzMigrateHCIServerReplication -ResourceGroupName -ProjectName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetByMachineName ``` Get-AzMigrateHCIServerReplication -ResourceGroupName -ProjectName [-SubscriptionId ] - -MachineName [-DefaultProfile ] [] + -MachineName [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetByItemID ``` Get-AzMigrateHCIServerReplication [-SubscriptionId ] -TargetObjectID - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetBySDSID ``` Get-AzMigrateHCIServerReplication [-SubscriptionId ] -DiscoveredMachineId - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetByInputObject ``` Get-AzMigrateHCIServerReplication [-SubscriptionId ] -InputObject - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### ListById ``` Get-AzMigrateHCIServerReplication [-SubscriptionId ] -ResourceGroupID -ProjectID - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -53,28 +53,88 @@ The Get-AzMigrateHCIServerReplication cmdlet retrieves the object for the replic ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Get details by id +```powershell Get-AzMigrateHCIServerReplication -TargetObjectID '/subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/proj62434replicationvault/protectedItems/503a4f02-916c-d6b0-8d14-222bbd4767e5' ``` -### EXAMPLE 2 +```output +Id : /subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/proj62434replicationvault/protectedItems/503a4f02-916c-d6b0-8d14-222bbd4767e5 +Name : 503a4f02-916c-d6b0-8d14-222bbd4767e5 +Property : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.ProtectedItemModelProperties +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.ProtectedItemModelTags +Type : Microsoft.DataReplication/replicationVaults/protectedItems ``` + +Get by id. + +### Example 2: Get detail by discovered machine id +```powershell Get-AzMigrateHCIServerReplication -DiscoveredMachineId "/subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.OffAzure/HyperVSites/siteName1/machines/503a4f02-916c-d6b0-8d14-222bbd4767e5" ``` -### EXAMPLE 3 +```output +Id : /subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/proj62434replicationvault/protectedItems/503a4f02-916c-d6b0-8d14-222bbd4767e5 +Name : 503a4f02-916c-d6b0-8d14-222bbd4767e5 +Property : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.ProtectedItemModelProperties +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.ProtectedItemModelTags +Type : Microsoft.DataReplication/replicationVaults/protectedItems ``` + +Get by discovered machine id. + +### Example 3: List all in project by name +```powershell Get-AzMigrateServerReplication -ResourceGroupName testResourceGroup -ProjectName testProjectName ``` +```output +Id : /subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/proj62434replicationvault/protectedItems/503a4f02-916c-d6b0-8d14-222bbd4767e5 +Name : 503a4f02-916c-d6b0-8d14-222bbd4767e5 +Property : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.ProtectedItemModelProperties +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.ProtectedItemModelTags +Type : Microsoft.DataReplication/replicationVaults/protectedItems + +Id : /subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/proj62434replicationvault/protectedItems/d758f4fb-ae5e-4ac8-bb97-1e114555fe9f +Name : d758f4fb-ae5e-4ac8-bb97-1e114555fe9f +Property : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.ProtectedItemModelProperties +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.ProtectedItemModelTags +Type : Microsoft.DataReplication/replicationVaults/protectedItems +``` + +List all. + ## PARAMETERS ### -DefaultProfile The credentials, account, tenant, and subscription used for communication with Azure. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -89,7 +149,7 @@ Accept wildcard characters: False Specifies the machine ID of the discovered server. ```yaml -Type: String +Type: System.String Parameter Sets: GetBySDSID Aliases: @@ -105,7 +165,7 @@ Specifies the machine object of the replicating server. To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml -Type: IMigrateIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity Parameter Sets: GetByInputObject Aliases: @@ -120,7 +180,7 @@ Accept wildcard characters: False Specifies the display name of the replicating machine. ```yaml -Type: String +Type: System.String Parameter Sets: GetByMachineName Aliases: @@ -131,11 +191,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProjectID Specifies the Azure Migrate Project in which servers are replicating. ```yaml -Type: String +Type: System.String Parameter Sets: ListById Aliases: @@ -150,7 +225,7 @@ Accept wildcard characters: False Specifies the Azure Migrate project in the current subscription. ```yaml -Type: String +Type: System.String Parameter Sets: ListByName, GetByMachineName Aliases: @@ -165,7 +240,7 @@ Accept wildcard characters: False Specifies the Resource Group of the Azure Migrate Project in the current subscription. ```yaml -Type: String +Type: System.String Parameter Sets: ListById Aliases: @@ -180,7 +255,7 @@ Accept wildcard characters: False Specifies the Resource Group of the Azure Migrate Project in the current subscription. ```yaml -Type: String +Type: System.String Parameter Sets: ListByName, GetByMachineName Aliases: @@ -195,13 +270,13 @@ Accept wildcard characters: False Azure Subscription ID. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -210,7 +285,7 @@ Accept wildcard characters: False Specifies the replicating server ARM ID. ```yaml -Type: String +Type: System.String Parameter Sets: GetByItemID Aliases: @@ -227,64 +302,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.IProtectedItemModel + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Specifies the machine object of the replicating server. - \[AccountName \\]: Run as account ARM name. - \[AlertSettingName \\]: The name of the email notification configuration. - \[ClusterName \\]: Cluster ARM name. - \[DatabaseInstanceName \\]: Unique name of a database instance in Azure migration hub. - \[DatabaseName \\]: Unique name of a database in Azure migration hub. - \[DeploymentId \\]: Deployment Id. - \[EmailConfigurationName \\]: The email configuration name. - \[EventName \\]: Unique name of an event within a migrate project. - \[FabricAgentName \\]: The fabric agent (Dra) name. - \[FabricName \\]: Fabric name. - \[HostName \\]: Host ARM name. - \[Id \\]: Resource identity path - \[IntentObjectName \\]: Replication protection intent name. - \[JobName \\]: Job ARM name. - \[Location \\]: The name of the Azure region. - \[LogicalNetworkName \\]: Logical network name. - \[MachineName \\]: Machine ARM name. - \[MappingName \\]: Protection Container mapping name. - \[MigrateProjectName \\]: Name of the Azure Migrate project. - \[MigrationItemName \\]: Migration item name. - \[MigrationRecoveryPointName \\]: The migration recovery point name. - \[NetworkMappingName \\]: Network mapping name. - \[NetworkName \\]: Primary network name. - \[OperationId \\]: The ID of an ongoing async operation. - \[OperationStatusName \\]: Operation status ARM name. - \[PolicyName \\]: Replication policy name. - \[ProtectableItemName \\]: Protectable item name. - \[ProtectedItemName \\]: The protected item name. - \[ProtectionContainerName \\]: Protection container name. - \[ProviderName \\]: Recovery services provider name. - \[RecoveryPlanName \\]: Name of the recovery plan. - \[RecoveryPointName \\]: The recovery point name. - \[ReplicatedProtectedItemName \\]: Replication protected item name. - \[ReplicationExtensionName \\]: The replication extension name. - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ResourceName \\]: The name of the recovery services vault. - \[SiteName \\]: Site name. - \[SolutionName \\]: Unique name of a migration solution within a migrate project. - \[StorageClassificationMappingName \\]: Storage classification mapping name. - \[StorageClassificationName \\]: Storage classification name. - \[SubscriptionId \\]: The ID of the target subscription. - \[VaultName \\]: The vault name. - \[VaultSettingName \\]: Vault setting name. - \[VcenterName \\]: VCenter ARM name. - \[VirtualMachineName \\]: Virtual Machine name. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratehciserverreplication](https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratehciserverreplication) - diff --git a/src/Migrate/Migrate/help/Get-AzMigrateJob.md b/src/Migrate/Migrate/help/Get-AzMigrateJob.md index 8a3cb2ab37ba..0ed718a2a0b4 100644 --- a/src/Migrate/Migrate/help/Get-AzMigrateJob.md +++ b/src/Migrate/Migrate/help/Get-AzMigrateJob.md @@ -15,30 +15,31 @@ Retrieves the status of an Azure Migrate job. ### ListByName (Default) ``` Get-AzMigrateJob -ResourceGroupName -ProjectName [-SubscriptionId ] - [-Filter ] [-DefaultProfile ] [] + [-Filter ] [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetByName ``` Get-AzMigrateJob -ResourceGroupName -ProjectName [-SubscriptionId ] -JobName - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetById ``` -Get-AzMigrateJob [-SubscriptionId ] -JobID [-DefaultProfile ] [] +Get-AzMigrateJob [-SubscriptionId ] -JobID [-DefaultProfile ] + [-ProgressAction ] [] ``` ### GetByInputObject ``` Get-AzMigrateJob [-SubscriptionId ] -InputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ### ListById ``` Get-AzMigrateJob [-SubscriptionId ] -ResourceGroupID -ProjectID [-Filter ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -214,6 +215,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProjectID Specifies the Azure Migrate Project in which servers are replicating. @@ -300,56 +316,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Specifies the job object of the replicating server. - - `[Location ]`: Resource Location - - `[ActivityId ]`: The activity id. - - `[AllowedAction ]`: The Allowed action the job. - - `[CustomDetailAffectedObjectDetail ]`: The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details. - - `[(Any) ]`: This indicates any property can be added to this object. - - `[CustomDetailInstanceType ]`: Gets the type of job details (see JobDetailsTypes enum for possible values). - - `[EndTime ]`: The end time. - - `[Error ]`: The errors. - - `[CreationTime ]`: The creation time of job error. - - `[ErrorLevel ]`: Error level of error. - - `[ProviderErrorDetailErrorCode ]`: The Error code. - - `[ProviderErrorDetailErrorId ]`: The Provider error Id. - - `[ProviderErrorDetailErrorMessage ]`: The Error message. - - `[ProviderErrorDetailPossibleCaus ]`: The possible causes for the error. - - `[ProviderErrorDetailRecommendedAction ]`: The recommended action to resolve the error. - - `[ServiceErrorDetailActivityId ]`: Activity Id. - - `[ServiceErrorDetailCode ]`: Error code. - - `[ServiceErrorDetailMessage ]`: Error message. - - `[ServiceErrorDetailPossibleCaus ]`: Possible causes of error. - - `[ServiceErrorDetailRecommendedAction ]`: Recommended action to resolve error. - - `[TaskId ]`: The Id of the task. - - `[FriendlyName ]`: The DisplayName. - - `[ScenarioName ]`: The ScenarioName. - - `[StartTime ]`: The start time. - - `[State ]`: The status of the Job. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other. - - `[StateDescription ]`: The description of the state of the Job. For e.g. - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped. - - `[TargetInstanceType ]`: The type of the affected object which is of Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType class. - - `[TargetObjectId ]`: The affected Object Id. - - `[TargetObjectName ]`: The name of the affected object. - - `[Task ]`: The tasks. - - `[AllowedAction ]`: The state/actions applicable on this task. - - `[CustomDetailInstanceType ]`: The type of task details. - - `[EndTime ]`: The end time. - - `[Error ]`: The task error details. - - `[FriendlyName ]`: The name. - - `[GroupTaskCustomDetailChildTask ]`: The child tasks. - - `[GroupTaskCustomDetailInstanceType ]`: The type of task details. - - `[Name ]`: The unique Task name. - - `[StartTime ]`: The start time. - - `[State ]`: The State. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other. - - `[StateDescription ]`: The description of the task state. For example - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped. - - `[TaskId ]`: The Id. - - `[TaskType ]`: The type of task. Details in CustomDetails property depend on this type. - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Get-AzMigrateProject.md b/src/Migrate/Migrate/help/Get-AzMigrateProject.md index 1d71a02c2d43..700261895d89 100644 --- a/src/Migrate/Migrate/help/Get-AzMigrateProject.md +++ b/src/Migrate/Migrate/help/Get-AzMigrateProject.md @@ -14,7 +14,7 @@ Method to get a migrate project. ``` Get-AzMigrateProject -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -68,6 +68,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Name of the Azure Resource Group that migrate project is part of. @@ -109,6 +124,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Get-AzMigrateReplicationFabric.md b/src/Migrate/Migrate/help/Get-AzMigrateReplicationFabric.md index 71da94f4d4fd..7230e643d8ca 100644 --- a/src/Migrate/Migrate/help/Get-AzMigrateReplicationFabric.md +++ b/src/Migrate/Migrate/help/Get-AzMigrateReplicationFabric.md @@ -15,13 +15,14 @@ Gets the details of an Azure Site Recovery fabric. ### List (Default) ``` Get-AzMigrateReplicationFabric -ResourceGroupName -ResourceName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzMigrateReplicationFabric -ResourceGroupName -ResourceName -FabricName - [-SubscriptionId ] [-Filter ] [-DefaultProfile ] [] + [-SubscriptionId ] [-Filter ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -133,6 +134,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group where the recovery services vault is present. @@ -189,6 +205,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Get-AzMigrateReplicationPolicy.md b/src/Migrate/Migrate/help/Get-AzMigrateReplicationPolicy.md index c8a0ea653ed8..2cb8539ffc74 100644 --- a/src/Migrate/Migrate/help/Get-AzMigrateReplicationPolicy.md +++ b/src/Migrate/Migrate/help/Get-AzMigrateReplicationPolicy.md @@ -15,13 +15,14 @@ Gets the details of a replication policy. ### List (Default) ``` Get-AzMigrateReplicationPolicy -ResourceGroupName -ResourceName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzMigrateReplicationPolicy -ResourceGroupName -ResourceName -PolicyName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -91,6 +92,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group where the recovery services vault is present. @@ -147,6 +163,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Get-AzMigrateReplicationProtectionContainer.md b/src/Migrate/Migrate/help/Get-AzMigrateReplicationProtectionContainer.md index b860ed34df9d..a4f365ace32b 100644 --- a/src/Migrate/Migrate/help/Get-AzMigrateReplicationProtectionContainer.md +++ b/src/Migrate/Migrate/help/Get-AzMigrateReplicationProtectionContainer.md @@ -15,20 +15,22 @@ Gets the details of a protection container. ### List1 (Default) ``` Get-AzMigrateReplicationProtectionContainer -ResourceGroupName -ResourceName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### List ``` Get-AzMigrateReplicationProtectionContainer -ResourceGroupName -ResourceName - -FabricName [-SubscriptionId ] [-DefaultProfile ] [] + -FabricName [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ### Get ``` Get-AzMigrateReplicationProtectionContainer -ResourceGroupName -ResourceName -FabricName -ProtectionContainerName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -95,6 +97,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProtectionContainerName Protection container name. @@ -166,6 +183,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Get-AzMigrateReplicationProtectionContainerMapping.md b/src/Migrate/Migrate/help/Get-AzMigrateReplicationProtectionContainerMapping.md index e7e147ebf95c..16f6d3dbaed4 100644 --- a/src/Migrate/Migrate/help/Get-AzMigrateReplicationProtectionContainerMapping.md +++ b/src/Migrate/Migrate/help/Get-AzMigrateReplicationProtectionContainerMapping.md @@ -15,21 +15,22 @@ Gets the details of a protection container mapping. ### List1 (Default) ``` Get-AzMigrateReplicationProtectionContainerMapping -ResourceGroupName -ResourceName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### List ``` Get-AzMigrateReplicationProtectionContainerMapping -ResourceGroupName -ResourceName -FabricName -ProtectionContainerName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzMigrateReplicationProtectionContainerMapping -ResourceGroupName -ResourceName -FabricName -MappingName -ProtectionContainerName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -98,6 +99,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProtectionContainerName Protection container name. @@ -169,6 +185,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Get-AzMigrateReplicationRecoveryServicesProvider.md b/src/Migrate/Migrate/help/Get-AzMigrateReplicationRecoveryServicesProvider.md index 627491612ab9..cb2c2152a8fa 100644 --- a/src/Migrate/Migrate/help/Get-AzMigrateReplicationRecoveryServicesProvider.md +++ b/src/Migrate/Migrate/help/Get-AzMigrateReplicationRecoveryServicesProvider.md @@ -15,14 +15,15 @@ Gets the details of registered recovery services provider. ### List (Default) ``` Get-AzMigrateReplicationRecoveryServicesProvider -ResourceGroupName -ResourceName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### Get ``` Get-AzMigrateReplicationRecoveryServicesProvider -ResourceGroupName -ResourceName -FabricName -ProviderName [-SubscriptionId ] [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -76,6 +77,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProviderName Recovery services provider name. @@ -147,6 +163,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Get-AzMigrateRunAsAccount.md b/src/Migrate/Migrate/help/Get-AzMigrateRunAsAccount.md index 78c1e051db1d..3ac052024bc0 100644 --- a/src/Migrate/Migrate/help/Get-AzMigrateRunAsAccount.md +++ b/src/Migrate/Migrate/help/Get-AzMigrateRunAsAccount.md @@ -15,13 +15,14 @@ Method to get run as account. ### List (Default) ``` Get-AzMigrateRunAsAccount -ResourceGroupName -SiteName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzMigrateRunAsAccount -ResourceGroupName -SiteName -AccountName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -88,6 +89,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -145,6 +161,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Get-AzMigrateServerReplication.md b/src/Migrate/Migrate/help/Get-AzMigrateServerReplication.md index b3d610919717..ec0289086a8e 100644 --- a/src/Migrate/Migrate/help/Get-AzMigrateServerReplication.md +++ b/src/Migrate/Migrate/help/Get-AzMigrateServerReplication.md @@ -15,37 +15,39 @@ Retrieves the details of the replicating server. ### ListByName (Default) ``` Get-AzMigrateServerReplication -ResourceGroupName -ProjectName [-SubscriptionId ] - [-Filter ] [-SkipToken ] [-DefaultProfile ] [] + [-Filter ] [-SkipToken ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### GetByMachineName ``` Get-AzMigrateServerReplication -ResourceGroupName -ProjectName [-SubscriptionId ] - -MachineName [-DefaultProfile ] [] + -MachineName [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetBySRSID ``` Get-AzMigrateServerReplication [-SubscriptionId ] -TargetObjectID [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ### GetBySDSID ``` Get-AzMigrateServerReplication [-SubscriptionId ] -DiscoveredMachineId - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetByInputObject ``` Get-AzMigrateServerReplication [-SubscriptionId ] -InputObject - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### ListById ``` Get-AzMigrateServerReplication [-SubscriptionId ] -ResourceGroupID -ProjectID - [-Filter ] [-SkipToken ] [-DefaultProfile ] [] + [-Filter ] [-SkipToken ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -293,6 +295,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProjectID Specifies the Azure Migrate Project in which servers are replicating. @@ -409,16 +426,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Specifies the machine object of the replicating server. - - `[Location ]`: Resource Location - - `[ProviderSpecificDetail ]`: The migration provider custom settings. - - `InstanceType `: Gets the instance type. - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Get-AzMigrateSite.md b/src/Migrate/Migrate/help/Get-AzMigrateSite.md index 0040f9f90d58..e4bb45115212 100644 --- a/src/Migrate/Migrate/help/Get-AzMigrateSite.md +++ b/src/Migrate/Migrate/help/Get-AzMigrateSite.md @@ -14,7 +14,7 @@ Method to get a site. ``` Get-AzMigrateSite -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -68,6 +68,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -110,6 +125,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Get-AzMigrateSolution.md b/src/Migrate/Migrate/help/Get-AzMigrateSolution.md index fe2c742be846..d8a5f52ea513 100644 --- a/src/Migrate/Migrate/help/Get-AzMigrateSolution.md +++ b/src/Migrate/Migrate/help/Get-AzMigrateSolution.md @@ -14,7 +14,8 @@ Gets a solution in the migrate project. ``` Get-AzMigrateSolution -MigrateProjectName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -83,6 +84,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Name of the Azure Resource Group that migrate project is part of. @@ -124,6 +140,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Initialize-AzMigrateHCIReplicationInfrastructure.md b/src/Migrate/Migrate/help/Initialize-AzMigrateHCIReplicationInfrastructure.md index ec410e72d475..a2d34c8623f9 100644 --- a/src/Migrate/Migrate/help/Initialize-AzMigrateHCIReplicationInfrastructure.md +++ b/src/Migrate/Migrate/help/Initialize-AzMigrateHCIReplicationInfrastructure.md @@ -15,7 +15,8 @@ Initializes the infrastructure for the migrate project. ``` Initialize-AzMigrateHCIReplicationInfrastructure -ResourceGroupName -ProjectName -SourceApplianceName -TargetApplianceName [-CacheStorageAccountId ] - [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] [] + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -23,17 +24,31 @@ The Initialize-AzMigrateHCIReplicationInfrastructure cmdlet initializes the infr ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Initialize AzStackHCI replication infrastructure +```powershell Initialize-AzMigrateHCIReplicationInfrastructure -ProjectName "testproj" -ResourceGroupName "test-rg" -SourceApplianceName "testsrcapp" -TargetApplianceName "testtgtapp" -PassThru:$true ``` -### EXAMPLE 2 +```output +$true ``` + +Initialize AzStackHCI replication infrastructure. +Cache storage account, replication policy, and replication extension will be created automatically. + +### Example 2: Initialize AzStackHCI replication infrastructure with custom cache storage account +```powershell $cacheStorageAccountId = "/subscriptions/xxx-xxx-xxxx/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/testSa" -``` Initialize-AzMigrateHCIReplicationInfrastructure -ProjectName "testproj" -ResourceGroupName "test-rg" -CacheStorageAccountId $cacheStorageAccountId -SourceApplianceName "testsrcapp" -TargetApplianceName "testtgtapp" -PassThru:$true +``` + +```output +$true +``` + +Initialize AzStackHCI replication infrastructure with custom cache storage account. +Replication policy and replication extension will be created automatically. ## PARAMETERS @@ -41,7 +56,7 @@ Initialize-AzMigrateHCIReplicationInfrastructure -ProjectName "testproj" -Resour Specifies the Storage Account ARM Id to be used for private endpoint scenario. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -56,7 +71,7 @@ Accept wildcard characters: False The credentials, account, tenant, and subscription used for communication with Azure. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -71,13 +86,28 @@ Accept wildcard characters: False Returns true when the command succeeds ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -86,7 +116,7 @@ Accept wildcard characters: False Specifies the name of the Azure Migrate project to be used for server migration. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -101,7 +131,7 @@ Accept wildcard characters: False Specifies the Resource Group of the Azure Migrate Project in the current subscription. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -116,7 +146,7 @@ Accept wildcard characters: False Specifies the source appliance name for the AzStackHCI scenario. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -131,13 +161,13 @@ Accept wildcard characters: False Azure Subscription ID. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -146,7 +176,7 @@ Accept wildcard characters: False Specifies the target appliance name for the AzStackHCI scenario. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -161,7 +191,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -177,7 +207,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -196,9 +226,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Boolean + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.migrate/initialize-azmigratehcireplicationinfrastructure](https://learn.microsoft.com/powershell/module/az.migrate/initialize-azmigratehcireplicationinfrastructure) - diff --git a/src/Migrate/Migrate/help/Initialize-AzMigrateReplicationInfrastructure.md b/src/Migrate/Migrate/help/Initialize-AzMigrateReplicationInfrastructure.md index aee9505b9a89..980a17c60bdb 100644 --- a/src/Migrate/Migrate/help/Initialize-AzMigrateReplicationInfrastructure.md +++ b/src/Migrate/Migrate/help/Initialize-AzMigrateReplicationInfrastructure.md @@ -15,7 +15,7 @@ Initialises the infrastructure for the migrate project. ``` Initialize-AzMigrateReplicationInfrastructure -ResourceGroupName -ProjectName -Scenario -TargetRegion [-CacheStorageAccountId ] [-SubscriptionId ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -77,6 +77,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProjectName Specifies the name of the Azure Migrate project to be used for server migration. @@ -194,6 +209,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/New-AzMigrateDiskMapping.md b/src/Migrate/Migrate/help/New-AzMigrateDiskMapping.md index 32c7457d13e8..34f731612d3e 100644 --- a/src/Migrate/Migrate/help/New-AzMigrateDiskMapping.md +++ b/src/Migrate/Migrate/help/New-AzMigrateDiskMapping.md @@ -14,7 +14,7 @@ Creates a new disk mapping ``` New-AzMigrateDiskMapping -DiskID -IsOSDisk -DiskType [-DiskEncryptionSetID ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -97,6 +97,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -108,6 +123,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/New-AzMigrateHCIDiskMappingObject.md b/src/Migrate/Migrate/help/New-AzMigrateHCIDiskMappingObject.md index 6e204d8c8735..151a1921eb34 100644 --- a/src/Migrate/Migrate/help/New-AzMigrateHCIDiskMappingObject.md +++ b/src/Migrate/Migrate/help/New-AzMigrateHCIDiskMappingObject.md @@ -14,7 +14,7 @@ Creates a new disk mapping ``` New-AzMigrateHCIDiskMappingObject -DiskID -IsOSDisk -IsDynamic -Size - -Format [] + -Format [-ProgressAction ] [] ``` ## DESCRIPTION @@ -22,18 +22,29 @@ The New-AzMigrateHCIDiskMappingObject cmdlet creates a mapping of the source dis ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Creates Disk to migrate +```powershell New-AzMigrateHCIDiskMappingObject -DiskID a -IsOSDisk true -IsDynamic true -Size 1 -Format VHDX ``` +```output +DiskFileFormat : VHDX +DiskId : a +DiskSizeGb : 1 +IsDynamic : True +IsOSDisk : True +StorageContainerId : +``` + +Get disk object to provide input for New-AzMigrateHCIServerReplication + ## PARAMETERS ### -DiskID Specifies the disk ID of the disk attached to the discovered server to be migrated. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -48,7 +59,7 @@ Accept wildcard characters: False Specifies the disk format. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -63,7 +74,7 @@ Accept wildcard characters: False Specifies whether the disk is dynamic. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -78,7 +89,7 @@ Accept wildcard characters: False Specifies whether the disk contains the Operating System for the source server to be migrated. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -89,17 +100,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Size Specifies the disk size in GB. ```yaml -Type: Int64 +Type: System.Int64 Parameter Sets: (All) Aliases: Required: True Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -112,9 +138,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.AzStackHCIDiskInput + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratehcidiskmappingobject](https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratehcidiskmappingobject) - diff --git a/src/Migrate/Migrate/help/New-AzMigrateHCINicMappingObject.md b/src/Migrate/Migrate/help/New-AzMigrateHCINicMappingObject.md index fb1c9b9cab3c..5387a4161608 100644 --- a/src/Migrate/Migrate/help/New-AzMigrateHCINicMappingObject.md +++ b/src/Migrate/Migrate/help/New-AzMigrateHCINicMappingObject.md @@ -14,7 +14,8 @@ Creates an object to update NIC properties of a replicating server. ``` New-AzMigrateHCINicMappingObject -NicID -TargetVirtualSwitchId - [-TargetTestVirtualSwitchId ] [-CreateAtTarget ] [] + [-TargetTestVirtualSwitchId ] [-CreateAtTarget ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -23,18 +24,27 @@ This object is provided as an input to the Set-AzMigrateServerReplication cmdlet ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create NIC to migrate +```powershell New-AzMigrateHCINicMappingObject -NicID a -TargetVirtualSwitchId "/subscriptions/xxx-xxx-xxx/resourceGroups/hciclus-rg/providers/Microsoft.AzureStackHCI/logicalnetworks/external" ``` +```output +NicId : a +TargetNetworkId : /subscriptions/xxx-xxx-xxx/resourceGroups/hciclus-rg/providers/Microsoft.AzureStackHCI/logicalnetworks/external +TestNetworkId : /subscriptions/xxx-xxx-xxx/resourceGroups/hciclus-rg/providers/Microsoft.AzureStackHCI/logicalnetworks/external +SelectionTypeForFailover : SelectedByUser +``` + +Get NIC object to provide input for New-AzMigrateHCIServerReplication and Set-AzMigrateHCIServerReplication + ## PARAMETERS ### -CreateAtTarget Specifies whether the this Nic should be created at target. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -49,7 +59,7 @@ Accept wildcard characters: False Specifies the ID of the NIC to be updated. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -60,11 +70,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TargetTestVirtualSwitchId Specifies the test logical network ARM ID that the VMs will use. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -79,7 +104,7 @@ Accept wildcard characters: False Specifies the logical network ARM ID that the VMs will use. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -98,9 +123,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.AzStackHCINicInput + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratehcinicmappingobject](https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratehcinicmappingobject) - diff --git a/src/Migrate/Migrate/help/New-AzMigrateHCIServerReplication.md b/src/Migrate/Migrate/help/New-AzMigrateHCIServerReplication.md index e0eff312ffb0..7b85e2bccc86 100644 --- a/src/Migrate/Migrate/help/New-AzMigrateHCIServerReplication.md +++ b/src/Migrate/Migrate/help/New-AzMigrateHCIServerReplication.md @@ -17,8 +17,8 @@ Starts replication for the specified server. New-AzMigrateHCIServerReplication -MachineId -TargetStoragePathId -TargetResourceGroupId -TargetVMName -TargetVirtualSwitchId -OSDiskID [-TargetVMCPUCore ] [-TargetTestVirtualSwitchId ] [-IsDynamicMemoryEnabled ] - [-TargetVMRam ] [-SubscriptionId ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + [-TargetVMRam ] [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### ByIdPowerUser @@ -27,7 +27,7 @@ New-AzMigrateHCIServerReplication -MachineId -TargetStoragePathId -TargetVMName [-TargetVMCPUCore ] [-IsDynamicMemoryEnabled ] [-TargetVMRam ] [-SubscriptionId ] -DiskToInclude -NicToInclude [-DefaultProfile ] - [-WhatIf] [-Confirm] [] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -35,25 +35,91 @@ The New-AzMigrateHCIServerReplication cmdlet starts the replication for a partic ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: When there is only OS disk to migrate +```powershell New-AzMigrateHCIServerReplication -MachineId "/subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.OffAzure/HyperVSites/testsrc7972site/machines/005-005-005" -OSDiskID "Microsoft:0EC082D5-6827-457A-BAE2-F986E1B94851\83F8638B-8DCA-4152-9EDA-2CA8B33039B4\0\0\L" -TargetStoragePathId "/subscriptions/xxx-xxx-xxx/resourceGroups/hciclus-rg/providers/Microsoft.AzureStackHCI/storagecontainers/testStorageContainer1" -TargetVirtualSwitchId "/subscriptions/xxx-xxx-xxx/resourceGroups/hciclus-rg/providers/Microsoft.AzureStackHCI/logicalnetworks/external" -TargetResourceGroupId "/subscriptions//xxx-xxx-xxx/resourceGroups/target-rg"-TargetVMName "targetVM" ``` -### EXAMPLE 2 +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelCustomPropertiesAffectedObjectDetails +CustomPropertyInstanceType : WorkflowDetails +DisplayName : Create or update protected item +EndTime : 1/1/1900 8:54:47 PM +Error : {} +Id : /subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/proj62434replicationvault/jobs/f2d3430a-2977-419f-abd5-11d171e17f5e +Name : f2d3430a-2977-419f-abd5-11d171e17f5e +ObjectId : /subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/proj62434replicationvault/protectedItems/0ec082d5-6827-457a-bae2-f986e1b94555 +ObjectInternalId : a8b5ee68-102c-5aae-9499-c57a475a8fd4 +ObjectInternalName : test_vm +ObjectName : 0ec082d5-6827-457a-bae2-f986e1b94555 +ObjectType : ProtectedItem +ReplicationProviderId : xxx-xxx-xxx +SourceFabricProviderId : b35da11c-d69e-4220-9a90-d81ed93ad2fc +StartTime : 1/1/1900 8:49:27 PM +State : Succeeded +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelTags +TargetFabricProviderId : 22f00372-a1b7-467f-87ce-d95e17a6e7c7 +Task : {Creating or updating the protected item, Initializing Protection, Enabling Protection, Starting Replication} +Type : Microsoft.DataReplication/replicationVaults/jobs ``` + +This is for the scenario, when there is only one single disk that has to be protected. + +### Example 2: When there are multiple disks or NICs to migrate +```powershell [AzStackHCIDiskInput[]]$DisksToInclude = @() $OSDisk = New-AzMigrateHCIDiskMappingObject -DiskID "Microsoft:C1A34301-3BFF-4EC6-97F1-6C4BD5ADCDE0\83F8638B-8DCA-4152-9EDA-2CA8B33039B4\0\0\L" -IsOSDisk true -IsDynamic true -Size 42 -Format VHD $DataDisk = New-AzMigrateHCIDiskMappingObject -DiskID "Microsoft:C1A34301-3BFF-4EC6-97F1-6C4BD5ADCDE0\C92FAB89-DA8B-47E9-92F3-364642ECDF39\0\0\L" -IsOSDisk false -IsDynamic true -Size 5 -Format VHD $DisksToInclude += $OSDisk $DisksToInclude += $DataDisk -``` -\[AzStackHCINicInput\[\]\]$NicsToInclude = @() +[AzStackHCINicInput[]]$NicsToInclude = @() $Nic = New-AzMigrateHCINicMappingObject -NicID "Microsoft:C1A34301-3BFF-4EC6-97F1-6C4BD5ADCDE0\99CDFD2E-D60C-4218-AC2E-E7C2D8253EB9" -TargetVirtualSwitchId "/subscriptions/xxx-xxx-xxx/resourceGroups/hciclus-rg/providers/Microsoft.AzureStackHCI/logicalnetworks/external" $NicsToInclude += $Nic New-AzMigrateHCIServerReplication -MachineId "/subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.OffAzure/HyperVSites/testsrc7972site/machines/005-005-005" -TargetStoragePathId "/subscriptions/xxx-xxx-xxx/resourceGroups/hciclus-rg/providers/Microsoft.AzureStackHCI/storagecontainers/testStorageContainer1" -TargetResourceGroupId "/subscriptions//xxx-xxx-xxx/resourceGroups/target-rg"-TargetVMName "targetVM" -DiskToInclude $DisksToInclude -NicToInclude $NicsToInclude +``` + +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelCustomPropertiesAffectedObjectDetails +CustomPropertyInstanceType : WorkflowDetails +DisplayName : Create or update protected item +EndTime : 1/1/1900 2:27:14 PM +Error : {} +Id : /subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/proj62434replicationvault/jobs/f855305c-5bed-4bc6-996e-d273115ab833 +Name : f855305c-5bed-4bc6-996e-d273115ab833 +ObjectId : /subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/proj62434replicationvault/protectedItems/c1a34301-3bff-4ec6-97f1-6c4bd5adcde0 +ObjectInternalId : a40ecd8e-6413-574d-b1f8-2ef925e087fc +ObjectInternalName : test_vm +ObjectName : c1a34301-3bff-4ec6-97f1-6c4bd5adcde0 +ObjectType : ProtectedItem +ReplicationProviderId : 4de0fddc-bdfe-40d9-b60e-678bdce89630 +SourceFabricProviderId : b35da11c-d69e-4220-9a90-d81ed93ad2fc +StartTime : 1/1/1900 2:21:50 PM +State : Succeeded +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelTags +TargetFabricProviderId : 22f00372-a1b7-467f-87ce-d95e17a6e7c7 +Task : {Creating or updating the protected item, Initializing Protection, Enabling Protection, Starting Replication} +Type : Microsoft.DataReplication/replicationVaults/jobs +``` + +This is for the scenario, when there are multiple disks that has to be protected. ## PARAMETERS @@ -61,7 +127,7 @@ New-AzMigrateHCIServerReplication -MachineId "/subscriptions/xxx-xxx-xxx/resourc The credentials, account, tenant, and subscription used for communication with Azure. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -76,7 +142,7 @@ Accept wildcard characters: False Specifies the disks on the source server to be included for replication. ```yaml -Type: AzStackHCIDiskInput[] +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.AzStackHCIDiskInput[] Parameter Sets: ByIdPowerUser Aliases: @@ -91,7 +157,7 @@ Accept wildcard characters: False Specifies if RAM is dynamic or not. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -106,7 +172,7 @@ Accept wildcard characters: False Specifies the machine ARM ID of the discovered server to be migrated. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -121,7 +187,7 @@ Accept wildcard characters: False Specifies the NICs on the source server to be included for replication. ```yaml -Type: AzStackHCINicInput[] +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.AzStackHCINicInput[] Parameter Sets: ByIdPowerUser Aliases: @@ -136,7 +202,7 @@ Accept wildcard characters: False Specifies the Operating System disk for the source server to be migrated. ```yaml -Type: String +Type: System.String Parameter Sets: ByIdDefaultUser Aliases: @@ -147,17 +213,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SubscriptionId Azure Subscription ID. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -166,7 +247,7 @@ Accept wildcard characters: False Specifies the target Resource Group Id where the migrated VM resources will reside. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -181,7 +262,7 @@ Accept wildcard characters: False Specifies the storage path ARM ID where the VMs will be stored. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -196,7 +277,7 @@ Accept wildcard characters: False Specifies the test logical network ARM ID that the VMs will use. ```yaml -Type: String +Type: System.String Parameter Sets: ByIdDefaultUser Aliases: @@ -211,7 +292,7 @@ Accept wildcard characters: False Specifies the logical network ARM ID that the VMs will use. ```yaml -Type: String +Type: System.String Parameter Sets: ByIdDefaultUser Aliases: @@ -226,13 +307,13 @@ Accept wildcard characters: False Specifies the number of CPU cores. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -241,7 +322,7 @@ Accept wildcard characters: False Specifies the name of the VM to be created. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -256,13 +337,13 @@ Accept wildcard characters: False Specifies the target RAM size in MB. ```yaml -Type: Int64 +Type: System.Int64 Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -271,7 +352,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -287,7 +368,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -306,9 +387,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.IWorkflowModel + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratehciserverreplication](https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratehciserverreplication) - diff --git a/src/Migrate/Migrate/help/New-AzMigrateNicMapping.md b/src/Migrate/Migrate/help/New-AzMigrateNicMapping.md index 4472fd51194f..fc52a8ad08c3 100644 --- a/src/Migrate/Migrate/help/New-AzMigrateNicMapping.md +++ b/src/Migrate/Migrate/help/New-AzMigrateNicMapping.md @@ -15,7 +15,7 @@ Creates an object to update NIC properties of a replicating server. ``` New-AzMigrateNicMapping -NicID [-TargetNicSelectionType ] [-TargetNicSubnet ] [-TargetNicName ] [-TargetNicIP ] [-TestNicSubnet ] [-TestNicIP ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -54,6 +54,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TargetNicIP Specifies the IP within the destination subnet to be used for the NIC. @@ -155,6 +170,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/New-AzMigrateProject.md b/src/Migrate/Migrate/help/New-AzMigrateProject.md index 1acc357f46c7..ab8895d3b381 100644 --- a/src/Migrate/Migrate/help/New-AzMigrateProject.md +++ b/src/Migrate/Migrate/help/New-AzMigrateProject.md @@ -14,7 +14,8 @@ Creates a new Migrate project. ``` New-AzMigrateProject -Name -ResourceGroupName -Location [-ETag ] - [-Property ] [-SubscriptionId ] [-WhatIf] [-Confirm] [] + [-Property ] [-SubscriptionId ] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -82,6 +83,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Property Specifies the project properties. To construct, see NOTES section for PROPERTY properties and create a hash table. @@ -168,15 +184,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`PROPERTY `: Specifies the project properties. - - `[ProvisioningState ]`: Provisioning state of the migrate project. - - `[RegisteredTool ]`: Gets or sets the list of tools registered with the migrate project. - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/New-AzMigrateReplicationPolicy.md b/src/Migrate/Migrate/help/New-AzMigrateReplicationPolicy.md index cf1c518ee975..d1fecc768f62 100644 --- a/src/Migrate/Migrate/help/New-AzMigrateReplicationPolicy.md +++ b/src/Migrate/Migrate/help/New-AzMigrateReplicationPolicy.md @@ -15,7 +15,8 @@ The operation to create a replication policy. ``` New-AzMigrateReplicationPolicy -PolicyName -ResourceGroupName -ResourceName [-SubscriptionId ] [-ProviderSpecificInput ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -104,6 +105,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProviderSpecificInput The ReplicationProviderSettings. To construct, see NOTES section for PROVIDERSPECIFICINPUT properties and create a hash table. @@ -207,14 +223,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`PROVIDERSPECIFICINPUT `: The ReplicationProviderSettings. - - `InstanceType `: The class type. - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/New-AzMigrateReplicationProtectionContainerMapping.md b/src/Migrate/Migrate/help/New-AzMigrateReplicationProtectionContainerMapping.md index 9996f1ff4871..39773fc526fc 100644 --- a/src/Migrate/Migrate/help/New-AzMigrateReplicationProtectionContainerMapping.md +++ b/src/Migrate/Migrate/help/New-AzMigrateReplicationProtectionContainerMapping.md @@ -17,8 +17,8 @@ New-AzMigrateReplicationProtectionContainerMapping -FabricName -Mapping -ProtectionContainerName -ResourceGroupName -ResourceName [-SubscriptionId ] [-PolicyId ] [-ProviderSpecificInput ] - [-TargetProtectionContainerId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + [-TargetProtectionContainerId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -141,6 +141,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProtectionContainerName Protection container name. @@ -274,14 +289,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`PROVIDERSPECIFICINPUT `: Provider specific input for pairing. - - `InstanceType `: The class type. - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/New-AzMigrateServerReplication.md b/src/Migrate/Migrate/help/New-AzMigrateServerReplication.md index df98737549ab..0b4207c559f0 100644 --- a/src/Migrate/Migrate/help/New-AzMigrateServerReplication.md +++ b/src/Migrate/Migrate/help/New-AzMigrateServerReplication.md @@ -22,7 +22,7 @@ New-AzMigrateServerReplication -LicenseType -TargetResourceGroupId ] [-NicTag ] [-DiskTag ] [-Tag ] [-TargetBootDiagnosticsStorageAccount ] [-DiskEncryptionSetID ] [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### ByIdPowerUser @@ -34,7 +34,8 @@ New-AzMigrateServerReplication -LicenseType -TargetResourceGroupId ] [-NicTag ] [-DiskTag ] [-Tag ] [-TargetBootDiagnosticsStorageAccount ] [-SubscriptionId ] - -DiskToInclude [-DefaultProfile ] [] + -DiskToInclude [-DefaultProfile ] [-ProgressAction ] + [] ``` ### ByInputObjectDefaultUser @@ -47,7 +48,8 @@ New-AzMigrateServerReplication -LicenseType -TargetResourceGroupId ] [-NicTag ] [-DiskTag ] [-Tag ] [-TargetBootDiagnosticsStorageAccount ] [-DiskEncryptionSetID ] [-SubscriptionId ] - -InputObject [-DefaultProfile ] [] + -InputObject [-DefaultProfile ] [-ProgressAction ] + [] ``` ### ByInputObjectPowerUser @@ -60,7 +62,7 @@ New-AzMigrateServerReplication -LicenseType -TargetResourceGroupId ] [-Tag ] [-TargetBootDiagnosticsStorageAccount ] [-SubscriptionId ] -DiskToInclude -InputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -304,6 +306,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SqlServerLicenseType Specifies if Azure Hybrid benefit for SQL Server is applicable for the server to be migrated. @@ -541,31 +558,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`DISKTAG `: Specifies the tag to be used for disk creation. - - `[(Any) ]`: This indicates any property can be added to this object. - -`DISKTOINCLUDE `: Specifies the disks on the source server to be included for replication. - - `DiskId `: The disk Id. - - `IsOSDisk `: A value indicating whether the disk is the OS disk. - - `LogStorageAccountId `: The log storage account ARM Id. - - `LogStorageAccountSasSecretName `: The key vault secret name of the log storage account. - - `[DiskEncryptionSetId ]`: The DiskEncryptionSet ARM Id. - - `[DiskType ]`: The disk type. - -`INPUTOBJECT `: Specifies the discovered server to be migrated. The server object can be retrieved using the Get-AzMigrateServer cmdlet. - - `[GuestOSDetailOstype ]`: Type of the operating system. - -`NICTAG `: Specifies the tag to be used for NIC creation. - - `[(Any) ]`: This indicates any property can be added to this object. - -`VMTAG `: Specifies the tag to be used for VM creation. - - `[(Any) ]`: This indicates any property can be added to this object. - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/New-AzMigrateTestNicMapping.md b/src/Migrate/Migrate/help/New-AzMigrateTestNicMapping.md index c2f606a8b1c4..65f288e9b600 100644 --- a/src/Migrate/Migrate/help/New-AzMigrateTestNicMapping.md +++ b/src/Migrate/Migrate/help/New-AzMigrateTestNicMapping.md @@ -13,7 +13,8 @@ Creates an object to update NIC properties of a test migrating server. ## SYNTAX ``` -New-AzMigrateTestNicMapping -NicID -TestNicSubnet [-WhatIf] [-Confirm] [] +New-AzMigrateTestNicMapping -NicID -TestNicSubnet [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -52,6 +53,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TestNicSubnet Specifies the Subnet name for the NIC in the destination Virtual Network to which the server needs to be test migrated. @@ -109,6 +125,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Register-AzMigrateProjectTool.md b/src/Migrate/Migrate/help/Register-AzMigrateProjectTool.md index 5ab52451fc17..0c2dab6e67e4 100644 --- a/src/Migrate/Migrate/help/Register-AzMigrateProjectTool.md +++ b/src/Migrate/Migrate/help/Register-AzMigrateProjectTool.md @@ -14,8 +14,8 @@ Registers a tool with the migrate project. ``` Register-AzMigrateProjectTool -MigrateProjectName -ResourceGroupName - [-SubscriptionId ] [-AcceptLanguage ] [-Tool ] [-DefaultProfile ] [-WhatIf] - [-Confirm] [] + [-SubscriptionId ] [-AcceptLanguage ] [-Tool ] [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -83,6 +83,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Name of the Azure Resource Group that migrate project is part of. @@ -170,6 +185,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Remove-AzMigrateHCIServerReplication.md b/src/Migrate/Migrate/help/Remove-AzMigrateHCIServerReplication.md index eeb3629a4264..baf66633a8d2 100644 --- a/src/Migrate/Migrate/help/Remove-AzMigrateHCIServerReplication.md +++ b/src/Migrate/Migrate/help/Remove-AzMigrateHCIServerReplication.md @@ -15,13 +15,15 @@ Stops replication for the migrated server. ### ByID (Default) ``` Remove-AzMigrateHCIServerReplication -TargetObjectID [-SubscriptionId ] - [-ForceRemove ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-ForceRemove ] [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### ByInputObject ``` Remove-AzMigrateHCIServerReplication [-SubscriptionId ] -InputObject - [-ForceRemove ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-ForceRemove ] [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -29,19 +31,85 @@ The Remove-AzMigrateHCIServerReplication cmdlet stops the replication for a migr ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Remove replication by Id +```powershell Remove-AzMigrateHCIServerReplication -TargetObjectID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/protectedItems/0ec082d5-6827-457a-bae2-f986e1b94851" ``` -### EXAMPLE 2 +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {Cancel} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelCustomPropertiesAffectedObjectDetails +CustomPropertyInstanceType : WorkflowDetails +DisplayName : Delete protected item +EndTime : +Error : {} +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/jobs/2b0b356e-d106-43af-ad26-02631fcaebba +Name : 2b0b356e-d106-43af-ad26-02631fcaebba +ObjectId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/protectedItems/c1a34301-3bff-4ec6-97f1-6c4bd5adcde0 +ObjectInternalId : a40ecd8e-6413-574d-b1f8-2ef925e087fc +ObjectInternalName : testmachine +ObjectName : c1a34301-3bff-4ec6-97f1-6c4bd5adcde0 +ObjectType : ProtectedItem +ReplicationProviderId : 4de0fddc-bdfe-40d9-b60e-678bdce89630 +SourceFabricProviderId : b35da11c-d69e-4220-9a90-d81ed93ad2fc +StartTime : 7/25/2023 10:14:42 PM +State : Started +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelTags +TargetFabricProviderId : 22f00372-a1b7-467f-87ce-d95e17a6e7c7 +Task : {Prerequisite check, Deleting protected item} +Type : Microsoft.DataReplication/replicationVaults/jobs ``` + +Remove AzStackHCI replication by Id. + +### Example 2: Remove replication by input object +```powershell $InputObject = Get-AzMigrateHCIServerReplication -TargetObjectID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/protectedItems/0ec082d5-6827-457a-bae2-f986e1b94851" -``` Remove-AzMigrateHCIServerReplication -InputObject $InputObject $InputObject | Remove-AzMigrateHCIServerReplication +``` + +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {Cancel} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelCustomPropertiesAffectedObjectDetails +CustomPropertyInstanceType : WorkflowDetails +DisplayName : Delete protected item +EndTime : +Error : {} +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/jobs/2b0b356e-d106-43af-ad26-02631fcaebba +Name : 2b0b356e-d106-43af-ad26-02631fcaebba +ObjectId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/protectedItems/c1a34301-3bff-4ec6-97f1-6c4bd5adcde0 +ObjectInternalId : a40ecd8e-6413-574d-b1f8-2ef925e087fc +ObjectInternalName : testmachine +ObjectName : c1a34301-3bff-4ec6-97f1-6c4bd5adcde0 +ObjectType : ProtectedItem +ReplicationProviderId : 4de0fddc-bdfe-40d9-b60e-678bdce89630 +SourceFabricProviderId : b35da11c-d69e-4220-9a90-d81ed93ad2fc +StartTime : 7/25/2023 10:14:42 PM +State : Started +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelTags +TargetFabricProviderId : 22f00372-a1b7-467f-87ce-d95e17a6e7c7 +Task : {Prerequisite check, Deleting protected item} +Type : Microsoft.DataReplication/replicationVaults/jobs +``` + +Remove AzStackHCI replication by replication input object. ## PARAMETERS @@ -49,7 +117,7 @@ $InputObject | Remove-AzMigrateHCIServerReplication The credentials, account, tenant, and subscription used for communication with Azure. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -65,7 +133,7 @@ Specifies whether the replication needs to be force removed. Default to "false". ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -82,7 +150,7 @@ The server object can be retrieved using the Get-AzMigrateHCIServerReplication c To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml -Type: IMigrateIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity Parameter Sets: ByInputObject Aliases: @@ -93,17 +161,32 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SubscriptionId Azure Subscription ID. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -113,7 +196,7 @@ Specifies the replcating server for which the replication needs to be disabled. The ID should be retrieved using the Get-AzMigrateHCIServerReplication cmdlet. ```yaml -Type: String +Type: System.String Parameter Sets: ByID Aliases: @@ -128,7 +211,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -144,7 +227,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -161,65 +244,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.IWorkflowModel -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. -INPUTOBJECT \: Specifies the replcating server for which the replication needs to be disabled. -The server object can be retrieved using the Get-AzMigrateHCIServerReplication cmdlet. - \[AccountName \\]: Run as account ARM name. - \[AlertSettingName \\]: The name of the email notification configuration. - \[ClusterName \\]: Cluster ARM name. - \[DatabaseInstanceName \\]: Unique name of a database instance in Azure migration hub. - \[DatabaseName \\]: Unique name of a database in Azure migration hub. - \[DeploymentId \\]: Deployment Id. - \[EmailConfigurationName \\]: The email configuration name. - \[EventName \\]: Unique name of an event within a migrate project. - \[FabricAgentName \\]: The fabric agent (Dra) name. - \[FabricName \\]: Fabric name. - \[HostName \\]: Host ARM name. - \[Id \\]: Resource identity path - \[IntentObjectName \\]: Replication protection intent name. - \[JobName \\]: Job ARM name. - \[Location \\]: The name of the Azure region. - \[LogicalNetworkName \\]: Logical network name. - \[MachineName \\]: Machine ARM name. - \[MappingName \\]: Protection Container mapping name. - \[MigrateProjectName \\]: Name of the Azure Migrate project. - \[MigrationItemName \\]: Migration item name. - \[MigrationRecoveryPointName \\]: The migration recovery point name. - \[NetworkMappingName \\]: Network mapping name. - \[NetworkName \\]: Primary network name. - \[OperationId \\]: The ID of an ongoing async operation. - \[OperationStatusName \\]: Operation status ARM name. - \[PolicyName \\]: Replication policy name. - \[ProtectableItemName \\]: Protectable item name. - \[ProtectedItemName \\]: The protected item name. - \[ProtectionContainerName \\]: Protection container name. - \[ProviderName \\]: Recovery services provider name. - \[RecoveryPlanName \\]: Name of the recovery plan. - \[RecoveryPointName \\]: The recovery point name. - \[ReplicatedProtectedItemName \\]: Replication protected item name. - \[ReplicationExtensionName \\]: The replication extension name. - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ResourceName \\]: The name of the recovery services vault. - \[SiteName \\]: Site name. - \[SolutionName \\]: Unique name of a migration solution within a migrate project. - \[StorageClassificationMappingName \\]: Storage classification mapping name. - \[StorageClassificationName \\]: Storage classification name. - \[SubscriptionId \\]: The ID of the target subscription. - \[VaultName \\]: The vault name. - \[VaultSettingName \\]: Vault setting name. - \[VcenterName \\]: VCenter ARM name. - \[VirtualMachineName \\]: Virtual Machine name. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.migrate/remove-azmigratehciserverreplication](https://learn.microsoft.com/powershell/module/az.migrate/remove-azmigratehciserverreplication) - diff --git a/src/Migrate/Migrate/help/Remove-AzMigrateProject.md b/src/Migrate/Migrate/help/Remove-AzMigrateProject.md index e298f0747716..2c143b6a2ec9 100644 --- a/src/Migrate/Migrate/help/Remove-AzMigrateProject.md +++ b/src/Migrate/Migrate/help/Remove-AzMigrateProject.md @@ -15,7 +15,8 @@ Deleting non-existent project is a no-operation. ``` Remove-AzMigrateProject -Name -ResourceGroupName [-SubscriptionId ] - [-AcceptLanguage ] [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] [] + [-AcceptLanguage ] [-DefaultProfile ] [-PassThru] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -96,6 +97,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Name of the Azure Resource Group that migrate project is part of. @@ -168,6 +184,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Remove-AzMigrateServerReplication.md b/src/Migrate/Migrate/help/Remove-AzMigrateServerReplication.md index 2d845d341f60..97c19af34556 100644 --- a/src/Migrate/Migrate/help/Remove-AzMigrateServerReplication.md +++ b/src/Migrate/Migrate/help/Remove-AzMigrateServerReplication.md @@ -15,13 +15,13 @@ Stops replication for the migrated server. ### ByIDVMwareCbt (Default) ``` Remove-AzMigrateServerReplication -TargetObjectID [-SubscriptionId ] [-ForceRemove ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### ByInputObjectVMwareCbt ``` Remove-AzMigrateServerReplication [-SubscriptionId ] -InputObject - [-ForceRemove ] [-DefaultProfile ] [] + [-ForceRemove ] [-DefaultProfile ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -123,7 +123,8 @@ Accept wildcard characters: False ``` ### -InputObject -Specifies the machine object of the replicating server. +Specifies the replcating server for which the replication needs to be disabled. +The server object should be retrieved using the Get-AzMigrateServerReplication cmdlet. To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml @@ -138,6 +139,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SubscriptionId Azure Subscription ID. @@ -154,7 +170,7 @@ Accept wildcard characters: False ``` ### -TargetObjectID -Specifies the replcating server for which the replicatio needs to be disabled. +Specifies the replcating server for which the replication needs to be disabled. The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. ```yaml @@ -180,16 +196,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Specifies the machine object of the replicating server. - - `[Location ]`: Resource Location - - `[ProviderSpecificDetail ]`: The migration provider custom settings. - - `InstanceType `: Gets the instance type. - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Restart-AzMigrateServerReplication.md b/src/Migrate/Migrate/help/Restart-AzMigrateServerReplication.md index 13b41885a992..5884a7d3a453 100644 --- a/src/Migrate/Migrate/help/Restart-AzMigrateServerReplication.md +++ b/src/Migrate/Migrate/help/Restart-AzMigrateServerReplication.md @@ -15,13 +15,13 @@ Restarts the replication for specified server. ### ByIDVMwareCbt (Default) ``` Restart-AzMigrateServerReplication -TargetObjectID [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### ByInputObjectVMwareCbt ``` Restart-AzMigrateServerReplication [-SubscriptionId ] -InputObject - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -123,6 +123,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SubscriptionId Azure Subscription ID. @@ -165,16 +180,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Specifies the machine object of the replicating server. - - `[Location ]`: Resource Location - - `[ProviderSpecificDetail ]`: The migration provider custom settings. - - `InstanceType `: Gets the instance type. - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Resume-AzMigrateServerReplication.md b/src/Migrate/Migrate/help/Resume-AzMigrateServerReplication.md index b8f72fa86514..be957faadf0e 100644 --- a/src/Migrate/Migrate/help/Resume-AzMigrateServerReplication.md +++ b/src/Migrate/Migrate/help/Resume-AzMigrateServerReplication.md @@ -15,13 +15,14 @@ Starts the replication that has been suspended. ### ByIDVMwareCbt (Default) ``` Resume-AzMigrateServerReplication -TargetObjectID [-DeleteMigratedResource] [-SubscriptionId ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### ByInputObjectVMwareCbt ``` Resume-AzMigrateServerReplication [-DeleteMigratedResource] [-SubscriptionId ] - -InputObject [-DefaultProfile ] [-WhatIf] [-Confirm] [] + -InputObject [-DefaultProfile ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -139,6 +140,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SubscriptionId Azure Subscription ID. @@ -212,16 +228,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Specifies the replicating server for which the resume replication needs to be initiated. The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet - - `[Location ]`: Resource Location - - `[ProviderSpecificDetail ]`: The migration provider custom settings. - - `InstanceType `: Gets the instance type. - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Set-AzMigrateDiskMapping.md b/src/Migrate/Migrate/help/Set-AzMigrateDiskMapping.md index 0e7161b43d3a..780d47e1a73b 100644 --- a/src/Migrate/Migrate/help/Set-AzMigrateDiskMapping.md +++ b/src/Migrate/Migrate/help/Set-AzMigrateDiskMapping.md @@ -13,7 +13,8 @@ Updates disk mapping ## SYNTAX ``` -Set-AzMigrateDiskMapping -DiskID [-DiskName ] [-IsOSDisk ] [] +Set-AzMigrateDiskMapping -DiskID [-DiskName ] [-IsOSDisk ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -81,6 +82,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -92,6 +108,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Set-AzMigrateHCIServerReplication.md b/src/Migrate/Migrate/help/Set-AzMigrateHCIServerReplication.md index 22b96d1b3d8c..96be18ca22e7 100644 --- a/src/Migrate/Migrate/help/Set-AzMigrateHCIServerReplication.md +++ b/src/Migrate/Migrate/help/Set-AzMigrateHCIServerReplication.md @@ -16,7 +16,7 @@ Updates the target properties for the replicating server. Set-AzMigrateHCIServerReplication -TargetObjectID [-TargetVMName ] [-TargetVMCPUCore ] [-IsDynamicMemoryEnabled ] [-DynamicMemoryConfig ] [-TargetVMRam ] [-NicToInclude ] [-SubscriptionId ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -24,21 +24,87 @@ The Set-AzMigrateHCIServerReplication cmdlet updates the target properties for t ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Update target VM name +```powershell Set-AzMigrateHCIServerReplication -TargetObjectID '/subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/proj62434replicationvault/protectedItems/503a4f02-916c-d6b0-8d14-222bbd4767e5' -TargetVMName "targetName1" ``` -### EXAMPLE 2 +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelCustomPropertiesAffectedObjectDetails +CustomPropertyInstanceType : WorkflowDetails +DisplayName : Create or update protected item +EndTime : 1/1/1900 8:54:47 PM +Error : {} +Id : /subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/proj62434replicationvault/jobs/f2d3430a-2977-419f-abd5-11d171e17f5e +Name : f2d3430a-2977-419f-abd5-11d171e17f5e +ObjectId : /subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/proj62434replicationvault/protectedItems/0ec082d5-6827-457a-bae2-f986e1b94555 +ObjectInternalId : a8b5ee68-102c-5aae-9499-c57a475a8fd4 +ObjectInternalName : test_vm +ObjectName : 0ec082d5-6827-457a-bae2-f986e1b94555 +ObjectType : ProtectedItem +ReplicationProviderId : xxx-xxx-xxx +SourceFabricProviderId : b35da11c-d69e-4220-9a90-d81ed93ad2fc +StartTime : 1/1/1900 8:49:27 PM +State : Succeeded +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelTags +TargetFabricProviderId : 22f00372-a1b7-467f-87ce-d95e17a6e7c7 +Task : {Creating or updating the protected item, Initializing Protection, Enabling Protection, Starting Replication} +Type : Microsoft.DataReplication/replicationVaults/jobs ``` + +Update target VM name + +### Example 2: Update dynamic memory configuration +```powershell $memoryConfig = [PSCustomObject]@{ MinimumMemoryInMegaByte = 1024 MaximumMemoryInMegaByte = 34816 TargetMemoryBufferPercentage = 20 } -``` Set-AzMigrateHCIServerReplication -TargetObjectID '/subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/proj62434replicationvault/protectedItems/503a4f02-916c-d6b0-8d14-222bbd4767e5' -DynamicMemoryConfig $memoryConfig +``` + +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelCustomPropertiesAffectedObjectDetails +CustomPropertyInstanceType : WorkflowDetails +DisplayName : Create or update protected item +EndTime : 1/1/1900 8:54:47 PM +Error : {} +Id : /subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/proj62434replicationvault/jobs/f2d3430a-2977-419f-abd5-11d171e17f5e +Name : f2d3430a-2977-419f-abd5-11d171e17f5e +ObjectId : /subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/proj62434replicationvault/protectedItems/0ec082d5-6827-457a-bae2-f986e1b94555 +ObjectInternalId : a8b5ee68-102c-5aae-9499-c57a475a8fd4 +ObjectInternalName : test_vm +ObjectName : 0ec082d5-6827-457a-bae2-f986e1b94555 +ObjectType : ProtectedItem +ReplicationProviderId : xxx-xxx-xxx +SourceFabricProviderId : b35da11c-d69e-4220-9a90-d81ed93ad2fc +StartTime : 1/1/1900 8:49:27 PM +State : Succeeded +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.WorkflowModelTags +TargetFabricProviderId : 22f00372-a1b7-467f-87ce-d95e17a6e7c7 +Task : {Creating or updating the protected item, Initializing Protection, Enabling Protection, Starting Replication} +Type : Microsoft.DataReplication/replicationVaults/jobs +``` + +Update dynamic memory configuration. ## PARAMETERS @@ -46,7 +112,7 @@ Set-AzMigrateHCIServerReplication -TargetObjectID '/subscriptions/xxx-xxx-xxx/r The credentials, account, tenant, and subscription used for communication with Azure. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -62,7 +128,7 @@ Specifies the dynamic memory configration of RAM. To construct, see NOTES section for DYNAMICMEMORYCONFIG properties and create a hash table. ```yaml -Type: ProtectedItemDynamicMemoryConfig +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.ProtectedItemDynamicMemoryConfig Parameter Sets: (All) Aliases: @@ -77,7 +143,7 @@ Accept wildcard characters: False Specifies if RAM is dynamic or not. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -92,7 +158,7 @@ Accept wildcard characters: False Specifies the nics on the source server to be included for replication. ```yaml -Type: AzStackHCINicInput[] +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.AzStackHCINicInput[] Parameter Sets: (All) Aliases: @@ -103,17 +169,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SubscriptionId The subscription Id. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -123,7 +204,7 @@ Specifies the replicating server for which the properties need to be updated. The ID should be retrieved using the Get-AzMigrateHCIServerReplication cmdlet. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -138,13 +219,13 @@ Accept wildcard characters: False Specifies the number of CPU cores. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -153,7 +234,7 @@ Accept wildcard characters: False Specifies the target VM name. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -168,13 +249,13 @@ Accept wildcard characters: False Specifies the target RAM size in MB. ```yaml -Type: Int64 +Type: System.Int64 Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -183,7 +264,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -199,7 +280,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -218,18 +299,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.IWorkflowModel -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. -DYNAMICMEMORYCONFIG \: Specifies the dynamic memory configration of RAM. - MaximumMemoryInMegaByte \: Gets or sets maximum memory in MB. - MinimumMemoryInMegaByte \: Gets or sets minimum memory in MB. - TargetMemoryBufferPercentage \: Gets or sets target memory buffer in %. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.migrate/set-azmigratehciserverreplication](https://learn.microsoft.com/powershell/module/az.migrate/set-azmigratehciserverreplication) - diff --git a/src/Migrate/Migrate/help/Set-AzMigrateServerReplication.md b/src/Migrate/Migrate/help/Set-AzMigrateServerReplication.md index 8a5f8ab95b65..145892a4ec2e 100644 --- a/src/Migrate/Migrate/help/Set-AzMigrateServerReplication.md +++ b/src/Migrate/Migrate/help/Set-AzMigrateServerReplication.md @@ -23,7 +23,7 @@ Set-AzMigrateServerReplication -TargetObjectID [-TargetVMName ] [-UpdateVMTagOperation ] [-UpdateNicTag ] [-UpdateNicTagOperation ] [-UpdateDiskTag ] [-UpdateDiskTagOperation ] [-TargetBootDiagnosticsStorageAccount ] [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### ByInputObjectVMwareCbt @@ -37,7 +37,7 @@ Set-AzMigrateServerReplication [-TargetVMName ] [-TargetDiskName ] [-UpdateNicTagOperation ] [-UpdateDiskTag ] [-UpdateDiskTagOperation ] [-TargetBootDiagnosticsStorageAccount ] [-SubscriptionId ] -InputObject - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -176,6 +176,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SqlServerLicenseType Specifies if Azure Hybrid benefit for SQL Server is applicable for the server to be migrated. @@ -492,40 +507,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`DISKTOUPDATE `: Updates the disk for the Azure VM to be created. - - `DiskId `: The disk Id. - - `[IsOSDisk ]`: A value indicating whether the disk is the OS disk. - - `[TargetDiskName ]`: The target disk name. - -`INPUTOBJECT `: Specifies the replicating server for which the properties need to be updated. The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet. - - `[Location ]`: Resource Location - - `[ProviderSpecificDetail ]`: The migration provider custom settings. - - `InstanceType `: Gets the instance type. - -`NICTOUPDATE `: Updates the NIC for the Azure VM to be created. - - `IsPrimaryNic `: A value indicating whether this is the primary NIC. - - `NicId `: The NIC Id. - - `[IsSelectedForMigration ]`: A value indicating whether this NIC is selected for migration. - - `[TargetNicName ]`: Target NIC name. - - `[TargetStaticIPAddress ]`: The static IP address. - - `[TargetSubnetName ]`: Target subnet name. - - `[TestStaticIPAddress ]`: The test static IP address. - - `[TestSubnetName ]`: The test subnet name. - -`UPDATEDISKTAG `: Specifies the tag to be used for disk creation. - - `[(Any) ]`: This indicates any property can be added to this object. - -`UPDATENICTAG `: Specifies the tag to be used for NIC creation. - - `[(Any) ]`: This indicates any property can be added to this object. - -`UPDATEVMTAG `: Specifies the tag to be used for VM creation. - - `[(Any) ]`: This indicates any property can be added to this object. - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Start-AzMigrateHCIServerMigration.md b/src/Migrate/Migrate/help/Start-AzMigrateHCIServerMigration.md index e3ebafa52462..e4191d1c8b13 100644 --- a/src/Migrate/Migrate/help/Start-AzMigrateHCIServerMigration.md +++ b/src/Migrate/Migrate/help/Start-AzMigrateHCIServerMigration.md @@ -15,13 +15,14 @@ Starts the migration for the replicating server. ### ByID (Default) ``` Start-AzMigrateHCIServerMigration -TargetObjectID [-TurnOffSourceServer] [-SubscriptionId ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### ByInputObject ``` Start-AzMigrateHCIServerMigration [-TurnOffSourceServer] [-SubscriptionId ] - -InputObject [-DefaultProfile ] [-WhatIf] [-Confirm] [] + -InputObject [-DefaultProfile ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -29,19 +30,99 @@ Starts the migration for the replicating server. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Start migration by Id +```powershell Start-AzMigrateHCIServerMigration -TargetObjectID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/protectedItems/0ec082d5-6827-457a-bae2-f986e1b94851" ``` -### EXAMPLE 2 +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {Cancel} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api2021 + 0216Preview.WorkflowModelCustomPropertiesAffectedObjectDe + tails +CustomPropertyInstanceType : FailoverWorkflowDetails +DisplayName : Planned failover +EndTime : +Error : {} +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication + /replicationVaults/testproj1234replicationvault/jobs/af0e1bf6-e3e6-482c-8345-b1a06d87af96 +Name : af0e1bf6-e3e6-482c-8345-b1a06d87af96 +ObjectId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication + /replicationVaults/testproj1234replicationvault/protectedItems/0ec082d5-6827-457a-bae2-f986e1b94851/plannedFai + lover +ObjectInternalId : a8b5ee68-102c-5aae-9499-c57a475a8fc4 +ObjectInternalName : testmachine +ObjectName : 0ec082d5-6827-457a-bae2-f986e1b94851 +ObjectType : ProtectedItem +ReplicationProviderId : 4de0fddc-bdfe-40d9-b60e-678bdce89630 +SourceFabricProviderId : b35da11c-d69e-4220-9a90-d81ed93ad2fc +StartTime : 8/1/2023 12:42:19 AM +State : Started +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api2021 + 0216Preview.WorkflowModelTags +TargetFabricProviderId : 22f00372-a1b7-467f-87ce-d95e17a6e7c7 +Task : {Prerequisite check, Turning off resource on primary, + Starting failover, Preparing protected entities...} +Type : Microsoft.DataReplication/replicationVaults/jobs ``` + +Start AzStackHCI server migration by Id. + +### Example 2: Start migration by input object +```powershell $InputObject = Get-AzMigrateHCIServerReplication -TargetObjectID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/protectedItems/0ec082d5-6827-457a-bae2-f986e1b94851" -``` Start-AzMigrateHCIServerMigration -InputObject $InputObject $InputObject | Start-AzMigrateHCIServerMigration +``` + +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {Cancel} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api2021 + 0216Preview.WorkflowModelCustomPropertiesAffectedObjectDe + tails +CustomPropertyInstanceType : FailoverWorkflowDetails +DisplayName : Planned failover +EndTime : +Error : {} +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication + /replicationVaults/testproj1234replicationvault/jobs/af0e1bf6-e3e6-482c-8345-b1a06d87af96 +Name : af0e1bf6-e3e6-482c-8345-b1a06d87af96 +ObjectId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication + /replicationVaults/testproj1234replicationvault/protectedItems/0ec082d5-6827-457a-bae2-f986e1b94851/plannedFai + lover +ObjectInternalId : a8b5ee68-102c-5aae-9499-c57a475a8fc4 +ObjectInternalName : testmachine +ObjectName : 0ec082d5-6827-457a-bae2-f986e1b94851 +ObjectType : ProtectedItem +ReplicationProviderId : 4de0fddc-bdfe-40d9-b60e-678bdce89630 +SourceFabricProviderId : b35da11c-d69e-4220-9a90-d81ed93ad2fc +StartTime : 8/1/2023 12:42:19 AM +State : Started +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Tag : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api2021 + 0216Preview.WorkflowModelTags +TargetFabricProviderId : 22f00372-a1b7-467f-87ce-d95e17a6e7c7 +Task : {Prerequisite check, Turning off resource on primary, + Starting failover, Preparing protected entities...} +Type : Microsoft.DataReplication/replicationVaults/jobs +``` + +Start AzStackHCI server migration by replication input object. ## PARAMETERS @@ -49,7 +130,7 @@ $InputObject | Start-AzMigrateHCIServerMigration The credentials, account, tenant, and subscription used for communication with Azure. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -66,7 +147,7 @@ The server object can be retrieved using the Get-AzMigrateHCIServerReplication c To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml -Type: IMigrateIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity Parameter Sets: ByInputObject Aliases: @@ -77,17 +158,32 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SubscriptionId Azure Subscription ID. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -97,7 +193,7 @@ Specifies the replcating server for which migration needs to be initiated. The ID should be retrieved using the Get-AzMigrateHCIServerReplication cmdlet. ```yaml -Type: String +Type: System.String Parameter Sets: ByID Aliases: @@ -112,13 +208,13 @@ Accept wildcard characters: False Specifies whether the source server should be turned off post migration. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -127,7 +223,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -143,7 +239,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -160,65 +256,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210216Preview.IWorkflowModel -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Specifies the replicating server for which migration needs to be initiated. -The server object can be retrieved using the Get-AzMigrateHCIServerReplication cmdlet. - \[AccountName \\]: Run as account ARM name. - \[AlertSettingName \\]: The name of the email notification configuration. - \[ClusterName \\]: Cluster ARM name. - \[DatabaseInstanceName \\]: Unique name of a database instance in Azure migration hub. - \[DatabaseName \\]: Unique name of a database in Azure migration hub. - \[DeploymentId \\]: Deployment Id. - \[EmailConfigurationName \\]: The email configuration name. - \[EventName \\]: Unique name of an event within a migrate project. - \[FabricAgentName \\]: The fabric agent (Dra) name. - \[FabricName \\]: Fabric name. - \[HostName \\]: Host ARM name. - \[Id \\]: Resource identity path - \[IntentObjectName \\]: Replication protection intent name. - \[JobName \\]: Job ARM name. - \[Location \\]: The name of the Azure region. - \[LogicalNetworkName \\]: Logical network name. - \[MachineName \\]: Machine ARM name. - \[MappingName \\]: Protection Container mapping name. - \[MigrateProjectName \\]: Name of the Azure Migrate project. - \[MigrationItemName \\]: Migration item name. - \[MigrationRecoveryPointName \\]: The migration recovery point name. - \[NetworkMappingName \\]: Network mapping name. - \[NetworkName \\]: Primary network name. - \[OperationId \\]: The ID of an ongoing async operation. - \[OperationStatusName \\]: Operation status ARM name. - \[PolicyName \\]: Replication policy name. - \[ProtectableItemName \\]: Protectable item name. - \[ProtectedItemName \\]: The protected item name. - \[ProtectionContainerName \\]: Protection container name. - \[ProviderName \\]: Recovery services provider name. - \[RecoveryPlanName \\]: Name of the recovery plan. - \[RecoveryPointName \\]: The recovery point name. - \[ReplicatedProtectedItemName \\]: Replication protected item name. - \[ReplicationExtensionName \\]: The replication extension name. - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ResourceName \\]: The name of the recovery services vault. - \[SiteName \\]: Site name. - \[SolutionName \\]: Unique name of a migration solution within a migrate project. - \[StorageClassificationMappingName \\]: Storage classification mapping name. - \[StorageClassificationName \\]: Storage classification name. - \[SubscriptionId \\]: The ID of the target subscription. - \[VaultName \\]: The vault name. - \[VaultSettingName \\]: Vault setting name. - \[VcenterName \\]: VCenter ARM name. - \[VirtualMachineName \\]: Virtual Machine name. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.migrate/start-azmigratehciservermigration](https://learn.microsoft.com/powershell/module/az.migrate/start-azmigratehciservermigration) - diff --git a/src/Migrate/Migrate/help/Start-AzMigrateServerMigration.md b/src/Migrate/Migrate/help/Start-AzMigrateServerMigration.md index e89c67c11c21..874e5a49d7c2 100644 --- a/src/Migrate/Migrate/help/Start-AzMigrateServerMigration.md +++ b/src/Migrate/Migrate/help/Start-AzMigrateServerMigration.md @@ -15,13 +15,15 @@ Starts the migration for the replicating server. ### ByIDVMwareCbt (Default) ``` Start-AzMigrateServerMigration -TargetObjectID [-OsUpgradeVersion ] [-TurnOffSourceServer] - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### ByInputObjectVMwareCbt ``` Start-AzMigrateServerMigration [-OsUpgradeVersion ] [-TurnOffSourceServer] [-SubscriptionId ] - -InputObject [-DefaultProfile ] [] + -InputObject [-DefaultProfile ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -109,6 +111,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SubscriptionId Azure Subscription ID. @@ -166,16 +183,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Specifies the replicating server for which migration needs to be initiated. The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet. - - `[Location ]`: Resource Location - - `[ProviderSpecificDetail ]`: The migration provider custom settings. - - `InstanceType `: Gets the instance type. - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Start-AzMigrateTestMigration.md b/src/Migrate/Migrate/help/Start-AzMigrateTestMigration.md index 4d5b1a5b40e4..50d362f28af4 100644 --- a/src/Migrate/Migrate/help/Start-AzMigrateTestMigration.md +++ b/src/Migrate/Migrate/help/Start-AzMigrateTestMigration.md @@ -16,14 +16,14 @@ Starts the test migration for the replicating server. ``` Start-AzMigrateTestMigration -TestNetworkID -TargetObjectID [-OsUpgradeVersion ] [-NicToUpdate ] [-SubscriptionId ] [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ### ByInputObjectVMwareCbt ``` Start-AzMigrateTestMigration -TestNetworkID [-OsUpgradeVersion ] [-NicToUpdate ] [-SubscriptionId ] -InputObject - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -158,6 +158,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SubscriptionId Azure Subscription ID. @@ -215,26 +230,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Specifies the replicating server for which the test migration needs to be initiated. The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet. - - `[Location ]`: Resource Location - - `[ProviderSpecificDetail ]`: The migration provider custom settings. - - `InstanceType `: Gets the instance type. - -`NICTOUPDATE `: Updates the NIC for the Azure VM to be created. - - `IsPrimaryNic `: A value indicating whether this is the primary NIC. - - `NicId `: The NIC Id. - - `[IsSelectedForMigration ]`: A value indicating whether this NIC is selected for migration. - - `[TargetNicName ]`: Target NIC name. - - `[TargetStaticIPAddress ]`: The static IP address. - - `[TargetSubnetName ]`: Target subnet name. - - `[TestStaticIPAddress ]`: The test static IP address. - - `[TestSubnetName ]`: The test subnet name. - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Start-AzMigrateTestMigrationCleanup.md b/src/Migrate/Migrate/help/Start-AzMigrateTestMigrationCleanup.md index e1397727080d..f36c6b230e39 100644 --- a/src/Migrate/Migrate/help/Start-AzMigrateTestMigrationCleanup.md +++ b/src/Migrate/Migrate/help/Start-AzMigrateTestMigrationCleanup.md @@ -15,13 +15,13 @@ Cleans up the test migration for the replicating server. ### ByIDVMwareCbt (Default) ``` Start-AzMigrateTestMigrationCleanup -TargetObjectID [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### ByInputObjectVMwareCbt ``` Start-AzMigrateTestMigrationCleanup [-SubscriptionId ] -InputObject - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -126,6 +126,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SubscriptionId Azure Subscription ID. @@ -168,16 +183,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Specifies the replicating server for which the test migration cleanup needs to be initiated. The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet - - `[Location ]`: Resource Location - - `[ProviderSpecificDetail ]`: The migration provider custom settings. - - `InstanceType `: Gets the instance type. - ## RELATED LINKS diff --git a/src/Migrate/Migrate/help/Suspend-AzMigrateServerReplication.md b/src/Migrate/Migrate/help/Suspend-AzMigrateServerReplication.md index d8585097c8d0..0d624368ee74 100644 --- a/src/Migrate/Migrate/help/Suspend-AzMigrateServerReplication.md +++ b/src/Migrate/Migrate/help/Suspend-AzMigrateServerReplication.md @@ -15,13 +15,13 @@ Suspends the ongoing replication. ### ByIDVMwareCbt (Default) ``` Suspend-AzMigrateServerReplication -TargetObjectID [-SubscriptionId ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### ByInputObjectVMwareCbt ``` Suspend-AzMigrateServerReplication [-SubscriptionId ] -InputObject - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -124,6 +124,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SubscriptionId Azure Subscription ID. @@ -197,16 +212,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`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 - - `[Location ]`: Resource Location - - `[ProviderSpecificDetail ]`: The migration provider custom settings. - - `InstanceType `: Gets the instance type. - ## RELATED LINKS