Condividi tramite

Eseguire automaticamente la migrazione degli script di PowerShell da AzureRM al modulo Az PowerShell

  • Articolo

In questo articolo si apprenderà come usare il modulo Az.Tools.Migration di PowerShell per aggiornare automaticamente gli script e i moduli di script di PowerShell da AzureRM al modulo Az PowerShell. Per altre opzioni di migrazione, vedere Eseguire la migrazione di Azure PowerShell da AzureRM ad Az.

Avvertimento

Il modulo AzureRM PowerShell è stato ufficialmente deprecato a partire dal 29 febbraio 2024. È consigliabile eseguire la migrazione da AzureRM al modulo Az PowerShell per garantire il supporto e gli aggiornamenti continui.

Anche se il modulo AzureRM può ancora funzionare, non è più gestito o supportato, posizionando qualsiasi uso continuo a discrezione e rischio dell'utente. Per indicazioni sulla transizione al modulo Az, vedere le risorse di migrazione .

Requisiti

Passaggio 1: Generare un piano di aggiornamento

Usare il cmdlet New-AzUpgradeModulePlan per generare un piano di aggiornamento per la migrazione degli script e dei moduli al modulo Az PowerShell. Questo cmdlet non apporta modifiche agli script esistenti. Usare il parametro FilePath per specificare come destinazione uno script specifico o il parametro DirectoryPath per specificare come destinazione tutti gli script in una cartella specifica.

Nota

Il cmdlet New-AzUpgradeModulePlan non esegue il piano, ma genera solo i passaggi di aggiornamento.

Nell'esempio seguente viene generato un piano per tutti gli script nella cartella C:\Scripts. Il parametro OutVariable viene specificato in modo che i risultati vengano restituiti e archiviati contemporaneamente in una variabile denominata 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

Come illustrato nell'output seguente, il piano di aggiornamento descrive in dettaglio i punti di offset e file specifici che richiedono modifiche durante il passaggio da AzureRM ai cmdlet di Az PowerShell.

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
...

Prima di eseguire l'aggiornamento, è necessario visualizzare i risultati del piano per i problemi. Nell'esempio seguente viene restituito un elenco di script e gli elementi di tali script che impediranno l'aggiornamento automatico.

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

Gli elementi mostrati nell'output seguente non verranno aggiornati automaticamente senza prima correggere manualmente i problemi.

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            :

Passaggio 2: Eseguire l'aggiornamento

Cautela

Non è presente alcuna operazione di annullamento. Assicurarsi sempre di disporre di una copia di backup degli script e dei moduli di PowerShell che si sta tentando di aggiornare.

Dopo che sei soddisfatto del piano, l'aggiornamento viene eseguito con il cmdlet Invoke-AzUpgradeModulePlan. Specificare SaveChangesToNewFiles per il valore del parametro FileEditMode per impedire che vengano apportate modifiche agli script originali. Quando si usa questa modalità, l'aggiornamento viene eseguito creando una copia di ogni script di destinazione con _az_upgraded accodato ai nomi dei file.

Avvertimento

Il cmdlet Invoke-AzUpgradeModulePlan è distruttivo quando viene specificata l'opzione -FileEditMode ModifyExistingFiles. Modifica gli script e le funzioni sul posto in base al piano di aggiornamento del modulo generato dal cmdlet New-AzUpgradeModulePlan. Per l'opzione non distruttiva specificare -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
...

Se vengono restituiti errori, è possibile esaminare più in dettaglio i risultati dell'errore con il comando seguente:

# 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            :

Limitazioni

  • Le operazioni di I/O dei file usano la codifica predefinita. Le situazioni di codifica dei file insolite possono causare problemi.
  • I cmdlet di AzureRM, passati come argomenti alle istruzioni fittizie dei test unitari Pester, non vengono rilevati.

Come segnalare i problemi

Segnalare commenti e problemi relativi al modulo Az.Tools.Migration di PowerShell tramite un problema di GitHub nel repository azure-powershell-migration.

Passaggi successivi

Per altre informazioni sul modulo Az PowerShell, vedere documentazione di Azure PowerShell