diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch.ProtocolTests/Azure.Batch.ProtocolTests.csproj b/src/SDKs/Batch/DataPlane/Azure.Batch.ProtocolTests/Azure.Batch.ProtocolTests.csproj index dc4eadb9621c..14ec1f4ed182 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch.ProtocolTests/Azure.Batch.ProtocolTests.csproj +++ b/src/SDKs/Batch/DataPlane/Azure.Batch.ProtocolTests/Azure.Batch.ProtocolTests.csproj @@ -20,8 +20,8 @@ - - + + diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch.Unit.Tests/Azure.Batch.Unit.Tests.csproj b/src/SDKs/Batch/DataPlane/Azure.Batch.Unit.Tests/Azure.Batch.Unit.Tests.csproj index 0e40fe65f98b..82d755f35cb4 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch.Unit.Tests/Azure.Batch.Unit.Tests.csproj +++ b/src/SDKs/Batch/DataPlane/Azure.Batch.Unit.Tests/Azure.Batch.Unit.Tests.csproj @@ -31,8 +31,8 @@ - - + + diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch.Unit.Tests/HttpClientBehaviorTests.cs b/src/SDKs/Batch/DataPlane/Azure.Batch.Unit.Tests/HttpClientBehaviorTests.cs index edace3741334..ce450a5925d2 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch.Unit.Tests/HttpClientBehaviorTests.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch.Unit.Tests/HttpClientBehaviorTests.cs @@ -46,7 +46,7 @@ public async Task HttpClient_IncludesContentLengthHeaderOnExpectedHttpVerbs(Http } } - private static IEnumerable HttpMethods() + public static IEnumerable HttpMethods() { yield return new[] { HttpMethod.Delete }; yield return new[] { HttpMethod.Post }; diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/AssemblyAttributes.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/AssemblyAttributes.cs index f829a03f40a3..20e88fe49265 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/AssemblyAttributes.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/AssemblyAttributes.cs @@ -10,10 +10,9 @@ [assembly: AssemblyDescription("Client library for interacting with the Azure Batch service.")] [assembly: AssemblyVersion("8.0.0.0")] -[assembly: AssemblyFileVersion("8.1.0.0")] +[assembly: AssemblyFileVersion("8.1.1.0")] [assembly: AssemblyCompany("Microsoft Corporation")] [assembly: AssemblyProduct("Microsoft Azure")] -[assembly: AssemblyCopyright("Copyright (c) Microsoft Corporation. All rights reserved.")] [assembly: CLSCompliant(false)] [assembly: ComVisible(false)] diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/Azure.Batch.csproj b/src/SDKs/Batch/DataPlane/Azure.Batch/Azure.Batch.csproj index 6879029282e5..b95ba717942f 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/Azure.Batch.csproj +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/Azure.Batch.csproj @@ -10,7 +10,7 @@ false Azure.Batch This client library provides access to the Microsoft Azure Batch service. - 8.1.0 + 8.1.1 $(DefineConstants);CODESIGN true Microsoft.Azure.Batch diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/CloudJob.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/CloudJob.cs index 482d8ae8ef11..3f276c9c401c 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/CloudJob.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/CloudJob.cs @@ -422,7 +422,8 @@ public DateTime? StateTransitionTime /// /// /// This property is populated only if the was retrieved with an - /// including the 'stats' attribute; otherwise it is null. + /// including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch + /// service performs periodic roll-up of statistics. The typical delay is about 30 minutes. /// public JobStatistics Statistics { diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/CloudJobSchedule.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/CloudJobSchedule.cs index 6a909f9824cb..273e289d1253 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/CloudJobSchedule.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/CloudJobSchedule.cs @@ -300,7 +300,8 @@ public DateTime? StateTransitionTime /// /// /// This property is populated only if the was retrieved with an - /// including the 'stats' attribute; otherwise it is null. + /// including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch + /// service performs periodic roll-up of statistics. The typical delay is about 30 minutes. /// public JobScheduleStatistics Statistics { diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/CloudPool.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/CloudPool.cs index b7a450fd15aa..d01b33920459 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/CloudPool.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/CloudPool.cs @@ -560,7 +560,8 @@ public DateTime? StateTransitionTime /// /// /// This property is populated only if the was retrieved with an - /// including the 'stats' attribute; otherwise it is null. + /// including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch + /// service performs periodic roll-up of statistics. The typical delay is about 30 minutes. /// public PoolStatistics Statistics { diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/CloudTask.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/CloudTask.cs index 590d9615e697..382ad0d4e3ec 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/CloudTask.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/CloudTask.cs @@ -21,6 +21,15 @@ namespace Microsoft.Azure.Batch /// /// An Azure Batch task. A task is a piece of work that is associated with a job and runs on a compute node. /// + /// + /// Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations + /// include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to + /// host failure. Retries due to recovery operations are independent of and are not counted against the . Even if the is 0, an internal retry due to a recovery operation + /// may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and + /// restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some + /// form of checkpointing. + /// public partial class CloudTask : ITransportObjectProvider, IInheritedBehaviors, IPropertyMetadata { private class PropertyContainer : PropertyCollection @@ -285,7 +294,9 @@ public AuthenticationTokenSettings AuthenticationTokenSettings /// /// The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment /// variable expansion. If you want to take advantage of such features, you should invoke the shell in the command - /// line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. + /// line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command + /// line refers to file paths, it should use a relative path (relative to the task working directory), or use the + /// Batch provided environment variables (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). /// public string CommandLine { diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/JobManagerTask.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/JobManagerTask.cs index b7cc52c2e817..b9edeb6a92db 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/JobManagerTask.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/JobManagerTask.cs @@ -18,8 +18,17 @@ namespace Microsoft.Azure.Batch using System.Linq; /// - /// Represents an Azure Batch JobManager task. + /// Represents an Azure Batch JobManager task. /// + /// + /// Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations + /// include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to + /// host failure. Retries due to recovery operations are independent of and are not counted against the . Even if the is 0, an internal retry due to a recovery operation + /// may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and + /// restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some + /// form of checkpointing. + /// public partial class JobManagerTask : ITransportObjectProvider, IPropertyMetadata { private class PropertyContainer : PropertyCollection @@ -147,7 +156,7 @@ internal JobManagerTask(Models.JobManagerTask protocolObject) /// /// Gets or sets whether the Job Manager task may run on a low-priority compute node. If omitted, the default is - /// false. + /// true. /// public bool? AllowLowPriorityNode { @@ -190,7 +199,9 @@ public AuthenticationTokenSettings AuthenticationTokenSettings /// /// The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment /// variable expansion. If you want to take advantage of such features, you should invoke the shell in the command - /// line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. + /// line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line + /// refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch + /// provided environment variables (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). /// public string CommandLine { diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/JobPreparationTask.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/JobPreparationTask.cs index 67b5f10c3e84..5d65f7ed05ab 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/JobPreparationTask.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/JobPreparationTask.cs @@ -20,6 +20,15 @@ namespace Microsoft.Azure.Batch /// /// A Job Preparation task to run before any tasks of the job on any given compute node. /// + /// + /// Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations + /// include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to + /// host failure. Retries due to recovery operations are independent of and are not counted against the . Even if the is 0, an internal retry due to a recovery operation + /// may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and + /// restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some + /// form of checkpointing. + /// public partial class JobPreparationTask : ITransportObjectProvider, IPropertyMetadata { private class PropertyContainer : PropertyCollection @@ -118,7 +127,9 @@ internal JobPreparationTask(Models.JobPreparationTask protocolObject) /// /// The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment /// variable expansion. If you want to take advantage of such features, you should invoke the shell in the command - /// line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. + /// line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line + /// refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch + /// provided environment variables (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). /// public string CommandLine { diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/JobReleaseTask.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/JobReleaseTask.cs index 430438d5ff1a..00bfd11a9784 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/JobReleaseTask.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/JobReleaseTask.cs @@ -112,7 +112,9 @@ internal JobReleaseTask(Models.JobReleaseTask protocolObject) /// /// The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment /// variable expansion. If you want to take advantage of such features, you should invoke the shell in the command - /// line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. + /// line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line + /// refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch + /// provided environment variables (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). /// public string CommandLine { diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/NodeCounts.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/NodeCounts.cs index 1117be299f45..9ffe2faee18c 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/NodeCounts.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/NodeCounts.cs @@ -28,6 +28,7 @@ internal NodeCounts(Models.NodeCounts protocolObject) { this.Creating = protocolObject.Creating; this.Idle = protocolObject.Idle; + this.LeavingPool = protocolObject.LeavingPool; this.Offline = protocolObject.Offline; this.Preempted = protocolObject.Preempted; this.Rebooting = protocolObject.Rebooting; @@ -55,6 +56,11 @@ internal NodeCounts(Models.NodeCounts protocolObject) /// public int Idle { get; } + /// + /// Gets the number of nodes in . + /// + public int LeavingPool { get; } + /// /// Gets the number of nodes in . /// diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/StartTask.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/StartTask.cs index b5229af772d6..ee6c8aae561e 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/StartTask.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/StartTask.cs @@ -21,6 +21,15 @@ namespace Microsoft.Azure.Batch /// A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted /// or reimaged. /// + /// + /// Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations + /// include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to + /// host failure. Retries due to recovery operations are independent of and are not counted against the . Even if the is 0, an internal retry due to a recovery operation + /// may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and + /// restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some + /// form of checkpointing. + /// public partial class StartTask : ITransportObjectProvider, IPropertyMetadata { private class PropertyContainer : PropertyCollection @@ -107,7 +116,9 @@ internal StartTask(Models.StartTask protocolObject) /// /// The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment /// variable expansion. If you want to take advantage of such features, you should invoke the shell in the command - /// line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. + /// line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line + /// refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch + /// provided environment variables (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). /// public string CommandLine { diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/TaskConstraints.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/TaskConstraints.cs index 4ae7aca2a1a3..c387f1bceab4 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/TaskConstraints.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/TaskConstraints.cs @@ -86,6 +86,14 @@ internal TaskConstraints(Models.TaskConstraints protocolObject) /// /// Gets or sets the maximum number of retries for the task. /// + /// + /// Note that this value specifically controls the number of retries for the task executable due to a nonzero exit + /// code. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum + /// retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count + /// is 0, the Batch service does not retry the task after the first attempt. If the maximum retry count is -1, the + /// Batch service retries the task without limit. Resource files and application packages are only downloaded again + /// if the task is retried on a new compute node. + /// public int? MaxTaskRetryCount { get { return this.propertyContainer.MaxTaskRetryCountProperty.Value; } diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/UserIdentity.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/UserIdentity.cs index d4bb1faccadd..7562e461ba3e 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/UserIdentity.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/Generated/UserIdentity.cs @@ -18,7 +18,9 @@ namespace Microsoft.Azure.Batch using System.Linq; /// - /// The definition of the user identity under which the task is run. + /// The definition of the user identity under which the task is run. On CloudServiceConfiguration pools, this user is + /// logged in with the INTERACTIVE flag. On Windows VirtualMachineConfiguration pools, this user is logged in with the + /// BATCH flag. /// public partial class UserIdentity : ITransportObjectProvider, IPropertyMetadata { diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/IJobOperations.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/IJobOperations.cs index 5562dd7575b0..067987d9bc94 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/IJobOperations.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/IJobOperations.cs @@ -30,7 +30,9 @@ public partial interface IJobOperations /// /// Statistics are aggregated across all jobs that have ever existed in /// the account, from account creation to the last update time of the - /// statistics. + /// statistics. The statistics may not be immediately available. The + /// Batch service performs periodic roll-up of statistics. The typical + /// delay is about 30 minutes. /// /// /// Additional parameters for the operation @@ -245,9 +247,12 @@ public partial interface IJobOperations /// /// When a Terminate Job request is received, the Batch service sets /// the job to the terminating state. The Batch service then terminates - /// any active or running tasks associated with the job, and runs any - /// required Job Release tasks. The job then moves into the completed - /// state. + /// any running tasks associated with the job and runs any required job + /// release tasks. Then the job moves into the completed state. If + /// there are any tasks in the job in the active state, they will + /// remain in the active state. Once a job is terminated, new tasks + /// cannot be added and any remaining active tasks will not be + /// scheduled. /// /// /// The ID of the job to terminate. diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/IPoolOperations.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/IPoolOperations.cs index ec6f30f62b91..ffe2e68a3417 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/IPoolOperations.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/IPoolOperations.cs @@ -62,7 +62,9 @@ public partial interface IPoolOperations /// /// Statistics are aggregated across all pools that have ever existed /// in the account, from account creation to the last update time of - /// the statistics. + /// the statistics. The statistics may not be immediately available. + /// The Batch service performs periodic roll-up of statistics. The + /// typical delay is about 30 minutes. /// /// /// Additional parameters for the operation diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/JobOperations.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/JobOperations.cs index 4b84044821fa..5db816fb647a 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/JobOperations.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/JobOperations.cs @@ -58,6 +58,8 @@ internal JobOperations(BatchServiceClient client) /// /// Statistics are aggregated across all jobs that have ever existed in the /// account, from account creation to the last update time of the statistics. + /// The statistics may not be immediately available. The Batch service performs + /// periodic roll-up of statistics. The typical delay is about 30 minutes. /// /// /// Additional parameters for the operation @@ -2102,9 +2104,12 @@ internal JobOperations(BatchServiceClient client) /// /// /// When a Terminate Job request is received, the Batch service sets the job to - /// the terminating state. The Batch service then terminates any active or - /// running tasks associated with the job, and runs any required Job Release - /// tasks. The job then moves into the completed state. + /// the terminating state. The Batch service then terminates any running tasks + /// associated with the job and runs any required job release tasks. Then the + /// job moves into the completed state. If there are any tasks in the job in + /// the active state, they will remain in the active state. Once a job is + /// terminated, new tasks cannot be added and any remaining active tasks will + /// not be scheduled. /// /// /// The ID of the job to terminate. diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/JobOperationsExtensions.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/JobOperationsExtensions.cs index 3e90c5cf6c85..79c8a673fcd5 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/JobOperationsExtensions.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/JobOperationsExtensions.cs @@ -28,6 +28,8 @@ public static partial class JobOperationsExtensions /// /// Statistics are aggregated across all jobs that have ever existed in the /// account, from account creation to the last update time of the statistics. + /// The statistics may not be immediately available. The Batch service performs + /// periodic roll-up of statistics. The typical delay is about 30 minutes. /// /// /// The operations group for this extension method. @@ -47,6 +49,8 @@ public static partial class JobOperationsExtensions /// /// Statistics are aggregated across all jobs that have ever existed in the /// account, from account creation to the last update time of the statistics. + /// The statistics may not be immediately available. The Batch service performs + /// periodic roll-up of statistics. The typical delay is about 30 minutes. /// /// /// The operations group for this extension method. @@ -408,9 +412,12 @@ public static partial class JobOperationsExtensions /// /// /// When a Terminate Job request is received, the Batch service sets the job to - /// the terminating state. The Batch service then terminates any active or - /// running tasks associated with the job, and runs any required Job Release - /// tasks. The job then moves into the completed state. + /// the terminating state. The Batch service then terminates any running tasks + /// associated with the job and runs any required job release tasks. Then the + /// job moves into the completed state. If there are any tasks in the job in + /// the active state, they will remain in the active state. Once a job is + /// terminated, new tasks cannot be added and any remaining active tasks will + /// not be scheduled. /// /// /// The operations group for this extension method. @@ -435,9 +442,12 @@ public static partial class JobOperationsExtensions /// /// /// When a Terminate Job request is received, the Batch service sets the job to - /// the terminating state. The Batch service then terminates any active or - /// running tasks associated with the job, and runs any required Job Release - /// tasks. The job then moves into the completed state. + /// the terminating state. The Batch service then terminates any running tasks + /// associated with the job and runs any required job release tasks. Then the + /// job moves into the completed state. If there are any tasks in the job in + /// the active state, they will remain in the active state. Once a job is + /// terminated, new tasks cannot be added and any remaining active tasks will + /// not be scheduled. /// /// /// The operations group for this extension method. diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/CloudJob.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/CloudJob.cs index 10fe7b26ce5f..2a65e25a5d8e 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/CloudJob.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/CloudJob.cs @@ -70,7 +70,9 @@ public CloudJob() /// The execution information for the /// job. /// Resource usage statistics for the entire - /// lifetime of the job. + /// lifetime of the job. The statistics may not be immediately + /// available. The Batch service performs periodic roll-up of + /// statistics. The typical delay is about 30 minutes. public CloudJob(string id = default(string), string displayName = default(string), bool? usesTaskDependencies = default(bool?), string url = default(string), string eTag = default(string), System.DateTime? lastModified = default(System.DateTime?), System.DateTime? creationTime = default(System.DateTime?), JobState? state = default(JobState?), System.DateTime? stateTransitionTime = default(System.DateTime?), JobState? previousState = default(JobState?), System.DateTime? previousStateTransitionTime = default(System.DateTime?), int? priority = default(int?), JobConstraints constraints = default(JobConstraints), JobManagerTask jobManagerTask = default(JobManagerTask), JobPreparationTask jobPreparationTask = default(JobPreparationTask), JobReleaseTask jobReleaseTask = default(JobReleaseTask), IList commonEnvironmentSettings = default(IList), PoolInformation poolInfo = default(PoolInformation), OnAllTasksComplete? onAllTasksComplete = default(OnAllTasksComplete?), OnTaskFailure? onTaskFailure = default(OnTaskFailure?), IList metadata = default(IList), JobExecutionInformation executionInfo = default(JobExecutionInformation), JobStatistics stats = default(JobStatistics)) { Id = id; @@ -306,7 +308,9 @@ public CloudJob() /// /// Gets or sets resource usage statistics for the entire lifetime of - /// the job. + /// the job. The statistics may not be immediately available. The Batch + /// service performs periodic roll-up of statistics. The typical delay + /// is about 30 minutes. /// [JsonProperty(PropertyName = "stats")] public JobStatistics Stats { get; set; } diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/CloudJobSchedule.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/CloudJobSchedule.cs index c95d9e1c4f4c..9b938c591e42 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/CloudJobSchedule.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/CloudJobSchedule.cs @@ -58,7 +58,9 @@ public CloudJobSchedule() /// A list of name-value pairs associated with /// the schedule as metadata. /// The lifetime resource usage statistics for the - /// job schedule. + /// job schedule. The statistics may not be immediately available. The + /// Batch service performs periodic roll-up of statistics. The typical + /// delay is about 30 minutes. public CloudJobSchedule(string id = default(string), string displayName = default(string), string url = default(string), string eTag = default(string), System.DateTime? lastModified = default(System.DateTime?), System.DateTime? creationTime = default(System.DateTime?), JobScheduleState? state = default(JobScheduleState?), System.DateTime? stateTransitionTime = default(System.DateTime?), JobScheduleState? previousState = default(JobScheduleState?), System.DateTime? previousStateTransitionTime = default(System.DateTime?), Schedule schedule = default(Schedule), JobSpecification jobSpecification = default(JobSpecification), JobScheduleExecutionInformation executionInfo = default(JobScheduleExecutionInformation), IList metadata = default(IList), JobScheduleStatistics stats = default(JobScheduleStatistics)) { Id = id; @@ -206,7 +208,9 @@ public CloudJobSchedule() /// /// Gets or sets the lifetime resource usage statistics for the job - /// schedule. + /// schedule. The statistics may not be immediately available. The + /// Batch service performs periodic roll-up of statistics. The typical + /// delay is about 30 minutes. /// [JsonProperty(PropertyName = "stats")] public JobScheduleStatistics Stats { get; set; } diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/CloudPool.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/CloudPool.cs index fbfced03b6d9..b838d03ab659 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/CloudPool.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/CloudPool.cs @@ -94,7 +94,9 @@ public CloudPool() /// A list of name-value pairs associated with /// the pool as metadata. /// Utilization and resource usage statistics for - /// the entire lifetime of the pool. + /// the entire lifetime of the pool. The statistics may not be + /// immediately available. The Batch service performs periodic roll-up + /// of statistics. The typical delay is about 30 minutes. public CloudPool(string id = default(string), string displayName = default(string), string url = default(string), string eTag = default(string), System.DateTime? lastModified = default(System.DateTime?), System.DateTime? creationTime = default(System.DateTime?), PoolState? state = default(PoolState?), System.DateTime? stateTransitionTime = default(System.DateTime?), AllocationState? allocationState = default(AllocationState?), System.DateTime? allocationStateTransitionTime = default(System.DateTime?), string vmSize = default(string), CloudServiceConfiguration cloudServiceConfiguration = default(CloudServiceConfiguration), VirtualMachineConfiguration virtualMachineConfiguration = default(VirtualMachineConfiguration), System.TimeSpan? resizeTimeout = default(System.TimeSpan?), IList resizeErrors = default(IList), int? currentDedicatedNodes = default(int?), int? currentLowPriorityNodes = default(int?), int? targetDedicatedNodes = default(int?), int? targetLowPriorityNodes = default(int?), bool? enableAutoScale = default(bool?), string autoScaleFormula = default(string), System.TimeSpan? autoScaleEvaluationInterval = default(System.TimeSpan?), AutoScaleRun autoScaleRun = default(AutoScaleRun), bool? enableInterNodeCommunication = default(bool?), NetworkConfiguration networkConfiguration = default(NetworkConfiguration), StartTask startTask = default(StartTask), IList certificateReferences = default(IList), IList applicationPackageReferences = default(IList), IList applicationLicenses = default(IList), int? maxTasksPerNode = default(int?), TaskSchedulingPolicy taskSchedulingPolicy = default(TaskSchedulingPolicy), IList userAccounts = default(IList), IList metadata = default(IList), PoolStatistics stats = default(PoolStatistics)) { Id = id; @@ -238,7 +240,7 @@ public CloudPool() /// For information about available sizes of virtual machines for Cloud /// Services pools (pools created with cloudServiceConfiguration), see /// Sizes for Cloud Services - /// (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). + /// (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). /// Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 /// and A2V2. For information about available VM sizes for pools using /// images from the Virtual Machines Marketplace (pools created with @@ -468,7 +470,9 @@ public CloudPool() /// /// Gets or sets utilization and resource usage statistics for the - /// entire lifetime of the pool. + /// entire lifetime of the pool. The statistics may not be immediately + /// available. The Batch service performs periodic roll-up of + /// statistics. The typical delay is about 30 minutes. /// [JsonProperty(PropertyName = "stats")] public PoolStatistics Stats { get; set; } diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/CloudTask.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/CloudTask.cs index 529a8851b8c8..c4a0b750c6b3 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/CloudTask.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/CloudTask.cs @@ -18,6 +18,19 @@ namespace Microsoft.Azure.Batch.Protocol.Models /// /// An Azure Batch task. /// + /// + /// Batch will retry tasks when a recovery operation is triggered on a + /// compute node. Examples of recovery operations include (but are not + /// limited to) when an unhealthy compute node is rebooted or a compute + /// node disappeared due to host failure. Retries due to recovery + /// operations are independent of and are not counted against the + /// maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal + /// retry due to a recovery operation may occur. Because of this, all tasks + /// should be idempotent. This means tasks need to tolerate being + /// interrupted and restarted without causing any corruption or duplicate + /// data. The best practice for long running tasks is to use some form of + /// checkpointing. + /// public partial class CloudTask { /// @@ -224,7 +237,10 @@ public CloudTask() /// features such as environment variable expansion. If you want to /// take advantage of such features, you should invoke the shell in the /// command line, for example using "cmd /c MyCommand" in Windows or - /// "/bin/sh -c MyCommand" in Linux. + /// "/bin/sh -c MyCommand" in Linux. If the command line refers to file + /// paths, it should use a relative path (relative to the task working + /// directory), or use the Batch provided environment variable + /// (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). /// [JsonProperty(PropertyName = "commandLine")] public string CommandLine { get; set; } diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/ComputeNode.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/ComputeNode.cs index 7f636007aaca..71a5f4353443 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/ComputeNode.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/ComputeNode.cs @@ -201,7 +201,7 @@ public ComputeNode() /// For information about available sizes of virtual machines for Cloud /// Services pools (pools created with cloudServiceConfiguration), see /// Sizes for Cloud Services - /// (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). + /// (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). /// Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 /// and A2V2. For information about available VM sizes for pools using /// images from the Virtual Machines Marketplace (pools created with diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/JobManagerTask.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/JobManagerTask.cs index d2274678b5d9..0b082bc55496 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/JobManagerTask.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/JobManagerTask.cs @@ -33,7 +33,17 @@ namespace Microsoft.Azure.Batch.Protocol.Models /// that a Job Manager task in one job does not have priority over tasks in /// other jobs. Across jobs, only job level priorities are observed. For /// example, if a Job Manager in a priority 0 job needs to be restarted, it - /// will not displace tasks of a priority 1 job. + /// will not displace tasks of a priority 1 job. Batch will retry tasks + /// when a recovery operation is triggered on a compute node. Examples of + /// recovery operations include (but are not limited to) when an unhealthy + /// compute node is rebooted or a compute node disappeared due to host + /// failure. Retries due to recovery operations are independent of and are + /// not counted against the maxTaskRetryCount. Even if the + /// maxTaskRetryCount is 0, an internal retry due to a recovery operation + /// may occur. Because of this, all tasks should be idempotent. This means + /// tasks need to tolerate being interrupted and restarted without causing + /// any corruption or duplicate data. The best practice for long running + /// tasks is to use some form of checkpointing. /// public partial class JobManagerTask { @@ -134,7 +144,11 @@ public JobManagerTask() /// take advantage of shell features such as environment variable /// expansion. If you want to take advantage of such features, you /// should invoke the shell in the command line, for example using "cmd - /// /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. + /// /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the + /// command line refers to file paths, it should use a relative path + /// (relative to the task working directory), or use the Batch provided + /// environment variable + /// (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). /// [JsonProperty(PropertyName = "commandLine")] public string CommandLine { get; set; } @@ -277,7 +291,7 @@ public JobManagerTask() /// compute node. /// /// - /// The default value is false. + /// The default value is true. /// [JsonProperty(PropertyName = "allowLowPriorityNode")] public bool? AllowLowPriorityNode { get; set; } diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/JobPreparationTask.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/JobPreparationTask.cs index 77b0c5053094..940c18674f64 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/JobPreparationTask.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/JobPreparationTask.cs @@ -39,6 +39,17 @@ namespace Microsoft.Azure.Batch.Protocol.Models /// rerunOnNodeRebootAfterSuccess is true or if the Job Preparation task /// did not previously complete. If the compute node is reimaged, the Job /// Preparation task is run again before scheduling any task of the job. + /// Batch will retry tasks when a recovery operation is triggered on a + /// compute node. Examples of recovery operations include (but are not + /// limited to) when an unhealthy compute node is rebooted or a compute + /// node disappeared due to host failure. Retries due to recovery + /// operations are independent of and are not counted against the + /// maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal + /// retry due to a recovery operation may occur. Because of this, all tasks + /// should be idempotent. This means tasks need to tolerate being + /// interrupted and restarted without causing any corruption or duplicate + /// data. The best practice for long running tasks is to use some form of + /// checkpointing. /// public partial class JobPreparationTask { @@ -121,7 +132,11 @@ public JobPreparationTask() /// take advantage of shell features such as environment variable /// expansion. If you want to take advantage of such features, you /// should invoke the shell in the command line, for example using "cmd - /// /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. + /// /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the + /// command line refers to file paths, it should use a relative path + /// (relative to the task working directory), or use the Batch provided + /// environment variable + /// (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). /// [JsonProperty(PropertyName = "commandLine")] public string CommandLine { get; set; } diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/JobReleaseTask.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/JobReleaseTask.cs index dcf71d13b69d..ae68586ddd2a 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/JobReleaseTask.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/JobReleaseTask.cs @@ -120,7 +120,11 @@ public JobReleaseTask() /// take advantage of shell features such as environment variable /// expansion. If you want to take advantage of such features, you /// should invoke the shell in the command line, for example using "cmd - /// /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. + /// /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the + /// command line refers to file paths, it should use a relative path + /// (relative to the task working directory), or use the Batch provided + /// environment variable + /// (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). /// [JsonProperty(PropertyName = "commandLine")] public string CommandLine { get; set; } diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/NodeCounts.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/NodeCounts.cs index 7f956690d3e5..43b6bce374da 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/NodeCounts.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/NodeCounts.cs @@ -46,6 +46,8 @@ public NodeCounts() /// state. /// The number of nodes in the /// startTaskFailed state. + /// The number of nodes in the leavingPool + /// state. /// The number of nodes in the unknown /// state. /// The number of nodes in the unusable @@ -53,7 +55,7 @@ public NodeCounts() /// The number of nodes in the /// waitingForStartTask state. /// The total number of nodes. - public NodeCounts(int creating, int idle, int offline, int preempted, int rebooting, int reimaging, int running, int starting, int startTaskFailed, int unknown, int unusable, int waitingForStartTask, int total) + public NodeCounts(int creating, int idle, int offline, int preempted, int rebooting, int reimaging, int running, int starting, int startTaskFailed, int leavingPool, int unknown, int unusable, int waitingForStartTask, int total) { Creating = creating; Idle = idle; @@ -64,6 +66,7 @@ public NodeCounts(int creating, int idle, int offline, int preempted, int reboot Running = running; Starting = starting; StartTaskFailed = startTaskFailed; + LeavingPool = leavingPool; Unknown = unknown; Unusable = unusable; WaitingForStartTask = waitingForStartTask; @@ -130,6 +133,12 @@ public NodeCounts(int creating, int idle, int offline, int preempted, int reboot [JsonProperty(PropertyName = "startTaskFailed")] public int StartTaskFailed { get; set; } + /// + /// Gets or sets the number of nodes in the leavingPool state. + /// + [JsonProperty(PropertyName = "leavingPool")] + public int LeavingPool { get; set; } + /// /// Gets or sets the number of nodes in the unknown state. /// diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/PoolAddParameter.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/PoolAddParameter.cs index 912f05e41478..9f6098fa1a8b 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/PoolAddParameter.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/PoolAddParameter.cs @@ -138,7 +138,7 @@ public PoolAddParameter() /// For information about available sizes of virtual machines for Cloud /// Services pools (pools created with cloudServiceConfiguration), see /// Sizes for Cloud Services - /// (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). + /// (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). /// Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 /// and A2V2. For information about available VM sizes for pools using /// images from the Virtual Machines Marketplace (pools created with diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/PoolSpecification.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/PoolSpecification.cs index 25cced93e267..6a2a1ee023bd 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/PoolSpecification.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/PoolSpecification.cs @@ -122,7 +122,7 @@ public PoolSpecification() /// For information about available sizes of virtual machines for Cloud /// Services pools (pools created with cloudServiceConfiguration), see /// Sizes for Cloud Services - /// (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). + /// (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). /// Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 /// and A2V2. For information about available VM sizes for pools using /// images from the Virtual Machines Marketplace (pools created with diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/StartTask.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/StartTask.cs index dfae2dec0327..9cbc18373a90 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/StartTask.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/StartTask.cs @@ -20,6 +20,19 @@ namespace Microsoft.Azure.Batch.Protocol.Models /// A task which is run when a compute node joins a pool in the Azure Batch /// service, or when the compute node is rebooted or reimaged. /// + /// + /// Batch will retry tasks when a recovery operation is triggered on a + /// compute node. Examples of recovery operations include (but are not + /// limited to) when an unhealthy compute node is rebooted or a compute + /// node disappeared due to host failure. Retries due to recovery + /// operations are independent of and are not counted against the + /// maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal + /// retry due to a recovery operation may occur. Because of this, all tasks + /// should be idempotent. This means tasks need to tolerate being + /// interrupted and restarted without causing any corruption or duplicate + /// data. The best practice for long running tasks is to use some form of + /// checkpointing. + /// public partial class StartTask { /// @@ -75,7 +88,11 @@ public StartTask() /// take advantage of shell features such as environment variable /// expansion. If you want to take advantage of such features, you /// should invoke the shell in the command line, for example using "cmd - /// /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. + /// /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the + /// command line refers to file paths, it should use a relative path + /// (relative to the task working directory), or use the Batch provided + /// environment variable + /// (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). /// [JsonProperty(PropertyName = "commandLine")] public string CommandLine { get; set; } diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/TaskAddParameter.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/TaskAddParameter.cs index 013e49dc53f9..adb69cc1ba6c 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/TaskAddParameter.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/TaskAddParameter.cs @@ -19,6 +19,19 @@ namespace Microsoft.Azure.Batch.Protocol.Models /// /// An Azure Batch task to add. /// + /// + /// Batch will retry tasks when a recovery operation is triggered on a + /// compute node. Examples of recovery operations include (but are not + /// limited to) when an unhealthy compute node is rebooted or a compute + /// node disappeared due to host failure. Retries due to recovery + /// operations are independent of and are not counted against the + /// maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal + /// retry due to a recovery operation may occur. Because of this, all tasks + /// should be idempotent. This means tasks need to tolerate being + /// interrupted and restarted without causing any corruption or duplicate + /// data. The best practice for long running tasks is to use some form of + /// checkpointing. + /// public partial class TaskAddParameter { /// @@ -126,7 +139,10 @@ public TaskAddParameter() /// features such as environment variable expansion. If you want to /// take advantage of such features, you should invoke the shell in the /// command line, for example using "cmd /c MyCommand" in Windows or - /// "/bin/sh -c MyCommand" in Linux. + /// "/bin/sh -c MyCommand" in Linux. If the command line refers to file + /// paths, it should use a relative path (relative to the task working + /// directory), or use the Batch provided environment variable + /// (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). /// [JsonProperty(PropertyName = "commandLine")] public string CommandLine { get; set; } diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/TaskConstraints.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/TaskConstraints.cs index 1a93a96ba58a..277e09e0742d 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/TaskConstraints.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/TaskConstraints.cs @@ -83,13 +83,16 @@ public TaskConstraints() /// The Batch service retries a task if its exit code is nonzero. /// /// - /// Note that this value specifically controls the number of retries. - /// The Batch service will try the task once, and may then retry up to - /// this limit. For example, if the maximum retry count is 3, Batch - /// tries the task up to 4 times (one initial try and 3 retries). If - /// the maximum retry count is 0, the Batch service does not retry the - /// task. If the maximum retry count is -1, the Batch service retries - /// the task without limit. + /// Note that this value specifically controls the number of retries + /// for the task executable due to a nonzero exit code. The Batch + /// service will try the task once, and may then retry up to this + /// limit. For example, if the maximum retry count is 3, Batch tries + /// the task up to 4 times (one initial try and 3 retries). If the + /// maximum retry count is 0, the Batch service does not retry the task + /// after the first attempt. If the maximum retry count is -1, the + /// Batch service retries the task without limit. Resource files and + /// application packages are only downloaded again if the task is + /// retried on a new compute node. /// [JsonProperty(PropertyName = "maxTaskRetryCount")] public int? MaxTaskRetryCount { get; set; } diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/UserIdentity.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/UserIdentity.cs index 282829e6b9dc..c6434d660924 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/UserIdentity.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/Models/UserIdentity.cs @@ -17,7 +17,10 @@ namespace Microsoft.Azure.Batch.Protocol.Models /// The definition of the user identity under which the task is run. /// /// - /// Specify either the userName or autoUser property, but not both. + /// Specify either the userName or autoUser property, but not both. On + /// CloudServiceConfiguration pools, this user is logged in with the + /// INTERACTIVE flag. On Windows VirtualMachineConfiguration pools, this + /// user is logged in with the BATCH flag. /// public partial class UserIdentity { diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/PoolOperations.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/PoolOperations.cs index 5e45ea2045c9..e3e5938e4d03 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/PoolOperations.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/PoolOperations.cs @@ -343,6 +343,8 @@ internal PoolOperations(BatchServiceClient client) /// /// Statistics are aggregated across all pools that have ever existed in the /// account, from account creation to the last update time of the statistics. + /// The statistics may not be immediately available. The Batch service performs + /// periodic roll-up of statistics. The typical delay is about 30 minutes. /// /// /// Additional parameters for the operation diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/PoolOperationsExtensions.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/PoolOperationsExtensions.cs index 800cd30af9ca..2f38e820729f 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/PoolOperationsExtensions.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/GeneratedProtocol/PoolOperationsExtensions.cs @@ -80,6 +80,8 @@ public static partial class PoolOperationsExtensions /// /// Statistics are aggregated across all pools that have ever existed in the /// account, from account creation to the last update time of the statistics. + /// The statistics may not be immediately available. The Batch service performs + /// periodic roll-up of statistics. The typical delay is about 30 minutes. /// /// /// The operations group for this extension method. @@ -99,6 +101,8 @@ public static partial class PoolOperationsExtensions /// /// Statistics are aggregated across all pools that have ever existed in the /// account, from account creation to the last update time of the statistics. + /// The statistics may not be immediately available. The Batch service performs + /// periodic roll-up of statistics. The typical delay is about 30 minutes. /// /// /// The operations group for this extension method. diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/JobOperations.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/JobOperations.cs index 8e50cfbcc2f6..a0016be22f08 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/JobOperations.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/JobOperations.cs @@ -1058,8 +1058,9 @@ public void AddTask( } /// - /// Gets lifetime summary statistics for all of the jobs in the current account. - /// Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. + /// Gets lifetime summary statistics for all of the jobs in the current account. + /// Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The + /// Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. /// /// A collection of instances that are applied to the Batch service request after the . /// A for controlling the lifetime of the asynchronous operation. @@ -1086,7 +1087,8 @@ public async System.Threading.Tasks.Task GetAllLifetimeStatistics /// /// Gets lifetime summary statistics for all of the jobs in the current account. - /// Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. + /// Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The + /// Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. /// /// A collection of instances that are applied to the Batch service request after the . /// The aggregated job statistics. diff --git a/src/SDKs/Batch/DataPlane/Azure.Batch/PoolOperations.cs b/src/SDKs/Batch/DataPlane/Azure.Batch/PoolOperations.cs index 5ae8f3c0e05e..af0eac029109 100644 --- a/src/SDKs/Batch/DataPlane/Azure.Batch/PoolOperations.cs +++ b/src/SDKs/Batch/DataPlane/Azure.Batch/PoolOperations.cs @@ -1735,7 +1735,8 @@ public void DeleteNodeFile( /// /// Gets lifetime summary statistics for all of the pools in the current account. - /// Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics. + /// Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The + /// Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. /// /// A collection of instances that are applied to the Batch service request after the . /// A for controlling the lifetime of the asynchronous operation. @@ -1758,7 +1759,8 @@ public void DeleteNodeFile( /// /// Gets lifetime summary statistics for all of the pools in the current account. - /// Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics. + /// Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The + /// Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. /// /// A collection of instances that are applied to the Batch service request after the . /// The aggregated pool statistics. diff --git a/src/SDKs/Batch/DataPlane/Tools/ConfigureAwaitAnalyzer/ConfigureAwaitAnalyzer.Tests/ConfigureAwaitAnalyzer.Tests.csproj b/src/SDKs/Batch/DataPlane/Tools/ConfigureAwaitAnalyzer/ConfigureAwaitAnalyzer.Tests/ConfigureAwaitAnalyzer.Tests.csproj index 0f2af22de7d1..aa024f2edc83 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ConfigureAwaitAnalyzer/ConfigureAwaitAnalyzer.Tests/ConfigureAwaitAnalyzer.Tests.csproj +++ b/src/SDKs/Batch/DataPlane/Tools/ConfigureAwaitAnalyzer/ConfigureAwaitAnalyzer.Tests/ConfigureAwaitAnalyzer.Tests.csproj @@ -3,7 +3,7 @@ Debug $(LibraryNugetPackageFolder) - + $(BuiltPackageOutputDir) false true @@ -14,8 +14,8 @@ - - + + diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/CodeGenerationLibrary/ObjectModelTypeData.cs b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/CodeGenerationLibrary/ObjectModelTypeData.cs index b70bf2d01fc7..a08f2c1429bb 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/CodeGenerationLibrary/ObjectModelTypeData.cs +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/CodeGenerationLibrary/ObjectModelTypeData.cs @@ -52,9 +52,14 @@ public ObjectModelTypeData() public string TransportProtocolName { get; set; } /// - /// Gets or sets the comment for the object model type. + /// Gets or sets the summary comment for the object model type. /// - public string Comment { get; set; } + public string SummaryComment { get; set; } + + /// + /// Gets or sets the remarks comment for the object model type. + /// + public string RemarksComment { get; set; } /// /// Gets or sets a value indicating if this type is used in collections and should have the diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/ModifiableClassTemplate.cs b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/ModifiableClassTemplate.cs index 48a987c4c5f2..a58e43146395 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/ModifiableClassTemplate.cs +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/ModifiableClassTemplate.cs @@ -28,8 +28,19 @@ public partial class ModifiableClassTemplate : ModifiableClassTemplateBase public virtual string TransformText() { this.Write(" /// \r\n"); - this.Write(this.ToStringHelper.ToStringWithCulture(CommentUtilities.FormatTripleSlashComment(type.Comment, CommentUtilities.Indentation.TypeLevel))); - this.Write("\r\n /// \r\n public partial class "); + this.Write(this.ToStringHelper.ToStringWithCulture(CommentUtilities.FormatTripleSlashComment(type.SummaryComment, CommentUtilities.Indentation.TypeLevel))); + this.Write("\r\n /// \r\n"); + +if (!string.IsNullOrEmpty(type.RemarksComment)) +{ + + this.Write(" /// \r\n"); + this.Write(this.ToStringHelper.ToStringWithCulture(CommentUtilities.FormatTripleSlashComment(type.RemarksComment, CommentUtilities.Indentation.TypeLevel))); + this.Write("\r\n /// \r\n"); + +} + + this.Write(" public partial class "); this.Write(this.ToStringHelper.ToStringWithCulture(type.Name)); this.Write(" :"); if (type.ShouldDefineGetTransportObject) { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/ModifiableClassTemplate.tt b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/ModifiableClassTemplate.tt index da5337e62c59..f433899552a6 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/ModifiableClassTemplate.tt +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/ModifiableClassTemplate.tt @@ -8,8 +8,18 @@ <#@ import namespace="CodeGenerationLibrary" #> <#@ parameter type="CodeGenerationLibrary.ObjectModelTypeData" name="type" #> /// -<#= CommentUtilities.FormatTripleSlashComment(type.Comment, CommentUtilities.Indentation.TypeLevel) #> +<#= CommentUtilities.FormatTripleSlashComment(type.SummaryComment, CommentUtilities.Indentation.TypeLevel) #> /// +<# +if (!string.IsNullOrEmpty(type.RemarksComment)) +{ +#> + /// +<#= CommentUtilities.FormatTripleSlashComment(type.RemarksComment, CommentUtilities.Indentation.TypeLevel) #> + /// +<# +} +#> public partial class <#= type.Name #> :<# if (type.ShouldDefineGetTransportObject) { #> ITransportObjectProvider<<#= type.TransportObjectTypeName #>>,<# } if (type.IsTopLevelObject) { #> IInheritedBehaviors,<# } #> IPropertyMetadata { private class PropertyContainer : PropertyCollection diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AddTaskResult.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AddTaskResult.json index f2d5b30fa66a..de2062cbdbb1 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AddTaskResult.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AddTaskResult.json @@ -2,7 +2,7 @@ "Name": "AddTaskResult", "ProtocolName": "Models.TaskAddResult", "IsConstructorPublic": false, - "Comment": "Result for a single task added as part of a collection of tasks.", + "SummaryComment": "Result for a single task added as part of a collection of tasks.", "Properties": [ { "Key": { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AffinityInformation.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AffinityInformation.json index 4087613be66a..5d0652c35df9 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AffinityInformation.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AffinityInformation.json @@ -1,7 +1,7 @@ { "Name": "AffinityInformation", "ProtocolName": "Models.AffinityInformation", - "Comment": "A locality hint that can be used by the Batch service to select a compute node on which to start a new task.", + "SummaryComment": "A locality hint that can be used by the Batch service to select a compute node on which to start a new task.", "Properties": [ { "Key": { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ApplicationPackageReference.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ApplicationPackageReference.json index 108e798804a8..b73da7d91739 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ApplicationPackageReference.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ApplicationPackageReference.json @@ -1,7 +1,7 @@ { "Name": "ApplicationPackageReference", "ProtocolName": "Models.ApplicationPackageReference", - "Comment": "A reference to an application package to be deployed to compute nodes.", + "SummaryComment": "A reference to an application package to be deployed to compute nodes.", "IsUsedInCollections": true, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ApplicationSummary.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ApplicationSummary.json index 5541be8fa344..2d60c6ab8fde 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ApplicationSummary.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ApplicationSummary.json @@ -1,7 +1,7 @@ { "Name": "ApplicationSummary", "ProtocolName": "Models.ApplicationSummary", - "Comment": "Contains information about an application in an Azure Batch account.", + "SummaryComment": "Contains information about an application in an Azure Batch account.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AuthenticationTokenSettings.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AuthenticationTokenSettings.json index 23436fee9f0c..a5c90fdcb059 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AuthenticationTokenSettings.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AuthenticationTokenSettings.json @@ -1,7 +1,7 @@ { "Name": "AuthenticationTokenSettings", "ProtocolName": "Models.AuthenticationTokenSettings", - "Comment": "The settings for an authentication token that the task can use to perform Batch service operations.", + "SummaryComment": "The settings for an authentication token that the task can use to perform Batch service operations.", "IsConstructorPublic": true, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AutoPoolSpecification.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AutoPoolSpecification.json index 259b548000d3..b9463913ebbb 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AutoPoolSpecification.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AutoPoolSpecification.json @@ -1,7 +1,7 @@ { "Name": "AutoPoolSpecification", "ProtocolName": "Models.AutoPoolSpecification", - "Comment": "Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto pool, run all the tasks for the job on it, and by default delete the pool once the job has completed.", + "SummaryComment": "Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto pool, run all the tasks for the job on it, and by default delete the pool once the job has completed.", "Properties": [ { "Key": { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AutoScaleRun.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AutoScaleRun.json index 226247efb8ec..5b48c7cc5a72 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AutoScaleRun.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AutoScaleRun.json @@ -1,7 +1,7 @@ { "Name": "AutoScaleRun", "ProtocolName": "Models.AutoScaleRun", - "Comment": "The results and errors from an evaluation or execution of a pool autoscale formula.", + "SummaryComment": "The results and errors from an evaluation or execution of a pool autoscale formula.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AutoScaleRunError.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AutoScaleRunError.json index ec26e0863f68..b16a16cadbcc 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AutoScaleRunError.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AutoScaleRunError.json @@ -1,7 +1,7 @@ { "Name": "AutoScaleRunError", "ProtocolName": "Models.AutoScaleRunError", - "Comment": "An error that occurred when executing or evaluating a pool autoscale formula.", + "SummaryComment": "An error that occurred when executing or evaluating a pool autoscale formula.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AutoUserSpecification.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AutoUserSpecification.json index bdf37f47d81c..34afedf98986 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AutoUserSpecification.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/AutoUserSpecification.json @@ -1,7 +1,7 @@ { "Name": "AutoUserSpecification", "ProtocolName": "Models.AutoUserSpecification", - "Comment": "Specifies the parameters for the auto user that runs a task on the Batch service", + "SummaryComment": "Specifies the parameters for the auto user that runs a task on the Batch service", "IsConstructorPublic": true, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/BatchError.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/BatchError.json index d7ef0949d371..c2d3cb3f7170 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/BatchError.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/BatchError.json @@ -1,7 +1,7 @@ { "Name": "BatchError", "ProtocolName": "Models.BatchError", - "Comment": "An error received from the Azure Batch service.", + "SummaryComment": "An error received from the Azure Batch service.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/BatchErrorDetail.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/BatchErrorDetail.json index 9a944fcd2c98..f80f75c7be28 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/BatchErrorDetail.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/BatchErrorDetail.json @@ -1,7 +1,7 @@ { "Name": "BatchErrorDetail", "ProtocolName": "Models.BatchErrorDetail", - "Comment": "An item of additional information included in a .", + "SummaryComment": "An item of additional information included in a .", "IsConstructorPublic": false, "IsUsedInCollections": true, "Properties": [ diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/Certificate.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/Certificate.json index 112a9e970e8c..977c0a24b781 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/Certificate.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/Certificate.json @@ -2,7 +2,7 @@ "Name": "Certificate", "ProtocolName": "Models.Certificate", "TransportProtocolName": "Models.CertificateAddParameter", - "Comment": "A certificate that can be installed on compute nodes and can be used to authenticate operations on a node.", + "SummaryComment": "A certificate that can be installed on compute nodes and can be used to authenticate operations on a node.", "IsTopLevelObject": true, "IsConstructorPublic": false, "Properties": [ diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CertificateReference.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CertificateReference.json index 2780fffd3678..0bb9463e667e 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CertificateReference.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CertificateReference.json @@ -1,7 +1,7 @@ { "Name": "CertificateReference", "ProtocolName": "Models.CertificateReference", - "Comment": "Represents a certificate object of the Azure Batch service.", + "SummaryComment": "Represents a certificate object of the Azure Batch service.", "IsUsedInCollections": true, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CloudJob.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CloudJob.json index d46e97924315..7f7960383f6e 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CloudJob.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CloudJob.json @@ -2,7 +2,7 @@ "Name": "CloudJob", "ProtocolName": "Models.CloudJob", "TransportProtocolName": "Models.JobAddParameter", - "Comment": "An Azure Batch job.", + "SummaryComment": "An Azure Batch job.", "IsTopLevelObject": true, "IsConstructorPublic": false, "Properties": [ @@ -248,7 +248,7 @@ "Type": "JobStatistics", "Name": "Statistics", "SummaryComment": "Resource usage statistics for the entire lifetime of the job.", - "RemarksComment": "This property is populated only if the was retrieved with an including the 'stats' attribute; otherwise it is null.", + "RemarksComment": "This property is populated only if the was retrieved with an including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.", "BoundAccess": "read", "UnboundAccess": "none" }, diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CloudJobSchedule.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CloudJobSchedule.json index 6735794d8e05..26a13d9c730f 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CloudJobSchedule.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CloudJobSchedule.json @@ -2,7 +2,7 @@ "Name": "CloudJobSchedule", "ProtocolName": "Models.CloudJobSchedule", "TransportProtocolName": "Models.JobScheduleAddParameter", - "Comment": "A job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job.", + "SummaryComment": "A job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job.", "IsTopLevelObject": true, "IsConstructorPublic": false, "Properties": [ @@ -163,7 +163,7 @@ "Type": "JobScheduleStatistics", "Name": "Statistics", "SummaryComment": "A containing resource usage statistics for the entire lifetime of the job schedule.", - "RemarksComment": "This property is populated only if the was retrieved with an including the 'stats' attribute; otherwise it is null.", + "RemarksComment": "This property is populated only if the was retrieved with an including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.", "BoundAccess": "read", "UnboundAccess": "none" }, diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CloudPool.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CloudPool.json index fbb0cb49330a..153f7a4516de 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CloudPool.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CloudPool.json @@ -2,7 +2,7 @@ "Name": "CloudPool", "ProtocolName": "Models.CloudPool", "TransportProtocolName": "Models.PoolAddParameter", - "Comment": "A pool in the Azure Batch service.", + "SummaryComment": "A pool in the Azure Batch service.", "IsTopLevelObject": true, "IsConstructorPublic": false, "Properties": [ @@ -318,7 +318,7 @@ "Type": "PoolStatistics", "Name": "Statistics", "SummaryComment": "The resource usage statistics for the pool.", - "RemarksComment": "This property is populated only if the was retrieved with an including the 'stats' attribute; otherwise it is null.", + "RemarksComment": "This property is populated only if the was retrieved with an including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.", "BoundAccess": "read", "UnboundAccess": "none" }, diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CloudServiceConfiguration.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CloudServiceConfiguration.json index 5b8ae6972b03..1cfddbaf9c40 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CloudServiceConfiguration.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CloudServiceConfiguration.json @@ -1,7 +1,7 @@ { "Name": "CloudServiceConfiguration", "ProtocolName": "Models.CloudServiceConfiguration", - "Comment": "The configuration for compute nodes in a pool based on the Azure Cloud Services platform.", + "SummaryComment": "The configuration for compute nodes in a pool based on the Azure Cloud Services platform.", "Properties": [ { "Key": { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CloudTask.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CloudTask.json index 3861bb6ae1c2..b2434125908d 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CloudTask.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/CloudTask.json @@ -1,340 +1,341 @@ +{ + "Name": "CloudTask", + "ProtocolName": "Models.CloudTask", + "TransportProtocolName": "Models.TaskAddParameter", + "SummaryComment": "An Azure Batch task. A task is a piece of work that is associated with a job and runs on a compute node.", + "RemarksComment": "Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the . Even if the is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing.", + "ParentPathVariables": [ "parentJobId" ], + "CustomIncludes": [ "FileStaging" ], + "IsTopLevelObject": true, + "IsConstructorPublic": false, + "HideCustomConstructor": true, + "Properties": [ { - "Name": "CloudTask", - "ProtocolName": "Models.CloudTask", - "TransportProtocolName": "Models.TaskAddParameter", - "Comment": "An Azure Batch task. A task is a piece of work that is associated with a job and runs on a compute node.", - "ParentPathVariables": [ "parentJobId" ], - "CustomIncludes": [ "FileStaging" ], - "IsTopLevelObject": true, - "IsConstructorPublic": false, - "HideCustomConstructor": true, - "Properties": [ - { - "Key": { - "Type": "AffinityInformation", - "Name": "AffinityInformation", - "SummaryComment": "A locality hint that can be used by the Batch service to select a node on which to start the task.", - "RemarksComment": null, - "BoundAccess": "read", - "UnboundAccess": "read,write" - }, - "Value": { - "Type": "Models.AffinityInformation", - "Name": "AffinityInfo" - } - }, - { - "Key": { - "Type": "string", - "Name": "CommandLine", - "SummaryComment": "The command line of the task.", - "RemarksComment": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux.", - "BoundAccess": "read", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "ComputeNodeInformation", - "Name": "ComputeNodeInformation", - "SummaryComment": "Information about the compute node on which the task ran.", - "RemarksComment": null, - "BoundAccess": "read", - "UnboundAccess": "none" - }, - "Value": { - "Type": "Models.NodeInformation", - "Name": "NodeInfo" - } - }, - { - "Key": { - "Type": "MultiInstanceSettings", - "Name": "MultiInstanceSettings", - "SummaryComment": "Information about how to run the multi-instance task.", - "RemarksComment": null, - "BoundAccess": "read", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "DateTime?", - "Name": "CreationTime", - "SummaryComment": "The creation time of the task.", - "RemarksComment": null, - "BoundAccess": "read", - "UnboundAccess": "none" - }, - "Value": null - }, - { - "Key": { - "Type": "TaskDependencies", - "Name": "DependsOn", - "SummaryComment": "Any other tasks that this depends on. The task will not be scheduled until all depended-on tasks have completed successfully.", - "RemarksComment": "The job must set to true in order to use task dependencies. If UsesTaskDependencies is false (the default), adding a task with dependencies will fail with an error.", - "BoundAccess": "read", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "string", - "Name": "DisplayName", - "SummaryComment": "The display name of the task.", - "RemarksComment": null, - "BoundAccess": "read", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "ExitConditions", - "Name": "ExitConditions", - "SummaryComment": "How the Batch service should respond when the task completes.", - "BoundAccess": "read", - "UnboundAccess": "read,write" - }, - "Value": { - "Type": "Models.ExitConditions", - "Name": "ExitConditions" - } - }, - { - "Key": { - "Type": "IList", - "Name": "EnvironmentSettings", - "SummaryComment": "A list of environment variable settings for the task.", - "RemarksComment": null, - "BoundAccess": "read", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "string", - "Name": "ETag", - "SummaryComment": "The ETag for the task.", - "RemarksComment": null, - "BoundAccess": "read", - "UnboundAccess": "none" - }, - "Value": null - }, - { - "Key": { - "Type": "IList", - "Name": "FilesToStage", - "SummaryComment": "A list of files to be staged for the task.", - "RemarksComment": null, - "BoundAccess": "none", - "UnboundAccess": "read,write", - "IsClientOnly": true - }, - "Value": null - }, - { - "Key": { - "Type": "TaskExecutionInformation", - "Name": "ExecutionInformation", - "SummaryComment": "The execution information for the task.", - "RemarksComment": null, - "BoundAccess": "read", - "UnboundAccess": "none" - }, - "Value": { - "Type": "Models.TaskExecutionInformation", - "Name": "ExecutionInfo" - } - }, - { - "Key": { - "Type": "string", - "Name": "Id", - "SummaryComment": "The id of the task.", - "RemarksComment": null, - "BoundAccess": "read", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "DateTime?", - "Name": "LastModified", - "SummaryComment": "The last modified time of the task.", - "RemarksComment": null, - "BoundAccess": "read", - "UnboundAccess": "none" - }, - "Value": null - }, - { - "Key": { - "Type": "Common.TaskState?", - "Name": "PreviousState", - "SummaryComment": "The previous state of the task.", - "RemarksComment": "If the task is in its initial state, the PreviousState property is not defined.", - "BoundAccess": "read", - "UnboundAccess": "none" - }, - "Value": { - "Type": "Models.TaskState?", - "Name": "PreviousState" - } - }, - { - "Key": { - "Type": "DateTime?", - "Name": "PreviousStateTransitionTime", - "SummaryComment": "The time at which the task entered its previous state.", - "RemarksComment": "If the task is in its initial state, the PreviousStateTransitionTime property is not defined.", - "BoundAccess": "read", - "UnboundAccess": "none" - }, - "Value": null - }, - { - "Key": { - "Type": "IList", - "Name": "ResourceFiles", - "SummaryComment": "A list of files that the Batch service will download to the compute node before running the command line.", - "RemarksComment": null, - "BoundAccess": "read", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "IList", - "Name": "OutputFiles", - "SummaryComment": "A list of files that the Batch service will upload from the compute node after running the command line.", - "RemarksComment": null, - "BoundAccess": "read", - "UnboundAccess": "read,write" - }, - "Value": { - "Type": "IList", - "Name": "OutputFiles" - } - }, - { - "Key": { - "Type": "UserIdentity", - "Name": "UserIdentity", - "SummaryComment": "The user identity under which the task runs.", - "RemarksComment": "If omitted, the task runs as a non-administrative user unique to the task.", - "BoundAccess": "read", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "Common.TaskState?", - "Name": "State", - "SummaryComment": "The current state of the task.", - "RemarksComment": null, - "BoundAccess": "read", - "UnboundAccess": "none" - }, - "Value": { - "Type": "Models.TaskState?", - "Name": "State" - } - }, - { - "Key": { - "Type": "DateTime?", - "Name": "StateTransitionTime", - "SummaryComment": "The time at which the task entered its current state.", - "RemarksComment": null, - "BoundAccess": "read", - "UnboundAccess": "none" - }, - "Value": null - }, - { - "Key": { - "Type": "TaskStatistics", - "Name": "Statistics", - "SummaryComment": "Resource usage statistics for the task.", - "RemarksComment": "This property is populated only if the was retrieved with an including the 'stats' attribute; otherwise it is null.", - "BoundAccess": "read", - "UnboundAccess": "none" - }, - "Value": { - "Type": "Models.TaskStatistics", - "Name": "Stats" - } - }, - { - "Key": { - "Type": "TaskConstraints", - "Name": "Constraints", - "SummaryComment": "The execution constraints that apply to this task.", - "RemarksComment": null, - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "string", - "Name": "Url", - "SummaryComment": "The URL of the task.", - "RemarksComment": null, - "BoundAccess": "read", - "UnboundAccess": "none" - }, - "Value": null - }, - { - "Key": { - "Type": "IList", - "Name": "ApplicationPackageReferences", - "SummaryComment": "A list of application packages that the Batch service will deploy to the compute node before running the command line.", - "RemarksComment": null, - "BoundAccess": "read", - "UnboundAccess": "read,write" - }, - "Value": { - "Type": "IList", - "Name": "ApplicationPackageReferences" - } - }, - { - "Key": { - "Type": "AuthenticationTokenSettings", - "Name": "AuthenticationTokenSettings", - "SummaryComment": "The settings for an authentication token that the task can use to perform Batch service operations.", - "RemarksComment": "If this property is set, the Batch service provides the task with an authentication token which can be used to authenticate Batch service operations without requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the task can carry out using the token depend on the settings. For example, a task can request job permissions in order to add other tasks to the job, or check the status of the job or of other tasks.", - "BoundAccess": "read", - "UnboundAccess": "read,write" - }, - "Value": { - "Type": "Models.AuthenticationTokenSettings?", - "Name": "AuthenticationTokenSettings" - } - }, - { - "Key": { - "Type": "TaskContainerSettings", - "Name": "ContainerSettings", - "SummaryComment": "The settings for the container under which the task runs.", - "RemarksComment": "If the pool that will run this task has set, this must be set as well. If the pool that will run this task doesn't have set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.", - "BoundAccess": "read", - "UnboundAccess": "read,write" - }, - "Value": null - } - ] + "Key": { + "Type": "AffinityInformation", + "Name": "AffinityInformation", + "SummaryComment": "A locality hint that can be used by the Batch service to select a node on which to start the task.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": { + "Type": "Models.AffinityInformation", + "Name": "AffinityInfo" + } + }, + { + "Key": { + "Type": "string", + "Name": "CommandLine", + "SummaryComment": "The command line of the task.", + "RemarksComment": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \\\"cmd /c MyCommand\\\" in Windows or \\\"/bin/sh -c MyCommand\\\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variables (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).", + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "ComputeNodeInformation", + "Name": "ComputeNodeInformation", + "SummaryComment": "Information about the compute node on which the task ran.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "none" + }, + "Value": { + "Type": "Models.NodeInformation", + "Name": "NodeInfo" + } + }, + { + "Key": { + "Type": "MultiInstanceSettings", + "Name": "MultiInstanceSettings", + "SummaryComment": "Information about how to run the multi-instance task.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "DateTime?", + "Name": "CreationTime", + "SummaryComment": "The creation time of the task.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "none" + }, + "Value": null + }, + { + "Key": { + "Type": "TaskDependencies", + "Name": "DependsOn", + "SummaryComment": "Any other tasks that this depends on. The task will not be scheduled until all depended-on tasks have completed successfully.", + "RemarksComment": "The job must set to true in order to use task dependencies. If UsesTaskDependencies is false (the default), adding a task with dependencies will fail with an error.", + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "DisplayName", + "SummaryComment": "The display name of the task.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "ExitConditions", + "Name": "ExitConditions", + "SummaryComment": "How the Batch service should respond when the task completes.", + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": { + "Type": "Models.ExitConditions", + "Name": "ExitConditions" + } + }, + { + "Key": { + "Type": "IList", + "Name": "EnvironmentSettings", + "SummaryComment": "A list of environment variable settings for the task.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "ETag", + "SummaryComment": "The ETag for the task.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "none" + }, + "Value": null + }, + { + "Key": { + "Type": "IList", + "Name": "FilesToStage", + "SummaryComment": "A list of files to be staged for the task.", + "RemarksComment": null, + "BoundAccess": "none", + "UnboundAccess": "read,write", + "IsClientOnly": true + }, + "Value": null + }, + { + "Key": { + "Type": "TaskExecutionInformation", + "Name": "ExecutionInformation", + "SummaryComment": "The execution information for the task.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "none" + }, + "Value": { + "Type": "Models.TaskExecutionInformation", + "Name": "ExecutionInfo" + } + }, + { + "Key": { + "Type": "string", + "Name": "Id", + "SummaryComment": "The id of the task.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "DateTime?", + "Name": "LastModified", + "SummaryComment": "The last modified time of the task.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "none" + }, + "Value": null + }, + { + "Key": { + "Type": "Common.TaskState?", + "Name": "PreviousState", + "SummaryComment": "The previous state of the task.", + "RemarksComment": "If the task is in its initial state, the PreviousState property is not defined.", + "BoundAccess": "read", + "UnboundAccess": "none" + }, + "Value": { + "Type": "Models.TaskState?", + "Name": "PreviousState" + } + }, + { + "Key": { + "Type": "DateTime?", + "Name": "PreviousStateTransitionTime", + "SummaryComment": "The time at which the task entered its previous state.", + "RemarksComment": "If the task is in its initial state, the PreviousStateTransitionTime property is not defined.", + "BoundAccess": "read", + "UnboundAccess": "none" + }, + "Value": null + }, + { + "Key": { + "Type": "IList", + "Name": "ResourceFiles", + "SummaryComment": "A list of files that the Batch service will download to the compute node before running the command line.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "IList", + "Name": "OutputFiles", + "SummaryComment": "A list of files that the Batch service will upload from the compute node after running the command line.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": { + "Type": "IList", + "Name": "OutputFiles" + } + }, + { + "Key": { + "Type": "UserIdentity", + "Name": "UserIdentity", + "SummaryComment": "The user identity under which the task runs.", + "RemarksComment": "If omitted, the task runs as a non-administrative user unique to the task.", + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "Common.TaskState?", + "Name": "State", + "SummaryComment": "The current state of the task.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "none" + }, + "Value": { + "Type": "Models.TaskState?", + "Name": "State" + } + }, + { + "Key": { + "Type": "DateTime?", + "Name": "StateTransitionTime", + "SummaryComment": "The time at which the task entered its current state.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "none" + }, + "Value": null + }, + { + "Key": { + "Type": "TaskStatistics", + "Name": "Statistics", + "SummaryComment": "Resource usage statistics for the task.", + "RemarksComment": "This property is populated only if the was retrieved with an including the 'stats' attribute; otherwise it is null.", + "BoundAccess": "read", + "UnboundAccess": "none" + }, + "Value": { + "Type": "Models.TaskStatistics", + "Name": "Stats" + } + }, + { + "Key": { + "Type": "TaskConstraints", + "Name": "Constraints", + "SummaryComment": "The execution constraints that apply to this task.", + "RemarksComment": null, + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "Url", + "SummaryComment": "The URL of the task.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "none" + }, + "Value": null + }, + { + "Key": { + "Type": "IList", + "Name": "ApplicationPackageReferences", + "SummaryComment": "A list of application packages that the Batch service will deploy to the compute node before running the command line.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": { + "Type": "IList", + "Name": "ApplicationPackageReferences" + } + }, + { + "Key": { + "Type": "AuthenticationTokenSettings", + "Name": "AuthenticationTokenSettings", + "SummaryComment": "The settings for an authentication token that the task can use to perform Batch service operations.", + "RemarksComment": "If this property is set, the Batch service provides the task with an authentication token which can be used to authenticate Batch service operations without requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the task can carry out using the token depend on the settings. For example, a task can request job permissions in order to add other tasks to the job, or check the status of the job or of other tasks.", + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": { + "Type": "Models.AuthenticationTokenSettings?", + "Name": "AuthenticationTokenSettings" + } + }, + { + "Key": { + "Type": "TaskContainerSettings", + "Name": "ContainerSettings", + "SummaryComment": "The settings for the container under which the task runs.", + "RemarksComment": "If the pool that will run this task has set, this must be set as well. If the pool that will run this task doesn't have set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.", + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": null } + ] +} diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ComputeNode.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ComputeNode.json index 543f593df0f4..531ca515f7f4 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ComputeNode.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ComputeNode.json @@ -1,7 +1,7 @@ { "Name": "ComputeNode", "ProtocolName": "Models.ComputeNode", - "Comment": "Summarizes the state of a compute node.", + "SummaryComment": "Summarizes the state of a compute node.", "ParentPathVariables": [ "parentPoolId" ], "IsTopLevelObject": true, "IsConstructorPublic": false, diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ComputeNodeEndpointConfiguration.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ComputeNodeEndpointConfiguration.json index ad9cf865d9fe..74353e18dd0a 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ComputeNodeEndpointConfiguration.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ComputeNodeEndpointConfiguration.json @@ -1,7 +1,7 @@ { "Name": "ComputeNodeEndpointConfiguration", "ProtocolName": "Models.ComputeNodeEndpointConfiguration", - "Comment": "The endpoint configuration for the compute node.", + "SummaryComment": "The endpoint configuration for the compute node.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ComputeNodeError.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ComputeNodeError.json index e9353f5baa62..2742bec54ba7 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ComputeNodeError.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ComputeNodeError.json @@ -1,7 +1,7 @@ { "Name": "ComputeNodeError", "ProtocolName": "Models.ComputeNodeError", - "Comment": "An error encountered by an Azure Batch compute node.", + "SummaryComment": "An error encountered by an Azure Batch compute node.", "IsConstructorPublic": false, "IsUsedInCollections": true, "Properties": [ diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ComputeNodeInformation.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ComputeNodeInformation.json index 8ef0c56accdf..ec42b7b580e5 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ComputeNodeInformation.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ComputeNodeInformation.json @@ -1,7 +1,7 @@ { "Name": "ComputeNodeInformation", "ProtocolName": "Models.ComputeNodeInformation", - "Comment": "The compute node information class.", + "SummaryComment": "The compute node information class.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ComputeNodeUser.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ComputeNodeUser.json index 91ca09637cd1..777459e388b8 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ComputeNodeUser.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ComputeNodeUser.json @@ -1,7 +1,7 @@ { "Name": "ComputeNodeUser", "ProtocolName": "Models.ComputeNodeUser", - "Comment": "A user account for remote access to a compute node.", + "SummaryComment": "A user account for remote access to a compute node.", "ParentPathVariables": [ "parentPoolId", "parentNodeId" ], "IsTopLevelObject": true, "IsConstructorPublic": false, diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ContainerConfiguration.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ContainerConfiguration.json index 3e958fba94a4..97e3201f1037 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ContainerConfiguration.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ContainerConfiguration.json @@ -1,7 +1,7 @@ { "Name": "ContainerConfiguration", "ProtocolName": "Models.ContainerConfiguration", - "Comment": "The configuration for container-enabled pools.", + "SummaryComment": "The configuration for container-enabled pools.", "Properties": [ { "Key": { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ContainerRegistry.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ContainerRegistry.json index b9afc27e4944..1d62e8c590df 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ContainerRegistry.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ContainerRegistry.json @@ -1,7 +1,7 @@ { "Name": "ContainerRegistry", "ProtocolName": "Models.ContainerRegistry", - "Comment": "A private container registry.", + "SummaryComment": "A private container registry.", "IsConstructorPublic": true, "IsUsedInCollections": true, "Properties": [ diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/DataDisk.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/DataDisk.json index 7d87b7129244..6846830e57db 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/DataDisk.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/DataDisk.json @@ -1,7 +1,7 @@ { "Name": "DataDisk", "ProtocolName": "Models.DataDisk", - "Comment": "Settings which will be used by the data disks associated to compute nodes in the pool.", + "SummaryComment": "Settings which will be used by the data disks associated to compute nodes in the pool.", "IsConstructorPublic": true, "IsUsedInCollections": true, "Properties": [ diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/DeleteCertificateError.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/DeleteCertificateError.json index ac62904d7bb2..52f91a50ea7b 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/DeleteCertificateError.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/DeleteCertificateError.json @@ -1,7 +1,7 @@ { "Name": "DeleteCertificateError", "ProtocolName": "Models.DeleteCertificateError", - "Comment": "An error encountered by the Batch service when deleting a certificate.", + "SummaryComment": "An error encountered by the Batch service when deleting a certificate.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/EnvironmentSetting.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/EnvironmentSetting.json index 586ea8089953..c9cf897ffa46 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/EnvironmentSetting.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/EnvironmentSetting.json @@ -1,7 +1,7 @@ { "Name": "EnvironmentSetting", "ProtocolName": "Models.EnvironmentSetting", - "Comment": "An environment variable to be set on a task process, such as a job task, start task, job manager task, or job preparation or release task.", + "SummaryComment": "An environment variable to be set on a task process, such as a job task, start task, job manager task, or job preparation or release task.", "IsUsedInCollections": true, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ErrorMessage.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ErrorMessage.json index 27e61d9791f5..57ebcd4212cb 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ErrorMessage.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ErrorMessage.json @@ -1,7 +1,7 @@ { "Name": "ErrorMessage", "ProtocolName": "Models.ErrorMessage", - "Comment": "An error message received in an Azure Batch error response.", + "SummaryComment": "An error message received in an Azure Batch error response.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ExitCodeMapping.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ExitCodeMapping.json index 763efa2af2be..8841544ce873 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ExitCodeMapping.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ExitCodeMapping.json @@ -1,7 +1,7 @@ { "Name": "ExitCodeMapping", "ProtocolName": "Models.ExitCodeMapping", - "Comment": "A process exit code and how the Batch service should respond if a task exits with that exit code.", + "SummaryComment": "A process exit code and how the Batch service should respond if a task exits with that exit code.", "IsUsedInCollections": true, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ExitCodeRangeMapping.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ExitCodeRangeMapping.json index 2e1b7709f8bc..c1e8a4d2cf0d 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ExitCodeRangeMapping.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ExitCodeRangeMapping.json @@ -1,7 +1,7 @@ { "Name": "ExitCodeRangeMapping", "ProtocolName": "Models.ExitCodeRangeMapping", - "Comment": "A range of exit codes and how the Batch service should respond if a task exits with an exit code within that range.", + "SummaryComment": "A range of exit codes and how the Batch service should respond if a task exits with an exit code within that range.", "IsUsedInCollections": true, "ForceConstructorOrder": true, "Properties": [ diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ExitConditions.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ExitConditions.json index 98c55f75e979..dd3625196045 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ExitConditions.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ExitConditions.json @@ -1,7 +1,7 @@ { "Name": "ExitConditions", "ProtocolName": "Models.ExitConditions", - "Comment": "How the Batch service should respond when a task completes.", + "SummaryComment": "How the Batch service should respond when a task completes.", "IsUsedInCollections": true, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ExitOptions.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ExitOptions.json index 2c405d1e59b0..3a5050588cfd 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ExitOptions.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ExitOptions.json @@ -1,7 +1,7 @@ { "Name": "ExitOptions", "ProtocolName": "Models.ExitOptions", - "Comment": "How the Batch service should respond to a particular exit condition.", + "SummaryComment": "How the Batch service should respond to a particular exit condition.", "IsUsedInCollections": true, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/FileProperties.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/FileProperties.json index 8675d250a1df..86720f2125e6 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/FileProperties.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/FileProperties.json @@ -1,7 +1,7 @@ { "Name": "FileProperties", "ProtocolName": "Models.FileProperties", - "Comment": "The properties of a file on a compute node.", + "SummaryComment": "The properties of a file on a compute node.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ImageReference.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ImageReference.json index eec9bad7f263..36dcae4f1b2a 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ImageReference.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ImageReference.json @@ -1,7 +1,7 @@ { "Name": "ImageReference", "ProtocolName": "Models.ImageReference", - "Comment": "Azure Virtual Machine image. To get the list of all Azure Marketplace image references verified by Azure Batch, see and .", + "SummaryComment": "Azure Virtual Machine image. To get the list of all Azure Marketplace image references verified by Azure Batch, see and .", "IsUsedInCollections": true, "IsConstructorPublic": false, "Properties": [ diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/InboundEndpoint.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/InboundEndpoint.json index 492baf20fb7f..6dfc2fb0dff1 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/InboundEndpoint.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/InboundEndpoint.json @@ -1,7 +1,7 @@ { "Name": "InboundEndpoint", "ProtocolName": "Models.InboundEndpoint", - "Comment": "An inbound endpoint on a compute node.", + "SummaryComment": "An inbound endpoint on a compute node.", "IsUsedInCollections": true, "IsConstructorPublic": false, "Properties": [ diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/InboundNatPool.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/InboundNatPool.json index 7454ffbf0710..6475e1031102 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/InboundNatPool.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/InboundNatPool.json @@ -1,7 +1,7 @@ { "Name": "InboundNatPool", "ProtocolName": "Models.InboundNATPool", - "Comment": "A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally.", + "SummaryComment": "A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally.", "IsUsedInCollections": true, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobConstraints.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobConstraints.json index 26a2146f80c1..46c187d6d84b 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobConstraints.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobConstraints.json @@ -1,7 +1,7 @@ { "Name": "JobConstraints", "ProtocolName": "Models.JobConstraints", - "Comment": "Specifies the execution constraints for a job.", + "SummaryComment": "Specifies the execution constraints for a job.", "Properties": [ { "Key": { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobExecutionInformation.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobExecutionInformation.json index 1288099510ab..3d253627925b 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobExecutionInformation.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobExecutionInformation.json @@ -1,7 +1,7 @@ { "Name": "JobExecutionInformation", "ProtocolName": "Models.JobExecutionInformation", - "Comment": "Information about the execution of an Azure Batch job.", + "SummaryComment": "Information about the execution of an Azure Batch job.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobManagerTask.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobManagerTask.json index 2822c5ed59c4..e07858352fba 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobManagerTask.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobManagerTask.json @@ -1,178 +1,179 @@ +{ + "Name": "JobManagerTask", + "ProtocolName": "Models.JobManagerTask", + "SummaryComment": "Represents an Azure Batch JobManager task.", + "RemarksComment": "Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the . Even if the is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing.", + "Properties": [ { - "Name": "JobManagerTask", - "ProtocolName": "Models.JobManagerTask", - "Comment": "Represents an Azure Batch JobManager task. ", - "Properties": [ - { - "Key": { - "Type": "bool?", - "Name": "AllowLowPriorityNode", - "SummaryComment": "Whether the Job Manager task may run on a low-priority compute node. If omitted, the default is false.", - "RemarksComment": null, - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "string", - "Name": "Id", - "SummaryComment": "The id of the task.", - "RemarksComment": null, - "BoundAccess": "read,write", - "UnboundAccess": "read,write", - "ConstructorArgumentType": "Required" - }, - "Value": null - }, - { - "Key": { - "Type": "string", - "Name": "CommandLine", - "SummaryComment": "The command line of the task.", - "RemarksComment": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux.", - "BoundAccess": "read,write", - "UnboundAccess": "read,write", - "ConstructorArgumentType": "Required" - }, - "Value": null - }, - { - "Key": { - "Type": "string", - "Name": "DisplayName", - "SummaryComment": "The display name of the JobManager task.", - "RemarksComment": null, - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "IList", - "Name": "EnvironmentSettings", - "SummaryComment": "A set of environment settings for the JobManager task.", - "RemarksComment": null, - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": { - "Type": "IList", - "Name": "EnvironmentSettings" - } - }, - { - "Key": { - "Type": "bool?", - "Name": "KillJobOnCompletion", - "SummaryComment": "A value that indicates whether to terminate all tasks in the job and complete the job when the job manager task completes.", - "RemarksComment": null, - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "IList", - "Name": "ResourceFiles", - "SummaryComment": "A list of files that the Batch service will download to the compute node before running the command line.", - "RemarksComment": null, - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": { - "Type": "IList", - "Name": "ResourceFiles" - } - }, - { - "Key": { - "Type": "IList", - "Name": "OutputFiles", - "SummaryComment": "A list of files that the Batch service will upload from the compute node after running the command line.", - "RemarksComment": null, - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": { - "Type": "IList", - "Name": "OutputFiles" - } - }, - { - "Key": { - "Type": "UserIdentity", - "Name": "UserIdentity", - "SummaryComment": "The user identity under which the task runs.", - "RemarksComment": "If omitted, the task runs as a non-administrative user unique to the task.", - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "bool?", - "Name": "RunExclusive", - "SummaryComment": "whether the Job Manager task requires exclusive use of the compute node where it runs.", - "RemarksComment": null, - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "TaskConstraints", - "Name": "Constraints", - "SummaryComment": "The execution constraints for this JobManager task.", - "RemarksComment": null, - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "IList", - "Name": "ApplicationPackageReferences", - "SummaryComment": "A list of application packages that the Batch service will deploy to the compute node before running the command line.", - "RemarksComment": null, - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": { - "Type": "IList", - "Name": "ApplicationPackageReferences" - } - }, - { - "Key": { - "Type": "AuthenticationTokenSettings", - "Name": "AuthenticationTokenSettings", - "SummaryComment": "The settings for an authentication token that the task can use to perform Batch service operations.", - "RemarksComment": "If this property is set, the Batch service provides the task with an authentication token which can be used to authenticate Batch service operations without requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the task can carry out using the token depend on the settings. For example, a task can request job permissions in order to add other tasks to the job, or check the status of the job or of other tasks.", - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": { - "Type": "Models.AuthenticationTokenSettings?", - "Name": "AuthenticationTokenSettings" - } - }, - { - "Key": { - "Type": "TaskContainerSettings", - "Name": "ContainerSettings", - "SummaryComment": "The settings for the container under which the task runs.", - "RemarksComment": "If the pool that will run this task has set, this must be set as well. If the pool that will run this task doesn't have set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.", - "BoundAccess": "read", - "UnboundAccess": "read,write" - }, - "Value": null - } - ] + "Key": { + "Type": "bool?", + "Name": "AllowLowPriorityNode", + "SummaryComment": "Whether the Job Manager task may run on a low-priority compute node. If omitted, the default is true.", + "RemarksComment": null, + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "Id", + "SummaryComment": "The id of the task.", + "RemarksComment": null, + "BoundAccess": "read,write", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Required" + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "CommandLine", + "SummaryComment": "The command line of the task.", + "RemarksComment": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variables (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).", + "BoundAccess": "read,write", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Required" + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "DisplayName", + "SummaryComment": "The display name of the JobManager task.", + "RemarksComment": null, + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "IList", + "Name": "EnvironmentSettings", + "SummaryComment": "A set of environment settings for the JobManager task.", + "RemarksComment": null, + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": { + "Type": "IList", + "Name": "EnvironmentSettings" + } + }, + { + "Key": { + "Type": "bool?", + "Name": "KillJobOnCompletion", + "SummaryComment": "A value that indicates whether to terminate all tasks in the job and complete the job when the job manager task completes.", + "RemarksComment": null, + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "IList", + "Name": "ResourceFiles", + "SummaryComment": "A list of files that the Batch service will download to the compute node before running the command line.", + "RemarksComment": null, + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": { + "Type": "IList", + "Name": "ResourceFiles" + } + }, + { + "Key": { + "Type": "IList", + "Name": "OutputFiles", + "SummaryComment": "A list of files that the Batch service will upload from the compute node after running the command line.", + "RemarksComment": null, + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": { + "Type": "IList", + "Name": "OutputFiles" + } + }, + { + "Key": { + "Type": "UserIdentity", + "Name": "UserIdentity", + "SummaryComment": "The user identity under which the task runs.", + "RemarksComment": "If omitted, the task runs as a non-administrative user unique to the task.", + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "bool?", + "Name": "RunExclusive", + "SummaryComment": "whether the Job Manager task requires exclusive use of the compute node where it runs.", + "RemarksComment": null, + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "TaskConstraints", + "Name": "Constraints", + "SummaryComment": "The execution constraints for this JobManager task.", + "RemarksComment": null, + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "IList", + "Name": "ApplicationPackageReferences", + "SummaryComment": "A list of application packages that the Batch service will deploy to the compute node before running the command line.", + "RemarksComment": null, + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": { + "Type": "IList", + "Name": "ApplicationPackageReferences" + } + }, + { + "Key": { + "Type": "AuthenticationTokenSettings", + "Name": "AuthenticationTokenSettings", + "SummaryComment": "The settings for an authentication token that the task can use to perform Batch service operations.", + "RemarksComment": "If this property is set, the Batch service provides the task with an authentication token which can be used to authenticate Batch service operations without requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the task can carry out using the token depend on the settings. For example, a task can request job permissions in order to add other tasks to the job, or check the status of the job or of other tasks.", + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": { + "Type": "Models.AuthenticationTokenSettings?", + "Name": "AuthenticationTokenSettings" + } + }, + { + "Key": { + "Type": "TaskContainerSettings", + "Name": "ContainerSettings", + "SummaryComment": "The settings for the container under which the task runs.", + "RemarksComment": "If the pool that will run this task has set, this must be set as well. If the pool that will run this task doesn't have set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.", + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": null } + ] +} diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobPreparationAndReleaseTaskExecutionInformation.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobPreparationAndReleaseTaskExecutionInformation.json index fd2384ced4bc..e725363912dd 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobPreparationAndReleaseTaskExecutionInformation.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobPreparationAndReleaseTaskExecutionInformation.json @@ -1,7 +1,7 @@ { "Name": "JobPreparationAndReleaseTaskExecutionInformation", "ProtocolName": "Models.JobPreparationAndReleaseTaskExecutionInformation", - "Comment": "The status of the Job Preparation task and Job Release task on a compute node.", + "SummaryComment": "The status of the Job Preparation task and Job Release task on a compute node.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobPreparationTask.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobPreparationTask.json index c67f7fee3e2e..70ba0118a184 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobPreparationTask.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobPreparationTask.json @@ -1,116 +1,117 @@ +{ + "Name": "JobPreparationTask", + "ProtocolName": "Models.JobPreparationTask", + "SummaryComment": "A Job Preparation task to run before any tasks of the job on any given compute node.", + "RemarksComment": "Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the . Even if the is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing.", + "Properties": [ { - "Name": "JobPreparationTask", - "ProtocolName": "Models.JobPreparationTask", - "Comment": "A Job Preparation task to run before any tasks of the job on any given compute node.", - "Properties": [ - { - "Key": { - "Type": "string", - "Name": "Id", - "SummaryComment": "The id of the task.", - "RemarksComment": null, - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "string", - "Name": "CommandLine", - "SummaryComment": "The command line of the task.", - "RemarksComment": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux.", - "BoundAccess": "read,write", - "UnboundAccess": "read,write", - "ConstructorArgumentType": "Required" - }, - "Value": null - }, - { - "Key": { - "Type": "IList", - "Name": "ResourceFiles", - "SummaryComment": "A list of files that the Batch service will download to the compute node before running the command line.", - "RemarksComment": null, - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": { - "Type": "IList", - "Name": "ResourceFiles" - } - }, - { - "Key": { - "Type": "IList", - "Name": "EnvironmentSettings", - "SummaryComment": "The collection of EnvironmentSetting instances.", - "RemarksComment": null, - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": { - "Type": "IList", - "Name": "EnvironmentSettings" - } - }, - { - "Key": { - "Type": "UserIdentity", - "Name": "UserIdentity", - "SummaryComment": "The user identity under which the task runs.", - "RemarksComment": "If omitted, the task runs as a non-administrative user unique to the task.", - "BoundAccess": "read", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "TaskConstraints", - "Name": "Constraints", - "SummaryComment": "The execution constraints provided by the user for this Job Preparation task.", - "RemarksComment": null, - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "bool?", - "Name": "WaitForSuccess", - "SummaryComment": "Whether the Batch service should wait for the successful completion of the Job Preparation task before scheduling any tasks on the compute node.", - "RemarksComment": "A Job Preparation task execution is considered successful if its ExitCode is 0. If this property is not specified, a default value of true is assigned by the Batch service.", - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "bool?", - "Name": "RerunOnComputeNodeRebootAfterSuccess", - "SummaryComment": "Whether the Batch service should rerun the Job Preparation task after a compute node reboots.", - "RemarksComment": "The Job Preparation task is always rerun if a compute node is reimaged, or if the Job Preparation task did not complete (e.g. because the reboot occurred while the task was running). Therefore, you should always write a Job Preparation task to be idempotent and to behave correctly if run multiple times. If this property is not specified, a default value of true is assigned by the Batch service.", - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": { - "Type": "bool?", - "Name": "RerunOnNodeRebootAfterSuccess" - } - }, - { - "Key": { - "Type": "TaskContainerSettings", - "Name": "ContainerSettings", - "SummaryComment": "The settings for the container under which the task runs.", - "RemarksComment": "When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.", - "BoundAccess": "read", - "UnboundAccess": "read,write" - }, - "Value": null - } - ] + "Key": { + "Type": "string", + "Name": "Id", + "SummaryComment": "The id of the task.", + "RemarksComment": null, + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "CommandLine", + "SummaryComment": "The command line of the task.", + "RemarksComment": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variables (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).", + "BoundAccess": "read,write", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Required" + }, + "Value": null + }, + { + "Key": { + "Type": "IList", + "Name": "ResourceFiles", + "SummaryComment": "A list of files that the Batch service will download to the compute node before running the command line.", + "RemarksComment": null, + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": { + "Type": "IList", + "Name": "ResourceFiles" + } + }, + { + "Key": { + "Type": "IList", + "Name": "EnvironmentSettings", + "SummaryComment": "The collection of EnvironmentSetting instances.", + "RemarksComment": null, + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": { + "Type": "IList", + "Name": "EnvironmentSettings" + } + }, + { + "Key": { + "Type": "UserIdentity", + "Name": "UserIdentity", + "SummaryComment": "The user identity under which the task runs.", + "RemarksComment": "If omitted, the task runs as a non-administrative user unique to the task.", + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "TaskConstraints", + "Name": "Constraints", + "SummaryComment": "The execution constraints provided by the user for this Job Preparation task.", + "RemarksComment": null, + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "bool?", + "Name": "WaitForSuccess", + "SummaryComment": "Whether the Batch service should wait for the successful completion of the Job Preparation task before scheduling any tasks on the compute node.", + "RemarksComment": "A Job Preparation task execution is considered successful if its ExitCode is 0. If this property is not specified, a default value of true is assigned by the Batch service.", + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "bool?", + "Name": "RerunOnComputeNodeRebootAfterSuccess", + "SummaryComment": "Whether the Batch service should rerun the Job Preparation task after a compute node reboots.", + "RemarksComment": "The Job Preparation task is always rerun if a compute node is reimaged, or if the Job Preparation task did not complete (e.g. because the reboot occurred while the task was running). Therefore, you should always write a Job Preparation task to be idempotent and to behave correctly if run multiple times. If this property is not specified, a default value of true is assigned by the Batch service.", + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": { + "Type": "bool?", + "Name": "RerunOnNodeRebootAfterSuccess" + } + }, + { + "Key": { + "Type": "TaskContainerSettings", + "Name": "ContainerSettings", + "SummaryComment": "The settings for the container under which the task runs.", + "RemarksComment": "When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.", + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": null } + ] +} diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobPreparationTaskExecutionInformation.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobPreparationTaskExecutionInformation.json index 96d0d2e25898..e5a38b4b5673 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobPreparationTaskExecutionInformation.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobPreparationTaskExecutionInformation.json @@ -1,7 +1,7 @@ { "Name": "JobPreparationTaskExecutionInformation", "ProtocolName": "Models.JobPreparationTaskExecutionInformation", - "Comment": "Details about the execution of a Job Preparation task on a compute node.", + "SummaryComment": "Details about the execution of a Job Preparation task on a compute node.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobReleaseTask.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobReleaseTask.json index d1b32901a5af..975953a0323c 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobReleaseTask.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobReleaseTask.json @@ -1,7 +1,7 @@ { "Name": "JobReleaseTask", "ProtocolName": "Models.JobReleaseTask", - "Comment": "A Job Release task to run on job completion on any compute node where the job has run.", + "SummaryComment": "A Job Release task to run on job completion on any compute node where the job has run.", "Properties": [ { "Key": { @@ -19,7 +19,7 @@ "Type": "string", "Name": "CommandLine", "SummaryComment": "The command line of the task.", - "RemarksComment": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux.", + "RemarksComment": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variables (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).", "BoundAccess": "read,write", "UnboundAccess": "read,write", "ConstructorArgumentType": "Required" diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobReleaseTaskExecutionInformation.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobReleaseTaskExecutionInformation.json index 36ab8738762e..a446f2bdb90d 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobReleaseTaskExecutionInformation.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobReleaseTaskExecutionInformation.json @@ -1,7 +1,7 @@ { "Name": "JobReleaseTaskExecutionInformation", "ProtocolName": "Models.JobReleaseTaskExecutionInformation", - "Comment": "Details about the execution of a Job Release task on a compute node.", + "SummaryComment": "Details about the execution of a Job Release task on a compute node.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobScheduleExecutionInformation.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobScheduleExecutionInformation.json index ac9eed6fcf49..b159d7bd9cbe 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobScheduleExecutionInformation.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobScheduleExecutionInformation.json @@ -1,7 +1,7 @@ { "Name": "JobScheduleExecutionInformation", "ProtocolName": "Models.JobScheduleExecutionInformation", - "Comment": "The execution information for a job schedule.", + "SummaryComment": "The execution information for a job schedule.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobScheduleStatistics.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobScheduleStatistics.json index cd24cb6fd95a..ab65244f7e1d 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobScheduleStatistics.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobScheduleStatistics.json @@ -1,7 +1,7 @@ { "Name": "JobScheduleStatistics", "ProtocolName": "Models.JobScheduleStatistics", - "Comment": "Resource usage statistics for a .", + "SummaryComment": "Resource usage statistics for a .", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobSchedulingError.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobSchedulingError.json index 57f3974c631b..ad3ad37aec27 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobSchedulingError.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobSchedulingError.json @@ -1,7 +1,7 @@ { "Name": "JobSchedulingError", "ProtocolName": "Models.JobSchedulingError", - "Comment": "An error encountered by the Batch service when scheduling a job.", + "SummaryComment": "An error encountered by the Batch service when scheduling a job.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobSpecification.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobSpecification.json index 466d0a6f7186..c3e692d85f87 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobSpecification.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobSpecification.json @@ -1,7 +1,7 @@ { "Name": "JobSpecification", "ProtocolName": "Models.JobSpecification", - "Comment": "The of a .", + "SummaryComment": "The of a .", "Properties": [ { "Key": { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobStatistics.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobStatistics.json index da365da6a330..ea23a25fe723 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobStatistics.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/JobStatistics.json @@ -1,7 +1,7 @@ { "Name": "JobStatistics", "ProtocolName": "Models.JobStatistics", - "Comment": "Resource usage statistics for the job.", + "SummaryComment": "Resource usage statistics for the job.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/LinuxUserConfiguration.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/LinuxUserConfiguration.json index a869e71826c4..ca0d26065cad 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/LinuxUserConfiguration.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/LinuxUserConfiguration.json @@ -1,7 +1,7 @@ { "Name": "LinuxUserConfiguration", "ProtocolName": "Models.LinuxUserConfiguration", - "Comment": "Properties used to create a user account on a Linux node.", + "SummaryComment": "Properties used to create a user account on a Linux node.", "IsConstructorPublic": true, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/MetadataItem.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/MetadataItem.json index 5b6bcc16d67a..b578ccfbb996 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/MetadataItem.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/MetadataItem.json @@ -1,7 +1,7 @@ { "Name": "MetadataItem", "ProtocolName": "Models.MetadataItem", - "Comment": "A name-value pair associated with a Batch service resource. The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.", + "SummaryComment": "A name-value pair associated with a Batch service resource. The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.", "IsUsedInCollections": true, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/MultiInstanceSettings.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/MultiInstanceSettings.json index edd3fa7e2067..ccb88e5b3089 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/MultiInstanceSettings.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/MultiInstanceSettings.json @@ -1,7 +1,7 @@ { "Name": "MultiInstanceSettings", "ProtocolName": "Models.MultiInstanceSettings", - "Comment": "Settings which specify how to run a multi-instance task. Multi-instance tasks are commonly used to support MPI tasks. For more information see https://azure.microsoft.com/documentation/articles/batch-mpi/.", + "SummaryComment": "Settings which specify how to run a multi-instance task. Multi-instance tasks are commonly used to support MPI tasks. For more information see https://azure.microsoft.com/documentation/articles/batch-mpi/.", "Properties": [ { "Key": { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/NameValuePair.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/NameValuePair.json index a12ebfdf66f8..b176241fe0e8 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/NameValuePair.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/NameValuePair.json @@ -1,7 +1,7 @@ { "Name": "NameValuePair", "ProtocolName": "Models.NameValuePair", - "Comment": "Represents a name-value pair.", + "SummaryComment": "Represents a name-value pair.", "IsUsedInCollections": true, "IsConstructorPublic": false, "Properties": [ diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/NetworkConfiguration.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/NetworkConfiguration.json index 4da2e20fd40f..2595a4cd892a 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/NetworkConfiguration.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/NetworkConfiguration.json @@ -1,7 +1,7 @@ { "Name": "NetworkConfiguration", "ProtocolName": "Models.NetworkConfiguration", - "Comment": "The network configuration for a pool.", + "SummaryComment": "The network configuration for a pool.", "Properties": [ { "Key": { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/NetworkSecurityGroupRule.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/NetworkSecurityGroupRule.json index 631ed43039bd..a7ab95c9bace 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/NetworkSecurityGroupRule.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/NetworkSecurityGroupRule.json @@ -1,7 +1,7 @@ { "Name": "NetworkSecurityGroupRule", "ProtocolName": "Models.NetworkSecurityGroupRule", - "Comment": "A network security group rule to apply to an inbound endpoint.", + "SummaryComment": "A network security group rule to apply to an inbound endpoint.", "IsUsedInCollections": true, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/NodeAgentSku.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/NodeAgentSku.json index aa68bbe4c174..80339658fae1 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/NodeAgentSku.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/NodeAgentSku.json @@ -1,7 +1,7 @@ { "Name": "NodeAgentSku", "ProtocolName": "Models.NodeAgentSku", - "Comment": "A node agent SKU supported by the Batch service. The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems.", + "SummaryComment": "A node agent SKU supported by the Batch service. The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/NodeCounts.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/NodeCounts.json index 369550379a84..0d787e4b522c 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/NodeCounts.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/NodeCounts.json @@ -1,7 +1,7 @@ { "Name": "NodeCounts", "ProtocolName": "Models.NodeCounts", - "Comment": "The number of nodes in each node state.", + "SummaryComment": "The number of nodes in each node state.", "IsConstructorPublic": false, "Properties": [ { @@ -136,6 +136,17 @@ }, "Value": null }, + { + "Key": { + "Type": "int", + "Name": "LeavingPool", + "SummaryComment": "The number of nodes in .", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "none" + }, + "Value": null + }, { "Key": { "Type": "int", diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/OSDisk.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/OSDisk.json index aa91c9d5ebd5..65ce3b4abd18 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/OSDisk.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/OSDisk.json @@ -1,7 +1,7 @@ { "Name": "OSDisk", "ProtocolName": "Models.OSDisk", - "Comment": "Settings for the operating system disk of the virtual machine.", + "SummaryComment": "Settings for the operating system disk of the virtual machine.", "IsConstructorPublic": true, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/OutputFile.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/OutputFile.json index 508376abb2cf..38e77a82a6dc 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/OutputFile.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/OutputFile.json @@ -1,7 +1,7 @@ { "Name": "OutputFile", "ProtocolName": "Models.OutputFile", - "Comment": "A specification for uploading files from an Azure Batch node to another location after the Batch service has finished executing the task process.", + "SummaryComment": "A specification for uploading files from an Azure Batch node to another location after the Batch service has finished executing the task process.", "IsConstructorPublic": true, "IsUsedInCollections": true, "Properties": [ diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/OutputFileBlobContainerDestination.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/OutputFileBlobContainerDestination.json index c2b26a555b32..b9cd212a8ca2 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/OutputFileBlobContainerDestination.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/OutputFileBlobContainerDestination.json @@ -1,7 +1,7 @@ { "Name": "OutputFileBlobContainerDestination", "ProtocolName": "Models.OutputFileBlobContainerDestination", - "Comment": "Specifies a file upload destination within an Azure blob storage container.", + "SummaryComment": "Specifies a file upload destination within an Azure blob storage container.", "IsConstructorPublic": true, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/OutputFileDestination.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/OutputFileDestination.json index 3b817cd3c4ed..112d781f5481 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/OutputFileDestination.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/OutputFileDestination.json @@ -1,7 +1,7 @@ { "Name": "OutputFileDestination", "ProtocolName": "Models.OutputFileDestination", - "Comment": "The destination to which a file should be uploaded.", + "SummaryComment": "The destination to which a file should be uploaded.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/OutputFileUploadOptions.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/OutputFileUploadOptions.json index ec864675684d..b3f4a1f064a5 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/OutputFileUploadOptions.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/OutputFileUploadOptions.json @@ -1,7 +1,7 @@ { "Name": "OutputFileUploadOptions", "ProtocolName": "Models.OutputFileUploadOptions", - "Comment": "Details about an output file upload operation, including under what conditions to perform the upload.", + "SummaryComment": "Details about an output file upload operation, including under what conditions to perform the upload.", "IsConstructorPublic": true, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolEndpointConfiguration.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolEndpointConfiguration.json index b51083d4be17..fcecd681aafa 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolEndpointConfiguration.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolEndpointConfiguration.json @@ -1,7 +1,7 @@ { "Name": "PoolEndpointConfiguration", "ProtocolName": "Models.PoolEndpointConfiguration", - "Comment": "The endpoint configuration for a pool.", + "SummaryComment": "The endpoint configuration for a pool.", "Properties": [ { "Key": { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolInformation.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolInformation.json index dcf8332a7b28..799e12594f77 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolInformation.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolInformation.json @@ -1,7 +1,7 @@ { "Name": "PoolInformation", "ProtocolName": "Models.PoolInformation", - "Comment": "Specifies how a job should be assigned to a pool.", + "SummaryComment": "Specifies how a job should be assigned to a pool.", "Properties": [ { "Key": { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolNodeCounts.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolNodeCounts.json index b384914325bd..98b42a570636 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolNodeCounts.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolNodeCounts.json @@ -1,7 +1,7 @@ { "Name": "PoolNodeCounts", "ProtocolName": "Models.PoolNodeCounts", - "Comment": "A pool in the Azure Batch service.", + "SummaryComment": "A pool in the Azure Batch service.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolSpecification.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolSpecification.json index 6884b7352465..5d5aa52040bd 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolSpecification.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolSpecification.json @@ -1,7 +1,7 @@ { "Name": "PoolSpecification", "ProtocolName": "Models.PoolSpecification", - "Comment": "The specification for a pool.", + "SummaryComment": "The specification for a pool.", "Properties": [ { "Key": { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolStatistics.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolStatistics.json index 704cd3bb93b9..8d6207aa4514 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolStatistics.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolStatistics.json @@ -1,7 +1,7 @@ { "Name": "PoolStatistics", "ProtocolName": "Models.PoolStatistics", - "Comment": "Contains utilization and resource usage statistics for the lifetime of a pool.", + "SummaryComment": "Contains utilization and resource usage statistics for the lifetime of a pool.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolUsageMetrics.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolUsageMetrics.json index 5a9dac161eef..db948f733eab 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolUsageMetrics.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/PoolUsageMetrics.json @@ -1,7 +1,7 @@ { "Name": "PoolUsageMetrics", "ProtocolName": "Models.PoolUsageMetrics", - "Comment": "The usage metrics for a single pool in a certain time range.", + "SummaryComment": "The usage metrics for a single pool in a certain time range.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/RecentJob.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/RecentJob.json index cabad4ea49e8..bc1916e24433 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/RecentJob.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/RecentJob.json @@ -1,7 +1,7 @@ { "Name": "RecentJob", "ProtocolName": "Models.RecentJob", - "Comment": "Information about the most recent job under a job schedule.", + "SummaryComment": "Information about the most recent job under a job schedule.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/RemoteLoginSettings.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/RemoteLoginSettings.json index 7c6e9c79bfc6..68cb9d53306d 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/RemoteLoginSettings.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/RemoteLoginSettings.json @@ -1,7 +1,7 @@ { "Name": "RemoteLoginSettings", "ProtocolName": "Models.ComputeNodeGetRemoteLoginSettingsResult", - "Comment": "Gets the settings required for remote login to a compute node.", + "SummaryComment": "Gets the settings required for remote login to a compute node.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ResizeError.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ResizeError.json index d1649e78bd6f..042769b702d7 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ResizeError.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ResizeError.json @@ -1,7 +1,7 @@ { "Name": "ResizeError", "ProtocolName": "Models.ResizeError", - "Comment": "An error that occurred when resizing a pool.", + "SummaryComment": "An error that occurred when resizing a pool.", "IsConstructorPublic": false, "IsUsedInCollections": true, "Properties": [ diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ResourceFile.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ResourceFile.json index c434588532f0..4f666e4acf37 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ResourceFile.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ResourceFile.json @@ -1,7 +1,7 @@ { "Name": "ResourceFile", "ProtocolName": "Models.ResourceFile", - "Comment": "A file to be downloaded to a compute node from Azure Blob Storage, such as task executables and task input data files.", + "SummaryComment": "A file to be downloaded to a compute node from Azure Blob Storage, such as task executables and task input data files.", "IsUsedInCollections": true, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ResourceStatistics.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ResourceStatistics.json index 78c2c699fac8..0d6eddde2545 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ResourceStatistics.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/ResourceStatistics.json @@ -1,7 +1,7 @@ { "Name": "ResourceStatistics", "ProtocolName": "Models.ResourceStatistics", - "Comment": "The resource statistics data for the pool.", + "SummaryComment": "The resource statistics data for the pool.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/Schedule.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/Schedule.json index 39bc698d4c59..492d175a771d 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/Schedule.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/Schedule.json @@ -1,7 +1,7 @@ { "Name": "Schedule", "ProtocolName": "Models.Schedule", - "Comment": "A schedule.", + "SummaryComment": "A schedule.", "Properties": [ { "Key": { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/StartTask.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/StartTask.json index a4e96dbe3824..b11f026da2f4 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/StartTask.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/StartTask.json @@ -1,91 +1,92 @@ +{ + "Name": "StartTask", + "ProtocolName": "Models.StartTask", + "SummaryComment": "A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged.", + "RemarksComment": "Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the . Even if the is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing.", + "Properties": [ { - "Name": "StartTask", - "ProtocolName": "Models.StartTask", - "Comment": "A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged.", - "Properties": [ - { - "Key": { - "Type": "string", - "Name": "CommandLine", - "SummaryComment": "The command line of the task.", - "RemarksComment": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux.", - "BoundAccess": "read,write", - "UnboundAccess": "read,write", - "ConstructorArgumentType": "Required" - }, - "Value": null - }, - { - "Key": { - "Type": "IList", - "Name": "EnvironmentSettings", - "SummaryComment": "A set of environment settings for the start task.", - "RemarksComment": null, - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": { - "Type": "IList", - "Name": "EnvironmentSettings" - } - }, - { - "Key": { - "Type": "int?", - "Name": "MaxTaskRetryCount", - "SummaryComment": "The maximum number of retries for the task.", - "RemarksComment": null, - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "IList", - "Name": "ResourceFiles", - "SummaryComment": "A list of files that the Batch service will download to the compute node before running the command line.", - "RemarksComment": null, - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": { - "Type": "IList", - "Name": "ResourceFiles" - } - }, - { - "Key": { - "Type": "UserIdentity", - "Name": "UserIdentity", - "SummaryComment": "The user identity under which the task runs.", - "RemarksComment": "If omitted, the task runs as a non-administrative user unique to the task.", - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "bool?", - "Name": "WaitForSuccess", - "SummaryComment": "A value indicating whether the Batch service should wait for the start task to complete before scheduling any tasks on the compute node.", - "RemarksComment": "If this is not specified, the default is false.", - "BoundAccess": "read,write", - "UnboundAccess": "read,write" - }, - "Value": null - }, - { - "Key": { - "Type": "TaskContainerSettings", - "Name": "ContainerSettings", - "SummaryComment": "The settings for the container under which the task runs.", - "RemarksComment": "When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.", - "BoundAccess": "read", - "UnboundAccess": "read,write" - }, - "Value": null - } - ] + "Key": { + "Type": "string", + "Name": "CommandLine", + "SummaryComment": "The command line of the task.", + "RemarksComment": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variables (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).", + "BoundAccess": "read,write", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Required" + }, + "Value": null + }, + { + "Key": { + "Type": "IList", + "Name": "EnvironmentSettings", + "SummaryComment": "A set of environment settings for the start task.", + "RemarksComment": null, + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": { + "Type": "IList", + "Name": "EnvironmentSettings" + } + }, + { + "Key": { + "Type": "int?", + "Name": "MaxTaskRetryCount", + "SummaryComment": "The maximum number of retries for the task.", + "RemarksComment": null, + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "IList", + "Name": "ResourceFiles", + "SummaryComment": "A list of files that the Batch service will download to the compute node before running the command line.", + "RemarksComment": null, + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": { + "Type": "IList", + "Name": "ResourceFiles" + } + }, + { + "Key": { + "Type": "UserIdentity", + "Name": "UserIdentity", + "SummaryComment": "The user identity under which the task runs.", + "RemarksComment": "If omitted, the task runs as a non-administrative user unique to the task.", + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "bool?", + "Name": "WaitForSuccess", + "SummaryComment": "A value indicating whether the Batch service should wait for the start task to complete before scheduling any tasks on the compute node.", + "RemarksComment": "If this is not specified, the default is false.", + "BoundAccess": "read,write", + "UnboundAccess": "read,write" + }, + "Value": null + }, + { + "Key": { + "Type": "TaskContainerSettings", + "Name": "ContainerSettings", + "SummaryComment": "The settings for the container under which the task runs.", + "RemarksComment": "When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.", + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": null } + ] +} diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/StartTaskInformation.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/StartTaskInformation.json index 72f0baaf125a..f3bd2475e4ec 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/StartTaskInformation.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/StartTaskInformation.json @@ -1,7 +1,7 @@ { "Name": "StartTaskInformation", "ProtocolName": "Models.StartTaskInformation", - "Comment": "Specifies the detailed runtime information of the start task, including current state, error details, exit code, start time, end time, etc.", + "SummaryComment": "Specifies the detailed runtime information of the start task, including current state, error details, exit code, start time, end time, etc.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/SubtaskInformation.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/SubtaskInformation.json index 9bde09eb2a18..234e4fce27f0 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/SubtaskInformation.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/SubtaskInformation.json @@ -1,7 +1,7 @@ { "Name": "SubtaskInformation", "ProtocolName": "Models.SubtaskInformation", - "Comment": "Information about an Azure Batch subtask.", + "SummaryComment": "Information about an Azure Batch subtask.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskConstraints.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskConstraints.json index 8f7313e6397b..53c9863b6349 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskConstraints.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskConstraints.json @@ -1,7 +1,7 @@ { "Name": "TaskConstraints", "ProtocolName": "Models.TaskConstraints", - "Comment": "Defines the constraints on a particular Azure Batch task.", + "SummaryComment": "Defines the constraints on a particular Azure Batch task.", "Properties": [ { "Key": { @@ -32,7 +32,7 @@ "Type": "int?", "Name": "MaxTaskRetryCount", "SummaryComment": "The maximum number of retries for the task.", - "RemarksComment": null, + "RemarksComment": "Note that this value specifically controls the number of retries for the task executable due to a nonzero exit code. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task after the first attempt. If the maximum retry count is -1, the Batch service retries the task without limit. Resource files and application packages are only downloaded again if the task is retried on a new compute node.", "BoundAccess": "read,write", "UnboundAccess": "read,write", "ConstructorArgumentType": "Optional" diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskContainerExecutionInformation.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskContainerExecutionInformation.json index a64b714e136f..e75eb418f612 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskContainerExecutionInformation.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskContainerExecutionInformation.json @@ -1,7 +1,7 @@ { "Name": "TaskContainerExecutionInformation", "ProtocolName": "Models.TaskContainerExecutionInformation", - "Comment": "Contains information about the container which a task is executing.", + "SummaryComment": "Contains information about the container which a task is executing.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskContainerSettings.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskContainerSettings.json index 5082416aa1a7..de30fcf179d0 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskContainerSettings.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskContainerSettings.json @@ -1,7 +1,7 @@ { "Name": "TaskContainerSettings", "ProtocolName": "Models.TaskContainerSettings", - "Comment": "The container settings for a task.", + "SummaryComment": "The container settings for a task.", "IsConstructorPublic": true, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskCounts.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskCounts.json index 30cd8a32570c..e069bde241fb 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskCounts.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskCounts.json @@ -1,7 +1,7 @@ { "Name": "TaskCounts", "ProtocolName": "Models.TaskCounts", - "Comment": "The task counts for a job.", + "SummaryComment": "The task counts for a job.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskDependencies.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskDependencies.json index 251f29a3e71a..7cb4fcfb8d36 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskDependencies.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskDependencies.json @@ -1,7 +1,7 @@ { "Name": "TaskDependencies", "ProtocolName": "Models.TaskDependencies", - "Comment": "Specifies any dependencies of a task. Any task that is explicitly specified or within a dependency range must complete before the dependant task will be scheduled.", + "SummaryComment": "Specifies any dependencies of a task. Any task that is explicitly specified or within a dependency range must complete before the dependant task will be scheduled.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskExecutionInformation.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskExecutionInformation.json index 18e0d157195a..0835c7b8c1b4 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskExecutionInformation.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskExecutionInformation.json @@ -1,7 +1,7 @@ { "Name": "TaskExecutionInformation", "ProtocolName": "Models.TaskExecutionInformation", - "Comment": "Task execution information.", + "SummaryComment": "Task execution information.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskFailureInfo.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskFailureInfo.json index 7027c7e5094d..232ce41f6c01 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskFailureInfo.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskFailureInfo.json @@ -1,7 +1,7 @@ { "Name": "TaskFailureInformation", "ProtocolName": "Models.TaskFailureInformation", - "Comment": "Information about a task failure.", + "SummaryComment": "Information about a task failure.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskIdRange.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskIdRange.json index 9e4a820bda1a..ff8801866cfc 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskIdRange.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskIdRange.json @@ -1,7 +1,7 @@ { "Name": "TaskIdRange", "ProtocolName": "Models.TaskIdRange", - "Comment": "A range of task ids that a depends on. All tasks with ids in the range must complete successfully before the dependent task can be scheduled.", + "SummaryComment": "A range of task ids that a depends on. All tasks with ids in the range must complete successfully before the dependent task can be scheduled.", "IsConstructorPublic": false, "IsUsedInCollections": true, "Properties": [ diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskInformation.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskInformation.json index 58aa1b5fbcf4..b73f61647279 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskInformation.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskInformation.json @@ -1,7 +1,7 @@ { "Name": "TaskInformation", "ProtocolName": "Models.TaskInformation", - "Comment": "The compute node's task info class.", + "SummaryComment": "The compute node's task info class.", "IsConstructorPublic": false, "IsUsedInCollections": true, "Properties": [ diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskSchedulingPolicy.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskSchedulingPolicy.json index 95cad01c44bb..c00870f193bc 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskSchedulingPolicy.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskSchedulingPolicy.json @@ -1,7 +1,7 @@ { "Name": "TaskSchedulingPolicy", "ProtocolName": "Models.TaskSchedulingPolicy", - "Comment": "A scheduling policy for a compute node.", + "SummaryComment": "A scheduling policy for a compute node.", "Properties": [ { "Key": { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskStatistics.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskStatistics.json index 638373248c89..bd8b95b8bb73 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskStatistics.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/TaskStatistics.json @@ -1,7 +1,7 @@ { "Name": "TaskStatistics", "ProtocolName": "Models.TaskStatistics", - "Comment": "Resource usage statistics for the task.", + "SummaryComment": "Resource usage statistics for the task.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/UploadBatchServiceLogsResult.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/UploadBatchServiceLogsResult.json index 56e1626d63c1..36a0450ec7f6 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/UploadBatchServiceLogsResult.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/UploadBatchServiceLogsResult.json @@ -1,7 +1,7 @@ { "Name": "UploadBatchServiceLogsResult", "ProtocolName": "Models.UploadBatchServiceLogsResult", - "Comment": "The result of uploading batch service log files from a specific compute node.", + "SummaryComment": "The result of uploading batch service log files from a specific compute node.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/UsageStatistics.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/UsageStatistics.json index 73c63fb4fd55..7b4b7252eccd 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/UsageStatistics.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/UsageStatistics.json @@ -1,7 +1,7 @@ { "Name": "UsageStatistics", "ProtocolName": "Models.UsageStatistics", - "Comment": "Statistics related to pool usage data.", + "SummaryComment": "Statistics related to pool usage data.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/UserAccount.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/UserAccount.json index 0784f304cdf7..3d0ab1b332f3 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/UserAccount.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/UserAccount.json @@ -1,7 +1,7 @@ { "Name": "UserAccount", "ProtocolName": "Models.UserAccount", - "Comment": "A user account to create on an Azure Batch node. Tasks may be configured to execute in the security context of the user account.", + "SummaryComment": "A user account to create on an Azure Batch node. Tasks may be configured to execute in the security context of the user account.", "IsConstructorPublic": true, "IsUsedInCollections": true, "Properties": [ diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/UserIdentity.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/UserIdentity.json index 7797069adb9b..cd41af4b7e00 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/UserIdentity.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/UserIdentity.json @@ -1,7 +1,7 @@ { "Name": "UserIdentity", "ProtocolName": "Models.UserIdentity", - "Comment": "The definition of the user identity under which the task is run.", + "SummaryComment": "The definition of the user identity under which the task is run. On CloudServiceConfiguration pools, this user is logged in with the INTERACTIVE flag. On Windows VirtualMachineConfiguration pools, this user is logged in with the BATCH flag.", "IsConstructorPublic": false, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/VirtualMachineConfiguration.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/VirtualMachineConfiguration.json index dc507b1af7de..9959ebc0da14 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/VirtualMachineConfiguration.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/VirtualMachineConfiguration.json @@ -1,7 +1,7 @@ { "Name": "VirtualMachineConfiguration", "ProtocolName": "Models.VirtualMachineConfiguration", - "Comment": "The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.", + "SummaryComment": "The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.", "ForceConstructorOrder": true, "Properties": [ { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/WindowsConfiguration.json b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/WindowsConfiguration.json index dff77e0d39cc..d54d5bca38b9 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/WindowsConfiguration.json +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/Spec/WindowsConfiguration.json @@ -1,7 +1,7 @@ { "Name": "WindowsConfiguration", "ProtocolName": "Models.WindowsConfiguration", - "Comment": "Windows operating system settings to apply to the virtual machine.", + "SummaryComment": "Windows operating system settings to apply to the virtual machine.", "Properties": [ { "Key": { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/StaticReadOnlyClassTemplate.cs b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/StaticReadOnlyClassTemplate.cs index b26b8fdca0db..0ded693312a4 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/StaticReadOnlyClassTemplate.cs +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/StaticReadOnlyClassTemplate.cs @@ -28,8 +28,19 @@ public partial class StaticReadOnlyClassTemplate : StaticReadOnlyClassTemplateBa public virtual string TransformText() { this.Write(" /// \r\n"); - this.Write(this.ToStringHelper.ToStringWithCulture(CommentUtilities.FormatTripleSlashComment(type.Comment, CommentUtilities.Indentation.TypeLevel))); - this.Write("\r\n /// \r\n public partial class "); + this.Write(this.ToStringHelper.ToStringWithCulture(CommentUtilities.FormatTripleSlashComment(type.SummaryComment, CommentUtilities.Indentation.TypeLevel))); + this.Write("\r\n /// \r\n"); + +if (!string.IsNullOrEmpty(type.RemarksComment)) +{ + + this.Write(" /// \r\n"); + this.Write(this.ToStringHelper.ToStringWithCulture(CommentUtilities.FormatTripleSlashComment(type.RemarksComment, CommentUtilities.Indentation.TypeLevel))); + this.Write("\r\n /// \r\n"); + +} + + this.Write(" public partial class "); this.Write(this.ToStringHelper.ToStringWithCulture(type.Name)); this.Write(" :"); if(type.ShouldDefineGetTransportObject) { diff --git a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/StaticReadOnlyClassTemplate.tt b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/StaticReadOnlyClassTemplate.tt index ce848ac81fbd..45aa711c41eb 100644 --- a/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/StaticReadOnlyClassTemplate.tt +++ b/src/SDKs/Batch/DataPlane/Tools/ObjectModelCodeGeneration/ObjectModelCodeGenerator/StaticReadOnlyClassTemplate.tt @@ -8,8 +8,18 @@ <#@ import namespace="CodeGenerationLibrary" #> <#@ parameter type="CodeGenerationLibrary.ObjectModelTypeData" name="type" #> /// -<#= CommentUtilities.FormatTripleSlashComment(type.Comment, CommentUtilities.Indentation.TypeLevel) #> +<#= CommentUtilities.FormatTripleSlashComment(type.SummaryComment, CommentUtilities.Indentation.TypeLevel) #> /// +<# +if (!string.IsNullOrEmpty(type.RemarksComment)) +{ +#> + /// +<#= CommentUtilities.FormatTripleSlashComment(type.RemarksComment, CommentUtilities.Indentation.TypeLevel) #> + /// +<# +} +#> public partial class <#= type.Name #> :<# if(type.ShouldDefineGetTransportObject) { #> ITransportObjectProvider<<#= type.TransportObjectTypeName #>>,<# } #> IPropertyMetadata { #region Constructors diff --git a/src/SDKs/Batch/DataPlane/changelog.md b/src/SDKs/Batch/DataPlane/changelog.md index 63dbe3080299..bd37cf5807b0 100644 --- a/src/SDKs/Batch/DataPlane/changelog.md +++ b/src/SDKs/Batch/DataPlane/changelog.md @@ -1,5 +1,13 @@ # Azure.Batch release notes +## Changes in 8.1.1 +### Bug fixes + - Fixed bug where LeavingPool state was not correctly returned via the `ListPoolNodeCounts` method on `PoolOperations`. + - Clarified various confusing documentation. + +### REST API version +This version of the Batch .NET client library targets version 2018-02-01.6.1 of the Azure Batch REST API. + ## Changes in 8.1.0 ### Features - Added the ability to query pool node counts by state, via the new `ListPoolNodeCounts` method on `PoolOperations`. @@ -10,7 +18,7 @@ This version of the Batch .NET client library targets version 2018-02-01.6.1 of the Azure Batch REST API. ### Import Note -The package will be renamed to Microsoft.Azure.Batch in future release. +The package will be renamed to Microsoft.Azure.Batch in a future release. ## Changes in 8.0.1 ### Bug fixes diff --git a/src/SDKs/_metadata/batch_data-plane.txt b/src/SDKs/_metadata/batch_data-plane.txt index 9fecf9643f93..f4f5911191fb 100644 --- a/src/SDKs/_metadata/batch_data-plane.txt +++ b/src/SDKs/_metadata/batch_data-plane.txt @@ -1,11 +1,11 @@ -2018-02-05 22:01:00 UTC +2018-04-24 22:42:09 UTC 1) azure-rest-api-specs repository information -GitHub user: xingwu1 +GitHub user: Azure Branch: master -Commit: 8461020530ea9797845d73617e52bb42ccb4c0ca +Commit: e6d46513662f00ab4d0d560ab710be4a849609c3 2) AutoRest information Requested version: latest -Bootstrapper version: C:\Users\matthchr\AppData\Roaming\npm `-- autorest@2.0.4245 +Bootstrapper version: C:\Users\matthchr\AppData\Roaming\npm `-- autorest@2.0.4262 Latest installed version: