|
| 1 | + |
| 2 | +This document serves as both a breaking change notification and migration guide for consumers of the AzureStack powershell version 2.0.0-preview. The module AzureStack 2.0.0-preview is compatible with both powershell core and windows powershell. The modules an also be installed on MacOs and Linux in addition to Windows. |
| 3 | + |
| 4 | +The previous version 1.8.1 is compatible only with windows powershell and does not support Mac/Linux platforms. The version 1.8.1 also requires AzureRM modules instead of Az. |
| 5 | + |
| 6 | +The modules are generated with the autorest tool (https://github.com/Azure/autorest.powershell). |
| 7 | + |
| 8 | +## Breaking Changes |
| 9 | + |
| 10 | +- [Common Changes](#common-changes) |
| 11 | +- [Azs.Backup.Admin](#azs-backup-admin) |
| 12 | +- [Azs.Network.Admin](#azs-network-admin) |
| 13 | +- [Azs.Fabric.Admin](#azs-fabric-admin) |
| 14 | +- [Azs.Storage.Admin](#azs-storage-admin) |
| 15 | +- [Azs.Subscriptions.Admin](#azs-subscriptions-admin) |
| 16 | +- [Azs.Subscriptions](#azs-subscriptions) |
| 17 | + |
| 18 | +## Common Changes |
| 19 | + |
| 20 | +### Az.Accounts dependency |
| 21 | +All AzureStack Admin modules have dependency on the Az.Accounts module version 2.0.1-preview. This version of Az.Accounts module is built with MSAL dll(https://github.com/AzureAD/microsoft-authentication-library-for-dotnet). This supports ADFS scenarios and device code authentication |
| 22 | + |
| 23 | +### Output Model Changes |
| 24 | +Output models of all the cmdlets have changed. Since the powershell modules are generated with the new autorest powershell extension, the output models have all changed considerably. If the existing scripts are accessing the output model, they likely need a change. Since the output model changes are huge and it impact each and every cmdlet, this guide does not list each of the changes |
| 25 | + |
| 26 | +### Removal of -AsJob feature |
| 27 | +The current version of the cmdlets do not support -AsJob paramter. It will get added in a future release as auotorest powershell generator evolves. |
| 28 | + |
| 29 | +### Removal of -ResourceId Parameter |
| 30 | +The ResourceId paramter got removed in all of the cmdlets. The Id is part of the InputObject parameter set now. So we could still use the piping with Id. |
| 31 | + |
| 32 | +### Removal of -Force Parameter |
| 33 | +The -Force paramter has been removed from the following cmdlets. The cmdlets would honor the $ConfirmPreference. |
| 34 | + - `Remove-AzsAzureBridgeDownloadedProduct` |
| 35 | + - `Start-AzsBackup` |
| 36 | + - `Remove-AzsComputeQuota` |
| 37 | + - `Remove-AzsPlatformImage` |
| 38 | + - `Remove-AzsVMExtension` |
| 39 | + - `Remove-AzsGalleryItem` |
| 40 | + - `Remove-AzsNetworkQuota` |
| 41 | + - `Remove-AzsStorageQuota` |
| 42 | + |
| 43 | +## Azs.Backup.Admin |
| 44 | +### **Set-AzsBackupConfiguration** |
| 45 | + - Parameter -IsBackupSchedulerEnabled has been changed from [bool] to [switch] in the cmldet |
| 46 | +## Azs.Network.Admin |
| 47 | +### **Set-AzsComputeQuota** |
| 48 | +- Parameter set of updating existing compute quota only by specififying the needed fields got deprecated. To update an existing quota user needs to get the quota object, modify the properties and pipe the object to set cmldet |
| 49 | + |
| 50 | +## Azs.Network.Admin |
| 51 | +### **Set-AzsNetworkQuota** |
| 52 | +- Parameter set of updating existing network quota only by specififying the needed fields got deprecated. To update an existing quota user needs to get the quota object, modify the properties and pipe the object to set cmldet |
| 53 | + |
| 54 | +## Azs.Fabric.Admin |
| 55 | +### **Get-AzsInfrastructureRoleInstance ** |
| 56 | +- Return property changed: The object Size (.Cores/.MemoryInGB) is flattened to NumberOfCores and SizeMemoryInGB |
| 57 | +### **Get-AzsScaleUnit** |
| 58 | +- Return property changed: The object TotalCapacity (.Cores/.MemoryInGB) is flattened to TotalCapacityOfCores and TotalCapacityOfMemoryInGB |
| 59 | +### **Get-AzsScaleUnitNode** |
| 60 | +- Return property changed: The object Capacity (.Cores/.MemoryInGB) is flattened to CapacityOfCores and CapacityOfMemoryInGB |
| 61 | + |
| 62 | +## Azs.Storage.Admin |
| 63 | +### **Update-AzsStorageSettings** |
| 64 | +- The cmdlet Update-AzsStorageSettings has been renamed to Set-AzsStorageSettings |
| 65 | +- A new parameter -Force has also been added |
| 66 | +## Set-AzsStorageQuota |
| 67 | +-The pipeable parameter -InputObject has been renamed to -QuotaObject to avoid confusion. This is not a breaking change for pipeline scenario. |
| 68 | + |
| 69 | +## Azs.Subscriptions.Admin |
| 70 | +### **Get-AzsDelegatedProviderManagedOffer** |
| 71 | +- Parameter DelegatedProvider has been deprecated. Please use DelegatedProviderSubscriptionId parameter or the alias DelegatedProviderId instead. |
| 72 | + |
| 73 | +### **New-AzsSubscriptionPlan**, **Get-AzsSubscriptionPlan**, **Remove-AzsSubscriptionPlan** |
| 74 | +- Parameter AcquisitionId has been deprecated. Please use PlanAcquisitionId parameter instead. |
| 75 | + |
| 76 | +### **SubscriptionId renamed to TargetSubscriptionId** |
| 77 | +- Parameter SubscriptionId has been deprecated. Please use the parameter TargetSubscriptionId instead. The affected cmdlets are Get-AzsUserSubscription, New-AzsOfferDelegation, New-AzsUserSubscription, Remove-AzsUserSubscription and Set-AzsUserSubscription |
| 78 | + |
| 79 | +### **Move-AzsSubscription** |
| 80 | +- The cmdlet Move-AzsSubscription has been renamed to Move-AzsUserSubscription |
| 81 | + |
| 82 | +### **ArmLocation parameter deprecated** |
| 83 | +- Parameter ArmLocation deprecated. Please use Location parameter instead. The affected cmdlets are New-AzsOffer, New-AzsPlan, Set-AzsOffer, Set-AzsPlan |
| 84 | + |
| 85 | +### **Set-AzsUserSubscription** |
| 86 | +- To update the subscription, the user object should be retrieved with the Get command, modify the needed properties in the object and then pipe it to the Set command. Please look at the example [here](https://github.com/Azure/azurestack-powershell/blob/master/src/Azs.Subscriptions.Admin/examples/Set-AzsUserSubscription.md). The update can also be done by explicitly passing all the individual properties as parameter. The parameter Location has been deprecated |
| 87 | + |
| 88 | +### **Set-AzsOffer** |
| 89 | +- To update the Offer, the Offer object should be retrieved with the Get command, modify the needed properties in the object and then pipe it to the Set command. Please look at the example [here](https://github.com/Azure/azurestack-powershell/blob/master/src/Azs.Subscriptions.Admin/examples/Set-AzsOffer.md) |
| 90 | +).The update can also be done by explicitly passing all the individual properties as parameter. |
| 91 | + |
| 92 | + |
| 93 | +### **Set-AzsPlan** |
| 94 | +- To update the plan, the plan object should be retrieved with the Get command, modify the needed properties in the object and then pipe it to the Set command. Please look at the example [here](https://github.com/Azure/azurestack-powershell/blob/master/src/Azs.Subscriptions.Admin/examples/Set-AzsPlan.md) |
| 95 | +).The update can also be done by explicitly passing all the individual properties as parameter. |
| 96 | + |
| 97 | +## Azs.Subscriptions |
| 98 | +### **New-AzsSubscription** |
| 99 | +- The parameter Location has been deprecated |
| 100 | + |
| 101 | +### Set-AzsSubscription |
| 102 | +- The parameter Type and Tags has been deprecated |
0 commit comments