Automatická migrace skriptů PowerShellu z AzureRM do modulu Az PowerShell

Článek
03/05/2025

V tomto článku se dozvíte, jak pomocí modulu Az.Tools.Migration PowerShell automaticky upgradovat skripty PowerShellu a moduly skriptů z AzureRM na modul Az PowerShell. Další možnosti migrace najdete v tématu Migrace Azure PowerShellu z AzureRM na Az.

Varování

Modul AzureRM PowerShell byl od 29. února 2024 oficiálně zastaralý. Uživatelům se doporučuje migrovat z AzureRM do modulu Az PowerShell, aby se zajistila nepřetržitá podpora a aktualizace.

Ačkoli může modul AzureRM stále fungovat, už se neudržuje ani nepodporuje, a jakékoli další použití je na vlastní uvážení a riziko uživatele. Pokyny k přechodu na modul Az najdete v našich migračních zdrojích .

Požadavky

Aktualizujte stávající skripty PowerShellu na nejnovější verzi modulu AzureRM PowerShellu (6.13.1).
Nainstalujte modul Az.Tools.Migration PowerShell.
```
Install-Module -Name Az.Tools.Migration
```

Krok 1: Vygenerování plánu upgradu

Pomocí rutiny New-AzUpgradeModulePlan vygenerujete plán upgradu pro migraci skriptů a modulů do modulu Az PowerShell. Tato rutina neprovádí žádné změny stávajících skriptů. Pro cílení na konkrétní skript použijte parametr FilePath nebo parametr DirectoryPath pro cílení na všechny skripty v konkrétní složce.

Poznámka

Rutina New-AzUpgradeModulePlan plán nespustí, vygeneruje pouze kroky upgradu.

Následující příklad vygeneruje plán pro všechny skripty ve složce C:\Scripts. Parametr OutVariable je zadán, takže výsledky jsou vráceny a současně uloženy v proměnné s názvem Plan.

# Generate an upgrade plan for all the scripts and module files in the specified folder and save it to a variable.
New-AzUpgradeModulePlan -FromAzureRmVersion 6.13.1 -ToAzVersion latest -DirectoryPath 'C:\Scripts' -OutVariable Plan

Jak je znázorněno na následujícím výstupu, plán upgradu podrobně popisuje konkrétní soubor a posunové body, které při přechodu z AzureRM na rutiny Az PowerShellu vyžadují změny.

Order Location                                                   UpgradeType     PlanResult             Original
----- --------                                                   -----------     ----------             --------
1     compute-create-dockerhost.ps1:59:24                        CmdletParameter ReadyToUpgrade         ExtensionName
2     compute-create-dockerhost.ps1:59:1                         Cmdlet          ReadyToUpgrade         Set-AzureRmVM...
3     compute-create-dockerhost.ps1:54:1                         Cmdlet          ReadyToUpgrade         New-AzureRmVM
4     compute-create-dockerhost.ps1:51:1                         Cmdlet          ReadyToUpgrade         Add-AzureRmVM...
5     compute-create-dockerhost.ps1:47:1                         Cmdlet          ReadyToUpgrade         Add-AzureRmVM...
6     compute-create-dockerhost.ps1:46:1                         Cmdlet          ReadyToUpgrade         Set-AzureRmVM...
7     compute-create-dockerhost.ps1:45:1                         Cmdlet          ReadyToUpgrade         Set-AzureRmVM...
8     compute-create-dockerhost.ps1:44:13                        Cmdlet          ReadyToUpgrade         New-AzureRmVM...
9     compute-create-dockerhost.ps1:40:8                         Cmdlet          ReadyToUpgrade         New-AzureRmNe...
10    compute-create-dockerhost.ps1:36:8                         Cmdlet          ReadyToUpgrade         New-AzureRmNe...
11    compute-create-dockerhost.ps1:31:16                        Cmdlet          ReadyToUpgrade         New-AzureRmNe...
12    compute-create-dockerhost.ps1:26:15                        Cmdlet          ReadyToUpgrade         New-AzureRmNe...
13    compute-create-dockerhost.ps1:22:8                         Cmdlet          ReadyToUpgrade         New-AzureRmPu...
14    compute-create-dockerhost.ps1:18:9                         Cmdlet          ReadyToUpgrade         New-AzureRmVi...
15    compute-create-dockerhost.ps1:15:17                        Cmdlet          ReadyToUpgrade         New-AzureRmVi...
16    compute-create-dockerhost.ps1:12:1                         Cmdlet          ReadyToUpgrade         New-AzureRmRe...
17    compute-create-windowsvm-quick.ps1:18:3                    CmdletParameter ReadyToUpgrade         ImageName
18    compute-create-windowsvm-quick.ps1:14:1                    Cmdlet          ReadyToUpgrade         New-AzureRmVM
19    compute-create-windowsvm-quick.ps1:11:1                    Cmdlet          ReadyToUpgrade         New-AzureRmRe...
20    compute-create-wordpress-mysql.ps1:59:24                   CmdletParameter ReadyToUpgrade         ExtensionName
...

Před provedením upgradu je potřeba zkontrolovat výsledky plánu, zda neobsahují problémy. Následující příklad vrátí seznam skriptů a položek v těchto skriptech, které zabrání jejich automatickému upgradu.

# Filter plan results to only warnings and errors
$Plan | Where-Object PlanResult -ne ReadyToUpgrade | Format-List

Položky zobrazené v následujícím výstupu se neupgradují automaticky, aniž by nejprve opravovaly problémy ručně.

Order                  : 42
UpgradeType            : CmdletParameter
PlanResult             : ErrorParameterNotFound
PlanSeverity           : Error
PlanResultReason       : Parameter was not found in Get-AzResource or it's aliases.
SourceCommand          : CommandReference
SourceCommandParameter : CommandReferenceParameter
Location               : devtestlab-add-marketplace-image-to-lab.ps1:14:74
FullPath               : C:\Scripts\devtestlab-add-marketplace-image-to-lab.ps1
StartOffset            : 556
Original               : ResourceNameEquals
Replacement            :

Krok 2: Provedení upgradu

Opatrnost

Neexistuje žádná operace vrácení zpět. Vždy se ujistěte, že máte záložní kopii skriptů a modulů PowerShellu, které se pokoušíte upgradovat.

Jakmile budete s plánem spokojeni, provede se upgrade pomocí příkazu Invoke-AzUpgradeModulePlan. Zadejte SaveChangesToNewFiles pro hodnotu parametru FileEditMode, aby se zabránilo změnám v původních skriptech. Při použití tohoto režimu se upgrade provádí vytvořením kopie každého skriptu s připojeným _az_upgraded k názvům souborů.

Varování

Při zadání možnosti -FileEditMode ModifyExistingFiles je cmdlet Invoke-AzUpgradeModulePlan destruktivní! Upraví vaše skripty a funkce na místě podle plánu upgradu modulu vygenerovaného rutinou New-AzUpgradeModulePlan. Pro nedestruktivní možnost zadejte místo toho -FileEditMode SaveChangesToNewFiles.

# Execute the automatic upgrade plan and save the results to a variable.
Invoke-AzUpgradeModulePlan -Plan $Plan -FileEditMode SaveChangesToNewFiles -OutVariable Results

Order Location                                                   UpgradeType     UpgradeResult    Original
----- --------                                                   -----------     -------------    --------
1     compute-create-dockerhost.ps1:59:24                        CmdletParameter UpgradeCompleted ExtensionName
2     compute-create-dockerhost.ps1:59:1                         Cmdlet          UpgradeCompleted Set-AzureRmVMExtens...
3     compute-create-dockerhost.ps1:54:1                         Cmdlet          UpgradeCompleted New-AzureRmVM
4     compute-create-dockerhost.ps1:51:1                         Cmdlet          UpgradeCompleted Add-AzureRmVMSshPub...
5     compute-create-dockerhost.ps1:47:1                         Cmdlet          UpgradeCompleted Add-AzureRmVMNetwor...
6     compute-create-dockerhost.ps1:46:1                         Cmdlet          UpgradeCompleted Set-AzureRmVMSource...
7     compute-create-dockerhost.ps1:45:1                         Cmdlet          UpgradeCompleted Set-AzureRmVMOperat...
8     compute-create-dockerhost.ps1:44:13                        Cmdlet          UpgradeCompleted New-AzureRmVMConfig
9     compute-create-dockerhost.ps1:40:8                         Cmdlet          UpgradeCompleted New-AzureRmNetworkI...
10    compute-create-dockerhost.ps1:36:8                         Cmdlet          UpgradeCompleted New-AzureRmNetworkS...
11    compute-create-dockerhost.ps1:31:16                        Cmdlet          UpgradeCompleted New-AzureRmNetworkS...
12    compute-create-dockerhost.ps1:26:15                        Cmdlet          UpgradeCompleted New-AzureRmNetworkS...
13    compute-create-dockerhost.ps1:22:8                         Cmdlet          UpgradeCompleted New-AzureRmPublicIp...
14    compute-create-dockerhost.ps1:18:9                         Cmdlet          UpgradeCompleted New-AzureRmVirtualN...
15    compute-create-dockerhost.ps1:15:17                        Cmdlet          UpgradeCompleted New-AzureRmVirtualN...
16    compute-create-dockerhost.ps1:12:1                         Cmdlet          UpgradeCompleted New-AzureRmResource...
17    compute-create-windowsvm-quick.ps1:18:3                    CmdletParameter UpgradeCompleted ImageName
18    compute-create-windowsvm-quick.ps1:14:1                    Cmdlet          UpgradeCompleted New-AzureRmVM
19    compute-create-windowsvm-quick.ps1:11:1                    Cmdlet          UpgradeCompleted New-AzureRmResource...
20    compute-create-wordpress-mysql.ps1:59:24                   CmdletParameter UpgradeCompleted ExtensionName
...

Pokud se vrátí nějaké chyby, můžete se blíže podívat na výsledky chyb pomocí následujícího příkazu:

# Filter results to show only errors
$Results | Where-Object UpgradeResult -ne UpgradeCompleted | Format-List

Order                  : 42
UpgradeType            : CmdletParameter
UpgradeResult          : UnableToUpgrade
UpgradeSeverity        : Error
UpgradeResultReason    : Parameter was not found in Get-AzResource or it's aliases.
SourceCommand          : CommandReference
SourceCommandParameter : CommandReferenceParameter
Location               : devtestlab-add-marketplace-image-to-lab.ps1:14:74
FullPath               : C:\Scripts\devtestlab-add-marketplace-image-to-lab.ps1
StartOffset            : 556
Original               : ResourceNameEquals
Replacement            :

Omezení

Vstupně-výstupní operace souborů používají výchozí kódování. Neobvyklé situace kódování souborů můžou způsobit problémy.
Cmdlety AzureRM předané jako argumenty do mockovacích prohlášení při jednotkovém testování prostřednictvím Pesteru nejsou detekovány.

Hlášení problémů

Nahlašte zpětnou vazbu a problémy týkající se modulu Az.Tools.Migration PowerShellu prostřednictvím problému GitHubu v úložišti azure-powershell-migration.

Další kroky

Další informace o modulu Az PowerShell najdete v dokumentaci k Azure PowerShellu

Sdílet prostřednictvím