Prepare migration guide for 5.0.0 release

src/ResourceManager/ApiManagement/documentation/current-breaking-changes.md

@@ -38,4 +38,41 @@
     https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md
 -->
 
-## Current Breaking Changes
+## Current Breaking Changes
+
+### Release 5.0.0 - November 2017
+
+The following cmdlets were affected this release:
+
+**New-AzureRmApiManagementBackendProxy**
+- Parameters "UserName" and "Password" are being replaced in favor of a PSCredential
+
+```powershell
+# Old
+New-AzureRmApiManagementBackendProxy [other required parameters] -UserName "plain-text string" -Password "plain-text string"
+
+# New
+New-AzureRmApiManagementBackendProxy [other required parameters] -Credential $PSCredentialVariable
+```
+
+**New-AzureRmApiManagementUser**
+- Parameter "Password" being replaced in favor of a SecureString
+
+```powershell
+# Old
+New-AzureRmApiManagementUser [other required parameters] -Password "plain-text string"
+
+# New
+New-AzureRmApiManagementUser [other required parameters] -Password $SecureStringVariable
+```
+
+**Set-AzureRmApiManagementUser**
+- Parameter "Password" being replaced in favor of a SecureString
+
+```powershell
+# Old
+Set-AzureRmApiManagementUser [other required parameters] -Password "plain-text string"
+
+# New
+Set-AzureRmApiManagementUser [other required parameters] -Password $SecureStringVariable
+```

src/ResourceManager/ApiManagement/documentation/upcoming-breaking-changes.md

@@ -25,42 +25,4 @@
     https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md
 -->
 
-# Upcoming Breaking Changes
-
-The following cmdlets were affected this release:
-
-**New-AzureRmApiManagementBackendProxy**
-- Parameters "UserName" and "Password" are being replaced in favor of a PSCredential
-
-```powershell
-
-# Old
-# New-AzureRmApiManagementBackendProxy [other required parameters] -UserName "plain-text string" -Password "plain-text string"
-
-# New
-# New-AzureRmApiManagementBackendProxy [other required parameters] -Credential $PSCredentialVariable
-```
-
-**New-AzureRmApiManagementUser**
-- Parameter "Password" being replaced in favor of a SecureString
-
-```powershell
-
-# Old
-# New-AzureRmApiManagementUser [other required parameters] -Password "plain-text string"
-
-# New
-# New-AzureRmApiManagementUser [other required parameters] -Password $SecureStringVariable
-```
-
-**Set-AzureRmApiManagementUser**
-- Parameter "Password" being replaced in favor of a SecureString
-
-```powershell
-
-# Old
-# Set-AzureRmApiManagementUser [other required parameters] -Password "plain-text string"
-
-# New
-# Set-AzureRmApiManagementUser [other required parameters] -Password $SecureStringVariable
-```
+# Upcoming Breaking Changes

src/ResourceManager/AzureBatch/documentation/current-breaking-changes.md

@@ -39,3 +39,211 @@
 -->
 
 ## Current Breaking Changes
+
+### Release 4.0.0 - November 2017
+
+The following cmdlets were affected this release:
+
+**New-AzureBatchCertificate**
+- Parameter `Password` being replaced in favor of a Secure string
+
+```powershell
+# Old
+New-AzureBatchCertificate [other required parameters] -Password "plain-text string"
+
+# New
+New-AzureBatchCertificate [other required parameters] -Password $SecureStringVariable
+```
+
+**New-AzureBatchComputeNodeUser**
+- Parameter `Password` being replaced in favor of a Secure string
+
+```powershell
+# Old
+New-AzureBatchComputeNodeUser [other required parameters] -Password "plain-text string"
+
+# New
+New-AzureBatchComputeNodeUser [other required parameters] -Password $SecureStringVariable
+```
+
+**Set-AzureRmBatchComputeNodeUser**
+- Parameter `Password` being replaced in favor of a Secure string
+
+```powershell
+# Old
+Set-AzureRmBatchComputeNodeUser [other required parameters] -Password "plain-text string"
+
+# New
+Set-AzureRmBatchComputeNodeUser [other required parameters] -Password $SecureStringVariable
+```
+
+**New-AzureBatchTask**
+ - Removed the `RunElevated` switch and replaced it with `UserIdentity`.
+
+```powershell
+# Old
+New-AzureBatchTask -Id $taskId1 -JobId $jobId -CommandLine "cmd /c echo hello" -RunElevated $TRUE
+
+# New
+$autoUser = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoUserSpecification -ArgumentList @("Task", "Admin")
+$userIdentity = New-Object Microsoft.Azure.Commands.Batch.Models.PSUserIdentity $autoUser
+New-AzureBatchTask -Id $taskId1 -JobId $jobId -CommandLine "cmd /c echo hello" -UserIdentity $userIdentity
+```
+
+This additionally impacts the `RunElevated` property on `PSCloudTask`, `PSStartTask`, `PSJobManagerTask`, `PSJobPreparationTask`, and `PSJobReleaseTask`.
+
+- `PSMultiInstanceSettings` constructor no longer takes a required `numberOfInstances` parameter, instead it takes a required `coordinationCommandLine` parameter.
+
+```powershell
+# Old
+$settings = New-Object Microsoft.Azure.Commands.Batch.Models.PSMultiInstanceSettings -ArgumentList @(2)
+$settings.CoordinationCommandLine = "cmd /c echo hello"
+New-AzureBatchTask [other parameters] -MultiInstanceSettings $settings
+
+# New
+$settings = New-Object Microsoft.Azure.Commands.Batch.Models.PSMultiInstanceSettings -ArgumentList @("cmd /c echo hello", 2)
+New-AzureBatchTask [other parameters] -MultiInstanceSettings $settings
+```
+
+**Get-AzureBatchTask**
+ - Removed the `RunElevated` property on `PSCloudTask`. The `UserIdentity` property has been added to replace `RunElevated`.
+
+```powershell
+# Old
+$task = Get-AzureBatchTask [parameters]
+$task.RunElevated
+
+# New
+$task = Get-AzureBatchTask [parameters]
+$task.UserIdentity.AutoUser.ElevationLevel
+```
+
+This additionally impacts the `RunElevated` property on `PSCloudTask`, `PSStartTask`, `PSJobManagerTask`, `PSJobPreparationTask`, and `PSJobReleaseTask`.
+
+- Renamed the `SchedulingError` property on `PSExitConditions` to `PreProcessingError`.
+
+```powershell
+# Old
+$task = Get-AzureBatchTask [parameters]
+$task.ExitConditions.SchedulingError
+
+# New
+$task = Get-AzureBatchTask [parameters]
+$task.ExitConditions.PreProcessingError
+```
+
+- Renamed the `SchedulingError` property on `PSJobPreparationTaskExecutionInformation`, `PSJobReleaseTaskExecutionInformation`, `PSStartTaskInformation`, `PSSubtaskInformation`, and `PSTaskExecutionInformation` to `FailureInformation`.
+  - `FailureInformation` is returned any time there is a task failure. This includes all previous scheduling error cases, as well as nonzero task exit codes, and file upload failures from the new output files feature.
+  - This is structured the same as before, so no code change is needed when using this type.
+
+```powershell
+# Old
+$task = Get-AzureBatchTask [parameters]
+$task.ExecutionInformation.SchedulingError
+
+# New
+$task = Get-AzureBatchTask [parameters]
+$task.ExecutionInformation.FailureInformation
+```
+
+This additionally impacts: Get-AzureBatchPool, Get-AzureBatchSubtask, and Get-AzureBatchJobPreparationAndReleaseTaskStatus
+
+**New-AzureBatchPool**
+ - Removed `TargetDedicated` and replaced it with `TargetDedicatedComputeNodes` and `TargetLowPriorityComputeNodes`.
+ - `TargetDedicatedComputeNodes` has an alias `TargetDedicated`.
+
+```powershell
+# Old
+New-AzureBatchPool [other parameters] [-TargetDedicated <Int32>]
+
+# New
+New-AzureBatchPool [other parameters] [-TargetDedicatedComputeNodes <Int32>] [-TargetLowPriorityComputeNodes <Int32>]
+```
+
+This also impacts: Start-AzureBatchPoolResize
+
+**Get-AzureBatchPool**
+ - Renamed the `TargetDedicated` and `CurrentDedicated` properties on `PSCloudPool` to `TargetDedicatedComputeNodes` and `CurrentDedicatedComputeNodes`.
+
+```powershell
+# Old
+$pool = Get-AzureBatchPool [parameters]
+$pool.TargetDedicated
+$pool.CurrentDedicated
+
+# New
+$pool = Get-AzureBatchPool [parameters]
+$pool.TargetDedicatedComputeNodes
+$pool.CurrentDedicatedComputeNodes
+```
+
+- Renamed `ResizeError` to `ResizeErrors` on `PSCloudPool`, and it is now a collection.
+
+```powershell
+# Old
+$pool = Get-AzureBatchPool [parameters]
+$pool.ResizeError
+
+# New
+$pool = Get-AzureBatchPool [parameters]
+$pool.ResizeErrors[0]
+```
+
+**New-AzureBatchJob**
+- Renamed the `TargetDedicated` property on `PSPoolSpecification` to `TargetDedicatedComputeNodes`.
+
+```powershell
+# Old
+$poolInfo = New-Object Microsoft.Azure.Commands.Batch.Models.PSPoolInformation
+$poolInfo.AutoPoolSpecification = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoPoolSpecification
+$poolInfo.AutoPoolSpecification.PoolSpecification = New-Object Microsoft.Azure.Commands.Batch.Models.PSPoolSpecification
+$poolInfo.AutoPoolSpecification.PoolSpecification.TargetDedicated = 5
+New-AzureBatchJob [other parameters] -PoolInformation $poolInfo
+
+# New
+$poolInfo = New-Object Microsoft.Azure.Commands.Batch.Models.PSPoolInformation
+$poolInfo.AutoPoolSpecification = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoPoolSpecification
+$poolInfo.AutoPoolSpecification.PoolSpecification = New-Object Microsoft.Azure.Commands.Batch.Models.PSPoolSpecification
+$poolInfo.AutoPoolSpecification.PoolSpecification.TargetDedicatedComputeNodes = 5
+New-AzureBatchJob [other parameters] -PoolInformation $poolInfo
+```
+
+**Get-AzureBatchNodeFile**
+ - Removed `Name` and replaced it with `Path`.
+ - `Path` has an alias `Name`.
+
+```powershell
+# Old
+Get-AzureBatchNodeFile [other parameters] [[-Name] <String>]
+
+# New
+Get-AzureBatchNodeFile [other parameters] [[-Path] <String>]
+```
+
+This also impacts: Get-AzureBatchNodeFileContent, Remove-AzureBatchNodeFile
+
+ - Renamed the `Name` property on `PSNodeFile` to `Path`.
+
+```powershell
+# Old
+$file = Get-AzureBatchNodeFile [parameters]
+$file.Name
+
+# New
+$file = Get-AzureBatchNodeFile [parameters]
+$file.Path
+```
+
+**Get-AzureBatchSubtask**
+- The `PreviousState` and `State` properties of `PSSubtaskInformation` are no longer of type `TaskState`, instead they are of type `SubtaskState`.
+  - Unlike `TaskState`, `SubtaskState` has no `Active` value, since it is not possible for subtasks to be in an `Active` state.
+
+```powershell
+# Old
+$subtask = Get-AzureBatchSubtask [parameters]
+if ($subtask.State -eq Microsoft.Azure.Batch.Common.TaskState.Running) { }
+
+# New
+$subtask = Get-AzureBatchSubtask [parameters]
+if ($subtask.State -eq Microsoft.Azure.Batch.Common.SubtaskState.Running) { }
+```