Migrar automaticamente scripts do PowerShell do AzureRM para o módulo Az PowerShell
Neste artigo, você aprenderá a usar o módulo Az.Tools.Migration PowerShell para atualizar automaticamente seus scripts e módulos de script do PowerShell do AzureRM para o módulo Az PowerShell. Para obter opções de migração adicionais, consulte Migrar o Azure PowerShell do AzureRM para Az.
Advertência
O módulo AzureRM PowerShell foi oficialmente preterido a partir de 29 de fevereiro de 2024. Os usuários são aconselhados a migrar do AzureRM para o módulo Az PowerShell para garantir suporte e atualizações contínuos.
Embora o módulo AzureRM ainda possa funcionar, ele não é mais mantido ou suportado, colocando qualquer uso continuado a critério e risco do usuário. Consulte os nossos recursos de migração para obter orientação sobre a transição para o módulo Az.
Requerimentos
Atualize seus scripts do PowerShell existentes para a versão mais recente do módulo PowerShell do AzureRM (6.13.1).
Instale o módulo Az.Tools.Migration PowerShell.
Install-Module -Name Az.Tools.Migration
Etapa 1: gerar um plano de atualização
Use o cmdlet New-AzUpgradeModulePlan para gerar um plano de atualização para migrar seus scripts e módulos para o módulo Az PowerShell. Este cmdlet não faz alterações nos scripts existentes. Use o parâmetro FilePath para direcionar um script específico ou o parâmetro DirectoryPath para direcionar todos os scripts em uma pasta específica.
Observação
O cmdlet New-AzUpgradeModulePlan não executa o plano, apenas gera as etapas de atualização.
O exemplo a seguir gera um plano para todos os scripts na pasta C:\Scripts. O parâmetro OutVariable é especificado para que os resultados sejam retornados e armazenados simultaneamente em uma variável chamada 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
Conforme mostrado na saída a seguir, o plano de upgrade detalha o arquivo específico e os pontos de offset que exigem alterações ao transitar do AzureRM para os cmdlets do 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
...
Antes de executar a atualização, você precisa verificar os resultados do plano quanto a problemas. O exemplo a seguir retorna uma lista de scripts e os itens nesses scripts que impedirão que eles sejam atualizados automaticamente.
# Filter plan results to only warnings and errors
$Plan | Where-Object PlanResult -ne ReadyToUpgrade | Format-List
Os itens mostrados na saída a seguir não serão atualizados automaticamente sem corrigir manualmente os problemas primeiro.
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 :
Etapa 2: Executar a atualização
Atenção
Não há operação de desfazer. Certifique-se sempre de ter uma cópia de backup dos scripts e módulos do PowerShell que está tentando atualizar.
Depois que você estiver satisfeito com o plano, a atualização será executada com o cmdlet Invoke-AzUpgradeModulePlan. Especifique SaveChangesToNewFiles para o valor do parâmetro FileEditMode para evitar que alterações sejam feitas em seus scripts originais. Ao usar este modo, a atualização é executada criando uma cópia de cada script alvo com _az_upgraded anexado aos nomes dos arquivos.
Advertência
O cmdlet Invoke-AzUpgradeModulePlan é destrutivo quando a opção -FileEditMode ModifyExistingFiles é especificada! Ele modifica seus scripts e funções de acordo com o plano de atualização do módulo gerado pelo cmdlet New-AzUpgradeModulePlan. Para a opção não destrutiva, especifique -FileEditMode SaveChangesToNewFiles em vez disso.
# 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 algum erro for retornado, você pode examinar mais de perto os resultados do erro com o seguinte comando:
# 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 :
Limitações
- As operações de E/S de arquivo usam codificação padrão. Situações incomuns de codificação de arquivos podem causar problemas.
- Os cmdlets do AzureRM passados como argumentos para declarações simuladas de testes unitários do Pester não são detetados.
Como comunicar problemas
Relate comentários e problemas sobre o módulo Az.Tools.Migration PowerShell por meio de uma questão no GitHub no repositório azure-powershell-migration.
Próximos passos
- Etapas de migração
- migrar automaticamente scripts do PowerShell
- Apresentando o módulo Az PowerShell
- Alterações entre AzureRM e Az
- Instalar o módulo Az PowerShell
- desinstalar o AzureRM
Para saber mais sobre o módulo Az PowerShell, consulte a documentação do Azure PowerShell
Azure PowerShell