From f80f7a8262a635ebc18a3fbcc7ce0f8b2fafbbd3 Mon Sep 17 00:00:00 2001 From: Anh Dinh Date: Fri, 27 Mar 2026 13:16:22 -0700 Subject: [PATCH 1/3] WIP, initial testing on new API version for Az.Migrate 2026-02-01 --- .../Properties/AssemblyInfo.cs | 1 + src/Migrate/Migrate.Autorest/README.md | 2 +- .../replicationFabrics.json | 2 +- .../custom/Az.Migrate.custom.psm1 | 4 +- .../custom/AzLocalDiskInput.cs | 2 +- .../custom/AzLocalNicInput.cs | 2 +- .../custom/Get-AzMigrateLocalJob.ps1 | 2 +- .../Get-AzMigrateLocalServerReplication.ps1 | 2 +- ...zMigrateLocalReplicationInfrastructure.ps1 | 12 +- .../New-AzMigrateLocalDiskMappingObject.ps1 | 4 +- .../New-AzMigrateLocalNicMappingObject.ps1 | 4 +- .../New-AzMigrateLocalServerReplication.ps1 | 38 +- src/Migrate/Migrate.Autorest/custom/README.md | 8 +- ...Remove-AzMigrateLocalServerReplication.ps1 | 2 +- .../Set-AzMigrateLocalServerReplication.ps1 | 19 +- .../Start-AzMigrateLocalServerMigration.ps1 | 8 +- .../Migrate.Autorest/docs/Az.Migrate.md | 140 ---- .../docs/Get-AzMigrateDiscoveredServer.md | 335 --------- .../Migrate.Autorest/docs/Get-AzMigrateJob.md | 304 --------- .../docs/Get-AzMigrateLocalJob.md | 456 ------------- .../Get-AzMigrateLocalReplicationFabric.md | 267 -------- .../Get-AzMigrateLocalServerReplication.md | 296 -------- .../docs/Get-AzMigrateProject.md | 113 --- .../docs/Get-AzMigrateReplicationFabric.md | 193 ------ .../docs/Get-AzMigrateReplicationPolicy.md | 151 ---- ...AzMigrateReplicationProtectionContainer.md | 170 ----- ...teReplicationProtectionContainerMapping.md | 173 ----- ...rateReplicationRecoveryServicesProvider.md | 151 ---- .../docs/Get-AzMigrateRunAsAccount.md | 149 ---- .../Get-AzMigrateServerMigrationStatus.md | 335 --------- .../docs/Get-AzMigrateServerReplication.md | 413 ----------- .../docs/Get-AzMigrateSite.md | 115 ---- .../docs/Get-AzMigrateSolution.md | 128 ---- ...AzMigrateLocalReplicationInfrastructure.md | 217 ------ ...lize-AzMigrateReplicationInfrastructure.md | 198 ------ .../docs/New-AzMigrateDiskMapping.md | 125 ---- .../New-AzMigrateLocalDiskMappingObject.md | 146 ---- .../New-AzMigrateLocalNicMappingObject.md | 114 ---- .../New-AzMigrateLocalServerReplication.md | 405 ----------- .../docs/New-AzMigrateNicMapping.md | 159 ----- .../docs/New-AzMigrateProject.md | 173 ----- .../docs/New-AzMigrateReplicationPolicy.md | 212 ------ ...teReplicationProtectionContainerMapping.md | 278 -------- .../docs/New-AzMigrateServerReplication.md | 642 ------------------ .../docs/New-AzMigrateTestNicMapping.md | 113 --- src/Migrate/Migrate.Autorest/docs/README.md | 4 +- .../docs/Register-AzMigrateProjectTool.md | 174 ----- .../Remove-AzMigrateLocalServerReplication.md | 234 ------- .../docs/Remove-AzMigrateProject.md | 172 ----- .../docs/Remove-AzMigrateServerReplication.md | 186 ----- .../Restart-AzMigrateServerReplication.md | 169 ----- .../docs/Resume-AzMigrateServerReplication.md | 216 ------ .../docs/Set-AzMigrateDiskMapping.md | 96 --- .../Set-AzMigrateLocalServerReplication.md | 251 ------- .../docs/Set-AzMigrateServerReplication.md | 528 -------------- .../Start-AzMigrateLocalServerMigration.md | 241 ------- .../docs/Start-AzMigrateServerMigration.md | 187 ----- .../docs/Start-AzMigrateTestMigration.md | 221 ------ .../Start-AzMigrateTestMigrationCleanup.md | 174 ----- .../Suspend-AzMigrateServerReplication.md | 201 ------ .../Migrate.Autorest/generate-info.json | 2 +- .../Migrate.Autorest/resources/README.md | 2 +- src/Migrate/Migrate.Autorest/test/README.md | 2 +- src/Migrate/Migrate.sln | 28 +- src/Migrate/Migrate/Az.Migrate.psd1 | 2 +- .../Migrate/help/Get-AzMigrateLocalJob.md | 2 +- .../Get-AzMigrateLocalReplicationFabric.md | 2 +- .../Get-AzMigrateLocalServerReplication.md | 2 +- .../New-AzMigrateLocalDiskMappingObject.md | 2 +- .../New-AzMigrateLocalNicMappingObject.md | 2 +- .../New-AzMigrateLocalServerReplication.md | 6 +- .../Remove-AzMigrateLocalServerReplication.md | 2 +- .../Set-AzMigrateLocalServerReplication.md | 6 +- .../Start-AzMigrateLocalServerMigration.md | 2 +- 74 files changed, 98 insertions(+), 9801 deletions(-) delete mode 100644 src/Migrate/Migrate.Autorest/docs/Az.Migrate.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateDiscoveredServer.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateJob.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalJob.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalReplicationFabric.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalServerReplication.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateProject.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationFabric.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationPolicy.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationProtectionContainer.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationProtectionContainerMapping.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationRecoveryServicesProvider.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateRunAsAccount.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateServerMigrationStatus.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateServerReplication.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateSite.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateSolution.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Initialize-AzMigrateLocalReplicationInfrastructure.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Initialize-AzMigrateReplicationInfrastructure.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/New-AzMigrateDiskMapping.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalDiskMappingObject.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalNicMappingObject.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalServerReplication.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/New-AzMigrateNicMapping.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/New-AzMigrateProject.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/New-AzMigrateReplicationPolicy.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/New-AzMigrateReplicationProtectionContainerMapping.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/New-AzMigrateServerReplication.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/New-AzMigrateTestNicMapping.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Register-AzMigrateProjectTool.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateLocalServerReplication.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateProject.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateServerReplication.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Restart-AzMigrateServerReplication.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Resume-AzMigrateServerReplication.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Set-AzMigrateDiskMapping.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Set-AzMigrateLocalServerReplication.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Set-AzMigrateServerReplication.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Start-AzMigrateLocalServerMigration.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Start-AzMigrateServerMigration.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Start-AzMigrateTestMigration.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Start-AzMigrateTestMigrationCleanup.md delete mode 100644 src/Migrate/Migrate.Autorest/docs/Suspend-AzMigrateServerReplication.md diff --git a/src/Migrate/Migrate.Autorest/Properties/AssemblyInfo.cs b/src/Migrate/Migrate.Autorest/Properties/AssemblyInfo.cs index 51c64c08eb86..22180c19ae94 100644 --- a/src/Migrate/Migrate.Autorest/Properties/AssemblyInfo.cs +++ b/src/Migrate/Migrate.Autorest/Properties/AssemblyInfo.cs @@ -24,3 +24,4 @@ [assembly: System.Reflection.AssemblyVersionAttribute("2.11.0")] [assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)] [assembly: System.CLSCompliantAttribute(false)] + diff --git a/src/Migrate/Migrate.Autorest/README.md b/src/Migrate/Migrate.Autorest/README.md index a8a3acee77e2..71dc8d3c6557 100644 --- a/src/Migrate/Migrate.Autorest/README.md +++ b/src/Migrate/Migrate.Autorest/README.md @@ -52,7 +52,7 @@ input-file: - $(repo)/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2020-01-01/migrate.json - $(repo)/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/migrate.json - $(repo)/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/SiteRecovery/stable/2025-08-01/service.json - - $(repo)/specification/recoveryservicesdatareplication/resource-manager/Microsoft.DataReplication/DataReplication/stable/2024-09-01/recoveryservicesdatareplication.json + - /azure-rest-api-specs-pr/specification/recoveryservicesdatareplication/resource-manager/Microsoft.DataReplication/DataReplication/stable/2026-02-01/recoveryservicesdatareplication.json module-version: 3.0.14 title: Migrate diff --git a/src/Migrate/Migrate.Autorest/UX/Microsoft.DataReplication/replicationFabrics.json b/src/Migrate/Migrate.Autorest/UX/Microsoft.DataReplication/replicationFabrics.json index 9a71642b5afb..df445feb825d 100644 --- a/src/Migrate/Migrate.Autorest/UX/Microsoft.DataReplication/replicationFabrics.json +++ b/src/Migrate/Migrate.Autorest/UX/Microsoft.DataReplication/replicationFabrics.json @@ -1,6 +1,6 @@ { "resourceType": "replicationFabrics", - "apiVersion": "2024-09-01", + "apiVersion": "2026-02-01", "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.migrate" }, diff --git a/src/Migrate/Migrate.Autorest/custom/Az.Migrate.custom.psm1 b/src/Migrate/Migrate.Autorest/custom/Az.Migrate.custom.psm1 index 414362f01faf..a8fc67b1e913 100644 --- a/src/Migrate/Migrate.Autorest/custom/Az.Migrate.custom.psm1 +++ b/src/Migrate/Migrate.Autorest/custom/Az.Migrate.custom.psm1 @@ -1,9 +1,9 @@ # region Generated # Load the private module dll - $null = Import-Module -PassThru -Name (Join-Path $PSScriptRoot '..\bin\Az.Migrate.private.dll') + $null = Import-Module -PassThru -Name (Join-Path $PSScriptRoot '../bin/Az.Migrate.private.dll') # Load the internal module - $internalModulePath = Join-Path $PSScriptRoot '..\internal\Az.Migrate.internal.psm1' + $internalModulePath = Join-Path $PSScriptRoot '../internal/Az.Migrate.internal.psm1' if(Test-Path $internalModulePath) { $null = Import-Module -Name $internalModulePath } diff --git a/src/Migrate/Migrate.Autorest/custom/AzLocalDiskInput.cs b/src/Migrate/Migrate.Autorest/custom/AzLocalDiskInput.cs index aa4f9e8185df..8d8b93ab2da7 100644 --- a/src/Migrate/Migrate.Autorest/custom/AzLocalDiskInput.cs +++ b/src/Migrate/Migrate.Autorest/custom/AzLocalDiskInput.cs @@ -2,7 +2,7 @@ // Licensed under the MIT License. See License.txt in the project root for license information. using System; -namespace Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901 +namespace Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201 { public class AzLocalDiskInput { diff --git a/src/Migrate/Migrate.Autorest/custom/AzLocalNicInput.cs b/src/Migrate/Migrate.Autorest/custom/AzLocalNicInput.cs index da4d43771c2a..d96a4055df56 100644 --- a/src/Migrate/Migrate.Autorest/custom/AzLocalNicInput.cs +++ b/src/Migrate/Migrate.Autorest/custom/AzLocalNicInput.cs @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. See License.txt in the project root for license information. -namespace Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901 +namespace Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201 { public class AzLocalNicInput { diff --git a/src/Migrate/Migrate.Autorest/custom/Get-AzMigrateLocalJob.ps1 b/src/Migrate/Migrate.Autorest/custom/Get-AzMigrateLocalJob.ps1 index cf03f407c79c..e345b40128a6 100644 --- a/src/Migrate/Migrate.Autorest/custom/Get-AzMigrateLocalJob.ps1 +++ b/src/Migrate/Migrate.Autorest/custom/Get-AzMigrateLocalJob.ps1 @@ -28,7 +28,7 @@ function Get-AzMigrateLocalJob { * See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *`n ***************************************************************************************************")] [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Runtime.PreviewMessageAttribute("This cmdlet is based on a preview API version and may experience breaking changes in future releases.")] - [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.IJobModel])] + [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.IJobModel])] [CmdletBinding(DefaultParameterSetName = 'ListByName', PositionalBinding = $false)] param( [Parameter(ParameterSetName = 'GetById', Mandatory)] diff --git a/src/Migrate/Migrate.Autorest/custom/Get-AzMigrateLocalServerReplication.ps1 b/src/Migrate/Migrate.Autorest/custom/Get-AzMigrateLocalServerReplication.ps1 index aa6a0610056e..6e4b59768cfa 100644 --- a/src/Migrate/Migrate.Autorest/custom/Get-AzMigrateLocalServerReplication.ps1 +++ b/src/Migrate/Migrate.Autorest/custom/Get-AzMigrateLocalServerReplication.ps1 @@ -28,7 +28,7 @@ function Get-AzMigrateLocalServerReplication { * See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *`n ***************************************************************************************************")] [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Runtime.PreviewMessageAttribute("This cmdlet is based on a preview API version and may experience breaking changes in future releases.")] - [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.IProtectedItemModel])] + [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.IProtectedItemModel])] [CmdletBinding(DefaultParameterSetName = 'ListByName', PositionalBinding = $false)] param( [Parameter(ParameterSetName = 'GetByItemID', Mandatory)] diff --git a/src/Migrate/Migrate.Autorest/custom/Initialize-AzMigrateLocalReplicationInfrastructure.ps1 b/src/Migrate/Migrate.Autorest/custom/Initialize-AzMigrateLocalReplicationInfrastructure.ps1 index 9eedb0cde11b..ac49b4076396 100644 --- a/src/Migrate/Migrate.Autorest/custom/Initialize-AzMigrateLocalReplicationInfrastructure.ps1 +++ b/src/Migrate/Migrate.Autorest/custom/Initialize-AzMigrateLocalReplicationInfrastructure.ps1 @@ -469,12 +469,12 @@ function Initialize-AzMigrateLocalReplicationInfrastructure { } # Setup Policy deployment parameters - $policyProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.PolicyModelProperties]::new() + $policyProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.PolicyModelProperties]::new() if ($instanceType -eq $AzLocalInstanceTypes.HyperVToAzLocal) { - $policyCustomProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.HyperVToAzStackHcipolicyModelCustomProperties]::new() + $policyCustomProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.HyperVToAzStackHcipolicyModelCustomProperties]::new() } elseif ($instanceType -eq $AzLocalInstanceTypes.VMwareToAzLocal) { - $policyCustomProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.VMwareToAzStackHcipolicyModelCustomProperties]::new() + $policyCustomProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.VMwareToAzStackHcipolicyModelCustomProperties]::new() } else { throw "Instance type '$($instanceType)' is not supported. Currently, for AzLocal scenario, only HyperV and VMware as the source is supported." @@ -1133,15 +1133,15 @@ function Initialize-AzMigrateLocalReplicationInfrastructure { } # Setup Replication Extension deployment parameters - $replicationExtensionProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.ReplicationExtensionModelProperties]::new() + $replicationExtensionProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.ReplicationExtensionModelProperties]::new() if ($instanceType -eq $AzLocalInstanceTypes.HyperVToAzLocal) { - $replicationExtensionCustomProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.HyperVToAzStackHcireplicationExtensionModelCustomProperties]::new() + $replicationExtensionCustomProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.HyperVToAzStackHcireplicationExtensionModelCustomProperties]::new() $replicationExtensionCustomProperties.HyperVFabricArmId = $params.SourceFabricArmId } elseif ($instanceType -eq $AzLocalInstanceTypes.VMwareToAzLocal) { - $replicationExtensionCustomProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.VMwareToAzStackHcireplicationExtensionModelCustomProperties]::new() + $replicationExtensionCustomProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.VMwareToAzStackHcireplicationExtensionModelCustomProperties]::new() $replicationExtensionCustomProperties.VMwareFabricArmId = $params.SourceFabricArmId } else { diff --git a/src/Migrate/Migrate.Autorest/custom/New-AzMigrateLocalDiskMappingObject.ps1 b/src/Migrate/Migrate.Autorest/custom/New-AzMigrateLocalDiskMappingObject.ps1 index 85b13f624613..cde9b42aa985 100644 --- a/src/Migrate/Migrate.Autorest/custom/New-AzMigrateLocalDiskMappingObject.ps1 +++ b/src/Migrate/Migrate.Autorest/custom/New-AzMigrateLocalDiskMappingObject.ps1 @@ -23,7 +23,7 @@ https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratelocaldiskm #> function New-AzMigrateLocalDiskMappingObject { [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Runtime.PreviewMessageAttribute("This cmdlet is based on a preview API version and may experience breaking changes in future releases.")] - [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.AzLocalDiskInput])] + [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.AzLocalDiskInput])] [CmdletBinding(PositionalBinding = $false)] param( [Parameter(Mandatory)] @@ -80,7 +80,7 @@ function New-AzMigrateLocalDiskMappingObject { throw "PhysicalSectorSize must be 512 for VHD format but $PhysicalSectorSize is given." } - $DiskObject = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.AzLocalDiskInput]::new( + $DiskObject = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.AzLocalDiskInput]::new( $DiskID, $isDynamicDisk, $Size, diff --git a/src/Migrate/Migrate.Autorest/custom/New-AzMigrateLocalNicMappingObject.ps1 b/src/Migrate/Migrate.Autorest/custom/New-AzMigrateLocalNicMappingObject.ps1 index edb0f505e1d6..ac21e713dbc3 100644 --- a/src/Migrate/Migrate.Autorest/custom/New-AzMigrateLocalNicMappingObject.ps1 +++ b/src/Migrate/Migrate.Autorest/custom/New-AzMigrateLocalNicMappingObject.ps1 @@ -23,7 +23,7 @@ https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratelocalnicma #> function New-AzMigrateLocalNicMappingObject { [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Runtime.PreviewMessageAttribute("This cmdlet is based on a preview API version and may experience breaking changes in future releases.")] - [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.AzLocalNicInput])] + [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.AzLocalNicInput])] [CmdletBinding(PositionalBinding = $false)] param( [Parameter(Mandatory)] @@ -70,7 +70,7 @@ function New-AzMigrateLocalNicMappingObject { $selectionTypeForFailover = $VMNicSelection.NotSelected } - $NicObject = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.AzLocalNicInput]::new( + $NicObject = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.AzLocalNicInput]::new( $NicID, $TargetVirtualSwitchId, $TargetTestVirtualSwitchId, diff --git a/src/Migrate/Migrate.Autorest/custom/New-AzMigrateLocalServerReplication.ps1 b/src/Migrate/Migrate.Autorest/custom/New-AzMigrateLocalServerReplication.ps1 index 1269524c6a1b..c85b9486eae2 100644 --- a/src/Migrate/Migrate.Autorest/custom/New-AzMigrateLocalServerReplication.ps1 +++ b/src/Migrate/Migrate.Autorest/custom/New-AzMigrateLocalServerReplication.ps1 @@ -23,7 +23,7 @@ https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratelocalserve #> function New-AzMigrateLocalServerReplication { [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Runtime.PreviewMessageAttribute("This cmdlet is based on a preview API version and may experience breaking changes in future releases.")] - [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.IJobModel])] + [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.IJobModel])] [CmdletBinding(DefaultParameterSetName = 'ByIdDefaultUser', PositionalBinding = $false, SupportsShouldProcess, ConfirmImpact = 'Medium')] param( [Parameter(ParameterSetName = 'ByIdDefaultUser', Mandatory)] @@ -65,6 +65,14 @@ function New-AzMigrateLocalServerReplication { # Specifies if RAM is dynamic or not. ${IsDynamicMemoryEnabled}, + [Parameter()] + [ValidateSet("true" , "false")] + [ArgumentCompleter( { "true" , "false" })] + [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Category('Path')] + [System.String] + # Specifies whether the VM should be migrated as an Arc VM. + ${MigrateAsArcVM}, + [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Category('Path')] [System.Int64] @@ -73,13 +81,13 @@ function New-AzMigrateLocalServerReplication { [Parameter(ParameterSetName = 'ByIdPowerUser', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Category('Path')] - [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.AzLocalDiskInput[]] + [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.AzLocalDiskInput[]] # Specifies the disks on the source server to be included for replication. ${DiskToInclude}, [Parameter(ParameterSetName = 'ByIdPowerUser', Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Category('Path')] - [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.AzLocalNicInput[]] + [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.AzLocalNicInput[]] # Specifies the NICs on the source server to be included for replication. ${NicToInclude}, @@ -185,6 +193,10 @@ function New-AzMigrateLocalServerReplication { if ($HasIsDynamicMemoryEnabled) { $isDynamicRamEnabled = [System.Convert]::ToBoolean($IsDynamicMemoryEnabled) } + $HasMigrateAsArcVM = $PSBoundParameters.ContainsKey('MigrateAsArcVM') + if ($HasMigrateAsArcVM) { + $migrateAsArcVMEnabled = [System.Convert]::ToBoolean($MigrateAsArcVM) + } $HasTargetVMRam = $PSBoundParameters.ContainsKey('TargetVMRam') $HasTargetVirtualSwitchId = $PSBoundParameters.ContainsKey('TargetVirtualSwitchId') $HasTargetTestVirtualSwitchId = $PSBoundParameters.ContainsKey('TargetTestVirtualSwitchId') @@ -198,6 +210,7 @@ function New-AzMigrateLocalServerReplication { $null = $PSBoundParameters.Remove('TargetVirtualSwitchId') $null = $PSBoundParameters.Remove('TargetTestVirtualSwitchId') $null = $PSBoundParameters.Remove('IsDynamicMemoryEnabled') + $null = $PSBoundParameters.Remove('MigrateAsArcVM') $null = $PSBoundParameters.Remove('TargetVMRam') $null = $PSBoundParameters.Remove('DiskToInclude') $null = $PSBoundParameters.Remove('NicToInclude') @@ -633,16 +646,16 @@ function New-AzMigrateLocalServerReplication { } # Construct create protected item request object - $protectedItemProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.ProtectedItemModelProperties]::new() + $protectedItemProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.ProtectedItemModelProperties]::new() $protectedItemProperties.PolicyName = $policyName $protectedItemProperties.ReplicationExtensionName = $replicationExtensionName if ($SiteType -eq $SiteTypes.HyperVSites) { - $customProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.HyperVToAzStackHCIProtectedItemModelCustomProperties]::new() + $customProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.HyperVToAzStackHciprotectedItemModelCustomProperties]::new() $isSourceDynamicMemoryEnabled = $machine.IsDynamicMemoryEnabled } elseif ($SiteType -eq $SiteTypes.VMwareSites) { - $customProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.VMwareToAzStackHCIProtectedItemModelCustomProperties]::new() + $customProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.VMwareToAzStackHciprotectedItemModelCustomProperties]::new() $isSourceDynamicMemoryEnabled = $false } @@ -658,6 +671,9 @@ function New-AzMigrateLocalServerReplication { $customProperties.TargetResourceGroupId = $TargetResourceGroupId $customProperties.TargetVMName = $TargetVMName $customProperties.IsDynamicRam = if ($HasIsDynamicMemoryEnabled) { $isDynamicRamEnabled } else { $isSourceDynamicMemoryEnabled } + if ($HasMigrateAsArcVM) { + $customProperties.MigrateAsArcVM = $migrateAsArcVMEnabled + } # Determine target VM Hyper-V Generation if ($SiteType -eq $SiteTypes.HyperVSites) { @@ -710,7 +726,7 @@ function New-AzMigrateLocalServerReplication { } # Construct default dynamic memory config - $memoryConfig = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.ProtectedItemDynamicMemoryConfig]::new() + $memoryConfig = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.ProtectedItemDynamicMemoryConfig]::new() $memoryConfig.MinimumMemoryInMegaByte = [System.Math]::Min($customProperties.TargetMemoryInMegaByte, $RAMConfig.DefaultMinDynamicMemoryInMB) $memoryConfig.MaximumMemoryInMegaByte = [System.Math]::Max($customProperties.TargetMemoryInMegaByte, $RAMConfig.DefaultMaxDynamicMemoryInMB) $memoryConfig.TargetMemoryBufferPercentage = $RAMConfig.DefaultTargetMemoryBufferPercentage @@ -835,12 +851,12 @@ function New-AzMigrateLocalServerReplication { } if ($SiteType -eq $SiteTypes.HyperVSites) { - $customProperties.DisksToInclude = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.HyperVToAzStackHCIDiskInput[]]$disks - $customProperties.NicsToInclude = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.HyperVToAzStackHCINicInput[]]$nics + $customProperties.DisksToInclude = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.HyperVToAzStackHcidiskInput[]]$disks + $customProperties.NicsToInclude = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.HyperVToAzStackHcinicInput[]]$nics } elseif ($SiteType -eq $SiteTypes.VMwareSites) { - $customProperties.DisksToInclude = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.VMwareToAzStackHCIDiskInput[]]$disks - $customProperties.NicsToInclude = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.VMwareToAzStackHCINicInput[]]$nics + $customProperties.DisksToInclude = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.VMwareToAzStackHcidiskInput[]]$disks + $customProperties.NicsToInclude = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.VMwareToAzStackHcinicInput[]]$nics } $protectedItemProperties.CustomProperty = $customProperties diff --git a/src/Migrate/Migrate.Autorest/custom/README.md b/src/Migrate/Migrate.Autorest/custom/README.md index 67ca1cd0e5cd..a268d35afb1d 100644 --- a/src/Migrate/Migrate.Autorest/custom/README.md +++ b/src/Migrate/Migrate.Autorest/custom/README.md @@ -1,5 +1,5 @@ # Custom -This directory contains custom implementation for non-generated cmdlets for the `Az.Migrate` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `..\exports` folder. The only generated file into this folder is the `Az.Migrate.custom.psm1`. This file should not be modified. +This directory contains custom implementation for non-generated cmdlets for the `Az.Migrate` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `../exports` folder. The only generated file into this folder is the `Az.Migrate.custom.psm1`. This file should not be modified. ## Info - Modifiable: yes @@ -15,10 +15,10 @@ For C# cmdlets, they are compiled with the rest of the generated low-level cmdle For script cmdlets, these are loaded via the `Az.Migrate.custom.psm1`. Then, during the build process, this module is loaded and processed in the same manner as the C# cmdlets. The fundamental difference is the script cmdlets use the `ParameterSetName` attribute and C# cmdlets do not. To create a script cmdlet variant of a generated cmdlet, simply decorate all parameters in the script with the new `ParameterSetName` in the `Parameter` attribute. This will appropriately treat each parameter set as a separate variant when processed to be exported during the build. ## Purpose -This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `..\exports` folder. +This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `../exports` folder. ## Usage -The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `..\exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters: +The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `../exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters: - Break - DefaultProfile - HttpPipelineAppend @@ -36,6 +36,6 @@ For processing the cmdlets, we've created some additional attributes: - `Microsoft.Azure.PowerShell.Cmdlets.Migrate.DoNotExportAttribute` - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.Migrate`. - `Microsoft.Azure.PowerShell.Cmdlets.Migrate.InternalExportAttribute` - - Used in C# cmdlets to route exported cmdlets to the `..\internal`, which are *not exposed* by `Az.Migrate`. For more information, see [README.md](..\internal/README.md) in the `..\internal` folder. + - Used in C# cmdlets to route exported cmdlets to the `../internal`, which are *not exposed* by `Az.Migrate`. For more information, see [README.md](../internal/README.md) in the `../internal` folder. - `Microsoft.Azure.PowerShell.Cmdlets.Migrate.ProfileAttribute` - Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules. \ No newline at end of file diff --git a/src/Migrate/Migrate.Autorest/custom/Remove-AzMigrateLocalServerReplication.ps1 b/src/Migrate/Migrate.Autorest/custom/Remove-AzMigrateLocalServerReplication.ps1 index 02e5bbf95d7d..323a047e3763 100644 --- a/src/Migrate/Migrate.Autorest/custom/Remove-AzMigrateLocalServerReplication.ps1 +++ b/src/Migrate/Migrate.Autorest/custom/Remove-AzMigrateLocalServerReplication.ps1 @@ -23,7 +23,7 @@ https://learn.microsoft.com/powershell/module/az.migrate/remove-azmigratelocalse #> function Remove-AzMigrateLocalServerReplication { [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Runtime.PreviewMessageAttribute("This cmdlet is based on a preview API version and may experience breaking changes in future releases.")] - [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.IJobModel])] + [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.IJobModel])] [CmdletBinding(DefaultParameterSetName = 'ByID', PositionalBinding = $false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName = 'ByID', Mandatory)] diff --git a/src/Migrate/Migrate.Autorest/custom/Set-AzMigrateLocalServerReplication.ps1 b/src/Migrate/Migrate.Autorest/custom/Set-AzMigrateLocalServerReplication.ps1 index 92143aaa9b7f..7d8c337e0f48 100644 --- a/src/Migrate/Migrate.Autorest/custom/Set-AzMigrateLocalServerReplication.ps1 +++ b/src/Migrate/Migrate.Autorest/custom/Set-AzMigrateLocalServerReplication.ps1 @@ -23,7 +23,7 @@ https://learn.microsoft.com/powershell/module/az.migrate/set-azmigratelocalserve #> function Set-AzMigrateLocalServerReplication { [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Runtime.PreviewMessageAttribute("This cmdlet is based on a preview API version and may experience breaking changes in future releases.")] - [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.IJobModel])] + [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.IJobModel])] [CmdletBinding(DefaultParameterSetName = 'ById', PositionalBinding = $false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(Mandatory)] @@ -48,7 +48,7 @@ function Set-AzMigrateLocalServerReplication { [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Category('Path')] - [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.ProtectedItemDynamicMemoryConfig] + [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.ProtectedItemDynamicMemoryConfig] # Specifies the dynamic memory configuration of RAM. ${DynamicMemoryConfig}, @@ -60,7 +60,7 @@ function Set-AzMigrateLocalServerReplication { [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Category('Path')] - [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.AzLocalNicInput[]] + [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.AzLocalNicInput[]] # Specifies the nics on the source server to be included for replication. ${NicToInclude}, @@ -201,11 +201,11 @@ function Set-AzMigrateLocalServerReplication { } if ($SiteType -eq $SiteTypes.HyperVSites) { - $customPropertiesUpdate = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.HyperVToAzStackHCIProtectedItemModelCustomPropertiesUpdate]::new() + $customPropertiesUpdate = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.HyperVToAzStackHciprotectedItemModelCustomPropertiesUpdate]::new() $customPropertiesUpdate.InstanceType = $AzLocalInstanceTypes.HyperVToAzLocal } elseif ($SiteType -eq $SiteTypes.VMwareSites) { - $customPropertiesUpdate = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.VMwareToAzStackHCIProtectedItemModelCustomPropertiesUpdate]::new() + $customPropertiesUpdate = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.VMwareToAzStackHciprotectedItemModelCustomPropertiesUpdate]::new() $customPropertiesUpdate.InstanceType = $AzLocalInstanceTypes.VMwareToAzLocal } @@ -248,6 +248,7 @@ function Set-AzMigrateLocalServerReplication { $customPropertiesUpdate.IsDynamicRam = $customProperties.IsDynamicRam } + # Dynamic memory is enabled - set provided configuration if ($customPropertiesUpdate.IsDynamicRam -and $HasDynamicMemoryConfig) { if ($targetMemory -lt $DynamicMemoryConfig.MinimumMemoryInMegaByte) { @@ -269,7 +270,7 @@ function Set-AzMigrateLocalServerReplication { # Dynamic memory is enabled - set default configuration if ($customPropertiesUpdate.IsDynamicRam -and !$HasDynamicMemoryConfig) { if ($null -eq $customProperties.DynamicMemoryConfig) { - $memoryConfig = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.ProtectedItemDynamicMemoryConfig]::new() + $memoryConfig = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.ProtectedItemDynamicMemoryConfig]::new() $memoryConfig.MinimumMemoryInMegaByte = [System.Math]::Min($targetMemory, $RAMConfig.DefaultMinDynamicMemoryInMB) $memoryConfig.MaximumMemoryInMegaByte = [System.Math]::Max($targetMemory, $RAMConfig.DefaultMaxDynamicMemoryInMB) $memoryConfig.TargetMemoryBufferPercentage = $RAMConfig.DefaultTargetMemoryBufferPercentage @@ -329,10 +330,10 @@ function Set-AzMigrateLocalServerReplication { } if ($SiteType -eq $SiteTypes.HyperVSites) { - $customPropertiesUpdate.NicsToInclude = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.HyperVToAzStackHCINicInput[]]$nics + $customPropertiesUpdate.NicsToInclude = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.HyperVToAzStackHcinicInput[]]$nics } elseif ($SiteType -eq $SiteTypes.VMwareSites) { - $customPropertiesUpdate.NicsToInclude = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.VMwareToAzStackHCINicInput[]]$nics + $customPropertiesUpdate.NicsToInclude = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.VMwareToAzStackHcinicInput[]]$nics } } @@ -341,7 +342,7 @@ function Set-AzMigrateLocalServerReplication { $customPropertiesUpdate.OsType = $OsType } - $protectedItemPropertiesUpdate = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.ProtectedItemModelPropertiesUpdate]::new() + $protectedItemPropertiesUpdate = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.ProtectedItemModelPropertiesUpdate]::new() $protectedItemPropertiesUpdate.CustomProperty = $customPropertiesUpdate # Remove common ErrorVariable and ErrorAction for get behaviors diff --git a/src/Migrate/Migrate.Autorest/custom/Start-AzMigrateLocalServerMigration.ps1 b/src/Migrate/Migrate.Autorest/custom/Start-AzMigrateLocalServerMigration.ps1 index 89af2cc83c03..72c61b1b58bd 100644 --- a/src/Migrate/Migrate.Autorest/custom/Start-AzMigrateLocalServerMigration.ps1 +++ b/src/Migrate/Migrate.Autorest/custom/Start-AzMigrateLocalServerMigration.ps1 @@ -23,7 +23,7 @@ https://learn.microsoft.com/powershell/module/az.migrate/start-azmigratelocalser #> function Start-AzMigrateLocalServerMigration { [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Runtime.PreviewMessageAttribute("This cmdlet is based on a preview API version and may experience breaking changes in future releases.")] - [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.IJobModel])] + [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.IJobModel])] [CmdletBinding(DefaultParameterSetName = 'ByID', PositionalBinding = $false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName = 'ByID', Mandatory)] @@ -153,13 +153,13 @@ function Start-AzMigrateLocalServerMigration { $instanceType = $protectedItem.Property.CustomProperty.InstanceType # Setup PlannedFailover deployment parameters - $properties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.PlannedFailoverModelProperties]::new() + $properties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.PlannedFailoverModelProperties]::new() if ($instanceType -eq $AzLocalInstanceTypes.HyperVToAzLocal) { - $customProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.HyperVToAzStackHciPlannedFailoverModelCustomProperties]::new() + $customProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.HyperVToAzStackHciPlannedFailoverModelCustomProperties]::new() } elseif ($instanceType -eq $AzLocalInstanceTypes.VMwareToAzLocal) { - $customProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.VMwareToAzStackHciPlannedFailoverModelCustomProperties]::new() + $customProperties = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.VMwareToAzStackHciPlannedFailoverModelCustomProperties]::new() } else { throw "Currently, for AzLocal scenario, only HyperV and VMware as the source is supported." diff --git a/src/Migrate/Migrate.Autorest/docs/Az.Migrate.md b/src/Migrate/Migrate.Autorest/docs/Az.Migrate.md deleted file mode 100644 index 9acf8c021552..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Az.Migrate.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -Module Name: Az.Migrate -Module Guid: 1e28f0b4-1cb3-4e57-ae54-b783789ddc1f -Download Help Link: https://learn.microsoft.com/powershell/module/az.migrate -Help Version: 1.0.0.0 -Locale: en-US ---- - -# Az.Migrate Module -## Description -Microsoft Azure PowerShell: Migrate cmdlets - -## Az.Migrate Cmdlets -### [Get-AzMigrateDiscoveredServer](Get-AzMigrateDiscoveredServer.md) -Get All discovered servers in a migrate project. - -### [Get-AzMigrateJob](Get-AzMigrateJob.md) -Retrieves the status of an Azure Migrate job. - -### [Get-AzMigrateLocalJob](Get-AzMigrateLocalJob.md) -Retrieves the status of an Azure Migrate job. - -### [Get-AzMigrateLocalReplicationFabric](Get-AzMigrateLocalReplicationFabric.md) -Gets the details of the fabric. - -### [Get-AzMigrateLocalServerReplication](Get-AzMigrateLocalServerReplication.md) -Retrieves the details of the replicating server. - -### [Get-AzMigrateProject](Get-AzMigrateProject.md) -Method to get a migrate project. - -### [Get-AzMigrateReplicationFabric](Get-AzMigrateReplicationFabric.md) -Gets the details of an Azure Site Recovery fabric. - -### [Get-AzMigrateReplicationPolicy](Get-AzMigrateReplicationPolicy.md) -Gets the details of a replication policy. - -### [Get-AzMigrateReplicationProtectionContainer](Get-AzMigrateReplicationProtectionContainer.md) -Gets the details of a protection container. - -### [Get-AzMigrateReplicationProtectionContainerMapping](Get-AzMigrateReplicationProtectionContainerMapping.md) -Gets the details of a protection container mapping. - -### [Get-AzMigrateReplicationRecoveryServicesProvider](Get-AzMigrateReplicationRecoveryServicesProvider.md) -Gets the details of registered recovery services provider. - -### [Get-AzMigrateRunAsAccount](Get-AzMigrateRunAsAccount.md) -Method to get run as account. - -### [Get-AzMigrateServerMigrationStatus](Get-AzMigrateServerMigrationStatus.md) -Retrieves the details of the replicating server status. - -### [Get-AzMigrateServerReplication](Get-AzMigrateServerReplication.md) -Retrieves the details of the replicating server. - -### [Get-AzMigrateSite](Get-AzMigrateSite.md) -Method to get a site. - -### [Get-AzMigrateSolution](Get-AzMigrateSolution.md) -Gets a solution in the migrate project. - -### [Initialize-AzMigrateLocalReplicationInfrastructure](Initialize-AzMigrateLocalReplicationInfrastructure.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-AzMigrateLocalDiskMappingObject](New-AzMigrateLocalDiskMappingObject.md) -Creates a new disk mapping - -### [New-AzMigrateLocalNicMappingObject](New-AzMigrateLocalNicMappingObject.md) -Creates an object to update NIC properties of a replicating server. - -### [New-AzMigrateLocalServerReplication](New-AzMigrateLocalServerReplication.md) -Starts replication for the specified server. - -### [New-AzMigrateNicMapping](New-AzMigrateNicMapping.md) -Creates an object to update NIC properties of a replicating server. - -### [New-AzMigrateProject](New-AzMigrateProject.md) -Creates a new Migrate project. - -### [New-AzMigrateReplicationPolicy](New-AzMigrateReplicationPolicy.md) -The operation to create a replication policy. - -### [New-AzMigrateReplicationProtectionContainerMapping](New-AzMigrateReplicationProtectionContainerMapping.md) -The operation to create a protection container mapping. - -### [New-AzMigrateServerReplication](New-AzMigrateServerReplication.md) -Starts replication for the specified server. - -### [New-AzMigrateTestNicMapping](New-AzMigrateTestNicMapping.md) -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-AzMigrateLocalServerReplication](Remove-AzMigrateLocalServerReplication.md) -Stops replication for the migrated server. - -### [Remove-AzMigrateProject](Remove-AzMigrateProject.md) -Delete the migrate project. -Deleting non-existent project is a no-operation. - -### [Remove-AzMigrateServerReplication](Remove-AzMigrateServerReplication.md) -Stops replication for the migrated server. - -### [Restart-AzMigrateServerReplication](Restart-AzMigrateServerReplication.md) -Restarts the replication for specified server. - -### [Resume-AzMigrateServerReplication](Resume-AzMigrateServerReplication.md) -Starts the replication that has been suspended. - -### [Set-AzMigrateDiskMapping](Set-AzMigrateDiskMapping.md) -Updates disk mapping - -### [Set-AzMigrateLocalServerReplication](Set-AzMigrateLocalServerReplication.md) -Updates the target properties for the replicating server. - -### [Set-AzMigrateServerReplication](Set-AzMigrateServerReplication.md) -Updates the target properties for the replicating server. - -### [Start-AzMigrateLocalServerMigration](Start-AzMigrateLocalServerMigration.md) -Starts the migration for the replicating server. - -### [Start-AzMigrateServerMigration](Start-AzMigrateServerMigration.md) -Starts the migration for the replicating server. - -### [Start-AzMigrateTestMigration](Start-AzMigrateTestMigration.md) -Starts the test migration for the replicating server. - -### [Start-AzMigrateTestMigrationCleanup](Start-AzMigrateTestMigrationCleanup.md) -Cleans up the test migration for the replicating server. - -### [Suspend-AzMigrateServerReplication](Suspend-AzMigrateServerReplication.md) -Suspends the ongoing replication. - diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateDiscoveredServer.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateDiscoveredServer.md deleted file mode 100644 index 3a1f58858b40..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateDiscoveredServer.md +++ /dev/null @@ -1,335 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratediscoveredserver -schema: 2.0.0 ---- - -# Get-AzMigrateDiscoveredServer - -## SYNOPSIS -Get All discovered servers in a migrate project. - -## SYNTAX - -### List (Default) -``` -Get-AzMigrateDiscoveredServer -ProjectName -ResourceGroupName [-DisplayName ] - [-SourceMachineType ] [-SubscriptionId ] [-Confirm] [-WhatIf] [] -``` - -### Get -``` -Get-AzMigrateDiscoveredServer -Name -ProjectName -ResourceGroupName - [-SourceMachineType ] [-SubscriptionId ] [-Confirm] [-WhatIf] [] -``` - -### GetInSite -``` -Get-AzMigrateDiscoveredServer -ApplianceName -Name -ProjectName - -ResourceGroupName [-SourceMachineType ] [-SubscriptionId ] [-Confirm] [-WhatIf] - [] -``` - -### ListInSite -``` -Get-AzMigrateDiscoveredServer -ApplianceName -ProjectName -ResourceGroupName - [-DisplayName ] [-SourceMachineType ] [-SubscriptionId ] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -Get Azure migrate server commandlet fetches all servers in a migrate project. - -## EXAMPLES - -### Example 1: List VMware machines -```powershell -Get-AzMigrateDiscoveredServer -SubscriptionId xxx-xxx-xxx -ResourceGroupName julytest -ProjectName julytest -``` - -```output -Name Typeo… ----- ----o… -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029e62c-31d2-a6c3-5316-aa39f47c49fc Microsoft.OffAzure/VMwareSites/machines -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029c180-1359-5e3c-3f56-05632aa4a37f Microsoft.OffAzure/VMwareSites/machines -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029d80d-d014-72f3-8d05-d43ee49a023d Microsoft.OffAzure/VMwareSites/machines -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029bd24-6d40-88dc-4f29-329596f9a50b Microsoft.OffAzure/VMwareSites/machines -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_50292d97-2025-bfdf-1f07-86afa50d144f Microsoft.OffAzure/VMwareSites/machines -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_50293685-fb73-0a89-204f-f79cb1f0061e Microsoft.OffAzure/VMwareSites/machines -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029c9aa-3c8c-aba8-834e-1058bc457e5b Microsoft.OffAzure/VMwareSites/machines -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029dabc-cc94-780f-76fd-e39acb0e9dce Microsoft.OffAzure/VMwareSites/machines -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_50299579-fc18-4152-ade2-c4a57946f72b Microsoft.OffAzure/VMwareSites/machines -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029cc18-efdc-7315-3b09-9d12a0f337e2 Microsoft.OffAzure/VMwareSites/machines - -``` - -Get All servers in a migrate project. - -### 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 -``` - -```output -Name Typeo… ----- ----o… -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029e62c-31d2-a6c3-5316-aa39f47c49fc Microsoft.OffAzure/VMwareSites/machines - -``` - -Get a server in a migrate project by name. -Name is a unique parameter for a server. - -### Example 3: List VMware machines in an appliance -```powershell -Get-AzMigrateDiscoveredServer -ApplianceName BBVMwareAVS -SubscriptionId xxx-xxx-xxx -ResourceGroupName julytest -ProjectName julytest -``` - -```output -Name Typeo… ----- ----o… -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029e62c-31d2-a6c3-5316-aa39f47c49fc Microsoft.OffAzure/VMwareSites/machines -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029c180-1359-5e3c-3f56-05632aa4a37f Microsoft.OffAzure/VMwareSites/machines -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029d80d-d014-72f3-8d05-d43ee49a023d Microsoft.OffAzure/VMwareSites/machines -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029bd24-6d40-88dc-4f29-329596f9a50b Microsoft.OffAzure/VMwareSites/machines -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_50292d97-2025-bfdf-1f07-86afa50d144f Microsoft.OffAzure/VMwareSites/machines -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_50293685-fb73-0a89-204f-f79cb1f0061e Microsoft.OffAzure/VMwareSites/machines -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029c9aa-3c8c-aba8-834e-1058bc457e5b Microsoft.OffAzure/VMwareSites/machines -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029dabc-cc94-780f-76fd-e39acb0e9dce Microsoft.OffAzure/VMwareSites/machines -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_50299579-fc18-4152-ade2-c4a57946f72b Microsoft.OffAzure/VMwareSites/machines -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029cc18-efdc-7315-3b09-9d12a0f337e2 Microsoft.OffAzure/VMwareSites/machines - -``` - -List all servers for an appliance in a project. - -### 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 -``` - -```output -Name Typeo… ----- ----o… -idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029e62c-31d2-a6c3-5316-aa39f47c49fc Microsoft.OffAzure/VMwareSites/machines - -``` - -Get a server for an appliance in a project. -Name is a unique parameter for a server. - -### 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 -``` - -```output -DisplayName Name Type ------------ ---- ---- -Contoso-ConfigurationServer 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50098b08-5701-4c58-f6ad-1daf127a8ed9 Microsoft.OffAzure/VMwareSites/machines -Contoso-FrontTier1 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_5009c31a-241a-8213-5627-4ea4af00df93 Microsoft.OffAzure/VMwareSites/machines -Contoso-MiddleTier1 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50097bb8-f32c-39d6-f475-5aaa6194f016 Microsoft.OffAzure/VMwareSites/machines -ContosoAppSrv2 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_5009b455-1721-fa03-7ceb-8177cd2c5de6 Microsoft.OffAzure/VMwareSites/machines -ContosoCSASR 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50096b80-7061-672c-8db0-07ee41212869 Microsoft.OffAzure/VMwareSites/machines -ContosoVMwareMigration2 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50099d31-71d5-2bd1-fada-8c4eba2f279a Microsoft.OffAzure/VMwareSites/machines -ContosoAppSrv1 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50097d3f-c1f6-9217-825c-936db54043df Microsoft.OffAzure/VMwareSites/machines - -``` - -List servers in a migrate project and filter responses with 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 -``` - -```output -DisplayName Name Type ------------ ---- ---- -Contoso-ConfigurationServer 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50098b08-5701-4c58-f6ad-1daf127a8ed9 Microsoft.OffAzure/VMwareSites/machines -Contoso-FrontTier1 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_5009c31a-241a-8213-5627-4ea4af00df93 Microsoft.OffAzure/VMwareSites/machines -Contoso-MiddleTier1 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50097bb8-f32c-39d6-f475-5aaa6194f016 Microsoft.OffAzure/VMwareSites/machines -ContosoAppSrv2 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_5009b455-1721-fa03-7ceb-8177cd2c5de6 Microsoft.OffAzure/VMwareSites/machines -ContosoCSASR 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50096b80-7061-672c-8db0-07ee41212869 Microsoft.OffAzure/VMwareSites/machines -ContosoVMwareMigration2 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50099d31-71d5-2bd1-fada-8c4eba2f279a Microsoft.OffAzure/VMwareSites/machines -ContosoAppSrv1 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50097d3f-c1f6-9217-825c-936db54043df Microsoft.OffAzure/VMwareSites/machines -Contoso-DataTier3 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_500986e5-7720-471e-11d7-d4e8ae9edc45 Microsoft.OffAzure/VMwareSites/machines -``` - -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 -Specifies the appliance name. -This internally maps to a site. - -```yaml -Type: System.String -Parameter Sets: GetInSite, ListInSite -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the source machine display name. - -```yaml -Type: System.String -Parameter Sets: List, ListInSite -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the source machine name. -This is an internal Name. -For users, use display name. - -```yaml -Type: System.String -Parameter Sets: Get, GetInSite -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -Specifies the migrate project name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceMachineType -Specifies the source machine type. -Currently, only HyperV and VMware are supported. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Specifies the subscription id. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202001.IHyperVMachine - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202001.IVMwareMachine - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateJob.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateJob.md deleted file mode 100644 index 1a208a3e031d..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateJob.md +++ /dev/null @@ -1,304 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratejob -schema: 2.0.0 ---- - -# Get-AzMigrateJob - -## SYNOPSIS -Retrieves the status of an Azure Migrate job. - -## SYNTAX - -### ListByName (Default) -``` -Get-AzMigrateJob -ProjectName -ResourceGroupName [-SubscriptionId ] - [-Filter ] [-DefaultProfile ] [] -``` - -### GetById -``` -Get-AzMigrateJob -JobID [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetByInputObject -``` -Get-AzMigrateJob -InputObject [-SubscriptionId ] [-DefaultProfile ] - [] -``` - -### GetByName -``` -Get-AzMigrateJob -JobName -ProjectName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### ListById -``` -Get-AzMigrateJob -ProjectID -ResourceGroupID [-SubscriptionId ] [-Filter ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The Get-AzMigrateJob cmdlet retrieves the status of an Azure Migrate job. - -## EXAMPLES - -### Example 1: Get By Job Id -```powershell -Get-AzMigrateJob -JobID "/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/997e2a92-5afe-49c7-a81a-89660aec9b7b" -``` - -```output -ActivityId : 68af14b4-46ae-48d1-b3e9-cdcffb9e8a93 ActivityId: 74d1a396-1d37-4264-8a5b-b727aaef0171 -AllowedAction : {} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails -CustomDetailInstanceType : AsrJobDetails -EndTime : 9/16/20 11:57:33 AM -Error : {} -FriendlyName : Associate replication policy -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover - yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/997e2a92-5afe-49c7-a81a-89660aec9b7b -Location : -Name : 997e2a92-5afe-49c7-a81a-89660aec9b7b -ScenarioName : AssociateProtectionProfile -StartTime : 9/16/20 11:57:32 AM -State : Succeeded -StateDescription : Completed -TargetInstanceType : ProtectionProfile -TargetObjectId : 42752b89-5fad-52fd-bf93-679fbdb6fed9 -TargetObjectName : migrateAzMigratePWSHTc8d1sitepolicy -Task : {CloudPairingPrerequisitesCheck, CloudPairingPrepareSite} -Type : Microsoft.RecoveryServices/vaults/replicationJobs -``` - -This retrieves a job by it's Id. - -### Example 2: List by resource group and project -```powershell -Get-AzMigrateJob -ResourceGroupName 'azmigratepwshtestasr13072020' -ProjectName 'AzMigrateTestProjectPWSH' -``` - -```output -ActivityId : -AllowedAction : {} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails -CustomDetailInstanceType : -EndTime : 9/21/20 4:13:40 PM -Error : {} -FriendlyName : Update the virtual machine -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover - yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/1c89e38e-34ec-4903-aa7c-115201bf2de1 -Location : -Name : 1c89e38e-34ec-4903-aa7c-115201bf2de1 -ScenarioName : UpdateVmProperties -StartTime : 9/21/20 4:13:34 PM -State : Succeeded -StateDescription : Completed -TargetInstanceType : ProtectionEntity -TargetObjectId : 593b735d-2a34-53b2-b8ed-e33da5650703 -TargetObjectName : rb-w2k12r2-1 -Task : {} -Type : Microsoft.RecoveryServices/vaults/replicationJobs -``` - -This gets all jobs in a project. - -### Example 3: Get by resource group, project and job name -```powershell -Get-AzMigrateJob -ResourceGroupName 'azmigratepwshtestasr13072020' -ProjectName 'AzMigrateTestProjectPWSH' -JobName 7ae1ee7c-442c-499d-8b0e-81d52a42b71e -``` - -```output -ActivityId : 6986b7e5-0f1f-49d8-8b4b-77e6f66bcb92 ActivityId: eb73c6a1-7c66-469f-a853-d896aa38cc0f -AllowedAction : {} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails -CustomDetailInstanceType : AsrJobDetails -EndTime : 8/21/20 6:41:48 AM -Error : {} -FriendlyName : Create replication policy -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover - yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/7ae1ee7c-442c-499d-8b0e-81d52a42b71e -Location : -Name : 7ae1ee7c-442c-499d-8b0e-81d52a42b71e -ScenarioName : AddProtectionProfile -StartTime : 8/21/20 6:41:48 AM -State : Succeeded -StateDescription : Completed -TargetInstanceType : ProtectionProfile -TargetObjectId : 18b2ccec-e39a-517b-ae5d-dd395e9f4f96 -TargetObjectName : samplePolicy3 -Task : {AddProtectionProfilePreflightsCheckTask, AddProtectionProfileTask} -Type : Microsoft.RecoveryServices/vaults/replicationJobs -``` - -This gets a specific job. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -OData filter options. - -```yaml -Type: System.String -Parameter Sets: ListById, ListByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the job object of the replicating server. -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob -Parameter Sets: GetByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobID -Specifies the job id for which the details needs to be retrieved. - -```yaml -Type: System.String -Parameter Sets: GetById -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobName -Job identifier - -```yaml -Type: System.String -Parameter Sets: GetByName -Aliases: - -Required: True -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: System.String -Parameter Sets: ListById -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The name of the migrate project. - -```yaml -Type: System.String -Parameter Sets: GetByName, ListByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupID -Specifies the Resource Group of the Azure Migrate Project in the current subscription. - -```yaml -Type: System.String -Parameter Sets: ListById -Aliases: - -Required: True -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. - -```yaml -Type: System.String -Parameter Sets: GetByName, ListByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalJob.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalJob.md deleted file mode 100644 index fc4f9b8c0ed2..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalJob.md +++ /dev/null @@ -1,456 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratelocaljob -schema: 2.0.0 ---- - -# Get-AzMigrateLocalJob - -## SYNOPSIS -Retrieves the status of an Azure Migrate job. - -## SYNTAX - -### ListByName (Default) -``` -Get-AzMigrateLocalJob -ProjectName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### GetById -``` -Get-AzMigrateLocalJob -ID [-SubscriptionId ] [-DefaultProfile ] - [] -``` - -### GetByInputObject -``` -Get-AzMigrateLocalJob -InputObject [-SubscriptionId ] [-DefaultProfile ] - [] -``` - -### GetByName -``` -Get-AzMigrateLocalJob -Name -ProjectName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### ListById -``` -Get-AzMigrateLocalJob -ProjectID -ResourceGroupID [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The Get-AzMigrateLocalJob cmdlet retrieves the status of an Azure Migrate job. - -## EXAMPLES - -### Example 1: Get by job Id -```powershell -Get-AzMigrateLocalJob -ID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/jobs/0203aa1b-1dff-4653-89a9-b90a76d1601a" -``` - -```output -ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 -AllowedAction : {Cancel} -CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails -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 : -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-AzMigrateLocalJob -ResourceGroupName "test-rg" -ProjectName "testproj" -Name "0203aa1b-1dff-4653-89a9-b90a76d1601a" -``` - -```output -ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 -AllowedAction : {Cancel} -CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails -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 : -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-AzMigrateLocalJob -ID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/jobs/0203aa1b-1dff-4653-89a9-b90a76d1601a" - -Get-AzMigrateLocalJob -InputObject $InputObject - -$InputObject | Get-AzMigrateLocalJob -``` - -```output -ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 -AllowedAction : {Cancel} -CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails -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 : -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-AzMigrateLocalJob -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" -``` - -```output -ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 -AllowedAction : {Cancel} -CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails -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 : -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.Api20240901.JobModelCustomPropertiesAffectedObjectDetails -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 : -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-AzMigrateLocalJob -ResourceGroupName "test-rg" -ProjectName "testproj" -``` - -```output -ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 -AllowedAction : {Cancel} -CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails -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 : -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.Api20240901.JobModelCustomPropertiesAffectedObjectDetails -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 : -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: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ID -Specifies the job id for which the details needs to be retrieved. - -```yaml -Type: System.String -Parameter Sets: GetById -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the job object of the replicating server. -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity -Parameter Sets: GetByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Job identifier - -```yaml -Type: System.String -Parameter Sets: GetByName -Aliases: - -Required: True -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: System.String -Parameter Sets: ListById -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The name of the migrate project. - -```yaml -Type: System.String -Parameter Sets: GetByName, ListByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupID -Specifies the Resource Group of the Azure Migrate Project in the current subscription. - -```yaml -Type: System.String -Parameter Sets: ListById -Aliases: - -Required: True -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. - -```yaml -Type: System.String -Parameter Sets: GetByName, ListByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -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). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.IJobModel - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalReplicationFabric.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalReplicationFabric.md deleted file mode 100644 index 3f8a2170a51b..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalReplicationFabric.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratelocalreplicationfabric -schema: 2.0.0 ---- - -# Get-AzMigrateLocalReplicationFabric - -## SYNOPSIS -Gets the details of the fabric. - -## SYNTAX - -### List (Default) -``` -Get-AzMigrateLocalReplicationFabric [-SubscriptionId ] [-DefaultProfile ] - [] -``` - -### Get -``` -Get-AzMigrateLocalReplicationFabric -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzMigrateLocalReplicationFabric -InputObject [-DefaultProfile ] - [] -``` - -### List1 -``` -Get-AzMigrateLocalReplicationFabric -ResourceGroupName [-SubscriptionId ] - [-ContinuationToken ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -Gets the details of the fabric. - -## EXAMPLES - -### Example 1: Get by fabric name -```powershell -Get-AzMigrateLocalReplicationFabric -ResourceGroupName "test-rg" -Name "testsrcappreplicationfabric" -``` - -```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.Api20240901.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 -Type : Microsoft.DataReplication/replicationFabrics -``` - -Retrieves a fabric by its name. - -### Example 2: Get by fabric input object -```powershell -$InputObject = Get-AzMigrateLocalReplicationFabric -ResourceGroupName "test-rg" -Name "testsrcappreplicationfabric" - -Get-AzMigrateLocalReplicationFabric -InputObject $InputObject - -$InputObject | Get-AzMigrateLocalReplicationFabric -``` - -```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.Api20240901.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 -Type : Microsoft.DataReplication/replicationFabrics -``` - -Retrieves a fabric by the fabric itself as an input object. - -### Example 3: List by resource group name -```powershell -Get-AzMigrateLocalReplicationFabric -ResourceGroupName "test-rg" -``` - -```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.Api20240901.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 -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.Api20240901.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 -Type : Microsoft.DataReplication/replicationFabrics -``` - -Retrieves all fabrics from a resource group by name. - -### Example 4: List all fabrics -```powershell -Get-AzMigrateLocalReplicationFabric -``` - -```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.Api20240901.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 -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.Api20240901.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 -Type : Microsoft.DataReplication/replicationFabrics - -... -``` - -Retrieves all fabrics from a subscription. - -## PARAMETERS - -### -ContinuationToken -Continuation token from the previous call. - -```yaml -Type: System.String -Parameter Sets: List1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The fabric name. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: FabricName - -Required: True -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: System.String -Parameter Sets: Get, List1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription Id in which migrate project was created. - -```yaml -Type: System.String[] -Parameter Sets: Get, List, List1 -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -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). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.IFabricModel - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalServerReplication.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalServerReplication.md deleted file mode 100644 index 88ee8137805e..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalServerReplication.md +++ /dev/null @@ -1,296 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratelocalserverreplication -schema: 2.0.0 ---- - -# Get-AzMigrateLocalServerReplication - -## SYNOPSIS -Retrieves the details of the replicating server. - -## SYNTAX - -### ListByName (Default) -``` -Get-AzMigrateLocalServerReplication -ProjectName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetByInputObject -``` -Get-AzMigrateLocalServerReplication -InputObject [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### GetByItemID -``` -Get-AzMigrateLocalServerReplication -TargetObjectID [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### GetByMachineName -``` -Get-AzMigrateLocalServerReplication -MachineName -ProjectName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetBySDSID -``` -Get-AzMigrateLocalServerReplication -DiscoveredMachineId [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### ListById -``` -Get-AzMigrateLocalServerReplication -ProjectID -ResourceGroupID [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The Get-AzMigrateLocalServerReplication cmdlet retrieves the object for the replicating server. - -## EXAMPLES - -### Example 1: Get details by id -```powershell -Get-AzMigrateLocalServerReplication -TargetObjectID '/subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/proj62434replicationvault/protectedItems/503a4f02-916c-d6b0-8d14-222bbd4767e5' -``` - -```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.Api20240901.ProtectedItemModelProperties -SystemDataCreatedAt : -SystemDataCreatedBy : -SystemDataCreatedByType : -SystemDataLastModifiedAt : -SystemDataLastModifiedBy : -SystemDataLastModifiedByType : -Type : Microsoft.DataReplication/replicationVaults/protectedItems -``` - -Get by id. - -### Example 2: Get detail by discovered machine id -```powershell -Get-AzMigrateLocalServerReplication -DiscoveredMachineId "/subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.OffAzure/HyperVSites/siteName1/machines/503a4f02-916c-d6b0-8d14-222bbd4767e5" - -``` - -```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.Api20240901.ProtectedItemModelProperties -SystemDataCreatedAt : -SystemDataCreatedBy : -SystemDataCreatedByType : -SystemDataLastModifiedAt : -SystemDataLastModifiedBy : -SystemDataLastModifiedByType : -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.Api20240901.ProtectedItemModelProperties -SystemDataCreatedAt : -SystemDataCreatedBy : -SystemDataCreatedByType : -SystemDataLastModifiedAt : -SystemDataLastModifiedBy : -SystemDataLastModifiedByType : -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.Api20240901.ProtectedItemModelProperties -SystemDataCreatedAt : -SystemDataCreatedBy : -SystemDataCreatedByType : -SystemDataLastModifiedAt : -SystemDataLastModifiedBy : -SystemDataLastModifiedByType : -Type : Microsoft.DataReplication/replicationVaults/protectedItems -``` - -List all. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiscoveredMachineId -Specifies the machine ID of the discovered server. - -```yaml -Type: System.String -Parameter Sets: GetBySDSID -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the machine object of the replicating server. -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity -Parameter Sets: GetByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MachineName -Specifies the display name of the replicating machine. - -```yaml -Type: System.String -Parameter Sets: GetByMachineName -Aliases: - -Required: True -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: System.String -Parameter Sets: ListById -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -Specifies the Azure Migrate project in the current subscription. - -```yaml -Type: System.String -Parameter Sets: GetByMachineName, ListByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupID -Specifies the Resource Group of the Azure Migrate Project in the current subscription. - -```yaml -Type: System.String -Parameter Sets: ListById -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the Resource Group of the Azure Migrate Project in the current subscription. - -```yaml -Type: System.String -Parameter Sets: GetByMachineName, ListByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetObjectID -Specifies the replicating server ARM ID. - -```yaml -Type: System.String -Parameter Sets: GetByItemID -Aliases: - -Required: True -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). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.IProtectedItemModel - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateProject.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateProject.md deleted file mode 100644 index 3c5bf9e8daab..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateProject.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigrateproject -schema: 2.0.0 ---- - -# Get-AzMigrateProject - -## SYNOPSIS -Method to get a migrate project. - -## SYNTAX - -``` -Get-AzMigrateProject -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -Method to get a migrate project. - -## EXAMPLES - -### Example 1: Get -```powershell -Get-AzMigrateProject -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -Name BugBashAVSVMware -``` - -```output -ETag Location Name Type ----- -------- ---- ---- - southeastasia BugBashAVSVMware Microsoft.Migrate/MigrateProjects -``` - -Method to get a migrate project. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the Azure Migrate project. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: MigrateProjectName - -Required: True -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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription Id in which migrate project was created. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180901Preview.IMigrateProject - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationFabric.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationFabric.md deleted file mode 100644 index 2a69fd708e61..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationFabric.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratereplicationfabric -schema: 2.0.0 ---- - -# Get-AzMigrateReplicationFabric - -## SYNOPSIS -Gets the details of an Azure Site Recovery fabric. - -## SYNTAX - -### List (Default) -``` -Get-AzMigrateReplicationFabric -ResourceGroupName -ResourceName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzMigrateReplicationFabric -FabricName -ResourceGroupName -ResourceName - [-SubscriptionId ] [-Filter ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -Gets the details of an Azure Site Recovery fabric. - -## EXAMPLES - -### Example 1: Get all fabrics by resource group and vault name -```powershell -Get-AzMigrateReplicationFabric -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault -FabricName AzMigratePWSHTc8d1replicationfabric -``` - -```output -BcdrState : Valid -CustomDetailInstanceType : VMwareV2 -EncryptionDetailKekCertExpiryDate : -EncryptionDetailKekCertThumbprint : -EncryptionDetailKekState : None -FriendlyName : AzMigratePWSHTc8d1replicationfabric -Health : Normal -HealthErrorDetail : {} -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsof - t.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabr - ic -InternalIdentifier : 501ff8f2-c9d7-5bf4-87ff-d0b3fc98aeb5 -Location : -Name : AzMigratePWSHTc8d1replicationfabric -RolloverEncryptionDetailKekCertExpiryDate : -RolloverEncryptionDetailKekCertThumbprint : -RolloverEncryptionDetailKekState : None -Type : Microsoft.RecoveryServices/vaults/replicationFabrics -``` - -Get all fabrics in resource group and vault - -### Example 2: Get fabric by resource group, vault name and fabric name -```powershell -Get-AzMigrateReplicationFabric -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault -``` - -```output -BcdrState : Valid -CustomDetailInstanceType : VMwareV2 -EncryptionDetailKekCertExpiryDate : -EncryptionDetailKekCertThumbprint : -EncryptionDetailKekState : None -FriendlyName : AzMigratePWSHTc8d1replicationfabric -Health : Normal -HealthErrorDetail : {} -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsof - t.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabr - ic -InternalIdentifier : 501ff8f2-c9d7-5bf4-87ff-d0b3fc98aeb5 -Location : -Name : AzMigratePWSHTc8d1replicationfabric -RolloverEncryptionDetailKekCertExpiryDate : -RolloverEncryptionDetailKekCertThumbprint : -RolloverEncryptionDetailKekState : None -Type : Microsoft.RecoveryServices/vaults/replicationFabrics -``` - -Get a specific fabric - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FabricName -Fabric name. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -OData filter options. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceName -The name of the recovery services vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription Id in which migrate project was created. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IFabric - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationPolicy.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationPolicy.md deleted file mode 100644 index ad4ffc076966..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationPolicy.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratereplicationpolicy -schema: 2.0.0 ---- - -# Get-AzMigrateReplicationPolicy - -## SYNOPSIS -Gets the details of a replication policy. - -## SYNTAX - -### List (Default) -``` -Get-AzMigrateReplicationPolicy -ResourceGroupName -ResourceName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzMigrateReplicationPolicy -PolicyName -ResourceGroupName -ResourceName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -Gets the details of a replication policy. - -## EXAMPLES - -### Example 1: Get all policies in a vault -```powershell -Get-AzMigrateReplicationPolicy -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault -``` - -```output -Location Name Type --------- ---- ---- - samplepolicy2 Microsoft.RecoveryServices/vaults/replicationPolicies - samplepolicy1 Microsoft.RecoveryServices/vaults/replicationPolicies - samplePolicy3 Microsoft.RecoveryServices/vaults/replicationPolicies - migrateAzMigratePWSHTc8d1sitepolicy Microsoft.RecoveryServices/vaults/replicationPolicies -``` - -Get all policies. - -### Example 2: Get a specific policy -```powershell -Get-AzMigrateReplicationPolicy -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault -PolicyName migrateAzMigratePWSHTc8d1sitepolicy -``` - -```output -Location Name Type --------- ---- ---- - migrateAzMigratePWSHTc8d1sitepolicy Microsoft.RecoveryServices/vaults/replicationPolicies -``` - -Get a specific one. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -Replication policy name. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceName -The name of the recovery services vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription Id in which migrate project was created. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IPolicy - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationProtectionContainer.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationProtectionContainer.md deleted file mode 100644 index a901ac4d8895..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationProtectionContainer.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratereplicationprotectioncontainer -schema: 2.0.0 ---- - -# Get-AzMigrateReplicationProtectionContainer - -## SYNOPSIS -Gets the details of a protection container. - -## SYNTAX - -### List1 (Default) -``` -Get-AzMigrateReplicationProtectionContainer -ResourceGroupName -ResourceName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzMigrateReplicationProtectionContainer -FabricName -ProtectionContainerName - -ResourceGroupName -ResourceName [-SubscriptionId ] [-DefaultProfile ] - [] -``` - -### List -``` -Get-AzMigrateReplicationProtectionContainer -FabricName -ResourceGroupName - -ResourceName [-SubscriptionId ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -Gets the details of a protection container. - -## EXAMPLES - -### Example 1: List all protection containers in vault and fabric -```powershell -Get-AzMigrateReplicationProtectionContainer -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault -FabricName AzMigratePWSHTc8d1replicationfabric -``` - -```output -Location Name Type --------- ---- ---- - AzMigratePWSHTc8d1replicationcontainer Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers -``` - -Lists all. - -### Example 2: Get a specific container -```powershell -Get-AzMigrateReplicationProtectionContainer -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault -FabricName AzMigratePWSHTc8d1replicationfabric -ProtectionContainerName AzMigratePWSHTc8d1replicationcontainer -``` - -```output -Location Name Type --------- ---- ---- - AzMigratePWSHTc8d1replicationcontainer Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers -``` - -Gets a specific one. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FabricName -Fabric name. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectionContainerName -Protection container name. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceName -The name of the recovery services vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription Id in which migrate project was created. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IProtectionContainer - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationProtectionContainerMapping.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationProtectionContainerMapping.md deleted file mode 100644 index 70c5860efb56..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationProtectionContainerMapping.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratereplicationprotectioncontainermapping -schema: 2.0.0 ---- - -# Get-AzMigrateReplicationProtectionContainerMapping - -## SYNOPSIS -Gets the details of a protection container mapping. - -## SYNTAX - -### List1 (Default) -``` -Get-AzMigrateReplicationProtectionContainerMapping -ResourceGroupName -ResourceName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzMigrateReplicationProtectionContainerMapping -FabricName -MappingName - -ProtectionContainerName -ResourceGroupName -ResourceName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### List -``` -Get-AzMigrateReplicationProtectionContainerMapping -FabricName -ProtectionContainerName - -ResourceGroupName -ResourceName [-SubscriptionId ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Gets the details of a protection container mapping. - -## EXAMPLES - -### Example 1: Get a specific mapping -```powershell -Get-AzMigrateReplicationProtectionContainerMapping -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault -FabricName AzMigratePWSHTc8d1replicationfabric -ProtectionContainerName AzMigratePWSHTc8d1replicationcontainer -MappingName "containermapping" -``` - -```output -Location Name Type --------- ---- ---- - containermapping Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings -``` - -Get a mapping detail. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FabricName -Fabric name. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MappingName -Protection Container mapping name. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectionContainerName -Protection container name. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceName -The name of the recovery services vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription Id in which migrate project was created. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IProtectionContainerMapping - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationRecoveryServicesProvider.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationRecoveryServicesProvider.md deleted file mode 100644 index aeaa3d721985..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationRecoveryServicesProvider.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratereplicationrecoveryservicesprovider -schema: 2.0.0 ---- - -# Get-AzMigrateReplicationRecoveryServicesProvider - -## SYNOPSIS -Gets the details of registered recovery services provider. - -## SYNTAX - -### List (Default) -``` -Get-AzMigrateReplicationRecoveryServicesProvider -ResourceGroupName -ResourceName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzMigrateReplicationRecoveryServicesProvider -FabricName -ProviderName - -ResourceGroupName -ResourceName [-SubscriptionId ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Gets the details of registered recovery services provider. - -## EXAMPLES - -### Example 1: Get all providers in vault -```powershell -Get-AzMigrateReplicationRecoveryServicesProvider -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault -``` - -```output -Location Name Type --------- ---- ---- - AzMigratePWSHTc8d1dra Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders -``` - -List all. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FabricName -Fabric name. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProviderName -Recovery services provider name. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceName -The name of the recovery services vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription Id in which migrate project was created. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IRecoveryServicesProvider - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateRunAsAccount.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateRunAsAccount.md deleted file mode 100644 index f36b5737a2d8..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateRunAsAccount.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigraterunasaccount -schema: 2.0.0 ---- - -# Get-AzMigrateRunAsAccount - -## SYNOPSIS -Method to get run as account. - -## SYNTAX - -### List (Default) -``` -Get-AzMigrateRunAsAccount -ResourceGroupName -SiteName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzMigrateRunAsAccount -AccountName -ResourceGroupName -SiteName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -Method to get run as account. - -## EXAMPLES - -### Example 1: List (Default) -```powershell -Get-AzMigrateRunAsAccount -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -SiteName BBVMwareAVScbbcsite -``` - -```output -Name Type ----- ---- -b090bef3-b733-5e34-bc8f-eb6f2701432a Microsoft.OffAzure/VMwareSites/runasaccounts -``` - -List all run as accounts in a site. - -### Example 2: Get -```powershell -Get-AzMigrateRunAsAccount -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -SiteName BBVMwareAVScbbcsite -AccountName b090bef3-b733-5e34-bc8f-eb6f2701432a -``` - -```output -Name Type ----- ---- -b090bef3-b733-5e34-bc8f-eb6f2701432a Microsoft.OffAzure/VMwareSites/runasaccounts -``` - -Get Run as account by name. - -## PARAMETERS - -### -AccountName -Run as account ARM name. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -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: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteName -Site name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202001.IVMwareRunAsAccount - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateServerMigrationStatus.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateServerMigrationStatus.md deleted file mode 100644 index e02e7491065a..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateServerMigrationStatus.md +++ /dev/null @@ -1,335 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigrateservermigrationstatus -schema: 2.0.0 ---- - -# Get-AzMigrateServerMigrationStatus - -## SYNOPSIS -Retrieves the details of the replicating server status. - -## SYNTAX - -### ListByName (Default) -``` -Get-AzMigrateServerMigrationStatus -ProjectName -ResourceGroupName - [-SubscriptionId ] [-Filter ] [-SkipToken ] [-DefaultProfile ] - [] -``` - -### GetByApplianceName -``` -Get-AzMigrateServerMigrationStatus -ApplianceName -ProjectName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetByMachineName -``` -Get-AzMigrateServerMigrationStatus -MachineName -ProjectName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetByPrioritiseServer -``` -Get-AzMigrateServerMigrationStatus -Expedite -MachineName -ProjectName - -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetHealthByMachineName -``` -Get-AzMigrateServerMigrationStatus -Health -MachineName -ProjectName - -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The Get-AzMigrateServerMigrationStatus cmdlet retrieves the replication status for the replicating server. - -## EXAMPLES - -### Example 1: List status by project name. -```powershell -Get-AzMigrateServerMigrationStatus -ProjectName "cbt-resync-gql" -ResourceGroupName "ankitbaluni-resync-rg" -``` - -```output - -Appliance Server State Progress TimeElapsed TimeRemaining UploadSpeed Health LastSync Datastore ESXiHost ---------- ------ ----- -------- ----------- ------------- ----------- ------ -------- --------- -------- -nosbm-test-ds el41-r5w12r1-3 InitialReplication InProgress 48 % 3 hr 48 min 12 hr 37 min 1230 Mbps Normal - IDCLAB-T100_10TB idclab-vcen65.corp.microsoft.com_10.150.84.28 -nosbm-test-ds el41-r5w2k8r2-1 DeltaReplication Completed - - - - Normal 9/4/2025, 3:04:45 PM IDCLAB-T100_10TB idclab-vcen65.corp.microsoft.com_10.150.84.28 -nosbm-test-ds dsinha-cbt-test DeltaReplication Completed - - - - Normal 9/4/2025, 2:58:21 PM IDCLAB-T100_10TB idclab-vcen65.corp.microsoft.com_10.150.84.28 - - - - -To resolve the health issue use the command -Get-AzMigrateServerMigrationStatus -ProjectName -ResourceGroupName -MachineName -Health -``` - -Get by project name. - -### Example 2: List status by machine name. -```powershell -Get-AzMigrateServerMigrationStatus -ProjectName "cbt-resync-gql" -ResourceGroupName "ankitbaluni-resync-rg" -MachineName "Rhel8-Vm" -``` - -```output -Server Rhel8-Vm is currently healthy. - -Appliance Server State Progress TimeElapsed TimeRemaining UploadSpeed LastSync ESXiHost Datastore ---------- ------ ----- -------- ----------- ------------- ----------- -------- -------- --------- -cbtresyncgql Rhel8-Vm DeltaReplication Completed - - - - 7/14/2025, 9:51:05 PM idclab-vcen8.fareast.corp.microsoft.com_10.150.102.181 IDCLAB-B161-3TB - - - -Disk Level Operation Status: - -Disk State Progress TimeElapsed TimeRemaining UploadSpeed Datastore ----- ----- -------- ----------- ------------- ----------- --------- -Rhel8-Vm DeltaReplication Completed - - - - IDCLAB-B161-3TB -``` - -Get by machine name. - -### Example 3: List status by appliance name. -```powershell -Get-AzMigrateServerMigrationStatus -ProjectName "cbt-resync-gql" -ResourceGroupName "ankitbaluni-resync-rg" -ApplianceName "cbtresyncgql" -``` - -```output -Server State Progress TimeElapsed TimeRemaining UploadSpeed Health LastSync Datastore ESXiHost ------- ----- -------- ----------- ------------- ----------- ------ -------- --------- -------- -el41-r5w12r1-3 InitialReplication InProgress 48 % 3 hr 48 min 12 hr 37 min 1230 Mbps Normal - IDCLAB-T100_10TB idclab-vcen65.corp.microsoft.com_10.150.84.28 -el41-r5w2k8r2-1 DeltaReplication Completed - - - - Normal 9/4/2025, 3:04:45 PM IDCLAB-T100_10TB idclab-vcen65.corp.microsoft.com_10.150.84.28 -dsinha-cbt-test DeltaReplication Completed - - - - Normal 9/4/2025, 2:58:21 PM IDCLAB-T100_10TB idclab-vcen65.corp.microsoft.com_10.150.84.28 - - -To check expedite the operation of a server use the command -Get-AzMigrateServerMigrationStatus -ProjectName -ResourceGroupName -MachineName -Expedite - -To resolve the health issue use the command -Get-AzMigrateServerMigrationStatus -ProjectName -ResourceGroupName -MachineName -Health -``` - -Get by appliance name. - -### Example 4: Expedite replication for a server. -```powershell -Get-AzMigrateServerMigrationStatus -ProjectName "cbt-resync-gql" -ResourceGroupName "ankitbaluni-resync-rg" -MachineName "Rhel8-Vm" -Expedite -``` - -```output -Server Information: - -Appliance Server State Progress TimeElapsed TimeRemaining UploadSpeed LastSync ESXiHost Datastore ---------- ------ ----- -------- ----------- ------------- ----------- -------- -------- --------- -cbtresyncgql Rhel8-Vm DeltaReplication Completed - - - - 7/14/2025, 9:51:05 PM idclab-vcen8.fareast.corp.microsoft.com_10.150.102.181 IDCLAB-B161-3TB - - - -Disk Level Operation Status: - -Disk State Progress TimeElapsed TimeRemaining UploadSpeed Datastore ----- ----- -------- ----------- ------------- ----------- --------- -Rhel8-Vm DeltaReplication Completed - - - - IDCLAB-B161-3TB - - -Resource Sharing: - -The following VMs share at least one resource (Appliance, ESXi Host, or Datastore) with VM 'Rhel8-Vm'. The 'SharedResourceType' and 'SharedResourceName' columns indicate which resource is shared. - -Appliance Server SharedResourceType State TimeRemaining ESXiHost Datastore ---------- ------ ------------------ ----- ------------- -------- --------- -cbtresyncgql wave-selfhost-vm8 Appliance DeltaReplication Completed - idclab-vcen8.fareast.corp.microsoft.com_10.150.102.191 Shared_1TB -cbtresyncgql el41-r5w12r2-1 Appliance DeltaReplication Completed - idclab-vcen65.corp.microsoft.com_10.150.84.28 IDCLAB-T100_10TB -cbtresyncgql el41-r5w2k8r2-1 Appliance DeltaReplication Completed - idclab-vcen65.corp.microsoft.com_10.150.84.28 IDCLAB-T100_10TB -cbtresyncgql el41-r5w12r1-2 Appliance DeltaReplication Completed - idclab-vcen65.corp.microsoft.com_10.150.84.28 IDCLAB-T100_10TB -cbtresyncgql ubuntu22-liverserver-bios-nolvm Appliance, ESXiHost, Datastore DeltaReplication Completed - idclab-vcen8.fareast.corp.microsoft.com_10.150.102.181 IDCLAB-B161-3TB - - -Resource utilization information for migration operations: - -Resource Capacity Utilization for server migrations Total utilization Status --------- -------- --------------------------------- ----------------- ------ -Appliance RAM Sum : Primary and scale out appliances 32768 MB 1808 MB 7014 MB Underutilized -Appliance CPU Sum : Primary and scale out appliances 4 Cores - 99% At capacity -Network bandwidth Sum : Primary and scale out appliances 1192 MBps - - Underutilized -ESXi host NFC buffer 32 MB 8 MB - Underutilized -Parallel Disks Replicated Sum : Primary and scale out appliances 58 3 - Underutilized -Datastore 'IDCLAB-B161-3TB' Snapshot Count 15 2 - Underutilized - - -Based on the resource utilization seen above, here are suggestions to expedite server Rhel8-Vm migration: - -1. CPU is At capacity. Pause or stop other migrations under this appliance, or increase CPU resources if possible. -``` - -Expedite replication for a specific server. - -## PARAMETERS - -### -ApplianceName -Specifies the name of the appliance. - -```yaml -Type: System.String -Parameter Sets: GetByApplianceName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Expedite -Specifies whether to expedite the operation of a replicating server. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: GetByPrioritiseServer -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -OData filter options. - -```yaml -Type: System.String -Parameter Sets: ListByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Health -Specifies whether the health issues to show for replicating server. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: GetHealthByMachineName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MachineName -Specifies the display name of the replicating machine. - -```yaml -Type: System.String -Parameter Sets: GetByMachineName, GetByPrioritiseServer, GetHealthByMachineName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -Specifies the Azure Migrate project in the current subscription. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the Resource Group of the Azure Migrate Project in the current subscription. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipToken -The pagination token. - -```yaml -Type: System.String -Parameter Sets: ListByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -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). - -## INPUTS - -## OUTPUTS - -### System.Management.Automation.PSObject[] - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateServerReplication.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateServerReplication.md deleted file mode 100644 index e812c7a31a9a..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateServerReplication.md +++ /dev/null @@ -1,413 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigrateserverreplication -schema: 2.0.0 ---- - -# Get-AzMigrateServerReplication - -## SYNOPSIS -Retrieves the details of the replicating server. - -## SYNTAX - -### ListByName (Default) -``` -Get-AzMigrateServerReplication -ProjectName -ResourceGroupName [-SubscriptionId ] - [-Filter ] [-SkipToken ] [-DefaultProfile ] [] -``` - -### GetByInputObject -``` -Get-AzMigrateServerReplication -InputObject [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### GetByMachineName -``` -Get-AzMigrateServerReplication -MachineName -ProjectName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetBySDSID -``` -Get-AzMigrateServerReplication -DiscoveredMachineId [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### GetBySRSID -``` -Get-AzMigrateServerReplication -TargetObjectID [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### ListById -``` -Get-AzMigrateServerReplication -ProjectID -ResourceGroupID [-SubscriptionId ] - [-Filter ] [-SkipToken ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The Get-AzMigrateServerReplication cmdlet retrieves the object for the replicating server. - -## EXAMPLES - -### Example 1: Get details by id -```powershell -Get-AzMigrateServerReplication -TargetObjectID '/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f' -``` - -```output -AllowedOperation : {DisableMigration, TestMigrate, Migrate} -CurrentJobId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ - ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/None -CurrentJobName : None -CurrentJobStartTime : 1/1/53 1:01:01 AM -EventCorrelationId : d8b110c6-3be9-4798-b2d4-9a1cd068adfb -Health : Normal -HealthError : {101883a0-23f7-538a-bbd5-6d8b4fa900e2} -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ - ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionCont - ainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af- - e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f -LastTestMigrationStatus : -LastTestMigrationTime : -Location : -MachineName : prsadhu-TestVM -MigrationState : Replicating -MigrationStateDescription : Ready to migrate -Name : bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f -PolicyFriendlyName : migrateAzMigratePWSHTc8d1sitepolicy -PolicyId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ - ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationPolicies/migrateAzMigratePWSHTc8d1sitepolicy -ProviderSpecificDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtMigrationDetails -TestMigrateState : None -TestMigrateStateDescription : None -Type : Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems -``` - -Get by id. - -### Example 2: List all in project by id. -```powershell -Get-AzMigrateServerReplication -ResourceGroupID /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020 -ProjectID "/subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Migrate/MigrateProjects/AzMigrateTestProjectPWSH" -``` - -```output -AllowedOperation : {DisableMigration, TestMigrate, Migrate} -CurrentJobId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ - ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/None -CurrentJobName : None -CurrentJobStartTime : 1/1/53 1:01:01 AM -EventCorrelationId : d8b110c6-3be9-4798-b2d4-9a1cd068adfb -Health : Normal -HealthError : {101883a0-23f7-538a-bbd5-6d8b4fa900e2} -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ - ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionCont - ainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af- - e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f -LastTestMigrationStatus : -LastTestMigrationTime : -Location : -MachineName : prsadhu-TestVM -MigrationState : Replicating -MigrationStateDescription : Ready to migrate -Name : bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f -PolicyFriendlyName : migrateAzMigratePWSHTc8d1sitepolicy -PolicyId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ - ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationPolicies/migrateAzMigratePWSHTc8d1sitepolicy -ProviderSpecificDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtMigrationDetails -TestMigrateState : None -TestMigrateStateDescription : None -Type : Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems - -AllowedOperation : {DisableMigration, TestMigrate, Migrate} -CurrentJobId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ - ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/None -CurrentJobName : None -CurrentJobStartTime : 1/1/53 1:01:01 AM -EventCorrelationId : 57b59212-6a2f-4333-8882-461647bb05f9 -Health : Normal -HealthError : {593b735d-2a34-53b2-b8ed-e33da5650703} -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ - ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionCont - ainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af- - e206c9ca4f93_500f44f8-2aa3-587b-8958-ead358639629 -LastTestMigrationStatus : -LastTestMigrationTime : -Location : -MachineName : rb-w2k12r2-1 -MigrationState : Replicating -MigrationStateDescription : Ready to migrate -Name : bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_500f44f8-2aa3-587b-8958-ead358639629 -PolicyFriendlyName : migrateAzMigratePWSHTc8d1sitepolicy -PolicyId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ - ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationPolicies/migrateAzMigratePWSHTc8d1sitepolicy -ProviderSpecificDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtMigrationDetails -TestMigrateState : None -TestMigrateStateDescription : None -Type : Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems -``` - -List all. - -### Example 3: List all in project by name. -```powershell -Get-AzMigrateServerReplication -ResourceGroupName azmigratepwshtestasr13072020 -ProjectName AzMigrateTestProjectPWSH -``` - -```output -AllowedOperation : {DisableMigration, TestMigrate, Migrate} -CurrentJobId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ - ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/None -CurrentJobName : None -CurrentJobStartTime : 1/1/53 1:01:01 AM -EventCorrelationId : d8b110c6-3be9-4798-b2d4-9a1cd068adfb -Health : Normal -HealthError : {101883a0-23f7-538a-bbd5-6d8b4fa900e2} -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ - ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionCont - ainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af- - e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f -LastTestMigrationStatus : -LastTestMigrationTime : -Location : -MachineName : prsadhu-TestVM -MigrationState : Replicating -MigrationStateDescription : Ready to migrate -Name : bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f -PolicyFriendlyName : migrateAzMigratePWSHTc8d1sitepolicy -PolicyId : /Subscriptions/7xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ - ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationPolicies/migrateAzMigratePWSHTc8d1sitepolicy -ProviderSpecificDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtMigrationDetails -TestMigrateState : None -TestMigrateStateDescription : None -Type : Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems - -AllowedOperation : {DisableMigration, TestMigrate, Migrate} -CurrentJobId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ - ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/None -CurrentJobName : None -CurrentJobStartTime : 1/1/53 1:01:01 AM -EventCorrelationId : 57b59212-6a2f-4333-8882-461647bb05f9 -Health : Normal -HealthError : {593b735d-2a34-53b2-b8ed-e33da5650703} -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ - ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionCont - ainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af- - e206c9ca4f93_500f44f8-2aa3-587b-8958-ead358639629 -LastTestMigrationStatus : -LastTestMigrationTime : -Location : -MachineName : rb-w2k12r2-1 -MigrationState : Replicating -MigrationStateDescription : Ready to migrate -Name : bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_500f44f8-2aa3-587b-8958-ead358639629 -PolicyFriendlyName : migrateAzMigratePWSHTc8d1sitepolicy -PolicyId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ - ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationPolicies/migrateAzMigratePWSHTc8d1sitepolicy -ProviderSpecificDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtMigrationDetails -TestMigrateState : None -TestMigrateStateDescription : None -Type : Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems -``` - -List all. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiscoveredMachineId -Specifies the machine ID of the discovered server. - -```yaml -Type: System.String -Parameter Sets: GetBySDSID -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -OData filter options. - -```yaml -Type: System.String -Parameter Sets: ListById, ListByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the machine object of the replicating server. -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IMigrationItem -Parameter Sets: GetByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MachineName -Specifies the display name of the replicating machine. - -```yaml -Type: System.String -Parameter Sets: GetByMachineName -Aliases: - -Required: True -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: System.String -Parameter Sets: ListById -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -Specifies the Azure Migrate project in the current subscription. - -```yaml -Type: System.String -Parameter Sets: GetByMachineName, ListByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupID -Specifies the Resource Group of the Azure Migrate Project in the current subscription. - -```yaml -Type: System.String -Parameter Sets: ListById -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the Resource Group of the Azure Migrate Project in the current subscription. - -```yaml -Type: System.String -Parameter Sets: GetByMachineName, ListByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipToken -The pagination token. - -```yaml -Type: System.String -Parameter Sets: ListById, ListByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetObjectID -Specifies the replicating server. - -```yaml -Type: System.String -Parameter Sets: GetBySRSID -Aliases: - -Required: True -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IMigrationItem - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateSite.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateSite.md deleted file mode 100644 index 8c7266aa8535..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateSite.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratesite -schema: 2.0.0 ---- - -# Get-AzMigrateSite - -## SYNOPSIS -Method to get a site. - -## SYNTAX - -``` -Get-AzMigrateSite -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -Method to get a site. - -## EXAMPLES - -### Example 1: Get (Default) -```powershell -Get-AzMigrateSite -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -SiteName BBVMwareAVScbbcsite -``` - -```output -ETag Location Name Type ----- -------- ---- ---- - southeastasia BBVMwareAVScbbcsite Microsoft.OffAzure/VMwareSites - -``` - -Get site by name - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Site name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SiteName - -Required: True -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: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202001.IVMwareSite - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateSolution.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateSolution.md deleted file mode 100644 index 54a477416235..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateSolution.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratesolution -schema: 2.0.0 ---- - -# Get-AzMigrateSolution - -## SYNOPSIS -Gets a solution in the migrate project. - -## SYNTAX - -``` -Get-AzMigrateSolution -MigrateProjectName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -Gets a solution in the migrate project. - -## EXAMPLES - -### Example 1: Get -```powershell -Get-AzMigrateSolution -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -MigrateProjectName BugBashAVSVMware -Name Servers-Migration-ServerMigration -``` - -```output -Etag Name Type ----- ---- ---- -"010097f1-0000-1800-0000-5ee9ae2b0000" Servers-Migration-ServerMigration Microsoft.Migrate/MigrateProjec… -``` - -Get Migrate project solution by name. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrateProjectName -Name of the Azure Migrate project. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Unique name of a migration solution within a migrate project. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: SolutionName - -Required: True -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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription Id in which migrate project was created. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180901Preview.ISolution - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Initialize-AzMigrateLocalReplicationInfrastructure.md b/src/Migrate/Migrate.Autorest/docs/Initialize-AzMigrateLocalReplicationInfrastructure.md deleted file mode 100644 index 0926922b75f5..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Initialize-AzMigrateLocalReplicationInfrastructure.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/initialize-azmigratelocalreplicationinfrastructure -schema: 2.0.0 ---- - -# Initialize-AzMigrateLocalReplicationInfrastructure - -## SYNOPSIS -Initializes the infrastructure for the migrate project. - -## SYNTAX - -``` -Initialize-AzMigrateLocalReplicationInfrastructure -ProjectName -ResourceGroupName - -SourceApplianceName -TargetApplianceName [-CacheStorageAccountId ] - [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -The Initialize-AzMigrateLocalReplicationInfrastructure cmdlet initializes the infrastructure for the migrate project in AzLocal scenario. - -## EXAMPLES - -### Example 1: Initialize AzLocal replication infrastructure -```powershell -Initialize-AzMigrateLocalReplicationInfrastructure -ProjectName "testproj" -ResourceGroupName "test-rg" -SourceApplianceName "testsrcapp" -TargetApplianceName "testtgtapp" -PassThru:$true -``` - -```output -$true -``` - -Initialize AzLocal replication infrastructure. -Cache storage account, replication policy, and replication extension will be created automatically. - -### Example 2: Initialize AzLocal replication infrastructure with custom cache storage account -```powershell -$cacheStorageAccountId = "/subscriptions/xxx-xxx-xxxx/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/testSa" - -Initialize-AzMigrateLocalReplicationInfrastructure -ProjectName "testproj" -ResourceGroupName "test-rg" -CacheStorageAccountId $cacheStorageAccountId -SourceApplianceName "testsrcapp" -TargetApplianceName "testtgtapp" -PassThru:$true -``` - -```output -$true -``` - -Initialize AzLocal replication infrastructure with custom cache storage account. -Replication policy and replication extension will be created automatically. - -## PARAMETERS - -### -CacheStorageAccountId -Specifies the Storage Account ARM Id to be used for private endpoint scenario. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the Resource Group of the Azure Migrate Project in the current subscription. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceApplianceName -Specifies the source appliance name for the AzLocal scenario. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetApplianceName -Specifies the target appliance name for the AzLocal scenario. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -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). - -## INPUTS - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Initialize-AzMigrateReplicationInfrastructure.md b/src/Migrate/Migrate.Autorest/docs/Initialize-AzMigrateReplicationInfrastructure.md deleted file mode 100644 index 32e4cc529376..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Initialize-AzMigrateReplicationInfrastructure.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/initialize-azmigratereplicationinfrastructure -schema: 2.0.0 ---- - -# Initialize-AzMigrateReplicationInfrastructure - -## SYNOPSIS -Initialises the infrastructure for the migrate project. - -## SYNTAX - -``` -Initialize-AzMigrateReplicationInfrastructure -ProjectName -ResourceGroupName - -Scenario -TargetRegion [-CacheStorageAccountId ] [-SubscriptionId ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -The Initialize-AzMigrateReplicationInfrastructure cmdlet initialises the infrastructure for the migrate project. - -## EXAMPLES - -### Example 1: Initialises the infrastructure for the migrate project. -```powershell -Initialize-AzMigrateReplicationInfrastructure -ResourceGroupName TestRG -ProjectName TestProject -TargetRegion centralus -``` - -```output -True -``` - -Initialises the infrastructure for the migrate project. - -### Example 2: Initialises the infrastructure for the migrate project for private endpoint scenario. -```powershell -Initialize-AzMigrateReplicationInfrastructure -ResourceGroupName "TestRG" -ProjectName "TestPEProject" -TargetRegion "centraluseuap" -Scenario "agentlessVMware" -CacheStorageAccountId "/subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/singhabh-rg/providers/Microsoft.Storage/storageAccounts/singhabhstoragepe1" -``` - -```output -True -``` - -Initialises the infrastructure for the migrate project for private endpoint scenario. - -## PARAMETERS - -### -CacheStorageAccountId -Specifies the Storage Account Id to be used for private endpoint scenario. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the Resource Group of the Azure Migrate Project in the current subscription. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scenario -Specifies the server migration scenario for which the replication infrastructure needs to be initialized. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetRegion -Specifies the target Azure region for server migrations. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -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). - -## INPUTS - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateDiskMapping.md b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateDiskMapping.md deleted file mode 100644 index a7572b915e98..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateDiskMapping.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratediskmapping -schema: 2.0.0 ---- - -# New-AzMigrateDiskMapping - -## SYNOPSIS -Creates a new disk mapping - -## SYNTAX - -``` -New-AzMigrateDiskMapping -DiskID -DiskType -IsOSDisk - [-DiskEncryptionSetID ] [] -``` - -## DESCRIPTION -The New-AzMigrateDiskMapping cmdlet creates a mapping of the source disk attached to the server to be migrated - -## EXAMPLES - -### Example 1: Make Standard disks -```powershell -New-AzMigrateDiskMapping -DiskID a -DiskType Standard_LRS -IsOSDisk 'true' -``` - -```output -DiskEncryptionSetId DiskId DiskType IsOSDisk LogStorageAccountId LogStorageAccountSasSecretName -------------------- ------ -------- -------- ------------------- ------------------------------ - a Standard_LRS true -``` - - - -### Example 2: Make Premium V2 disks -```powershell -New-AzMigrateDiskMapping -DiskID b -DiskType PremiumV2_LRS -IsOSDisk 'false' -``` - -```output -DiskEncryptionSetId DiskId DiskType IsOSDisk LogStorageAccountId LogStorageAccountSasSecretName -------------------- ------ -------- -------- ------------------- ------------------------------ - b PremiumV2_LRS false -``` - -Get disks object to provide input for New-AzMigrateServerReplication - -## PARAMETERS - -### -DiskEncryptionSetID -Specifies the disk encryption set to be used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskID -Specifies the disk ID of the disk attached to the discovered server to be migrated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskType -Specifies the type of disks to be used for the Azure VM. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsOSDisk -Specifies whether the disk contains the Operating System for the source server to be migrated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtDiskInput - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalDiskMappingObject.md b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalDiskMappingObject.md deleted file mode 100644 index 47164f1d6be3..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalDiskMappingObject.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratelocaldiskmappingobject -schema: 2.0.0 ---- - -# New-AzMigrateLocalDiskMappingObject - -## SYNOPSIS -Creates a new disk mapping - -## SYNTAX - -``` -New-AzMigrateLocalDiskMappingObject -DiskID -Format -IsDynamic -IsOSDisk - -Size [-PhysicalSectorSize ] [] -``` - -## DESCRIPTION -The New-AzMigrateLocalDiskMappingObject cmdlet creates a mapping of the source disk attached to the server to be migrated - -## EXAMPLES - -### Example 1: Creates Disk to migrate -```powershell -New-AzMigrateLocalDiskMappingObject -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-AzMigrateLocalServerReplication - -## PARAMETERS - -### -DiskID -Specifies the disk ID of the disk attached to the discovered server to be migrated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Format -Specifies the disk format. -'VHD' or 'VHDX' for Hyper-V Generation 1; 'VHDX' for Hyper-V Generation 2. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsDynamic -Specifies whether the disk is dynamic. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsOSDisk -Specifies whether the disk contains the Operating System for the source server to be migrated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhysicalSectorSize -Specifies the disk physical sector size in bytes. - -```yaml -Type: System.Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Size -Specifies the disk size in GB. - -```yaml -Type: System.Int64 -Parameter Sets: (All) -Aliases: - -Required: True -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.AzLocalDiskInput - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalNicMappingObject.md b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalNicMappingObject.md deleted file mode 100644 index cc24799c603e..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalNicMappingObject.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratelocalnicmappingobject -schema: 2.0.0 ---- - -# New-AzMigrateLocalNicMappingObject - -## SYNOPSIS -Creates an object to update NIC properties of a replicating server. - -## SYNTAX - -``` -New-AzMigrateLocalNicMappingObject -NicID [-CreateAtTarget ] - [-TargetTestVirtualSwitchId ] [-TargetVirtualSwitchId ] [] -``` - -## DESCRIPTION -The New-AzMigrateLocalNicMappingObject cmdlet creates a mapping of the source NIC attached to the server to be migrated. -This object is provided as an input to the Set-AzMigrateServerReplication cmdlet to update the NIC and its properties for a replicating server. - -## EXAMPLES - -### Example 1: Create NIC to migrate -```powershell -New-AzMigrateLocalNicMappingObject -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-AzMigrateLocalServerReplication and Set-AzMigrateLocalServerReplication - -## PARAMETERS - -### -CreateAtTarget -Specifies whether this Nic should be created at target. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NicID -Specifies the ID of the NIC to be updated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetVirtualSwitchId -Specifies the logical network ARM ID that the VMs will use. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.AzLocalNicInput - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalServerReplication.md b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalServerReplication.md deleted file mode 100644 index 80d24ffa4955..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalServerReplication.md +++ /dev/null @@ -1,405 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratelocalserverreplication -schema: 2.0.0 ---- - -# New-AzMigrateLocalServerReplication - -## SYNOPSIS -Starts replication for the specified server. - -## SYNTAX - -### ByIdDefaultUser (Default) -``` -New-AzMigrateLocalServerReplication -MachineId -OSDiskID -SourceApplianceName - -TargetApplianceName -TargetResourceGroupId -TargetStoragePathId - -TargetVirtualSwitchId -TargetVMName [-IsDynamicMemoryEnabled ] - [-SubscriptionId ] [-TargetTestVirtualSwitchId ] [-TargetVMCPUCore ] - [-TargetVMRam ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -### ByIdPowerUser -``` -New-AzMigrateLocalServerReplication -DiskToInclude -MachineId - -NicToInclude -SourceApplianceName -TargetApplianceName - -TargetResourceGroupId -TargetStoragePathId -TargetVMName - [-IsDynamicMemoryEnabled ] [-SubscriptionId ] [-TargetVMCPUCore ] - [-TargetVMRam ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -The New-AzMigrateLocalServerReplication cmdlet starts the replication for a particular discovered server in the Azure Migrate project. - -## EXAMPLES - -### Example 1: When there is only OS disk to migrate -```powershell -New-AzMigrateLocalServerReplication -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" -``` - -```output -ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 -AllowedAction : {} -CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails -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 : -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 -[AzLocalDiskInput[]]$DisksToInclude = @() -$OSDisk = New-AzMigrateLocalDiskMappingObject -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-AzMigrateLocalDiskMappingObject -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 - -[AzLocalNicInput[]]$NicsToInclude = @() -$Nic = New-AzMigrateLocalNicMappingObject -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-AzMigrateLocalServerReplication -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.Api20240901.JobModelCustomPropertiesAffectedObjectDetails -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 : -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 - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskToInclude -Specifies the disks on the source server to be included for replication. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.AzLocalDiskInput[] -Parameter Sets: ByIdPowerUser -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsDynamicMemoryEnabled -Specifies if RAM is dynamic or not. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MachineId -Specifies the machine ARM ID of the discovered server to be migrated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NicToInclude -Specifies the NICs on the source server to be included for replication. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.AzLocalNicInput[] -Parameter Sets: ByIdPowerUser -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OSDiskID -Specifies the operating system disk for the source server to be migrated. - -```yaml -Type: System.String -Parameter Sets: ByIdDefaultUser -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceApplianceName -Specifies the source appliance name for the AzLocal scenario. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetApplianceName -Specifies the target appliance name for the AzLocal scenario. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetResourceGroupId -Specifies the target resource group ARM ID where the migrated VM resources will reside. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetStoragePathId -Specifies the storage path ARM ID where the VMs will be stored. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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: System.String -Parameter Sets: ByIdDefaultUser -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetVirtualSwitchId -Specifies the logical network ARM ID that the VMs will use. - -```yaml -Type: System.String -Parameter Sets: ByIdDefaultUser -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetVMCPUCore -Specifies the number of CPU cores. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetVMName -Specifies the name of the VM to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetVMRam -Specifies the target RAM size in MB. - -```yaml -Type: System.Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.IJobModel - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateNicMapping.md b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateNicMapping.md deleted file mode 100644 index d7ccb819216b..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateNicMapping.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratenicmapping -schema: 2.0.0 ---- - -# New-AzMigrateNicMapping - -## SYNOPSIS -Creates an object to update NIC properties of a replicating server. - -## SYNTAX - -``` -New-AzMigrateNicMapping -NicID [-TargetNicIP ] [-TargetNicName ] - [-TargetNicSelectionType ] [-TargetNicSubnet ] [-TestNicIP ] - [-TestNicSubnet ] [] -``` - -## DESCRIPTION -The New-AzMigrateNicMapping cmdlet creates a mapping of the source NIC attached to the server to be migrated. -This object is provided as an input to the Set-AzMigrateServerReplication cmdlet to update the NIC and its properties for a replicating server. - -## EXAMPLES - -### Example 1: Create a NIC object -```powershell -New-AzMigrateNicMapping -NicID a2399354-653a-464e-a567-d30ef5467a31 -TargetNicSelectionType primary -TargetNicIP "172.17.1.17" -``` - -```output -IsPrimaryNic IsSelectedForMigration NicId TargetStaticIPAddress TargetSubnetName ------------- ---------------------- ----- --------------------- ---------------- -false false a2399354-653a-464e-a567-d30ef5467a31 -``` - -Creates a NIC update object. - -## PARAMETERS - -### -NicID -Specifies the ID of the NIC to be updated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetNicName -Specifies the name of the NIC to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetNicSelectionType -Specifies whether the NIC to be updated will be the primary, secondary or not migrated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetNicSubnet -Specifies the Subnet name for the NIC in the destination Virtual Network to which the server needs to be migrated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestNicIP -Specifies the IP within the destination test subnet to be used for the NIC. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtNicInput - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateProject.md b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateProject.md deleted file mode 100644 index acc0f929111a..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateProject.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigrateproject -schema: 2.0.0 ---- - -# New-AzMigrateProject - -## SYNOPSIS -Creates a new Migrate project. - -## SYNTAX - -``` -New-AzMigrateProject -Location -Name -ResourceGroupName [-ETag ] - [-Property ] [-SubscriptionId ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Creates a new Migrate project. - -## EXAMPLES - -### Example 1: Create (Default) -```powershell -New-AzMigrateProject -SubscriptionId xxx-xxx-xxx -ResourceGroupName kuchaturimpkocrg1 -Name kuchaturimpkocrg1pwshp14 -Location "centralus" -``` - -```output -ETag Location Name Type ----- -------- ---- ---- - centralus kuchaturimpkocrg1pwshp14 Microsoft.Migrate/MigrateProjects - -``` - -Method to create a new migrate project. - -## PARAMETERS - -### -ETag -Specifies the VMware machine name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the VMware machine name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the migrate project name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180901Preview.IMigrateProjectProperties -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -Specifies the resource group name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Specifies the subscription id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -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). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateReplicationPolicy.md b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateReplicationPolicy.md deleted file mode 100644 index e873c853e9e1..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateReplicationPolicy.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratereplicationpolicy -schema: 2.0.0 ---- - -# New-AzMigrateReplicationPolicy - -## SYNOPSIS -The operation to create a replication policy. - -## SYNTAX - -``` -New-AzMigrateReplicationPolicy -PolicyName -ResourceGroupName -ResourceName - [-SubscriptionId ] [-ProviderSpecificInput ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -The operation to create a replication policy. - -## EXAMPLES - -### Example 1: Create a replication policy -```powershell -$providerSpecificPolicy = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtPolicyCreationInput]::new() -$providerSpecificPolicy.AppConsistentFrequencyInMinute = 240 -$providerSpecificPolicy.InstanceType = "VMwareCbt" -$providerSpecificPolicy.RecoveryPointHistoryInMinute = 4320 -$providerSpecificPolicy.CrashConsistentFrequencyInMinute = 60 -New-AzMigrateReplicationPolicy -PolicyName TestPolicy -ResourceGroupName ResourceGroup -ResourceName VaultName -SubscriptionId SubscriptionId -ProviderSpecificInput $providerSpecificPolicy -``` - -```output -Location Name Type --------- ---- ---- - TestPolicy Microsoft.RecoveryServices/vaults/replicationPolicies - -``` - -Creates a policy for VmWare Cbt - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -Replication policy name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IPolicyProviderSpecificInput -Parameter Sets: (All) -Aliases: - -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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceName -The name of the recovery services vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription Id in which migrate project was created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IPolicy - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateReplicationProtectionContainerMapping.md b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateReplicationProtectionContainerMapping.md deleted file mode 100644 index 3c9e54dc8d14..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateReplicationProtectionContainerMapping.md +++ /dev/null @@ -1,278 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratereplicationprotectioncontainermapping -schema: 2.0.0 ---- - -# New-AzMigrateReplicationProtectionContainerMapping - -## SYNOPSIS -The operation to create a protection container mapping. - -## SYNTAX - -``` -New-AzMigrateReplicationProtectionContainerMapping -FabricName -MappingName - -ProtectionContainerName -ResourceGroupName -ResourceName - [-SubscriptionId ] [-PolicyId ] - [-ProviderSpecificInput ] - [-TargetProtectionContainerId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -The operation to create a protection container mapping. - -## EXAMPLES - -### Example 1: Create a mapping -```powershell -$providerSpecificInput = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtContainerMappingInput]::new() -$providerSpecificInput.InstanceType = "VMwareCbt" -$providerSpecificInput.KeyVaultId = "/subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.KeyVault/vaults/migratekv846827101" -$providerSpecificInput.KeyVaultUri = "https://migratekv846827101.vault.azure.net" -$providerSpecificInput.ServiceBusConnectionStringSecretName = "ServiceBusConnectionString" -$providerSpecificInput.StorageAccountId = "/subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Storage/storageAccounts/migrategwsa846827101" -$providerSpecificInput.StorageAccountSasSecretName = "migrategwsa846827101-gwySas" -$providerSpecificInput.TargetLocation = "centraluseuap" - -New-AzMigrateReplicationProtectionContainerMapping -FabricName "AzMigratePWSHTc8d1replicationfabric" -MappingName "containermapping" -ProtectionContainerName "AzMigratePWSHTc8d1replicationcontainer" -ResourceGroupName "azmigratepwshtestasr13072020" -ResourceName "AzMigrateTestProjectPWSH02aarsvault" -PolicyId "/subscriptionsxxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationPolicies/migrateAzMigratePWSHTc8d1sitepolicy" -ProviderSpecificInput $providerSpecificInput -TargetProtectionContainerId "Microsoft Azure" -``` - -```output -Location Name Type --------- ---- ---- - containermapping Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings -``` - -Create a mapping - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FabricName -Fabric name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MappingName -Protection container mapping name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyId -Applicable policy. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectionContainerName -Protection container name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProviderSpecificInput -Provider specific input for pairing. -To construct, see NOTES section for PROVIDERSPECIFICINPUT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IReplicationProviderSpecificContainerMappingInput -Parameter Sets: (All) -Aliases: - -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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceName -The name of the recovery services vault. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription Id in which migrate project was created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetProtectionContainerId -The target unique protection container name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IProtectionContainerMapping - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateServerReplication.md b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateServerReplication.md deleted file mode 100644 index 8520a25013bf..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateServerReplication.md +++ /dev/null @@ -1,642 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigrateserverreplication -schema: 2.0.0 ---- - -# New-AzMigrateServerReplication - -## SYNOPSIS -Starts replication for the specified server. - -## SYNTAX - -### ByIdDefaultUser (Default) -``` -New-AzMigrateServerReplication -DiskType -LicenseType -MachineId -OSDiskID - -TargetNetworkId -TargetResourceGroupId -TargetSubnetName -TargetVMName - [-DiskEncryptionSetID ] [-DiskTag ] - [-LinuxLicenseType ] [-NicTag ] - [-PerformAutoResync ] [-SqlServerLicenseType ] [-SubscriptionId ] [-Tag ] - [-TargetAvailabilitySet ] [-TargetAvailabilityZone ] - [-TargetBootDiagnosticsStorageAccount ] [-TargetCapacityReservationGroupId ] - [-TargetSecurityType ] [-TargetVMSecureBootEnabled ] [-TargetVMSize ] - [-TestNetworkId ] [-TestSubnetName ] [-VMTag ] - [-VMWarerunasaccountID ] [-DefaultProfile ] [] -``` - -### ByIdPowerUser -``` -New-AzMigrateServerReplication -DiskToInclude -LicenseType - -MachineId -TargetNetworkId -TargetResourceGroupId -TargetSubnetName - -TargetVMName [-DiskTag ] [-LinuxLicenseType ] - [-NicTag ] [-PerformAutoResync ] - [-SqlServerLicenseType ] [-SubscriptionId ] [-Tag ] - [-TargetAvailabilitySet ] [-TargetAvailabilityZone ] - [-TargetBootDiagnosticsStorageAccount ] [-TargetCapacityReservationGroupId ] - [-TargetSecurityType ] [-TargetVMSecureBootEnabled ] [-TargetVMSize ] - [-TestNetworkId ] [-TestSubnetName ] [-VMTag ] - [-VMWarerunasaccountID ] [-DefaultProfile ] [] -``` - -### ByInputObjectDefaultUser -``` -New-AzMigrateServerReplication -DiskType -InputObject -LicenseType - -OSDiskID -TargetNetworkId -TargetResourceGroupId -TargetSubnetName - -TargetVMName [-DiskEncryptionSetID ] - [-DiskTag ] [-LinuxLicenseType ] - [-NicTag ] [-PerformAutoResync ] - [-SqlServerLicenseType ] [-SubscriptionId ] [-Tag ] - [-TargetAvailabilitySet ] [-TargetAvailabilityZone ] - [-TargetBootDiagnosticsStorageAccount ] [-TargetCapacityReservationGroupId ] - [-TargetSecurityType ] [-TargetVMSecureBootEnabled ] [-TargetVMSize ] - [-TestNetworkId ] [-TestSubnetName ] [-VMTag ] - [-VMWarerunasaccountID ] [-DefaultProfile ] [] -``` - -### ByInputObjectPowerUser -``` -New-AzMigrateServerReplication -DiskToInclude -InputObject - -LicenseType -TargetNetworkId -TargetResourceGroupId -TargetSubnetName - -TargetVMName [-DiskTag ] [-LinuxLicenseType ] - [-NicTag ] [-PerformAutoResync ] - [-SqlServerLicenseType ] [-SubscriptionId ] [-Tag ] - [-TargetAvailabilitySet ] [-TargetAvailabilityZone ] - [-TargetBootDiagnosticsStorageAccount ] [-TargetCapacityReservationGroupId ] - [-TargetSecurityType ] [-TargetVMSecureBootEnabled ] [-TargetVMSize ] - [-TestNetworkId ] [-TestSubnetName ] [-VMTag ] - [-VMWarerunasaccountID ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The New-AzMigrateServerReplication cmdlet starts the replication for a particular discovered server in the Azure Migrate project. - -## EXAMPLES - -### Example 1: When there is only OS disk -```powershell -New-AzMigrateServerReplication -MachineId "/subscriptions/xxx-xxx-xxx4/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.OffAzure/VMwareSites/AzMigratePWSHTc8d1site/machines/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f" -LicenseType NoLicenseType -TargetResourceGroupId "/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG" -TargetNetworkId "/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG/providers/Microsoft.Network/virtualNetworks/AzMigrateTargetNetwork" -TargetSubnetName default -TargetVMName "prsadhu-TestVM" -DiskType "Standard_LRS" -OSDiskID "6000C299-343d-7bcd-c05e-a94bd63316dd" -``` - -```output -ActivityId : 68af14b4-46ae-48d1-b3e9-cdcffb9e8a93 ActivityId: 74d1a396-1d37-4264-8a5b-b727aaef0171 -AllowedAction : {} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails -CustomDetailInstanceType : AsrJobDetails -EndTime : 9/16/20 11:57:33 AM -Error : {} -FriendlyName : Enable -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover - yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/997e2a92-5afe-49c7-a81a-89660aec9b7b -Location : -Name : 997e2a92-5afe-49c7-a81a-89660aec9b7b -ScenarioName : Enable -StartTime : 9/16/20 11:57:32 AM -State : Succeeded -StateDescription : Completed -TargetInstanceType : ProtectionProfile -TargetObjectId : 42752b89-5fad-52fd-bf93-679fbdb6fed9 -TargetObjectName : migrateAzMigratePWSHTc8d1sitepolicy -Task : {CloudPairingPrerequisitesCheck, CloudPairingPrepareSite} -Type : Microsoft.RecoveryServices/vaults/replicationJobs -``` - -This is for the scenario, when there is only one single disk that has to be protected. - -### Example 2: When there are multiple disks -```powershell -$OSDisk = New-AzMigrateDiskMapping -DiskID '6000C299-343d-7bcd-c05e-a94bd63316dd' -DiskType 'Standard_LRS' -IsOSDisk 'true' -$DataDisk = New-AzMigrateDiskMapping -DiskID '7000C299-343d-7bcd-c05e-a94bd63316dd' -DiskType 'Standard_LRS' -IsOSDisk 'false' -$DisksToInclude = @() -$DisksToInclude += $OSDisk -$DisksToInclude += $DataDisk -New-AzMigrateServerReplication -MachineId "/subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.OffAzure/VMwareSites/AzMigratePWSHTc8d1site/machines/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f" -LicenseType NoLicenseType -TargetResourceGroupId "/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG" -TargetNetworkId "/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG/providers/Microsoft.Network/virtualNetworks/AzMigrateTargetNetwork" -TargetSubnetName default -TargetVMName "prsadhu-TestVM" -DiskToInclude $DisksToInclude -PerformAutoResync true -``` - -```output -ActivityId : 68af14b4-46ae-48d1-b3e9-cdcffb9e8a93 ActivityId: 74d1a396-1d37-4264-8a5b-b727aaef0171 -AllowedAction : {} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails -CustomDetailInstanceType : AsrJobDetails -EndTime : 9/16/20 11:57:33 AM -Error : {} -FriendlyName : Enable -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover - yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/997e2a92-5afe-49c7-a81a-89660aec9b7b -Location : -Name : 997e2a92-5afe-49c7-a81a-89660aec9b7b -ScenarioName : Enable -StartTime : 9/16/20 11:57:32 AM -State : Succeeded -StateDescription : Completed -TargetInstanceType : ProtectionProfile -TargetObjectId : 42752b89-5fad-52fd-bf93-679fbdb6fed9 -TargetObjectName : migrateAzMigratePWSHTc8d1sitepolicy -Task : {CloudPairingPrerequisitesCheck, CloudPairingPrepareSite} -Type : Microsoft.RecoveryServices/vaults/replicationJobs -``` - -This is for the scenario, when there are multiple disks that has to be protected. - -### Example 3: With Trusted Launch security type -```powershell -New-AzMigrateServerReplication -MachineId "/subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.OffAzure/VMwareSites/AzMigratePWSHTc8d1site/machines/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f" -LicenseType NoLicenseType -TargetResourceGroupId "/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG" -TargetNetworkId "/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG/providers/Microsoft.Network/virtualNetworks/AzMigrateTargetNetwork" -TargetSubnetName default -TargetVMName "prsadhu-TestVM" -DiskType "Standard_LRS" -OSDiskID "6000C299-343d-7bcd-c05e-a94bd63316dd" -TargetSecurityType "TrustedLaunch" -TargetVMSecureBootEnabled $true -``` - -```output -ActivityId : 68af14b4-46ae-48d1-b3e9-cdcffb9e8a93 ActivityId: 74d1a396-1d37-4264-8a5b-b727aaef0171 -AllowedAction : {} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails -CustomDetailInstanceType : AsrJobDetails -EndTime : 9/16/20 11:57:33 AM -Error : {} -FriendlyName : Enable -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover - yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/997e2a92-5afe-49c7-a81a-89660aec9b7b -Location : -Name : 997e2a92-5afe-49c7-a81a-89660aec9b7b -ScenarioName : Enable -StartTime : 9/16/20 11:57:32 AM -State : Succeeded -StateDescription : Completed -TargetInstanceType : ProtectionProfile -TargetObjectId : 42752b89-5fad-52fd-bf93-679fbdb6fed9 -TargetObjectName : migrateAzMigratePWSHTc8d1sitepolicy -Task : {CloudPairingPrerequisitesCheck, CloudPairingPrepareSite} -Type : Microsoft.RecoveryServices/vaults/replicationJobs -``` - -This is for the scenario when replication is started with TrustedLaunch security type and secure boot enabled on the target Azure VM. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskEncryptionSetID -Specifies the disk encryption set to be used. - -```yaml -Type: System.String -Parameter Sets: ByIdDefaultUser, ByInputObjectDefaultUser -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskTag -Specifies the tag to be used for disk creation. -To construct, see NOTES section for DISKTAG properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtEnableMigrationInputTargetDiskTags -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskToInclude -Specifies the disks on the source server to be included for replication. -To construct, see NOTES section for DISKTOINCLUDE properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtDiskInput[] -Parameter Sets: ByIdPowerUser, ByInputObjectPowerUser -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskType -Specifies the type of disks to be used for the Azure VM. - -```yaml -Type: System.String -Parameter Sets: ByIdDefaultUser, ByInputObjectDefaultUser -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the discovered server to be migrated. -The server object can be retrieved using the Get-AzMigrateServer cmdlet. -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202001.IVMwareMachine -Parameter Sets: ByInputObjectDefaultUser, ByInputObjectPowerUser -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LicenseType -Specifies if Azure Hybrid benefit is applicable for the source server to be migrated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinuxLicenseType -Specifies if Azure Hybrid benefit is applicable for the source linux server to be migrated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MachineId -Specifies the machine ID of the discovered server to be migrated. - -```yaml -Type: System.String -Parameter Sets: ByIdDefaultUser, ByIdPowerUser -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NicTag -Specifies the tag to be used for NIC creation. -To construct, see NOTES section for NICTAG properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtEnableMigrationInputTargetNicTags -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OSDiskID -Specifies the Operating System disk for the source server to be migrated. - -```yaml -Type: System.String -Parameter Sets: ByIdDefaultUser, ByInputObjectDefaultUser -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PerformAutoResync -Specifies if replication be auto-repaired in case change tracking is lost for the source server under replication. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Specifies the tag to be used for Resource creation. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetAvailabilitySet -Specifies the Availability Set to be used for VM creationSpecifies the Availability Set to be used for VM creation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetAvailabilityZone -Specifies the Availability Zone to be used for VM creation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetBootDiagnosticsStorageAccount -Specifies the storage account to be used for boot diagnostics. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetCapacityReservationGroupId -Specifies the Target Capacity Reservation Group Id within the destination Azure subscription. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetNetworkId -Specifies the Virtual Network id within the destination Azure subscription to which the server needs to be migrated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetResourceGroupId -Specifies the Resource Group id within the destination Azure subscription to which the server needs to be migrated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetSecurityType -Specifies the security type for the Azure VM. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetSubnetName -Specifies the Subnet name within the destination Virtual Network to which the server needs to be migrated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetVMName -Specifies the name of the Azure VM to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetVMSecureBootEnabled -Specifies if secure boot needs to be enabled on target VM. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetVMSize -Specifies the SKU of the Azure VM to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestNetworkId -Specifies the Virtual Network id within the destination Azure subscription to which the server needs to be test migrated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestSubnetName -Specifies the Subnet name within the destination Virtual Network to which the server needs to be test migrated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMTag -Specifies the tag to be used for VM creation. -To construct, see NOTES section for VMTAG properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtEnableMigrationInputTargetVmtags -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMWarerunasaccountID -Account id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateTestNicMapping.md b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateTestNicMapping.md deleted file mode 100644 index 64914330c25b..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateTestNicMapping.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratetestnicmapping -schema: 2.0.0 ---- - -# New-AzMigrateTestNicMapping - -## SYNOPSIS -Creates an object to update NIC properties of a test migrating server. - -## SYNTAX - -``` -New-AzMigrateTestNicMapping -NicID -TestNicSubnet [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -The New-AzMigrateTestNicMapping cmdlet creates a mapping of the source NIC attached to the server to be test migrated. -This object is provided as an input to the Start-AzMigrateTestMigration cmdlet to update the NIC and its properties for a test migrating server. - -## EXAMPLES - -### Example 1: Create a NIC object for test migration. -```powershell -New-AzMigrateTestNicMapping -NicID a2399354-653a-464e-a567-d30ef5467a31 -TestNicSubnet subnet1 -``` - -```output -IsPrimaryNic IsSelectedForMigration NicId TargetNicName TargetStaticIPAddress TargetSubnetName TestStaticIPAddress TestSubnetName ------------- ---------------------- ----- ------------- --------------------- ---------------- ------------------- -------------- - a2399354-653a-464e-a567-d30ef5467a31 subnet1 -``` - -Creates a NIC object for test migration. - -## PARAMETERS - -### -NicID -Specifies the ID of the NIC to be updated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtNicInput - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/README.md b/src/Migrate/Migrate.Autorest/docs/README.md index 888608999710..c166cf748460 100644 --- a/src/Migrate/Migrate.Autorest/docs/README.md +++ b/src/Migrate/Migrate.Autorest/docs/README.md @@ -1,5 +1,5 @@ # Docs -This directory contains the documentation of the cmdlets for the `Az.Migrate` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overridden on regeneration*. To update documentation examples, please use the `..\examples` folder. +This directory contains the documentation of the cmdlets for the `Az.Migrate` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overridden on regeneration*. To update documentation examples, please use the `../examples` folder. ## Info - Modifiable: no @@ -8,4 +8,4 @@ This directory contains the documentation of the cmdlets for the `Az.Migrate` mo - Packaged: yes ## Details -The process of documentation generation loads `Az.Migrate` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `..\exports` folder. Additionally, when writing custom cmdlets in the `..\custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `..\examples` folder. \ No newline at end of file +The process of documentation generation loads `Az.Migrate` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `../exports` folder. Additionally, when writing custom cmdlets in the `../custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `../examples` folder. \ No newline at end of file diff --git a/src/Migrate/Migrate.Autorest/docs/Register-AzMigrateProjectTool.md b/src/Migrate/Migrate.Autorest/docs/Register-AzMigrateProjectTool.md deleted file mode 100644 index c326e5a34428..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Register-AzMigrateProjectTool.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/register-azmigrateprojecttool -schema: 2.0.0 ---- - -# Register-AzMigrateProjectTool - -## SYNOPSIS -Registers a tool with the migrate project. - -## SYNTAX - -``` -Register-AzMigrateProjectTool -MigrateProjectName -ResourceGroupName - [-SubscriptionId ] [-AcceptLanguage ] [-Tool ] [-DefaultProfile ] - [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Registers a tool with the migrate project. - -## EXAMPLES - -### Example 1: REgister tool. -```powershell -Register-AzMigrateProjectTool -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -MigrateProjectName BugBashAVSVMware -Tool Zerto -``` - -```output -True -``` - -Registers a tool with the migrate project. - -## PARAMETERS - -### -AcceptLanguage -Standard request header. -Used by service to respond to client in appropriate language. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrateProjectName -Name of the Azure Migrate project. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription Id in which migrate project was created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tool -Gets or sets the tool to be registered. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -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). - -## INPUTS - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateLocalServerReplication.md b/src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateLocalServerReplication.md deleted file mode 100644 index fe693b37e81a..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateLocalServerReplication.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/remove-azmigratelocalserverreplication -schema: 2.0.0 ---- - -# Remove-AzMigrateLocalServerReplication - -## SYNOPSIS -Stops replication for the migrated server. - -## SYNTAX - -### ByID (Default) -``` -Remove-AzMigrateLocalServerReplication -TargetObjectID [-SubscriptionId ] - [-ForceRemove ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -### ByInputObject -``` -Remove-AzMigrateLocalServerReplication -InputObject [-SubscriptionId ] - [-ForceRemove ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -The Remove-AzMigrateLocalServerReplication cmdlet stops the replication for a migrated server. - -## EXAMPLES - -### Example 1: Remove replication by Id -```powershell -Remove-AzMigrateLocalServerReplication -TargetObjectID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/protectedItems/0ec082d5-6827-457a-bae2-f986e1b94851" -``` - -```output -ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 -AllowedAction : {Cancel} -CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails -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 : -TargetFabricProviderId : 22f00372-a1b7-467f-87ce-d95e17a6e7c7 -Task : {Prerequisite check, Deleting protected item} -Type : Microsoft.DataReplication/replicationVaults/jobs -``` - -Remove AzLocal replication by Id. - -### Example 2: Remove replication by input object -```powershell -$InputObject = Get-AzMigrateLocalServerReplication -TargetObjectID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/protectedItems/0ec082d5-6827-457a-bae2-f986e1b94851" - -Remove-AzMigrateLocalServerReplication -InputObject $InputObject - -$InputObject | Remove-AzMigrateLocalServerReplication -``` - -```output -ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 -AllowedAction : {Cancel} -CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails -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 : -TargetFabricProviderId : 22f00372-a1b7-467f-87ce-d95e17a6e7c7 -Task : {Prerequisite check, Deleting protected item} -Type : Microsoft.DataReplication/replicationVaults/jobs -``` - -Remove AzLocal replication by replication input object. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceRemove -Specifies whether the replication needs to be force removed. -Default to "false". - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the replicating server for which the replication needs to be disabled. -The server object can be retrieved using the Get-AzMigrateLocalServerReplication cmdlet. -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetObjectID -Specifies the replcating server for which the replication needs to be disabled. -The ID should be retrieved using the Get-AzMigrateLocalServerReplication cmdlet. - -```yaml -Type: System.String -Parameter Sets: ByID -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -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). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.IJobModel - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateProject.md b/src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateProject.md deleted file mode 100644 index 2ea0719f91f3..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateProject.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/remove-azmigrateproject -schema: 2.0.0 ---- - -# Remove-AzMigrateProject - -## SYNOPSIS -Delete the migrate project. -Deleting non-existent project is a no-operation. - -## SYNTAX - -``` -Remove-AzMigrateProject -Name -ResourceGroupName [-SubscriptionId ] - [-AcceptLanguage ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Delete the migrate project. -Deleting non-existent project is a no-operation. - -## EXAMPLES - -### Example 1: Delete (Default) -```powershell -Remove-AzMigrateProject -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -Name BugBashAVSVMware -``` - -Delete the migrate project. -Deleting non-existent project is a no-operation. - -## PARAMETERS - -### -AcceptLanguage -Standard request header. -Used by service to respond to client in appropriate language. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the Azure Migrate project. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: MigrateProjectName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription Id in which migrate project was created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -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). - -## INPUTS - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateServerReplication.md b/src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateServerReplication.md deleted file mode 100644 index ef53d1e85f6a..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateServerReplication.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/remove-azmigrateserverreplication -schema: 2.0.0 ---- - -# Remove-AzMigrateServerReplication - -## SYNOPSIS -Stops replication for the migrated server. - -## SYNTAX - -### ByIDVMwareCbt (Default) -``` -Remove-AzMigrateServerReplication -TargetObjectID [-SubscriptionId ] [-ForceRemove ] - [-DefaultProfile ] [] -``` - -### ByInputObjectVMwareCbt -``` -Remove-AzMigrateServerReplication -InputObject [-SubscriptionId ] - [-ForceRemove ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -The Remove-AzMigrateServerReplication cmdlet stops the replication for a migrated server. - -## EXAMPLES - -### Example 1: Remove by id. -```powershell -Remove-AzMigrateServerReplication -TargetObjectID "/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f" -``` - -```output -ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 -AllowedAction : {Cancel} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails -CustomDetailInstanceType : AsrJobDetails -EndTime : -Error : {} -FriendlyName : Disable -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover - yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab -Location : -Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab -ScenarioName : Disable -StartTime : 9/25/20 9:20:08 PM -State : InProgress -StateDescription : InProgress -TargetInstanceType : ProtectionEntity -TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 -TargetObjectName : prsadhu-TestVM -Task : {DisableProtectionOnPrimary, UpdateDraState} -Type : Microsoft.RecoveryServices/vaults/replicationJobs - -``` - -Resync by id. - -### Example 2: Remove by Input Object -```powershell -$obj = Get-AzMigrateServerReplication -TargetObjectID "/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f" -Remove-AzMigrateServerReplication -InputObject $obj -``` - -```output -ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 -AllowedAction : {Cancel} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails -CustomDetailInstanceType : AsrJobDetails -EndTime : -Error : {} -FriendlyName : Disable -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover - yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab -Location : -Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab -ScenarioName : Disable -StartTime : 9/25/20 9:20:08 PM -State : InProgress -StateDescription : InProgress -TargetInstanceType : ProtectionEntity -TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 -TargetObjectName : prsadhu-TestVM -Task : {DisableProtectionOnPrimary, UpdateDraState} -Type : Microsoft.RecoveryServices/vaults/replicationJobs -``` - -By name. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceRemove -Specifies whether the replication needs to be force removed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -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 -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IMigrationItem -Parameter Sets: ByInputObjectVMwareCbt -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetObjectID -Specifies the replcating server for which the replication needs to be disabled. -The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. - -```yaml -Type: System.String -Parameter Sets: ByIDVMwareCbt -Aliases: - -Required: True -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Restart-AzMigrateServerReplication.md b/src/Migrate/Migrate.Autorest/docs/Restart-AzMigrateServerReplication.md deleted file mode 100644 index 87a8ce9efd06..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Restart-AzMigrateServerReplication.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/restart-azmigrateserverreplication -schema: 2.0.0 ---- - -# Restart-AzMigrateServerReplication - -## SYNOPSIS -Restarts the replication for specified server. - -## SYNTAX - -### ByIDVMwareCbt (Default) -``` -Restart-AzMigrateServerReplication -TargetObjectID [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### ByInputObjectVMwareCbt -``` -Restart-AzMigrateServerReplication -InputObject [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The Restart-AzMigrateServerReplication cmdlet repairs the replication for the specified server. - -## EXAMPLES - -### Example 1: By id. -```powershell -Restart-AzMigrateServerReplication -TargetObjectID "/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f" -``` - -```output -ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 -AllowedAction : {Cancel} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails -CustomDetailInstanceType : AsrJobDetails -EndTime : -Error : {} -FriendlyName : Restart -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover - yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab -Location : -Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab -ScenarioName : Restart -StartTime : 9/25/20 9:20:08 PM -State : InProgress -StateDescription : InProgress -TargetInstanceType : ProtectionEntity -TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 -TargetObjectName : prsadhu-TestVM -Task : {DisableProtectionOnPrimary, UpdateDraState} -Type : Microsoft.RecoveryServices/vaults/replicationJobs -``` - -By id. - -### Example 2: By Input Object -```powershell -$obj = Get-AzMigrateServerReplication -TargetObjectID "/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f" -$output = Restart-AzMigrateServerReplication -InputObject $obj -``` - -```output -ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 -AllowedAction : {Cancel} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails -CustomDetailInstanceType : AsrJobDetails -EndTime : -Error : {} -FriendlyName : Restart -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover - yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab -Location : -Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab -ScenarioName : Restart -StartTime : 9/25/20 9:20:08 PM -State : InProgress -StateDescription : InProgress -TargetInstanceType : ProtectionEntity -TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 -TargetObjectName : prsadhu-TestVM -Task : {DisableProtectionOnPrimary, UpdateDraState} -Type : Microsoft.RecoveryServices/vaults/replicationJobs -``` - -By Input Object. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the machine object of the replicating server. -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IMigrationItem -Parameter Sets: ByInputObjectVMwareCbt -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetObjectID -Specifies the replcating server for which the resync needs to be initiated. -The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. - -```yaml -Type: System.String -Parameter Sets: ByIDVMwareCbt -Aliases: - -Required: True -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Resume-AzMigrateServerReplication.md b/src/Migrate/Migrate.Autorest/docs/Resume-AzMigrateServerReplication.md deleted file mode 100644 index 968c1e372483..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Resume-AzMigrateServerReplication.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/resume-azmigrateserverreplication -schema: 2.0.0 ---- - -# Resume-AzMigrateServerReplication - -## SYNOPSIS -Starts the replication that has been suspended. - -## SYNTAX - -### ByIDVMwareCbt (Default) -``` -Resume-AzMigrateServerReplication -TargetObjectID [-DeleteMigratedResource] - [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -### ByInputObjectVMwareCbt -``` -Resume-AzMigrateServerReplication -InputObject [-DeleteMigratedResource] - [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -The Resume-AzMigrateServerReplication starts the replication that has been suspended. - -## EXAMPLES - -### Example 1: By machine id. -```powershell -Resume-AzMigrateServerReplication -TargetObjectID "/Subscriptions/xxx-xxx-xxxxxx-xxx-xxx/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoffccyapp3352vault/replicationFabrics/signoffccyappae52replicationfabric/replicationProtectionContainers/signoffccyappae52replicationcontainer/replicationMigrationItems/idclab-vcen67-fareast-corp-micr-0f144e99-ba36-4649-b92b-8b06854aa539_5015f6d8-fc84-afdf-de47-1eab79330f00" -``` - -```output -ActivityId : 0b810233-b0aa-4a4c-a44e-bea4589c0513 ActivityId: ccb4889b-b9ec-4a76-af4d-4eb59c76ebac -AllowedAction : {} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.JobDetailsAffectedObjectDetails -CustomDetailInstanceType : AsrJobDetails -EndTime : -Error : {} -FriendlyName : -Id : /Subscriptions/xxx-xxx-xxxxxx-xxx-xxx/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoff - ccyapp3352vault/replicationJobs/75a6945d-2276-4dbb-926c-d0745e004130 -Location : -Name : 75a6945d-2276-4dbb-926c-d0745e004130 -ScenarioName : -StartTime : -State : NotStarted -StateDescription : NotStarted -TargetInstanceType : ProtectionEntity -TargetObjectId : -TargetObjectName : -Task : {} -Type : Microsoft.RecoveryServices/vaults/replicationJobs -``` - -By machine id. - -### Example 2: By input object -```powershell -$obj = Get-AzMigrateServerReplication -ProjectName "signoffccyproj" -ResourceGroupName "cbtsignoff2201rg" -MachineName "Win2k16" -Resume-AzMigrateServerReplication -InputObject $obj -``` - -```output -ActivityId : 0b810233-b0aa-4a4c-a44e-bea4589c0513 ActivityId: ccb4889b-b9ec-4a76-af4d-4eb59c76ebac -AllowedAction : {} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.JobDetailsAffectedObjectDetails -CustomDetailInstanceType : AsrJobDetails -EndTime : -Error : {} -FriendlyName : -Id : /Subscriptions/xxx-xxx-xxxxxx-xxx-xxx/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoff - ccyapp3352vault/replicationJobs/75a6945d-2276-4dbb-926c-d0745e004130 -Location : -Name : 75a6945d-2276-4dbb-926c-d0745e004130 -ScenarioName : -StartTime : -State : NotStarted -StateDescription : NotStarted -TargetInstanceType : ProtectionEntity -TargetObjectId : -TargetObjectName : -Task : {} -Type : Microsoft.RecoveryServices/vaults/replicationJobs -``` - -By input object. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteMigratedResource -Specifies whether the migrated resources needs to be deleted. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IMigrationItem -Parameter Sets: ByInputObjectVMwareCbt -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetObjectID -Specifies the replicating server for which the resume replication needs to be initiated. -The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. - -```yaml -Type: System.String -Parameter Sets: ByIDVMwareCbt -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Set-AzMigrateDiskMapping.md b/src/Migrate/Migrate.Autorest/docs/Set-AzMigrateDiskMapping.md deleted file mode 100644 index c43c50fd4b96..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Set-AzMigrateDiskMapping.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/set-azmigratediskmapping -schema: 2.0.0 ---- - -# Set-AzMigrateDiskMapping - -## SYNOPSIS -Updates disk mapping - -## SYNTAX - -``` -Set-AzMigrateDiskMapping -DiskID [-DiskName ] [-IsOSDisk ] [] -``` - -## DESCRIPTION -The Set-AzMigrateDiskMapping cmdlet updates a mapping of the source disk attached to the server to be migrated - -## EXAMPLES - -### Example 1: Make disks -```powershell -Set-AzMigrateDiskMapping -DiskID "6000C294-1217-dec3-bc18-81f117220424" -DiskName "ContosoDisk_1" -IsOSDisk "True" -``` - -```output -DiskId IsOSDisk TargetDiskName ------- -------- -------------- -6000C294-1217-dec3-bc18-81f117220424 True ContosoDisk_1 -``` - -Get disks object to provide input for Set-AzMigrateServerReplication - -## PARAMETERS - -### -DiskID -Specifies the disk ID of the disk attached to the discovered server to be migrated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskName -Specifies the name of the managed disk to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsOSDisk -Specifies whether the disk contains the Operating System for the source server to be migrated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtUpdateDiskInput - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Set-AzMigrateLocalServerReplication.md b/src/Migrate/Migrate.Autorest/docs/Set-AzMigrateLocalServerReplication.md deleted file mode 100644 index 10df4e66133d..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Set-AzMigrateLocalServerReplication.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/set-azmigratelocalserverreplication -schema: 2.0.0 ---- - -# Set-AzMigrateLocalServerReplication - -## SYNOPSIS -Updates the target properties for the replicating server. - -## SYNTAX - -``` -Set-AzMigrateLocalServerReplication -TargetObjectID - [-DynamicMemoryConfig ] [-IsDynamicMemoryEnabled ] - [-NicToInclude ] [-OsType ] [-SubscriptionId ] [-TargetVMCPUCore ] - [-TargetVMRam ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -The Set-AzMigrateLocalServerReplication cmdlet updates the target properties for the replicating server. - -## EXAMPLES - -### Example 1: Update dynamic memory configuration -```powershell -$memoryConfig = [PSCustomObject]@{ - MinimumMemoryInMegaByte = 1024 - MaximumMemoryInMegaByte = 34816 - TargetMemoryBufferPercentage = 20 -} - -Set-AzMigrateLocalServerReplication -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.Api20240901.JobModelCustomPropertiesAffectedObjectDetails -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 : -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 - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DynamicMemoryConfig -Specifies the dynamic memory configuration of RAM. -To construct, see NOTES section for DYNAMICMEMORYCONFIG properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.ProtectedItemDynamicMemoryConfig -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsDynamicMemoryEnabled -Specifies if RAM is dynamic or not. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NicToInclude -Specifies the nics on the source server to be included for replication. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.AzLocalNicInput[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OsType -Specifies the OS type of the VM, either WindowsGuest or LinuxGuest. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The subscription Id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetObjectID -Specifies the replicating server for which the properties need to be updated. -The ID should be retrieved using the Get-AzMigrateLocalServerReplication cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetVMCPUCore -Specifies the number of CPU cores. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetVMRam -Specifies the target RAM size in MB. - -```yaml -Type: System.Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.IJobModel - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Set-AzMigrateServerReplication.md b/src/Migrate/Migrate.Autorest/docs/Set-AzMigrateServerReplication.md deleted file mode 100644 index db35b330bb87..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Set-AzMigrateServerReplication.md +++ /dev/null @@ -1,528 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/set-azmigrateserverreplication -schema: 2.0.0 ---- - -# Set-AzMigrateServerReplication - -## SYNOPSIS -Updates the target properties for the replicating server. - -## SYNTAX - -### ByIDVMwareCbt (Default) -``` -Set-AzMigrateServerReplication -TargetObjectID [-DiskToUpdate ] - [-LinuxLicenseType ] [-NicToUpdate ] [-SqlServerLicenseType ] - [-SubscriptionId ] [-TargetAvailabilitySet ] [-TargetAvailabilityZone ] - [-TargetBootDiagnosticsStorageAccount ] [-TargetCapacityReservationGroupId ] - [-TargetDiskName ] [-TargetNetworkId ] [-TargetResourceGroupID ] - [-TargetVMName ] [-TargetVMSize ] [-TestNetworkId ] - [-UpdateDiskTag ] [-UpdateDiskTagOperation ] - [-UpdateNicTag ] [-UpdateNicTagOperation ] - [-UpdateTag ] [-UpdateTagOperation ] - [-UpdateVMTag ] [-UpdateVMTagOperation ] - [-DefaultProfile ] [] -``` - -### ByInputObjectVMwareCbt -``` -Set-AzMigrateServerReplication -InputObject [-DiskToUpdate ] - [-LinuxLicenseType ] [-NicToUpdate ] [-SqlServerLicenseType ] - [-SubscriptionId ] [-TargetAvailabilitySet ] [-TargetAvailabilityZone ] - [-TargetBootDiagnosticsStorageAccount ] [-TargetCapacityReservationGroupId ] - [-TargetDiskName ] [-TargetNetworkId ] [-TargetResourceGroupID ] - [-TargetVMName ] [-TargetVMSize ] [-TestNetworkId ] - [-UpdateDiskTag ] [-UpdateDiskTagOperation ] - [-UpdateNicTag ] [-UpdateNicTagOperation ] - [-UpdateTag ] [-UpdateTagOperation ] - [-UpdateVMTag ] [-UpdateVMTagOperation ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The Set-AzMigrateServerReplication cmdlet updates the target properties for the replicating server. - -## EXAMPLES - -### Example 1: Update by id -```powershell -Set-AzMigrateServerReplication -TargetObjectID '/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_500f44f8-2aa3-587b-8958-ead358639629' -TargetVMName 'rb-w2k12r2-1' -``` - -```output -ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 -AllowedAction : {Cancel} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails -CustomDetailInstanceType : AsrJobDetails -EndTime : -Error : {} -FriendlyName : Update -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover - yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab -Location : -Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab -ScenarioName : Update -StartTime : 9/25/20 9:20:08 PM -State : InProgress -StateDescription : InProgress -TargetInstanceType : ProtectionEntity -TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 -TargetObjectName : prsadhu-TestVM -Task : {DisableProtectionOnPrimary, UpdateDraState} -Type : Microsoft.RecoveryServices/vaults/replicationJobs -``` - -By id. - -### Example 2: Update multiple disk names by id -```powershell -$OSDisk = Set-AzMigrateDiskMapping -DiskID "6000C294-1217-dec3-bc18-81f117220424" -DiskName "ContosoDisk_1" -$DataDisk = Set-AzMigrateDiskMapping -DiskID "6000C292-79b9-bbdc-fb8a-f1fa8dbeff84" -DiskName "ContosoDisk_2" -$DiskMapping = $OSDisk, $DataDisk -Set-AzMigrateServerReplication -TargetObjectId "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/cbtsignoff2105srcrg/providers/Microsoft.RecoveryServices/vaults/signoff2105app1452vault/replicationFabrics/signoff2105app1c36replicationfabric/replicationProtectionContainers/signoff2105app1c36replicationcontainer/replicationMigrationItems/idclab-vcen67-fareast-corp-micr-6f5e3b29-29ad-4e62-abbd-6cd33c4183ef_5015f6d8-fc84-afdf-de47-1eab79330f00" -DiskToUpdate $DiskMapping -``` - -```output -ActivityId : c533d88d-2211-43c6-b615-7b46876d8882 ActivityId: de18df8b-8d43-4249-8989-846d33a124f6 -AllowedAction : {} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210210.JobDetailsAffectedObje - ctDetails -CustomDetailInstanceType : AsrJobDetails -EndTime : -Error : {} -FriendlyName : Update the virtual machine -Id : /Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/cbtsignoff2105src - rg/providers/Microsoft.RecoveryServices/vaults/signoff2105app1452vault/replicationJo - bs/6ec1cca6-87c7-4f14-9657-bd0469c02fcd -Location : -Name : 6ec1cca6-87c7-4f14-9657-bd0469c02fcd -ScenarioName : UpdateVmProperties -StartTime : 8/30/2021 7:08:51 AM -State : InProgress -StateDescription : InProgress -TargetInstanceType : ProtectionEntity -TargetObjectId : f3aa6bd4-1b60-52bb-b12d-e850f8d8f13c -TargetObjectName : Win2k16 -Task : {UpdateVmPropertiesTask} -Type : Microsoft.RecoveryServices/vaults/replicationJobs -``` - -Updating disk name by id. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskToUpdate -Updates the disk for the Azure VM to be created. -To construct, see NOTES section for DISKTOUPDATE properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtUpdateDiskInput[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the replicating server for which the properties need to be updated. -The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet. -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IMigrationItem -Parameter Sets: ByInputObjectVMwareCbt -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LinuxLicenseType -Specifies if Azure Hybrid benefit is applicable for the source linux server to be migrated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NicToUpdate -Updates the NIC for the Azure VM to be created. -To construct, see NOTES section for NICTOUPDATE properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtNicInput[] -Parameter Sets: (All) -Aliases: - -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. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The subscription Id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetAvailabilitySet -Specifies the Availability Set to be used for VM creation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetAvailabilityZone -Specifies the Availability Zone to be used for VM creation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetBootDiagnosticsStorageAccount -Specifies the storage account to be used for boot diagnostics. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetCapacityReservationGroupId -Specifies the Target Capacity Reservation Group Id within the destination Azure subscription. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetDiskName -Specifies the name of the Azure VM to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetNetworkId -Updates the Virtual Network id within the destination Azure subscription to which the server needs to be migrated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetObjectID -Specifies the replcating server for which the properties need to be updated. -The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. - -```yaml -Type: System.String -Parameter Sets: ByIDVMwareCbt -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetResourceGroupID -Updates the Resource Group id within the destination Azure subscription to which the server needs to be migrated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetVMName -Specifies the replcating server for which the properties need to be updated. -The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetVMSize -Updates the SKU of the Azure VM to be created. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestNetworkId -Updates the Virtual Network id within the destination Azure subscription to which the server needs to be test migrated. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateDiskTag -Specifies the tag to be used for disk creation. -To construct, see NOTES section for UPDATEDISKTAG properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtEnableMigrationInputTargetDiskTags -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateDiskTagOperation -Specifies update disk tag operation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateNicTag -Specifies the tag to be used for NIC creation. -To construct, see NOTES section for UPDATENICTAG properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtEnableMigrationInputTargetNicTags -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateNicTagOperation -Specifies update NIC tag operation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateTag -Specifies the tag to be used for Resource creation. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateTagOperation -Specifies update tag operation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateVMTag -Specifies the tag to be used for VM creation. -To construct, see NOTES section for UPDATEVMTAG properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtEnableMigrationInputTargetVmtags -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateVMTagOperation -Specifies update VM tag operation. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateLocalServerMigration.md b/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateLocalServerMigration.md deleted file mode 100644 index 77fb2f167161..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateLocalServerMigration.md +++ /dev/null @@ -1,241 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/start-azmigratelocalservermigration -schema: 2.0.0 ---- - -# Start-AzMigrateLocalServerMigration - -## SYNOPSIS -Starts the migration for the replicating server. - -## SYNTAX - -### ByID (Default) -``` -Start-AzMigrateLocalServerMigration -TargetObjectID [-SubscriptionId ] [-TurnOffSourceServer] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -### ByInputObject -``` -Start-AzMigrateLocalServerMigration -InputObject [-SubscriptionId ] - [-TurnOffSourceServer] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Starts the migration for the replicating server. - -## EXAMPLES - -### Example 1: Start migration by Id -```powershell -Start-AzMigrateLocalServerMigration -TargetObjectID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/protectedItems/0ec082d5-6827-457a-bae2-f986e1b94851" -``` - -```output -ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 -AllowedAction : {Cancel} -CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails -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 : -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 AzLocal server migration by Id. - -### Example 2: Start migration by input object -```powershell -$InputObject = Get-AzMigrateLocalServerReplication -TargetObjectID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/protectedItems/0ec082d5-6827-457a-bae2-f986e1b94851" - -Start-AzMigrateLocalServerMigration -InputObject $InputObject - -$InputObject | Start-AzMigrateLocalServerMigration -``` - -```output -ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 -AllowedAction : {Cancel} -CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails -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 : -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 AzLocal server migration by replication input object. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the replicating server for which migration needs to be initiated. -The server object can be retrieved using the Get-AzMigrateLocalServerReplication cmdlet. -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity -Parameter Sets: ByInputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetObjectID -Specifies the replcating server for which migration needs to be initiated. -The ID should be retrieved using the Get-AzMigrateLocalServerReplication cmdlet. - -```yaml -Type: System.String -Parameter Sets: ByID -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TurnOffSourceServer -Specifies whether the source server should be turned off post migration. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -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). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.IJobModel - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateServerMigration.md b/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateServerMigration.md deleted file mode 100644 index edabbf31d2da..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateServerMigration.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/start-azmigrateservermigration -schema: 2.0.0 ---- - -# Start-AzMigrateServerMigration - -## SYNOPSIS -Starts the migration for the replicating server. - -## SYNTAX - -### ByIDVMwareCbt (Default) -``` -Start-AzMigrateServerMigration -TargetObjectID [-OsUpgradeVersion ] - [-SubscriptionId ] [-TargetCapacityReservationGroupId ] [-TurnOffSourceServer] - [-DefaultProfile ] [] -``` - -### ByInputObjectVMwareCbt -``` -Start-AzMigrateServerMigration -InputObject [-OsUpgradeVersion ] - [-SubscriptionId ] [-TargetCapacityReservationGroupId ] [-TurnOffSourceServer] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -Starts the migration for the replicating server. - -## EXAMPLES - -### Example 1: By id -```powershell -Start-AzMigrateServerMigration -TargetObjectID "/Subscriptions/7xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_52f42ee7-8eb3-1aa4-e2d5-1ae83f86b085" -``` - -```output -ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 -AllowedAction : {Cancel} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails -CustomDetailInstanceType : AsrJobDetails -EndTime : -Error : {} -FriendlyName : Migrate -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover - yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab -Location : -Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab -ScenarioName : Migrate -StartTime : 9/25/20 9:20:08 PM -State : InProgress -StateDescription : InProgress -TargetInstanceType : ProtectionEntity -TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 -TargetObjectName : prsadhu-TestVM -Task : {DisableProtectionOnPrimary, UpdateDraState} -Type : Microsoft.RecoveryServices/vaults/replicationJobs -``` - -By id - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the replicating server for which migration needs to be initiated. -The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet. -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IMigrationItem -Parameter Sets: ByInputObjectVMwareCbt -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OsUpgradeVersion -Specifies the target version to which the Os has to be upgraded to. -The valid values can be selected from SupportedOSVersions retrieved using Get-AzMigrateServerReplication cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetCapacityReservationGroupId -Specifies the Target Capacity Reservation Group Id within the destination Azure subscription. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetObjectID -Specifies the replcating server for which migration needs to be initiated. -The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. - -```yaml -Type: System.String -Parameter Sets: ByIDVMwareCbt -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TurnOffSourceServer -Specifies whether the source server should be turned off post migration. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateTestMigration.md b/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateTestMigration.md deleted file mode 100644 index b5a4121884ef..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateTestMigration.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/start-azmigratetestmigration -schema: 2.0.0 ---- - -# Start-AzMigrateTestMigration - -## SYNOPSIS -Starts the test migration for the replicating server. - -## SYNTAX - -### ByIDVMwareCbt (Default) -``` -Start-AzMigrateTestMigration -TargetObjectID -TestNetworkID - [-NicToUpdate ] [-OsUpgradeVersion ] [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### ByInputObjectVMwareCbt -``` -Start-AzMigrateTestMigration -InputObject -TestNetworkID - [-NicToUpdate ] [-OsUpgradeVersion ] [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The Start-AzMigrateTestMigration cmdlet initiates the test migration for the replicating server. - -## EXAMPLES - -### Example 1: By machine id. -```powershell -Start-AzMigrateTestMigration -TargetObjectID '/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f' -TestNetworkId '/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG/providers/Microsoft.Network/virtualNetworks/AzMigrateTargetNetwork' -``` - -```output -ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 -AllowedAction : {Cancel} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails -CustomDetailInstanceType : AsrJobDetails -EndTime : -Error : {} -FriendlyName : Test Migrate -Id : /Subscriptions/xxx-xxx-xxxresourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover - yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab -Location : -Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab -ScenarioName : TestMigrate -StartTime : 9/25/20 9:20:08 PM -State : InProgress -StateDescription : InProgress -TargetInstanceType : ProtectionEntity -TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 -TargetObjectName : prsadhu-TestVM -Task : {DisableProtectionOnPrimary, UpdateDraState} -Type : Microsoft.RecoveryServices/vaults/replicationJobs - -``` - -By machine id. - -### Example 2: By input object -```powershell -$obj = Get-AzMigrateServerReplication -TargetObjectID $env.srsMachineId -SubscriptionId $env.srsSubscriptionId -Start-AzMigrateTestMigration -InputObject $obj -TestNetworkId '/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG/providers/Microsoft.Network/virtualNetworks/AzMigrateTargetNetwork' -``` - -```output -ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 -AllowedAction : {Cancel} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails -CustomDetailInstanceType : AsrJobDetails -EndTime : -Error : {} -FriendlyName : Test Migrate -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover - yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab -Location : -Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab -ScenarioName : TestMigrate -StartTime : 9/25/20 9:20:08 PM -State : InProgress -StateDescription : InProgress -TargetInstanceType : ProtectionEntity -TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 -TargetObjectName : prsadhu-TestVM -Task : {DisableProtectionOnPrimary, UpdateDraState} -Type : Microsoft.RecoveryServices/vaults/replicationJobs - -``` - -By input object. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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. -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IMigrationItem -Parameter Sets: ByInputObjectVMwareCbt -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NicToUpdate -Updates the NIC for the Azure VM to be created. -To construct, see NOTES section for NICTOUPDATE properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtNicInput[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OsUpgradeVersion -Specifies the target version to which the Os has to be upgraded to. -The valid values can be selected from SupportedOSVersions retrieved using Get-AzMigrateServerReplication cmdlet. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetObjectID -Specifies the replicating server for which the test migration needs to be initiated. -The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. - -```yaml -Type: System.String -Parameter Sets: ByIDVMwareCbt -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestNetworkID -Updates the Virtual Network id within the destination Azure subscription to be used for test migration. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateTestMigrationCleanup.md b/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateTestMigrationCleanup.md deleted file mode 100644 index 37cb9a7e022f..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateTestMigrationCleanup.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/start-azmigratetestmigrationcleanup -schema: 2.0.0 ---- - -# Start-AzMigrateTestMigrationCleanup - -## SYNOPSIS -Cleans up the test migration for the replicating server. - -## SYNTAX - -### ByIDVMwareCbt (Default) -``` -Start-AzMigrateTestMigrationCleanup -TargetObjectID [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### ByInputObjectVMwareCbt -``` -Start-AzMigrateTestMigrationCleanup -InputObject [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -The Start-AzMigrateTestMigrationCleanup cmdlet initiates the clean up of the test migration for the replicating server. - -## EXAMPLES - -### Example 1: By machine id. -```powershell -Start-AzMigrateTestMigrationCleanup -TargetObjectID '/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f' -``` - -```output -ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 -AllowedAction : {Cancel} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails -CustomDetailInstanceType : AsrJobDetails -EndTime : -Error : {} -FriendlyName : Test Migrate Cleanup -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover - yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab -Location : -Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab -ScenarioName : TestMigrateCleanup -StartTime : 9/25/20 9:20:08 PM -State : InProgress -StateDescription : InProgress -TargetInstanceType : ProtectionEntity -TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 -TargetObjectName : prsadhu-TestVM -Task : {DisableProtectionOnPrimary, UpdateDraState} -Type : Microsoft.RecoveryServices/vaults/replicationJobs - -``` - -By machine id. - -### Example 2: By input object -```powershell -$obj = Get-AzMigrateServerReplication -TargetObjectID $env.srsMachineId -SubscriptionId $env.srsSubscriptionId -Start-AzMigrateTestMigrationCleanup -InputObject $ob -``` - -```output -AllowedOperation : {DisableMigration, TestMigrate, Migrate} - -ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 -AllowedAction : {Cancel} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails -CustomDetailInstanceType : AsrJobDetails -EndTime : -Error : {} -FriendlyName : Test Migrate Cleanup -Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover - yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab -Location : -Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab -ScenarioName : TestMigrateCleanup -StartTime : 9/25/20 9:20:08 PM -State : InProgress -StateDescription : InProgress -TargetInstanceType : ProtectionEntity -TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 -TargetObjectName : prsadhu-TestVM -Task : {DisableProtectionOnPrimary, UpdateDraState} -Type : Microsoft.RecoveryServices/vaults/replicationJobs - -``` - -By input object. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IMigrationItem -Parameter Sets: ByInputObjectVMwareCbt -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetObjectID -Specifies the replicating server for which the test migration cleanup needs to be initiated. -The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. - -```yaml -Type: System.String -Parameter Sets: ByIDVMwareCbt -Aliases: - -Required: True -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/docs/Suspend-AzMigrateServerReplication.md b/src/Migrate/Migrate.Autorest/docs/Suspend-AzMigrateServerReplication.md deleted file mode 100644 index fa383a33d152..000000000000 --- a/src/Migrate/Migrate.Autorest/docs/Suspend-AzMigrateServerReplication.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: -Module Name: Az.Migrate -online version: https://learn.microsoft.com/powershell/module/az.migrate/suspend-azmigrateserverreplication -schema: 2.0.0 ---- - -# Suspend-AzMigrateServerReplication - -## SYNOPSIS -Suspends the ongoing replication. - -## SYNTAX - -### ByIDVMwareCbt (Default) -``` -Suspend-AzMigrateServerReplication -TargetObjectID [-SubscriptionId ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -### ByInputObjectVMwareCbt -``` -Suspend-AzMigrateServerReplication -InputObject [-SubscriptionId ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -The Suspend-AzMigrateServerReplication suspends the ongoing replication. - -## EXAMPLES - -### Example 1: By machine id. -```powershell -Suspend-AzMigrateServerReplication -TargetObjectID "/Subscriptions/xxx-xxx-xxxxxx-xxx-xxx/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoffccyapp3352vault/replicationFabrics/signoffccyappae52replicationfabric/replicationProtectionContainers/signoffccyappae52replicationcontainer/replicationMigrationItems/idclab-vcen67-fareast-corp-micr-0f144e99-ba36-4649-b92b-8b06854aa539_5015f6d8-fc84-afdf-de47-1eab79330f00" -``` - -```output -ActivityId : da61a495-48b7-40df-a251-f23f491b2566 ActivityId: e16e0301-be13-4c35-8242-1451cb057994 -AllowedAction : {} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.JobDetailsAffectedObjectDetails -CustomDetailInstanceType : AsrJobDetails -EndTime : -Error : {} -FriendlyName : Pause replication -Id : /Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoff - ccyapp3352vault/replicationJobs/6ded7417-b939-4c30-b622-d80a63865025 -Location : -Name : 6ded7417-b939-4c30-b622-d80a63865025 -ScenarioName : PauseReplication -StartTime : 9/25/2022 9:10:42 PM -State : InProgress -StateDescription : InProgress -TargetInstanceType : ProtectionEntity -TargetObjectId : 52896ea4-214d-5825-bc32-24169dfcc44c -TargetObjectName : Win2k16 -Task : {PauseReplicationPreflightChecksTask, PauseReplicationTask} -Type : Microsoft.RecoveryServices/vaults/replicationJobs -``` - -By machine id. - -### Example 2: By input object -```powershell -$obj = Get-AzMigrateServerReplication -ProjectName "signoffccyproj" -ResourceGroupName "cbtsignoff2201rg" -MachineName "Win2k16" -Suspend-AzMigrateServerReplication -InputObject $obj -``` - -```output -ActivityId : da61a495-48b7-40df-a251-f23f491b2566 ActivityId: e16e0301-be13-4c35-8242-1451cb057994 -AllowedAction : {} -CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.JobDetailsAffectedObjectDetails -CustomDetailInstanceType : AsrJobDetails -EndTime : -Error : {} -FriendlyName : Pause replication -Id : /Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoff - ccyapp3352vault/replicationJobs/6ded7417-b939-4c30-b622-d80a63865025 -Location : -Name : 6ded7417-b939-4c30-b622-d80a63865025 -ScenarioName : PauseReplication -StartTime : 9/25/2022 9:10:42 PM -State : InProgress -StateDescription : InProgress -TargetInstanceType : ProtectionEntity -TargetObjectId : 52896ea4-214d-5825-bc32-24169dfcc44c -TargetObjectName : Win2k16 -Task : {PauseReplicationPreflightChecksTask, PauseReplicationTask} -Type : Microsoft.RecoveryServices/vaults/replicationJobs -``` - -By input object. - -## PARAMETERS - -### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the replicating server for which the suspend replication needs to be initiated. -The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IMigrationItem -Parameter Sets: ByInputObjectVMwareCbt -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -Azure Subscription ID. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetObjectID -Specifies the replicating server for which the suspend replication needs to be initiated. -The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. - -```yaml -Type: System.String -Parameter Sets: ByIDVMwareCbt -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -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). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob - -## NOTES - -## RELATED LINKS - diff --git a/src/Migrate/Migrate.Autorest/generate-info.json b/src/Migrate/Migrate.Autorest/generate-info.json index d3a777410a31..a8d94b8da18f 100644 --- a/src/Migrate/Migrate.Autorest/generate-info.json +++ b/src/Migrate/Migrate.Autorest/generate-info.json @@ -1,3 +1,3 @@ { - "generate_Id": "16bb7afe-8ed4-4a71-ad0d-44d35c30243f" + "generate_Id": "4db2e2db-0006-411d-8af1-07589c8cbad2" } diff --git a/src/Migrate/Migrate.Autorest/resources/README.md b/src/Migrate/Migrate.Autorest/resources/README.md index 937f07f8fec2..736492341e3d 100644 --- a/src/Migrate/Migrate.Autorest/resources/README.md +++ b/src/Migrate/Migrate.Autorest/resources/README.md @@ -1,5 +1,5 @@ # Resources -This directory can contain any additional resources for module that are not required at runtime. This directory **does not** get packaged with the module. If you have assets for custom implementation, place them into the `..\custom` folder. +This directory can contain any additional resources for module that are not required at runtime. This directory **does not** get packaged with the module. If you have assets for custom implementation, place them into the `../custom` folder. ## Info - Modifiable: yes diff --git a/src/Migrate/Migrate.Autorest/test/README.md b/src/Migrate/Migrate.Autorest/test/README.md index 7c752b4c8c43..1969200c6a09 100644 --- a/src/Migrate/Migrate.Autorest/test/README.md +++ b/src/Migrate/Migrate.Autorest/test/README.md @@ -1,5 +1,5 @@ # Test -This directory contains the [Pester](https://www.powershellgallery.com/packages/Pester) tests to run for the module. We use Pester as it is the unofficial standard for PowerShell unit testing. Test stubs for custom cmdlets (created in `..\custom`) will be generated into this folder when `build-module.ps1` is ran. These test stubs will fail automatically, to indicate that tests should be written for custom cmdlets. +This directory contains the [Pester](https://www.powershellgallery.com/packages/Pester) tests to run for the module. We use Pester as it is the unofficial standard for PowerShell unit testing. Test stubs for custom cmdlets (created in `../custom`) will be generated into this folder when `build-module.ps1` is ran. These test stubs will fail automatically, to indicate that tests should be written for custom cmdlets. ## Info - Modifiable: yes diff --git a/src/Migrate/Migrate.sln b/src/Migrate/Migrate.sln index eac6674ed04f..38d0db0f111d 100644 --- a/src/Migrate/Migrate.sln +++ b/src/Migrate/Migrate.sln @@ -21,7 +21,7 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Migrate", "Migrate\Migrate. EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Migrate.Autorest", "Migrate.Autorest", "{9AA2C35A-2264-B74D-8556-EB72BD88EE60}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.Migrate", "..\..\generated\Migrate\Migrate.Autorest\Az.Migrate.csproj", "{B5AD4A73-4A71-429B-8A83-827092E5683B}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.Migrate", "..\..\generated\Migrate\Migrate.Autorest\Az.Migrate.csproj", "{3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution @@ -117,18 +117,18 @@ Global {1847EC8D-87A5-4772-9E75-1DEA1DC531EE}.Release|x64.Build.0 = Release|Any CPU {1847EC8D-87A5-4772-9E75-1DEA1DC531EE}.Release|x86.ActiveCfg = Release|Any CPU {1847EC8D-87A5-4772-9E75-1DEA1DC531EE}.Release|x86.Build.0 = Release|Any CPU - {B5AD4A73-4A71-429B-8A83-827092E5683B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {B5AD4A73-4A71-429B-8A83-827092E5683B}.Debug|Any CPU.Build.0 = Debug|Any CPU - {B5AD4A73-4A71-429B-8A83-827092E5683B}.Debug|x64.ActiveCfg = Debug|Any CPU - {B5AD4A73-4A71-429B-8A83-827092E5683B}.Debug|x64.Build.0 = Debug|Any CPU - {B5AD4A73-4A71-429B-8A83-827092E5683B}.Debug|x86.ActiveCfg = Debug|Any CPU - {B5AD4A73-4A71-429B-8A83-827092E5683B}.Debug|x86.Build.0 = Debug|Any CPU - {B5AD4A73-4A71-429B-8A83-827092E5683B}.Release|Any CPU.ActiveCfg = Release|Any CPU - {B5AD4A73-4A71-429B-8A83-827092E5683B}.Release|Any CPU.Build.0 = Release|Any CPU - {B5AD4A73-4A71-429B-8A83-827092E5683B}.Release|x64.ActiveCfg = Release|Any CPU - {B5AD4A73-4A71-429B-8A83-827092E5683B}.Release|x64.Build.0 = Release|Any CPU - {B5AD4A73-4A71-429B-8A83-827092E5683B}.Release|x86.ActiveCfg = Release|Any CPU - {B5AD4A73-4A71-429B-8A83-827092E5683B}.Release|x86.Build.0 = Release|Any CPU + {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Debug|Any CPU.Build.0 = Debug|Any CPU + {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Debug|x64.ActiveCfg = Debug|Any CPU + {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Debug|x64.Build.0 = Debug|Any CPU + {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Debug|x86.ActiveCfg = Debug|Any CPU + {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Debug|x86.Build.0 = Debug|Any CPU + {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Release|Any CPU.ActiveCfg = Release|Any CPU + {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Release|Any CPU.Build.0 = Release|Any CPU + {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Release|x64.ActiveCfg = Release|Any CPU + {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Release|x64.Build.0 = Release|Any CPU + {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Release|x86.ActiveCfg = Release|Any CPU + {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Release|x86.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE @@ -140,6 +140,6 @@ Global {FB2B969F-E6FB-4E6E-9D2A-E52F4F53F51F} = {2D0176AD-AE30-4235-9D62-17043F0D4CD8} {D8D28132-CE20-45C8-8476-6B88C891D945} = {2D0176AD-AE30-4235-9D62-17043F0D4CD8} {B799EA2F-9E28-421A-9301-BB061C6ADDC2} = {2D0176AD-AE30-4235-9D62-17043F0D4CD8} - {B5AD4A73-4A71-429B-8A83-827092E5683B} = {9AA2C35A-2264-B74D-8556-EB72BD88EE60} + {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273} = {9AA2C35A-2264-B74D-8556-EB72BD88EE60} EndGlobalSection EndGlobal diff --git a/src/Migrate/Migrate/Az.Migrate.psd1 b/src/Migrate/Migrate/Az.Migrate.psd1 index fc6139bcabd5..759b461d9f57 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: 3/16/2026 +# Generated on: 3/26/2026 # @{ diff --git a/src/Migrate/Migrate/help/Get-AzMigrateLocalJob.md b/src/Migrate/Migrate/help/Get-AzMigrateLocalJob.md index 147526d5592a..1ef41330fb47 100644 --- a/src/Migrate/Migrate/help/Get-AzMigrateLocalJob.md +++ b/src/Migrate/Migrate/help/Get-AzMigrateLocalJob.md @@ -448,7 +448,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.IJobModel +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.IJobModel ## NOTES diff --git a/src/Migrate/Migrate/help/Get-AzMigrateLocalReplicationFabric.md b/src/Migrate/Migrate/help/Get-AzMigrateLocalReplicationFabric.md index 7ca42f588f2b..9a9c3daa08cb 100644 --- a/src/Migrate/Migrate/help/Get-AzMigrateLocalReplicationFabric.md +++ b/src/Migrate/Migrate/help/Get-AzMigrateLocalReplicationFabric.md @@ -260,7 +260,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.IFabricModel +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.IFabricModel ## NOTES diff --git a/src/Migrate/Migrate/help/Get-AzMigrateLocalServerReplication.md b/src/Migrate/Migrate/help/Get-AzMigrateLocalServerReplication.md index f3f571b32d30..553f916521e2 100644 --- a/src/Migrate/Migrate/help/Get-AzMigrateLocalServerReplication.md +++ b/src/Migrate/Migrate/help/Get-AzMigrateLocalServerReplication.md @@ -288,7 +288,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.IProtectedItemModel +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.IProtectedItemModel ## NOTES diff --git a/src/Migrate/Migrate/help/New-AzMigrateLocalDiskMappingObject.md b/src/Migrate/Migrate/help/New-AzMigrateLocalDiskMappingObject.md index 9d4f307b1966..4c211e02bf37 100644 --- a/src/Migrate/Migrate/help/New-AzMigrateLocalDiskMappingObject.md +++ b/src/Migrate/Migrate/help/New-AzMigrateLocalDiskMappingObject.md @@ -138,7 +138,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.AzLocalDiskInput +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.AzLocalDiskInput ## NOTES diff --git a/src/Migrate/Migrate/help/New-AzMigrateLocalNicMappingObject.md b/src/Migrate/Migrate/help/New-AzMigrateLocalNicMappingObject.md index 2392758d6986..e458defc75a4 100644 --- a/src/Migrate/Migrate/help/New-AzMigrateLocalNicMappingObject.md +++ b/src/Migrate/Migrate/help/New-AzMigrateLocalNicMappingObject.md @@ -107,7 +107,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.AzLocalNicInput +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.AzLocalNicInput ## NOTES diff --git a/src/Migrate/Migrate/help/New-AzMigrateLocalServerReplication.md b/src/Migrate/Migrate/help/New-AzMigrateLocalServerReplication.md index 41e86fb4977c..281ebe6fc56f 100644 --- a/src/Migrate/Migrate/help/New-AzMigrateLocalServerReplication.md +++ b/src/Migrate/Migrate/help/New-AzMigrateLocalServerReplication.md @@ -140,7 +140,7 @@ Accept wildcard characters: False Specifies the disks on the source server to be included for replication. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.AzLocalDiskInput[] +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.AzLocalDiskInput[] Parameter Sets: ByIdPowerUser Aliases: @@ -185,7 +185,7 @@ Accept wildcard characters: False Specifies the NICs on the source server to be included for replication. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.AzLocalNicInput[] +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.AzLocalNicInput[] Parameter Sets: ByIdPowerUser Aliases: @@ -399,7 +399,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.IJobModel +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.IJobModel ## NOTES diff --git a/src/Migrate/Migrate/help/Remove-AzMigrateLocalServerReplication.md b/src/Migrate/Migrate/help/Remove-AzMigrateLocalServerReplication.md index d865f1d03e98..1846f4d1bdf1 100644 --- a/src/Migrate/Migrate/help/Remove-AzMigrateLocalServerReplication.md +++ b/src/Migrate/Migrate/help/Remove-AzMigrateLocalServerReplication.md @@ -228,7 +228,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.IJobModel +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.IJobModel ## NOTES diff --git a/src/Migrate/Migrate/help/Set-AzMigrateLocalServerReplication.md b/src/Migrate/Migrate/help/Set-AzMigrateLocalServerReplication.md index 3f6b23a01cb7..0c06dc862796 100644 --- a/src/Migrate/Migrate/help/Set-AzMigrateLocalServerReplication.md +++ b/src/Migrate/Migrate/help/Set-AzMigrateLocalServerReplication.md @@ -88,7 +88,7 @@ Specifies the dynamic memory configuration of RAM. To construct, see NOTES section for DYNAMICMEMORYCONFIG properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.ProtectedItemDynamicMemoryConfig +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.ProtectedItemDynamicMemoryConfig Parameter Sets: (All) Aliases: @@ -118,7 +118,7 @@ Accept wildcard characters: False Specifies the nics on the source server to be included for replication. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.AzLocalNicInput[] +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.AzLocalNicInput[] Parameter Sets: (All) Aliases: @@ -243,7 +243,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.IJobModel +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.IJobModel ## NOTES diff --git a/src/Migrate/Migrate/help/Start-AzMigrateLocalServerMigration.md b/src/Migrate/Migrate/help/Start-AzMigrateLocalServerMigration.md index 620b2129e49b..3d3e6457596e 100644 --- a/src/Migrate/Migrate/help/Start-AzMigrateLocalServerMigration.md +++ b/src/Migrate/Migrate/help/Start-AzMigrateLocalServerMigration.md @@ -234,7 +234,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.IJobModel +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.IJobModel ## NOTES From bf943249ba1a34b5d5f2d011ac8340510cf5d7c4 Mon Sep 17 00:00:00 2001 From: Anh Dinh Date: Fri, 27 Mar 2026 13:27:24 -0700 Subject: [PATCH 2/3] more WIP --- .../Properties/AssemblyInfo.cs | 1 + .../Migrate.Autorest/generate-info.json | 2 +- src/Migrate/Migrate.sln | 28 +++++++++---------- src/Migrate/Migrate/Az.Migrate.psd1 | 2 +- .../New-AzMigrateLocalServerReplication.md | 27 ++++++++++++++---- 5 files changed, 38 insertions(+), 22 deletions(-) diff --git a/src/Migrate/Migrate.Autorest/Properties/AssemblyInfo.cs b/src/Migrate/Migrate.Autorest/Properties/AssemblyInfo.cs index 22180c19ae94..cfd29a74ce34 100644 --- a/src/Migrate/Migrate.Autorest/Properties/AssemblyInfo.cs +++ b/src/Migrate/Migrate.Autorest/Properties/AssemblyInfo.cs @@ -25,3 +25,4 @@ [assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)] [assembly: System.CLSCompliantAttribute(false)] + diff --git a/src/Migrate/Migrate.Autorest/generate-info.json b/src/Migrate/Migrate.Autorest/generate-info.json index a8d94b8da18f..57720f5084a9 100644 --- a/src/Migrate/Migrate.Autorest/generate-info.json +++ b/src/Migrate/Migrate.Autorest/generate-info.json @@ -1,3 +1,3 @@ { - "generate_Id": "4db2e2db-0006-411d-8af1-07589c8cbad2" + "generate_Id": "70101746-1d42-4ca8-ab55-09e486151be1" } diff --git a/src/Migrate/Migrate.sln b/src/Migrate/Migrate.sln index 38d0db0f111d..48daa438bdde 100644 --- a/src/Migrate/Migrate.sln +++ b/src/Migrate/Migrate.sln @@ -21,7 +21,7 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Migrate", "Migrate\Migrate. EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Migrate.Autorest", "Migrate.Autorest", "{9AA2C35A-2264-B74D-8556-EB72BD88EE60}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.Migrate", "..\..\generated\Migrate\Migrate.Autorest\Az.Migrate.csproj", "{3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.Migrate", "..\..\generated\Migrate\Migrate.Autorest\Az.Migrate.csproj", "{61624D8A-FD96-4107-A0F8-D50B1B811797}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution @@ -117,18 +117,18 @@ Global {1847EC8D-87A5-4772-9E75-1DEA1DC531EE}.Release|x64.Build.0 = Release|Any CPU {1847EC8D-87A5-4772-9E75-1DEA1DC531EE}.Release|x86.ActiveCfg = Release|Any CPU {1847EC8D-87A5-4772-9E75-1DEA1DC531EE}.Release|x86.Build.0 = Release|Any CPU - {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Debug|Any CPU.Build.0 = Debug|Any CPU - {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Debug|x64.ActiveCfg = Debug|Any CPU - {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Debug|x64.Build.0 = Debug|Any CPU - {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Debug|x86.ActiveCfg = Debug|Any CPU - {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Debug|x86.Build.0 = Debug|Any CPU - {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Release|Any CPU.ActiveCfg = Release|Any CPU - {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Release|Any CPU.Build.0 = Release|Any CPU - {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Release|x64.ActiveCfg = Release|Any CPU - {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Release|x64.Build.0 = Release|Any CPU - {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Release|x86.ActiveCfg = Release|Any CPU - {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273}.Release|x86.Build.0 = Release|Any CPU + {61624D8A-FD96-4107-A0F8-D50B1B811797}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {61624D8A-FD96-4107-A0F8-D50B1B811797}.Debug|Any CPU.Build.0 = Debug|Any CPU + {61624D8A-FD96-4107-A0F8-D50B1B811797}.Debug|x64.ActiveCfg = Debug|Any CPU + {61624D8A-FD96-4107-A0F8-D50B1B811797}.Debug|x64.Build.0 = Debug|Any CPU + {61624D8A-FD96-4107-A0F8-D50B1B811797}.Debug|x86.ActiveCfg = Debug|Any CPU + {61624D8A-FD96-4107-A0F8-D50B1B811797}.Debug|x86.Build.0 = Debug|Any CPU + {61624D8A-FD96-4107-A0F8-D50B1B811797}.Release|Any CPU.ActiveCfg = Release|Any CPU + {61624D8A-FD96-4107-A0F8-D50B1B811797}.Release|Any CPU.Build.0 = Release|Any CPU + {61624D8A-FD96-4107-A0F8-D50B1B811797}.Release|x64.ActiveCfg = Release|Any CPU + {61624D8A-FD96-4107-A0F8-D50B1B811797}.Release|x64.Build.0 = Release|Any CPU + {61624D8A-FD96-4107-A0F8-D50B1B811797}.Release|x86.ActiveCfg = Release|Any CPU + {61624D8A-FD96-4107-A0F8-D50B1B811797}.Release|x86.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE @@ -140,6 +140,6 @@ Global {FB2B969F-E6FB-4E6E-9D2A-E52F4F53F51F} = {2D0176AD-AE30-4235-9D62-17043F0D4CD8} {D8D28132-CE20-45C8-8476-6B88C891D945} = {2D0176AD-AE30-4235-9D62-17043F0D4CD8} {B799EA2F-9E28-421A-9301-BB061C6ADDC2} = {2D0176AD-AE30-4235-9D62-17043F0D4CD8} - {3F020BD9-8A4F-48E7-A9C8-18EAD7D7B273} = {9AA2C35A-2264-B74D-8556-EB72BD88EE60} + {61624D8A-FD96-4107-A0F8-D50B1B811797} = {9AA2C35A-2264-B74D-8556-EB72BD88EE60} EndGlobalSection EndGlobal diff --git a/src/Migrate/Migrate/Az.Migrate.psd1 b/src/Migrate/Migrate/Az.Migrate.psd1 index 759b461d9f57..3739271abc97 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: 3/26/2026 +# Generated on: 3/27/2026 # @{ diff --git a/src/Migrate/Migrate/help/New-AzMigrateLocalServerReplication.md b/src/Migrate/Migrate/help/New-AzMigrateLocalServerReplication.md index 281ebe6fc56f..1ec6ee132a04 100644 --- a/src/Migrate/Migrate/help/New-AzMigrateLocalServerReplication.md +++ b/src/Migrate/Migrate/help/New-AzMigrateLocalServerReplication.md @@ -17,9 +17,9 @@ Starts replication for the specified server. New-AzMigrateLocalServerReplication -MachineId -TargetStoragePathId -TargetResourceGroupId -TargetVMName -SourceApplianceName -TargetApplianceName -TargetVirtualSwitchId -OSDiskID [-TargetVMCPUCore ] - [-TargetTestVirtualSwitchId ] [-IsDynamicMemoryEnabled ] [-TargetVMRam ] - [-SubscriptionId ] [-DefaultProfile ] [-WhatIf] - [-Confirm] [] + [-TargetTestVirtualSwitchId ] [-IsDynamicMemoryEnabled ] [-MigrateAsArcVM ] + [-TargetVMRam ] [-SubscriptionId ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ### ByIdPowerUser @@ -27,9 +27,9 @@ New-AzMigrateLocalServerReplication -MachineId -TargetStoragePathId -TargetStoragePathId -TargetResourceGroupId -TargetVMName -SourceApplianceName -TargetApplianceName [-TargetVMCPUCore ] [-IsDynamicMemoryEnabled ] - [-TargetVMRam ] [-SubscriptionId ] -DiskToInclude - -NicToInclude [-DefaultProfile ] [-WhatIf] - [-Confirm] [] + [-MigrateAsArcVM ] [-TargetVMRam ] [-SubscriptionId ] + -DiskToInclude -NicToInclude [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -181,6 +181,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MigrateAsArcVM +Specifies whether the VM should be migrated as an Arc VM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NicToInclude Specifies the NICs on the source server to be included for replication. From 20d18b04eeb4b877c5284e46c863d8340d39d8b1 Mon Sep 17 00:00:00 2001 From: Anh Dinh Date: Fri, 27 Mar 2026 13:45:38 -0700 Subject: [PATCH 3/3] added the generated docs back --- .../Migrate.Autorest/docs/Az.Migrate.md | 140 ++++ .../docs/Get-AzMigrateDiscoveredServer.md | 335 +++++++++ .../Migrate.Autorest/docs/Get-AzMigrateJob.md | 304 +++++++++ .../docs/Get-AzMigrateLocalJob.md | 456 +++++++++++++ .../Get-AzMigrateLocalReplicationFabric.md | 267 ++++++++ .../Get-AzMigrateLocalServerReplication.md | 296 ++++++++ .../docs/Get-AzMigrateProject.md | 113 +++ .../docs/Get-AzMigrateReplicationFabric.md | 193 ++++++ .../docs/Get-AzMigrateReplicationPolicy.md | 151 ++++ ...AzMigrateReplicationProtectionContainer.md | 170 +++++ ...teReplicationProtectionContainerMapping.md | 173 +++++ ...rateReplicationRecoveryServicesProvider.md | 151 ++++ .../docs/Get-AzMigrateRunAsAccount.md | 149 ++++ .../Get-AzMigrateServerMigrationStatus.md | 335 +++++++++ .../docs/Get-AzMigrateServerReplication.md | 413 +++++++++++ .../docs/Get-AzMigrateSite.md | 115 ++++ .../docs/Get-AzMigrateSolution.md | 128 ++++ ...AzMigrateLocalReplicationInfrastructure.md | 217 ++++++ ...lize-AzMigrateReplicationInfrastructure.md | 198 ++++++ .../docs/New-AzMigrateDiskMapping.md | 125 ++++ .../New-AzMigrateLocalDiskMappingObject.md | 146 ++++ .../New-AzMigrateLocalNicMappingObject.md | 114 ++++ .../New-AzMigrateLocalServerReplication.md | 422 ++++++++++++ .../docs/New-AzMigrateNicMapping.md | 159 +++++ .../docs/New-AzMigrateProject.md | 173 +++++ .../docs/New-AzMigrateReplicationPolicy.md | 212 ++++++ ...teReplicationProtectionContainerMapping.md | 278 ++++++++ .../docs/New-AzMigrateServerReplication.md | 642 ++++++++++++++++++ .../docs/New-AzMigrateTestNicMapping.md | 113 +++ .../docs/Register-AzMigrateProjectTool.md | 174 +++++ .../Remove-AzMigrateLocalServerReplication.md | 234 +++++++ .../docs/Remove-AzMigrateProject.md | 172 +++++ .../docs/Remove-AzMigrateServerReplication.md | 186 +++++ .../Restart-AzMigrateServerReplication.md | 169 +++++ .../docs/Resume-AzMigrateServerReplication.md | 216 ++++++ .../docs/Set-AzMigrateDiskMapping.md | 96 +++ .../Set-AzMigrateLocalServerReplication.md | 251 +++++++ .../docs/Set-AzMigrateServerReplication.md | 528 ++++++++++++++ .../Start-AzMigrateLocalServerMigration.md | 241 +++++++ .../docs/Start-AzMigrateServerMigration.md | 187 +++++ .../docs/Start-AzMigrateTestMigration.md | 221 ++++++ .../Start-AzMigrateTestMigrationCleanup.md | 174 +++++ .../Suspend-AzMigrateServerReplication.md | 201 ++++++ 43 files changed, 9738 insertions(+) create mode 100644 src/Migrate/Migrate.Autorest/docs/Az.Migrate.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateDiscoveredServer.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateJob.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalJob.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalReplicationFabric.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalServerReplication.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateProject.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationFabric.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationPolicy.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationProtectionContainer.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationProtectionContainerMapping.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationRecoveryServicesProvider.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateRunAsAccount.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateServerMigrationStatus.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateServerReplication.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateSite.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Get-AzMigrateSolution.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Initialize-AzMigrateLocalReplicationInfrastructure.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Initialize-AzMigrateReplicationInfrastructure.md create mode 100644 src/Migrate/Migrate.Autorest/docs/New-AzMigrateDiskMapping.md create mode 100644 src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalDiskMappingObject.md create mode 100644 src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalNicMappingObject.md create mode 100644 src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalServerReplication.md create mode 100644 src/Migrate/Migrate.Autorest/docs/New-AzMigrateNicMapping.md create mode 100644 src/Migrate/Migrate.Autorest/docs/New-AzMigrateProject.md create mode 100644 src/Migrate/Migrate.Autorest/docs/New-AzMigrateReplicationPolicy.md create mode 100644 src/Migrate/Migrate.Autorest/docs/New-AzMigrateReplicationProtectionContainerMapping.md create mode 100644 src/Migrate/Migrate.Autorest/docs/New-AzMigrateServerReplication.md create mode 100644 src/Migrate/Migrate.Autorest/docs/New-AzMigrateTestNicMapping.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Register-AzMigrateProjectTool.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateLocalServerReplication.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateProject.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateServerReplication.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Restart-AzMigrateServerReplication.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Resume-AzMigrateServerReplication.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Set-AzMigrateDiskMapping.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Set-AzMigrateLocalServerReplication.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Set-AzMigrateServerReplication.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Start-AzMigrateLocalServerMigration.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Start-AzMigrateServerMigration.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Start-AzMigrateTestMigration.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Start-AzMigrateTestMigrationCleanup.md create mode 100644 src/Migrate/Migrate.Autorest/docs/Suspend-AzMigrateServerReplication.md diff --git a/src/Migrate/Migrate.Autorest/docs/Az.Migrate.md b/src/Migrate/Migrate.Autorest/docs/Az.Migrate.md new file mode 100644 index 000000000000..c3f350c83060 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Az.Migrate.md @@ -0,0 +1,140 @@ +--- +Module Name: Az.Migrate +Module Guid: 1902a337-0442-4923-8323-7b11f6936631 +Download Help Link: https://learn.microsoft.com/powershell/module/az.migrate +Help Version: 1.0.0.0 +Locale: en-US +--- + +# Az.Migrate Module +## Description +Microsoft Azure PowerShell: Migrate cmdlets + +## Az.Migrate Cmdlets +### [Get-AzMigrateDiscoveredServer](Get-AzMigrateDiscoveredServer.md) +Get All discovered servers in a migrate project. + +### [Get-AzMigrateJob](Get-AzMigrateJob.md) +Retrieves the status of an Azure Migrate job. + +### [Get-AzMigrateLocalJob](Get-AzMigrateLocalJob.md) +Retrieves the status of an Azure Migrate job. + +### [Get-AzMigrateLocalReplicationFabric](Get-AzMigrateLocalReplicationFabric.md) +Gets the details of the fabric. + +### [Get-AzMigrateLocalServerReplication](Get-AzMigrateLocalServerReplication.md) +Retrieves the details of the replicating server. + +### [Get-AzMigrateProject](Get-AzMigrateProject.md) +Method to get a migrate project. + +### [Get-AzMigrateReplicationFabric](Get-AzMigrateReplicationFabric.md) +Gets the details of an Azure Site Recovery fabric. + +### [Get-AzMigrateReplicationPolicy](Get-AzMigrateReplicationPolicy.md) +Gets the details of a replication policy. + +### [Get-AzMigrateReplicationProtectionContainer](Get-AzMigrateReplicationProtectionContainer.md) +Gets the details of a protection container. + +### [Get-AzMigrateReplicationProtectionContainerMapping](Get-AzMigrateReplicationProtectionContainerMapping.md) +Gets the details of a protection container mapping. + +### [Get-AzMigrateReplicationRecoveryServicesProvider](Get-AzMigrateReplicationRecoveryServicesProvider.md) +Gets the details of registered recovery services provider. + +### [Get-AzMigrateRunAsAccount](Get-AzMigrateRunAsAccount.md) +Method to get run as account. + +### [Get-AzMigrateServerMigrationStatus](Get-AzMigrateServerMigrationStatus.md) +Retrieves the details of the replicating server status. + +### [Get-AzMigrateServerReplication](Get-AzMigrateServerReplication.md) +Retrieves the details of the replicating server. + +### [Get-AzMigrateSite](Get-AzMigrateSite.md) +Method to get a site. + +### [Get-AzMigrateSolution](Get-AzMigrateSolution.md) +Gets a solution in the migrate project. + +### [Initialize-AzMigrateLocalReplicationInfrastructure](Initialize-AzMigrateLocalReplicationInfrastructure.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-AzMigrateLocalDiskMappingObject](New-AzMigrateLocalDiskMappingObject.md) +Creates a new disk mapping + +### [New-AzMigrateLocalNicMappingObject](New-AzMigrateLocalNicMappingObject.md) +Creates an object to update NIC properties of a replicating server. + +### [New-AzMigrateLocalServerReplication](New-AzMigrateLocalServerReplication.md) +Starts replication for the specified server. + +### [New-AzMigrateNicMapping](New-AzMigrateNicMapping.md) +Creates an object to update NIC properties of a replicating server. + +### [New-AzMigrateProject](New-AzMigrateProject.md) +Creates a new Migrate project. + +### [New-AzMigrateReplicationPolicy](New-AzMigrateReplicationPolicy.md) +The operation to create a replication policy. + +### [New-AzMigrateReplicationProtectionContainerMapping](New-AzMigrateReplicationProtectionContainerMapping.md) +The operation to create a protection container mapping. + +### [New-AzMigrateServerReplication](New-AzMigrateServerReplication.md) +Starts replication for the specified server. + +### [New-AzMigrateTestNicMapping](New-AzMigrateTestNicMapping.md) +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-AzMigrateLocalServerReplication](Remove-AzMigrateLocalServerReplication.md) +Stops replication for the migrated server. + +### [Remove-AzMigrateProject](Remove-AzMigrateProject.md) +Delete the migrate project. +Deleting non-existent project is a no-operation. + +### [Remove-AzMigrateServerReplication](Remove-AzMigrateServerReplication.md) +Stops replication for the migrated server. + +### [Restart-AzMigrateServerReplication](Restart-AzMigrateServerReplication.md) +Restarts the replication for specified server. + +### [Resume-AzMigrateServerReplication](Resume-AzMigrateServerReplication.md) +Starts the replication that has been suspended. + +### [Set-AzMigrateDiskMapping](Set-AzMigrateDiskMapping.md) +Updates disk mapping + +### [Set-AzMigrateLocalServerReplication](Set-AzMigrateLocalServerReplication.md) +Updates the target properties for the replicating server. + +### [Set-AzMigrateServerReplication](Set-AzMigrateServerReplication.md) +Updates the target properties for the replicating server. + +### [Start-AzMigrateLocalServerMigration](Start-AzMigrateLocalServerMigration.md) +Starts the migration for the replicating server. + +### [Start-AzMigrateServerMigration](Start-AzMigrateServerMigration.md) +Starts the migration for the replicating server. + +### [Start-AzMigrateTestMigration](Start-AzMigrateTestMigration.md) +Starts the test migration for the replicating server. + +### [Start-AzMigrateTestMigrationCleanup](Start-AzMigrateTestMigrationCleanup.md) +Cleans up the test migration for the replicating server. + +### [Suspend-AzMigrateServerReplication](Suspend-AzMigrateServerReplication.md) +Suspends the ongoing replication. + diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateDiscoveredServer.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateDiscoveredServer.md new file mode 100644 index 000000000000..3a1f58858b40 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateDiscoveredServer.md @@ -0,0 +1,335 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratediscoveredserver +schema: 2.0.0 +--- + +# Get-AzMigrateDiscoveredServer + +## SYNOPSIS +Get All discovered servers in a migrate project. + +## SYNTAX + +### List (Default) +``` +Get-AzMigrateDiscoveredServer -ProjectName -ResourceGroupName [-DisplayName ] + [-SourceMachineType ] [-SubscriptionId ] [-Confirm] [-WhatIf] [] +``` + +### Get +``` +Get-AzMigrateDiscoveredServer -Name -ProjectName -ResourceGroupName + [-SourceMachineType ] [-SubscriptionId ] [-Confirm] [-WhatIf] [] +``` + +### GetInSite +``` +Get-AzMigrateDiscoveredServer -ApplianceName -Name -ProjectName + -ResourceGroupName [-SourceMachineType ] [-SubscriptionId ] [-Confirm] [-WhatIf] + [] +``` + +### ListInSite +``` +Get-AzMigrateDiscoveredServer -ApplianceName -ProjectName -ResourceGroupName + [-DisplayName ] [-SourceMachineType ] [-SubscriptionId ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Get Azure migrate server commandlet fetches all servers in a migrate project. + +## EXAMPLES + +### Example 1: List VMware machines +```powershell +Get-AzMigrateDiscoveredServer -SubscriptionId xxx-xxx-xxx -ResourceGroupName julytest -ProjectName julytest +``` + +```output +Name Typeo… +---- ----o… +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029e62c-31d2-a6c3-5316-aa39f47c49fc Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029c180-1359-5e3c-3f56-05632aa4a37f Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029d80d-d014-72f3-8d05-d43ee49a023d Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029bd24-6d40-88dc-4f29-329596f9a50b Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_50292d97-2025-bfdf-1f07-86afa50d144f Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_50293685-fb73-0a89-204f-f79cb1f0061e Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029c9aa-3c8c-aba8-834e-1058bc457e5b Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029dabc-cc94-780f-76fd-e39acb0e9dce Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_50299579-fc18-4152-ade2-c4a57946f72b Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029cc18-efdc-7315-3b09-9d12a0f337e2 Microsoft.OffAzure/VMwareSites/machines + +``` + +Get All servers in a migrate project. + +### 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 +``` + +```output +Name Typeo… +---- ----o… +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029e62c-31d2-a6c3-5316-aa39f47c49fc Microsoft.OffAzure/VMwareSites/machines + +``` + +Get a server in a migrate project by name. +Name is a unique parameter for a server. + +### Example 3: List VMware machines in an appliance +```powershell +Get-AzMigrateDiscoveredServer -ApplianceName BBVMwareAVS -SubscriptionId xxx-xxx-xxx -ResourceGroupName julytest -ProjectName julytest +``` + +```output +Name Typeo… +---- ----o… +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029e62c-31d2-a6c3-5316-aa39f47c49fc Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029c180-1359-5e3c-3f56-05632aa4a37f Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029d80d-d014-72f3-8d05-d43ee49a023d Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029bd24-6d40-88dc-4f29-329596f9a50b Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_50292d97-2025-bfdf-1f07-86afa50d144f Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_50293685-fb73-0a89-204f-f79cb1f0061e Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029c9aa-3c8c-aba8-834e-1058bc457e5b Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029dabc-cc94-780f-76fd-e39acb0e9dce Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_50299579-fc18-4152-ade2-c4a57946f72b Microsoft.OffAzure/VMwareSites/machines +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029cc18-efdc-7315-3b09-9d12a0f337e2 Microsoft.OffAzure/VMwareSites/machines + +``` + +List all servers for an appliance in a project. + +### 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 +``` + +```output +Name Typeo… +---- ----o… +idclab-a360-fareast-corp-micros-86617dcf-effe-59ad-8c3a-cdd3ea7300d3_5029e62c-31d2-a6c3-5316-aa39f47c49fc Microsoft.OffAzure/VMwareSites/machines + +``` + +Get a server for an appliance in a project. +Name is a unique parameter for a server. + +### 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 +``` + +```output +DisplayName Name Type +----------- ---- ---- +Contoso-ConfigurationServer 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50098b08-5701-4c58-f6ad-1daf127a8ed9 Microsoft.OffAzure/VMwareSites/machines +Contoso-FrontTier1 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_5009c31a-241a-8213-5627-4ea4af00df93 Microsoft.OffAzure/VMwareSites/machines +Contoso-MiddleTier1 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50097bb8-f32c-39d6-f475-5aaa6194f016 Microsoft.OffAzure/VMwareSites/machines +ContosoAppSrv2 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_5009b455-1721-fa03-7ceb-8177cd2c5de6 Microsoft.OffAzure/VMwareSites/machines +ContosoCSASR 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50096b80-7061-672c-8db0-07ee41212869 Microsoft.OffAzure/VMwareSites/machines +ContosoVMwareMigration2 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50099d31-71d5-2bd1-fada-8c4eba2f279a Microsoft.OffAzure/VMwareSites/machines +ContosoAppSrv1 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50097d3f-c1f6-9217-825c-936db54043df Microsoft.OffAzure/VMwareSites/machines + +``` + +List servers in a migrate project and filter responses with 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 +``` + +```output +DisplayName Name Type +----------- ---- ---- +Contoso-ConfigurationServer 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50098b08-5701-4c58-f6ad-1daf127a8ed9 Microsoft.OffAzure/VMwareSites/machines +Contoso-FrontTier1 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_5009c31a-241a-8213-5627-4ea4af00df93 Microsoft.OffAzure/VMwareSites/machines +Contoso-MiddleTier1 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50097bb8-f32c-39d6-f475-5aaa6194f016 Microsoft.OffAzure/VMwareSites/machines +ContosoAppSrv2 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_5009b455-1721-fa03-7ceb-8177cd2c5de6 Microsoft.OffAzure/VMwareSites/machines +ContosoCSASR 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50096b80-7061-672c-8db0-07ee41212869 Microsoft.OffAzure/VMwareSites/machines +ContosoVMwareMigration2 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50099d31-71d5-2bd1-fada-8c4eba2f279a Microsoft.OffAzure/VMwareSites/machines +ContosoAppSrv1 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_50097d3f-c1f6-9217-825c-936db54043df Microsoft.OffAzure/VMwareSites/machines +Contoso-DataTier3 10-150-8-52-b090bef3-b733-5e34-bc8f-eb6f2701432a_500986e5-7720-471e-11d7-d4e8ae9edc45 Microsoft.OffAzure/VMwareSites/machines +``` + +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 +Specifies the appliance name. +This internally maps to a site. + +```yaml +Type: System.String +Parameter Sets: GetInSite, ListInSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Specifies the source machine display name. + +```yaml +Type: System.String +Parameter Sets: List, ListInSite +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the source machine name. +This is an internal Name. +For users, use display name. + +```yaml +Type: System.String +Parameter Sets: Get, GetInSite +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +Specifies the migrate project name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceMachineType +Specifies the source machine type. +Currently, only HyperV and VMware are supported. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Specifies the subscription id. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202001.IHyperVMachine + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202001.IVMwareMachine + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateJob.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateJob.md new file mode 100644 index 000000000000..1a208a3e031d --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateJob.md @@ -0,0 +1,304 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratejob +schema: 2.0.0 +--- + +# Get-AzMigrateJob + +## SYNOPSIS +Retrieves the status of an Azure Migrate job. + +## SYNTAX + +### ListByName (Default) +``` +Get-AzMigrateJob -ProjectName -ResourceGroupName [-SubscriptionId ] + [-Filter ] [-DefaultProfile ] [] +``` + +### GetById +``` +Get-AzMigrateJob -JobID [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetByInputObject +``` +Get-AzMigrateJob -InputObject [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetByName +``` +Get-AzMigrateJob -JobName -ProjectName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### ListById +``` +Get-AzMigrateJob -ProjectID -ResourceGroupID [-SubscriptionId ] [-Filter ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Get-AzMigrateJob cmdlet retrieves the status of an Azure Migrate job. + +## EXAMPLES + +### Example 1: Get By Job Id +```powershell +Get-AzMigrateJob -JobID "/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/997e2a92-5afe-49c7-a81a-89660aec9b7b" +``` + +```output +ActivityId : 68af14b4-46ae-48d1-b3e9-cdcffb9e8a93 ActivityId: 74d1a396-1d37-4264-8a5b-b727aaef0171 +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : 9/16/20 11:57:33 AM +Error : {} +FriendlyName : Associate replication policy +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/997e2a92-5afe-49c7-a81a-89660aec9b7b +Location : +Name : 997e2a92-5afe-49c7-a81a-89660aec9b7b +ScenarioName : AssociateProtectionProfile +StartTime : 9/16/20 11:57:32 AM +State : Succeeded +StateDescription : Completed +TargetInstanceType : ProtectionProfile +TargetObjectId : 42752b89-5fad-52fd-bf93-679fbdb6fed9 +TargetObjectName : migrateAzMigratePWSHTc8d1sitepolicy +Task : {CloudPairingPrerequisitesCheck, CloudPairingPrepareSite} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +This retrieves a job by it's Id. + +### Example 2: List by resource group and project +```powershell +Get-AzMigrateJob -ResourceGroupName 'azmigratepwshtestasr13072020' -ProjectName 'AzMigrateTestProjectPWSH' +``` + +```output +ActivityId : +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : +EndTime : 9/21/20 4:13:40 PM +Error : {} +FriendlyName : Update the virtual machine +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/1c89e38e-34ec-4903-aa7c-115201bf2de1 +Location : +Name : 1c89e38e-34ec-4903-aa7c-115201bf2de1 +ScenarioName : UpdateVmProperties +StartTime : 9/21/20 4:13:34 PM +State : Succeeded +StateDescription : Completed +TargetInstanceType : ProtectionEntity +TargetObjectId : 593b735d-2a34-53b2-b8ed-e33da5650703 +TargetObjectName : rb-w2k12r2-1 +Task : {} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +This gets all jobs in a project. + +### Example 3: Get by resource group, project and job name +```powershell +Get-AzMigrateJob -ResourceGroupName 'azmigratepwshtestasr13072020' -ProjectName 'AzMigrateTestProjectPWSH' -JobName 7ae1ee7c-442c-499d-8b0e-81d52a42b71e +``` + +```output +ActivityId : 6986b7e5-0f1f-49d8-8b4b-77e6f66bcb92 ActivityId: eb73c6a1-7c66-469f-a853-d896aa38cc0f +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : 8/21/20 6:41:48 AM +Error : {} +FriendlyName : Create replication policy +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/7ae1ee7c-442c-499d-8b0e-81d52a42b71e +Location : +Name : 7ae1ee7c-442c-499d-8b0e-81d52a42b71e +ScenarioName : AddProtectionProfile +StartTime : 8/21/20 6:41:48 AM +State : Succeeded +StateDescription : Completed +TargetInstanceType : ProtectionProfile +TargetObjectId : 18b2ccec-e39a-517b-ae5d-dd395e9f4f96 +TargetObjectName : samplePolicy3 +Task : {AddProtectionProfilePreflightsCheckTask, AddProtectionProfileTask} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +This gets a specific job. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +OData filter options. + +```yaml +Type: System.String +Parameter Sets: ListById, ListByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the job object of the replicating server. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob +Parameter Sets: GetByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobID +Specifies the job id for which the details needs to be retrieved. + +```yaml +Type: System.String +Parameter Sets: GetById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobName +Job identifier + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +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: System.String +Parameter Sets: ListById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the migrate project. + +```yaml +Type: System.String +Parameter Sets: GetByName, ListByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupID +Specifies the Resource Group of the Azure Migrate Project in the current subscription. + +```yaml +Type: System.String +Parameter Sets: ListById +Aliases: + +Required: True +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. + +```yaml +Type: System.String +Parameter Sets: GetByName, ListByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalJob.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalJob.md new file mode 100644 index 000000000000..f2db2e87428c --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalJob.md @@ -0,0 +1,456 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratelocaljob +schema: 2.0.0 +--- + +# Get-AzMigrateLocalJob + +## SYNOPSIS +Retrieves the status of an Azure Migrate job. + +## SYNTAX + +### ListByName (Default) +``` +Get-AzMigrateLocalJob -ProjectName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetById +``` +Get-AzMigrateLocalJob -ID [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetByInputObject +``` +Get-AzMigrateLocalJob -InputObject [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetByName +``` +Get-AzMigrateLocalJob -Name -ProjectName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### ListById +``` +Get-AzMigrateLocalJob -ProjectID -ResourceGroupID [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Get-AzMigrateLocalJob cmdlet retrieves the status of an Azure Migrate job. + +## EXAMPLES + +### Example 1: Get by job Id +```powershell +Get-AzMigrateLocalJob -ID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/jobs/0203aa1b-1dff-4653-89a9-b90a76d1601a" +``` + +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {Cancel} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails +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 : +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-AzMigrateLocalJob -ResourceGroupName "test-rg" -ProjectName "testproj" -Name "0203aa1b-1dff-4653-89a9-b90a76d1601a" +``` + +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {Cancel} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails +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 : +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-AzMigrateLocalJob -ID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/jobs/0203aa1b-1dff-4653-89a9-b90a76d1601a" + +Get-AzMigrateLocalJob -InputObject $InputObject + +$InputObject | Get-AzMigrateLocalJob +``` + +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {Cancel} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails +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 : +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-AzMigrateLocalJob -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" +``` + +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {Cancel} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails +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 : +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.Api20240901.JobModelCustomPropertiesAffectedObjectDetails +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 : +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-AzMigrateLocalJob -ResourceGroupName "test-rg" -ProjectName "testproj" +``` + +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {Cancel} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails +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 : +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.Api20240901.JobModelCustomPropertiesAffectedObjectDetails +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 : +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: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ID +Specifies the job id for which the details needs to be retrieved. + +```yaml +Type: System.String +Parameter Sets: GetById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the job object of the replicating server. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity +Parameter Sets: GetByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Job identifier + +```yaml +Type: System.String +Parameter Sets: GetByName +Aliases: + +Required: True +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: System.String +Parameter Sets: ListById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the migrate project. + +```yaml +Type: System.String +Parameter Sets: GetByName, ListByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupID +Specifies the Resource Group of the Azure Migrate Project in the current subscription. + +```yaml +Type: System.String +Parameter Sets: ListById +Aliases: + +Required: True +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. + +```yaml +Type: System.String +Parameter Sets: GetByName, ListByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +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). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.IJobModel + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalReplicationFabric.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalReplicationFabric.md new file mode 100644 index 000000000000..12bc5bd24a57 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalReplicationFabric.md @@ -0,0 +1,267 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratelocalreplicationfabric +schema: 2.0.0 +--- + +# Get-AzMigrateLocalReplicationFabric + +## SYNOPSIS +Gets the details of the fabric. + +## SYNTAX + +### List (Default) +``` +Get-AzMigrateLocalReplicationFabric [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzMigrateLocalReplicationFabric -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzMigrateLocalReplicationFabric -InputObject [-DefaultProfile ] + [] +``` + +### List1 +``` +Get-AzMigrateLocalReplicationFabric -ResourceGroupName [-SubscriptionId ] + [-ContinuationToken ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets the details of the fabric. + +## EXAMPLES + +### Example 1: Get by fabric name +```powershell +Get-AzMigrateLocalReplicationFabric -ResourceGroupName "test-rg" -Name "testsrcappreplicationfabric" +``` + +```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.Api20240901.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 +Type : Microsoft.DataReplication/replicationFabrics +``` + +Retrieves a fabric by its name. + +### Example 2: Get by fabric input object +```powershell +$InputObject = Get-AzMigrateLocalReplicationFabric -ResourceGroupName "test-rg" -Name "testsrcappreplicationfabric" + +Get-AzMigrateLocalReplicationFabric -InputObject $InputObject + +$InputObject | Get-AzMigrateLocalReplicationFabric +``` + +```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.Api20240901.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 +Type : Microsoft.DataReplication/replicationFabrics +``` + +Retrieves a fabric by the fabric itself as an input object. + +### Example 3: List by resource group name +```powershell +Get-AzMigrateLocalReplicationFabric -ResourceGroupName "test-rg" +``` + +```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.Api20240901.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 +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.Api20240901.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 +Type : Microsoft.DataReplication/replicationFabrics +``` + +Retrieves all fabrics from a resource group by name. + +### Example 4: List all fabrics +```powershell +Get-AzMigrateLocalReplicationFabric +``` + +```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.Api20240901.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 +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.Api20240901.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 +Type : Microsoft.DataReplication/replicationFabrics + +... +``` + +Retrieves all fabrics from a subscription. + +## PARAMETERS + +### -ContinuationToken +Continuation token from the previous call. + +```yaml +Type: System.String +Parameter Sets: List1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The fabric name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: FabricName + +Required: True +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: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +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). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.IFabricModel + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalServerReplication.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalServerReplication.md new file mode 100644 index 000000000000..a1f6c37f9f74 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateLocalServerReplication.md @@ -0,0 +1,296 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratelocalserverreplication +schema: 2.0.0 +--- + +# Get-AzMigrateLocalServerReplication + +## SYNOPSIS +Retrieves the details of the replicating server. + +## SYNTAX + +### ListByName (Default) +``` +Get-AzMigrateLocalServerReplication -ProjectName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetByInputObject +``` +Get-AzMigrateLocalServerReplication -InputObject [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetByItemID +``` +Get-AzMigrateLocalServerReplication -TargetObjectID [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetByMachineName +``` +Get-AzMigrateLocalServerReplication -MachineName -ProjectName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetBySDSID +``` +Get-AzMigrateLocalServerReplication -DiscoveredMachineId [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### ListById +``` +Get-AzMigrateLocalServerReplication -ProjectID -ResourceGroupID [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Get-AzMigrateLocalServerReplication cmdlet retrieves the object for the replicating server. + +## EXAMPLES + +### Example 1: Get details by id +```powershell +Get-AzMigrateLocalServerReplication -TargetObjectID '/subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/proj62434replicationvault/protectedItems/503a4f02-916c-d6b0-8d14-222bbd4767e5' +``` + +```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.Api20240901.ProtectedItemModelProperties +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.DataReplication/replicationVaults/protectedItems +``` + +Get by id. + +### Example 2: Get detail by discovered machine id +```powershell +Get-AzMigrateLocalServerReplication -DiscoveredMachineId "/subscriptions/xxx-xxx-xxx/resourceGroups/test-rg/providers/Microsoft.OffAzure/HyperVSites/siteName1/machines/503a4f02-916c-d6b0-8d14-222bbd4767e5" + +``` + +```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.Api20240901.ProtectedItemModelProperties +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +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.Api20240901.ProtectedItemModelProperties +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +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.Api20240901.ProtectedItemModelProperties +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : Microsoft.DataReplication/replicationVaults/protectedItems +``` + +List all. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiscoveredMachineId +Specifies the machine ID of the discovered server. + +```yaml +Type: System.String +Parameter Sets: GetBySDSID +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the machine object of the replicating server. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity +Parameter Sets: GetByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MachineName +Specifies the display name of the replicating machine. + +```yaml +Type: System.String +Parameter Sets: GetByMachineName +Aliases: + +Required: True +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: System.String +Parameter Sets: ListById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +Specifies the Azure Migrate project in the current subscription. + +```yaml +Type: System.String +Parameter Sets: GetByMachineName, ListByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupID +Specifies the Resource Group of the Azure Migrate Project in the current subscription. + +```yaml +Type: System.String +Parameter Sets: ListById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the Resource Group of the Azure Migrate Project in the current subscription. + +```yaml +Type: System.String +Parameter Sets: GetByMachineName, ListByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replicating server ARM ID. + +```yaml +Type: System.String +Parameter Sets: GetByItemID +Aliases: + +Required: True +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). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.IProtectedItemModel + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateProject.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateProject.md new file mode 100644 index 000000000000..3c5bf9e8daab --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateProject.md @@ -0,0 +1,113 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigrateproject +schema: 2.0.0 +--- + +# Get-AzMigrateProject + +## SYNOPSIS +Method to get a migrate project. + +## SYNTAX + +``` +Get-AzMigrateProject -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Method to get a migrate project. + +## EXAMPLES + +### Example 1: Get +```powershell +Get-AzMigrateProject -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -Name BugBashAVSVMware +``` + +```output +ETag Location Name Type +---- -------- ---- ---- + southeastasia BugBashAVSVMware Microsoft.Migrate/MigrateProjects +``` + +Method to get a migrate project. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Migrate project. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MigrateProjectName + +Required: True +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180901Preview.IMigrateProject + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationFabric.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationFabric.md new file mode 100644 index 000000000000..2a69fd708e61 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationFabric.md @@ -0,0 +1,193 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratereplicationfabric +schema: 2.0.0 +--- + +# Get-AzMigrateReplicationFabric + +## SYNOPSIS +Gets the details of an Azure Site Recovery fabric. + +## SYNTAX + +### List (Default) +``` +Get-AzMigrateReplicationFabric -ResourceGroupName -ResourceName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzMigrateReplicationFabric -FabricName -ResourceGroupName -ResourceName + [-SubscriptionId ] [-Filter ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets the details of an Azure Site Recovery fabric. + +## EXAMPLES + +### Example 1: Get all fabrics by resource group and vault name +```powershell +Get-AzMigrateReplicationFabric -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault -FabricName AzMigratePWSHTc8d1replicationfabric +``` + +```output +BcdrState : Valid +CustomDetailInstanceType : VMwareV2 +EncryptionDetailKekCertExpiryDate : +EncryptionDetailKekCertThumbprint : +EncryptionDetailKekState : None +FriendlyName : AzMigratePWSHTc8d1replicationfabric +Health : Normal +HealthErrorDetail : {} +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsof + t.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabr + ic +InternalIdentifier : 501ff8f2-c9d7-5bf4-87ff-d0b3fc98aeb5 +Location : +Name : AzMigratePWSHTc8d1replicationfabric +RolloverEncryptionDetailKekCertExpiryDate : +RolloverEncryptionDetailKekCertThumbprint : +RolloverEncryptionDetailKekState : None +Type : Microsoft.RecoveryServices/vaults/replicationFabrics +``` + +Get all fabrics in resource group and vault + +### Example 2: Get fabric by resource group, vault name and fabric name +```powershell +Get-AzMigrateReplicationFabric -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault +``` + +```output +BcdrState : Valid +CustomDetailInstanceType : VMwareV2 +EncryptionDetailKekCertExpiryDate : +EncryptionDetailKekCertThumbprint : +EncryptionDetailKekState : None +FriendlyName : AzMigratePWSHTc8d1replicationfabric +Health : Normal +HealthErrorDetail : {} +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsof + t.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabr + ic +InternalIdentifier : 501ff8f2-c9d7-5bf4-87ff-d0b3fc98aeb5 +Location : +Name : AzMigratePWSHTc8d1replicationfabric +RolloverEncryptionDetailKekCertExpiryDate : +RolloverEncryptionDetailKekCertThumbprint : +RolloverEncryptionDetailKekState : None +Type : Microsoft.RecoveryServices/vaults/replicationFabrics +``` + +Get a specific fabric + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FabricName +Fabric name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +OData filter options. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the recovery services vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IFabric + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationPolicy.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationPolicy.md new file mode 100644 index 000000000000..ad4ffc076966 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationPolicy.md @@ -0,0 +1,151 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratereplicationpolicy +schema: 2.0.0 +--- + +# Get-AzMigrateReplicationPolicy + +## SYNOPSIS +Gets the details of a replication policy. + +## SYNTAX + +### List (Default) +``` +Get-AzMigrateReplicationPolicy -ResourceGroupName -ResourceName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzMigrateReplicationPolicy -PolicyName -ResourceGroupName -ResourceName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets the details of a replication policy. + +## EXAMPLES + +### Example 1: Get all policies in a vault +```powershell +Get-AzMigrateReplicationPolicy -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault +``` + +```output +Location Name Type +-------- ---- ---- + samplepolicy2 Microsoft.RecoveryServices/vaults/replicationPolicies + samplepolicy1 Microsoft.RecoveryServices/vaults/replicationPolicies + samplePolicy3 Microsoft.RecoveryServices/vaults/replicationPolicies + migrateAzMigratePWSHTc8d1sitepolicy Microsoft.RecoveryServices/vaults/replicationPolicies +``` + +Get all policies. + +### Example 2: Get a specific policy +```powershell +Get-AzMigrateReplicationPolicy -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault -PolicyName migrateAzMigratePWSHTc8d1sitepolicy +``` + +```output +Location Name Type +-------- ---- ---- + migrateAzMigratePWSHTc8d1sitepolicy Microsoft.RecoveryServices/vaults/replicationPolicies +``` + +Get a specific one. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Replication policy name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the recovery services vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IPolicy + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationProtectionContainer.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationProtectionContainer.md new file mode 100644 index 000000000000..a901ac4d8895 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationProtectionContainer.md @@ -0,0 +1,170 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratereplicationprotectioncontainer +schema: 2.0.0 +--- + +# Get-AzMigrateReplicationProtectionContainer + +## SYNOPSIS +Gets the details of a protection container. + +## SYNTAX + +### List1 (Default) +``` +Get-AzMigrateReplicationProtectionContainer -ResourceGroupName -ResourceName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzMigrateReplicationProtectionContainer -FabricName -ProtectionContainerName + -ResourceGroupName -ResourceName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### List +``` +Get-AzMigrateReplicationProtectionContainer -FabricName -ResourceGroupName + -ResourceName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets the details of a protection container. + +## EXAMPLES + +### Example 1: List all protection containers in vault and fabric +```powershell +Get-AzMigrateReplicationProtectionContainer -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault -FabricName AzMigratePWSHTc8d1replicationfabric +``` + +```output +Location Name Type +-------- ---- ---- + AzMigratePWSHTc8d1replicationcontainer Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers +``` + +Lists all. + +### Example 2: Get a specific container +```powershell +Get-AzMigrateReplicationProtectionContainer -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault -FabricName AzMigratePWSHTc8d1replicationfabric -ProtectionContainerName AzMigratePWSHTc8d1replicationcontainer +``` + +```output +Location Name Type +-------- ---- ---- + AzMigratePWSHTc8d1replicationcontainer Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers +``` + +Gets a specific one. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FabricName +Fabric name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionContainerName +Protection container name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the recovery services vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IProtectionContainer + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationProtectionContainerMapping.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationProtectionContainerMapping.md new file mode 100644 index 000000000000..70c5860efb56 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationProtectionContainerMapping.md @@ -0,0 +1,173 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratereplicationprotectioncontainermapping +schema: 2.0.0 +--- + +# Get-AzMigrateReplicationProtectionContainerMapping + +## SYNOPSIS +Gets the details of a protection container mapping. + +## SYNTAX + +### List1 (Default) +``` +Get-AzMigrateReplicationProtectionContainerMapping -ResourceGroupName -ResourceName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzMigrateReplicationProtectionContainerMapping -FabricName -MappingName + -ProtectionContainerName -ResourceGroupName -ResourceName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### List +``` +Get-AzMigrateReplicationProtectionContainerMapping -FabricName -ProtectionContainerName + -ResourceGroupName -ResourceName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets the details of a protection container mapping. + +## EXAMPLES + +### Example 1: Get a specific mapping +```powershell +Get-AzMigrateReplicationProtectionContainerMapping -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault -FabricName AzMigratePWSHTc8d1replicationfabric -ProtectionContainerName AzMigratePWSHTc8d1replicationcontainer -MappingName "containermapping" +``` + +```output +Location Name Type +-------- ---- ---- + containermapping Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings +``` + +Get a mapping detail. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FabricName +Fabric name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MappingName +Protection Container mapping name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionContainerName +Protection container name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the recovery services vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IProtectionContainerMapping + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationRecoveryServicesProvider.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationRecoveryServicesProvider.md new file mode 100644 index 000000000000..aeaa3d721985 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateReplicationRecoveryServicesProvider.md @@ -0,0 +1,151 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratereplicationrecoveryservicesprovider +schema: 2.0.0 +--- + +# Get-AzMigrateReplicationRecoveryServicesProvider + +## SYNOPSIS +Gets the details of registered recovery services provider. + +## SYNTAX + +### List (Default) +``` +Get-AzMigrateReplicationRecoveryServicesProvider -ResourceGroupName -ResourceName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzMigrateReplicationRecoveryServicesProvider -FabricName -ProviderName + -ResourceGroupName -ResourceName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets the details of registered recovery services provider. + +## EXAMPLES + +### Example 1: Get all providers in vault +```powershell +Get-AzMigrateReplicationRecoveryServicesProvider -ResourceGroupName azmigratepwshtestasr13072020 -ResourceName AzMigrateTestProjectPWSH02aarsvault +``` + +```output +Location Name Type +-------- ---- ---- + AzMigratePWSHTc8d1dra Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders +``` + +List all. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FabricName +Fabric name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderName +Recovery services provider name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the recovery services vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IRecoveryServicesProvider + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateRunAsAccount.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateRunAsAccount.md new file mode 100644 index 000000000000..f36b5737a2d8 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateRunAsAccount.md @@ -0,0 +1,149 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigraterunasaccount +schema: 2.0.0 +--- + +# Get-AzMigrateRunAsAccount + +## SYNOPSIS +Method to get run as account. + +## SYNTAX + +### List (Default) +``` +Get-AzMigrateRunAsAccount -ResourceGroupName -SiteName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzMigrateRunAsAccount -AccountName -ResourceGroupName -SiteName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Method to get run as account. + +## EXAMPLES + +### Example 1: List (Default) +```powershell +Get-AzMigrateRunAsAccount -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -SiteName BBVMwareAVScbbcsite +``` + +```output +Name Type +---- ---- +b090bef3-b733-5e34-bc8f-eb6f2701432a Microsoft.OffAzure/VMwareSites/runasaccounts +``` + +List all run as accounts in a site. + +### Example 2: Get +```powershell +Get-AzMigrateRunAsAccount -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -SiteName BBVMwareAVScbbcsite -AccountName b090bef3-b733-5e34-bc8f-eb6f2701432a +``` + +```output +Name Type +---- ---- +b090bef3-b733-5e34-bc8f-eb6f2701432a Microsoft.OffAzure/VMwareSites/runasaccounts +``` + +Get Run as account by name. + +## PARAMETERS + +### -AccountName +Run as account ARM name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +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: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteName +Site name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202001.IVMwareRunAsAccount + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateServerMigrationStatus.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateServerMigrationStatus.md new file mode 100644 index 000000000000..e02e7491065a --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateServerMigrationStatus.md @@ -0,0 +1,335 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigrateservermigrationstatus +schema: 2.0.0 +--- + +# Get-AzMigrateServerMigrationStatus + +## SYNOPSIS +Retrieves the details of the replicating server status. + +## SYNTAX + +### ListByName (Default) +``` +Get-AzMigrateServerMigrationStatus -ProjectName -ResourceGroupName + [-SubscriptionId ] [-Filter ] [-SkipToken ] [-DefaultProfile ] + [] +``` + +### GetByApplianceName +``` +Get-AzMigrateServerMigrationStatus -ApplianceName -ProjectName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetByMachineName +``` +Get-AzMigrateServerMigrationStatus -MachineName -ProjectName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetByPrioritiseServer +``` +Get-AzMigrateServerMigrationStatus -Expedite -MachineName -ProjectName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetHealthByMachineName +``` +Get-AzMigrateServerMigrationStatus -Health -MachineName -ProjectName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Get-AzMigrateServerMigrationStatus cmdlet retrieves the replication status for the replicating server. + +## EXAMPLES + +### Example 1: List status by project name. +```powershell +Get-AzMigrateServerMigrationStatus -ProjectName "cbt-resync-gql" -ResourceGroupName "ankitbaluni-resync-rg" +``` + +```output + +Appliance Server State Progress TimeElapsed TimeRemaining UploadSpeed Health LastSync Datastore ESXiHost +--------- ------ ----- -------- ----------- ------------- ----------- ------ -------- --------- -------- +nosbm-test-ds el41-r5w12r1-3 InitialReplication InProgress 48 % 3 hr 48 min 12 hr 37 min 1230 Mbps Normal - IDCLAB-T100_10TB idclab-vcen65.corp.microsoft.com_10.150.84.28 +nosbm-test-ds el41-r5w2k8r2-1 DeltaReplication Completed - - - - Normal 9/4/2025, 3:04:45 PM IDCLAB-T100_10TB idclab-vcen65.corp.microsoft.com_10.150.84.28 +nosbm-test-ds dsinha-cbt-test DeltaReplication Completed - - - - Normal 9/4/2025, 2:58:21 PM IDCLAB-T100_10TB idclab-vcen65.corp.microsoft.com_10.150.84.28 + + + + +To resolve the health issue use the command +Get-AzMigrateServerMigrationStatus -ProjectName -ResourceGroupName -MachineName -Health +``` + +Get by project name. + +### Example 2: List status by machine name. +```powershell +Get-AzMigrateServerMigrationStatus -ProjectName "cbt-resync-gql" -ResourceGroupName "ankitbaluni-resync-rg" -MachineName "Rhel8-Vm" +``` + +```output +Server Rhel8-Vm is currently healthy. + +Appliance Server State Progress TimeElapsed TimeRemaining UploadSpeed LastSync ESXiHost Datastore +--------- ------ ----- -------- ----------- ------------- ----------- -------- -------- --------- +cbtresyncgql Rhel8-Vm DeltaReplication Completed - - - - 7/14/2025, 9:51:05 PM idclab-vcen8.fareast.corp.microsoft.com_10.150.102.181 IDCLAB-B161-3TB + + + +Disk Level Operation Status: + +Disk State Progress TimeElapsed TimeRemaining UploadSpeed Datastore +---- ----- -------- ----------- ------------- ----------- --------- +Rhel8-Vm DeltaReplication Completed - - - - IDCLAB-B161-3TB +``` + +Get by machine name. + +### Example 3: List status by appliance name. +```powershell +Get-AzMigrateServerMigrationStatus -ProjectName "cbt-resync-gql" -ResourceGroupName "ankitbaluni-resync-rg" -ApplianceName "cbtresyncgql" +``` + +```output +Server State Progress TimeElapsed TimeRemaining UploadSpeed Health LastSync Datastore ESXiHost +------ ----- -------- ----------- ------------- ----------- ------ -------- --------- -------- +el41-r5w12r1-3 InitialReplication InProgress 48 % 3 hr 48 min 12 hr 37 min 1230 Mbps Normal - IDCLAB-T100_10TB idclab-vcen65.corp.microsoft.com_10.150.84.28 +el41-r5w2k8r2-1 DeltaReplication Completed - - - - Normal 9/4/2025, 3:04:45 PM IDCLAB-T100_10TB idclab-vcen65.corp.microsoft.com_10.150.84.28 +dsinha-cbt-test DeltaReplication Completed - - - - Normal 9/4/2025, 2:58:21 PM IDCLAB-T100_10TB idclab-vcen65.corp.microsoft.com_10.150.84.28 + + +To check expedite the operation of a server use the command +Get-AzMigrateServerMigrationStatus -ProjectName -ResourceGroupName -MachineName -Expedite + +To resolve the health issue use the command +Get-AzMigrateServerMigrationStatus -ProjectName -ResourceGroupName -MachineName -Health +``` + +Get by appliance name. + +### Example 4: Expedite replication for a server. +```powershell +Get-AzMigrateServerMigrationStatus -ProjectName "cbt-resync-gql" -ResourceGroupName "ankitbaluni-resync-rg" -MachineName "Rhel8-Vm" -Expedite +``` + +```output +Server Information: + +Appliance Server State Progress TimeElapsed TimeRemaining UploadSpeed LastSync ESXiHost Datastore +--------- ------ ----- -------- ----------- ------------- ----------- -------- -------- --------- +cbtresyncgql Rhel8-Vm DeltaReplication Completed - - - - 7/14/2025, 9:51:05 PM idclab-vcen8.fareast.corp.microsoft.com_10.150.102.181 IDCLAB-B161-3TB + + + +Disk Level Operation Status: + +Disk State Progress TimeElapsed TimeRemaining UploadSpeed Datastore +---- ----- -------- ----------- ------------- ----------- --------- +Rhel8-Vm DeltaReplication Completed - - - - IDCLAB-B161-3TB + + +Resource Sharing: + +The following VMs share at least one resource (Appliance, ESXi Host, or Datastore) with VM 'Rhel8-Vm'. The 'SharedResourceType' and 'SharedResourceName' columns indicate which resource is shared. + +Appliance Server SharedResourceType State TimeRemaining ESXiHost Datastore +--------- ------ ------------------ ----- ------------- -------- --------- +cbtresyncgql wave-selfhost-vm8 Appliance DeltaReplication Completed - idclab-vcen8.fareast.corp.microsoft.com_10.150.102.191 Shared_1TB +cbtresyncgql el41-r5w12r2-1 Appliance DeltaReplication Completed - idclab-vcen65.corp.microsoft.com_10.150.84.28 IDCLAB-T100_10TB +cbtresyncgql el41-r5w2k8r2-1 Appliance DeltaReplication Completed - idclab-vcen65.corp.microsoft.com_10.150.84.28 IDCLAB-T100_10TB +cbtresyncgql el41-r5w12r1-2 Appliance DeltaReplication Completed - idclab-vcen65.corp.microsoft.com_10.150.84.28 IDCLAB-T100_10TB +cbtresyncgql ubuntu22-liverserver-bios-nolvm Appliance, ESXiHost, Datastore DeltaReplication Completed - idclab-vcen8.fareast.corp.microsoft.com_10.150.102.181 IDCLAB-B161-3TB + + +Resource utilization information for migration operations: + +Resource Capacity Utilization for server migrations Total utilization Status +-------- -------- --------------------------------- ----------------- ------ +Appliance RAM Sum : Primary and scale out appliances 32768 MB 1808 MB 7014 MB Underutilized +Appliance CPU Sum : Primary and scale out appliances 4 Cores - 99% At capacity +Network bandwidth Sum : Primary and scale out appliances 1192 MBps - - Underutilized +ESXi host NFC buffer 32 MB 8 MB - Underutilized +Parallel Disks Replicated Sum : Primary and scale out appliances 58 3 - Underutilized +Datastore 'IDCLAB-B161-3TB' Snapshot Count 15 2 - Underutilized + + +Based on the resource utilization seen above, here are suggestions to expedite server Rhel8-Vm migration: + +1. CPU is At capacity. Pause or stop other migrations under this appliance, or increase CPU resources if possible. +``` + +Expedite replication for a specific server. + +## PARAMETERS + +### -ApplianceName +Specifies the name of the appliance. + +```yaml +Type: System.String +Parameter Sets: GetByApplianceName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expedite +Specifies whether to expedite the operation of a replicating server. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GetByPrioritiseServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +OData filter options. + +```yaml +Type: System.String +Parameter Sets: ListByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Health +Specifies whether the health issues to show for replicating server. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: GetHealthByMachineName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MachineName +Specifies the display name of the replicating machine. + +```yaml +Type: System.String +Parameter Sets: GetByMachineName, GetByPrioritiseServer, GetHealthByMachineName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +Specifies the Azure Migrate project in the current subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the Resource Group of the Azure Migrate Project in the current subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipToken +The pagination token. + +```yaml +Type: System.String +Parameter Sets: ListByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +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). + +## INPUTS + +## OUTPUTS + +### System.Management.Automation.PSObject[] + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateServerReplication.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateServerReplication.md new file mode 100644 index 000000000000..e812c7a31a9a --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateServerReplication.md @@ -0,0 +1,413 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigrateserverreplication +schema: 2.0.0 +--- + +# Get-AzMigrateServerReplication + +## SYNOPSIS +Retrieves the details of the replicating server. + +## SYNTAX + +### ListByName (Default) +``` +Get-AzMigrateServerReplication -ProjectName -ResourceGroupName [-SubscriptionId ] + [-Filter ] [-SkipToken ] [-DefaultProfile ] [] +``` + +### GetByInputObject +``` +Get-AzMigrateServerReplication -InputObject [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetByMachineName +``` +Get-AzMigrateServerReplication -MachineName -ProjectName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetBySDSID +``` +Get-AzMigrateServerReplication -DiscoveredMachineId [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetBySRSID +``` +Get-AzMigrateServerReplication -TargetObjectID [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### ListById +``` +Get-AzMigrateServerReplication -ProjectID -ResourceGroupID [-SubscriptionId ] + [-Filter ] [-SkipToken ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Get-AzMigrateServerReplication cmdlet retrieves the object for the replicating server. + +## EXAMPLES + +### Example 1: Get details by id +```powershell +Get-AzMigrateServerReplication -TargetObjectID '/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f' +``` + +```output +AllowedOperation : {DisableMigration, TestMigrate, Migrate} +CurrentJobId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/None +CurrentJobName : None +CurrentJobStartTime : 1/1/53 1:01:01 AM +EventCorrelationId : d8b110c6-3be9-4798-b2d4-9a1cd068adfb +Health : Normal +HealthError : {101883a0-23f7-538a-bbd5-6d8b4fa900e2} +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionCont + ainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af- + e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f +LastTestMigrationStatus : +LastTestMigrationTime : +Location : +MachineName : prsadhu-TestVM +MigrationState : Replicating +MigrationStateDescription : Ready to migrate +Name : bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f +PolicyFriendlyName : migrateAzMigratePWSHTc8d1sitepolicy +PolicyId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationPolicies/migrateAzMigratePWSHTc8d1sitepolicy +ProviderSpecificDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtMigrationDetails +TestMigrateState : None +TestMigrateStateDescription : None +Type : Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems +``` + +Get by id. + +### Example 2: List all in project by id. +```powershell +Get-AzMigrateServerReplication -ResourceGroupID /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020 -ProjectID "/subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Migrate/MigrateProjects/AzMigrateTestProjectPWSH" +``` + +```output +AllowedOperation : {DisableMigration, TestMigrate, Migrate} +CurrentJobId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/None +CurrentJobName : None +CurrentJobStartTime : 1/1/53 1:01:01 AM +EventCorrelationId : d8b110c6-3be9-4798-b2d4-9a1cd068adfb +Health : Normal +HealthError : {101883a0-23f7-538a-bbd5-6d8b4fa900e2} +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionCont + ainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af- + e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f +LastTestMigrationStatus : +LastTestMigrationTime : +Location : +MachineName : prsadhu-TestVM +MigrationState : Replicating +MigrationStateDescription : Ready to migrate +Name : bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f +PolicyFriendlyName : migrateAzMigratePWSHTc8d1sitepolicy +PolicyId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationPolicies/migrateAzMigratePWSHTc8d1sitepolicy +ProviderSpecificDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtMigrationDetails +TestMigrateState : None +TestMigrateStateDescription : None +Type : Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems + +AllowedOperation : {DisableMigration, TestMigrate, Migrate} +CurrentJobId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/None +CurrentJobName : None +CurrentJobStartTime : 1/1/53 1:01:01 AM +EventCorrelationId : 57b59212-6a2f-4333-8882-461647bb05f9 +Health : Normal +HealthError : {593b735d-2a34-53b2-b8ed-e33da5650703} +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionCont + ainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af- + e206c9ca4f93_500f44f8-2aa3-587b-8958-ead358639629 +LastTestMigrationStatus : +LastTestMigrationTime : +Location : +MachineName : rb-w2k12r2-1 +MigrationState : Replicating +MigrationStateDescription : Ready to migrate +Name : bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_500f44f8-2aa3-587b-8958-ead358639629 +PolicyFriendlyName : migrateAzMigratePWSHTc8d1sitepolicy +PolicyId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationPolicies/migrateAzMigratePWSHTc8d1sitepolicy +ProviderSpecificDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtMigrationDetails +TestMigrateState : None +TestMigrateStateDescription : None +Type : Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems +``` + +List all. + +### Example 3: List all in project by name. +```powershell +Get-AzMigrateServerReplication -ResourceGroupName azmigratepwshtestasr13072020 -ProjectName AzMigrateTestProjectPWSH +``` + +```output +AllowedOperation : {DisableMigration, TestMigrate, Migrate} +CurrentJobId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/None +CurrentJobName : None +CurrentJobStartTime : 1/1/53 1:01:01 AM +EventCorrelationId : d8b110c6-3be9-4798-b2d4-9a1cd068adfb +Health : Normal +HealthError : {101883a0-23f7-538a-bbd5-6d8b4fa900e2} +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionCont + ainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af- + e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f +LastTestMigrationStatus : +LastTestMigrationTime : +Location : +MachineName : prsadhu-TestVM +MigrationState : Replicating +MigrationStateDescription : Ready to migrate +Name : bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f +PolicyFriendlyName : migrateAzMigratePWSHTc8d1sitepolicy +PolicyId : /Subscriptions/7xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationPolicies/migrateAzMigratePWSHTc8d1sitepolicy +ProviderSpecificDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtMigrationDetails +TestMigrateState : None +TestMigrateStateDescription : None +Type : Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems + +AllowedOperation : {DisableMigration, TestMigrate, Migrate} +CurrentJobId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/None +CurrentJobName : None +CurrentJobStartTime : 1/1/53 1:01:01 AM +EventCorrelationId : 57b59212-6a2f-4333-8882-461647bb05f9 +Health : Normal +HealthError : {593b735d-2a34-53b2-b8ed-e33da5650703} +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionCont + ainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af- + e206c9ca4f93_500f44f8-2aa3-587b-8958-ead358639629 +LastTestMigrationStatus : +LastTestMigrationTime : +Location : +MachineName : rb-w2k12r2-1 +MigrationState : Replicating +MigrationStateDescription : Ready to migrate +Name : bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_500f44f8-2aa3-587b-8958-ead358639629 +PolicyFriendlyName : migrateAzMigratePWSHTc8d1sitepolicy +PolicyId : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServ + ices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationPolicies/migrateAzMigratePWSHTc8d1sitepolicy +ProviderSpecificDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtMigrationDetails +TestMigrateState : None +TestMigrateStateDescription : None +Type : Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems +``` + +List all. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiscoveredMachineId +Specifies the machine ID of the discovered server. + +```yaml +Type: System.String +Parameter Sets: GetBySDSID +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +OData filter options. + +```yaml +Type: System.String +Parameter Sets: ListById, ListByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the machine object of the replicating server. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IMigrationItem +Parameter Sets: GetByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MachineName +Specifies the display name of the replicating machine. + +```yaml +Type: System.String +Parameter Sets: GetByMachineName +Aliases: + +Required: True +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: System.String +Parameter Sets: ListById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +Specifies the Azure Migrate project in the current subscription. + +```yaml +Type: System.String +Parameter Sets: GetByMachineName, ListByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupID +Specifies the Resource Group of the Azure Migrate Project in the current subscription. + +```yaml +Type: System.String +Parameter Sets: ListById +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the Resource Group of the Azure Migrate Project in the current subscription. + +```yaml +Type: System.String +Parameter Sets: GetByMachineName, ListByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipToken +The pagination token. + +```yaml +Type: System.String +Parameter Sets: ListById, ListByName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replicating server. + +```yaml +Type: System.String +Parameter Sets: GetBySRSID +Aliases: + +Required: True +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IMigrationItem + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateSite.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateSite.md new file mode 100644 index 000000000000..8c7266aa8535 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateSite.md @@ -0,0 +1,115 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratesite +schema: 2.0.0 +--- + +# Get-AzMigrateSite + +## SYNOPSIS +Method to get a site. + +## SYNTAX + +``` +Get-AzMigrateSite -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Method to get a site. + +## EXAMPLES + +### Example 1: Get (Default) +```powershell +Get-AzMigrateSite -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -SiteName BBVMwareAVScbbcsite +``` + +```output +ETag Location Name Type +---- -------- ---- ---- + southeastasia BBVMwareAVScbbcsite Microsoft.OffAzure/VMwareSites + +``` + +Get site by name + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Site name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SiteName + +Required: True +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: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202001.IVMwareSite + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateSolution.md b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateSolution.md new file mode 100644 index 000000000000..54a477416235 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Get-AzMigrateSolution.md @@ -0,0 +1,128 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/get-azmigratesolution +schema: 2.0.0 +--- + +# Get-AzMigrateSolution + +## SYNOPSIS +Gets a solution in the migrate project. + +## SYNTAX + +``` +Get-AzMigrateSolution -MigrateProjectName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets a solution in the migrate project. + +## EXAMPLES + +### Example 1: Get +```powershell +Get-AzMigrateSolution -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -MigrateProjectName BugBashAVSVMware -Name Servers-Migration-ServerMigration +``` + +```output +Etag Name Type +---- ---- ---- +"010097f1-0000-1800-0000-5ee9ae2b0000" Servers-Migration-ServerMigration Microsoft.Migrate/MigrateProjec… +``` + +Get Migrate project solution by name. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateProjectName +Name of the Azure Migrate project. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Unique name of a migration solution within a migrate project. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SolutionName + +Required: True +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180901Preview.ISolution + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Initialize-AzMigrateLocalReplicationInfrastructure.md b/src/Migrate/Migrate.Autorest/docs/Initialize-AzMigrateLocalReplicationInfrastructure.md new file mode 100644 index 000000000000..0926922b75f5 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Initialize-AzMigrateLocalReplicationInfrastructure.md @@ -0,0 +1,217 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/initialize-azmigratelocalreplicationinfrastructure +schema: 2.0.0 +--- + +# Initialize-AzMigrateLocalReplicationInfrastructure + +## SYNOPSIS +Initializes the infrastructure for the migrate project. + +## SYNTAX + +``` +Initialize-AzMigrateLocalReplicationInfrastructure -ProjectName -ResourceGroupName + -SourceApplianceName -TargetApplianceName [-CacheStorageAccountId ] + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +The Initialize-AzMigrateLocalReplicationInfrastructure cmdlet initializes the infrastructure for the migrate project in AzLocal scenario. + +## EXAMPLES + +### Example 1: Initialize AzLocal replication infrastructure +```powershell +Initialize-AzMigrateLocalReplicationInfrastructure -ProjectName "testproj" -ResourceGroupName "test-rg" -SourceApplianceName "testsrcapp" -TargetApplianceName "testtgtapp" -PassThru:$true +``` + +```output +$true +``` + +Initialize AzLocal replication infrastructure. +Cache storage account, replication policy, and replication extension will be created automatically. + +### Example 2: Initialize AzLocal replication infrastructure with custom cache storage account +```powershell +$cacheStorageAccountId = "/subscriptions/xxx-xxx-xxxx/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/testSa" + +Initialize-AzMigrateLocalReplicationInfrastructure -ProjectName "testproj" -ResourceGroupName "test-rg" -CacheStorageAccountId $cacheStorageAccountId -SourceApplianceName "testsrcapp" -TargetApplianceName "testtgtapp" -PassThru:$true +``` + +```output +$true +``` + +Initialize AzLocal replication infrastructure with custom cache storage account. +Replication policy and replication extension will be created automatically. + +## PARAMETERS + +### -CacheStorageAccountId +Specifies the Storage Account ARM Id to be used for private endpoint scenario. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the Resource Group of the Azure Migrate Project in the current subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceApplianceName +Specifies the source appliance name for the AzLocal scenario. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetApplianceName +Specifies the target appliance name for the AzLocal scenario. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Initialize-AzMigrateReplicationInfrastructure.md b/src/Migrate/Migrate.Autorest/docs/Initialize-AzMigrateReplicationInfrastructure.md new file mode 100644 index 000000000000..32e4cc529376 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Initialize-AzMigrateReplicationInfrastructure.md @@ -0,0 +1,198 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/initialize-azmigratereplicationinfrastructure +schema: 2.0.0 +--- + +# Initialize-AzMigrateReplicationInfrastructure + +## SYNOPSIS +Initialises the infrastructure for the migrate project. + +## SYNTAX + +``` +Initialize-AzMigrateReplicationInfrastructure -ProjectName -ResourceGroupName + -Scenario -TargetRegion [-CacheStorageAccountId ] [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +The Initialize-AzMigrateReplicationInfrastructure cmdlet initialises the infrastructure for the migrate project. + +## EXAMPLES + +### Example 1: Initialises the infrastructure for the migrate project. +```powershell +Initialize-AzMigrateReplicationInfrastructure -ResourceGroupName TestRG -ProjectName TestProject -TargetRegion centralus +``` + +```output +True +``` + +Initialises the infrastructure for the migrate project. + +### Example 2: Initialises the infrastructure for the migrate project for private endpoint scenario. +```powershell +Initialize-AzMigrateReplicationInfrastructure -ResourceGroupName "TestRG" -ProjectName "TestPEProject" -TargetRegion "centraluseuap" -Scenario "agentlessVMware" -CacheStorageAccountId "/subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/singhabh-rg/providers/Microsoft.Storage/storageAccounts/singhabhstoragepe1" +``` + +```output +True +``` + +Initialises the infrastructure for the migrate project for private endpoint scenario. + +## PARAMETERS + +### -CacheStorageAccountId +Specifies the Storage Account Id to be used for private endpoint scenario. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the Resource Group of the Azure Migrate Project in the current subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scenario +Specifies the server migration scenario for which the replication infrastructure needs to be initialized. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetRegion +Specifies the target Azure region for server migrations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateDiskMapping.md b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateDiskMapping.md new file mode 100644 index 000000000000..a7572b915e98 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateDiskMapping.md @@ -0,0 +1,125 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratediskmapping +schema: 2.0.0 +--- + +# New-AzMigrateDiskMapping + +## SYNOPSIS +Creates a new disk mapping + +## SYNTAX + +``` +New-AzMigrateDiskMapping -DiskID -DiskType -IsOSDisk + [-DiskEncryptionSetID ] [] +``` + +## DESCRIPTION +The New-AzMigrateDiskMapping cmdlet creates a mapping of the source disk attached to the server to be migrated + +## EXAMPLES + +### Example 1: Make Standard disks +```powershell +New-AzMigrateDiskMapping -DiskID a -DiskType Standard_LRS -IsOSDisk 'true' +``` + +```output +DiskEncryptionSetId DiskId DiskType IsOSDisk LogStorageAccountId LogStorageAccountSasSecretName +------------------- ------ -------- -------- ------------------- ------------------------------ + a Standard_LRS true +``` + + + +### Example 2: Make Premium V2 disks +```powershell +New-AzMigrateDiskMapping -DiskID b -DiskType PremiumV2_LRS -IsOSDisk 'false' +``` + +```output +DiskEncryptionSetId DiskId DiskType IsOSDisk LogStorageAccountId LogStorageAccountSasSecretName +------------------- ------ -------- -------- ------------------- ------------------------------ + b PremiumV2_LRS false +``` + +Get disks object to provide input for New-AzMigrateServerReplication + +## PARAMETERS + +### -DiskEncryptionSetID +Specifies the disk encryption set to be used. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskID +Specifies the disk ID of the disk attached to the discovered server to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskType +Specifies the type of disks to be used for the Azure VM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsOSDisk +Specifies whether the disk contains the Operating System for the source server to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtDiskInput + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalDiskMappingObject.md b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalDiskMappingObject.md new file mode 100644 index 000000000000..670e8da26f12 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalDiskMappingObject.md @@ -0,0 +1,146 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratelocaldiskmappingobject +schema: 2.0.0 +--- + +# New-AzMigrateLocalDiskMappingObject + +## SYNOPSIS +Creates a new disk mapping + +## SYNTAX + +``` +New-AzMigrateLocalDiskMappingObject -DiskID -Format -IsDynamic -IsOSDisk + -Size [-PhysicalSectorSize ] [] +``` + +## DESCRIPTION +The New-AzMigrateLocalDiskMappingObject cmdlet creates a mapping of the source disk attached to the server to be migrated + +## EXAMPLES + +### Example 1: Creates Disk to migrate +```powershell +New-AzMigrateLocalDiskMappingObject -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-AzMigrateLocalServerReplication + +## PARAMETERS + +### -DiskID +Specifies the disk ID of the disk attached to the discovered server to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Format +Specifies the disk format. +'VHD' or 'VHDX' for Hyper-V Generation 1; 'VHDX' for Hyper-V Generation 2. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDynamic +Specifies whether the disk is dynamic. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsOSDisk +Specifies whether the disk contains the Operating System for the source server to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhysicalSectorSize +Specifies the disk physical sector size in bytes. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Size +Specifies the disk size in GB. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: True +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.AzLocalDiskInput + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalNicMappingObject.md b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalNicMappingObject.md new file mode 100644 index 000000000000..f912bbd8844a --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalNicMappingObject.md @@ -0,0 +1,114 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratelocalnicmappingobject +schema: 2.0.0 +--- + +# New-AzMigrateLocalNicMappingObject + +## SYNOPSIS +Creates an object to update NIC properties of a replicating server. + +## SYNTAX + +``` +New-AzMigrateLocalNicMappingObject -NicID [-CreateAtTarget ] + [-TargetTestVirtualSwitchId ] [-TargetVirtualSwitchId ] [] +``` + +## DESCRIPTION +The New-AzMigrateLocalNicMappingObject cmdlet creates a mapping of the source NIC attached to the server to be migrated. +This object is provided as an input to the Set-AzMigrateServerReplication cmdlet to update the NIC and its properties for a replicating server. + +## EXAMPLES + +### Example 1: Create NIC to migrate +```powershell +New-AzMigrateLocalNicMappingObject -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-AzMigrateLocalServerReplication and Set-AzMigrateLocalServerReplication + +## PARAMETERS + +### -CreateAtTarget +Specifies whether this Nic should be created at target. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NicID +Specifies the ID of the NIC to be updated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVirtualSwitchId +Specifies the logical network ARM ID that the VMs will use. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.AzLocalNicInput + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalServerReplication.md b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalServerReplication.md new file mode 100644 index 000000000000..34b3ad132421 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateLocalServerReplication.md @@ -0,0 +1,422 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratelocalserverreplication +schema: 2.0.0 +--- + +# New-AzMigrateLocalServerReplication + +## SYNOPSIS +Starts replication for the specified server. + +## SYNTAX + +### ByIdDefaultUser (Default) +``` +New-AzMigrateLocalServerReplication -MachineId -OSDiskID -SourceApplianceName + -TargetApplianceName -TargetResourceGroupId -TargetStoragePathId + -TargetVirtualSwitchId -TargetVMName [-IsDynamicMemoryEnabled ] + [-MigrateAsArcVM ] [-SubscriptionId ] [-TargetTestVirtualSwitchId ] + [-TargetVMCPUCore ] [-TargetVMRam ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### ByIdPowerUser +``` +New-AzMigrateLocalServerReplication -DiskToInclude -MachineId + -NicToInclude -SourceApplianceName -TargetApplianceName + -TargetResourceGroupId -TargetStoragePathId -TargetVMName + [-IsDynamicMemoryEnabled ] [-MigrateAsArcVM ] [-SubscriptionId ] + [-TargetVMCPUCore ] [-TargetVMRam ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +The New-AzMigrateLocalServerReplication cmdlet starts the replication for a particular discovered server in the Azure Migrate project. + +## EXAMPLES + +### Example 1: When there is only OS disk to migrate +```powershell +New-AzMigrateLocalServerReplication -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" +``` + +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails +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 : +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 +[AzLocalDiskInput[]]$DisksToInclude = @() +$OSDisk = New-AzMigrateLocalDiskMappingObject -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-AzMigrateLocalDiskMappingObject -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 + +[AzLocalNicInput[]]$NicsToInclude = @() +$Nic = New-AzMigrateLocalNicMappingObject -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-AzMigrateLocalServerReplication -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.Api20240901.JobModelCustomPropertiesAffectedObjectDetails +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 : +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 + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskToInclude +Specifies the disks on the source server to be included for replication. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.AzLocalDiskInput[] +Parameter Sets: ByIdPowerUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDynamicMemoryEnabled +Specifies if RAM is dynamic or not. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MachineId +Specifies the machine ARM ID of the discovered server to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateAsArcVM +Specifies whether the VM should be migrated as an Arc VM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NicToInclude +Specifies the NICs on the source server to be included for replication. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.AzLocalNicInput[] +Parameter Sets: ByIdPowerUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSDiskID +Specifies the operating system disk for the source server to be migrated. + +```yaml +Type: System.String +Parameter Sets: ByIdDefaultUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceApplianceName +Specifies the source appliance name for the AzLocal scenario. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetApplianceName +Specifies the target appliance name for the AzLocal scenario. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroupId +Specifies the target resource group ARM ID where the migrated VM resources will reside. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetStoragePathId +Specifies the storage path ARM ID where the VMs will be stored. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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: System.String +Parameter Sets: ByIdDefaultUser +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVirtualSwitchId +Specifies the logical network ARM ID that the VMs will use. + +```yaml +Type: System.String +Parameter Sets: ByIdDefaultUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVMCPUCore +Specifies the number of CPU cores. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVMName +Specifies the name of the VM to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVMRam +Specifies the target RAM size in MB. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.IJobModel + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateNicMapping.md b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateNicMapping.md new file mode 100644 index 000000000000..d7ccb819216b --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateNicMapping.md @@ -0,0 +1,159 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratenicmapping +schema: 2.0.0 +--- + +# New-AzMigrateNicMapping + +## SYNOPSIS +Creates an object to update NIC properties of a replicating server. + +## SYNTAX + +``` +New-AzMigrateNicMapping -NicID [-TargetNicIP ] [-TargetNicName ] + [-TargetNicSelectionType ] [-TargetNicSubnet ] [-TestNicIP ] + [-TestNicSubnet ] [] +``` + +## DESCRIPTION +The New-AzMigrateNicMapping cmdlet creates a mapping of the source NIC attached to the server to be migrated. +This object is provided as an input to the Set-AzMigrateServerReplication cmdlet to update the NIC and its properties for a replicating server. + +## EXAMPLES + +### Example 1: Create a NIC object +```powershell +New-AzMigrateNicMapping -NicID a2399354-653a-464e-a567-d30ef5467a31 -TargetNicSelectionType primary -TargetNicIP "172.17.1.17" +``` + +```output +IsPrimaryNic IsSelectedForMigration NicId TargetStaticIPAddress TargetSubnetName +------------ ---------------------- ----- --------------------- ---------------- +false false a2399354-653a-464e-a567-d30ef5467a31 +``` + +Creates a NIC update object. + +## PARAMETERS + +### -NicID +Specifies the ID of the NIC to be updated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNicName +Specifies the name of the NIC to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNicSelectionType +Specifies whether the NIC to be updated will be the primary, secondary or not migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNicSubnet +Specifies the Subnet name for the NIC in the destination Virtual Network to which the server needs to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestNicIP +Specifies the IP within the destination test subnet to be used for the NIC. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtNicInput + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateProject.md b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateProject.md new file mode 100644 index 000000000000..acc0f929111a --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateProject.md @@ -0,0 +1,173 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigrateproject +schema: 2.0.0 +--- + +# New-AzMigrateProject + +## SYNOPSIS +Creates a new Migrate project. + +## SYNTAX + +``` +New-AzMigrateProject -Location -Name -ResourceGroupName [-ETag ] + [-Property ] [-SubscriptionId ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a new Migrate project. + +## EXAMPLES + +### Example 1: Create (Default) +```powershell +New-AzMigrateProject -SubscriptionId xxx-xxx-xxx -ResourceGroupName kuchaturimpkocrg1 -Name kuchaturimpkocrg1pwshp14 -Location "centralus" +``` + +```output +ETag Location Name Type +---- -------- ---- ---- + centralus kuchaturimpkocrg1pwshp14 Microsoft.Migrate/MigrateProjects + +``` + +Method to create a new migrate project. + +## PARAMETERS + +### -ETag +Specifies the VMware machine name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Specifies the VMware machine name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the migrate project name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180901Preview.IMigrateProjectProperties +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Specifies the resource group name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Specifies the subscription id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateReplicationPolicy.md b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateReplicationPolicy.md new file mode 100644 index 000000000000..e873c853e9e1 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateReplicationPolicy.md @@ -0,0 +1,212 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratereplicationpolicy +schema: 2.0.0 +--- + +# New-AzMigrateReplicationPolicy + +## SYNOPSIS +The operation to create a replication policy. + +## SYNTAX + +``` +New-AzMigrateReplicationPolicy -PolicyName -ResourceGroupName -ResourceName + [-SubscriptionId ] [-ProviderSpecificInput ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +The operation to create a replication policy. + +## EXAMPLES + +### Example 1: Create a replication policy +```powershell +$providerSpecificPolicy = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtPolicyCreationInput]::new() +$providerSpecificPolicy.AppConsistentFrequencyInMinute = 240 +$providerSpecificPolicy.InstanceType = "VMwareCbt" +$providerSpecificPolicy.RecoveryPointHistoryInMinute = 4320 +$providerSpecificPolicy.CrashConsistentFrequencyInMinute = 60 +New-AzMigrateReplicationPolicy -PolicyName TestPolicy -ResourceGroupName ResourceGroup -ResourceName VaultName -SubscriptionId SubscriptionId -ProviderSpecificInput $providerSpecificPolicy +``` + +```output +Location Name Type +-------- ---- ---- + TestPolicy Microsoft.RecoveryServices/vaults/replicationPolicies + +``` + +Creates a policy for VmWare Cbt + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Replication policy name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IPolicyProviderSpecificInput +Parameter Sets: (All) +Aliases: + +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the recovery services vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IPolicy + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateReplicationProtectionContainerMapping.md b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateReplicationProtectionContainerMapping.md new file mode 100644 index 000000000000..3c9e54dc8d14 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateReplicationProtectionContainerMapping.md @@ -0,0 +1,278 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratereplicationprotectioncontainermapping +schema: 2.0.0 +--- + +# New-AzMigrateReplicationProtectionContainerMapping + +## SYNOPSIS +The operation to create a protection container mapping. + +## SYNTAX + +``` +New-AzMigrateReplicationProtectionContainerMapping -FabricName -MappingName + -ProtectionContainerName -ResourceGroupName -ResourceName + [-SubscriptionId ] [-PolicyId ] + [-ProviderSpecificInput ] + [-TargetProtectionContainerId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +The operation to create a protection container mapping. + +## EXAMPLES + +### Example 1: Create a mapping +```powershell +$providerSpecificInput = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtContainerMappingInput]::new() +$providerSpecificInput.InstanceType = "VMwareCbt" +$providerSpecificInput.KeyVaultId = "/subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.KeyVault/vaults/migratekv846827101" +$providerSpecificInput.KeyVaultUri = "https://migratekv846827101.vault.azure.net" +$providerSpecificInput.ServiceBusConnectionStringSecretName = "ServiceBusConnectionString" +$providerSpecificInput.StorageAccountId = "/subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Storage/storageAccounts/migrategwsa846827101" +$providerSpecificInput.StorageAccountSasSecretName = "migrategwsa846827101-gwySas" +$providerSpecificInput.TargetLocation = "centraluseuap" + +New-AzMigrateReplicationProtectionContainerMapping -FabricName "AzMigratePWSHTc8d1replicationfabric" -MappingName "containermapping" -ProtectionContainerName "AzMigratePWSHTc8d1replicationcontainer" -ResourceGroupName "azmigratepwshtestasr13072020" -ResourceName "AzMigrateTestProjectPWSH02aarsvault" -PolicyId "/subscriptionsxxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationPolicies/migrateAzMigratePWSHTc8d1sitepolicy" -ProviderSpecificInput $providerSpecificInput -TargetProtectionContainerId "Microsoft Azure" +``` + +```output +Location Name Type +-------- ---- ---- + containermapping Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings +``` + +Create a mapping + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FabricName +Fabric name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MappingName +Protection container mapping name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyId +Applicable policy. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProtectionContainerName +Protection container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProviderSpecificInput +Provider specific input for pairing. +To construct, see NOTES section for PROVIDERSPECIFICINPUT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IReplicationProviderSpecificContainerMappingInput +Parameter Sets: (All) +Aliases: + +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the recovery services vault. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetProtectionContainerId +The target unique protection container name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IProtectionContainerMapping + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateServerReplication.md b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateServerReplication.md new file mode 100644 index 000000000000..8520a25013bf --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateServerReplication.md @@ -0,0 +1,642 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigrateserverreplication +schema: 2.0.0 +--- + +# New-AzMigrateServerReplication + +## SYNOPSIS +Starts replication for the specified server. + +## SYNTAX + +### ByIdDefaultUser (Default) +``` +New-AzMigrateServerReplication -DiskType -LicenseType -MachineId -OSDiskID + -TargetNetworkId -TargetResourceGroupId -TargetSubnetName -TargetVMName + [-DiskEncryptionSetID ] [-DiskTag ] + [-LinuxLicenseType ] [-NicTag ] + [-PerformAutoResync ] [-SqlServerLicenseType ] [-SubscriptionId ] [-Tag ] + [-TargetAvailabilitySet ] [-TargetAvailabilityZone ] + [-TargetBootDiagnosticsStorageAccount ] [-TargetCapacityReservationGroupId ] + [-TargetSecurityType ] [-TargetVMSecureBootEnabled ] [-TargetVMSize ] + [-TestNetworkId ] [-TestSubnetName ] [-VMTag ] + [-VMWarerunasaccountID ] [-DefaultProfile ] [] +``` + +### ByIdPowerUser +``` +New-AzMigrateServerReplication -DiskToInclude -LicenseType + -MachineId -TargetNetworkId -TargetResourceGroupId -TargetSubnetName + -TargetVMName [-DiskTag ] [-LinuxLicenseType ] + [-NicTag ] [-PerformAutoResync ] + [-SqlServerLicenseType ] [-SubscriptionId ] [-Tag ] + [-TargetAvailabilitySet ] [-TargetAvailabilityZone ] + [-TargetBootDiagnosticsStorageAccount ] [-TargetCapacityReservationGroupId ] + [-TargetSecurityType ] [-TargetVMSecureBootEnabled ] [-TargetVMSize ] + [-TestNetworkId ] [-TestSubnetName ] [-VMTag ] + [-VMWarerunasaccountID ] [-DefaultProfile ] [] +``` + +### ByInputObjectDefaultUser +``` +New-AzMigrateServerReplication -DiskType -InputObject -LicenseType + -OSDiskID -TargetNetworkId -TargetResourceGroupId -TargetSubnetName + -TargetVMName [-DiskEncryptionSetID ] + [-DiskTag ] [-LinuxLicenseType ] + [-NicTag ] [-PerformAutoResync ] + [-SqlServerLicenseType ] [-SubscriptionId ] [-Tag ] + [-TargetAvailabilitySet ] [-TargetAvailabilityZone ] + [-TargetBootDiagnosticsStorageAccount ] [-TargetCapacityReservationGroupId ] + [-TargetSecurityType ] [-TargetVMSecureBootEnabled ] [-TargetVMSize ] + [-TestNetworkId ] [-TestSubnetName ] [-VMTag ] + [-VMWarerunasaccountID ] [-DefaultProfile ] [] +``` + +### ByInputObjectPowerUser +``` +New-AzMigrateServerReplication -DiskToInclude -InputObject + -LicenseType -TargetNetworkId -TargetResourceGroupId -TargetSubnetName + -TargetVMName [-DiskTag ] [-LinuxLicenseType ] + [-NicTag ] [-PerformAutoResync ] + [-SqlServerLicenseType ] [-SubscriptionId ] [-Tag ] + [-TargetAvailabilitySet ] [-TargetAvailabilityZone ] + [-TargetBootDiagnosticsStorageAccount ] [-TargetCapacityReservationGroupId ] + [-TargetSecurityType ] [-TargetVMSecureBootEnabled ] [-TargetVMSize ] + [-TestNetworkId ] [-TestSubnetName ] [-VMTag ] + [-VMWarerunasaccountID ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The New-AzMigrateServerReplication cmdlet starts the replication for a particular discovered server in the Azure Migrate project. + +## EXAMPLES + +### Example 1: When there is only OS disk +```powershell +New-AzMigrateServerReplication -MachineId "/subscriptions/xxx-xxx-xxx4/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.OffAzure/VMwareSites/AzMigratePWSHTc8d1site/machines/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f" -LicenseType NoLicenseType -TargetResourceGroupId "/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG" -TargetNetworkId "/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG/providers/Microsoft.Network/virtualNetworks/AzMigrateTargetNetwork" -TargetSubnetName default -TargetVMName "prsadhu-TestVM" -DiskType "Standard_LRS" -OSDiskID "6000C299-343d-7bcd-c05e-a94bd63316dd" +``` + +```output +ActivityId : 68af14b4-46ae-48d1-b3e9-cdcffb9e8a93 ActivityId: 74d1a396-1d37-4264-8a5b-b727aaef0171 +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : 9/16/20 11:57:33 AM +Error : {} +FriendlyName : Enable +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/997e2a92-5afe-49c7-a81a-89660aec9b7b +Location : +Name : 997e2a92-5afe-49c7-a81a-89660aec9b7b +ScenarioName : Enable +StartTime : 9/16/20 11:57:32 AM +State : Succeeded +StateDescription : Completed +TargetInstanceType : ProtectionProfile +TargetObjectId : 42752b89-5fad-52fd-bf93-679fbdb6fed9 +TargetObjectName : migrateAzMigratePWSHTc8d1sitepolicy +Task : {CloudPairingPrerequisitesCheck, CloudPairingPrepareSite} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +This is for the scenario, when there is only one single disk that has to be protected. + +### Example 2: When there are multiple disks +```powershell +$OSDisk = New-AzMigrateDiskMapping -DiskID '6000C299-343d-7bcd-c05e-a94bd63316dd' -DiskType 'Standard_LRS' -IsOSDisk 'true' +$DataDisk = New-AzMigrateDiskMapping -DiskID '7000C299-343d-7bcd-c05e-a94bd63316dd' -DiskType 'Standard_LRS' -IsOSDisk 'false' +$DisksToInclude = @() +$DisksToInclude += $OSDisk +$DisksToInclude += $DataDisk +New-AzMigrateServerReplication -MachineId "/subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.OffAzure/VMwareSites/AzMigratePWSHTc8d1site/machines/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f" -LicenseType NoLicenseType -TargetResourceGroupId "/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG" -TargetNetworkId "/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG/providers/Microsoft.Network/virtualNetworks/AzMigrateTargetNetwork" -TargetSubnetName default -TargetVMName "prsadhu-TestVM" -DiskToInclude $DisksToInclude -PerformAutoResync true +``` + +```output +ActivityId : 68af14b4-46ae-48d1-b3e9-cdcffb9e8a93 ActivityId: 74d1a396-1d37-4264-8a5b-b727aaef0171 +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : 9/16/20 11:57:33 AM +Error : {} +FriendlyName : Enable +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/997e2a92-5afe-49c7-a81a-89660aec9b7b +Location : +Name : 997e2a92-5afe-49c7-a81a-89660aec9b7b +ScenarioName : Enable +StartTime : 9/16/20 11:57:32 AM +State : Succeeded +StateDescription : Completed +TargetInstanceType : ProtectionProfile +TargetObjectId : 42752b89-5fad-52fd-bf93-679fbdb6fed9 +TargetObjectName : migrateAzMigratePWSHTc8d1sitepolicy +Task : {CloudPairingPrerequisitesCheck, CloudPairingPrepareSite} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +This is for the scenario, when there are multiple disks that has to be protected. + +### Example 3: With Trusted Launch security type +```powershell +New-AzMigrateServerReplication -MachineId "/subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.OffAzure/VMwareSites/AzMigratePWSHTc8d1site/machines/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f" -LicenseType NoLicenseType -TargetResourceGroupId "/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG" -TargetNetworkId "/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG/providers/Microsoft.Network/virtualNetworks/AzMigrateTargetNetwork" -TargetSubnetName default -TargetVMName "prsadhu-TestVM" -DiskType "Standard_LRS" -OSDiskID "6000C299-343d-7bcd-c05e-a94bd63316dd" -TargetSecurityType "TrustedLaunch" -TargetVMSecureBootEnabled $true +``` + +```output +ActivityId : 68af14b4-46ae-48d1-b3e9-cdcffb9e8a93 ActivityId: 74d1a396-1d37-4264-8a5b-b727aaef0171 +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : 9/16/20 11:57:33 AM +Error : {} +FriendlyName : Enable +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/997e2a92-5afe-49c7-a81a-89660aec9b7b +Location : +Name : 997e2a92-5afe-49c7-a81a-89660aec9b7b +ScenarioName : Enable +StartTime : 9/16/20 11:57:32 AM +State : Succeeded +StateDescription : Completed +TargetInstanceType : ProtectionProfile +TargetObjectId : 42752b89-5fad-52fd-bf93-679fbdb6fed9 +TargetObjectName : migrateAzMigratePWSHTc8d1sitepolicy +Task : {CloudPairingPrerequisitesCheck, CloudPairingPrepareSite} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +This is for the scenario when replication is started with TrustedLaunch security type and secure boot enabled on the target Azure VM. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskEncryptionSetID +Specifies the disk encryption set to be used. + +```yaml +Type: System.String +Parameter Sets: ByIdDefaultUser, ByInputObjectDefaultUser +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskTag +Specifies the tag to be used for disk creation. +To construct, see NOTES section for DISKTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtEnableMigrationInputTargetDiskTags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskToInclude +Specifies the disks on the source server to be included for replication. +To construct, see NOTES section for DISKTOINCLUDE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtDiskInput[] +Parameter Sets: ByIdPowerUser, ByInputObjectPowerUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskType +Specifies the type of disks to be used for the Azure VM. + +```yaml +Type: System.String +Parameter Sets: ByIdDefaultUser, ByInputObjectDefaultUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the discovered server to be migrated. +The server object can be retrieved using the Get-AzMigrateServer cmdlet. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202001.IVMwareMachine +Parameter Sets: ByInputObjectDefaultUser, ByInputObjectPowerUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LicenseType +Specifies if Azure Hybrid benefit is applicable for the source server to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinuxLicenseType +Specifies if Azure Hybrid benefit is applicable for the source linux server to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MachineId +Specifies the machine ID of the discovered server to be migrated. + +```yaml +Type: System.String +Parameter Sets: ByIdDefaultUser, ByIdPowerUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NicTag +Specifies the tag to be used for NIC creation. +To construct, see NOTES section for NICTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtEnableMigrationInputTargetNicTags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OSDiskID +Specifies the Operating System disk for the source server to be migrated. + +```yaml +Type: System.String +Parameter Sets: ByIdDefaultUser, ByInputObjectDefaultUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PerformAutoResync +Specifies if replication be auto-repaired in case change tracking is lost for the source server under replication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Specifies the tag to be used for Resource creation. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetAvailabilitySet +Specifies the Availability Set to be used for VM creationSpecifies the Availability Set to be used for VM creation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetAvailabilityZone +Specifies the Availability Zone to be used for VM creation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetBootDiagnosticsStorageAccount +Specifies the storage account to be used for boot diagnostics. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetCapacityReservationGroupId +Specifies the Target Capacity Reservation Group Id within the destination Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNetworkId +Specifies the Virtual Network id within the destination Azure subscription to which the server needs to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroupId +Specifies the Resource Group id within the destination Azure subscription to which the server needs to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSecurityType +Specifies the security type for the Azure VM. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSubnetName +Specifies the Subnet name within the destination Virtual Network to which the server needs to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVMName +Specifies the name of the Azure VM to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVMSecureBootEnabled +Specifies if secure boot needs to be enabled on target VM. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVMSize +Specifies the SKU of the Azure VM to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestNetworkId +Specifies the Virtual Network id within the destination Azure subscription to which the server needs to be test migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestSubnetName +Specifies the Subnet name within the destination Virtual Network to which the server needs to be test migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMTag +Specifies the tag to be used for VM creation. +To construct, see NOTES section for VMTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtEnableMigrationInputTargetVmtags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMWarerunasaccountID +Account id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/New-AzMigrateTestNicMapping.md b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateTestNicMapping.md new file mode 100644 index 000000000000..64914330c25b --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/New-AzMigrateTestNicMapping.md @@ -0,0 +1,113 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/new-azmigratetestnicmapping +schema: 2.0.0 +--- + +# New-AzMigrateTestNicMapping + +## SYNOPSIS +Creates an object to update NIC properties of a test migrating server. + +## SYNTAX + +``` +New-AzMigrateTestNicMapping -NicID -TestNicSubnet [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +The New-AzMigrateTestNicMapping cmdlet creates a mapping of the source NIC attached to the server to be test migrated. +This object is provided as an input to the Start-AzMigrateTestMigration cmdlet to update the NIC and its properties for a test migrating server. + +## EXAMPLES + +### Example 1: Create a NIC object for test migration. +```powershell +New-AzMigrateTestNicMapping -NicID a2399354-653a-464e-a567-d30ef5467a31 -TestNicSubnet subnet1 +``` + +```output +IsPrimaryNic IsSelectedForMigration NicId TargetNicName TargetStaticIPAddress TargetSubnetName TestStaticIPAddress TestSubnetName +------------ ---------------------- ----- ------------- --------------------- ---------------- ------------------- -------------- + a2399354-653a-464e-a567-d30ef5467a31 subnet1 +``` + +Creates a NIC object for test migration. + +## PARAMETERS + +### -NicID +Specifies the ID of the NIC to be updated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtNicInput + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Register-AzMigrateProjectTool.md b/src/Migrate/Migrate.Autorest/docs/Register-AzMigrateProjectTool.md new file mode 100644 index 000000000000..c326e5a34428 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Register-AzMigrateProjectTool.md @@ -0,0 +1,174 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/register-azmigrateprojecttool +schema: 2.0.0 +--- + +# Register-AzMigrateProjectTool + +## SYNOPSIS +Registers a tool with the migrate project. + +## SYNTAX + +``` +Register-AzMigrateProjectTool -MigrateProjectName -ResourceGroupName + [-SubscriptionId ] [-AcceptLanguage ] [-Tool ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Registers a tool with the migrate project. + +## EXAMPLES + +### Example 1: REgister tool. +```powershell +Register-AzMigrateProjectTool -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -MigrateProjectName BugBashAVSVMware -Tool Zerto +``` + +```output +True +``` + +Registers a tool with the migrate project. + +## PARAMETERS + +### -AcceptLanguage +Standard request header. +Used by service to respond to client in appropriate language. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateProjectName +Name of the Azure Migrate project. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tool +Gets or sets the tool to be registered. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateLocalServerReplication.md b/src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateLocalServerReplication.md new file mode 100644 index 000000000000..12528ca747cf --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateLocalServerReplication.md @@ -0,0 +1,234 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/remove-azmigratelocalserverreplication +schema: 2.0.0 +--- + +# Remove-AzMigrateLocalServerReplication + +## SYNOPSIS +Stops replication for the migrated server. + +## SYNTAX + +### ByID (Default) +``` +Remove-AzMigrateLocalServerReplication -TargetObjectID [-SubscriptionId ] + [-ForceRemove ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### ByInputObject +``` +Remove-AzMigrateLocalServerReplication -InputObject [-SubscriptionId ] + [-ForceRemove ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +The Remove-AzMigrateLocalServerReplication cmdlet stops the replication for a migrated server. + +## EXAMPLES + +### Example 1: Remove replication by Id +```powershell +Remove-AzMigrateLocalServerReplication -TargetObjectID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/protectedItems/0ec082d5-6827-457a-bae2-f986e1b94851" +``` + +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {Cancel} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails +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 : +TargetFabricProviderId : 22f00372-a1b7-467f-87ce-d95e17a6e7c7 +Task : {Prerequisite check, Deleting protected item} +Type : Microsoft.DataReplication/replicationVaults/jobs +``` + +Remove AzLocal replication by Id. + +### Example 2: Remove replication by input object +```powershell +$InputObject = Get-AzMigrateLocalServerReplication -TargetObjectID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/protectedItems/0ec082d5-6827-457a-bae2-f986e1b94851" + +Remove-AzMigrateLocalServerReplication -InputObject $InputObject + +$InputObject | Remove-AzMigrateLocalServerReplication +``` + +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {Cancel} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails +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 : +TargetFabricProviderId : 22f00372-a1b7-467f-87ce-d95e17a6e7c7 +Task : {Prerequisite check, Deleting protected item} +Type : Microsoft.DataReplication/replicationVaults/jobs +``` + +Remove AzLocal replication by replication input object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceRemove +Specifies whether the replication needs to be force removed. +Default to "false". + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the replicating server for which the replication needs to be disabled. +The server object can be retrieved using the Get-AzMigrateLocalServerReplication cmdlet. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replcating server for which the replication needs to be disabled. +The ID should be retrieved using the Get-AzMigrateLocalServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: ByID +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.IJobModel + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateProject.md b/src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateProject.md new file mode 100644 index 000000000000..2ea0719f91f3 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateProject.md @@ -0,0 +1,172 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/remove-azmigrateproject +schema: 2.0.0 +--- + +# Remove-AzMigrateProject + +## SYNOPSIS +Delete the migrate project. +Deleting non-existent project is a no-operation. + +## SYNTAX + +``` +Remove-AzMigrateProject -Name -ResourceGroupName [-SubscriptionId ] + [-AcceptLanguage ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete the migrate project. +Deleting non-existent project is a no-operation. + +## EXAMPLES + +### Example 1: Delete (Default) +```powershell +Remove-AzMigrateProject -SubscriptionId xxx-xxx-xxx -ResourceGroupName BugBashAVSVMware -Name BugBashAVSVMware +``` + +Delete the migrate project. +Deleting non-existent project is a no-operation. + +## PARAMETERS + +### -AcceptLanguage +Standard request header. +Used by service to respond to client in appropriate language. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the Azure Migrate project. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MigrateProjectName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription Id in which migrate project was created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateServerReplication.md b/src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateServerReplication.md new file mode 100644 index 000000000000..ef53d1e85f6a --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Remove-AzMigrateServerReplication.md @@ -0,0 +1,186 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/remove-azmigrateserverreplication +schema: 2.0.0 +--- + +# Remove-AzMigrateServerReplication + +## SYNOPSIS +Stops replication for the migrated server. + +## SYNTAX + +### ByIDVMwareCbt (Default) +``` +Remove-AzMigrateServerReplication -TargetObjectID [-SubscriptionId ] [-ForceRemove ] + [-DefaultProfile ] [] +``` + +### ByInputObjectVMwareCbt +``` +Remove-AzMigrateServerReplication -InputObject [-SubscriptionId ] + [-ForceRemove ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Remove-AzMigrateServerReplication cmdlet stops the replication for a migrated server. + +## EXAMPLES + +### Example 1: Remove by id. +```powershell +Remove-AzMigrateServerReplication -TargetObjectID "/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f" +``` + +```output +ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 +AllowedAction : {Cancel} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Disable +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab +Location : +Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab +ScenarioName : Disable +StartTime : 9/25/20 9:20:08 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 +TargetObjectName : prsadhu-TestVM +Task : {DisableProtectionOnPrimary, UpdateDraState} +Type : Microsoft.RecoveryServices/vaults/replicationJobs + +``` + +Resync by id. + +### Example 2: Remove by Input Object +```powershell +$obj = Get-AzMigrateServerReplication -TargetObjectID "/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f" +Remove-AzMigrateServerReplication -InputObject $obj +``` + +```output +ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 +AllowedAction : {Cancel} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Disable +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab +Location : +Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab +ScenarioName : Disable +StartTime : 9/25/20 9:20:08 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 +TargetObjectName : prsadhu-TestVM +Task : {DisableProtectionOnPrimary, UpdateDraState} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +By name. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceRemove +Specifies whether the replication needs to be force removed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +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 +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IMigrationItem +Parameter Sets: ByInputObjectVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replcating server for which the replication needs to be disabled. +The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: ByIDVMwareCbt +Aliases: + +Required: True +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Restart-AzMigrateServerReplication.md b/src/Migrate/Migrate.Autorest/docs/Restart-AzMigrateServerReplication.md new file mode 100644 index 000000000000..87a8ce9efd06 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Restart-AzMigrateServerReplication.md @@ -0,0 +1,169 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/restart-azmigrateserverreplication +schema: 2.0.0 +--- + +# Restart-AzMigrateServerReplication + +## SYNOPSIS +Restarts the replication for specified server. + +## SYNTAX + +### ByIDVMwareCbt (Default) +``` +Restart-AzMigrateServerReplication -TargetObjectID [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### ByInputObjectVMwareCbt +``` +Restart-AzMigrateServerReplication -InputObject [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Restart-AzMigrateServerReplication cmdlet repairs the replication for the specified server. + +## EXAMPLES + +### Example 1: By id. +```powershell +Restart-AzMigrateServerReplication -TargetObjectID "/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f" +``` + +```output +ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 +AllowedAction : {Cancel} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Restart +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab +Location : +Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab +ScenarioName : Restart +StartTime : 9/25/20 9:20:08 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 +TargetObjectName : prsadhu-TestVM +Task : {DisableProtectionOnPrimary, UpdateDraState} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +By id. + +### Example 2: By Input Object +```powershell +$obj = Get-AzMigrateServerReplication -TargetObjectID "/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f" +$output = Restart-AzMigrateServerReplication -InputObject $obj +``` + +```output +ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 +AllowedAction : {Cancel} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Restart +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab +Location : +Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab +ScenarioName : Restart +StartTime : 9/25/20 9:20:08 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 +TargetObjectName : prsadhu-TestVM +Task : {DisableProtectionOnPrimary, UpdateDraState} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +By Input Object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the machine object of the replicating server. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IMigrationItem +Parameter Sets: ByInputObjectVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replcating server for which the resync needs to be initiated. +The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: ByIDVMwareCbt +Aliases: + +Required: True +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Resume-AzMigrateServerReplication.md b/src/Migrate/Migrate.Autorest/docs/Resume-AzMigrateServerReplication.md new file mode 100644 index 000000000000..968c1e372483 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Resume-AzMigrateServerReplication.md @@ -0,0 +1,216 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/resume-azmigrateserverreplication +schema: 2.0.0 +--- + +# Resume-AzMigrateServerReplication + +## SYNOPSIS +Starts the replication that has been suspended. + +## SYNTAX + +### ByIDVMwareCbt (Default) +``` +Resume-AzMigrateServerReplication -TargetObjectID [-DeleteMigratedResource] + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### ByInputObjectVMwareCbt +``` +Resume-AzMigrateServerReplication -InputObject [-DeleteMigratedResource] + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +The Resume-AzMigrateServerReplication starts the replication that has been suspended. + +## EXAMPLES + +### Example 1: By machine id. +```powershell +Resume-AzMigrateServerReplication -TargetObjectID "/Subscriptions/xxx-xxx-xxxxxx-xxx-xxx/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoffccyapp3352vault/replicationFabrics/signoffccyappae52replicationfabric/replicationProtectionContainers/signoffccyappae52replicationcontainer/replicationMigrationItems/idclab-vcen67-fareast-corp-micr-0f144e99-ba36-4649-b92b-8b06854aa539_5015f6d8-fc84-afdf-de47-1eab79330f00" +``` + +```output +ActivityId : 0b810233-b0aa-4a4c-a44e-bea4589c0513 ActivityId: ccb4889b-b9ec-4a76-af4d-4eb59c76ebac +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : +Id : /Subscriptions/xxx-xxx-xxxxxx-xxx-xxx/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoff + ccyapp3352vault/replicationJobs/75a6945d-2276-4dbb-926c-d0745e004130 +Location : +Name : 75a6945d-2276-4dbb-926c-d0745e004130 +ScenarioName : +StartTime : +State : NotStarted +StateDescription : NotStarted +TargetInstanceType : ProtectionEntity +TargetObjectId : +TargetObjectName : +Task : {} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +By machine id. + +### Example 2: By input object +```powershell +$obj = Get-AzMigrateServerReplication -ProjectName "signoffccyproj" -ResourceGroupName "cbtsignoff2201rg" -MachineName "Win2k16" +Resume-AzMigrateServerReplication -InputObject $obj +``` + +```output +ActivityId : 0b810233-b0aa-4a4c-a44e-bea4589c0513 ActivityId: ccb4889b-b9ec-4a76-af4d-4eb59c76ebac +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : +Id : /Subscriptions/xxx-xxx-xxxxxx-xxx-xxx/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoff + ccyapp3352vault/replicationJobs/75a6945d-2276-4dbb-926c-d0745e004130 +Location : +Name : 75a6945d-2276-4dbb-926c-d0745e004130 +ScenarioName : +StartTime : +State : NotStarted +StateDescription : NotStarted +TargetInstanceType : ProtectionEntity +TargetObjectId : +TargetObjectName : +Task : {} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +By input object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteMigratedResource +Specifies whether the migrated resources needs to be deleted. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IMigrationItem +Parameter Sets: ByInputObjectVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replicating server for which the resume replication needs to be initiated. +The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: ByIDVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Set-AzMigrateDiskMapping.md b/src/Migrate/Migrate.Autorest/docs/Set-AzMigrateDiskMapping.md new file mode 100644 index 000000000000..c43c50fd4b96 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Set-AzMigrateDiskMapping.md @@ -0,0 +1,96 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/set-azmigratediskmapping +schema: 2.0.0 +--- + +# Set-AzMigrateDiskMapping + +## SYNOPSIS +Updates disk mapping + +## SYNTAX + +``` +Set-AzMigrateDiskMapping -DiskID [-DiskName ] [-IsOSDisk ] [] +``` + +## DESCRIPTION +The Set-AzMigrateDiskMapping cmdlet updates a mapping of the source disk attached to the server to be migrated + +## EXAMPLES + +### Example 1: Make disks +```powershell +Set-AzMigrateDiskMapping -DiskID "6000C294-1217-dec3-bc18-81f117220424" -DiskName "ContosoDisk_1" -IsOSDisk "True" +``` + +```output +DiskId IsOSDisk TargetDiskName +------ -------- -------------- +6000C294-1217-dec3-bc18-81f117220424 True ContosoDisk_1 +``` + +Get disks object to provide input for Set-AzMigrateServerReplication + +## PARAMETERS + +### -DiskID +Specifies the disk ID of the disk attached to the discovered server to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskName +Specifies the name of the managed disk to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsOSDisk +Specifies whether the disk contains the Operating System for the source server to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtUpdateDiskInput + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Set-AzMigrateLocalServerReplication.md b/src/Migrate/Migrate.Autorest/docs/Set-AzMigrateLocalServerReplication.md new file mode 100644 index 000000000000..4ca0e6ed2de5 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Set-AzMigrateLocalServerReplication.md @@ -0,0 +1,251 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/set-azmigratelocalserverreplication +schema: 2.0.0 +--- + +# Set-AzMigrateLocalServerReplication + +## SYNOPSIS +Updates the target properties for the replicating server. + +## SYNTAX + +``` +Set-AzMigrateLocalServerReplication -TargetObjectID + [-DynamicMemoryConfig ] [-IsDynamicMemoryEnabled ] + [-NicToInclude ] [-OsType ] [-SubscriptionId ] [-TargetVMCPUCore ] + [-TargetVMRam ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +The Set-AzMigrateLocalServerReplication cmdlet updates the target properties for the replicating server. + +## EXAMPLES + +### Example 1: Update dynamic memory configuration +```powershell +$memoryConfig = [PSCustomObject]@{ + MinimumMemoryInMegaByte = 1024 + MaximumMemoryInMegaByte = 34816 + TargetMemoryBufferPercentage = 20 +} + +Set-AzMigrateLocalServerReplication -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.Api20240901.JobModelCustomPropertiesAffectedObjectDetails +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 : +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 + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DynamicMemoryConfig +Specifies the dynamic memory configuration of RAM. +To construct, see NOTES section for DYNAMICMEMORYCONFIG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.ProtectedItemDynamicMemoryConfig +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDynamicMemoryEnabled +Specifies if RAM is dynamic or not. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NicToInclude +Specifies the nics on the source server to be included for replication. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.AzLocalNicInput[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OsType +Specifies the OS type of the VM, either WindowsGuest or LinuxGuest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replicating server for which the properties need to be updated. +The ID should be retrieved using the Get-AzMigrateLocalServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVMCPUCore +Specifies the number of CPU cores. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVMRam +Specifies the target RAM size in MB. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.IJobModel + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Set-AzMigrateServerReplication.md b/src/Migrate/Migrate.Autorest/docs/Set-AzMigrateServerReplication.md new file mode 100644 index 000000000000..db35b330bb87 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Set-AzMigrateServerReplication.md @@ -0,0 +1,528 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/set-azmigrateserverreplication +schema: 2.0.0 +--- + +# Set-AzMigrateServerReplication + +## SYNOPSIS +Updates the target properties for the replicating server. + +## SYNTAX + +### ByIDVMwareCbt (Default) +``` +Set-AzMigrateServerReplication -TargetObjectID [-DiskToUpdate ] + [-LinuxLicenseType ] [-NicToUpdate ] [-SqlServerLicenseType ] + [-SubscriptionId ] [-TargetAvailabilitySet ] [-TargetAvailabilityZone ] + [-TargetBootDiagnosticsStorageAccount ] [-TargetCapacityReservationGroupId ] + [-TargetDiskName ] [-TargetNetworkId ] [-TargetResourceGroupID ] + [-TargetVMName ] [-TargetVMSize ] [-TestNetworkId ] + [-UpdateDiskTag ] [-UpdateDiskTagOperation ] + [-UpdateNicTag ] [-UpdateNicTagOperation ] + [-UpdateTag ] [-UpdateTagOperation ] + [-UpdateVMTag ] [-UpdateVMTagOperation ] + [-DefaultProfile ] [] +``` + +### ByInputObjectVMwareCbt +``` +Set-AzMigrateServerReplication -InputObject [-DiskToUpdate ] + [-LinuxLicenseType ] [-NicToUpdate ] [-SqlServerLicenseType ] + [-SubscriptionId ] [-TargetAvailabilitySet ] [-TargetAvailabilityZone ] + [-TargetBootDiagnosticsStorageAccount ] [-TargetCapacityReservationGroupId ] + [-TargetDiskName ] [-TargetNetworkId ] [-TargetResourceGroupID ] + [-TargetVMName ] [-TargetVMSize ] [-TestNetworkId ] + [-UpdateDiskTag ] [-UpdateDiskTagOperation ] + [-UpdateNicTag ] [-UpdateNicTagOperation ] + [-UpdateTag ] [-UpdateTagOperation ] + [-UpdateVMTag ] [-UpdateVMTagOperation ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Set-AzMigrateServerReplication cmdlet updates the target properties for the replicating server. + +## EXAMPLES + +### Example 1: Update by id +```powershell +Set-AzMigrateServerReplication -TargetObjectID '/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_500f44f8-2aa3-587b-8958-ead358639629' -TargetVMName 'rb-w2k12r2-1' +``` + +```output +ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 +AllowedAction : {Cancel} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Update +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab +Location : +Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab +ScenarioName : Update +StartTime : 9/25/20 9:20:08 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 +TargetObjectName : prsadhu-TestVM +Task : {DisableProtectionOnPrimary, UpdateDraState} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +By id. + +### Example 2: Update multiple disk names by id +```powershell +$OSDisk = Set-AzMigrateDiskMapping -DiskID "6000C294-1217-dec3-bc18-81f117220424" -DiskName "ContosoDisk_1" +$DataDisk = Set-AzMigrateDiskMapping -DiskID "6000C292-79b9-bbdc-fb8a-f1fa8dbeff84" -DiskName "ContosoDisk_2" +$DiskMapping = $OSDisk, $DataDisk +Set-AzMigrateServerReplication -TargetObjectId "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/cbtsignoff2105srcrg/providers/Microsoft.RecoveryServices/vaults/signoff2105app1452vault/replicationFabrics/signoff2105app1c36replicationfabric/replicationProtectionContainers/signoff2105app1c36replicationcontainer/replicationMigrationItems/idclab-vcen67-fareast-corp-micr-6f5e3b29-29ad-4e62-abbd-6cd33c4183ef_5015f6d8-fc84-afdf-de47-1eab79330f00" -DiskToUpdate $DiskMapping +``` + +```output +ActivityId : c533d88d-2211-43c6-b615-7b46876d8882 ActivityId: de18df8b-8d43-4249-8989-846d33a124f6 +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210210.JobDetailsAffectedObje + ctDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Update the virtual machine +Id : /Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/cbtsignoff2105src + rg/providers/Microsoft.RecoveryServices/vaults/signoff2105app1452vault/replicationJo + bs/6ec1cca6-87c7-4f14-9657-bd0469c02fcd +Location : +Name : 6ec1cca6-87c7-4f14-9657-bd0469c02fcd +ScenarioName : UpdateVmProperties +StartTime : 8/30/2021 7:08:51 AM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : f3aa6bd4-1b60-52bb-b12d-e850f8d8f13c +TargetObjectName : Win2k16 +Task : {UpdateVmPropertiesTask} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +Updating disk name by id. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskToUpdate +Updates the disk for the Azure VM to be created. +To construct, see NOTES section for DISKTOUPDATE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtUpdateDiskInput[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the replicating server for which the properties need to be updated. +The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IMigrationItem +Parameter Sets: ByInputObjectVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinuxLicenseType +Specifies if Azure Hybrid benefit is applicable for the source linux server to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NicToUpdate +Updates the NIC for the Azure VM to be created. +To construct, see NOTES section for NICTOUPDATE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtNicInput[] +Parameter Sets: (All) +Aliases: + +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The subscription Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetAvailabilitySet +Specifies the Availability Set to be used for VM creation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetAvailabilityZone +Specifies the Availability Zone to be used for VM creation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetBootDiagnosticsStorageAccount +Specifies the storage account to be used for boot diagnostics. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetCapacityReservationGroupId +Specifies the Target Capacity Reservation Group Id within the destination Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDiskName +Specifies the name of the Azure VM to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNetworkId +Updates the Virtual Network id within the destination Azure subscription to which the server needs to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replcating server for which the properties need to be updated. +The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: ByIDVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetResourceGroupID +Updates the Resource Group id within the destination Azure subscription to which the server needs to be migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVMName +Specifies the replcating server for which the properties need to be updated. +The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVMSize +Updates the SKU of the Azure VM to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestNetworkId +Updates the Virtual Network id within the destination Azure subscription to which the server needs to be test migrated. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateDiskTag +Specifies the tag to be used for disk creation. +To construct, see NOTES section for UPDATEDISKTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtEnableMigrationInputTargetDiskTags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateDiskTagOperation +Specifies update disk tag operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateNicTag +Specifies the tag to be used for NIC creation. +To construct, see NOTES section for UPDATENICTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtEnableMigrationInputTargetNicTags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateNicTagOperation +Specifies update NIC tag operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateTag +Specifies the tag to be used for Resource creation. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateTagOperation +Specifies update tag operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateVMTag +Specifies the tag to be used for VM creation. +To construct, see NOTES section for UPDATEVMTAG properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtEnableMigrationInputTargetVmtags +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateVMTagOperation +Specifies update VM tag operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateLocalServerMigration.md b/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateLocalServerMigration.md new file mode 100644 index 000000000000..b9957d1aa5bc --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateLocalServerMigration.md @@ -0,0 +1,241 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/start-azmigratelocalservermigration +schema: 2.0.0 +--- + +# Start-AzMigrateLocalServerMigration + +## SYNOPSIS +Starts the migration for the replicating server. + +## SYNTAX + +### ByID (Default) +``` +Start-AzMigrateLocalServerMigration -TargetObjectID [-SubscriptionId ] [-TurnOffSourceServer] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### ByInputObject +``` +Start-AzMigrateLocalServerMigration -InputObject [-SubscriptionId ] + [-TurnOffSourceServer] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Starts the migration for the replicating server. + +## EXAMPLES + +### Example 1: Start migration by Id +```powershell +Start-AzMigrateLocalServerMigration -TargetObjectID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/protectedItems/0ec082d5-6827-457a-bae2-f986e1b94851" +``` + +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {Cancel} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails +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 : +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 AzLocal server migration by Id. + +### Example 2: Start migration by input object +```powershell +$InputObject = Get-AzMigrateLocalServerReplication -TargetObjectID "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.DataReplication/replicationVaults/testproj1234replicationvault/protectedItems/0ec082d5-6827-457a-bae2-f986e1b94851" + +Start-AzMigrateLocalServerMigration -InputObject $InputObject + +$InputObject | Start-AzMigrateLocalServerMigration +``` + +```output +ActivityId : ActivityId: 00000000-0000-0000-0000-000000000000 +AllowedAction : {Cancel} +CustomPropertyAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20240901.JobModelCustomPropertiesAffectedObjectDetails +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 : +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 AzLocal server migration by replication input object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the replicating server for which migration needs to be initiated. +The server object can be retrieved using the Get-AzMigrateLocalServerReplication cmdlet. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replcating server for which migration needs to be initiated. +The ID should be retrieved using the Get-AzMigrateLocalServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: ByID +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TurnOffSourceServer +Specifies whether the source server should be turned off post migration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.IMigrateIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20260201.IJobModel + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateServerMigration.md b/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateServerMigration.md new file mode 100644 index 000000000000..edabbf31d2da --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateServerMigration.md @@ -0,0 +1,187 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/start-azmigrateservermigration +schema: 2.0.0 +--- + +# Start-AzMigrateServerMigration + +## SYNOPSIS +Starts the migration for the replicating server. + +## SYNTAX + +### ByIDVMwareCbt (Default) +``` +Start-AzMigrateServerMigration -TargetObjectID [-OsUpgradeVersion ] + [-SubscriptionId ] [-TargetCapacityReservationGroupId ] [-TurnOffSourceServer] + [-DefaultProfile ] [] +``` + +### ByInputObjectVMwareCbt +``` +Start-AzMigrateServerMigration -InputObject [-OsUpgradeVersion ] + [-SubscriptionId ] [-TargetCapacityReservationGroupId ] [-TurnOffSourceServer] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Starts the migration for the replicating server. + +## EXAMPLES + +### Example 1: By id +```powershell +Start-AzMigrateServerMigration -TargetObjectID "/Subscriptions/7xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_52f42ee7-8eb3-1aa4-e2d5-1ae83f86b085" +``` + +```output +ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 +AllowedAction : {Cancel} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Migrate +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab +Location : +Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab +ScenarioName : Migrate +StartTime : 9/25/20 9:20:08 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 +TargetObjectName : prsadhu-TestVM +Task : {DisableProtectionOnPrimary, UpdateDraState} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +By id + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the replicating server for which migration needs to be initiated. +The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IMigrationItem +Parameter Sets: ByInputObjectVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OsUpgradeVersion +Specifies the target version to which the Os has to be upgraded to. +The valid values can be selected from SupportedOSVersions retrieved using Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetCapacityReservationGroupId +Specifies the Target Capacity Reservation Group Id within the destination Azure subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replcating server for which migration needs to be initiated. +The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: ByIDVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TurnOffSourceServer +Specifies whether the source server should be turned off post migration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateTestMigration.md b/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateTestMigration.md new file mode 100644 index 000000000000..b5a4121884ef --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateTestMigration.md @@ -0,0 +1,221 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/start-azmigratetestmigration +schema: 2.0.0 +--- + +# Start-AzMigrateTestMigration + +## SYNOPSIS +Starts the test migration for the replicating server. + +## SYNTAX + +### ByIDVMwareCbt (Default) +``` +Start-AzMigrateTestMigration -TargetObjectID -TestNetworkID + [-NicToUpdate ] [-OsUpgradeVersion ] [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### ByInputObjectVMwareCbt +``` +Start-AzMigrateTestMigration -InputObject -TestNetworkID + [-NicToUpdate ] [-OsUpgradeVersion ] [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Start-AzMigrateTestMigration cmdlet initiates the test migration for the replicating server. + +## EXAMPLES + +### Example 1: By machine id. +```powershell +Start-AzMigrateTestMigration -TargetObjectID '/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f' -TestNetworkId '/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG/providers/Microsoft.Network/virtualNetworks/AzMigrateTargetNetwork' +``` + +```output +ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 +AllowedAction : {Cancel} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Test Migrate +Id : /Subscriptions/xxx-xxx-xxxresourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab +Location : +Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab +ScenarioName : TestMigrate +StartTime : 9/25/20 9:20:08 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 +TargetObjectName : prsadhu-TestVM +Task : {DisableProtectionOnPrimary, UpdateDraState} +Type : Microsoft.RecoveryServices/vaults/replicationJobs + +``` + +By machine id. + +### Example 2: By input object +```powershell +$obj = Get-AzMigrateServerReplication -TargetObjectID $env.srsMachineId -SubscriptionId $env.srsSubscriptionId +Start-AzMigrateTestMigration -InputObject $obj -TestNetworkId '/subscriptions/xxx-xxx-xxx/resourceGroups/AzMigratePWSHtargetRG/providers/Microsoft.Network/virtualNetworks/AzMigrateTargetNetwork' +``` + +```output +ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 +AllowedAction : {Cancel} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Test Migrate +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab +Location : +Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab +ScenarioName : TestMigrate +StartTime : 9/25/20 9:20:08 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 +TargetObjectName : prsadhu-TestVM +Task : {DisableProtectionOnPrimary, UpdateDraState} +Type : Microsoft.RecoveryServices/vaults/replicationJobs + +``` + +By input object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IMigrationItem +Parameter Sets: ByInputObjectVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NicToUpdate +Updates the NIC for the Azure VM to be created. +To construct, see NOTES section for NICTOUPDATE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IVMwareCbtNicInput[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OsUpgradeVersion +Specifies the target version to which the Os has to be upgraded to. +The valid values can be selected from SupportedOSVersions retrieved using Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replicating server for which the test migration needs to be initiated. +The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: ByIDVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestNetworkID +Updates the Virtual Network id within the destination Azure subscription to be used for test migration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateTestMigrationCleanup.md b/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateTestMigrationCleanup.md new file mode 100644 index 000000000000..37cb9a7e022f --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Start-AzMigrateTestMigrationCleanup.md @@ -0,0 +1,174 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/start-azmigratetestmigrationcleanup +schema: 2.0.0 +--- + +# Start-AzMigrateTestMigrationCleanup + +## SYNOPSIS +Cleans up the test migration for the replicating server. + +## SYNTAX + +### ByIDVMwareCbt (Default) +``` +Start-AzMigrateTestMigrationCleanup -TargetObjectID [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### ByInputObjectVMwareCbt +``` +Start-AzMigrateTestMigrationCleanup -InputObject [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +The Start-AzMigrateTestMigrationCleanup cmdlet initiates the clean up of the test migration for the replicating server. + +## EXAMPLES + +### Example 1: By machine id. +```powershell +Start-AzMigrateTestMigrationCleanup -TargetObjectID '/Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.RecoveryServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationFabrics/AzMigratePWSHTc8d1replicationfabric/replicationProtectionContainers/AzMigratePWSHTc8d1replicationcontainer/replicationMigrationItems/bcdr-vcenter-fareast-corp-micro-cfcc5a24-a40e-56b9-a6af-e206c9ca4f93_50063baa-9806-d6d6-7e09-c0ae87309b4f' +``` + +```output +ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 +AllowedAction : {Cancel} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Test Migrate Cleanup +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab +Location : +Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab +ScenarioName : TestMigrateCleanup +StartTime : 9/25/20 9:20:08 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 +TargetObjectName : prsadhu-TestVM +Task : {DisableProtectionOnPrimary, UpdateDraState} +Type : Microsoft.RecoveryServices/vaults/replicationJobs + +``` + +By machine id. + +### Example 2: By input object +```powershell +$obj = Get-AzMigrateServerReplication -TargetObjectID $env.srsMachineId -SubscriptionId $env.srsSubscriptionId +Start-AzMigrateTestMigrationCleanup -InputObject $ob +``` + +```output +AllowedOperation : {DisableMigration, TestMigrate, Migrate} + +ActivityId : da958651-96b3-4e65-a41e-897d4b06f7dd ActivityId: 3a4c8d4d-920a-47cd-82c3-f3dcce90a588 +AllowedAction : {Cancel} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Test Migrate Cleanup +Id : /Subscriptions/xxx-xxx-xxx/resourceGroups/azmigratepwshtestasr13072020/providers/Microsoft.Recover + yServices/vaults/AzMigrateTestProjectPWSH02aarsvault/replicationJobs/931dde9a-de67-4a30-a045-bb9d6162f8ab +Location : +Name : 931dde9a-de67-4a30-a045-bb9d6162f8ab +ScenarioName : TestMigrateCleanup +StartTime : 9/25/20 9:20:08 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 101883a0-23f7-538a-bbd5-6d8b4fa900e2 +TargetObjectName : prsadhu-TestVM +Task : {DisableProtectionOnPrimary, UpdateDraState} +Type : Microsoft.RecoveryServices/vaults/replicationJobs + +``` + +By input object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IMigrationItem +Parameter Sets: ByInputObjectVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replicating server for which the test migration cleanup needs to be initiated. +The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: ByIDVMwareCbt +Aliases: + +Required: True +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob + +## NOTES + +## RELATED LINKS + diff --git a/src/Migrate/Migrate.Autorest/docs/Suspend-AzMigrateServerReplication.md b/src/Migrate/Migrate.Autorest/docs/Suspend-AzMigrateServerReplication.md new file mode 100644 index 000000000000..fa383a33d152 --- /dev/null +++ b/src/Migrate/Migrate.Autorest/docs/Suspend-AzMigrateServerReplication.md @@ -0,0 +1,201 @@ +--- +external help file: +Module Name: Az.Migrate +online version: https://learn.microsoft.com/powershell/module/az.migrate/suspend-azmigrateserverreplication +schema: 2.0.0 +--- + +# Suspend-AzMigrateServerReplication + +## SYNOPSIS +Suspends the ongoing replication. + +## SYNTAX + +### ByIDVMwareCbt (Default) +``` +Suspend-AzMigrateServerReplication -TargetObjectID [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### ByInputObjectVMwareCbt +``` +Suspend-AzMigrateServerReplication -InputObject [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +The Suspend-AzMigrateServerReplication suspends the ongoing replication. + +## EXAMPLES + +### Example 1: By machine id. +```powershell +Suspend-AzMigrateServerReplication -TargetObjectID "/Subscriptions/xxx-xxx-xxxxxx-xxx-xxx/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoffccyapp3352vault/replicationFabrics/signoffccyappae52replicationfabric/replicationProtectionContainers/signoffccyappae52replicationcontainer/replicationMigrationItems/idclab-vcen67-fareast-corp-micr-0f144e99-ba36-4649-b92b-8b06854aa539_5015f6d8-fc84-afdf-de47-1eab79330f00" +``` + +```output +ActivityId : da61a495-48b7-40df-a251-f23f491b2566 ActivityId: e16e0301-be13-4c35-8242-1451cb057994 +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Pause replication +Id : /Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoff + ccyapp3352vault/replicationJobs/6ded7417-b939-4c30-b622-d80a63865025 +Location : +Name : 6ded7417-b939-4c30-b622-d80a63865025 +ScenarioName : PauseReplication +StartTime : 9/25/2022 9:10:42 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 52896ea4-214d-5825-bc32-24169dfcc44c +TargetObjectName : Win2k16 +Task : {PauseReplicationPreflightChecksTask, PauseReplicationTask} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +By machine id. + +### Example 2: By input object +```powershell +$obj = Get-AzMigrateServerReplication -ProjectName "signoffccyproj" -ResourceGroupName "cbtsignoff2201rg" -MachineName "Win2k16" +Suspend-AzMigrateServerReplication -InputObject $obj +``` + +```output +ActivityId : da61a495-48b7-40df-a251-f23f491b2566 ActivityId: e16e0301-be13-4c35-8242-1451cb057994 +AllowedAction : {} +CustomDetailAffectedObjectDetail : Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api202301.JobDetailsAffectedObjectDetails +CustomDetailInstanceType : AsrJobDetails +EndTime : +Error : {} +FriendlyName : Pause replication +Id : /Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/cbtsignoff2201rg/providers/Microsoft.RecoveryServices/vaults/signoff + ccyapp3352vault/replicationJobs/6ded7417-b939-4c30-b622-d80a63865025 +Location : +Name : 6ded7417-b939-4c30-b622-d80a63865025 +ScenarioName : PauseReplication +StartTime : 9/25/2022 9:10:42 PM +State : InProgress +StateDescription : InProgress +TargetInstanceType : ProtectionEntity +TargetObjectId : 52896ea4-214d-5825-bc32-24169dfcc44c +TargetObjectName : Win2k16 +Task : {PauseReplicationPreflightChecksTask, PauseReplicationTask} +Type : Microsoft.RecoveryServices/vaults/replicationJobs +``` + +By input object. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the replicating server for which the suspend replication needs to be initiated. +The server object can be retrieved using the Get-AzMigrateServerReplication cmdlet +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IMigrationItem +Parameter Sets: ByInputObjectVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Azure Subscription ID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetObjectID +Specifies the replicating server for which the suspend replication needs to be initiated. +The ID should be retrieved using the Get-AzMigrateServerReplication cmdlet. + +```yaml +Type: System.String +Parameter Sets: ByIDVMwareCbt +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20250801.IJob + +## NOTES + +## RELATED LINKS +