API Reference
Command
Import-ADXMigrationPlan
Imports an AD migration plan from a repeatable JSON artifact.
Examples
Example 1: Import a reviewed plan and inspect blockers before execution.
$plan = Import-ADXMigrationPlan -Path '.\CAB-1234.adxmigration.json'
$plan | Test-ADXMigrationPlan -PassThru | Select-Object -ExpandProperty Issues | Format-Table Severity, Code, Target, Message -AutoSize
$plan.Phases | Format-Table Kind, Item, IsMutating, RequiresMachineExecutor, Description -AutoSize
Example 2: Import, preview, and apply a governed migration.
$plan = Import-ADXMigrationPlan -Path '.\CAB-1234.adxmigration.json'
$preview = $plan | Invoke-ADXMigrationPlan
$preview.Phases | Format-Table Kind, Item, Status, Changed, Message -AutoSize
$plan | Invoke-ADXMigrationPlan -Intent read_write -AllowWrite -Apply -WriteExecutionId mig-2026-001 -WriteActorId pklys -WriteChangeReason CAB-1234 -WriteRollbackPlanId rollback-CAB-1234
Common Parameters
This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters.
Syntax
Import-ADXMigrationPlan -Path <string> [<CommonParameters>]#Parameters
- Path string
- Source JSON file path.
Outputs
ADPlayground.Migrations.Core.AdMigrationPlan