Skip to content

Commit 7438ea7

Browse files
matthchrmatthchr
committed
Update changelog and breaking changes files
1 parent 96c4fc0 commit 7438ea7

File tree

3 files changed

+127
-71
lines changed

3 files changed

+127
-71
lines changed

‎src/ResourceManager/AzureBatch/ChangeLog.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,51 @@
2727
- $autoUser = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoUserSpecification -ArgumentList @("Task", "Admin")
2828
- $userIdentity = New-Object Microsoft.Azure.Commands.Batch.Models.PSUserIdentity $autoUser
2929
- Added the `AuthenticationTokenSettings` parameter. This parameter allows you to request the Batch service provide an authentication token to the task when it runs, avoiding the need to pass Batch account keys to the task in order to issue requests to the Batch service.
30-
* Added the `UserAccounts` parameter to `New-AzureBatchPool`.
31-
- This parameter defines user accounts created on each node in the pool.
30+
- Added the `ContainerSettings` parameter.
31+
- This parameter allows you to request the Batch service run the task inside a container.
32+
- Added the `OutputFiles` parameter.
33+
- This parameter allows you to configure the task to upload files to Azure Storage after it has finished.
34+
* Updated parameters to `New-AzureBatchPool`.
35+
- Added the `UserAccounts` parameter.
36+
- This parameter defines user accounts created on each node in the pool.
37+
- Added `TargetLowPriorityComputeNodes` and renamed `TargetDedicated` to `TargetDedicatedComputeNodes`.
38+
- A `TargetDedicated` alias was created for the `TargetDedicatedComputeNodes` parameter.
39+
- Added the `NetworkConfiguration` parameter.
40+
- This parameter allows you to configure the pools network settings.
41+
* Updated parameters to `New-AzureBatchCertificate`.
42+
- The `Password` parameter is now a `SecureString`.
43+
* Updated parameters to `New-AzureBatchComputeNodeUser`.
44+
- The `Password` parameter is now a `SecureString`.
45+
* Updated parameters to `Set-AzureBatchComputeNodeUser`.
46+
- The `Password` parameter is now a `SecureString`.
3247
* Renamed the `Name` parameter to `Path` on `Get-AzureBatchNodeFile`, `Get-AzureBatchNodeFileContent`, and `Remove-AzureBatchNodeFile`.
3348
- A `Name` alias was created for the `Path` parameter.
3449
* Changes to objects:
3550
- Removed the `RunElevated` property on `PSCloudTask`, `PSStartTask`, `PSJobManagerTask`, `PSJobPreparationTask`, and `PSJobReleaseTask`. The `UserIdentity` property has been added to replace `RunElevated`. Equivalent behavior to `RunElevated = $true` can be achieved by constructing a `PSUserIdentity` as shown below:
3651
- $autoUser = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoUserSpecification -ArgumentList @("Task", "Admin")
3752
- $userIdentity = New-Object Microsoft.Azure.Commands.Batch.Models.PSUserIdentity $autoUser
3853
- Added the `AuthenticationTokenSettings` property to `PSCloudTask` and `PSJobManagerTask`.
54+
- Added the `OutputFiles` property to `PSCloudTask`, and `PSJobManagerTask`.
55+
- Added the `ContainerSettings` property to `PSCloudTask`, `PSStartTask`, `PSJobManagerTask`, `PSJobPreparationTask`, and `PSJobReleaseTask`.
56+
- Added the `AllowLowPriorityNode` property to `PSJobManagerTask`.
57+
- Renamed the `SchedulingError` property on `PSJobPreparationTaskExecutionInformation`, `PSJobReleaseTaskExecutionInformation`, `PSStartTaskInformation`, `PSSubtaskInformation`, and `PSTaskExecutionInformation` to `FailureInformation`.
58+
- `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.
59+
- Renamed `PSTaskSchedulingError` to `PSTaskFailureInformation`.
60+
- Added the `ContainerInformation` and `Result` properties to `PSJobPreparationTaskExecutionInformation`, `PSJobReleaseTaskExecutionInformation`, `PSStartTaskInformation`, `PSSubtaskInformation`, and `PSTaskExecutionInformation`.
3961
- Added the `UserAccounts` property to `PSCloudPool` and `PSPoolSpecification`.
62+
- Added the `TargetLowPriorityComputeNodes` property to `PSCloudPool` and `PSPoolSpecification`, and renamed `TargetDedicated` to `TargetDedicatedComputeNodes`.
4063
- Renamed the `Name` property on `PSNodeFile` to `Path`.
64+
- Added the `EndpointConfiguration` and `IsDedicated` property to `PSComputeNode`.
65+
- Renamed the `SchedulingError` property on `PSExitConditions` to `PreProcessingError`.
66+
- Added the `FileUploadError` to `PSExitConditions`.
4167
- Added the `DependencyAction` property to `PSExitOptions`.
42-
- Added the `OSDisk` property to `PSVirtualMachineConfiguration`. Note that in order to allow deploying nodes using custom VHDs, the Batch account being used must have been created with `PoolAllocationMode = UserSubscription`.
68+
- Added the `OSDisk`, `ContainerConfiguration`, `DataDisks`, and `LicenseType` properties to `PSVirtualMachineConfiguration`.
69+
- Added the `VirtualMachineImageId` property to `PSImageReference`. Note that in order to allow deploying nodes using custom VHDs, the `BatchAccountContext` must be using Azure Active Directory authentication.
70+
- Added the `OnAllTasksComplete` and `OnTaskFailure` properties to `PSJobSpecification`.
71+
- Added the `EndpointConfiguration` property to `PSNetworkConfiguration`.
72+
- Renamed `ResizeError` to `ResizeErrors` on `PSCloudPool`, and it is now a collection.
73+
- `PSMultiInstanceSettings` constructor no longer takes a required `numberOfInstances` parameter, instead it takes a required `coordinationCommandLine` parameter.
74+
4375
* Added support for Azure Active Directory based authentication.
4476
- To use Azure Active Directory authentication, retrieve a `BatchAccountContext` object using the `Get-AzureRmBatchAccount` cmdlet, and supply this `BatchAccountContext` to the `-BatchContext` parameter of a Batch service cmdlet. Azure Active Directory authentication is mandatory for accounts with `PoolAllocationMode = UserSubscription`.
4577
- For existing accounts or for new accounts created with `PoolAllocationMode = BatchService`, you may continue to use shared key authentication by retrieving a `BatchAccountContext` object using the `Get-AzureRmBatchAccoutKeys` cmdlet.

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

Lines changed: 91 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,94 @@
3939
-->
4040

4141
## Current Breaking Changes
42-
* Removed the `RunElevated` switch on the `New-AzureBatchTask` cmdlet. The `UserIdentity` parameter has been added to replace `RunElevated`, and the equivalent behavior can be achieved by constructing a `PSUserIdentity` as shown below:
43-
- $autoUser = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoUserSpecification -ArgumentList @("Task", "Admin")
44-
- $userIdentity = New-Object Microsoft.Azure.Commands.Batch.Models.PSUserIdentity $autoUser
45-
* Removed the `RunElevated` property on `PSCloudTask`, `PSStartTask`, `PSJobManagerTask`, `PSJobPreparationTask`, and `PSJobReleaseTask`. The `UserIdentity` property has been added to replace `RunElevated`. Equivalent behavior to `RunElevated = $true` can be achieved by constructing a `PSUserIdentity` as shown below:
46-
- $autoUser = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoUserSpecification -ArgumentList @("Task", "Admin")
47-
- $userIdentity = New-Object Microsoft.Azure.Commands.Batch.Models.PSUserIdentity $autoUser
48-
* Renamed the `Name` property on `PSNodeFile` to `Path`.
42+
## Release 5.0.0 - November 2017
43+
44+
### Changes to objects
45+
- Renamed `ResizeError` to `ResizeErrors` on `PSCloudPool`, and it is now a collection.
46+
- Renamed the `Name` property on `PSNodeFile` to `Path`.
47+
- Renamed `PSTaskSchedulingError` to `PSTaskFailureInformation`.
48+
- Renamed the `SchedulingError` property on `PSJobPreparationTaskExecutionInformation`, `PSJobReleaseTaskExecutionInformation`, `PSStartTaskInformation`, `PSSubtaskInformation`, and `PSTaskExecutionInformation` to `FailureInformation`.
49+
- `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.
50+
- Renamed the `SchedulingError` property on `PSExitConditions` to `PreProcessingError`.
51+
- `PSMultiInstanceSettings` constructor no longer takes a required `numberOfInstances` parameter, instead it takes a required `coordinationCommandLine` parameter.
52+
53+
The following cmdlets were affected this release:
54+
55+
**New-AzureBatchCertificate**
56+
- Parameter `Password` being replaced in favor of a Secure string
57+
58+
```powershell
59+
60+
# Old
61+
# New-AzureBatchCertificate [other required parameters] -Password "plain-text string"
62+
63+
# New
64+
# New-AzureBatchCertificate [other required parameters] -Password $SecureStringVariable
65+
```
66+
67+
**New-AzureBatchComputeNodeUser**
68+
- Parameter `Password` being replaced in favor of a Secure string
69+
70+
```powershell
71+
72+
# Old
73+
# New-AzureBatchComputeNodeUser [other required parameters] -Password "plain-text string"
74+
75+
# New
76+
# New-AzureBatchComputeNodeUser [other required parameters] -Password $SecureStringVariable
77+
```
78+
79+
**Set-AzureRmBatchComputeNodeUser**
80+
- Parameter `Password` being replaced in favor of a Secure string
81+
82+
```powershell
83+
84+
# Old
85+
# Set-AzureRmBatchComputeNodeUser [other required parameters] -Password "plain-text string"
86+
87+
# New
88+
# Set-AzureRmBatchComputeNodeUser [other required parameters] -Password $SecureStringVariable
89+
```
90+
91+
**New-AzureBatchTask**
92+
- Removed the `RunElevated` switch and replaced it with `UserIdentity`.
93+
94+
```powershell
95+
# Old
96+
New-AzureBatchTask -Id $taskId1 -JobId $jobId -CommandLine "cmd /c echo hello" -RunElevated $TRUE
97+
98+
# New
99+
$autoUser = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoUserSpecification -ArgumentList @("Task", "Admin")
100+
$userIdentity = New-Object Microsoft.Azure.Commands.Batch.Models.PSUserIdentity $autoUser
101+
New-AzureBatchTask -Id $taskId1 -JobId $jobId -CommandLine "cmd /c echo hello" -UserIdentity $userIdentity
102+
```
103+
104+
This additionally impacts the `RunElevated` property on `PSCloudTask`, `PSStartTask`, `PSJobManagerTask`, `PSJobPreparationTask`, and `PSJobReleaseTask`.
105+
106+
**New-AzureBatchPool**
107+
- Removed `TargetDedicated` and replaced it with `TargetDedicatedComputeNodes` and `TargetLowPriorityComputeNodes`.
108+
- `TargetDedicatedComputeNodes` has an alias `TargetDedicated`.
109+
110+
```powershell
111+
# Old
112+
New-AzureBatchPool [other parameters] [-TargetDedicated <Int32>]
113+
114+
# New
115+
New-AzureBatchPool [other parameters] [-TargetDedicatedComputeNodes <Int32>] [-TargetLowPriorityComputeNodes <Int32>]
116+
```
117+
118+
This also impacts: Start-AzureBatchPoolResize
119+
120+
**Get-AzureBatchNodeFile**
121+
- Removed `Name` and replaced it with `Path`.
122+
- `Path` has an alias `Name`.
123+
124+
```powershell
125+
# Old
126+
Get-AzureBatchNodeFile [other parameters] [[-Name] <String>]
127+
128+
# New
129+
Get-AzureBatchNodeFile [other parameters] [[-Path] <String>]
130+
```
131+
132+
This also impacts: Get-AzureBatchNodeFileContent, Remove-AzureBatchNodeFile

‎src/ResourceManager/AzureBatch/documentation/upcoming-breaking-changes.md

Lines changed: 1 addition & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -25,65 +25,5 @@
2525
https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md
2626
-->
2727

28-
# Upcoming Breaking Changes
28+
# Upcoming Breaking Changes
2929

30-
## Release 5.0.0 - November 2017
31-
32-
- `PSCloudPool` `ResizeError` was replaced by `ResizeErrors`.
33-
- `PSJobPreparationTaskExecutionInformation`, `PSJobReleaseTaskExecutionInformation`, `PSStartTaskInformation`, `PSTaskExecutionInformation`, and `PSSubtaskInformation`
34-
no longer have a `SchedulingError` property, they instead have a `FailureInformation` property. `FailureInformation` is returned any time there is a task failure.
35-
This includes all previous scheduling error cases, as well as nonzero task exit codes, and file upload failures from the new output files feature.
36-
- `PSMultiInstanceSettings` constructor no longer takes a required `numberOfInstances` parameter, instead it takes a required `coordinationCommandLine` parameter.
37-
38-
The following cmdlets were affected this release:
39-
40-
**New-AzureBatchCertificate**
41-
- Parameter "Password" being replaced in favor of a Secure string
42-
43-
```powershell
44-
45-
# Old
46-
# New-AzureBatchCertificate [other required parameters] -Password "plain-text string"
47-
48-
# New
49-
# New-AzureBatchCertificate [other required parameters] -Password $SecureStringVariable
50-
```
51-
52-
**New-AzureBatchComputeNodeUser**
53-
- Parameter "Password" being replaced in favor of a Secure string
54-
55-
```powershell
56-
57-
# Old
58-
# New-AzureBatchComputeNodeUser [other required parameters] -Password "plain-text string"
59-
60-
# New
61-
# New-AzureBatchComputeNodeUser [other required parameters] -Password $SecureStringVariable
62-
```
63-
64-
**Set-AzureRmBatchComputeNodeUser**
65-
- Parameter "Password" being replaced in favor of a Secure string
66-
67-
```powershell
68-
69-
# Old
70-
# Set-AzureRmBatchComputeNodeUser [other required parameters] -Password "plain-text string"
71-
72-
# New
73-
# Set-AzureRmBatchComputeNodeUser [other required parameters] -Password $SecureStringVariable
74-
```
75-
76-
**New-AzureBatchTask**
77-
- Removed the `RunElevated` switch and replaced it with `UserIdentity`.
78-
79-
```powershell
80-
# Old
81-
New-AzureBatchTask -Id $taskId1 -JobId $jobId -CommandLine "cmd /c echo hello" -RunElevated $TRUE
82-
83-
# New
84-
$autoUser = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoUserSpecification -ArgumentList @("Task", "Admin")
85-
$userIdentity = New-Object Microsoft.Azure.Commands.Batch.Models.PSUserIdentity $autoUser
86-
New-AzureBatchTask -Id $taskId1 -JobId $jobId -CommandLine "cmd /c echo hello" -UserIdentity $userIdentity
87-
```
88-
89-
This additionally impacts the `RunElevated` property on `PSCloudTask`, `PSStartTask`, `PSJobManagerTask`, `PSJobPreparationTask`, and `PSJobReleaseTask`.

0 commit comments

Comments
 (0)