inital checkin

Author: wiboris

sdk/batch/Azure.Compute.Batch/CHANGELOG.md

@@ -1,14 +1,12 @@
 # Release History
 
-## 1.0.0-beta.3 (Unreleased)
-
-### Features Added
-
-### Breaking Changes
-
-### Bugs Fixed
+## 1.0.0 (2025-03-27)
+ 
+ This release is the first stable release of the Azure Compute Batch client library.
 
 ### Other Changes
+ 
+ Documenation updates.
 
 ## 1.0.0-beta.2 (2025-02-28)
 
@@ -26,8 +24,8 @@
   - Added `containerHostBatchBindMounts` of type `List<ContainerHostBatchBindMountEntry>` to `BatchTaskContainerSettings`.
 
 - Patch improvements for pool and job:
-  - Added `displayName`, `vmSize`, `taskSlotsPerNode`, `taskSchedulingPolicy`, `enableInterNodeCommunication`, `virtualMachineConfiguration`, `networkConfiguration`, `userAccounts`, `mountConfiguration`, `upgradePolicy`, and `resourceTags` to `BatchPoolUpdateContent`.
-  - Added `networkConfiguration` to `BatchJobUpdateContent`.
+  - Added `displayName`, `vmSize`, `taskSlotsPerNode`, `taskSchedulingPolicy`, `enableInterNodeCommunication`, `virtualMachineConfiguration`, `networkConfiguration`, `userAccounts`, `mountConfiguration`, `upgradePolicy`, and `resourceTags` to `BatchPoolUpdateOptions`.
+  - Added `networkConfiguration` to `BatchJobUpdateOptions`.
 
 - Confidential VM support:
   - Added `confidentialVM` to `SecurityTypes`.

sdk/batch/Azure.Compute.Batch/MigrationGuide.md

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "net",
   "TagPrefix": "net/batch/Azure.Compute.Batch",
-  "Tag": "net/batch/Azure.Compute.Batch_40246b7ff5"
+  "Tag": "net/batch/Azure.Compute.Batch_dcf3a3e145"
 }

sdk/batch/Azure.Compute.Batch/README.md

@@ -13,4 +13,4 @@ description: Samples for the Azure.Compute.Batch client library
 Before starting, take a look at the Azure Batch [README](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/batch/Azure.Compute.Batch/README.md) for more information on how to create an Batch Account using the Azure portal/Azure CLI, and retrieving the designated endpoint and credential.
 
 - [Creating a Pool, Job, and Task](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/batch/Azure.Compute.Batch/samples/Sample1_CreatePool_Job_Task.md)
-- [Creating multiple Task](https://github.com/Azure/azure-sdk-for-net/blob/50a965255278aa2ca604daef81e26632f5b668f3/sdk/batch/Azure.Compute.Batch/samples/Sample2_Creating_Multiple_Tasks.md)
+- [Creating multiple Task](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/batch/Azure.Compute.Batch/samples/Sample2_Creating_Multiple_Tasks.md)

sdk/batch/Azure.Compute.Batch/api/Azure.Compute.Batch.net8.0.cs

@@ -28,7 +28,7 @@ With the BatchAccountResource you can create a pool with the [batchAccount.GetBa
 
 ```C# Snippet:Batch_Sample01_PoolCreation
 var poolName = "HelloWorldPool";
-var imageReference = new BatchImageReference()
+var imageReference = new Azure.ResourceManager.Batch.Models.BatchImageReference()
 {
     Publisher = "canonical",
     Offer = "0001-com-ubuntu-server-jammy",
@@ -71,14 +71,14 @@ new Uri("https://examplebatchaccount.eastus.batch.azure.com"), credential);
 Before we can create Batch Tasks, we first need to create a Job for the tasks to be associatd with, this can be done via the `CreateJobAsync` command. The basic elements needed are an id for job itself and the name of the pool that this job will run against. 
 
 ```C# Snippet:Batch_Sample01_CreateBatchJob
-await batchClient.CreateJobAsync(new BatchJobCreateContent("jobId", new BatchPoolInfo() { PoolId = "poolName" }));
+await batchClient.CreateJobAsync(new BatchJobCreateOptions("jobId", new BatchPoolInfo() { PoolId = "poolName" }));
 ```
 
 ### Task creation
 
 Batch tasks can be created from the BatchClient via the `CreateTaskAsync`.  The basic elements needed are the name of the job the task will be assigned to, and id for the task itself, and a command to run.
 ```C# Snippet:Batch_Sample01_CreateBatchTask
-await batchClient.CreateTaskAsync("jobId", new BatchTaskCreateContent("taskId", $"echo Hello world"));
+await batchClient.CreateTaskAsync("jobId", new BatchTaskCreateOptions("taskId", $"echo Hello world"));
 ```
 
 

sdk/batch/Azure.Compute.Batch/api/Azure.Compute.Batch.netstandard2.0.cs

@@ -28,7 +28,7 @@ With the BatchAccountResource you can create a pool with the [batchAccount.GetBa
 
 ```C# Snippet:Batch_Sample02_PoolCreation
 var poolName = "HelloWorldPool";
-var imageReference = new BatchImageReference()
+var imageReference = new Azure.ResourceManager.Batch.Models.BatchImageReference()
 {
     Publisher = "canonical",
     Offer = "0001-com-ubuntu-server-jammy",
@@ -71,7 +71,7 @@ new Uri("https://examplebatchaccount.eastus.batch.azure.com"), credential);
 Before we can create Batch Tasks, we first need to create a Job for the tasks to be associatd with, this can be done via the `CreateJobAsync` command. The basic elements needed are an id for job itself and the name of the pool that this job will run against. 
 
 ```C# Snippet:Batch_Sample02_CreateBatchJob
-await batchClient.CreateJobAsync(new BatchJobCreateContent("jobId", new BatchPoolInfo() { PoolId = "poolName" }));
+await batchClient.CreateJobAsync(new BatchJobCreateOptions("jobId", new BatchPoolInfo() { PoolId = "poolName" }));
 ```
 
 ### Task creation
@@ -107,27 +107,27 @@ In the following code example a list of 1000 tasks are created of type `BatchTas
 
 ```C# Snippet:Batch_Sample02_CreateTasks_Default
 int tasksCount = 1000;
-List<BatchTaskCreateContent> tasks = new List<BatchTaskCreateContent>();
+List<BatchTaskCreateOptions> tasks = new List<BatchTaskCreateOptions>();
 for (int i = 0; i < tasksCount; i++)
 {
-    tasks.Add(new BatchTaskCreateContent($"task{i}", "cmd /c echo Hello World"));
+    tasks.Add(new BatchTaskCreateOptions($"task{i}", "cmd /c echo Hello World"));
 }
 
 // Create 1000 tasks in a single request using the default settings
 CreateTasksResult result = await batchClient.CreateTasksAsync("jobId", tasks);
 
 // Print the results
-Console.WriteLine("{0} Tasks Passed, {1} Failed.", result.Pass, result.Fail);
+Console.WriteLine("{0} Tasks Passed, {1} Failed.", result.PassCount, result.FailCount);
 ```
 
 By default `CreateTasksResult` will only contain a count of the Pass/Fail results but if you want the list of the `BatchTaskAddResult` results returned by the service you can pass in a CreateTasksOptions to the AddTasks method with the field ReturnBatchTaskAddResults set to true.  This is disabled by default because the size of the list scales with the number of requests so memory constrants could be a factor.
 
 ```C# Snippet:Batch_Sample02_CreateTasks_ReturnBatchTaskAddResults
 int tasksCount = 1000;
-List<BatchTaskCreateContent> tasks = new List<BatchTaskCreateContent>();
+List<BatchTaskCreateOptions> tasks = new List<BatchTaskCreateOptions>();
 for (int i = 0; i < tasksCount; i++)
 {
-    tasks.Add(new BatchTaskCreateContent($"task{i}", "cmd /c echo Hello World"));
+    tasks.Add(new BatchTaskCreateOptions($"task{i}", "cmd /c echo Hello World"));
 }
 
 // Create a CreateTaskOptions object with custom settings for the BatchTaskAddResults to be returned.
@@ -136,7 +136,7 @@ CreateTasksOptions createTaskOptions = new CreateTasksOptions(returnBatchTaskAdd
 // Create 1000 tasks in a single request over 10 parallel requests
 CreateTasksResult result = await batchClient.CreateTasksAsync("jobId", tasks, createTaskOptions);
 
-foreach (BatchTaskAddResult t in result.BatchTaskAddResults)
+foreach (BatchTaskCreateResult t in result.BatchTaskCreateResults)
 {
     Console.WriteLine("Task {0} created with status {1}. ",
         t.TaskId, t.Status);
@@ -147,23 +147,23 @@ Alternatively you can call `CreateTasks()` with an instance of `CreateTasksOptio
 
 ```C# Snippet:Batch_Sample02_CreateTasks_ParallelOptions
 int tasksCount = 1000;
-List<BatchTaskCreateContent> tasks = new List<BatchTaskCreateContent>();
+List<BatchTaskCreateOptions> tasks = new List<BatchTaskCreateOptions>();
 for (int i = 0; i < tasksCount; i++)
 {
-    tasks.Add(new BatchTaskCreateContent($"task{i}", "cmd /c echo Hello World"));
+    tasks.Add(new BatchTaskCreateOptions($"task{i}", "cmd /c echo Hello World"));
 }
 
 // Create a CreateTaskOptions object with custom settings for parallelism
 CreateTasksOptions createTaskOptions = new CreateTasksOptions()
 {
     MaxDegreeOfParallelism = 10,
-    ReturnBatchTaskAddResults = true
+    ReturnBatchTaskCreateResults = true
 };
 
 // Create 1000 tasks in a single request over 10 parallel requests
 CreateTasksResult result = await batchClient.CreateTasksAsync("jobId", tasks, createTaskOptions);
 
-foreach (BatchTaskAddResult t in result.BatchTaskAddResults)
+foreach (BatchTaskCreateResult t in result.BatchTaskCreateResults)
 {
     Console.WriteLine("Task {0} created with status  {1}. ",
         t.TaskId, t.Status);
@@ -174,10 +174,10 @@ Addiontally you can call `CreateTasks()` with an instance of `CreateTasksOptions
 
 ```C# Snippet:Batch_Sample02_CreateTasks_MaxTimeBetweenCallsInSeconds
 int tasksCount = 1000;
-List<BatchTaskCreateContent> tasks = new List<BatchTaskCreateContent>();
+List<BatchTaskCreateOptions> tasks = new List<BatchTaskCreateOptions>();
 for (int i = 0; i < tasksCount; i++)
 {
-    tasks.Add(new BatchTaskCreateContent($"task{i}", "cmd /c echo Hello World"));
+    tasks.Add(new BatchTaskCreateOptions($"task{i}", "cmd /c echo Hello World"));
 }
 
 // Create a CreateTaskOptions object with custom settings for
@@ -187,13 +187,13 @@ CreateTasksOptions createTaskOptions = new CreateTasksOptions()
 {
     MaxDegreeOfParallelism = 10,
     MaxTimeBetweenCallsInSeconds = 60,
-    ReturnBatchTaskAddResults = true
+    ReturnBatchTaskCreateResults = true
 };
 
 // Create 1000 tasks in a single request over 10 parallel requests
 CreateTasksResult result = await batchClient.CreateTasksAsync("jobId", tasks, createTaskOptions);
 
-foreach (BatchTaskAddResult t in result.BatchTaskAddResults)
+foreach (BatchTaskCreateResult t in result.BatchTaskCreateResults)
 {
     Console.WriteLine("Task {0} created with status  {1}. ",
         t.TaskId, t.Status);
@@ -204,10 +204,10 @@ Addtional parameters to the `CreateTasks()` method can be set such as `timeOutIn
 
 ```C# Snippet:Batch_Sample02_CreateTasks_Non_Default
 int tasksCount = 1000;
-List<BatchTaskCreateContent> tasks = new List<BatchTaskCreateContent>();
+List<BatchTaskCreateOptions> tasks = new List<BatchTaskCreateOptions>();
 for (int i = 0; i < tasksCount; i++)
 {
-    tasks.Add(new BatchTaskCreateContent($"task{i}", "cmd /c echo Hello World"));
+    tasks.Add(new BatchTaskCreateOptions($"task{i}", "cmd /c echo Hello World"));
 }
 
 // Create a CancellationTokenSource object to cancel the operation if need be
@@ -218,7 +218,7 @@ var cts = new CancellationTokenSource();
 CreateTasksOptions createTaskOptions = new CreateTasksOptions()
 {
     MaxDegreeOfParallelism = 10,
-    ReturnBatchTaskAddResults = true
+    ReturnBatchTaskCreateResults = true
 };
 
 try
@@ -234,7 +234,7 @@ try
         );
 
     // Print the results
-    Console.WriteLine("{0} Tasks Passed, {1} Failed.", result.Pass, result.Fail);
+    Console.WriteLine("{0} Tasks Passed, {1} Failed.", result.PassCount, result.FailCount);
 }
 catch (ParallelOperationsException)
 {
@@ -254,7 +254,7 @@ Here's and example of a custom implmentation of `ICreateTaskResultHandler`
 /// <summary>
 ///  Custom TaskCollectionResultHandler to handle the result of a CreateTasksAsync operation.
 /// </summary>
-private class CustomTaskCollectionResultHandler : ICreateTaskResultHandler
+private class CustomTaskCollectionResultHandler : TaskResultHandler
 {
     /// <summary>
     /// This handler treats and result without errors as Success, 'TaskExists' errors as failures, retries server errors (HTTP 5xx),
@@ -265,7 +265,7 @@ private class CustomTaskCollectionResultHandler : ICreateTaskResultHandler
     /// <param name="cancellationToken">The cancellation token associated with the AddTaskCollection operation.</param>
     /// <returns>An <see cref="CreateTaskResultStatus"/> which indicates whether the <paramref name="addTaskResult"/>
     /// is classified as a success or as requiring a retry.</returns>
-    public CreateTaskResultStatus CreateTaskResultHandler(CreateTaskResult addTaskResult, CancellationToken cancellationToken)
+    public override CreateTaskResultStatus CreateTaskResultHandler(CreateTaskResult addTaskResult, CancellationToken cancellationToken)
     {
         if (addTaskResult == null)
         {
@@ -280,7 +280,7 @@ private class CustomTaskCollectionResultHandler : ICreateTaskResultHandler
             {
                 status = CreateTaskResultStatus.Retry;
             }
-            else if (addTaskResult.BatchTaskResult.Status == BatchTaskAddStatus.ClientError && addTaskResult.BatchTaskResult.Error.Code == BatchErrorCodeStrings.TaskExists)
+            else if (addTaskResult.BatchTaskResult.Status == BatchTaskAddStatus.ClientError && addTaskResult.BatchTaskResult.Error.Code == BatchErrorCode.TaskExists)
             {
                 status = CreateTaskResultStatus.Failure; //TaskExists mark as failure
             }
@@ -297,24 +297,24 @@ Here is an example of the custom CreateTaskResultHandler being used.
 
 ```C# Snippet:Batch_Sample02_CreateTasks_Custom_TaskCollectionResultHandler
 int tasksCount = 1000;
-List<BatchTaskCreateContent> tasks = new List<BatchTaskCreateContent>();
+List<BatchTaskCreateOptions> tasks = new List<BatchTaskCreateOptions>();
 for (int i = 0; i < tasksCount; i++)
 {
-    tasks.Add(new BatchTaskCreateContent($"task{i}", "cmd /c echo Hello World"));
+    tasks.Add(new BatchTaskCreateOptions($"task{i}", "cmd /c echo Hello World"));
 }
 
 // Create a CreateTaskOptions object with a custom CreateTaskResultHandler
 CreateTasksOptions createTaskOptions = new CreateTasksOptions()
 {
     CreateTaskResultHandler = new CustomTaskCollectionResultHandler(),
-    ReturnBatchTaskAddResults = true
+    ReturnBatchTaskCreateResults = true
 };
 
 // Create 1000 tasks in a single request using the default settings
 CreateTasksResult result = await batchClient.CreateTasksAsync("jobId", tasks, createTaskOptions);
 
 // Print the status of each task creation
-foreach (BatchTaskAddResult t in result.BatchTaskAddResults)
+foreach (BatchTaskCreateResult t in result.BatchTaskCreateResults)
 {
     Console.WriteLine("Task {0} created with status  {1}. ",
         t.TaskId, t.Status);

sdk/batch/Azure.Compute.Batch/assets.json

@@ -2,7 +2,7 @@
   <PropertyGroup>
     <Description>This is the Azure.Compute.Batch client library, enabling the creation and management of Batch objects such as Pools, Jobs, and Tasks. For more information about Azure Batch, see https://learn.microsoft.com/azure/batch/batch-technical-overview </Description>
     <AssemblyTitle>The Azure Batch client library</AssemblyTitle>
-    <Version>1.0.0-beta.3</Version>
+    <Version>1.0.0</Version>
     <PackageTags>Azure.Compute.Batch</PackageTags>
     <TargetFrameworks>$(RequiredTargetFrameworks)</TargetFrameworks>
     <IncludeOperationsSharedSource>true</IncludeOperationsSharedSource>