Update Batch management plane with latest features

Author: jasper-schneider

src/ResourceManager/AzureBatch/ChangeLog.md

@@ -18,6 +18,31 @@
         - Additional information about change #1
 -->
 ## Current Release
+* Added new parameters to `New-AzureRmBatchAccount`.
+    - `PoolAllocationMode`: The allocation mode to use for creating pools in the Batch account. To create a Batch account which allocates pool nodes in the user's subscription, set this to `UserSubscription`.
+    - `KeyVaultId`: The resource ID of the Azure key vault associated with the Batch account.
+    - `KeyVaultUrl`: The URL of the Azure key vault associated with the Batch account.
+* Updated parameters to `New-AzureBatchTask`.
+    - Removed the `RunElevated` switch. The `UserIdentity` parameter has been added to replace `RunElevated`, and the equivalent behavior can be achieved by constructing a `PSUserIdentity` as shown below:
+        - $autoUser = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoUserSpecification -ArgumentList @("Task", "Admin")
+        - $userIdentity = New-Object Microsoft.Azure.Commands.Batch.Models.PSUserIdentity $autoUser
+    - 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.
+* Added the `UserAccounts` parameter to `New-AzureBatchPool`.
+    - This parameter defines user accounts created on each node in the pool.
+* Renamed the `Name` parameter to `Path` on `Get-AzureBatchNodeFile`, `Get-AzureBatchNodeFileContent`, and `Remove-AzureBatchNodeFile`.
+    - A `Name` alias was created for the `Path` parameter.
+* Changes to objects:
+    - 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:
+        - $autoUser = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoUserSpecification -ArgumentList @("Task", "Admin")
+        - $userIdentity = New-Object Microsoft.Azure.Commands.Batch.Models.PSUserIdentity $autoUser
+    - Added the `AuthenticationTokenSettings` property to `PSCloudTask` and `PSJobManagerTask`.
+    - Added the `UserAccounts` property to `PSCloudPool` and `PSPoolSpecification`.
+    - Renamed the `Name` property on `PSNodeFile` to `Path`.
+    - Added the `DependencyAction` property to `PSExitOptions`.
+    - 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`.
+* Added support for Azure Active Directory based authentication.
+    - 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`.
+    - 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.
 
 ## Version 3.4.1
  - Marked cmdlet parameters and type properties obsolete in 

src/ResourceManager/AzureBatch/Commands.Batch.Test/BatchAccounts/NewBatchAccountCommandTests.cs

@@ -12,6 +12,7 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
+using Microsoft.Azure.Commands.Batch.Models;
 using Microsoft.Azure.Management.Batch.Models;
 using Microsoft.WindowsAzure.Commands.ScenarioTest;
 using Moq;
@@ -46,18 +47,28 @@ public void NewBatchAccountTest()
             string accountName = "account01";
             string resourceGroup = "resourceGroup";
             string location = "location";
-            BatchAccount accountResource = BatchTestHelpers.CreateAccountResource(accountName, resourceGroup);
-            BatchAccountContext expected = BatchAccountContext.ConvertAccountResourceToNewAccountContext(accountResource, null);
+            AccountCreateParameters actualCreateParameters = null;
 
-            batchClientMock.Setup(b => b.CreateAccount(resourceGroup, accountName, location, null, null)).Returns(expected);
+            // Setup the mock client to return a fake response and capture the account create parameters
+            BatchAccount accountResource = BatchTestHelpers.CreateAccountResource(accountName, resourceGroup, location);
+            BatchAccountContext fakeResponse = BatchAccountContext.ConvertAccountResourceToNewAccountContext(accountResource, null);
 
+            batchClientMock.Setup(b => b.CreateAccount(It.IsAny<AccountCreateParameters>()))
+                .Returns(fakeResponse)
+                .Callback((AccountCreateParameters p) => actualCreateParameters = p);
+
+            // Setup and run the cmdlet
             cmdlet.AccountName = accountName;
             cmdlet.ResourceGroupName = resourceGroup;
             cmdlet.Location = location;
-
             cmdlet.ExecuteCmdlet();
 
-            commandRuntimeMock.Verify(r => r.WriteObject(expected), Times.Once());
+            // Verify the fake response was written to the pipeline and that the captured account create
+            // parameters matched expectations.
+            commandRuntimeMock.Verify(r => r.WriteObject(fakeResponse), Times.Once());
+            Assert.Equal(accountName, actualCreateParameters.BatchAccount);
+            Assert.Equal(resourceGroup, actualCreateParameters.ResourceGroup);
+            Assert.Equal(location, actualCreateParameters.Location);
         }
 
         [Fact]
@@ -68,20 +79,70 @@ public void NewBatchWithAutoStorageAccountTest()
             string resourceGroup = "resourceGroup";
             string location = "location";
             string storageId = "storageId";
+            AccountCreateParameters actualCreateParameters = null;
 
-            BatchAccount accountResource = BatchTestHelpers.CreateAccountResource(accountName, resourceGroup);
-            BatchAccountContext expected = BatchAccountContext.ConvertAccountResourceToNewAccountContext(accountResource, null);
+            // Setup the mock client to return a fake response and capture the account create parameters
+            BatchAccount accountResource = BatchTestHelpers.CreateAccountResource(accountName, resourceGroup, location);
+            BatchAccountContext fakeResponse = BatchAccountContext.ConvertAccountResourceToNewAccountContext(accountResource, null);
 
-            batchClientMock.Setup(b => b.CreateAccount(resourceGroup, accountName, location, null, storageId)).Returns(expected);
+            batchClientMock.Setup(b => b.CreateAccount(It.IsAny<AccountCreateParameters>()))
+                .Returns(fakeResponse)
+                .Callback((AccountCreateParameters p) => actualCreateParameters = p);
 
+            // Setup and run the cmdlet
             cmdlet.AccountName = accountName;
             cmdlet.ResourceGroupName = resourceGroup;
             cmdlet.Location = location;
             cmdlet.AutoStorageAccountId = storageId;
+            cmdlet.ExecuteCmdlet();
+
+            // Verify the fake response was written to the pipeline and that the captured account create
+            // parameters matched expectations.
+            commandRuntimeMock.Verify(r => r.WriteObject(fakeResponse), Times.Once());
+            Assert.Equal(accountName, actualCreateParameters.BatchAccount);
+            Assert.Equal(resourceGroup, actualCreateParameters.ResourceGroup);
+            Assert.Equal(location, actualCreateParameters.Location);
+            Assert.Equal(storageId, actualCreateParameters.AutoStorageAccountId);
+        }
 
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void CanCreateUserSubscriptionBatchAccount()
+        {
+            string accountName = "account01";
+            string resourceGroup = "resourceGroup";
+            string location = "location";
+            string keyVaultId = "subscriptions/0000/resourceGroups/resourceGroup/providers/Microsoft.KeyVault/vaults/myVault";
+            string keyVaultUrl = "https://myVault.vault.azure.com";
+            PoolAllocationMode allocationMode = PoolAllocationMode.UserSubscription;
+            AccountCreateParameters actualCreateParameters = null;
+
+            // Setup the mock client to return a fake response and capture the account create parameters
+            BatchAccount accountResource = BatchTestHelpers.CreateAccountResource(accountName, resourceGroup, location);
+            BatchAccountContext fakeResponse = BatchAccountContext.ConvertAccountResourceToNewAccountContext(accountResource, null);
+
+            batchClientMock.Setup(b => b.CreateAccount(It.IsAny<AccountCreateParameters>()))
+                .Returns(fakeResponse)
+                .Callback((AccountCreateParameters p) => actualCreateParameters = p);
+
+            // Setup and run the cmdlet
+            cmdlet.AccountName = accountName;
+            cmdlet.ResourceGroupName = resourceGroup;
+            cmdlet.Location = location;
+            cmdlet.PoolAllocationMode = allocationMode;
+            cmdlet.KeyVaultId = keyVaultId;
+            cmdlet.KeyVaultUrl = keyVaultUrl;
             cmdlet.ExecuteCmdlet();
 
-            commandRuntimeMock.Verify(r => r.WriteObject(expected), Times.Once());
+            // Verify the fake response was written to the pipeline and that the captured account create
+            // parameters matched expectations.
+            commandRuntimeMock.Verify(r => r.WriteObject(fakeResponse), Times.Once());
+            Assert.Equal(accountName, actualCreateParameters.BatchAccount);
+            Assert.Equal(resourceGroup, actualCreateParameters.ResourceGroup);
+            Assert.Equal(location, actualCreateParameters.Location);
+            Assert.Equal(allocationMode, actualCreateParameters.PoolAllocationMode);
+            Assert.Equal(keyVaultId, actualCreateParameters.KeyVaultId);
+            Assert.Equal(keyVaultUrl, actualCreateParameters.KeyVaultUrl);
         }
     }
 }

src/ResourceManager/AzureBatch/Commands.Batch.Test/BatchAccounts/SetBatchAccountCommandTests.cs

@@ -54,7 +54,7 @@ public void UpdateAccountTest()
                     {"Value", "tagValue"}
                 };
 
-            BatchAccount accountResource = BatchTestHelpers.CreateAccountResource(accountName, resourceGroup, tags);
+            BatchAccount accountResource = BatchTestHelpers.CreateAccountResource(accountName, resourceGroup, tags: tags);
             BatchAccountContext expected = BatchAccountContext.ConvertAccountResourceToNewAccountContext(accountResource, null);
             batchClientMock.Setup(b => b.UpdateAccount(resourceGroup, accountName, tags, storageId)).Returns(expected);
 

src/ResourceManager/AzureBatch/Commands.Batch.Test/BatchTestHelpers.cs

@@ -46,7 +46,8 @@ public static class BatchTestHelpers
         /// <summary>
         /// Builds an AccountResource object using the specified parameters
         /// </summary>
-        public static BatchAccount CreateAccountResource(string accountName, string resourceGroupName, Hashtable tags = null, string storageId = null)
+        public static BatchAccount CreateAccountResource(string accountName, string resourceGroupName, string location = "location", 
+            Hashtable tags = null, string storageId = null)
         {
             string tenantUrlEnding = "batch-test.windows-int.net";
             string endpoint = string.Format("{0}.{1}", accountName, tenantUrlEnding);
@@ -61,17 +62,11 @@ public static BatchAccount CreateAccountResource(string accountName, string reso
                 activeJobAndJobScheduleQuota: DefaultQuotaCount,
                 accountEndpoint: endpoint,
                 id: id,
-                type: "type")
-            {
-                Location = "location",
-                ProvisioningState = ProvisioningState.Succeeded,
-                AutoStorage = new AutoStorageProperties() { StorageAccountId = storageId }
-            };
-
-            if (tags != null)
-            {
-                resource.Tags = TagsConversionHelper.CreateTagDictionary(tags, true);
-            }
+                type: "type",
+                location: location,
+                provisioningState: ProvisioningState.Succeeded,
+                autoStorage: new AutoStorageProperties() { StorageAccountId = storageId },
+                tags: tags == null ? null : TagsConversionHelper.CreateTagDictionary(tags, true));
 
             return resource;
         }
@@ -259,10 +254,10 @@ public static RequestInterceptor CreateFakeGetFileAndPropertiesFromTaskResponseI
 
                     propRequest.ServiceRequestFunc = (cancellationToken) =>
                     {
-                        var response = new AzureOperationHeaderResponse<ProxyModels.FileGetNodeFilePropertiesFromTaskHeaders>();
-                        response.Headers = new ProxyModels.FileGetNodeFilePropertiesFromTaskHeaders();
+                        var response = new AzureOperationHeaderResponse<ProxyModels.FileGetPropertiesFromTaskHeaders>();
+                        response.Headers = new ProxyModels.FileGetPropertiesFromTaskHeaders();
 
-                        Task<AzureOperationHeaderResponse<ProxyModels.FileGetNodeFilePropertiesFromTaskHeaders>> task = Task.FromResult(response);
+                        Task<AzureOperationHeaderResponse<ProxyModels.FileGetPropertiesFromTaskHeaders>> task = Task.FromResult(response);
 
                         return task;
                     };
@@ -301,10 +296,10 @@ public static RequestInterceptor CreateFakeGetFileAndPropertiesFromComputeNodeRe
 
                     propRequest.ServiceRequestFunc = (cancellationToken) =>
                     {
-                        var response = new AzureOperationHeaderResponse<ProxyModels.FileGetNodeFilePropertiesFromComputeNodeHeaders>();
-                        response.Headers = new ProxyModels.FileGetNodeFilePropertiesFromComputeNodeHeaders();
+                        var response = new AzureOperationHeaderResponse<ProxyModels.FileGetPropertiesFromComputeNodeHeaders>();
+                        response.Headers = new ProxyModels.FileGetPropertiesFromComputeNodeHeaders();
 
-                        Task<AzureOperationHeaderResponse<ProxyModels.FileGetNodeFilePropertiesFromComputeNodeHeaders>> task = Task.FromResult(response);
+                        Task<AzureOperationHeaderResponse<ProxyModels.FileGetPropertiesFromComputeNodeHeaders>> task = Task.FromResult(response);
 
                         return task;
                     };
@@ -406,7 +401,7 @@ public static RequestInterceptor ExamineRequestInterceptor<T>(Action<T> assertAc
         /// <summary>
         /// Builds a CloudPoolUsageMetricsResponse object. Note: The lengths of all three lists must be the same.
         /// </summary>
-        public static AzureOperationResponse<IPage<ProxyModels.PoolUsageMetrics>, ProxyModels.PoolListPoolUsageMetricsHeaders> CreatePoolListUsageMetricsResponse(
+        public static AzureOperationResponse<IPage<ProxyModels.PoolUsageMetrics>, ProxyModels.PoolListUsageMetricsHeaders> CreatePoolListUsageMetricsResponse(
             IEnumerable<string> poolIds,
             IEnumerable<DateTime> startTimes,
             IEnumerable<DateTime> endTimes)
@@ -435,7 +430,7 @@ public static RequestInterceptor ExamineRequestInterceptor<T>(Action<T> assertAc
             }
 
             var response = new AzureOperationResponse
-                <IPage<ProxyModels.PoolUsageMetrics>, ProxyModels.PoolListPoolUsageMetricsHeaders>()
+                <IPage<ProxyModels.PoolUsageMetrics>, ProxyModels.PoolListUsageMetricsHeaders>()
             {
                 Response = new HttpResponseMessage(HttpStatusCode.OK),
                 Body = new MockPagedEnumerable<ProxyModels.PoolUsageMetrics>(poolUsageList)
@@ -447,7 +442,7 @@ public static RequestInterceptor ExamineRequestInterceptor<T>(Action<T> assertAc
         /// <summary>
         /// Builds a CloudPoolStatisticsResponse object. Note: Using avgCPUPercentage and startTime for validating if the pipeline return the correct values
         /// </summary>
-        public static AzureOperationResponse<ProxyModels.PoolStatistics, ProxyModels.PoolGetAllPoolsLifetimeStatisticsHeaders> CreatePoolStatisticsResponse(
+        public static AzureOperationResponse<ProxyModels.PoolStatistics, ProxyModels.PoolGetAllLifetimeStatisticsHeaders> CreatePoolStatisticsResponse(
             double avgCPUPercentage,
             DateTime startTime)
         {
@@ -458,7 +453,7 @@ public static RequestInterceptor ExamineRequestInterceptor<T>(Action<T> assertAc
             };
 
             var response = new AzureOperationResponse
-                <ProxyModels.PoolStatistics, ProxyModels.PoolGetAllPoolsLifetimeStatisticsHeaders>()
+                <ProxyModels.PoolStatistics, ProxyModels.PoolGetAllLifetimeStatisticsHeaders>()
             {
                 Body = stats,
                 Response = new HttpResponseMessage(HttpStatusCode.Accepted)
@@ -470,15 +465,15 @@ public static RequestInterceptor ExamineRequestInterceptor<T>(Action<T> assertAc
         /// <summary>
         /// Builds a CloudJobStatisticsResponse object.Note: Using startTime for validating if the pipeline return the correct values
         /// </summary>
-        public static AzureOperationResponse<ProxyModels.JobStatistics, ProxyModels.JobGetAllJobsLifetimeStatisticsHeaders> CreateJobStatisticsResponse(DateTime startTime)
+        public static AzureOperationResponse<ProxyModels.JobStatistics, ProxyModels.JobGetAllLifetimeStatisticsHeaders> CreateJobStatisticsResponse(DateTime startTime)
         {
             var stats = new ProxyModels.JobStatistics()
             {
                 StartTime = startTime
             };
 
             var response = new AzureOperationResponse
-                <ProxyModels.JobStatistics, ProxyModels.JobGetAllJobsLifetimeStatisticsHeaders>()
+                <ProxyModels.JobStatistics, ProxyModels.JobGetAllLifetimeStatisticsHeaders>()
             {
                 Body = stats,
                 Response = new HttpResponseMessage(HttpStatusCode.Accepted)
@@ -794,22 +789,22 @@ public static AzureOperationResponse<
         /// <summary>
         /// Builds a NodeFileGetPropertiesFromTaskResponse object
         /// </summary>
-        public static AzureOperationHeaderResponse<ProxyModels.FileGetNodeFilePropertiesFromTaskHeaders> CreateNodeFileGetPropertiesByTaskResponse()
+        public static AzureOperationHeaderResponse<ProxyModels.FileGetPropertiesFromTaskHeaders> CreateNodeFileGetPropertiesByTaskResponse()
         {
-            var response = new AzureOperationHeaderResponse<ProxyModels.FileGetNodeFilePropertiesFromTaskHeaders>();
+            var response = new AzureOperationHeaderResponse<ProxyModels.FileGetPropertiesFromTaskHeaders>();
             response.Response = new HttpResponseMessage(HttpStatusCode.OK);
-            response.Headers = new ProxyModels.FileGetNodeFilePropertiesFromTaskHeaders();
+            response.Headers = new ProxyModels.FileGetPropertiesFromTaskHeaders();
             return response;
         }
 
         /// <summary>
         /// Builds a NodeFileGetPropertiesFromComputeNodeResponse object
         /// </summary>
-        public static AzureOperationHeaderResponse<ProxyModels.FileGetNodeFilePropertiesFromComputeNodeHeaders> CreateNodeFileGetPropertiesByComputeNodeResponse()
+        public static AzureOperationHeaderResponse<ProxyModels.FileGetPropertiesFromComputeNodeHeaders> CreateNodeFileGetPropertiesByComputeNodeResponse()
         {
-            var response = new AzureOperationHeaderResponse<ProxyModels.FileGetNodeFilePropertiesFromComputeNodeHeaders>();
+            var response = new AzureOperationHeaderResponse<ProxyModels.FileGetPropertiesFromComputeNodeHeaders>();
             response.Response = new HttpResponseMessage(HttpStatusCode.OK);
-            response.Headers = new ProxyModels.FileGetNodeFilePropertiesFromComputeNodeHeaders();
+            response.Headers = new ProxyModels.FileGetPropertiesFromComputeNodeHeaders();
             return response;
         }