diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 891dec1d31b6..0eea9398ef86 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -22,7 +22,7 @@ /sdk/eventgrid/ @kalyanaj -/sdk/eventhub/ @serkantkaraca +/sdk/eventhub/ @serkantkaraca @jsquire @kinelski /sdk/eventhub/azure.messaging.eventhubs/ @jsquire @kinelski /sdk/identity/azure.identity/ @schaabs @@ -31,7 +31,7 @@ /sdk/keyvault/azure.*/ @schaabs @shahabhijeet /sdk/search/ @brjohnstmsft -/sdk/servicebus/ @nemakam +/sdk/servicebus/ @nemakam @jsquire /sdk/storage/ @kfarmer-msft @seanmcc-msft @tg-msft # Management Plane /**/*Management*/ @erich-wang diff --git a/eng/Directory.Build.Data.props b/eng/Directory.Build.Data.props index 979c7daa2b71..18f8a9c261e4 100644 --- a/eng/Directory.Build.Data.props +++ b/eng/Directory.Build.Data.props @@ -108,7 +108,7 @@ false false false - true + false preview $(IntermediateOutputPath)$(TargetFramework)\$(MSBuildProjectName).xml diff --git a/eng/Packages.Data.props b/eng/Packages.Data.props index 5be423b5a17f..89694924ebd6 100755 --- a/eng/Packages.Data.props +++ b/eng/Packages.Data.props @@ -9,7 +9,8 @@ - + + diff --git a/eng/mgmt/mgmtmetadata/search_data-plane_Microsoft.Azure.Search.Service.txt b/eng/mgmt/mgmtmetadata/search_data-plane_Microsoft.Azure.Search.Service.txt index e84e664eb864..66accf64b1ae 100644 --- a/eng/mgmt/mgmtmetadata/search_data-plane_Microsoft.Azure.Search.Service.txt +++ b/eng/mgmt/mgmtmetadata/search_data-plane_Microsoft.Azure.Search.Service.txt @@ -3,12 +3,12 @@ AutoRest installed successfully. Commencing code generation Generating CSharp code Executing AutoRest command -cmd.exe /c autorest.cmd https://github.com/Azure/azure-rest-api-specs/blob/master/specification/search/data-plane/Microsoft.Azure.Search.Service/readme.md --csharp --version=latest --reflect-api-versions --csharp-sdks-folder=C:\repos\azure-sdk-for-net\sdk -2019-07-25 22:29:05 UTC +cmd.exe /c autorest.cmd https://github.com/Azure/azure-rest-api-specs/blob/master/specification/search/data-plane/Microsoft.Azure.Search.Service/readme.md --csharp --version=latest --reflect-api-versions --csharp-sdks-folder=D:\src\azure-sdk-for-net\sdk +2019-08-01 17:40:34 UTC Azure-rest-api-specs repository information GitHub fork: Azure Branch: master -Commit: a28a3fca492d332b0e515f0017551cb692772b29 +Commit: 39c47bb0623a056d760175c63688d688e0020faa AutoRest information Requested version: latest Bootstrapper version: autorest@2.0.4283 diff --git a/packages.md b/packages.md old mode 100644 new mode 100755 index fd7b542b8570..779ddd7bf96a --- a/packages.md +++ b/packages.md @@ -8,8 +8,7 @@ | [`Azure.Core`]( sdk/core/Azure.Core/src/Azure.Core.csproj )| [Readme](sdk/core/Azure.Core/README.md) | N/A | [Nuget]( https://www.nuget.org/packages/Azure.Core/ ) | | [`Azure.Core.Extensions`]( sdk/core/Azure.Core.Extensions/src/Azure.Core.Extensions.csproj )| N/A | N/A | [Nuget]( https://www.nuget.org/packages/Azure.Core.Extensions/ ) | | [`Azure.Identity`]( sdk/identity/Azure.Identity/src/Azure.Identity.csproj )| [Readme](sdk/identity/Azure.Identity/README.md) | N/A | [Nuget]( https://www.nuget.org/packages/Azure.Identity/ ) | -| [`Azure.Messaging.EventHubs`]( sdk/eventhub/Azure.Messaging.EventHubs/src/Azure.Messaging.EventHubs.csproj )| [Readme](sdk/eventhub/Azure.Messaging.EventHubs/README.md) | N/A | [Nuget]( https://www.nuget.org/packages/Azure.Messaging.EventHubs/ ) | -| [`Azure.Messaging.EventHubs.TrackOne`]( sdk/eventhub/Azure.Messaging.EventHubs/src/TrackOneClient/Azure.Messaging.EventHubs.TrackOne.csproj )| [Readme](sdk/eventhub/Azure.Messaging.EventHubs/README.md) | N/A | N/A | +| [`Azure.Messaging.EventHubs`]( sdk/eventhub/Azure.Messaging.EventHubs/src/Azure.Messaging.EventHubs.csproj )| [Readme](sdk/eventhub/Azure.Messaging.EventHubs/README.md) | [Changelog](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/CHANGELOG.md) | [Nuget]( https://www.nuget.org/packages/Azure.Messaging.EventHubs/ ) | | [`Azure.Security.KeyVault.Secrets`]( sdk/keyvault/Azure.Security.KeyVault.Secrets/src/Azure.Security.KeyVault.Secrets.csproj )| N/A | N/A | [Nuget]( https://www.nuget.org/packages/Azure.Security.KeyVault.Secrets/ ) | | [`Azure.Security.Keyvault.Keys`]( sdk/keyvault/Azure.Security.KeyVault.Keys/src/Azure.Security.Keyvault.Keys.csproj )| N/A | N/A | [Nuget]( https://www.nuget.org/packages/Azure.Security.Keyvault.Keys/ ) | | [`Azure.Storage.Blobs`]( sdk/storage/Azure.Storage.Blobs/src/Azure.Storage.Blobs.csproj )| [Readme](sdk/storage/Azure.Storage.Blobs/README.md) | N/A | [Nuget]( https://www.nuget.org/packages/Azure.Storage.Blobs/ ) | diff --git a/sdk/appconfiguration/Azure.ApplicationModel.Configuration/tests/ConfigurationWatcher.cs b/sdk/appconfiguration/Azure.ApplicationModel.Configuration/tests/ConfigurationWatcher.cs deleted file mode 100644 index 317e366e541b..000000000000 --- a/sdk/appconfiguration/Azure.ApplicationModel.Configuration/tests/ConfigurationWatcher.cs +++ /dev/null @@ -1,139 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. See License.txt in the project root for -// license information. - -using System; -using System.Collections.Generic; -using System.Diagnostics; -using System.Threading; -using System.Threading.Tasks; - -namespace Azure.ApplicationModel.Configuration.Tests -{ - public class ConfigurationWatcher - { - readonly ConfigurationClient _client; - readonly List _keysToWatch = new List(); - readonly Dictionary _lastPolled = new Dictionary(); - Task _watching; - CancellationTokenSource _cancel; - object _sync = new object(); - - // TODO (pri 2): should we be using passed in client? the retry policy and logging is pretty bad for watching - public ConfigurationWatcher(ConfigurationClient client, params string[] keysToWatch) - { - if (client == null) throw new ArgumentNullException(nameof(client)); - _keysToWatch.AddRange(keysToWatch); - _client = client; - } - - public TimeSpan Interval { get; set; } = TimeSpan.FromSeconds(1); - - public void Start(CancellationToken token = default) - { - lock (_sync) { - if (_watching != null) throw new InvalidOperationException("watcher already started"); - _cancel = (token == default) ? new CancellationTokenSource() : CancellationTokenSource.CreateLinkedTokenSource(token); - _watching = WatchChangesAsync(_cancel.Token); - } - } - - public async Task Stop() - { - Task watching; - lock (_sync) { - if (_watching == null) throw new InvalidOperationException("watcher has not been started"); - watching = _watching; - _cancel.Cancel(); - _cancel = null; - _watching = null; - } - Debug.Assert(watching != null); - await watching.ConfigureAwait(false); - } - - public event EventHandler SettingChanged; - public event EventHandler Error; - - protected virtual bool CompareSetting(ConfigurationSetting left, ConfigurationSetting right) - { - if (left == null && right != null) return true; - return !left.Equals(right); - } - - private async Task WatchChangesAsync(CancellationToken cancellationToken) - { - // record current values - await Snapshot(cancellationToken).ConfigureAwait(false); - - while (!cancellationToken.IsCancellationRequested) { - try { - await PollAsync(cancellationToken).ConfigureAwait(false); - await Task.Delay(Interval, cancellationToken).ConfigureAwait(false); - } - catch (Exception e) { - if (e is OperationCanceledException) return; - Error?.Invoke(this, e); - } - } - } - - private async Task Snapshot(CancellationToken cancellationToken) - { - try { - for (int i = 0; i < _keysToWatch.Count; i++) { - - var response = await _client.GetAsync(_keysToWatch[i], null, default, cancellationToken).ConfigureAwait(false); - if (response.GetRawResponse().Status == 200) { - var setting = response.Value; - _lastPolled[setting.Key] = setting; - } - // TODO (pri 2): what should we do when the request fails? - } - } - catch (Exception e) { - if (e is OperationCanceledException) return; - Error?.Invoke(this, e); - } - } - - private async Task PollAsync(CancellationToken cancellationToken) - { - var callback = SettingChanged; - if (callback == null) return; - - var tasks = new Task>[_keysToWatch.Count]; - for (int i = 0; i < _keysToWatch.Count; i++) { - tasks[i] = _client.GetAsync(_keysToWatch[i], null, default, cancellationToken); - } - await Task.WhenAll(tasks); - - foreach(var task in tasks) { - var response = task.Result; - if (response.GetRawResponse().Status == 200) { - ConfigurationSetting current = response.Value; - _lastPolled.TryGetValue(current.Key, out var previous); - if (CompareSetting(current, previous)) { - if (current == null) _lastPolled.Remove(current.Key); - else _lastPolled[current.Key] = current; - var e = new SettingChangedEventArgs(previous, current); - callback(this, e); // TODO (pri 2): should this be synchronized to the UI thread? - } - } - // TODO (pri 2): should we return for some error status codes? - } - } - - public struct SettingChangedEventArgs - { - public SettingChangedEventArgs(ConfigurationSetting older, ConfigurationSetting newer) - { - Older = older; - Newer = newer; - } - - public ConfigurationSetting Older { get; } - public ConfigurationSetting Newer { get; } - } - } -} diff --git a/sdk/appconfiguration/Azure.ApplicationModel.Configuration/tests/ConfigurationWatcherTests.cs b/sdk/appconfiguration/Azure.ApplicationModel.Configuration/tests/ConfigurationWatcherTests.cs deleted file mode 100644 index 12f9894d3a80..000000000000 --- a/sdk/appconfiguration/Azure.ApplicationModel.Configuration/tests/ConfigurationWatcherTests.cs +++ /dev/null @@ -1,108 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. See License.txt in the project root for -// license information. - -using NUnit.Framework; -using System.Threading.Tasks; -using System; -using System.Linq; -using System.Threading; -using System.Collections.Generic; - -namespace Azure.ApplicationModel.Configuration.Tests -{ - [Category("Live")] - public class ConfigurationWatcherTests - { - [Test] - public async Task Helpers() - { - ConfigurationClient client = new ConfigurationClient(TestEnvironment.GetClientConnectionString()); - - const int numberOfSettings = 2; - - // key prefix used to partition tests running at the same time so that they don't interract with each other - var testPartition = Guid.NewGuid().ToString(); - - var addedSettings = new List(numberOfSettings); - - try { - // add settings to the store - for (int i = 0; i < numberOfSettings; i++) { - ConfigurationSetting setting = await client.AddAsync(new ConfigurationSetting($"{testPartition}_{i}", i.ToString())); - addedSettings.Add(setting); - } - - var changed = new List(); // acumulator for detected changes - var watcher = new ConfigurationWatcher(client, addedSettings.Select((setting) => setting.Key).ToArray()); - watcher.SettingChanged += (sender, e) => - { - changed.Add(e); - }; - watcher.Error += (sender, e) => - { - Assert.Fail(e.Message); - }; - - // start watching for changes - watcher.Start(); - - // do updates in the service store - for (int i = 0; i < numberOfSettings; i++) { - var updated = addedSettings[i]; - updated.Value = (i + 100).ToString(); - var response = await client.UpdateAsync(updated); - } - - // wait for updates to be detected - await Task.Delay(2000); - await watcher.Stop(); - - // assert expectations - Assert.AreEqual(numberOfSettings, changed.Count); - } - finally { - // delete settings from the service store - foreach (var setting in addedSettings) { - var response = await client.DeleteAsync(setting.Key); - if (response.Status != 200) { - throw new Exception("could not delete setting " + setting.Key); - } - } - } - } - - [Test] - public async Task WatcherSample() - { - // Retrieve the connection string from the configuration store. - // You can get the string from your Azure portal. - var connectionString = Environment.GetEnvironmentVariable("APP_CONFIG_CONNECTION"); - - // Instantiate a client that will be used to call the service. - var client = new ConfigurationClient(connectionString); - - // Setup the watcher to watch "key1" and "key2" - var watcher = new ConfigurationWatcher(client, "key1", "key2"); - watcher.SettingChanged += (sender, e) => - { - Console.WriteLine($"old value: {e.Older.Value}"); - Console.WriteLine($"new value: {e.Newer.Value}"); - }; - // Print errors occuring during watching - watcher.Error += (sender, e) => - { - Console.WriteLine($"Error {e.Message}"); - }; - - // start watching - watcher.Start(); - - // watch for 1 second - await Task.Delay(1000); - - // stop watching - await watcher.Stop(); - } - } -} diff --git a/sdk/batch/Microsoft.Azure.Batch/Microsoft.Azure.Batch.sln b/sdk/batch/Microsoft.Azure.Batch/Microsoft.Azure.Batch.sln index 5218de8de650..d3ec27e60f65 100644 --- a/sdk/batch/Microsoft.Azure.Batch/Microsoft.Azure.Batch.sln +++ b/sdk/batch/Microsoft.Azure.Batch/Microsoft.Azure.Batch.sln @@ -1,7 +1,7 @@  Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio Version 16 -VisualStudioVersion = 16.0.28803.452 +# Visual Studio 15 +VisualStudioVersion = 15.0.28307.645 MinimumVisualStudioVersion = 10.0.40219.1 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Azure.Batch", "src\Microsoft.Azure.Batch.csproj", "{A8548C94-A0EA-438D-9226-11142F2646B9}" EndProject @@ -15,10 +15,6 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Azure.Batch.Unit. EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CodeGenerationLibrary", "tools\CodeGenerationLibrary\CodeGenerationLibrary.csproj", "{D15F9643-2956-499E-A94A-5171D5A47D9A}" EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ConfigureAwaitAnalyzer.Tests", "tools\ConfigureAwaitAnalyzerTests\ConfigureAwaitAnalyzer.Tests.csproj", "{AB0EB56A-413A-4CBE-AF93-F99AB6C0798A}" -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ConfigureAwaitAnalyzer", "tools\ConfigureAwaitAnalyzer\ConfigureAwaitAnalyzer.csproj", "{E6F7F36C-C370-438A-A8F2-8B7A021B5155}" -EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ObjectModelCodeGenerator", "tools\ObjectModelCodeGenerator\ObjectModelCodeGenerator.csproj", "{718237FC-37F8-4557-B2FB-70DF3255AAF5}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ProxyLayerParser", "tools\RoslynParser\ProxyLayerParser.csproj", "{403E2952-7152-4F52-B7FD-5BF8A4691B48}" @@ -111,30 +107,6 @@ Global {D15F9643-2956-499E-A94A-5171D5A47D9A}.Portable-Release|Any CPU.Build.0 = Release|Any CPU {D15F9643-2956-499E-A94A-5171D5A47D9A}.Release|Any CPU.ActiveCfg = Release|Any CPU {D15F9643-2956-499E-A94A-5171D5A47D9A}.Release|Any CPU.Build.0 = Release|Any CPU - {AB0EB56A-413A-4CBE-AF93-F99AB6C0798A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {AB0EB56A-413A-4CBE-AF93-F99AB6C0798A}.Debug|Any CPU.Build.0 = Debug|Any CPU - {AB0EB56A-413A-4CBE-AF93-F99AB6C0798A}.Net45-Debug|Any CPU.ActiveCfg = Debug|Any CPU - {AB0EB56A-413A-4CBE-AF93-F99AB6C0798A}.Net45-Debug|Any CPU.Build.0 = Debug|Any CPU - {AB0EB56A-413A-4CBE-AF93-F99AB6C0798A}.Net45-Release|Any CPU.ActiveCfg = Release|Any CPU - {AB0EB56A-413A-4CBE-AF93-F99AB6C0798A}.Net45-Release|Any CPU.Build.0 = Release|Any CPU - {AB0EB56A-413A-4CBE-AF93-F99AB6C0798A}.Portable-Debug|Any CPU.ActiveCfg = Debug|Any CPU - {AB0EB56A-413A-4CBE-AF93-F99AB6C0798A}.Portable-Debug|Any CPU.Build.0 = Debug|Any CPU - {AB0EB56A-413A-4CBE-AF93-F99AB6C0798A}.Portable-Release|Any CPU.ActiveCfg = Release|Any CPU - {AB0EB56A-413A-4CBE-AF93-F99AB6C0798A}.Portable-Release|Any CPU.Build.0 = Release|Any CPU - {AB0EB56A-413A-4CBE-AF93-F99AB6C0798A}.Release|Any CPU.ActiveCfg = Release|Any CPU - {AB0EB56A-413A-4CBE-AF93-F99AB6C0798A}.Release|Any CPU.Build.0 = Release|Any CPU - {E6F7F36C-C370-438A-A8F2-8B7A021B5155}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {E6F7F36C-C370-438A-A8F2-8B7A021B5155}.Debug|Any CPU.Build.0 = Debug|Any CPU - {E6F7F36C-C370-438A-A8F2-8B7A021B5155}.Net45-Debug|Any CPU.ActiveCfg = Debug|Any CPU - {E6F7F36C-C370-438A-A8F2-8B7A021B5155}.Net45-Debug|Any CPU.Build.0 = Debug|Any CPU - {E6F7F36C-C370-438A-A8F2-8B7A021B5155}.Net45-Release|Any CPU.ActiveCfg = Release|Any CPU - {E6F7F36C-C370-438A-A8F2-8B7A021B5155}.Net45-Release|Any CPU.Build.0 = Release|Any CPU - {E6F7F36C-C370-438A-A8F2-8B7A021B5155}.Portable-Debug|Any CPU.ActiveCfg = Debug|Any CPU - {E6F7F36C-C370-438A-A8F2-8B7A021B5155}.Portable-Debug|Any CPU.Build.0 = Debug|Any CPU - {E6F7F36C-C370-438A-A8F2-8B7A021B5155}.Portable-Release|Any CPU.ActiveCfg = Release|Any CPU - {E6F7F36C-C370-438A-A8F2-8B7A021B5155}.Portable-Release|Any CPU.Build.0 = Release|Any CPU - {E6F7F36C-C370-438A-A8F2-8B7A021B5155}.Release|Any CPU.ActiveCfg = Release|Any CPU - {E6F7F36C-C370-438A-A8F2-8B7A021B5155}.Release|Any CPU.Build.0 = Release|Any CPU {718237FC-37F8-4557-B2FB-70DF3255AAF5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {718237FC-37F8-4557-B2FB-70DF3255AAF5}.Debug|Any CPU.Build.0 = Debug|Any CPU {718237FC-37F8-4557-B2FB-70DF3255AAF5}.Net45-Debug|Any CPU.ActiveCfg = Debug|Any CPU @@ -170,8 +142,6 @@ Global {BEC46645-02DB-4759-B6D9-56B6B17741A5} = {9B6E704C-0833-4CDE-BE2C-603A4087BAC9} {11F0374A-3609-4C9C-B57B-BB7876C76DA4} = {9B6E704C-0833-4CDE-BE2C-603A4087BAC9} {D15F9643-2956-499E-A94A-5171D5A47D9A} = {48070FB2-8BB9-4EE4-A8BD-413B2C2B8ED4} - {AB0EB56A-413A-4CBE-AF93-F99AB6C0798A} = {48070FB2-8BB9-4EE4-A8BD-413B2C2B8ED4} - {E6F7F36C-C370-438A-A8F2-8B7A021B5155} = {48070FB2-8BB9-4EE4-A8BD-413B2C2B8ED4} {718237FC-37F8-4557-B2FB-70DF3255AAF5} = {48070FB2-8BB9-4EE4-A8BD-413B2C2B8ED4} {403E2952-7152-4F52-B7FD-5BF8A4691B48} = {48070FB2-8BB9-4EE4-A8BD-413B2C2B8ED4} EndGlobalSection diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/CodeGenerationLibrary/CodeGenerationLibrary.csproj b/sdk/batch/Microsoft.Azure.Batch/Tools/CodeGenerationLibrary/CodeGenerationLibrary.csproj index f0f1160fb965..e9e08675d1e2 100644 --- a/sdk/batch/Microsoft.Azure.Batch/Tools/CodeGenerationLibrary/CodeGenerationLibrary.csproj +++ b/sdk/batch/Microsoft.Azure.Batch/Tools/CodeGenerationLibrary/CodeGenerationLibrary.csproj @@ -2,6 +2,7 @@ Azure Batch object model code generation library true + false @@ -9,6 +10,6 @@ - + diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/CodeGenerationLibrary/CodeGenerationUtilities.cs b/sdk/batch/Microsoft.Azure.Batch/Tools/CodeGenerationLibrary/CodeGenerationUtilities.cs index 9ccf4d282610..e678a43e78cb 100644 --- a/sdk/batch/Microsoft.Azure.Batch/Tools/CodeGenerationLibrary/CodeGenerationUtilities.cs +++ b/sdk/batch/Microsoft.Azure.Batch/Tools/CodeGenerationLibrary/CodeGenerationUtilities.cs @@ -162,8 +162,18 @@ private static string GetProtocolCollectionToObjectModelCollectionString(string return omPropertyData.GenericTypeParameter + ".ConvertFromProtocolCollection(" + protocolObjectSimpleGetter + ")"; } - return omPropertyData.GenericTypeParameter + ".ConvertFromProtocolCollectionAndFreeze(" + - protocolObjectSimpleGetter + ")"; + + // If the name of the type and the name of the property happen to match, we need to disambiguate + if(string.Equals(omPropertyData.Name, omPropertyData.GenericTypeParameter)) + { + // This is a bit of a hack... + const string prefix = "Batch"; + return $"{prefix}.{omPropertyData.GenericTypeParameter}.ConvertFromProtocolCollectionAndFreeze({protocolObjectSimpleGetter})"; + } + else + { + return $"{omPropertyData.GenericTypeParameter}.ConvertFromProtocolCollectionAndFreeze({protocolObjectSimpleGetter})"; + } } return omPropertyData.GenericTypeParameter + ".ConvertFromProtocolCollectionReadOnly(" + protocolObjectSimpleGetter + ")"; } diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzer/AssemblyAttributes.cs b/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzer/AssemblyAttributes.cs deleted file mode 100644 index 259123e45927..000000000000 --- a/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzer/AssemblyAttributes.cs +++ /dev/null @@ -1,6 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. See License.txt in the project root for license information. - -using System.Runtime.CompilerServices; - -[assembly: InternalsVisibleTo("ConfigureAwaitAnalyzer.Tests, PublicKey=0024000004800000940000000602000000240000525341310004000001000100b5fc90e7027f67871e773a8fde8938c81dd402ba65b9201d60593e96c492651e889cc13f1415ebb53fac1131ae0bd333c5ee6021672d9718ea31a8aebd0da0072f25d87dba6fc90ffd598ed4da35e44c398c454307e8e33b8426143daec9f596836f97c8f74750e5975c64e2189f45def46b2a2b1247adc3652bf5c308055da9")] \ No newline at end of file diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzer/ConfigureAwaitAnalyzer.csproj b/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzer/ConfigureAwaitAnalyzer.csproj deleted file mode 100644 index 0824608b6131..000000000000 --- a/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzer/ConfigureAwaitAnalyzer.csproj +++ /dev/null @@ -1,17 +0,0 @@ - - - Azure Batch Roslyn analyzer for checking configureawait - $(DefineConstants);TESTSIGN - true - true - - - - netstandard1.4 - $(PackageTargetFallback);portable-net45+win8 - - - - - - diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzer/DiagnosticAnalyzer.cs b/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzer/DiagnosticAnalyzer.cs deleted file mode 100644 index 5dc0a18c38e5..000000000000 --- a/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzer/DiagnosticAnalyzer.cs +++ /dev/null @@ -1,100 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. See License.txt in the project root for license information. - -namespace ConfigureAwaitAnalyzer -{ - using System; - using System.Collections.Immutable; - using System.Linq; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.CSharp.Syntax; - using Microsoft.CodeAnalysis.Diagnostics; - - [DiagnosticAnalyzer(LanguageNames.CSharp)] - public class ConfigureAwaitAnalyzer : DiagnosticAnalyzer - { - public const string DiagnosticId = "ConfigureAwaitAnalyzer"; - - internal const string Title = "ConfigureAwaitFalseChecker"; - internal const string MessageFormat = "'await' expressions must include ConfigureAwait(false)"; - internal const string Description = "Ensures that all await expressions include ConfigureAwait(false)"; - private const string Category = "Usage"; - - private static readonly DiagnosticDescriptor Rule = new DiagnosticDescriptor( - DiagnosticId, - Title, - MessageFormat, - Category, - DiagnosticSeverity.Warning, - isEnabledByDefault: true, - description: Description); - - private const string ConfigureAwait = "ConfigureAwait"; - - public struct AnalysisResult - { - public bool HasConfigureAwaitFalse { get; } - public Location Location { get; } - - public AnalysisResult(bool hasConfigureAwaitFalse, Location location) - { - this.HasConfigureAwaitFalse = hasConfigureAwaitFalse; - this.Location = location; - } - } - - public override ImmutableArray SupportedDiagnostics => ImmutableArray.Create(Rule); - - public override void Initialize(AnalysisContext context) - { - context.RegisterSyntaxNodeAction(Analyze, SyntaxKind.AwaitExpression); - } - - private static void Analyze(SyntaxNodeAnalysisContext context) - { - var awaitNode = (AwaitExpressionSyntax)context.Node; - AnalysisResult analysisResult = HasConfigureAwaitFalse(awaitNode); - if (!analysisResult.HasConfigureAwaitFalse) - { - context.ReportDiagnostic(Diagnostic.Create(Rule, analysisResult.Location)); - } - } - - private static AnalysisResult HasConfigureAwaitFalse(AwaitExpressionSyntax awaitNode) - { - InvocationExpressionSyntax configureAwaitExpression = FindConfigureAwaitExpression(awaitNode); - bool hasConfigureAwaitFalse = configureAwaitExpression != null && IsExpressionConfigureAwaitFalse(configureAwaitExpression); - return new AnalysisResult(hasConfigureAwaitFalse, awaitNode.GetLocation()); - } - - private static InvocationExpressionSyntax FindConfigureAwaitExpression(SyntaxNode node) - { - foreach (SyntaxNode childNode in node.ChildNodes()) - { - //Find the first node which is an invocation expression - if (childNode is InvocationExpressionSyntax) - { - return (InvocationExpressionSyntax)childNode; - } - return FindConfigureAwaitExpression(childNode); - } - - return null; - } - - /// - /// Checks to see if the expression already contains ConfigureAwait(false) - /// - private static bool IsExpressionConfigureAwaitFalse(InvocationExpressionSyntax invocationExpression) - { - var memberAccessExpression = invocationExpression.Expression as MemberAccessExpressionSyntax; - - bool isConfigureAwait = memberAccessExpression?.Name.Identifier.Text.Equals(ConfigureAwait, StringComparison.Ordinal) == true; - bool hasFalseParameter = invocationExpression.ArgumentList.Arguments.Count == 1 && - invocationExpression.ArgumentList.Arguments.Single().Expression.IsKind(SyntaxKind.FalseLiteralExpression); - - return isConfigureAwait && hasFalseParameter; - } - } -} diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzerTests/ConfigureAwaitAnalyzer.Tests.csproj b/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzerTests/ConfigureAwaitAnalyzer.Tests.csproj deleted file mode 100644 index 8c388027e617..000000000000 --- a/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzerTests/ConfigureAwaitAnalyzer.Tests.csproj +++ /dev/null @@ -1,39 +0,0 @@ - - - - $(BuiltPackageOutputDir) - false - true - false - true - - - - - - - - - - - - - - Azure Batch configure await analyzer tests - 1.0.0-preview - false - - - netcoreapp1.1 - $(PackageTargetFallback);portable-net45+win8 - - - - - - - - - - - diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzerTests/ConfigureAwaitAnalyzerTests.cs b/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzerTests/ConfigureAwaitAnalyzerTests.cs deleted file mode 100644 index 359a08c306b0..000000000000 --- a/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzerTests/ConfigureAwaitAnalyzerTests.cs +++ /dev/null @@ -1,122 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. See License.txt in the project root for license information. - -namespace ConfigureAwaitAnalyzerTests -{ - using System; - using ConfigureAwaitAnalyzer; - using Helpers; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - using Xunit; - - public class ConfigureAwaitAnalyzerTests : DiagnosticVerifier - { - private static readonly string ExpectedFileName = $"{DefaultFilePathPrefix}0.{CSharpDefaultFileExt}"; - - [Fact] - public void TestEmptyCodeBlock_ShouldBeNoError() - { - var test = @""; - - this.VerifyCSharpDiagnostic(test); - } - - [Fact] - public void TestAwaitWithNoConfigureAwait_ShouldBeError() - { - var test = @" - using System; - using System.Collections.Generic; - using System.Linq; - using System.Text; - using System.Threading.Tasks; - using System.Diagnostics; - - namespace ConsoleApplication1 - { - public class TypeName - { - public static async Task Test() - { - await Task.Delay(0); - } - } - }"; - this.VerifyCSharpDiagnostic(test, BuildExpectedResult(15, 17)); - } - - [Fact] - public void TestAwaitWithConfigureAwaitTrue_ShouldBeError() - { - var test = @" - using System; - using System.Collections.Generic; - using System.Linq; - using System.Text; - using System.Threading.Tasks; - using System.Diagnostics; - - namespace ConsoleApplication1 - { - public class TypeName - { - public static async Task Test() - { - await Task.Delay(0).ConfigureAwait(true); - } - } - }"; - this.VerifyCSharpDiagnostic(test, BuildExpectedResult(15, 17)); - } - - [Fact] - public void TestAwaitWithConfigureAwaitFalse_ShouldBeNoError() - { - var test = @" - using System; - using System.Collections.Generic; - using System.Linq; - using System.Text; - using System.Threading.Tasks; - using System.Diagnostics; - - namespace ConsoleApplication1 - { - public class TypeName - { - public static async Task Test() - { - await Task.Delay(0).ConfigureAwait(false); - await Task.Delay(0).ConfigureAwait(continueOnCapturedContext: false); - } - } - }"; - this.VerifyCSharpDiagnostic(test); - } - - protected override DiagnosticAnalyzer GetCSharpDiagnosticAnalyzer() - { - return new ConfigureAwaitAnalyzer(); - } - - protected override DiagnosticAnalyzer GetBasicDiagnosticAnalyzer() - { - throw new NotSupportedException("VB is not supported"); - } - - private static DiagnosticResult BuildExpectedResult(int line, int column) - { - return new DiagnosticResult - { - Id = ConfigureAwaitAnalyzer.DiagnosticId, - Message = ConfigureAwaitAnalyzer.MessageFormat, - Severity = DiagnosticSeverity.Warning, - Locations = - new[] { - new DiagnosticResultLocation(ExpectedFileName, line, column) - } - }; - } - } -} \ No newline at end of file diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzerTests/Helpers/DiagnosticResult.cs b/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzerTests/Helpers/DiagnosticResult.cs deleted file mode 100644 index 8a693e5e1054..000000000000 --- a/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzerTests/Helpers/DiagnosticResult.cs +++ /dev/null @@ -1,90 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. See License.txt in the project root for license information. - -namespace ConfigureAwaitAnalyzerTests.Helpers -{ - using System; - using Microsoft.CodeAnalysis; - - /// - /// Location where the diagnostic appears, as determined by path, line number, and column number. - /// - public struct DiagnosticResultLocation - { - public DiagnosticResultLocation(string path, int line, int column) - { - if (line < -1) - { - throw new ArgumentOutOfRangeException(nameof(line), "line must be >= -1"); - } - - if (column < -1) - { - throw new ArgumentOutOfRangeException(nameof(column), "column must be >= -1"); - } - - this.Path = path; - this.Line = line; - this.Column = column; - } - - public string Path { get; } - public int Line { get; } - public int Column { get; } - } - - /// - /// Struct that stores information about a Diagnostic appearing in a source - /// - public struct DiagnosticResult - { - private DiagnosticResultLocation[] locations; - - public DiagnosticResultLocation[] Locations - { - get - { - if (this.locations == null) - { - this.locations = new DiagnosticResultLocation[] { }; - } - return this.locations; - } - - set - { - this.locations = value; - } - } - - public DiagnosticSeverity Severity { get; set; } - - public string Id { get; set; } - - public string Message { get; set; } - - public string Path - { - get - { - return this.Locations.Length > 0 ? this.Locations[0].Path : ""; - } - } - - public int Line - { - get - { - return this.Locations.Length > 0 ? this.Locations[0].Line : -1; - } - } - - public int Column - { - get - { - return this.Locations.Length > 0 ? this.Locations[0].Column : -1; - } - } - } -} \ No newline at end of file diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzerTests/Helpers/DiagnosticVerifier.Helper.cs b/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzerTests/Helpers/DiagnosticVerifier.Helper.cs deleted file mode 100644 index b296ef1a5714..000000000000 --- a/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzerTests/Helpers/DiagnosticVerifier.Helper.cs +++ /dev/null @@ -1,175 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. See License.txt in the project root for license information. - -namespace ConfigureAwaitAnalyzerTests -{ - using System; - using System.Collections.Generic; - using System.Collections.Immutable; - using System.Linq; - using System.Reflection; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.CSharp; - using Microsoft.CodeAnalysis.Diagnostics; - using Microsoft.CodeAnalysis.Text; - - /// - /// Class for turning strings into documents and getting the diagnostics on them - /// All methods are static - /// - public abstract partial class DiagnosticVerifier - { - private static readonly MetadataReference CorlibReference = MetadataReference.CreateFromFile(typeof(object).GetTypeInfo().Assembly.Location); - private static readonly MetadataReference SystemCoreReference = MetadataReference.CreateFromFile(typeof(Enumerable).GetTypeInfo().Assembly.Location); - private static readonly MetadataReference CSharpSymbolsReference = MetadataReference.CreateFromFile(typeof(CSharpCompilation).GetTypeInfo().Assembly.Location); - private static readonly MetadataReference CodeAnalysisReference = MetadataReference.CreateFromFile(typeof(Compilation).GetTypeInfo().Assembly.Location); - - internal static string DefaultFilePathPrefix = "Test"; - internal static string CSharpDefaultFileExt = "cs"; - internal static string VisualBasicDefaultExt = "vb"; - internal static string TestProjectName = "TestProject"; - - #region Get Diagnostics - - /// - /// Given classes in the form of strings, their language, and an IDiagnosticAnlayzer to apply to it, return the diagnostics found in the string after converting it to a document. - /// - /// Classes in the form of strings - /// The language the source classes are in - /// The analyzer to be run on the sources - /// An IEnumerable of Diagnostics that surfaced in the source code, sorted by Location - private static Diagnostic[] GetSortedDiagnostics(string[] sources, string language, DiagnosticAnalyzer analyzer) - { - return GetSortedDiagnosticsFromDocuments(analyzer, GetDocuments(sources, language)); - } - - /// - /// Given an analyzer and a document to apply it to, run the analyzer and gather an array of diagnostics found in it. - /// The returned diagnostics are then ordered by location in the source document. - /// - /// The analyzer to run on the documents - /// The Documents that the analyzer will be run on - /// An IEnumerable of Diagnostics that surfaced in the source code, sorted by Location - protected static Diagnostic[] GetSortedDiagnosticsFromDocuments(DiagnosticAnalyzer analyzer, Document[] documents) - { - var projects = new HashSet(); - foreach (var document in documents) - { - projects.Add(document.Project); - } - - var diagnostics = new List(); - foreach (var project in projects) - { - var compilationWithAnalyzers = project.GetCompilationAsync().Result.WithAnalyzers(ImmutableArray.Create(analyzer)); - var diags = compilationWithAnalyzers.GetAnalyzerDiagnosticsAsync().Result; - foreach (var diag in diags) - { - if (diag.Location == Location.None || diag.Location.IsInMetadata) - { - diagnostics.Add(diag); - } - else - { - for (int i = 0; i < documents.Length; i++) - { - var document = documents[i]; - var tree = document.GetSyntaxTreeAsync().Result; - if (tree == diag.Location.SourceTree) - { - diagnostics.Add(diag); - } - } - } - } - - } - - var results = SortDiagnostics(diagnostics); - diagnostics.Clear(); - return results; - } - - /// - /// Sort diagnostics by location in source document - /// - /// The list of Diagnostics to be sorted - /// An IEnumerable containing the Diagnostics in order of Location - private static Diagnostic[] SortDiagnostics(IEnumerable diagnostics) - { - return diagnostics.OrderBy(d => d.Location.SourceSpan.Start).ToArray(); - } - - #endregion - - #region Set up compilation and documents - /// - /// Given an array of strings as sources and a language, turn them into a project and return the documents and spans of it. - /// - /// Classes in the form of strings - /// The language the source code is in - /// A Tuple containing the Documents produced from the sources and their TextSpans if relevant - private static Document[] GetDocuments(string[] sources, string language) - { - if (language != LanguageNames.CSharp && language != LanguageNames.VisualBasic) - { - throw new ArgumentException("Unsupported Language"); - } - - var project = CreateProject(sources, language); - var documents = project.Documents.ToArray(); - - if (sources.Length != documents.Length) - { - throw new Exception("Amount of sources did not match amount of Documents created"); - } - - return documents; - } - - /// - /// Create a Document from a string through creating a project that contains it. - /// - /// Classes in the form of a string - /// The language the source code is in - /// A Document created from the source string - protected static Document CreateDocument(string source, string language = LanguageNames.CSharp) - { - return CreateProject(new[] { source }, language).Documents.First(); - } - - /// - /// Create a project using the inputted strings as sources. - /// - /// Classes in the form of strings - /// The language the source code is in - /// A Project created out of the Documents created from the source strings - private static Project CreateProject(string[] sources, string language = LanguageNames.CSharp) - { - string fileNamePrefix = DefaultFilePathPrefix; - string fileExt = language == LanguageNames.CSharp ? CSharpDefaultFileExt : VisualBasicDefaultExt; - - var projectId = ProjectId.CreateNewId(debugName: TestProjectName); - - var solution = new AdhocWorkspace() - .CurrentSolution - .AddProject(projectId, TestProjectName, TestProjectName, language) - .AddMetadataReference(projectId, CorlibReference) - .AddMetadataReference(projectId, SystemCoreReference) - .AddMetadataReference(projectId, CSharpSymbolsReference) - .AddMetadataReference(projectId, CodeAnalysisReference); - - int count = 0; - foreach (var source in sources) - { - var newFileName = fileNamePrefix + count + "." + fileExt; - var documentId = DocumentId.CreateNewId(projectId, debugName: newFileName); - solution = solution.AddDocument(documentId, newFileName, SourceText.From(source)); - count++; - } - return solution.GetProject(projectId); - } - #endregion - } -} - diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzerTests/Verifiers/DiagnosticVerifier.cs b/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzerTests/Verifiers/DiagnosticVerifier.cs deleted file mode 100644 index a926da7a3afe..000000000000 --- a/sdk/batch/Microsoft.Azure.Batch/Tools/ConfigureAwaitAnalyzerTests/Verifiers/DiagnosticVerifier.cs +++ /dev/null @@ -1,247 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. See License.txt in the project root for license information. - -namespace ConfigureAwaitAnalyzerTests -{ - using System.Collections.Generic; - using System.Linq; - using System.Text; - using Helpers; - using Microsoft.CodeAnalysis; - using Microsoft.CodeAnalysis.Diagnostics; - using Xunit; - - /// - /// Superclass of all Unit Tests for DiagnosticAnalyzers - /// - public abstract partial class DiagnosticVerifier - { - #region To be implemented by Test classes - - /// - /// Get the CSharp analyzer being tested - to be implemented in non-abstract class - /// - protected abstract DiagnosticAnalyzer GetCSharpDiagnosticAnalyzer(); - - /// - /// Get the Visual Basic analyzer being tested (C#) - to be implemented in non-abstract class - /// - protected abstract DiagnosticAnalyzer GetBasicDiagnosticAnalyzer(); - - #endregion - - #region Verifier wrappers - - /// - /// Called to test a C# DiagnosticAnalyzer when applied on the single inputted string as a source - /// Note: input a DiagnosticResult for each Diagnostic expected - /// - /// A class in the form of a string to run the analyzer on - /// DiagnosticResults that should appear after the analyzer is run on the source - protected void VerifyCSharpDiagnostic(string source, params DiagnosticResult[] expected) - { - this.VerifyDiagnostics(new[] { source }, LanguageNames.CSharp, this.GetCSharpDiagnosticAnalyzer(), expected); - } - - /// - /// Called to test a C# DiagnosticAnalyzer when applied on the inputted strings as a source - /// Note: input a DiagnosticResult for each Diagnostic expected - /// - /// An array of strings to create source documents from to run the analyzers on - /// DiagnosticResults that should appear after the analyzer is run on the sources - protected void VerifyCSharpDiagnostic(string[] sources, params DiagnosticResult[] expected) - { - this.VerifyDiagnostics(sources, LanguageNames.CSharp, this.GetCSharpDiagnosticAnalyzer(), expected); - } - - /// - /// General method that gets a collection of actual diagnostics found in the source after the analyzer is run, - /// then verifies each of them. - /// - /// An array of strings to create source documents from to run the analyzers on - /// The language of the classes represented by the source strings - /// The analyzer to be run on the source code - /// DiagnosticResults that should appear after the analyzer is run on the sources - private void VerifyDiagnostics(string[] sources, string language, DiagnosticAnalyzer analyzer, params DiagnosticResult[] expected) - { - var diagnostics = GetSortedDiagnostics(sources, language, analyzer); - VerifyDiagnosticResults(diagnostics, analyzer, expected); - } - - #endregion - - #region Actual comparisons and verifications - /// - /// Checks each of the actual Diagnostics found and compares them with the corresponding DiagnosticResult in the array of expected results. - /// Diagnostics are considered equal only if the DiagnosticResultLocation, Id, Severity, and Message of the DiagnosticResult match the actual diagnostic. - /// - /// The Diagnostics found by the compiler after running the analyzer on the source code - /// The analyzer that was being run on the sources - /// Diagnostic Results that should have appeared in the code - private static void VerifyDiagnosticResults(IEnumerable actualResults, DiagnosticAnalyzer analyzer, params DiagnosticResult[] expectedResults) - { - int expectedCount = expectedResults.Count(); - int actualCount = actualResults.Count(); - - if (expectedCount != actualCount) - { - string diagnosticsOutput = actualResults.Any() ? FormatDiagnostics(analyzer, actualResults.ToArray()) : " NONE."; - - Assert.True(false, - string.Format("Mismatch between number of diagnostics returned, expected \"{0}\" actual \"{1}\"\r\n\r\nDiagnostics:\r\n{2}\r\n", expectedCount, actualCount, diagnosticsOutput)); - } - - for (int i = 0; i < expectedResults.Length; i++) - { - var actual = actualResults.ElementAt(i); - var expected = expectedResults[i]; - - if (expected.Line == -1 && expected.Column == -1) - { - if (actual.Location != Location.None) - { - Assert.True(false, - string.Format("Expected:\nA project diagnostic with No location\nActual:\n{0}", - FormatDiagnostics(analyzer, actual))); - } - } - else - { - VerifyDiagnosticLocation(analyzer, actual, actual.Location, expected.Locations.First()); - var additionalLocations = actual.AdditionalLocations.ToArray(); - - if (additionalLocations.Length != expected.Locations.Length - 1) - { - Assert.True(false, - string.Format("Expected {0} additional locations but got {1} for Diagnostic:\r\n {2}\r\n", - expected.Locations.Length - 1, additionalLocations.Length, - FormatDiagnostics(analyzer, actual))); - } - - for (int j = 0; j < additionalLocations.Length; ++j) - { - VerifyDiagnosticLocation(analyzer, actual, additionalLocations[j], expected.Locations[j + 1]); - } - } - - if (actual.Id != expected.Id) - { - Assert.True(false, - string.Format("Expected diagnostic id to be \"{0}\" was \"{1}\"\r\n\r\nDiagnostic:\r\n {2}\r\n", - expected.Id, actual.Id, FormatDiagnostics(analyzer, actual))); - } - - if (actual.Severity != expected.Severity) - { - Assert.True(false, - string.Format("Expected diagnostic severity to be \"{0}\" was \"{1}\"\r\n\r\nDiagnostic:\r\n {2}\r\n", - expected.Severity, actual.Severity, FormatDiagnostics(analyzer, actual))); - } - - if (actual.GetMessage() != expected.Message) - { - Assert.True(false, - string.Format("Expected diagnostic message to be \"{0}\" was \"{1}\"\r\n\r\nDiagnostic:\r\n {2}\r\n", - expected.Message, actual.GetMessage(), FormatDiagnostics(analyzer, actual))); - } - } - } - - /// - /// Helper method to VerifyDiagnosticResult that checks the location of a diagnostic and compares it with the location in the expected DiagnosticResult. - /// - /// The analyzer that was being run on the sources - /// The diagnostic that was found in the code - /// The Location of the Diagnostic found in the code - /// The DiagnosticResultLocation that should have been found - private static void VerifyDiagnosticLocation(DiagnosticAnalyzer analyzer, Diagnostic diagnostic, Location actual, DiagnosticResultLocation expected) - { - var actualSpan = actual.GetLineSpan(); - - Assert.True(actualSpan.Path == expected.Path || (actualSpan.Path != null && actualSpan.Path.Contains("Test0.") && expected.Path.Contains("Test.")), - string.Format("Expected diagnostic to be in file \"{0}\" was actually in file \"{1}\"\r\n\r\nDiagnostic:\r\n {2}\r\n", - expected.Path, actualSpan.Path, FormatDiagnostics(analyzer, diagnostic))); - - var actualLinePosition = actualSpan.StartLinePosition; - - // Only check line position if there is an actual line in the real diagnostic - if (actualLinePosition.Line > 0) - { - if (actualLinePosition.Line + 1 != expected.Line) - { - Assert.True(false, - string.Format("Expected diagnostic to be on line \"{0}\" was actually on line \"{1}\"\r\n\r\nDiagnostic:\r\n {2}\r\n", - expected.Line, actualLinePosition.Line + 1, FormatDiagnostics(analyzer, diagnostic))); - } - } - - // Only check column position if there is an actual column position in the real diagnostic - if (actualLinePosition.Character > 0) - { - if (actualLinePosition.Character + 1 != expected.Column) - { - Assert.True(false, - string.Format("Expected diagnostic to start at column \"{0}\" was actually at column \"{1}\"\r\n\r\nDiagnostic:\r\n {2}\r\n", - expected.Column, actualLinePosition.Character + 1, FormatDiagnostics(analyzer, diagnostic))); - } - } - } - #endregion - - #region Formatting Diagnostics - /// - /// Helper method to format a Diagnostic into an easily readable string - /// - /// The analyzer that this verifier tests - /// The Diagnostics to be formatted - /// The Diagnostics formatted as a string - private static string FormatDiagnostics(DiagnosticAnalyzer analyzer, params Diagnostic[] diagnostics) - { - var builder = new StringBuilder(); - for (int i = 0; i < diagnostics.Length; ++i) - { - builder.AppendLine("// " + diagnostics[i].ToString()); - - var analyzerType = analyzer.GetType(); - var rules = analyzer.SupportedDiagnostics; - - foreach (var rule in rules) - { - if (rule != null && rule.Id == diagnostics[i].Id) - { - var location = diagnostics[i].Location; - if (location == Location.None) - { - builder.AppendFormat("GetGlobalResult({0}.{1})", analyzerType.Name, rule.Id); - } - else - { - Assert.True(location.IsInSource, - $"Test base does not currently handle diagnostics in metadata locations. Diagnostic in metadata: {diagnostics[i]}\r\n"); - - string resultMethodName = diagnostics[i].Location.SourceTree.FilePath.EndsWith(".cs") ? "GetCSharpResultAt" : "GetBasicResultAt"; - var linePosition = diagnostics[i].Location.GetLineSpan().StartLinePosition; - - builder.AppendFormat("{0}({1}, {2}, {3}.{4})", - resultMethodName, - linePosition.Line + 1, - linePosition.Character + 1, - analyzerType.Name, - rule.Id); - } - - if (i != diagnostics.Length - 1) - { - builder.Append(','); - } - - builder.AppendLine(); - break; - } - } - } - return builder.ToString(); - } - #endregion - } -} diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/ObjectModelCodeGenerator.csproj b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/ObjectModelCodeGenerator.csproj index 5e70351aee47..482adec72342 100644 --- a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/ObjectModelCodeGenerator.csproj +++ b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/ObjectModelCodeGenerator.csproj @@ -3,6 +3,7 @@ Azure Batch object model code generator Exe true + false @@ -10,7 +11,7 @@ - + diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Program.cs b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Program.cs index 164e02aa053d..40e8afdf3e9f 100644 --- a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Program.cs +++ b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Program.cs @@ -34,7 +34,7 @@ private static void GenerateModelFiles() } seen.Add(type.Name); - string outputDirectory = "../../../../../../Microsoft.Azure.Batch/src/Generated"; + string outputDirectory = "../../../../../sdk/batch/Microsoft.Azure.Batch/src/Generated"; string outputFilePath = Path.Combine(outputDirectory, type.Name + ".cs"); string innerClassString; diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/AutoUserSpecification.json b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/AutoUserSpecification.json index 34afedf98986..80dedc3d96b6 100644 --- a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/AutoUserSpecification.json +++ b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/AutoUserSpecification.json @@ -8,8 +8,8 @@ "Key": { "Type": "Common.AutoUserScope?", "Name": "Scope", - "SummaryComment": "The scope for the auto user. If omitted, the default is .", - "RemarksComment": null, + "SummaryComment": "The scope for the auto user. If omitted, the default is .", + "RemarksComment": "If the pool is running Windows a value of should be specified if stricter isolation between tasks is required. For example, if the Task mutates the registry in a way which could impact other Tasks, or if Certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by StartTasks.", "BoundAccess": "read", "UnboundAccess": "read,write", "ConstructorArgumentType": "Optional", diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/AzureBlobFileSystemConfiguration.json b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/AzureBlobFileSystemConfiguration.json new file mode 100644 index 000000000000..396bbcaffbfb --- /dev/null +++ b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/AzureBlobFileSystemConfiguration.json @@ -0,0 +1,84 @@ +{ + "Name": "AzureBlobFileSystemConfiguration", + "ProtocolName": "Models.AzureBlobFileSystemConfiguration", + "SummaryComment": "Information used to connect to an Azure Storage Container using Blobfuse.", + "IsConstructorPublic": false, + "Properties": [ + { + "Key": { + "Type": "string", + "Name": "AccountName", + "SummaryComment": "The Azure Storage account name.", + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Required", + "HideSetter": true + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "ContainerName", + "SummaryComment": "The Azure Blob Storage Container name.", + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Required", + "HideSetter": true + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "RelativeMountPath", + "SummaryComment": "The relative path on the compute node where the file system will be mounted.", + "RemarksComment": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.", + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Required", + "HideSetter": true + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "AccountKey", + "SummaryComment": "The Azure Storage Account key. This property is mutually exclusive with .", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Optional", + "HideSetter": true + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "SasKey", + "SummaryComment": "The Azure Storage SAS token. This property is mutually exclusive with .", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Optional", + "HideSetter": true + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "BlobfuseOptions", + "SummaryComment": "Additional command line options to pass to the mount command.", + "RemarksComment": "These are 'net use' options in Windows and 'mount' options in Linux.", + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Optional", + "HideSetter": true + }, + "Value": null + } + ] +} diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/AzureFileShareConfiguration.json b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/AzureFileShareConfiguration.json new file mode 100644 index 000000000000..b440db2edeaa --- /dev/null +++ b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/AzureFileShareConfiguration.json @@ -0,0 +1,71 @@ +{ + "Name": "AzureFileShareConfiguration", + "ProtocolName": "Models.AzureFileShareConfiguration", + "SummaryComment": "Information used to connect to an Azure Fileshare.", + "Properties": [ + { + "Key": { + "Type": "string", + "Name": "AccountName", + "SummaryComment": "The Azure Storage Account name.", + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Required", + "HideSetter": true + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "AzureFileUrl", + "SummaryComment": "The Azure Files URL.", + "RemarksComment": "This is of the form 'https://myaccount.file.core.windows.net/'.", + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Required", + "HideSetter": true + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "RelativeMountPath", + "SummaryComment": "The relative path on the compute node where the file system will be mounted.", + "RemarksComment": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.", + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Required", + "HideSetter": true + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "AccountKey", + "SummaryComment": "The Azure Storage Account key.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Required", + "HideSetter": true + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "MountOptions", + "SummaryComment": "Additional command line options to pass to the mount command.", + "RemarksComment": "These are 'net use' options in Windows and 'mount' options in Linux.", + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Optional", + "HideSetter": true + }, + "Value": null + } + ] +} diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/CifsMountConfiguration.json b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/CifsMountConfiguration.json new file mode 100644 index 000000000000..3a99024cc0ec --- /dev/null +++ b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/CifsMountConfiguration.json @@ -0,0 +1,72 @@ +{ + "Name": "CifsMountConfiguration", + "ProtocolName": "Models.CIFSMountConfiguration", + "SummaryComment": "Information used to connect to a CIFS file system.", + "Properties": [ + { + "Key": { + "Type": "string", + "Name": "Username", + "SummaryComment": "The user to use for authentication against the CIFS file system.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Required", + "HideSetter": true + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "Password", + "SummaryComment": "The password to use for authentication against the CIFS file system.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Required", + "HideSetter": true + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "Source", + "SummaryComment": "The URI of the file system to mount.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Required", + "HideSetter": true + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "RelativeMountPath", + "SummaryComment": "The relative path on the compute node where the file system will be mounted.", + "RemarksComment": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.", + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Required", + "HideSetter": true + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "MountOptions", + "SummaryComment": "Additional command line options to pass to the mount command.", + "RemarksComment": "These are 'net use' options in Windows and 'mount' options in Linux.", + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Optional", + "HideSetter": true + }, + "Value": null + } + ] +} diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/CloudPool.json b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/CloudPool.json index f1c8c94b3d2b..f017d73818b9 100644 --- a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/CloudPool.json +++ b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/CloudPool.json @@ -415,6 +415,20 @@ "UnboundAccess": "read,write" }, "Value": null + }, + { + "Key": { + "Type": "IList", + "Name": "MountConfiguration", + "SummaryComment": "A list of file systems to mount on each node in the pool.", + "RemarksComment": "This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.", + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": { + "Type": "IList", + "Name": "MountConfiguration" + } } ] } diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/ImageReference.json b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/ImageReference.json index 4e45e7426fb1..9045044ef4a3 100644 --- a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/ImageReference.json +++ b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/ImageReference.json @@ -34,7 +34,7 @@ "Type": "string", "Name": "Sku", "SummaryComment": "The SKU of the Azure Virtual Machines Marketplace Image.", - "RemarksComment": "For example, 14.04.0-LTS or 2012-R2-Datacenter.", + "RemarksComment": "For example, 18.04-LTS or 2019-Datacenter.", "BoundAccess": "read", "UnboundAccess": "read,write", "HideSetter": true @@ -57,8 +57,8 @@ "Key": { "Type": "string", "Name": "VirtualMachineImageId", - "SummaryComment": "The ARM resource identifier of the Virtual Machine Image. Computes nodes of the pool will be created using this custom image. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}", - "RemarksComment": "This property is mutually exclusive with other ImageReference properties. The virtual machine image must be in the same region and subscription as the Azure Batch account. For information about the firewall settings for the Batch Node Agent to communicate with Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.", + "SummaryComment": "The ARM resource identifier of the Virtual Machine Image or Shared Image Gallery Image. Computes Compute Nodes of the Pool will be created using this Image Id. This is of either the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName} for Virtual Machine Image or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId} for SIG image.", + "RemarksComment": "This property is mutually exclusive with other properties. For Virtual Machine Image it must be in the same region and subscription as the Azure Batch account. For SIG image it must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.", "BoundAccess": "read", "UnboundAccess": "read,write", "HideSetter": true diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/MountConfiguration.json b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/MountConfiguration.json new file mode 100644 index 000000000000..2cd62c13c9df --- /dev/null +++ b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/MountConfiguration.json @@ -0,0 +1,57 @@ +{ + "Name": "MountConfiguration", + "ProtocolName": "Models.MountConfiguration", + "SummaryComment": "The file system to mount on each node.", + "IsConstructorPublic": false, + "IsUsedInCollections": true, + "Properties": [ + { + "Key": { + "Type": "AzureBlobFileSystemConfiguration", + "Name": "AzureBlobFileSystemConfiguration", + "SummaryComment": "The Azure Storage Container to mount using blob FUSE on each node.", + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Optional", + "HideSetter": true + }, + "Value": null + }, + { + "Key": { + "Type": "NfsMountConfiguration", + "Name": "NfsMountConfiguration", + "SummaryComment": "The NFS file system to mount on each node.", + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Optional", + "HideSetter": true + }, + "Value": null + }, + { + "Key": { + "Type": "CifsMountConfiguration", + "Name": "CifsMountConfiguration", + "SummaryComment": "The CIFS/SMB file system to mount on each node.", + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Optional", + "HideSetter": true + }, + "Value": null + }, + { + "Key": { + "Type": "AzureFileShareConfiguration", + "Name": "AzureFileShareConfiguration", + "SummaryComment": "The Azure File Share to mount on each node.", + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Optional", + "HideSetter": true + }, + "Value": null + } + ] +} diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/NetworkConfiguration.json b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/NetworkConfiguration.json index 70cc3cb5e41f..4a453f17506b 100644 --- a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/NetworkConfiguration.json +++ b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/NetworkConfiguration.json @@ -38,6 +38,20 @@ "Type": "Models.DynamicVNetAssignmentScope?", "Name": "DynamicVNetAssignmentScope" } + }, + { + "Key": { + "Type": "IList", + "Name": "PublicIPs", + "SummaryComment": "The list of public IPs which the Batch service will use when provisioning Compute Nodes.", + "RemarksComment": "The number of IPs specified here limits the maximum size of the Pool - 50 dedicated nodes or 20 low-priority nodes can be allocated for each public IP. For example, a pool needing 150 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.", + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": { + "Type": "IList", + "Name": "PublicIPs" + } } ] } diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/NfsMountConfiguration.json b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/NfsMountConfiguration.json new file mode 100644 index 000000000000..75581e1d7626 --- /dev/null +++ b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/NfsMountConfiguration.json @@ -0,0 +1,46 @@ +{ + "Name": "NfsMountConfiguration", + "ProtocolName": "Models.NFSMountConfiguration", + "SummaryComment": "Information used to connect to an NFS file system.", + "Properties": [ + { + "Key": { + "Type": "string", + "Name": "Source", + "SummaryComment": "The URI of the file system to mount.", + "RemarksComment": null, + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Required", + "HideSetter": true + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "RelativeMountPath", + "SummaryComment": "The relative path on the compute node where the file system will be mounted.", + "RemarksComment": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.", + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Required", + "HideSetter": true + }, + "Value": null + }, + { + "Key": { + "Type": "string", + "Name": "MountOptions", + "SummaryComment": "Additional command line options to pass to the mount command.", + "RemarksComment": "These are 'net use' options in Windows and 'mount' options in Linux.", + "BoundAccess": "read", + "UnboundAccess": "read,write", + "ConstructorArgumentType": "Optional", + "HideSetter": true + }, + "Value": null + } + ] +} diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/PoolSpecification.json b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/PoolSpecification.json index f1b026e8c4f4..4f855601be0b 100644 --- a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/PoolSpecification.json +++ b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/PoolSpecification.json @@ -252,6 +252,20 @@ "UnboundAccess": "read,write" }, "Value": null + }, + { + "Key": { + "Type": "IList", + "Name": "MountConfiguration", + "SummaryComment": "A list of file systems to mount on each node in the pool.", + "RemarksComment": "This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.", + "BoundAccess": "read", + "UnboundAccess": "read,write" + }, + "Value": { + "Type": "IList", + "Name": "MountConfiguration" + } } ] } diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/StartTask.json b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/StartTask.json index a15c5e2be5a8..5f2f61330686 100644 --- a/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/StartTask.json +++ b/sdk/batch/Microsoft.Azure.Batch/Tools/ObjectModelCodeGenerator/Spec/StartTask.json @@ -71,7 +71,7 @@ "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.", + "RemarksComment": "If this is not specified, the default is true.", "BoundAccess": "read,write", "UnboundAccess": "read,write" }, diff --git a/sdk/batch/Microsoft.Azure.Batch/Tools/RoslynParser/ProxyLayerParser.csproj b/sdk/batch/Microsoft.Azure.Batch/Tools/RoslynParser/ProxyLayerParser.csproj index cc87edc615bd..ec4db155bc53 100644 --- a/sdk/batch/Microsoft.Azure.Batch/Tools/RoslynParser/ProxyLayerParser.csproj +++ b/sdk/batch/Microsoft.Azure.Batch/Tools/RoslynParser/ProxyLayerParser.csproj @@ -9,9 +9,9 @@ - - - + + + diff --git a/sdk/batch/Microsoft.Azure.Batch/changelog.md b/sdk/batch/Microsoft.Azure.Batch/changelog.md index 82ab87c7c53f..aa337a899a59 100644 --- a/sdk/batch/Microsoft.Azure.Batch/changelog.md +++ b/sdk/batch/Microsoft.Azure.Batch/changelog.md @@ -1,5 +1,20 @@ # Microsoft.Azure.Batch release notes +## Changes in 12.0.0 +### Features +- Added ability to specify a collection of public IPs on `NetworkConfiguration` via the new `PublicIPs` property. This guarantees nodes in the Pool will have an + IP from the list user provided IPs. +- Added ability to mount remote file-systems on each node of a pool via the `MountConfiguration` property on `CloudPool`. +- Shared Image Gallery images can now be specified on the `VirtualMachineImageId` property of `ImageReference` by referencing the image via its ARM ID. +- **[Breaking]** When not specified, the default value for `WaitForSuccess` on `StartTask` is now `true` (was `false`). +- **[Breaking]** When not specified, the default value for `Scope` on `AutoUserSpecification` is now always `Pool` (was `Task` on Windows nodes, `Pool` on Linux nodes). + +### Bug fixes + - Improved various confusing or incomplete documentation. + +### REST API version +This version of the Batch .NET client library targets version 2019-08-01.10.0 of the Azure Batch REST API. + ## Changes in 11.0.0 ### Features - Added `maxBackoff` parameter to `RetryPolicyProvider.ExponentialRetryProvider`. This option was already available on the `ExponentialRetry` constructor, diff --git a/sdk/batch/Microsoft.Azure.Batch/src/AddTaskResult.cs b/sdk/batch/Microsoft.Azure.Batch/src/AddTaskResult.cs index 86316c3029a1..abc2f9295f12 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/AddTaskResult.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/AddTaskResult.cs @@ -43,13 +43,15 @@ public override string ToString() { StringBuilder builder = new StringBuilder(); - builder.AppendFormat("TaskId={0}", this.TaskId); - builder.AppendFormat(", Status={0}", this.Status); - builder.AppendFormat(", Error.Code={0}", this.Error?.Code); - builder.AppendFormat(", Error.Message={0}", this.Error?.Message?.Value); + builder.Append($"TaskId={this.TaskId}"); + builder.Append($", Status={this.Status}"); + builder.Append($", Error.Code={this.Error?.Code}"); + builder.Append($", Error.Message={this.Error?.Message?.Value}"); if (this.Error?.Values != null) { - builder.AppendFormat(", Error.Values=[{0}]", string.Join(", ", this.Error.Values.Select(value => string.Format("{0}={1}", value.Key, value.Value)))); + builder.AppendFormat( + System.Globalization.CultureInfo.CurrentCulture, + ", Error.Values=[{0}]", string.Join(", ", this.Error.Values.Select(value => $"{value.Key}={value.Value}"))); } return builder.ToString(); diff --git a/sdk/batch/Microsoft.Azure.Batch/src/AddTasksWorkflowManager.cs b/sdk/batch/Microsoft.Azure.Batch/src/AddTasksWorkflowManager.cs index 023de078aefa..2d275f70b093 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/AddTasksWorkflowManager.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/AddTasksWorkflowManager.cs @@ -6,6 +6,7 @@ using System; using System.Collections.Concurrent; using System.Collections.Generic; + using System.Globalization; using System.Linq; using System.Threading; using System.Threading.Tasks; @@ -79,7 +80,8 @@ internal AddTasksWorkflowManager( //Validation that there is a handler for AddTaskResult if (this._addTaskResultHandlerCollection.Count == 0) { - throw new BatchClientException(string.Format(BatchErrorMessages.GeneralBehaviorMissing, typeof(AddTaskCollectionResultHandler))); + throw new BatchClientException( + string.Format(CultureInfo.InvariantCulture, BatchErrorMessages.GeneralBehaviorMissing, typeof(AddTaskCollectionResultHandler))); } } @@ -92,7 +94,7 @@ public async System.Threading.Tasks.Task AddTasksAsync(IEnumerable ta if (original != HasNotRun) { - throw new RunOnceException(string.Format(BatchErrorMessages.CanOnlyBeRunOnceFailure, this.GetType().Name)); + throw new RunOnceException(string.Format(CultureInfo.InvariantCulture, BatchErrorMessages.CanOnlyBeRunOnceFailure, this.GetType().Name)); } //Determine what time to timeout at @@ -127,7 +129,7 @@ public async System.Threading.Tasks.Task AddTasksAsync(IEnumerable ta { if (cloudTask == null) { - throw new ArgumentNullException("tasksToAdd", BatchErrorMessages.CollectionMustNotContainNull); + throw new ArgumentNullException(nameof(tasksToAdd), BatchErrorMessages.CollectionMustNotContainNull); } if (cloudTask.BindingState == BindingState.Bound) diff --git a/sdk/batch/Microsoft.Azure.Batch/src/AzureBatch.ruleset b/sdk/batch/Microsoft.Azure.Batch/src/AzureBatch.ruleset new file mode 100644 index 000000000000..9e02544fb018 --- /dev/null +++ b/sdk/batch/Microsoft.Azure.Batch/src/AzureBatch.ruleset @@ -0,0 +1,121 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/sdk/batch/Microsoft.Azure.Batch/src/AzureBlobFileSystemConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/AzureBlobFileSystemConfiguration.cs new file mode 100644 index 000000000000..30e921ffffea --- /dev/null +++ b/sdk/batch/Microsoft.Azure.Batch/src/AzureBlobFileSystemConfiguration.cs @@ -0,0 +1,29 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License.txt in the project root for license information. + +namespace Microsoft.Azure.Batch +{ + using System; + + public partial class AzureBlobFileSystemConfiguration + { + /// + /// Initializes a new instance of the class. + /// + /// The Azure Storage account name. + /// The Azure Blob Storage Container name. + /// The relative path on the compute node where the file system will be mounted. + /// The key to use to authenticate with Azure Storage. This can be either a SAS key or a Storage Account Key. + /// Additional command line options to pass to the mount command. + public AzureBlobFileSystemConfiguration( + string accountName, + string containerName, + string relativeMountPath, + AzureStorageAuthenticationKey key, + string blobfuseOptions = default(string)) : this(accountName, containerName, relativeMountPath, blobfuseOptions: blobfuseOptions) + { + SasKey = key.SasKey; + AccountKey = key.AccountKey; + } + } +} diff --git a/sdk/batch/Microsoft.Azure.Batch/src/AzureStorageAuthenticationKey.cs b/sdk/batch/Microsoft.Azure.Batch/src/AzureStorageAuthenticationKey.cs new file mode 100644 index 000000000000..e1b0cefe68ab --- /dev/null +++ b/sdk/batch/Microsoft.Azure.Batch/src/AzureStorageAuthenticationKey.cs @@ -0,0 +1,40 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License.txt in the project root for license information. + +namespace Microsoft.Azure.Batch +{ + using System; + + public sealed class AzureStorageAuthenticationKey + { + /// + /// Gets the Azure Storage Account key. + /// + public string AccountKey { get; } + + /// + /// Gets the Azure Storage SAS key. + /// + public string SasKey { get; } + + private AzureStorageAuthenticationKey(string accountKey = null, string sasKey = null) + { + AccountKey = accountKey; + SasKey = sasKey; + } + + /// + /// Creates a new referencing an Azure Storage Account key. + /// + /// The Storage Account key. + /// A new referencing the Azure Storage Account key. + public static AzureStorageAuthenticationKey FromAccountKey(string key) => new AzureStorageAuthenticationKey(accountKey: key); + + /// + /// Creates a new referencing an Azure Storage SAS key. + /// + /// The Storage SAS key. + /// A new referencing the Azure Storage SAS key. + public static AzureStorageAuthenticationKey FromSasKey(string key) => new AzureStorageAuthenticationKey(sasKey: key); + } +} diff --git a/sdk/batch/Microsoft.Azure.Batch/src/BatchClientExceptions.cs b/sdk/batch/Microsoft.Azure.Batch/src/BatchClientExceptions.cs index 404c7745826a..2332ac0ec252 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/BatchClientExceptions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/BatchClientExceptions.cs @@ -39,7 +39,7 @@ internal AddTaskCollectionTerminatedException(AddTaskResult result, Exception in private static string GenerateMessageString(AddTaskResult result) { - return string.Format(BatchErrorMessages.AddTaskCollectionTerminated, result); + return string.Format(System.Globalization.CultureInfo.InvariantCulture, BatchErrorMessages.AddTaskCollectionTerminated, result); } } @@ -64,13 +64,13 @@ internal ParallelOperationsException(string message, IEnumerable inne public override string ToString() { StringBuilder builder = new StringBuilder(); - builder.AppendFormat("{0}: ", this.GetType()).AppendLine(this.Message); + builder.Append($"{this.GetType()}: ").AppendLine(this.Message); builder.AppendLine(this.StackTrace); builder.AppendLine(); for (int i = 0; i < this.InnerExceptions.Count; i++) { - builder.AppendFormat("Exception #{0}:", i).AppendLine(); + builder.Append($"Exception #{i}:").AppendLine(); builder.Append(this.InnerExceptions[i]).AppendLine().AppendLine(); } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/CertificateOperations.cs b/sdk/batch/Microsoft.Azure.Batch/src/CertificateOperations.cs index 777a222b4865..ac7a810f92fe 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/CertificateOperations.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/CertificateOperations.cs @@ -5,6 +5,7 @@ { using System; using System.Collections.Generic; + using System.Globalization; using System.Security.Cryptography.X509Certificates; using System.Threading; using System.Threading.Tasks; @@ -228,7 +229,7 @@ private Models.CertificateAddParameter GetCertificateInfo(byte[] rawData) private static Models.CertificateAddParameter CreateAddCertificateEntity(byte[] rawData, X509Certificate2 certificate) { Models.CertificateAddParameter cert = new Models.CertificateAddParameter(); - cert.Thumbprint = certificate.Thumbprint.ToLower(); + cert.Thumbprint = certificate.Thumbprint.ToLowerInvariant(); //ThumbprintAlgorithm is always SHA1 since thumbprint is dynamically generated from the cert body cert.ThumbprintAlgorithm = KnownCertificateAlgorithm; diff --git a/sdk/batch/Microsoft.Azure.Batch/src/Common/BatchException.cs b/sdk/batch/Microsoft.Azure.Batch/src/Common/BatchException.cs index 60f1b1261211..0b824747be39 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/Common/BatchException.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/Common/BatchException.cs @@ -98,22 +98,17 @@ public override string ToString() if (this.RequestInformation.BatchError != null) { - sb.AppendFormat("\n\nError Code = {0},", - this.RequestInformation.BatchError.Code); + sb.Append($"\n\nError Code = {this.RequestInformation.BatchError.Code},"); if (this.RequestInformation.BatchError.Message != null) { - sb.AppendFormat(" Lang={0}, Message = {1}\nAdditional Values:\n", - this.RequestInformation.BatchError.Message.Language, - this.RequestInformation.BatchError.Message.Value); + sb.Append($" Lang={this.RequestInformation.BatchError.Message.Language}, Message = {this.RequestInformation.BatchError.Message.Value}\nAdditional Values:\n"); } if (this.RequestInformation.BatchError.Values != null) { foreach (var item in this.RequestInformation.BatchError.Values) { - sb.AppendFormat("Error Details key={0} value={1}\n", - item.Key, - item.Value); + sb.Append($"Error Details key={item.Key} value={item.Value}\n"); } } } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/FileStaging/FileStagingUtils.cs b/sdk/batch/Microsoft.Azure.Batch/src/FileStaging/FileStagingUtils.cs index 7b64201c8160..7a4582996032 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/FileStaging/FileStagingUtils.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/FileStaging/FileStagingUtils.cs @@ -57,12 +57,12 @@ internal static async Task StageFilesAsync(List filesToSta { if (null == allFileStagingArtifacts) { - throw new ArgumentNullException("allFileStagingArtifacts"); + throw new ArgumentNullException(nameof(allFileStagingArtifacts)); } if (allFileStagingArtifacts.Count > 0) { - throw new ArgumentOutOfRangeException("allFileStagingArtifacts.Count"); + throw new ArgumentOutOfRangeException(nameof(allFileStagingArtifacts)); } // first we get the buckets. One for each file staging provider that contains only the files for that provider. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/Generated/AutoUserSpecification.cs b/sdk/batch/Microsoft.Azure.Batch/src/Generated/AutoUserSpecification.cs index f11bb38efe80..43f1ff283522 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/Generated/AutoUserSpecification.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/Generated/AutoUserSpecification.cs @@ -26,7 +26,7 @@ public partial class AutoUserSpecification : ITransportObjectProvider /// Initializes a new instance of the class. /// - /// The scope for the auto user. If omitted, the default is . + /// The scope for the auto user. If omitted, the default is . /// The elevation level of the auto user. If omitted, the default is . public AutoUserSpecification( Common.AutoUserScope? scope = default(Common.AutoUserScope?), @@ -52,8 +52,14 @@ internal AutoUserSpecification(Models.AutoUserSpecification protocolObject) public Common.ElevationLevel? ElevationLevel { get; } /// - /// Gets the scope for the auto user. If omitted, the default is . + /// Gets the scope for the auto user. If omitted, the default is . /// + /// + /// If the pool is running Windows a value of should be specified if stricter + /// isolation between tasks is required. For example, if the Task mutates the registry in a way which could impact + /// other Tasks, or if Certificates have been specified on the pool which should not be accessible by normal tasks + /// but should be accessible by StartTasks. + /// public Common.AutoUserScope? Scope { get; } #endregion // AutoUserSpecification diff --git a/sdk/batch/Microsoft.Azure.Batch/src/Generated/AzureBlobFileSystemConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/Generated/AzureBlobFileSystemConfiguration.cs new file mode 100644 index 000000000000..f335af010e26 --- /dev/null +++ b/sdk/batch/Microsoft.Azure.Batch/src/Generated/AzureBlobFileSystemConfiguration.cs @@ -0,0 +1,147 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License.txt in the project root for license information. +// +// Code generated by Microsoft (R) AutoRest Code Generator. +// Changes may cause incorrect behavior and will be lost if the code is +// regenerated. + +// +// This file was autogenerated by a tool. +// Do not modify it. +// + +namespace Microsoft.Azure.Batch +{ + using Models = Microsoft.Azure.Batch.Protocol.Models; + using System; + using System.Collections.Generic; + using System.Linq; + + /// + /// Information used to connect to an Azure Storage Container using Blobfuse. + /// + public partial class AzureBlobFileSystemConfiguration : ITransportObjectProvider, IPropertyMetadata + { + #region Constructors + /// + /// Initializes a new instance of the class. + /// + /// The Azure Storage account name. + /// The Azure Blob Storage Container name. + /// The relative path on the compute node where the file system will be mounted. + /// The Azure Storage Account key. This property is mutually exclusive with . + /// The Azure Storage SAS token. This property is mutually exclusive with . + /// Additional command line options to pass to the mount command. + internal AzureBlobFileSystemConfiguration( + string accountName, + string containerName, + string relativeMountPath, + string accountKey = default(string), + string sasKey = default(string), + string blobfuseOptions = default(string)) + { + this.AccountName = accountName; + this.ContainerName = containerName; + this.RelativeMountPath = relativeMountPath; + this.AccountKey = accountKey; + this.SasKey = sasKey; + this.BlobfuseOptions = blobfuseOptions; + } + + internal AzureBlobFileSystemConfiguration(Models.AzureBlobFileSystemConfiguration protocolObject) + { + this.AccountKey = protocolObject.AccountKey; + this.AccountName = protocolObject.AccountName; + this.BlobfuseOptions = protocolObject.BlobfuseOptions; + this.ContainerName = protocolObject.ContainerName; + this.RelativeMountPath = protocolObject.RelativeMountPath; + this.SasKey = protocolObject.SasKey; + } + + #endregion Constructors + + #region AzureBlobFileSystemConfiguration + + /// + /// Gets the Azure Storage Account key. This property is mutually exclusive with . + /// + public string AccountKey { get; } + + /// + /// Gets the Azure Storage account name. + /// + public string AccountName { get; } + + /// + /// Gets additional command line options to pass to the mount command. + /// + /// + /// These are 'net use' options in Windows and 'mount' options in Linux. + /// + public string BlobfuseOptions { get; } + + /// + /// Gets the Azure Blob Storage Container name. + /// + public string ContainerName { get; } + + /// + /// Gets the relative path on the compute node where the file system will be mounted. + /// + /// + /// All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR + /// environment variable. + /// + public string RelativeMountPath { get; } + + /// + /// Gets the Azure Storage SAS token. This property is mutually exclusive with . + /// + public string SasKey { get; } + + #endregion // AzureBlobFileSystemConfiguration + + #region IPropertyMetadata + + bool IModifiable.HasBeenModified + { + //This class is compile time readonly so it cannot have been modified + get { return false; } + } + + bool IReadOnly.IsReadOnly + { + get { return true; } + set + { + // This class is compile time readonly already + } + } + + #endregion // IPropertyMetadata + + #region Internal/private methods + + /// + /// Return a protocol object of the requested type. + /// + /// The protocol object of the requested type. + Models.AzureBlobFileSystemConfiguration ITransportObjectProvider.GetTransportObject() + { + Models.AzureBlobFileSystemConfiguration result = new Models.AzureBlobFileSystemConfiguration() + { + AccountKey = this.AccountKey, + AccountName = this.AccountName, + BlobfuseOptions = this.BlobfuseOptions, + ContainerName = this.ContainerName, + RelativeMountPath = this.RelativeMountPath, + SasKey = this.SasKey, + }; + + return result; + } + + + #endregion // Internal/private methods + } +} \ No newline at end of file diff --git a/sdk/batch/Microsoft.Azure.Batch/src/Generated/AzureFileShareConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/Generated/AzureFileShareConfiguration.cs new file mode 100644 index 000000000000..957a7bdf5287 --- /dev/null +++ b/sdk/batch/Microsoft.Azure.Batch/src/Generated/AzureFileShareConfiguration.cs @@ -0,0 +1,140 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License.txt in the project root for license information. +// +// Code generated by Microsoft (R) AutoRest Code Generator. +// Changes may cause incorrect behavior and will be lost if the code is +// regenerated. + +// +// This file was autogenerated by a tool. +// Do not modify it. +// + +namespace Microsoft.Azure.Batch +{ + using Models = Microsoft.Azure.Batch.Protocol.Models; + using System; + using System.Collections.Generic; + using System.Linq; + + /// + /// Information used to connect to an Azure Fileshare. + /// + public partial class AzureFileShareConfiguration : ITransportObjectProvider, IPropertyMetadata + { + #region Constructors + /// + /// Initializes a new instance of the class. + /// + /// The Azure Storage Account name. + /// The Azure Files URL. + /// The relative path on the compute node where the file system will be mounted. + /// The Azure Storage Account key. + /// Additional command line options to pass to the mount command. + public AzureFileShareConfiguration( + string accountName, + string azureFileUrl, + string relativeMountPath, + string accountKey, + string mountOptions = default(string)) + { + this.AccountName = accountName; + this.AzureFileUrl = azureFileUrl; + this.RelativeMountPath = relativeMountPath; + this.AccountKey = accountKey; + this.MountOptions = mountOptions; + } + + internal AzureFileShareConfiguration(Models.AzureFileShareConfiguration protocolObject) + { + this.AccountKey = protocolObject.AccountKey; + this.AccountName = protocolObject.AccountName; + this.AzureFileUrl = protocolObject.AzureFileUrl; + this.MountOptions = protocolObject.MountOptions; + this.RelativeMountPath = protocolObject.RelativeMountPath; + } + + #endregion Constructors + + #region AzureFileShareConfiguration + + /// + /// Gets the Azure Storage Account key. + /// + public string AccountKey { get; } + + /// + /// Gets the Azure Storage Account name. + /// + public string AccountName { get; } + + /// + /// Gets the Azure Files URL. + /// + /// + /// This is of the form 'https://myaccount.file.core.windows.net/'. + /// + public string AzureFileUrl { get; } + + /// + /// Gets additional command line options to pass to the mount command. + /// + /// + /// These are 'net use' options in Windows and 'mount' options in Linux. + /// + public string MountOptions { get; } + + /// + /// Gets the relative path on the compute node where the file system will be mounted. + /// + /// + /// All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR + /// environment variable. + /// + public string RelativeMountPath { get; } + + #endregion // AzureFileShareConfiguration + + #region IPropertyMetadata + + bool IModifiable.HasBeenModified + { + //This class is compile time readonly so it cannot have been modified + get { return false; } + } + + bool IReadOnly.IsReadOnly + { + get { return true; } + set + { + // This class is compile time readonly already + } + } + + #endregion // IPropertyMetadata + + #region Internal/private methods + + /// + /// Return a protocol object of the requested type. + /// + /// The protocol object of the requested type. + Models.AzureFileShareConfiguration ITransportObjectProvider.GetTransportObject() + { + Models.AzureFileShareConfiguration result = new Models.AzureFileShareConfiguration() + { + AccountKey = this.AccountKey, + AccountName = this.AccountName, + AzureFileUrl = this.AzureFileUrl, + MountOptions = this.MountOptions, + RelativeMountPath = this.RelativeMountPath, + }; + + return result; + } + + + #endregion // Internal/private methods + } +} \ No newline at end of file diff --git a/sdk/batch/Microsoft.Azure.Batch/src/Generated/CifsMountConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/Generated/CifsMountConfiguration.cs new file mode 100644 index 000000000000..5b5f45283192 --- /dev/null +++ b/sdk/batch/Microsoft.Azure.Batch/src/Generated/CifsMountConfiguration.cs @@ -0,0 +1,137 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License.txt in the project root for license information. +// +// Code generated by Microsoft (R) AutoRest Code Generator. +// Changes may cause incorrect behavior and will be lost if the code is +// regenerated. + +// +// This file was autogenerated by a tool. +// Do not modify it. +// + +namespace Microsoft.Azure.Batch +{ + using Models = Microsoft.Azure.Batch.Protocol.Models; + using System; + using System.Collections.Generic; + using System.Linq; + + /// + /// Information used to connect to a CIFS file system. + /// + public partial class CifsMountConfiguration : ITransportObjectProvider, IPropertyMetadata + { + #region Constructors + /// + /// Initializes a new instance of the class. + /// + /// The user to use for authentication against the CIFS file system. + /// The password to use for authentication against the CIFS file system. + /// The URI of the file system to mount. + /// The relative path on the compute node where the file system will be mounted. + /// Additional command line options to pass to the mount command. + public CifsMountConfiguration( + string username, + string password, + string source, + string relativeMountPath, + string mountOptions = default(string)) + { + this.Username = username; + this.Password = password; + this.Source = source; + this.RelativeMountPath = relativeMountPath; + this.MountOptions = mountOptions; + } + + internal CifsMountConfiguration(Models.CIFSMountConfiguration protocolObject) + { + this.MountOptions = protocolObject.MountOptions; + this.Password = protocolObject.Password; + this.RelativeMountPath = protocolObject.RelativeMountPath; + this.Source = protocolObject.Source; + this.Username = protocolObject.Username; + } + + #endregion Constructors + + #region CifsMountConfiguration + + /// + /// Gets additional command line options to pass to the mount command. + /// + /// + /// These are 'net use' options in Windows and 'mount' options in Linux. + /// + public string MountOptions { get; } + + /// + /// Gets the password to use for authentication against the CIFS file system. + /// + public string Password { get; } + + /// + /// Gets the relative path on the compute node where the file system will be mounted. + /// + /// + /// All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR + /// environment variable. + /// + public string RelativeMountPath { get; } + + /// + /// Gets the URI of the file system to mount. + /// + public string Source { get; } + + /// + /// Gets the user to use for authentication against the CIFS file system. + /// + public string Username { get; } + + #endregion // CifsMountConfiguration + + #region IPropertyMetadata + + bool IModifiable.HasBeenModified + { + //This class is compile time readonly so it cannot have been modified + get { return false; } + } + + bool IReadOnly.IsReadOnly + { + get { return true; } + set + { + // This class is compile time readonly already + } + } + + #endregion // IPropertyMetadata + + #region Internal/private methods + + /// + /// Return a protocol object of the requested type. + /// + /// The protocol object of the requested type. + Models.CIFSMountConfiguration ITransportObjectProvider.GetTransportObject() + { + Models.CIFSMountConfiguration result = new Models.CIFSMountConfiguration() + { + MountOptions = this.MountOptions, + Password = this.Password, + RelativeMountPath = this.RelativeMountPath, + Source = this.Source, + Username = this.Username, + }; + + return result; + } + + + #endregion // Internal/private methods + } +} \ No newline at end of file diff --git a/sdk/batch/Microsoft.Azure.Batch/src/Generated/CloudPool.cs b/sdk/batch/Microsoft.Azure.Batch/src/Generated/CloudPool.cs index de64d4316da6..9e4c9c6bddb4 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/Generated/CloudPool.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/Generated/CloudPool.cs @@ -44,6 +44,7 @@ private class PropertyContainer : PropertyCollection public readonly PropertyAccessor LastModifiedProperty; public readonly PropertyAccessor MaxTasksPerComputeNodeProperty; public readonly PropertyAccessor> MetadataProperty; + public readonly PropertyAccessor> MountConfigurationProperty; public readonly PropertyAccessor NetworkConfigurationProperty; public readonly PropertyAccessor> ResizeErrorsProperty; public readonly PropertyAccessor ResizeTimeoutProperty; @@ -81,6 +82,7 @@ public PropertyContainer() : base(BindingState.Unbound) this.LastModifiedProperty = this.CreatePropertyAccessor(nameof(LastModified), BindingAccess.None); this.MaxTasksPerComputeNodeProperty = this.CreatePropertyAccessor(nameof(MaxTasksPerComputeNode), BindingAccess.Read | BindingAccess.Write); this.MetadataProperty = this.CreatePropertyAccessor>(nameof(Metadata), BindingAccess.Read | BindingAccess.Write); + this.MountConfigurationProperty = this.CreatePropertyAccessor>(nameof(MountConfiguration), BindingAccess.Read | BindingAccess.Write); this.NetworkConfigurationProperty = this.CreatePropertyAccessor(nameof(NetworkConfiguration), BindingAccess.Read | BindingAccess.Write); this.ResizeErrorsProperty = this.CreatePropertyAccessor>(nameof(ResizeErrors), BindingAccess.None); this.ResizeTimeoutProperty = this.CreatePropertyAccessor(nameof(ResizeTimeout), BindingAccess.Read | BindingAccess.Write); @@ -179,6 +181,10 @@ public PropertyContainer(Models.CloudPool protocolObject) : base(BindingState.Bo MetadataItem.ConvertFromProtocolCollection(protocolObject.Metadata), nameof(Metadata), BindingAccess.Read | BindingAccess.Write); + this.MountConfigurationProperty = this.CreatePropertyAccessor( + Batch.MountConfiguration.ConvertFromProtocolCollectionAndFreeze(protocolObject.MountConfiguration), + nameof(MountConfiguration), + BindingAccess.Read); this.NetworkConfigurationProperty = this.CreatePropertyAccessor( UtilitiesInternal.CreateObjectWithNullCheck(protocolObject.NetworkConfiguration, o => new NetworkConfiguration(o).Freeze()), nameof(NetworkConfiguration), @@ -508,6 +514,21 @@ public IList Metadata } } + /// + /// Gets or sets a list of file systems to mount on each node in the pool. + /// + /// + /// This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. + /// + public IList MountConfiguration + { + get { return this.propertyContainer.MountConfigurationProperty.Value; } + set + { + this.propertyContainer.MountConfigurationProperty.Value = ConcurrentChangeTrackedModifiableList.TransformEnumerableToConcurrentModifiableList(value); + } + } + /// /// Gets or sets the network configuration of the pool. /// @@ -692,6 +713,7 @@ bool IReadOnly.IsReadOnly EnableInterNodeCommunication = this.InterComputeNodeCommunicationEnabled, MaxTasksPerNode = this.MaxTasksPerComputeNode, Metadata = UtilitiesInternal.ConvertToProtocolCollection(this.Metadata), + MountConfiguration = UtilitiesInternal.ConvertToProtocolCollection(this.MountConfiguration), NetworkConfiguration = UtilitiesInternal.CreateObjectWithNullCheck(this.NetworkConfiguration, (o) => o.GetTransportObject()), ResizeTimeout = this.ResizeTimeout, StartTask = UtilitiesInternal.CreateObjectWithNullCheck(this.StartTask, (o) => o.GetTransportObject()), diff --git a/sdk/batch/Microsoft.Azure.Batch/src/Generated/ImageReference.cs b/sdk/batch/Microsoft.Azure.Batch/src/Generated/ImageReference.cs index bd40d3037469..96dc04a9e66d 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/Generated/ImageReference.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/Generated/ImageReference.cs @@ -58,7 +58,7 @@ internal ImageReference(Models.ImageReference protocolObject) /// Gets the SKU of the Azure Virtual Machines Marketplace Image. /// /// - /// For example, 14.04.0-LTS or 2012-R2-Datacenter. + /// For example, 18.04-LTS or 2019-Datacenter. /// public string Sku { get; } @@ -71,13 +71,16 @@ internal ImageReference(Models.ImageReference protocolObject) public string Version { get; } /// - /// Gets the ARM resource identifier of the Virtual Machine Image. Computes nodes of the pool will be created using - /// this custom image. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName} + /// Gets the ARM resource identifier of the Virtual Machine Image or Shared Image Gallery Image. Computes Compute + /// Nodes of the Pool will be created using this Image Id. This is of either the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName} + /// for Virtual Machine Image or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId} + /// for SIG image. /// /// - /// This property is mutually exclusive with other ImageReference properties. The virtual machine image must be in - /// the same region and subscription as the Azure Batch account. For information about the firewall settings for - /// the Batch Node Agent to communicate with Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. + /// This property is mutually exclusive with other properties. For Virtual Machine Image + /// it must be in the same region and subscription as the Azure Batch account. For SIG image it must have replicas + /// in the same region as the Azure Batch account. For information about the firewall settings for the Batch Compute + /// Node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. /// public string VirtualMachineImageId { get; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/Generated/MountConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/Generated/MountConfiguration.cs new file mode 100644 index 000000000000..796dea345ee0 --- /dev/null +++ b/sdk/batch/Microsoft.Azure.Batch/src/Generated/MountConfiguration.cs @@ -0,0 +1,160 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License.txt in the project root for license information. +// +// Code generated by Microsoft (R) AutoRest Code Generator. +// Changes may cause incorrect behavior and will be lost if the code is +// regenerated. + +// +// This file was autogenerated by a tool. +// Do not modify it. +// + +namespace Microsoft.Azure.Batch +{ + using Models = Microsoft.Azure.Batch.Protocol.Models; + using System; + using System.Collections.Generic; + using System.Linq; + + /// + /// The file system to mount on each node. + /// + public partial class MountConfiguration : ITransportObjectProvider, IPropertyMetadata + { + #region Constructors + /// + /// Initializes a new instance of the class. + /// + /// The Azure Storage Container to mount using blob FUSE on each node. + /// The NFS file system to mount on each node. + /// The CIFS/SMB file system to mount on each node. + /// The Azure File Share to mount on each node. + internal MountConfiguration( + AzureBlobFileSystemConfiguration azureBlobFileSystemConfiguration = default(AzureBlobFileSystemConfiguration), + NfsMountConfiguration nfsMountConfiguration = default(NfsMountConfiguration), + CifsMountConfiguration cifsMountConfiguration = default(CifsMountConfiguration), + AzureFileShareConfiguration azureFileShareConfiguration = default(AzureFileShareConfiguration)) + { + this.AzureBlobFileSystemConfiguration = azureBlobFileSystemConfiguration; + this.NfsMountConfiguration = nfsMountConfiguration; + this.CifsMountConfiguration = cifsMountConfiguration; + this.AzureFileShareConfiguration = azureFileShareConfiguration; + } + + internal MountConfiguration(Models.MountConfiguration protocolObject) + { + this.AzureBlobFileSystemConfiguration = UtilitiesInternal.CreateObjectWithNullCheck(protocolObject.AzureBlobFileSystemConfiguration, o => new AzureBlobFileSystemConfiguration(o).Freeze()); + this.AzureFileShareConfiguration = UtilitiesInternal.CreateObjectWithNullCheck(protocolObject.AzureFileShareConfiguration, o => new AzureFileShareConfiguration(o).Freeze()); + this.CifsMountConfiguration = UtilitiesInternal.CreateObjectWithNullCheck(protocolObject.CifsMountConfiguration, o => new CifsMountConfiguration(o).Freeze()); + this.NfsMountConfiguration = UtilitiesInternal.CreateObjectWithNullCheck(protocolObject.NfsMountConfiguration, o => new NfsMountConfiguration(o).Freeze()); + } + + #endregion Constructors + + #region MountConfiguration + + /// + /// Gets the Azure Storage Container to mount using blob FUSE on each node. + /// + public AzureBlobFileSystemConfiguration AzureBlobFileSystemConfiguration { get; } + + /// + /// Gets the Azure File Share to mount on each node. + /// + public AzureFileShareConfiguration AzureFileShareConfiguration { get; } + + /// + /// Gets the CIFS/SMB file system to mount on each node. + /// + public CifsMountConfiguration CifsMountConfiguration { get; } + + /// + /// Gets the NFS file system to mount on each node. + /// + public NfsMountConfiguration NfsMountConfiguration { get; } + + #endregion // MountConfiguration + + #region IPropertyMetadata + + bool IModifiable.HasBeenModified + { + //This class is compile time readonly so it cannot have been modified + get { return false; } + } + + bool IReadOnly.IsReadOnly + { + get { return true; } + set + { + // This class is compile time readonly already + } + } + + #endregion // IPropertyMetadata + + #region Internal/private methods + + /// + /// Return a protocol object of the requested type. + /// + /// The protocol object of the requested type. + Models.MountConfiguration ITransportObjectProvider.GetTransportObject() + { + Models.MountConfiguration result = new Models.MountConfiguration() + { + AzureBlobFileSystemConfiguration = UtilitiesInternal.CreateObjectWithNullCheck(this.AzureBlobFileSystemConfiguration, (o) => o.GetTransportObject()), + AzureFileShareConfiguration = UtilitiesInternal.CreateObjectWithNullCheck(this.AzureFileShareConfiguration, (o) => o.GetTransportObject()), + CifsMountConfiguration = UtilitiesInternal.CreateObjectWithNullCheck(this.CifsMountConfiguration, (o) => o.GetTransportObject()), + NfsMountConfiguration = UtilitiesInternal.CreateObjectWithNullCheck(this.NfsMountConfiguration, (o) => o.GetTransportObject()), + }; + + return result; + } + + /// + /// Converts a collection of protocol layer objects to object layer collection objects. + /// + internal static IList ConvertFromProtocolCollection(IEnumerable protoCollection) + { + ConcurrentChangeTrackedModifiableList converted = UtilitiesInternal.CollectionToThreadSafeCollectionIModifiable( + items: protoCollection, + objectCreationFunc: o => new MountConfiguration(o)); + + return converted; + } + + /// + /// Converts a collection of protocol layer objects to object layer collection objects, in a frozen state. + /// + internal static IList ConvertFromProtocolCollectionAndFreeze(IEnumerable protoCollection) + { + ConcurrentChangeTrackedModifiableList converted = UtilitiesInternal.CollectionToThreadSafeCollectionIModifiable( + items: protoCollection, + objectCreationFunc: o => new MountConfiguration(o).Freeze()); + + converted = UtilitiesInternal.CreateObjectWithNullCheck(converted, o => o.Freeze()); + + return converted; + } + + /// + /// Converts a collection of protocol layer objects to object layer collection objects, with each object marked readonly + /// and returned as a readonly collection. + /// + internal static IReadOnlyList ConvertFromProtocolCollectionReadOnly(IEnumerable protoCollection) + { + IReadOnlyList converted = + UtilitiesInternal.CreateObjectWithNullCheck( + UtilitiesInternal.CollectionToNonThreadSafeCollection( + items: protoCollection, + objectCreationFunc: o => new MountConfiguration(o).Freeze()), o => o.AsReadOnly()); + + return converted; + } + + #endregion // Internal/private methods + } +} \ No newline at end of file diff --git a/sdk/batch/Microsoft.Azure.Batch/src/Generated/NetworkConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/Generated/NetworkConfiguration.cs index 364ad4828958..4598b742310d 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/Generated/NetworkConfiguration.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/Generated/NetworkConfiguration.cs @@ -26,12 +26,14 @@ private class PropertyContainer : PropertyCollection { public readonly PropertyAccessor DynamicVNetAssignmentScopeProperty; public readonly PropertyAccessor EndpointConfigurationProperty; + public readonly PropertyAccessor> PublicIPsProperty; public readonly PropertyAccessor SubnetIdProperty; public PropertyContainer() : base(BindingState.Unbound) { this.DynamicVNetAssignmentScopeProperty = this.CreatePropertyAccessor(nameof(DynamicVNetAssignmentScope), BindingAccess.Read | BindingAccess.Write); this.EndpointConfigurationProperty = this.CreatePropertyAccessor(nameof(EndpointConfiguration), BindingAccess.Read | BindingAccess.Write); + this.PublicIPsProperty = this.CreatePropertyAccessor>(nameof(PublicIPs), BindingAccess.Read | BindingAccess.Write); this.SubnetIdProperty = this.CreatePropertyAccessor(nameof(SubnetId), BindingAccess.Read | BindingAccess.Write); } @@ -45,6 +47,10 @@ public PropertyContainer(Models.NetworkConfiguration protocolObject) : base(Bind UtilitiesInternal.CreateObjectWithNullCheck(protocolObject.EndpointConfiguration, o => new PoolEndpointConfiguration(o).Freeze()), nameof(EndpointConfiguration), BindingAccess.Read); + this.PublicIPsProperty = this.CreatePropertyAccessor( + UtilitiesInternal.CollectionToThreadSafeCollection(protocolObject.PublicIPs, o => o), + nameof(PublicIPs), + BindingAccess.Read); this.SubnetIdProperty = this.CreatePropertyAccessor( protocolObject.SubnetId, nameof(SubnetId), @@ -97,6 +103,23 @@ public PoolEndpointConfiguration EndpointConfiguration set { this.propertyContainer.EndpointConfigurationProperty.Value = value; } } + /// + /// Gets or sets the list of public IPs which the Batch service will use when provisioning Compute Nodes. + /// + /// + /// The number of IPs specified here limits the maximum size of the Pool - 50 dedicated nodes or 20 low-priority + /// nodes can be allocated for each public IP. For example, a pool needing 150 dedicated VMs would need at least + /// 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. + /// + public IList PublicIPs + { + get { return this.propertyContainer.PublicIPsProperty.Value; } + set + { + this.propertyContainer.PublicIPsProperty.Value = ConcurrentChangeTrackedList.TransformEnumerableToConcurrentList(value); + } + } + /// /// Gets or sets the ARM resource identifier of the virtual network subnet which the compute nodes of the pool will /// join. @@ -152,6 +175,7 @@ bool IReadOnly.IsReadOnly { DynamicVNetAssignmentScope = UtilitiesInternal.MapNullableEnum(this.DynamicVNetAssignmentScope), EndpointConfiguration = UtilitiesInternal.CreateObjectWithNullCheck(this.EndpointConfiguration, (o) => o.GetTransportObject()), + PublicIPs = this.PublicIPs, SubnetId = this.SubnetId, }; diff --git a/sdk/batch/Microsoft.Azure.Batch/src/Generated/NfsMountConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/Generated/NfsMountConfiguration.cs new file mode 100644 index 000000000000..6ffb2f8fa9cf --- /dev/null +++ b/sdk/batch/Microsoft.Azure.Batch/src/Generated/NfsMountConfiguration.cs @@ -0,0 +1,117 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License.txt in the project root for license information. +// +// Code generated by Microsoft (R) AutoRest Code Generator. +// Changes may cause incorrect behavior and will be lost if the code is +// regenerated. + +// +// This file was autogenerated by a tool. +// Do not modify it. +// + +namespace Microsoft.Azure.Batch +{ + using Models = Microsoft.Azure.Batch.Protocol.Models; + using System; + using System.Collections.Generic; + using System.Linq; + + /// + /// Information used to connect to an NFS file system. + /// + public partial class NfsMountConfiguration : ITransportObjectProvider, IPropertyMetadata + { + #region Constructors + /// + /// Initializes a new instance of the class. + /// + /// The URI of the file system to mount. + /// The relative path on the compute node where the file system will be mounted. + /// Additional command line options to pass to the mount command. + public NfsMountConfiguration( + string source, + string relativeMountPath, + string mountOptions = default(string)) + { + this.Source = source; + this.RelativeMountPath = relativeMountPath; + this.MountOptions = mountOptions; + } + + internal NfsMountConfiguration(Models.NFSMountConfiguration protocolObject) + { + this.MountOptions = protocolObject.MountOptions; + this.RelativeMountPath = protocolObject.RelativeMountPath; + this.Source = protocolObject.Source; + } + + #endregion Constructors + + #region NfsMountConfiguration + + /// + /// Gets additional command line options to pass to the mount command. + /// + /// + /// These are 'net use' options in Windows and 'mount' options in Linux. + /// + public string MountOptions { get; } + + /// + /// Gets the relative path on the compute node where the file system will be mounted. + /// + /// + /// All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR + /// environment variable. + /// + public string RelativeMountPath { get; } + + /// + /// Gets the URI of the file system to mount. + /// + public string Source { get; } + + #endregion // NfsMountConfiguration + + #region IPropertyMetadata + + bool IModifiable.HasBeenModified + { + //This class is compile time readonly so it cannot have been modified + get { return false; } + } + + bool IReadOnly.IsReadOnly + { + get { return true; } + set + { + // This class is compile time readonly already + } + } + + #endregion // IPropertyMetadata + + #region Internal/private methods + + /// + /// Return a protocol object of the requested type. + /// + /// The protocol object of the requested type. + Models.NFSMountConfiguration ITransportObjectProvider.GetTransportObject() + { + Models.NFSMountConfiguration result = new Models.NFSMountConfiguration() + { + MountOptions = this.MountOptions, + RelativeMountPath = this.RelativeMountPath, + Source = this.Source, + }; + + return result; + } + + + #endregion // Internal/private methods + } +} \ No newline at end of file diff --git a/sdk/batch/Microsoft.Azure.Batch/src/Generated/PoolSpecification.cs b/sdk/batch/Microsoft.Azure.Batch/src/Generated/PoolSpecification.cs index 82ddbba5a80b..645e2af01f9f 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/Generated/PoolSpecification.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/Generated/PoolSpecification.cs @@ -35,6 +35,7 @@ private class PropertyContainer : PropertyCollection public readonly PropertyAccessor InterComputeNodeCommunicationEnabledProperty; public readonly PropertyAccessor MaxTasksPerComputeNodeProperty; public readonly PropertyAccessor> MetadataProperty; + public readonly PropertyAccessor> MountConfigurationProperty; public readonly PropertyAccessor NetworkConfigurationProperty; public readonly PropertyAccessor ResizeTimeoutProperty; public readonly PropertyAccessor StartTaskProperty; @@ -58,6 +59,7 @@ public PropertyContainer() : base(BindingState.Unbound) this.InterComputeNodeCommunicationEnabledProperty = this.CreatePropertyAccessor(nameof(InterComputeNodeCommunicationEnabled), BindingAccess.Read | BindingAccess.Write); this.MaxTasksPerComputeNodeProperty = this.CreatePropertyAccessor(nameof(MaxTasksPerComputeNode), BindingAccess.Read | BindingAccess.Write); this.MetadataProperty = this.CreatePropertyAccessor>(nameof(Metadata), BindingAccess.Read | BindingAccess.Write); + this.MountConfigurationProperty = this.CreatePropertyAccessor>(nameof(MountConfiguration), BindingAccess.Read | BindingAccess.Write); this.NetworkConfigurationProperty = this.CreatePropertyAccessor(nameof(NetworkConfiguration), BindingAccess.Read | BindingAccess.Write); this.ResizeTimeoutProperty = this.CreatePropertyAccessor(nameof(ResizeTimeout), BindingAccess.Read | BindingAccess.Write); this.StartTaskProperty = this.CreatePropertyAccessor(nameof(StartTask), BindingAccess.Read | BindingAccess.Write); @@ -115,6 +117,10 @@ public PropertyContainer(Models.PoolSpecification protocolObject) : base(Binding MetadataItem.ConvertFromProtocolCollection(protocolObject.Metadata), nameof(Metadata), BindingAccess.Read | BindingAccess.Write); + this.MountConfigurationProperty = this.CreatePropertyAccessor( + Batch.MountConfiguration.ConvertFromProtocolCollectionAndFreeze(protocolObject.MountConfiguration), + nameof(MountConfiguration), + BindingAccess.Read); this.NetworkConfigurationProperty = this.CreatePropertyAccessor( UtilitiesInternal.CreateObjectWithNullCheck(protocolObject.NetworkConfiguration, o => new NetworkConfiguration(o).Freeze()), nameof(NetworkConfiguration), @@ -315,6 +321,21 @@ public IList Metadata } } + /// + /// Gets or sets a list of file systems to mount on each node in the pool. + /// + /// + /// This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. + /// + public IList MountConfiguration + { + get { return this.propertyContainer.MountConfigurationProperty.Value; } + set + { + this.propertyContainer.MountConfigurationProperty.Value = ConcurrentChangeTrackedModifiableList.TransformEnumerableToConcurrentModifiableList(value); + } + } + /// /// Gets or sets the network configuration of the pool. /// @@ -458,6 +479,7 @@ bool IReadOnly.IsReadOnly EnableInterNodeCommunication = this.InterComputeNodeCommunicationEnabled, MaxTasksPerNode = this.MaxTasksPerComputeNode, Metadata = UtilitiesInternal.ConvertToProtocolCollection(this.Metadata), + MountConfiguration = UtilitiesInternal.ConvertToProtocolCollection(this.MountConfiguration), NetworkConfiguration = UtilitiesInternal.CreateObjectWithNullCheck(this.NetworkConfiguration, (o) => o.GetTransportObject()), ResizeTimeout = this.ResizeTimeout, StartTask = UtilitiesInternal.CreateObjectWithNullCheck(this.StartTask, (o) => o.GetTransportObject()), diff --git a/sdk/batch/Microsoft.Azure.Batch/src/Generated/StartTask.cs b/sdk/batch/Microsoft.Azure.Batch/src/Generated/StartTask.cs index 0db4b1e1bfad..d8903accc5e5 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/Generated/StartTask.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/Generated/StartTask.cs @@ -199,7 +199,7 @@ public UserIdentity UserIdentity /// any tasks on the compute node. /// /// - /// If this is not specified, the default is false. + /// If this is not specified, the default is true. /// public bool? WaitForSuccess { diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/AccountOperations.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/AccountOperations.cs index f58d1013aa48..50bf6925af6d 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/AccountOperations.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/AccountOperations.cs @@ -313,7 +313,7 @@ internal AccountOperations(BatchServiceClient client) } /// - /// Gets the number of nodes in each state, grouped by pool. + /// Gets the number of Compute Nodes in each state, grouped by Pool. /// /// /// Additional parameters for the operation @@ -800,7 +800,7 @@ internal AccountOperations(BatchServiceClient client) } /// - /// Gets the number of nodes in each state, grouped by pool. + /// Gets the number of Compute Nodes in each state, grouped by Pool. /// /// /// The NextLink from the previous successful call to List operation. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/AccountOperationsExtensions.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/AccountOperationsExtensions.cs index 1a29dda81148..e90197352bf1 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/AccountOperationsExtensions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/AccountOperationsExtensions.cs @@ -56,7 +56,7 @@ public static partial class AccountOperationsExtensions } /// - /// Gets the number of nodes in each state, grouped by pool. + /// Gets the number of Compute Nodes in each state, grouped by Pool. /// /// /// The operations group for this extension method. @@ -70,7 +70,7 @@ public static partial class AccountOperationsExtensions } /// - /// Gets the number of nodes in each state, grouped by pool. + /// Gets the number of Compute Nodes in each state, grouped by Pool. /// /// /// The operations group for this extension method. @@ -130,7 +130,7 @@ public static partial class AccountOperationsExtensions } /// - /// Gets the number of nodes in each state, grouped by pool. + /// Gets the number of Compute Nodes in each state, grouped by Pool. /// /// /// The operations group for this extension method. @@ -147,7 +147,7 @@ public static partial class AccountOperationsExtensions } /// - /// Gets the number of nodes in each state, grouped by pool. + /// Gets the number of Compute Nodes in each state, grouped by Pool. /// /// /// The operations group for this extension method. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ApplicationOperations.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ApplicationOperations.cs index 6543d5af2f24..ecf6ae0d3787 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ApplicationOperations.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ApplicationOperations.cs @@ -52,14 +52,14 @@ internal ApplicationOperations(BatchServiceClient client) public BatchServiceClient Client { get; private set; } /// - /// Lists all of the applications available in the specified account. + /// Lists all of the applications available in the specified Account. /// /// - /// This operation returns only applications and versions that are available - /// for use on compute nodes; that is, that can be used in an application - /// package reference. For administrator information about applications and - /// versions that are not yet available to compute nodes, use the Azure portal - /// or the Azure Resource Manager API. + /// This operation returns only Applications and versions that are available + /// for use on Compute Nodes; that is, that can be used in an Package + /// reference. For administrator information about applications and versions + /// that are not yet available to Compute Nodes, use the Azure portal or the + /// Azure Resource Manager API. /// /// /// Additional parameters for the operation @@ -310,17 +310,17 @@ internal ApplicationOperations(BatchServiceClient client) } /// - /// Gets information about the specified application. + /// Gets information about the specified Application. /// /// - /// This operation returns only applications and versions that are available - /// for use on compute nodes; that is, that can be used in an application - /// package reference. For administrator information about applications and - /// versions that are not yet available to compute nodes, use the Azure portal - /// or the Azure Resource Manager API. + /// This operation returns only Applications and versions that are available + /// for use on Compute Nodes; that is, that can be used in an Package + /// reference. For administrator information about Applications and versions + /// that are not yet available to Compute Nodes, use the Azure portal or the + /// Azure Resource Manager API. /// /// - /// The ID of the application. + /// The ID of the Application. /// /// /// Additional parameters for the operation @@ -567,14 +567,14 @@ internal ApplicationOperations(BatchServiceClient client) } /// - /// Lists all of the applications available in the specified account. + /// Lists all of the applications available in the specified Account. /// /// - /// This operation returns only applications and versions that are available - /// for use on compute nodes; that is, that can be used in an application - /// package reference. For administrator information about applications and - /// versions that are not yet available to compute nodes, use the Azure portal - /// or the Azure Resource Manager API. + /// This operation returns only Applications and versions that are available + /// for use on Compute Nodes; that is, that can be used in an Package + /// reference. For administrator information about applications and versions + /// that are not yet available to Compute Nodes, use the Azure portal or the + /// Azure Resource Manager API. /// /// /// The NextLink from the previous successful call to List operation. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ApplicationOperationsExtensions.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ApplicationOperationsExtensions.cs index 63d0a14e3aa7..3eb8b8587bb1 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ApplicationOperationsExtensions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ApplicationOperationsExtensions.cs @@ -22,14 +22,14 @@ namespace Microsoft.Azure.Batch.Protocol public static partial class ApplicationOperationsExtensions { /// - /// Lists all of the applications available in the specified account. + /// Lists all of the applications available in the specified Account. /// /// - /// This operation returns only applications and versions that are available - /// for use on compute nodes; that is, that can be used in an application - /// package reference. For administrator information about applications and - /// versions that are not yet available to compute nodes, use the Azure portal - /// or the Azure Resource Manager API. + /// This operation returns only Applications and versions that are available + /// for use on Compute Nodes; that is, that can be used in an Package + /// reference. For administrator information about applications and versions + /// that are not yet available to Compute Nodes, use the Azure portal or the + /// Azure Resource Manager API. /// /// /// The operations group for this extension method. @@ -43,14 +43,14 @@ public static partial class ApplicationOperationsExtensions } /// - /// Lists all of the applications available in the specified account. + /// Lists all of the applications available in the specified Account. /// /// - /// This operation returns only applications and versions that are available - /// for use on compute nodes; that is, that can be used in an application - /// package reference. For administrator information about applications and - /// versions that are not yet available to compute nodes, use the Azure portal - /// or the Azure Resource Manager API. + /// This operation returns only Applications and versions that are available + /// for use on Compute Nodes; that is, that can be used in an Package + /// reference. For administrator information about applications and versions + /// that are not yet available to Compute Nodes, use the Azure portal or the + /// Azure Resource Manager API. /// /// /// The operations group for this extension method. @@ -70,20 +70,20 @@ public static partial class ApplicationOperationsExtensions } /// - /// Gets information about the specified application. + /// Gets information about the specified Application. /// /// - /// This operation returns only applications and versions that are available - /// for use on compute nodes; that is, that can be used in an application - /// package reference. For administrator information about applications and - /// versions that are not yet available to compute nodes, use the Azure portal - /// or the Azure Resource Manager API. + /// This operation returns only Applications and versions that are available + /// for use on Compute Nodes; that is, that can be used in an Package + /// reference. For administrator information about Applications and versions + /// that are not yet available to Compute Nodes, use the Azure portal or the + /// Azure Resource Manager API. /// /// /// The operations group for this extension method. /// /// - /// The ID of the application. + /// The ID of the Application. /// /// /// Additional parameters for the operation @@ -94,20 +94,20 @@ public static partial class ApplicationOperationsExtensions } /// - /// Gets information about the specified application. + /// Gets information about the specified Application. /// /// - /// This operation returns only applications and versions that are available - /// for use on compute nodes; that is, that can be used in an application - /// package reference. For administrator information about applications and - /// versions that are not yet available to compute nodes, use the Azure portal - /// or the Azure Resource Manager API. + /// This operation returns only Applications and versions that are available + /// for use on Compute Nodes; that is, that can be used in an Package + /// reference. For administrator information about Applications and versions + /// that are not yet available to Compute Nodes, use the Azure portal or the + /// Azure Resource Manager API. /// /// /// The operations group for this extension method. /// /// - /// The ID of the application. + /// The ID of the Application. /// /// /// Additional parameters for the operation @@ -124,14 +124,14 @@ public static partial class ApplicationOperationsExtensions } /// - /// Lists all of the applications available in the specified account. + /// Lists all of the applications available in the specified Account. /// /// - /// This operation returns only applications and versions that are available - /// for use on compute nodes; that is, that can be used in an application - /// package reference. For administrator information about applications and - /// versions that are not yet available to compute nodes, use the Azure portal - /// or the Azure Resource Manager API. + /// This operation returns only Applications and versions that are available + /// for use on Compute Nodes; that is, that can be used in an Package + /// reference. For administrator information about applications and versions + /// that are not yet available to Compute Nodes, use the Azure portal or the + /// Azure Resource Manager API. /// /// /// The operations group for this extension method. @@ -148,14 +148,14 @@ public static partial class ApplicationOperationsExtensions } /// - /// Lists all of the applications available in the specified account. + /// Lists all of the applications available in the specified Account. /// /// - /// This operation returns only applications and versions that are available - /// for use on compute nodes; that is, that can be used in an application - /// package reference. For administrator information about applications and - /// versions that are not yet available to compute nodes, use the Azure portal - /// or the Azure Resource Manager API. + /// This operation returns only Applications and versions that are available + /// for use on Compute Nodes; that is, that can be used in an Package + /// reference. For administrator information about applications and versions + /// that are not yet available to Compute Nodes, use the Azure portal or the + /// Azure Resource Manager API. /// /// /// The operations group for this extension method. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/BatchServiceClient.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/BatchServiceClient.cs index 38f34248d0aa..15a0ce0da5a0 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/BatchServiceClient.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/BatchServiceClient.cs @@ -256,7 +256,7 @@ private void Initialize() Task = new TaskOperations(this); ComputeNode = new ComputeNodeOperations(this); BaseUri = "{batchUrl}"; - ApiVersion = "2019-06-01.9.0"; + ApiVersion = "2019-08-01.10.0"; AcceptLanguage = "en-US"; LongRunningOperationRetryTimeout = 30; GenerateClientRequestId = true; diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/CertificateOperations.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/CertificateOperations.cs index 5aeb377e3dab..d8d6b304f522 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/CertificateOperations.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/CertificateOperations.cs @@ -52,10 +52,10 @@ internal CertificateOperations(BatchServiceClient client) public BatchServiceClient Client { get; private set; } /// - /// Adds a certificate to the specified account. + /// Adds a Certificate to the specified Account. /// /// - /// The certificate to be added. + /// The Certificate to be added. /// /// /// Additional parameters for the operation @@ -286,8 +286,8 @@ internal CertificateOperations(BatchServiceClient client) } /// - /// Lists all of the certificates that have been added to the specified - /// account. + /// Lists all of the Certificates that have been added to the specified + /// Account. /// /// /// Additional parameters for the operation @@ -558,22 +558,22 @@ internal CertificateOperations(BatchServiceClient client) } /// - /// Cancels a failed deletion of a certificate from the specified account. + /// Cancels a failed deletion of a Certificate from the specified Account. /// /// - /// If you try to delete a certificate that is being used by a pool or compute - /// node, the status of the certificate changes to deleteFailed. If you decide - /// that you want to continue using the certificate, you can use this operation - /// to set the status of the certificate back to active. If you intend to - /// delete the certificate, you do not need to run this operation after the - /// deletion failed. You must make sure that the certificate is not being used - /// by any resources, and then you can try again to delete the certificate. + /// If you try to delete a Certificate that is being used by a Pool or Compute + /// Node, the status of the Certificate changes to deleteFailed. If you decide + /// that you want to continue using the Certificate, you can use this operation + /// to set the status of the Certificate back to active. If you intend to + /// delete the Certificate, you do not need to run this operation after the + /// deletion failed. You must make sure that the Certificate is not being used + /// by any resources, and then you can try again to delete the Certificate. /// /// /// The algorithm used to derive the thumbprint parameter. This must be sha1. /// /// - /// The thumbprint of the certificate being deleted. + /// The thumbprint of the Certificate being deleted. /// /// /// Additional parameters for the operation @@ -805,25 +805,25 @@ internal CertificateOperations(BatchServiceClient client) } /// - /// Deletes a certificate from the specified account. + /// Deletes a Certificate from the specified Account. /// /// - /// You cannot delete a certificate if a resource (pool or compute node) is - /// using it. Before you can delete a certificate, you must therefore make sure - /// that the certificate is not associated with any existing pools, the - /// certificate is not installed on any compute nodes (even if you remove a - /// certificate from a pool, it is not removed from existing compute nodes in - /// that pool until they restart), and no running tasks depend on the - /// certificate. If you try to delete a certificate that is in use, the - /// deletion fails. The certificate status changes to deleteFailed. You can use - /// Cancel Delete Certificate to set the status back to active if you decide - /// that you want to continue using the certificate. + /// You cannot delete a Certificate if a resource (Pool or Compute Node) is + /// using it. Before you can delete a Certificate, you must therefore make sure + /// that the Certificate is not associated with any existing Pools, the + /// Certificate is not installed on any Nodes (even if you remove a Certificate + /// from a Pool, it is not removed from existing Compute Nodes in that Pool + /// until they restart), and no running Tasks depend on the Certificate. If you + /// try to delete a Certificate that is in use, the deletion fails. The + /// Certificate status changes to deleteFailed. You can use Cancel Delete + /// Certificate to set the status back to active if you decide that you want to + /// continue using the Certificate. /// /// /// The algorithm used to derive the thumbprint parameter. This must be sha1. /// /// - /// The thumbprint of the certificate to be deleted. + /// The thumbprint of the Certificate to be deleted. /// /// /// Additional parameters for the operation @@ -1055,13 +1055,13 @@ internal CertificateOperations(BatchServiceClient client) } /// - /// Gets information about the specified certificate. + /// Gets information about the specified Certificate. /// /// /// The algorithm used to derive the thumbprint parameter. This must be sha1. /// /// - /// The thumbprint of the certificate to get. + /// The thumbprint of the Certificate to get. /// /// /// Additional parameters for the operation @@ -1324,8 +1324,8 @@ internal CertificateOperations(BatchServiceClient client) } /// - /// Lists all of the certificates that have been added to the specified - /// account. + /// Lists all of the Certificates that have been added to the specified + /// Account. /// /// /// The NextLink from the previous successful call to List operation. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/CertificateOperationsExtensions.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/CertificateOperationsExtensions.cs index a1a2213140fb..32f746f8adca 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/CertificateOperationsExtensions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/CertificateOperationsExtensions.cs @@ -22,13 +22,13 @@ namespace Microsoft.Azure.Batch.Protocol public static partial class CertificateOperationsExtensions { /// - /// Adds a certificate to the specified account. + /// Adds a Certificate to the specified Account. /// /// /// The operations group for this extension method. /// /// - /// The certificate to be added. + /// The Certificate to be added. /// /// /// Additional parameters for the operation @@ -39,13 +39,13 @@ public static partial class CertificateOperationsExtensions } /// - /// Adds a certificate to the specified account. + /// Adds a Certificate to the specified Account. /// /// /// The operations group for this extension method. /// /// - /// The certificate to be added. + /// The Certificate to be added. /// /// /// Additional parameters for the operation @@ -62,8 +62,8 @@ public static partial class CertificateOperationsExtensions } /// - /// Lists all of the certificates that have been added to the specified - /// account. + /// Lists all of the Certificates that have been added to the specified + /// Account. /// /// /// The operations group for this extension method. @@ -77,8 +77,8 @@ public static partial class CertificateOperationsExtensions } /// - /// Lists all of the certificates that have been added to the specified - /// account. + /// Lists all of the Certificates that have been added to the specified + /// Account. /// /// /// The operations group for this extension method. @@ -98,16 +98,16 @@ public static partial class CertificateOperationsExtensions } /// - /// Cancels a failed deletion of a certificate from the specified account. + /// Cancels a failed deletion of a Certificate from the specified Account. /// /// - /// If you try to delete a certificate that is being used by a pool or compute - /// node, the status of the certificate changes to deleteFailed. If you decide - /// that you want to continue using the certificate, you can use this operation - /// to set the status of the certificate back to active. If you intend to - /// delete the certificate, you do not need to run this operation after the - /// deletion failed. You must make sure that the certificate is not being used - /// by any resources, and then you can try again to delete the certificate. + /// If you try to delete a Certificate that is being used by a Pool or Compute + /// Node, the status of the Certificate changes to deleteFailed. If you decide + /// that you want to continue using the Certificate, you can use this operation + /// to set the status of the Certificate back to active. If you intend to + /// delete the Certificate, you do not need to run this operation after the + /// deletion failed. You must make sure that the Certificate is not being used + /// by any resources, and then you can try again to delete the Certificate. /// /// /// The operations group for this extension method. @@ -116,7 +116,7 @@ public static partial class CertificateOperationsExtensions /// The algorithm used to derive the thumbprint parameter. This must be sha1. /// /// - /// The thumbprint of the certificate being deleted. + /// The thumbprint of the Certificate being deleted. /// /// /// Additional parameters for the operation @@ -127,16 +127,16 @@ public static partial class CertificateOperationsExtensions } /// - /// Cancels a failed deletion of a certificate from the specified account. + /// Cancels a failed deletion of a Certificate from the specified Account. /// /// - /// If you try to delete a certificate that is being used by a pool or compute - /// node, the status of the certificate changes to deleteFailed. If you decide - /// that you want to continue using the certificate, you can use this operation - /// to set the status of the certificate back to active. If you intend to - /// delete the certificate, you do not need to run this operation after the - /// deletion failed. You must make sure that the certificate is not being used - /// by any resources, and then you can try again to delete the certificate. + /// If you try to delete a Certificate that is being used by a Pool or Compute + /// Node, the status of the Certificate changes to deleteFailed. If you decide + /// that you want to continue using the Certificate, you can use this operation + /// to set the status of the Certificate back to active. If you intend to + /// delete the Certificate, you do not need to run this operation after the + /// deletion failed. You must make sure that the Certificate is not being used + /// by any resources, and then you can try again to delete the Certificate. /// /// /// The operations group for this extension method. @@ -145,7 +145,7 @@ public static partial class CertificateOperationsExtensions /// The algorithm used to derive the thumbprint parameter. This must be sha1. /// /// - /// The thumbprint of the certificate being deleted. + /// The thumbprint of the Certificate being deleted. /// /// /// Additional parameters for the operation @@ -162,19 +162,19 @@ public static partial class CertificateOperationsExtensions } /// - /// Deletes a certificate from the specified account. + /// Deletes a Certificate from the specified Account. /// /// - /// You cannot delete a certificate if a resource (pool or compute node) is - /// using it. Before you can delete a certificate, you must therefore make sure - /// that the certificate is not associated with any existing pools, the - /// certificate is not installed on any compute nodes (even if you remove a - /// certificate from a pool, it is not removed from existing compute nodes in - /// that pool until they restart), and no running tasks depend on the - /// certificate. If you try to delete a certificate that is in use, the - /// deletion fails. The certificate status changes to deleteFailed. You can use - /// Cancel Delete Certificate to set the status back to active if you decide - /// that you want to continue using the certificate. + /// You cannot delete a Certificate if a resource (Pool or Compute Node) is + /// using it. Before you can delete a Certificate, you must therefore make sure + /// that the Certificate is not associated with any existing Pools, the + /// Certificate is not installed on any Nodes (even if you remove a Certificate + /// from a Pool, it is not removed from existing Compute Nodes in that Pool + /// until they restart), and no running Tasks depend on the Certificate. If you + /// try to delete a Certificate that is in use, the deletion fails. The + /// Certificate status changes to deleteFailed. You can use Cancel Delete + /// Certificate to set the status back to active if you decide that you want to + /// continue using the Certificate. /// /// /// The operations group for this extension method. @@ -183,7 +183,7 @@ public static partial class CertificateOperationsExtensions /// The algorithm used to derive the thumbprint parameter. This must be sha1. /// /// - /// The thumbprint of the certificate to be deleted. + /// The thumbprint of the Certificate to be deleted. /// /// /// Additional parameters for the operation @@ -194,19 +194,19 @@ public static partial class CertificateOperationsExtensions } /// - /// Deletes a certificate from the specified account. + /// Deletes a Certificate from the specified Account. /// /// - /// You cannot delete a certificate if a resource (pool or compute node) is - /// using it. Before you can delete a certificate, you must therefore make sure - /// that the certificate is not associated with any existing pools, the - /// certificate is not installed on any compute nodes (even if you remove a - /// certificate from a pool, it is not removed from existing compute nodes in - /// that pool until they restart), and no running tasks depend on the - /// certificate. If you try to delete a certificate that is in use, the - /// deletion fails. The certificate status changes to deleteFailed. You can use - /// Cancel Delete Certificate to set the status back to active if you decide - /// that you want to continue using the certificate. + /// You cannot delete a Certificate if a resource (Pool or Compute Node) is + /// using it. Before you can delete a Certificate, you must therefore make sure + /// that the Certificate is not associated with any existing Pools, the + /// Certificate is not installed on any Nodes (even if you remove a Certificate + /// from a Pool, it is not removed from existing Compute Nodes in that Pool + /// until they restart), and no running Tasks depend on the Certificate. If you + /// try to delete a Certificate that is in use, the deletion fails. The + /// Certificate status changes to deleteFailed. You can use Cancel Delete + /// Certificate to set the status back to active if you decide that you want to + /// continue using the Certificate. /// /// /// The operations group for this extension method. @@ -215,7 +215,7 @@ public static partial class CertificateOperationsExtensions /// The algorithm used to derive the thumbprint parameter. This must be sha1. /// /// - /// The thumbprint of the certificate to be deleted. + /// The thumbprint of the Certificate to be deleted. /// /// /// Additional parameters for the operation @@ -232,7 +232,7 @@ public static partial class CertificateOperationsExtensions } /// - /// Gets information about the specified certificate. + /// Gets information about the specified Certificate. /// /// /// The operations group for this extension method. @@ -241,7 +241,7 @@ public static partial class CertificateOperationsExtensions /// The algorithm used to derive the thumbprint parameter. This must be sha1. /// /// - /// The thumbprint of the certificate to get. + /// The thumbprint of the Certificate to get. /// /// /// Additional parameters for the operation @@ -252,7 +252,7 @@ public static partial class CertificateOperationsExtensions } /// - /// Gets information about the specified certificate. + /// Gets information about the specified Certificate. /// /// /// The operations group for this extension method. @@ -261,7 +261,7 @@ public static partial class CertificateOperationsExtensions /// The algorithm used to derive the thumbprint parameter. This must be sha1. /// /// - /// The thumbprint of the certificate to get. + /// The thumbprint of the Certificate to get. /// /// /// Additional parameters for the operation @@ -278,8 +278,8 @@ public static partial class CertificateOperationsExtensions } /// - /// Lists all of the certificates that have been added to the specified - /// account. + /// Lists all of the Certificates that have been added to the specified + /// Account. /// /// /// The operations group for this extension method. @@ -296,8 +296,8 @@ public static partial class CertificateOperationsExtensions } /// - /// Lists all of the certificates that have been added to the specified - /// account. + /// Lists all of the Certificates that have been added to the specified + /// Account. /// /// /// The operations group for this extension method. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ComputeNodeOperations.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ComputeNodeOperations.cs index d52af0751c92..ea70d1a2951b 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ComputeNodeOperations.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ComputeNodeOperations.cs @@ -53,20 +53,20 @@ internal ComputeNodeOperations(BatchServiceClient client) public BatchServiceClient Client { get; private set; } /// - /// Adds a user account to the specified compute node. + /// Adds a user Account to the specified Compute Node. /// /// - /// You can add a user account to a node only when it is in the idle or running - /// state. + /// You can add a user Account to a Compute Node only when it is in the idle or + /// running state. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the machine on which you want to create a user account. + /// The ID of the machine on which you want to create a user Account. /// /// - /// The user account to be created. + /// The user Account to be created. /// /// /// Additional parameters for the operation @@ -309,20 +309,20 @@ internal ComputeNodeOperations(BatchServiceClient client) } /// - /// Deletes a user account from the specified compute node. + /// Deletes a user Account from the specified Compute Node. /// /// - /// You can delete a user account to a node only when it is in the idle or - /// running state. + /// You can delete a user Account to a Compute Node only when it is in the idle + /// or running state. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the machine on which you want to delete a user account. + /// The ID of the machine on which you want to delete a user Account. /// /// - /// The name of the user account to delete. + /// The name of the user Account to delete. /// /// /// Additional parameters for the operation @@ -560,23 +560,23 @@ internal ComputeNodeOperations(BatchServiceClient client) } /// - /// Updates the password and expiration time of a user account on the specified - /// compute node. + /// Updates the password and expiration time of a user Account on the specified + /// Compute Node. /// /// - /// This operation replaces of all the updatable properties of the account. For + /// This operation replaces of all the updatable properties of the Account. For /// example, if the expiryTime element is not specified, the current value is /// replaced with the default value, not left unmodified. You can update a user - /// account on a node only when it is in the idle or running state. + /// Account on a Compute Node only when it is in the idle or running state. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the machine on which you want to update a user account. + /// The ID of the machine on which you want to update a user Account. /// /// - /// The name of the user account to update. + /// The name of the user Account to update. /// /// /// The parameters for the request. @@ -828,13 +828,13 @@ internal ComputeNodeOperations(BatchServiceClient client) } /// - /// Gets information about the specified compute node. + /// Gets information about the specified Compute Node. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node that you want to get information about. + /// The ID of the Compute Node that you want to get information about. /// /// /// Additional parameters for the operation @@ -1097,20 +1097,20 @@ internal ComputeNodeOperations(BatchServiceClient client) } /// - /// Restarts the specified compute node. + /// Restarts the specified Compute Node. /// /// - /// You can restart a node only if it is in an idle or running state. + /// You can restart a Compute Node only if it is in an idle or running state. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node that you want to restart. + /// The ID of the Compute Node that you want to restart. /// /// - /// When to reboot the compute node and what to do with currently running - /// tasks. The default value is requeue. Possible values include: 'requeue', + /// When to reboot the Compute Node and what to do with currently running + /// Tasks. The default value is requeue. Possible values include: 'requeue', /// 'terminate', 'taskCompletion', 'retainedData' /// /// @@ -1356,22 +1356,22 @@ internal ComputeNodeOperations(BatchServiceClient client) } /// - /// Reinstalls the operating system on the specified compute node. + /// Reinstalls the operating system on the specified Compute Node. /// /// - /// You can reinstall the operating system on a node only if it is in an idle - /// or running state. This API can be invoked only on pools created with the - /// cloud service configuration property. + /// You can reinstall the operating system on a Compute Node only if it is in + /// an idle or running state. This API can be invoked only on Pools created + /// with the cloud service configuration property. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node that you want to restart. + /// The ID of the Compute Node that you want to restart. /// /// - /// When to reimage the compute node and what to do with currently running - /// tasks. The default value is requeue. Possible values include: 'requeue', + /// When to reimage the Compute Node and what to do with currently running + /// Tasks. The default value is requeue. Possible values include: 'requeue', /// 'terminate', 'taskCompletion', 'retainedData' /// /// @@ -1617,21 +1617,21 @@ internal ComputeNodeOperations(BatchServiceClient client) } /// - /// Disables task scheduling on the specified compute node. + /// Disables Task scheduling on the specified Compute Node. /// /// - /// You can disable task scheduling on a node only if its current scheduling - /// state is enabled. + /// You can disable Task scheduling on a Compute Node only if its current + /// scheduling state is enabled. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node on which you want to disable task scheduling. + /// The ID of the Compute Node on which you want to disable Task scheduling. /// /// - /// What to do with currently running tasks when disabling task scheduling on - /// the compute node. The default value is requeue. Possible values include: + /// What to do with currently running Tasks when disabling Task scheduling on + /// the Compute Node. The default value is requeue. Possible values include: /// 'requeue', 'terminate', 'taskCompletion' /// /// @@ -1877,17 +1877,17 @@ internal ComputeNodeOperations(BatchServiceClient client) } /// - /// Enables task scheduling on the specified compute node. + /// Enables Task scheduling on the specified Compute Node. /// /// - /// You can enable task scheduling on a node only if its current scheduling - /// state is disabled + /// You can enable Task scheduling on a Compute Node only if its current + /// scheduling state is disabled /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node on which you want to enable task scheduling. + /// The ID of the Compute Node on which you want to enable Task scheduling. /// /// /// Additional parameters for the operation @@ -2119,19 +2119,20 @@ internal ComputeNodeOperations(BatchServiceClient client) } /// - /// Gets the settings required for remote login to a compute node. + /// Gets the settings required for remote login to a Compute Node. /// /// - /// Before you can remotely login to a node using the remote login settings, - /// you must create a user account on the node. This API can be invoked only on - /// pools created with the virtual machine configuration property. For pools - /// created with a cloud service configuration, see the GetRemoteDesktop API. + /// Before you can remotely login to a Compute Node using the remote login + /// settings, you must create a user Account on the Compute Node. This API can + /// be invoked only on Pools created with the virtual machine configuration + /// property. For Pools created with a cloud service configuration, see the + /// GetRemoteDesktop API. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node for which to obtain the remote login settings. + /// The ID of the Compute Node for which to obtain the remote login settings. /// /// /// Additional parameters for the operation @@ -2384,19 +2385,19 @@ internal ComputeNodeOperations(BatchServiceClient client) } /// - /// Gets the Remote Desktop Protocol file for the specified compute node. + /// Gets the Remote Desktop Protocol file for the specified Compute Node. /// /// - /// Before you can access a node by using the RDP file, you must create a user - /// account on the node. This API can only be invoked on pools created with a - /// cloud service configuration. For pools created with a virtual machine - /// configuration, see the GetRemoteLoginSettings API. + /// Before you can access a Compute Node by using the RDP file, you must create + /// a user Account on the Compute Node. This API can only be invoked on Pools + /// created with a cloud service configuration. For Pools created with a + /// virtual machine configuration, see the GetRemoteLoginSettings API. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node for which you want to get the Remote Desktop + /// The ID of the Compute Node for which you want to get the Remote Desktop /// Protocol file. /// /// @@ -2637,20 +2638,20 @@ internal ComputeNodeOperations(BatchServiceClient client) } /// - /// Upload Azure Batch service log files from the specified compute node to + /// Upload Azure Batch service log files from the specified Compute Node to /// Azure Blob Storage. /// /// /// This is for gathering Azure Batch service log files in an automated fashion - /// from nodes if you are experiencing an error and wish to escalate to Azure - /// support. The Azure Batch service log files should be shared with Azure - /// support to aid in debugging issues with the Batch service. + /// from Compute Nodes if you are experiencing an error and wish to escalate to + /// Azure support. The Azure Batch service log files should be shared with + /// Azure support to aid in debugging issues with the Batch service. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node from which you want to upload the Azure Batch + /// The ID of the Compute Node from which you want to upload the Azure Batch /// service log files. /// /// @@ -2918,10 +2919,10 @@ internal ComputeNodeOperations(BatchServiceClient client) } /// - /// Lists the compute nodes in the specified pool. + /// Lists the Compute Nodes in the specified Pool. /// /// - /// The ID of the pool from which you want to list nodes. + /// The ID of the Pool from which you want to list Compute Nodes. /// /// /// Additional parameters for the operation @@ -3198,7 +3199,7 @@ internal ComputeNodeOperations(BatchServiceClient client) } /// - /// Lists the compute nodes in the specified pool. + /// Lists the Compute Nodes in the specified Pool. /// /// /// The NextLink from the previous successful call to List operation. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ComputeNodeOperationsExtensions.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ComputeNodeOperationsExtensions.cs index aca1e947096f..41b0e951dcc8 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ComputeNodeOperationsExtensions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ComputeNodeOperationsExtensions.cs @@ -23,23 +23,23 @@ namespace Microsoft.Azure.Batch.Protocol public static partial class ComputeNodeOperationsExtensions { /// - /// Adds a user account to the specified compute node. + /// Adds a user Account to the specified Compute Node. /// /// - /// You can add a user account to a node only when it is in the idle or running - /// state. + /// You can add a user Account to a Compute Node only when it is in the idle or + /// running state. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the machine on which you want to create a user account. + /// The ID of the machine on which you want to create a user Account. /// /// - /// The user account to be created. + /// The user Account to be created. /// /// /// Additional parameters for the operation @@ -50,23 +50,23 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Adds a user account to the specified compute node. + /// Adds a user Account to the specified Compute Node. /// /// - /// You can add a user account to a node only when it is in the idle or running - /// state. + /// You can add a user Account to a Compute Node only when it is in the idle or + /// running state. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the machine on which you want to create a user account. + /// The ID of the machine on which you want to create a user Account. /// /// - /// The user account to be created. + /// The user Account to be created. /// /// /// Additional parameters for the operation @@ -83,23 +83,23 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Deletes a user account from the specified compute node. + /// Deletes a user Account from the specified Compute Node. /// /// - /// You can delete a user account to a node only when it is in the idle or - /// running state. + /// You can delete a user Account to a Compute Node only when it is in the idle + /// or running state. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the machine on which you want to delete a user account. + /// The ID of the machine on which you want to delete a user Account. /// /// - /// The name of the user account to delete. + /// The name of the user Account to delete. /// /// /// Additional parameters for the operation @@ -110,23 +110,23 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Deletes a user account from the specified compute node. + /// Deletes a user Account from the specified Compute Node. /// /// - /// You can delete a user account to a node only when it is in the idle or - /// running state. + /// You can delete a user Account to a Compute Node only when it is in the idle + /// or running state. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the machine on which you want to delete a user account. + /// The ID of the machine on which you want to delete a user Account. /// /// - /// The name of the user account to delete. + /// The name of the user Account to delete. /// /// /// Additional parameters for the operation @@ -143,26 +143,26 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Updates the password and expiration time of a user account on the specified - /// compute node. + /// Updates the password and expiration time of a user Account on the specified + /// Compute Node. /// /// - /// This operation replaces of all the updatable properties of the account. For + /// This operation replaces of all the updatable properties of the Account. For /// example, if the expiryTime element is not specified, the current value is /// replaced with the default value, not left unmodified. You can update a user - /// account on a node only when it is in the idle or running state. + /// Account on a Compute Node only when it is in the idle or running state. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the machine on which you want to update a user account. + /// The ID of the machine on which you want to update a user Account. /// /// - /// The name of the user account to update. + /// The name of the user Account to update. /// /// /// The parameters for the request. @@ -176,26 +176,26 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Updates the password and expiration time of a user account on the specified - /// compute node. + /// Updates the password and expiration time of a user Account on the specified + /// Compute Node. /// /// - /// This operation replaces of all the updatable properties of the account. For + /// This operation replaces of all the updatable properties of the Account. For /// example, if the expiryTime element is not specified, the current value is /// replaced with the default value, not left unmodified. You can update a user - /// account on a node only when it is in the idle or running state. + /// Account on a Compute Node only when it is in the idle or running state. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the machine on which you want to update a user account. + /// The ID of the machine on which you want to update a user Account. /// /// - /// The name of the user account to update. + /// The name of the user Account to update. /// /// /// The parameters for the request. @@ -215,16 +215,16 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Gets information about the specified compute node. + /// Gets information about the specified Compute Node. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node that you want to get information about. + /// The ID of the Compute Node that you want to get information about. /// /// /// Additional parameters for the operation @@ -235,16 +235,16 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Gets information about the specified compute node. + /// Gets information about the specified Compute Node. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node that you want to get information about. + /// The ID of the Compute Node that you want to get information about. /// /// /// Additional parameters for the operation @@ -261,23 +261,23 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Restarts the specified compute node. + /// Restarts the specified Compute Node. /// /// - /// You can restart a node only if it is in an idle or running state. + /// You can restart a Compute Node only if it is in an idle or running state. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node that you want to restart. + /// The ID of the Compute Node that you want to restart. /// /// - /// When to reboot the compute node and what to do with currently running - /// tasks. The default value is requeue. Possible values include: 'requeue', + /// When to reboot the Compute Node and what to do with currently running + /// Tasks. The default value is requeue. Possible values include: 'requeue', /// 'terminate', 'taskCompletion', 'retainedData' /// /// @@ -289,23 +289,23 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Restarts the specified compute node. + /// Restarts the specified Compute Node. /// /// - /// You can restart a node only if it is in an idle or running state. + /// You can restart a Compute Node only if it is in an idle or running state. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node that you want to restart. + /// The ID of the Compute Node that you want to restart. /// /// - /// When to reboot the compute node and what to do with currently running - /// tasks. The default value is requeue. Possible values include: 'requeue', + /// When to reboot the Compute Node and what to do with currently running + /// Tasks. The default value is requeue. Possible values include: 'requeue', /// 'terminate', 'taskCompletion', 'retainedData' /// /// @@ -323,25 +323,25 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Reinstalls the operating system on the specified compute node. + /// Reinstalls the operating system on the specified Compute Node. /// /// - /// You can reinstall the operating system on a node only if it is in an idle - /// or running state. This API can be invoked only on pools created with the - /// cloud service configuration property. + /// You can reinstall the operating system on a Compute Node only if it is in + /// an idle or running state. This API can be invoked only on Pools created + /// with the cloud service configuration property. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node that you want to restart. + /// The ID of the Compute Node that you want to restart. /// /// - /// When to reimage the compute node and what to do with currently running - /// tasks. The default value is requeue. Possible values include: 'requeue', + /// When to reimage the Compute Node and what to do with currently running + /// Tasks. The default value is requeue. Possible values include: 'requeue', /// 'terminate', 'taskCompletion', 'retainedData' /// /// @@ -353,25 +353,25 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Reinstalls the operating system on the specified compute node. + /// Reinstalls the operating system on the specified Compute Node. /// /// - /// You can reinstall the operating system on a node only if it is in an idle - /// or running state. This API can be invoked only on pools created with the - /// cloud service configuration property. + /// You can reinstall the operating system on a Compute Node only if it is in + /// an idle or running state. This API can be invoked only on Pools created + /// with the cloud service configuration property. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node that you want to restart. + /// The ID of the Compute Node that you want to restart. /// /// - /// When to reimage the compute node and what to do with currently running - /// tasks. The default value is requeue. Possible values include: 'requeue', + /// When to reimage the Compute Node and what to do with currently running + /// Tasks. The default value is requeue. Possible values include: 'requeue', /// 'terminate', 'taskCompletion', 'retainedData' /// /// @@ -389,24 +389,24 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Disables task scheduling on the specified compute node. + /// Disables Task scheduling on the specified Compute Node. /// /// - /// You can disable task scheduling on a node only if its current scheduling - /// state is enabled. + /// You can disable Task scheduling on a Compute Node only if its current + /// scheduling state is enabled. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node on which you want to disable task scheduling. + /// The ID of the Compute Node on which you want to disable Task scheduling. /// /// - /// What to do with currently running tasks when disabling task scheduling on - /// the compute node. The default value is requeue. Possible values include: + /// What to do with currently running Tasks when disabling Task scheduling on + /// the Compute Node. The default value is requeue. Possible values include: /// 'requeue', 'terminate', 'taskCompletion' /// /// @@ -418,24 +418,24 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Disables task scheduling on the specified compute node. + /// Disables Task scheduling on the specified Compute Node. /// /// - /// You can disable task scheduling on a node only if its current scheduling - /// state is enabled. + /// You can disable Task scheduling on a Compute Node only if its current + /// scheduling state is enabled. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node on which you want to disable task scheduling. + /// The ID of the Compute Node on which you want to disable Task scheduling. /// /// - /// What to do with currently running tasks when disabling task scheduling on - /// the compute node. The default value is requeue. Possible values include: + /// What to do with currently running Tasks when disabling Task scheduling on + /// the Compute Node. The default value is requeue. Possible values include: /// 'requeue', 'terminate', 'taskCompletion' /// /// @@ -453,20 +453,20 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Enables task scheduling on the specified compute node. + /// Enables Task scheduling on the specified Compute Node. /// /// - /// You can enable task scheduling on a node only if its current scheduling - /// state is disabled + /// You can enable Task scheduling on a Compute Node only if its current + /// scheduling state is disabled /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node on which you want to enable task scheduling. + /// The ID of the Compute Node on which you want to enable Task scheduling. /// /// /// Additional parameters for the operation @@ -477,20 +477,20 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Enables task scheduling on the specified compute node. + /// Enables Task scheduling on the specified Compute Node. /// /// - /// You can enable task scheduling on a node only if its current scheduling - /// state is disabled + /// You can enable Task scheduling on a Compute Node only if its current + /// scheduling state is disabled /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node on which you want to enable task scheduling. + /// The ID of the Compute Node on which you want to enable Task scheduling. /// /// /// Additional parameters for the operation @@ -507,22 +507,23 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Gets the settings required for remote login to a compute node. + /// Gets the settings required for remote login to a Compute Node. /// /// - /// Before you can remotely login to a node using the remote login settings, - /// you must create a user account on the node. This API can be invoked only on - /// pools created with the virtual machine configuration property. For pools - /// created with a cloud service configuration, see the GetRemoteDesktop API. + /// Before you can remotely login to a Compute Node using the remote login + /// settings, you must create a user Account on the Compute Node. This API can + /// be invoked only on Pools created with the virtual machine configuration + /// property. For Pools created with a cloud service configuration, see the + /// GetRemoteDesktop API. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node for which to obtain the remote login settings. + /// The ID of the Compute Node for which to obtain the remote login settings. /// /// /// Additional parameters for the operation @@ -533,22 +534,23 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Gets the settings required for remote login to a compute node. + /// Gets the settings required for remote login to a Compute Node. /// /// - /// Before you can remotely login to a node using the remote login settings, - /// you must create a user account on the node. This API can be invoked only on - /// pools created with the virtual machine configuration property. For pools - /// created with a cloud service configuration, see the GetRemoteDesktop API. + /// Before you can remotely login to a Compute Node using the remote login + /// settings, you must create a user Account on the Compute Node. This API can + /// be invoked only on Pools created with the virtual machine configuration + /// property. For Pools created with a cloud service configuration, see the + /// GetRemoteDesktop API. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node for which to obtain the remote login settings. + /// The ID of the Compute Node for which to obtain the remote login settings. /// /// /// Additional parameters for the operation @@ -565,22 +567,22 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Gets the Remote Desktop Protocol file for the specified compute node. + /// Gets the Remote Desktop Protocol file for the specified Compute Node. /// /// - /// Before you can access a node by using the RDP file, you must create a user - /// account on the node. This API can only be invoked on pools created with a - /// cloud service configuration. For pools created with a virtual machine - /// configuration, see the GetRemoteLoginSettings API. + /// Before you can access a Compute Node by using the RDP file, you must create + /// a user Account on the Compute Node. This API can only be invoked on Pools + /// created with a cloud service configuration. For Pools created with a + /// virtual machine configuration, see the GetRemoteLoginSettings API. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node for which you want to get the Remote Desktop + /// The ID of the Compute Node for which you want to get the Remote Desktop /// Protocol file. /// /// @@ -592,22 +594,22 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Gets the Remote Desktop Protocol file for the specified compute node. + /// Gets the Remote Desktop Protocol file for the specified Compute Node. /// /// - /// Before you can access a node by using the RDP file, you must create a user - /// account on the node. This API can only be invoked on pools created with a - /// cloud service configuration. For pools created with a virtual machine - /// configuration, see the GetRemoteLoginSettings API. + /// Before you can access a Compute Node by using the RDP file, you must create + /// a user Account on the Compute Node. This API can only be invoked on Pools + /// created with a cloud service configuration. For Pools created with a + /// virtual machine configuration, see the GetRemoteLoginSettings API. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node for which you want to get the Remote Desktop + /// The ID of the Compute Node for which you want to get the Remote Desktop /// Protocol file. /// /// @@ -624,23 +626,23 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Upload Azure Batch service log files from the specified compute node to + /// Upload Azure Batch service log files from the specified Compute Node to /// Azure Blob Storage. /// /// /// This is for gathering Azure Batch service log files in an automated fashion - /// from nodes if you are experiencing an error and wish to escalate to Azure - /// support. The Azure Batch service log files should be shared with Azure - /// support to aid in debugging issues with the Batch service. + /// from Compute Nodes if you are experiencing an error and wish to escalate to + /// Azure support. The Azure Batch service log files should be shared with + /// Azure support to aid in debugging issues with the Batch service. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node from which you want to upload the Azure Batch + /// The ID of the Compute Node from which you want to upload the Azure Batch /// service log files. /// /// @@ -655,23 +657,23 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Upload Azure Batch service log files from the specified compute node to + /// Upload Azure Batch service log files from the specified Compute Node to /// Azure Blob Storage. /// /// /// This is for gathering Azure Batch service log files in an automated fashion - /// from nodes if you are experiencing an error and wish to escalate to Azure - /// support. The Azure Batch service log files should be shared with Azure - /// support to aid in debugging issues with the Batch service. + /// from Compute Nodes if you are experiencing an error and wish to escalate to + /// Azure support. The Azure Batch service log files should be shared with + /// Azure support to aid in debugging issues with the Batch service. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node from which you want to upload the Azure Batch + /// The ID of the Compute Node from which you want to upload the Azure Batch /// service log files. /// /// @@ -692,13 +694,13 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Lists the compute nodes in the specified pool. + /// Lists the Compute Nodes in the specified Pool. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool from which you want to list nodes. + /// The ID of the Pool from which you want to list Compute Nodes. /// /// /// Additional parameters for the operation @@ -709,13 +711,13 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Lists the compute nodes in the specified pool. + /// Lists the Compute Nodes in the specified Pool. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool from which you want to list nodes. + /// The ID of the Pool from which you want to list Compute Nodes. /// /// /// Additional parameters for the operation @@ -732,7 +734,7 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Lists the compute nodes in the specified pool. + /// Lists the Compute Nodes in the specified Pool. /// /// /// The operations group for this extension method. @@ -749,7 +751,7 @@ public static partial class ComputeNodeOperationsExtensions } /// - /// Lists the compute nodes in the specified pool. + /// Lists the Compute Nodes in the specified Pool. /// /// /// The operations group for this extension method. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/FileOperations.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/FileOperations.cs index 3552045549f8..78beece1ec20 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/FileOperations.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/FileOperations.cs @@ -53,16 +53,16 @@ internal FileOperations(BatchServiceClient client) public BatchServiceClient Client { get; private set; } /// - /// Deletes the specified task file from the compute node where the task ran. + /// Deletes the specified Task file from the Compute Node where the Task ran. /// /// - /// The ID of the job that contains the task. + /// The ID of the Job that contains the Task. /// /// - /// The ID of the task whose file you want to delete. + /// The ID of the Task whose file you want to delete. /// /// - /// The path to the task file or directory that you want to delete. + /// The path to the Task file or directory that you want to delete. /// /// /// Whether to delete children of a directory. If the filePath parameter @@ -311,16 +311,16 @@ internal FileOperations(BatchServiceClient client) } /// - /// Returns the content of the specified task file. + /// Returns the content of the specified Task file. /// /// - /// The ID of the job that contains the task. + /// The ID of the Job that contains the Task. /// /// - /// The ID of the task whose file you want to retrieve. + /// The ID of the Task whose file you want to retrieve. /// /// - /// The path to the task file that you want to get the content of. + /// The path to the Task file that you want to get the content of. /// /// /// Additional parameters for the operation @@ -608,16 +608,16 @@ internal FileOperations(BatchServiceClient client) } /// - /// Gets the properties of the specified task file. + /// Gets the properties of the specified Task file. /// /// - /// The ID of the job that contains the task. + /// The ID of the Job that contains the Task. /// /// - /// The ID of the task whose file you want to get the properties of. + /// The ID of the Task whose file you want to get the properties of. /// /// - /// The path to the task file that you want to get the properties of. + /// The path to the Task file that you want to get the properties of. /// /// /// Additional parameters for the operation @@ -883,13 +883,13 @@ internal FileOperations(BatchServiceClient client) } /// - /// Deletes the specified file from the compute node. + /// Deletes the specified file from the Compute Node. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node from which you want to delete the file. + /// The ID of the Compute Node from which you want to delete the file. /// /// /// The path to the file or directory that you want to delete. @@ -1141,16 +1141,16 @@ internal FileOperations(BatchServiceClient client) } /// - /// Returns the content of the specified compute node file. + /// Returns the content of the specified Compute Node file. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node that contains the file. + /// The ID of the Compute Node that contains the file. /// /// - /// The path to the compute node file that you want to get the content of. + /// The path to the Compute Node file that you want to get the content of. /// /// /// Additional parameters for the operation @@ -1438,16 +1438,16 @@ internal FileOperations(BatchServiceClient client) } /// - /// Gets the properties of the specified compute node file. + /// Gets the properties of the specified Compute Node file. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node that contains the file. + /// The ID of the Compute Node that contains the file. /// /// - /// The path to the compute node file that you want to get the properties of. + /// The path to the Compute Node file that you want to get the properties of. /// /// /// Additional parameters for the operation @@ -1713,16 +1713,16 @@ internal FileOperations(BatchServiceClient client) } /// - /// Lists the files in a task's directory on its compute node. + /// Lists the files in a Task's directory on its Compute Node. /// /// - /// The ID of the job that contains the task. + /// The ID of the Job that contains the Task. /// /// - /// The ID of the task whose files you want to list. + /// The ID of the Task whose files you want to list. /// /// - /// Whether to list children of the task directory. This parameter can be used + /// Whether to list children of the Task directory. This parameter can be used /// in combination with the filter parameter to list specific type of files. /// /// @@ -2001,13 +2001,13 @@ internal FileOperations(BatchServiceClient client) } /// - /// Lists all of the files in task directories on the specified compute node. + /// Lists all of the files in Task directories on the specified Compute Node. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node whose files you want to list. + /// The ID of the Compute Node whose files you want to list. /// /// /// Whether to list children of a directory. @@ -2288,7 +2288,7 @@ internal FileOperations(BatchServiceClient client) } /// - /// Lists the files in a task's directory on its compute node. + /// Lists the files in a Task's directory on its Compute Node. /// /// /// The NextLink from the previous successful call to List operation. @@ -2514,7 +2514,7 @@ internal FileOperations(BatchServiceClient client) } /// - /// Lists all of the files in task directories on the specified compute node. + /// Lists all of the files in Task directories on the specified Compute Node. /// /// /// The NextLink from the previous successful call to List operation. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/FileOperationsExtensions.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/FileOperationsExtensions.cs index 4bae083cb92e..910baa413d51 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/FileOperationsExtensions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/FileOperationsExtensions.cs @@ -23,19 +23,19 @@ namespace Microsoft.Azure.Batch.Protocol public static partial class FileOperationsExtensions { /// - /// Deletes the specified task file from the compute node where the task ran. + /// Deletes the specified Task file from the Compute Node where the Task ran. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job that contains the task. + /// The ID of the Job that contains the Task. /// /// - /// The ID of the task whose file you want to delete. + /// The ID of the Task whose file you want to delete. /// /// - /// The path to the task file or directory that you want to delete. + /// The path to the Task file or directory that you want to delete. /// /// /// Whether to delete children of a directory. If the filePath parameter @@ -52,19 +52,19 @@ public static partial class FileOperationsExtensions } /// - /// Deletes the specified task file from the compute node where the task ran. + /// Deletes the specified Task file from the Compute Node where the Task ran. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job that contains the task. + /// The ID of the Job that contains the Task. /// /// - /// The ID of the task whose file you want to delete. + /// The ID of the Task whose file you want to delete. /// /// - /// The path to the task file or directory that you want to delete. + /// The path to the Task file or directory that you want to delete. /// /// /// Whether to delete children of a directory. If the filePath parameter @@ -87,19 +87,19 @@ public static partial class FileOperationsExtensions } /// - /// Returns the content of the specified task file. + /// Returns the content of the specified Task file. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job that contains the task. + /// The ID of the Job that contains the Task. /// /// - /// The ID of the task whose file you want to retrieve. + /// The ID of the Task whose file you want to retrieve. /// /// - /// The path to the task file that you want to get the content of. + /// The path to the Task file that you want to get the content of. /// /// /// Additional parameters for the operation @@ -110,19 +110,19 @@ public static partial class FileOperationsExtensions } /// - /// Returns the content of the specified task file. + /// Returns the content of the specified Task file. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job that contains the task. + /// The ID of the Job that contains the Task. /// /// - /// The ID of the task whose file you want to retrieve. + /// The ID of the Task whose file you want to retrieve. /// /// - /// The path to the task file that you want to get the content of. + /// The path to the Task file that you want to get the content of. /// /// /// Additional parameters for the operation @@ -138,19 +138,19 @@ public static partial class FileOperationsExtensions } /// - /// Gets the properties of the specified task file. + /// Gets the properties of the specified Task file. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job that contains the task. + /// The ID of the Job that contains the Task. /// /// - /// The ID of the task whose file you want to get the properties of. + /// The ID of the Task whose file you want to get the properties of. /// /// - /// The path to the task file that you want to get the properties of. + /// The path to the Task file that you want to get the properties of. /// /// /// Additional parameters for the operation @@ -161,19 +161,19 @@ public static partial class FileOperationsExtensions } /// - /// Gets the properties of the specified task file. + /// Gets the properties of the specified Task file. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job that contains the task. + /// The ID of the Job that contains the Task. /// /// - /// The ID of the task whose file you want to get the properties of. + /// The ID of the Task whose file you want to get the properties of. /// /// - /// The path to the task file that you want to get the properties of. + /// The path to the Task file that you want to get the properties of. /// /// /// Additional parameters for the operation @@ -190,16 +190,16 @@ public static partial class FileOperationsExtensions } /// - /// Deletes the specified file from the compute node. + /// Deletes the specified file from the Compute Node. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node from which you want to delete the file. + /// The ID of the Compute Node from which you want to delete the file. /// /// /// The path to the file or directory that you want to delete. @@ -219,16 +219,16 @@ public static partial class FileOperationsExtensions } /// - /// Deletes the specified file from the compute node. + /// Deletes the specified file from the Compute Node. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node from which you want to delete the file. + /// The ID of the Compute Node from which you want to delete the file. /// /// /// The path to the file or directory that you want to delete. @@ -254,19 +254,19 @@ public static partial class FileOperationsExtensions } /// - /// Returns the content of the specified compute node file. + /// Returns the content of the specified Compute Node file. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node that contains the file. + /// The ID of the Compute Node that contains the file. /// /// - /// The path to the compute node file that you want to get the content of. + /// The path to the Compute Node file that you want to get the content of. /// /// /// Additional parameters for the operation @@ -277,19 +277,19 @@ public static partial class FileOperationsExtensions } /// - /// Returns the content of the specified compute node file. + /// Returns the content of the specified Compute Node file. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node that contains the file. + /// The ID of the Compute Node that contains the file. /// /// - /// The path to the compute node file that you want to get the content of. + /// The path to the Compute Node file that you want to get the content of. /// /// /// Additional parameters for the operation @@ -305,19 +305,19 @@ public static partial class FileOperationsExtensions } /// - /// Gets the properties of the specified compute node file. + /// Gets the properties of the specified Compute Node file. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node that contains the file. + /// The ID of the Compute Node that contains the file. /// /// - /// The path to the compute node file that you want to get the properties of. + /// The path to the Compute Node file that you want to get the properties of. /// /// /// Additional parameters for the operation @@ -328,19 +328,19 @@ public static partial class FileOperationsExtensions } /// - /// Gets the properties of the specified compute node file. + /// Gets the properties of the specified Compute Node file. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node that contains the file. + /// The ID of the Compute Node that contains the file. /// /// - /// The path to the compute node file that you want to get the properties of. + /// The path to the Compute Node file that you want to get the properties of. /// /// /// Additional parameters for the operation @@ -357,19 +357,19 @@ public static partial class FileOperationsExtensions } /// - /// Lists the files in a task's directory on its compute node. + /// Lists the files in a Task's directory on its Compute Node. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job that contains the task. + /// The ID of the Job that contains the Task. /// /// - /// The ID of the task whose files you want to list. + /// The ID of the Task whose files you want to list. /// /// - /// Whether to list children of the task directory. This parameter can be used + /// Whether to list children of the Task directory. This parameter can be used /// in combination with the filter parameter to list specific type of files. /// /// @@ -381,19 +381,19 @@ public static partial class FileOperationsExtensions } /// - /// Lists the files in a task's directory on its compute node. + /// Lists the files in a Task's directory on its Compute Node. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job that contains the task. + /// The ID of the Job that contains the Task. /// /// - /// The ID of the task whose files you want to list. + /// The ID of the Task whose files you want to list. /// /// - /// Whether to list children of the task directory. This parameter can be used + /// Whether to list children of the Task directory. This parameter can be used /// in combination with the filter parameter to list specific type of files. /// /// @@ -411,16 +411,16 @@ public static partial class FileOperationsExtensions } /// - /// Lists all of the files in task directories on the specified compute node. + /// Lists all of the files in Task directories on the specified Compute Node. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node whose files you want to list. + /// The ID of the Compute Node whose files you want to list. /// /// /// Whether to list children of a directory. @@ -434,16 +434,16 @@ public static partial class FileOperationsExtensions } /// - /// Lists all of the files in task directories on the specified compute node. + /// Lists all of the files in Task directories on the specified Compute Node. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node whose files you want to list. + /// The ID of the Compute Node whose files you want to list. /// /// /// Whether to list children of a directory. @@ -463,7 +463,7 @@ public static partial class FileOperationsExtensions } /// - /// Lists the files in a task's directory on its compute node. + /// Lists the files in a Task's directory on its Compute Node. /// /// /// The operations group for this extension method. @@ -480,7 +480,7 @@ public static partial class FileOperationsExtensions } /// - /// Lists the files in a task's directory on its compute node. + /// Lists the files in a Task's directory on its Compute Node. /// /// /// The operations group for this extension method. @@ -503,7 +503,7 @@ public static partial class FileOperationsExtensions } /// - /// Lists all of the files in task directories on the specified compute node. + /// Lists all of the files in Task directories on the specified Compute Node. /// /// /// The operations group for this extension method. @@ -520,7 +520,7 @@ public static partial class FileOperationsExtensions } /// - /// Lists all of the files in task directories on the specified compute node. + /// Lists all of the files in Task directories on the specified Compute Node. /// /// /// The operations group for this extension method. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IAccountOperations.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IAccountOperations.cs index 77f0404a9e45..db2c390c71a1 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IAccountOperations.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IAccountOperations.cs @@ -47,7 +47,7 @@ public partial interface IAccountOperations /// Task,AccountListSupportedImagesHeaders>> ListSupportedImagesWithHttpMessagesAsync(AccountListSupportedImagesOptions accountListSupportedImagesOptions = default(AccountListSupportedImagesOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Gets the number of nodes in each state, grouped by pool. + /// Gets the number of Compute Nodes in each state, grouped by Pool. /// /// /// Additional parameters for the operation @@ -95,7 +95,7 @@ public partial interface IAccountOperations /// Task,AccountListSupportedImagesHeaders>> ListSupportedImagesNextWithHttpMessagesAsync(string nextPageLink, AccountListSupportedImagesNextOptions accountListSupportedImagesNextOptions = default(AccountListSupportedImagesNextOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Gets the number of nodes in each state, grouped by pool. + /// Gets the number of Compute Nodes in each state, grouped by Pool. /// /// /// The NextLink from the previous successful call to List operation. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IApplicationOperations.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IApplicationOperations.cs index fae7c099940c..57246bb8a6c0 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IApplicationOperations.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IApplicationOperations.cs @@ -24,14 +24,14 @@ namespace Microsoft.Azure.Batch.Protocol public partial interface IApplicationOperations { /// - /// Lists all of the applications available in the specified account. + /// Lists all of the applications available in the specified Account. /// /// - /// This operation returns only applications and versions that are - /// available for use on compute nodes; that is, that can be used in an - /// application package reference. For administrator information about - /// applications and versions that are not yet available to compute - /// nodes, use the Azure portal or the Azure Resource Manager API. + /// This operation returns only Applications and versions that are + /// available for use on Compute Nodes; that is, that can be used in an + /// Package reference. For administrator information about applications + /// and versions that are not yet available to Compute Nodes, use the + /// Azure portal or the Azure Resource Manager API. /// /// /// Additional parameters for the operation @@ -53,17 +53,17 @@ public partial interface IApplicationOperations /// Task,ApplicationListHeaders>> ListWithHttpMessagesAsync(ApplicationListOptions applicationListOptions = default(ApplicationListOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Gets information about the specified application. + /// Gets information about the specified Application. /// /// - /// This operation returns only applications and versions that are - /// available for use on compute nodes; that is, that can be used in an - /// application package reference. For administrator information about - /// applications and versions that are not yet available to compute - /// nodes, use the Azure portal or the Azure Resource Manager API. + /// This operation returns only Applications and versions that are + /// available for use on Compute Nodes; that is, that can be used in an + /// Package reference. For administrator information about Applications + /// and versions that are not yet available to Compute Nodes, use the + /// Azure portal or the Azure Resource Manager API. /// /// - /// The ID of the application. + /// The ID of the Application. /// /// /// Additional parameters for the operation @@ -85,14 +85,14 @@ public partial interface IApplicationOperations /// Task> GetWithHttpMessagesAsync(string applicationId, ApplicationGetOptions applicationGetOptions = default(ApplicationGetOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Lists all of the applications available in the specified account. + /// Lists all of the applications available in the specified Account. /// /// - /// This operation returns only applications and versions that are - /// available for use on compute nodes; that is, that can be used in an - /// application package reference. For administrator information about - /// applications and versions that are not yet available to compute - /// nodes, use the Azure portal or the Azure Resource Manager API. + /// This operation returns only Applications and versions that are + /// available for use on Compute Nodes; that is, that can be used in an + /// Package reference. For administrator information about applications + /// and versions that are not yet available to Compute Nodes, use the + /// Azure portal or the Azure Resource Manager API. /// /// /// The NextLink from the previous successful call to List operation. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ICertificateOperations.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ICertificateOperations.cs index 2ad7bbce7732..14f0f8b4a2ad 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ICertificateOperations.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ICertificateOperations.cs @@ -24,10 +24,10 @@ namespace Microsoft.Azure.Batch.Protocol public partial interface ICertificateOperations { /// - /// Adds a certificate to the specified account. + /// Adds a Certificate to the specified Account. /// /// - /// The certificate to be added. + /// The Certificate to be added. /// /// /// Additional parameters for the operation @@ -46,8 +46,8 @@ public partial interface ICertificateOperations /// Task> AddWithHttpMessagesAsync(CertificateAddParameter certificate, CertificateAddOptions certificateAddOptions = default(CertificateAddOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Lists all of the certificates that have been added to the specified - /// account. + /// Lists all of the Certificates that have been added to the specified + /// Account. /// /// /// Additional parameters for the operation @@ -69,26 +69,26 @@ public partial interface ICertificateOperations /// Task,CertificateListHeaders>> ListWithHttpMessagesAsync(CertificateListOptions certificateListOptions = default(CertificateListOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Cancels a failed deletion of a certificate from the specified - /// account. + /// Cancels a failed deletion of a Certificate from the specified + /// Account. /// /// - /// If you try to delete a certificate that is being used by a pool or - /// compute node, the status of the certificate changes to + /// If you try to delete a Certificate that is being used by a Pool or + /// Compute Node, the status of the Certificate changes to /// deleteFailed. If you decide that you want to continue using the - /// certificate, you can use this operation to set the status of the - /// certificate back to active. If you intend to delete the - /// certificate, you do not need to run this operation after the - /// deletion failed. You must make sure that the certificate is not + /// Certificate, you can use this operation to set the status of the + /// Certificate back to active. If you intend to delete the + /// Certificate, you do not need to run this operation after the + /// deletion failed. You must make sure that the Certificate is not /// being used by any resources, and then you can try again to delete - /// the certificate. + /// the Certificate. /// /// /// The algorithm used to derive the thumbprint parameter. This must be /// sha1. /// /// - /// The thumbprint of the certificate being deleted. + /// The thumbprint of the Certificate being deleted. /// /// /// Additional parameters for the operation @@ -107,27 +107,27 @@ public partial interface ICertificateOperations /// Task> CancelDeletionWithHttpMessagesAsync(string thumbprintAlgorithm, string thumbprint, CertificateCancelDeletionOptions certificateCancelDeletionOptions = default(CertificateCancelDeletionOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Deletes a certificate from the specified account. + /// Deletes a Certificate from the specified Account. /// /// - /// You cannot delete a certificate if a resource (pool or compute - /// node) is using it. Before you can delete a certificate, you must - /// therefore make sure that the certificate is not associated with any - /// existing pools, the certificate is not installed on any compute - /// nodes (even if you remove a certificate from a pool, it is not - /// removed from existing compute nodes in that pool until they - /// restart), and no running tasks depend on the certificate. If you - /// try to delete a certificate that is in use, the deletion fails. The - /// certificate status changes to deleteFailed. You can use Cancel - /// Delete Certificate to set the status back to active if you decide - /// that you want to continue using the certificate. + /// You cannot delete a Certificate if a resource (Pool or Compute + /// Node) is using it. Before you can delete a Certificate, you must + /// therefore make sure that the Certificate is not associated with any + /// existing Pools, the Certificate is not installed on any Nodes (even + /// if you remove a Certificate from a Pool, it is not removed from + /// existing Compute Nodes in that Pool until they restart), and no + /// running Tasks depend on the Certificate. If you try to delete a + /// Certificate that is in use, the deletion fails. The Certificate + /// status changes to deleteFailed. You can use Cancel Delete + /// Certificate to set the status back to active if you decide that you + /// want to continue using the Certificate. /// /// /// The algorithm used to derive the thumbprint parameter. This must be /// sha1. /// /// - /// The thumbprint of the certificate to be deleted. + /// The thumbprint of the Certificate to be deleted. /// /// /// Additional parameters for the operation @@ -146,14 +146,14 @@ public partial interface ICertificateOperations /// Task> DeleteWithHttpMessagesAsync(string thumbprintAlgorithm, string thumbprint, CertificateDeleteOptions certificateDeleteOptions = default(CertificateDeleteOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Gets information about the specified certificate. + /// Gets information about the specified Certificate. /// /// /// The algorithm used to derive the thumbprint parameter. This must be /// sha1. /// /// - /// The thumbprint of the certificate to get. + /// The thumbprint of the Certificate to get. /// /// /// Additional parameters for the operation @@ -175,8 +175,8 @@ public partial interface ICertificateOperations /// Task> GetWithHttpMessagesAsync(string thumbprintAlgorithm, string thumbprint, CertificateGetOptions certificateGetOptions = default(CertificateGetOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Lists all of the certificates that have been added to the specified - /// account. + /// Lists all of the Certificates that have been added to the specified + /// Account. /// /// /// The NextLink from the previous successful call to List operation. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IComputeNodeOperations.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IComputeNodeOperations.cs index 84cad6409927..f993d0f053cc 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IComputeNodeOperations.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IComputeNodeOperations.cs @@ -25,20 +25,20 @@ namespace Microsoft.Azure.Batch.Protocol public partial interface IComputeNodeOperations { /// - /// Adds a user account to the specified compute node. + /// Adds a user Account to the specified Compute Node. /// /// - /// You can add a user account to a node only when it is in the idle or - /// running state. + /// You can add a user Account to a Compute Node only when it is in the + /// idle or running state. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the machine on which you want to create a user account. + /// The ID of the machine on which you want to create a user Account. /// /// - /// The user account to be created. + /// The user Account to be created. /// /// /// Additional parameters for the operation @@ -57,20 +57,20 @@ public partial interface IComputeNodeOperations /// Task> AddUserWithHttpMessagesAsync(string poolId, string nodeId, ComputeNodeUser user, ComputeNodeAddUserOptions computeNodeAddUserOptions = default(ComputeNodeAddUserOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Deletes a user account from the specified compute node. + /// Deletes a user Account from the specified Compute Node. /// /// - /// You can delete a user account to a node only when it is in the idle - /// or running state. + /// You can delete a user Account to a Compute Node only when it is in + /// the idle or running state. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the machine on which you want to delete a user account. + /// The ID of the machine on which you want to delete a user Account. /// /// - /// The name of the user account to delete. + /// The name of the user Account to delete. /// /// /// Additional parameters for the operation @@ -89,24 +89,24 @@ public partial interface IComputeNodeOperations /// Task> DeleteUserWithHttpMessagesAsync(string poolId, string nodeId, string userName, ComputeNodeDeleteUserOptions computeNodeDeleteUserOptions = default(ComputeNodeDeleteUserOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Updates the password and expiration time of a user account on the - /// specified compute node. + /// Updates the password and expiration time of a user Account on the + /// specified Compute Node. /// /// /// This operation replaces of all the updatable properties of the - /// account. For example, if the expiryTime element is not specified, + /// Account. For example, if the expiryTime element is not specified, /// the current value is replaced with the default value, not left - /// unmodified. You can update a user account on a node only when it is - /// in the idle or running state. + /// unmodified. You can update a user Account on a Compute Node only + /// when it is in the idle or running state. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the machine on which you want to update a user account. + /// The ID of the machine on which you want to update a user Account. /// /// - /// The name of the user account to update. + /// The name of the user Account to update. /// /// /// The parameters for the request. @@ -128,13 +128,13 @@ public partial interface IComputeNodeOperations /// Task> UpdateUserWithHttpMessagesAsync(string poolId, string nodeId, string userName, NodeUpdateUserParameter nodeUpdateUserParameter, ComputeNodeUpdateUserOptions computeNodeUpdateUserOptions = default(ComputeNodeUpdateUserOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Gets information about the specified compute node. + /// Gets information about the specified Compute Node. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node that you want to get information about. + /// The ID of the Compute Node that you want to get information about. /// /// /// Additional parameters for the operation @@ -156,20 +156,21 @@ public partial interface IComputeNodeOperations /// Task> GetWithHttpMessagesAsync(string poolId, string nodeId, ComputeNodeGetOptions computeNodeGetOptions = default(ComputeNodeGetOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Restarts the specified compute node. + /// Restarts the specified Compute Node. /// /// - /// You can restart a node only if it is in an idle or running state. + /// You can restart a Compute Node only if it is in an idle or running + /// state. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node that you want to restart. + /// The ID of the Compute Node that you want to restart. /// /// - /// When to reboot the compute node and what to do with currently - /// running tasks. The default value is requeue. Possible values + /// When to reboot the Compute Node and what to do with currently + /// running Tasks. The default value is requeue. Possible values /// include: 'requeue', 'terminate', 'taskCompletion', 'retainedData' /// /// @@ -189,22 +190,22 @@ public partial interface IComputeNodeOperations /// Task> RebootWithHttpMessagesAsync(string poolId, string nodeId, ComputeNodeRebootOption? nodeRebootOption = default(ComputeNodeRebootOption?), ComputeNodeRebootOptions computeNodeRebootOptions = default(ComputeNodeRebootOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Reinstalls the operating system on the specified compute node. + /// Reinstalls the operating system on the specified Compute Node. /// /// - /// You can reinstall the operating system on a node only if it is in - /// an idle or running state. This API can be invoked only on pools - /// created with the cloud service configuration property. + /// You can reinstall the operating system on a Compute Node only if it + /// is in an idle or running state. This API can be invoked only on + /// Pools created with the cloud service configuration property. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node that you want to restart. + /// The ID of the Compute Node that you want to restart. /// /// - /// When to reimage the compute node and what to do with currently - /// running tasks. The default value is requeue. Possible values + /// When to reimage the Compute Node and what to do with currently + /// running Tasks. The default value is requeue. Possible values /// include: 'requeue', 'terminate', 'taskCompletion', 'retainedData' /// /// @@ -224,22 +225,22 @@ public partial interface IComputeNodeOperations /// Task> ReimageWithHttpMessagesAsync(string poolId, string nodeId, ComputeNodeReimageOption? nodeReimageOption = default(ComputeNodeReimageOption?), ComputeNodeReimageOptions computeNodeReimageOptions = default(ComputeNodeReimageOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Disables task scheduling on the specified compute node. + /// Disables Task scheduling on the specified Compute Node. /// /// - /// You can disable task scheduling on a node only if its current - /// scheduling state is enabled. + /// You can disable Task scheduling on a Compute Node only if its + /// current scheduling state is enabled. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node on which you want to disable task + /// The ID of the Compute Node on which you want to disable Task /// scheduling. /// /// - /// What to do with currently running tasks when disabling task - /// scheduling on the compute node. The default value is requeue. + /// What to do with currently running Tasks when disabling Task + /// scheduling on the Compute Node. The default value is requeue. /// Possible values include: 'requeue', 'terminate', 'taskCompletion' /// /// @@ -259,17 +260,17 @@ public partial interface IComputeNodeOperations /// Task> DisableSchedulingWithHttpMessagesAsync(string poolId, string nodeId, DisableComputeNodeSchedulingOption? nodeDisableSchedulingOption = default(DisableComputeNodeSchedulingOption?), ComputeNodeDisableSchedulingOptions computeNodeDisableSchedulingOptions = default(ComputeNodeDisableSchedulingOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Enables task scheduling on the specified compute node. + /// Enables Task scheduling on the specified Compute Node. /// /// - /// You can enable task scheduling on a node only if its current - /// scheduling state is disabled + /// You can enable Task scheduling on a Compute Node only if its + /// current scheduling state is disabled /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node on which you want to enable task + /// The ID of the Compute Node on which you want to enable Task /// scheduling. /// /// @@ -289,20 +290,20 @@ public partial interface IComputeNodeOperations /// Task> EnableSchedulingWithHttpMessagesAsync(string poolId, string nodeId, ComputeNodeEnableSchedulingOptions computeNodeEnableSchedulingOptions = default(ComputeNodeEnableSchedulingOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Gets the settings required for remote login to a compute node. + /// Gets the settings required for remote login to a Compute Node. /// /// - /// Before you can remotely login to a node using the remote login - /// settings, you must create a user account on the node. This API can - /// be invoked only on pools created with the virtual machine - /// configuration property. For pools created with a cloud service - /// configuration, see the GetRemoteDesktop API. + /// Before you can remotely login to a Compute Node using the remote + /// login settings, you must create a user Account on the Compute Node. + /// This API can be invoked only on Pools created with the virtual + /// machine configuration property. For Pools created with a cloud + /// service configuration, see the GetRemoteDesktop API. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node for which to obtain the remote login + /// The ID of the Compute Node for which to obtain the remote login /// settings. /// /// @@ -325,21 +326,21 @@ public partial interface IComputeNodeOperations /// Task> GetRemoteLoginSettingsWithHttpMessagesAsync(string poolId, string nodeId, ComputeNodeGetRemoteLoginSettingsOptions computeNodeGetRemoteLoginSettingsOptions = default(ComputeNodeGetRemoteLoginSettingsOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Gets the Remote Desktop Protocol file for the specified compute - /// node. + /// Gets the Remote Desktop Protocol file for the specified Compute + /// Node. /// /// - /// Before you can access a node by using the RDP file, you must create - /// a user account on the node. This API can only be invoked on pools - /// created with a cloud service configuration. For pools created with - /// a virtual machine configuration, see the GetRemoteLoginSettings - /// API. + /// Before you can access a Compute Node by using the RDP file, you + /// must create a user Account on the Compute Node. This API can only + /// be invoked on Pools created with a cloud service configuration. For + /// Pools created with a virtual machine configuration, see the + /// GetRemoteLoginSettings API. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node for which you want to get the Remote + /// The ID of the Compute Node for which you want to get the Remote /// Desktop Protocol file. /// /// @@ -362,21 +363,21 @@ public partial interface IComputeNodeOperations /// Task> GetRemoteDesktopWithHttpMessagesAsync(string poolId, string nodeId, ComputeNodeGetRemoteDesktopOptions computeNodeGetRemoteDesktopOptions = default(ComputeNodeGetRemoteDesktopOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Upload Azure Batch service log files from the specified compute - /// node to Azure Blob Storage. + /// Upload Azure Batch service log files from the specified Compute + /// Node to Azure Blob Storage. /// /// /// This is for gathering Azure Batch service log files in an automated - /// fashion from nodes if you are experiencing an error and wish to - /// escalate to Azure support. The Azure Batch service log files should - /// be shared with Azure support to aid in debugging issues with the - /// Batch service. + /// fashion from Compute Nodes if you are experiencing an error and + /// wish to escalate to Azure support. The Azure Batch service log + /// files should be shared with Azure support to aid in debugging + /// issues with the Batch service. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node from which you want to upload the Azure + /// The ID of the Compute Node from which you want to upload the Azure /// Batch service log files. /// /// @@ -402,10 +403,10 @@ public partial interface IComputeNodeOperations /// Task> UploadBatchServiceLogsWithHttpMessagesAsync(string poolId, string nodeId, UploadBatchServiceLogsConfiguration uploadBatchServiceLogsConfiguration, ComputeNodeUploadBatchServiceLogsOptions computeNodeUploadBatchServiceLogsOptions = default(ComputeNodeUploadBatchServiceLogsOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Lists the compute nodes in the specified pool. + /// Lists the Compute Nodes in the specified Pool. /// /// - /// The ID of the pool from which you want to list nodes. + /// The ID of the Pool from which you want to list Compute Nodes. /// /// /// Additional parameters for the operation @@ -427,7 +428,7 @@ public partial interface IComputeNodeOperations /// Task,ComputeNodeListHeaders>> ListWithHttpMessagesAsync(string poolId, ComputeNodeListOptions computeNodeListOptions = default(ComputeNodeListOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Lists the compute nodes in the specified pool. + /// Lists the Compute Nodes in the specified Pool. /// /// /// The NextLink from the previous successful call to List operation. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IFileOperations.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IFileOperations.cs index ea04a98879c8..8b51a6648df5 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IFileOperations.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IFileOperations.cs @@ -25,17 +25,17 @@ namespace Microsoft.Azure.Batch.Protocol public partial interface IFileOperations { /// - /// Deletes the specified task file from the compute node where the - /// task ran. + /// Deletes the specified Task file from the Compute Node where the + /// Task ran. /// /// - /// The ID of the job that contains the task. + /// The ID of the Job that contains the Task. /// /// - /// The ID of the task whose file you want to delete. + /// The ID of the Task whose file you want to delete. /// /// - /// The path to the task file or directory that you want to delete. + /// The path to the Task file or directory that you want to delete. /// /// /// Whether to delete children of a directory. If the filePath @@ -61,16 +61,16 @@ public partial interface IFileOperations /// Task> DeleteFromTaskWithHttpMessagesAsync(string jobId, string taskId, string filePath, bool? recursive = default(bool?), FileDeleteFromTaskOptions fileDeleteFromTaskOptions = default(FileDeleteFromTaskOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Returns the content of the specified task file. + /// Returns the content of the specified Task file. /// /// - /// The ID of the job that contains the task. + /// The ID of the Job that contains the Task. /// /// - /// The ID of the task whose file you want to retrieve. + /// The ID of the Task whose file you want to retrieve. /// /// - /// The path to the task file that you want to get the content of. + /// The path to the Task file that you want to get the content of. /// /// /// Additional parameters for the operation @@ -92,16 +92,16 @@ public partial interface IFileOperations /// Task> GetFromTaskWithHttpMessagesAsync(string jobId, string taskId, string filePath, FileGetFromTaskOptions fileGetFromTaskOptions = default(FileGetFromTaskOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Gets the properties of the specified task file. + /// Gets the properties of the specified Task file. /// /// - /// The ID of the job that contains the task. + /// The ID of the Job that contains the Task. /// /// - /// The ID of the task whose file you want to get the properties of. + /// The ID of the Task whose file you want to get the properties of. /// /// - /// The path to the task file that you want to get the properties of. + /// The path to the Task file that you want to get the properties of. /// /// /// Additional parameters for the operation @@ -120,13 +120,13 @@ public partial interface IFileOperations /// Task> GetPropertiesFromTaskWithHttpMessagesAsync(string jobId, string taskId, string filePath, FileGetPropertiesFromTaskOptions fileGetPropertiesFromTaskOptions = default(FileGetPropertiesFromTaskOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Deletes the specified file from the compute node. + /// Deletes the specified file from the Compute Node. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node from which you want to delete the file. + /// The ID of the Compute Node from which you want to delete the file. /// /// /// The path to the file or directory that you want to delete. @@ -155,16 +155,16 @@ public partial interface IFileOperations /// Task> DeleteFromComputeNodeWithHttpMessagesAsync(string poolId, string nodeId, string filePath, bool? recursive = default(bool?), FileDeleteFromComputeNodeOptions fileDeleteFromComputeNodeOptions = default(FileDeleteFromComputeNodeOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Returns the content of the specified compute node file. + /// Returns the content of the specified Compute Node file. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node that contains the file. + /// The ID of the Compute Node that contains the file. /// /// - /// The path to the compute node file that you want to get the content + /// The path to the Compute Node file that you want to get the content /// of. /// /// @@ -187,16 +187,16 @@ public partial interface IFileOperations /// Task> GetFromComputeNodeWithHttpMessagesAsync(string poolId, string nodeId, string filePath, FileGetFromComputeNodeOptions fileGetFromComputeNodeOptions = default(FileGetFromComputeNodeOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Gets the properties of the specified compute node file. + /// Gets the properties of the specified Compute Node file. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node that contains the file. + /// The ID of the Compute Node that contains the file. /// /// - /// The path to the compute node file that you want to get the + /// The path to the Compute Node file that you want to get the /// properties of. /// /// @@ -216,16 +216,16 @@ public partial interface IFileOperations /// Task> GetPropertiesFromComputeNodeWithHttpMessagesAsync(string poolId, string nodeId, string filePath, FileGetPropertiesFromComputeNodeOptions fileGetPropertiesFromComputeNodeOptions = default(FileGetPropertiesFromComputeNodeOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Lists the files in a task's directory on its compute node. + /// Lists the files in a Task's directory on its Compute Node. /// /// - /// The ID of the job that contains the task. + /// The ID of the Job that contains the Task. /// /// - /// The ID of the task whose files you want to list. + /// The ID of the Task whose files you want to list. /// /// - /// Whether to list children of the task directory. This parameter can + /// Whether to list children of the Task directory. This parameter can /// be used in combination with the filter parameter to list specific /// type of files. /// @@ -249,14 +249,14 @@ public partial interface IFileOperations /// Task,FileListFromTaskHeaders>> ListFromTaskWithHttpMessagesAsync(string jobId, string taskId, bool? recursive = default(bool?), FileListFromTaskOptions fileListFromTaskOptions = default(FileListFromTaskOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Lists all of the files in task directories on the specified compute - /// node. + /// Lists all of the files in Task directories on the specified Compute + /// Node. /// /// - /// The ID of the pool that contains the compute node. + /// The ID of the Pool that contains the Compute Node. /// /// - /// The ID of the compute node whose files you want to list. + /// The ID of the Compute Node whose files you want to list. /// /// /// Whether to list children of a directory. @@ -281,7 +281,7 @@ public partial interface IFileOperations /// Task,FileListFromComputeNodeHeaders>> ListFromComputeNodeWithHttpMessagesAsync(string poolId, string nodeId, bool? recursive = default(bool?), FileListFromComputeNodeOptions fileListFromComputeNodeOptions = default(FileListFromComputeNodeOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Lists the files in a task's directory on its compute node. + /// Lists the files in a Task's directory on its Compute Node. /// /// /// The NextLink from the previous successful call to List operation. @@ -306,8 +306,8 @@ public partial interface IFileOperations /// Task,FileListFromTaskHeaders>> ListFromTaskNextWithHttpMessagesAsync(string nextPageLink, FileListFromTaskNextOptions fileListFromTaskNextOptions = default(FileListFromTaskNextOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Lists all of the files in task directories on the specified compute - /// node. + /// Lists all of the files in Task directories on the specified Compute + /// Node. /// /// /// The NextLink from the previous successful call to List operation. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IJobOperations.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IJobOperations.cs index 7925e2c48619..95fbaa092b53 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IJobOperations.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IJobOperations.cs @@ -24,12 +24,12 @@ namespace Microsoft.Azure.Batch.Protocol public partial interface IJobOperations { /// - /// Gets lifetime summary statistics for all of the jobs in the - /// specified account. + /// Gets lifetime summary statistics for all of the Jobs in the + /// specified 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 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. @@ -54,21 +54,21 @@ public partial interface IJobOperations /// Task> GetAllLifetimeStatisticsWithHttpMessagesAsync(JobGetAllLifetimeStatisticsOptions jobGetAllLifetimeStatisticsOptions = default(JobGetAllLifetimeStatisticsOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Deletes a job. + /// Deletes a Job. /// /// - /// Deleting a job also deletes all tasks that are part of that job, - /// and all job statistics. This also overrides the retention period - /// for task data; that is, if the job contains tasks which are still - /// retained on compute nodes, the Batch services deletes those tasks' + /// Deleting a Job also deletes all Tasks that are part of that Job, + /// and all Job statistics. This also overrides the retention period + /// for Task data; that is, if the Job contains Tasks which are still + /// retained on Compute Nodes, the Batch services deletes those Tasks' /// working directories and all their contents. When a Delete Job - /// request is received, the Batch service sets the job to the deleting - /// state. All update operations on a job that is in deleting state + /// request is received, the Batch service sets the Job to the deleting + /// state. All update operations on a Job that is in deleting state /// will fail with status code 409 (Conflict), with additional - /// information indicating that the job is being deleted. + /// information indicating that the Job is being deleted. /// /// - /// The ID of the job to delete. + /// The ID of the Job to delete. /// /// /// Additional parameters for the operation @@ -87,10 +87,10 @@ public partial interface IJobOperations /// Task> DeleteWithHttpMessagesAsync(string jobId, JobDeleteOptions jobDeleteOptions = default(JobDeleteOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Gets information about the specified job. + /// Gets information about the specified Job. /// /// - /// The ID of the job. + /// The ID of the Job. /// /// /// Additional parameters for the operation @@ -112,16 +112,16 @@ public partial interface IJobOperations /// Task> GetWithHttpMessagesAsync(string jobId, JobGetOptions jobGetOptions = default(JobGetOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Updates the properties of the specified job. + /// Updates the properties of the specified Job. /// /// - /// This replaces only the job properties specified in the request. For - /// example, if the job has constraints, and a request does not specify - /// the constraints element, then the job keeps the existing + /// This replaces only the Job properties specified in the request. For + /// example, if the Job has constraints, and a request does not specify + /// the constraints element, then the Job keeps the existing /// constraints. /// /// - /// The ID of the job whose properties you want to update. + /// The ID of the Job whose properties you want to update. /// /// /// The parameters for the request. @@ -143,16 +143,16 @@ public partial interface IJobOperations /// Task> PatchWithHttpMessagesAsync(string jobId, JobPatchParameter jobPatchParameter, JobPatchOptions jobPatchOptions = default(JobPatchOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Updates the properties of the specified job. + /// Updates the properties of the specified Job. /// /// - /// This fully replaces all the updatable properties of the job. For - /// example, if the job has constraints associated with it and if + /// This fully replaces all the updatable properties of the Job. For + /// example, if the Job has constraints associated with it and if /// constraints is not specified with this request, then the Batch /// service will remove the existing constraints. /// /// - /// The ID of the job whose properties you want to update. + /// The ID of the Job whose properties you want to update. /// /// /// The parameters for the request. @@ -174,24 +174,24 @@ public partial interface IJobOperations /// Task> UpdateWithHttpMessagesAsync(string jobId, JobUpdateParameter jobUpdateParameter, JobUpdateOptions jobUpdateOptions = default(JobUpdateOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Disables the specified job, preventing new tasks from running. + /// Disables the specified Job, preventing new Tasks from running. /// /// - /// The Batch Service immediately moves the job to the disabling state. + /// The Batch Service immediately moves the Job to the disabling state. /// Batch then uses the disableTasks parameter to determine what to do - /// with the currently running tasks of the job. The job remains in the + /// with the currently running Tasks of the Job. The Job remains in the /// disabling state until the disable operation is completed and all - /// tasks have been dealt with according to the disableTasks option; - /// the job then moves to the disabled state. No new tasks are started - /// under the job until it moves back to active state. If you try to - /// disable a job that is in any state other than active, disabling, or + /// Tasks have been dealt with according to the disableTasks option; + /// the Job then moves to the disabled state. No new Tasks are started + /// under the Job until it moves back to active state. If you try to + /// disable a Job that is in any state other than active, disabling, or /// disabled, the request fails with status code 409. /// /// - /// The ID of the job to disable. + /// The ID of the Job to disable. /// /// - /// What to do with active tasks associated with the job. Possible + /// What to do with active Tasks associated with the Job. Possible /// values include: 'requeue', 'terminate', 'wait' /// /// @@ -211,19 +211,19 @@ public partial interface IJobOperations /// Task> DisableWithHttpMessagesAsync(string jobId, DisableJobOption disableTasks, JobDisableOptions jobDisableOptions = default(JobDisableOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Enables the specified job, allowing new tasks to run. + /// Enables the specified Job, allowing new Tasks to run. /// /// - /// When you call this API, the Batch service sets a disabled job to - /// the enabling state. After the this operation is completed, the job - /// moves to the active state, and scheduling of new tasks under the - /// job resumes. The Batch service does not allow a task to remain in + /// When you call this API, the Batch service sets a disabled Job to + /// the enabling state. After the this operation is completed, the Job + /// moves to the active state, and scheduling of new Tasks under the + /// Job resumes. The Batch service does not allow a Task to remain in /// the active state for more than 180 days. Therefore, if you enable a - /// job containing active tasks which were added more than 180 days - /// ago, those tasks will not run. + /// Job containing active Tasks which were added more than 180 days + /// ago, those Tasks will not run. /// /// - /// The ID of the job to enable. + /// The ID of the Job to enable. /// /// /// Additional parameters for the operation @@ -242,23 +242,23 @@ public partial interface IJobOperations /// Task> EnableWithHttpMessagesAsync(string jobId, JobEnableOptions jobEnableOptions = default(JobEnableOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Terminates the specified job, marking it as completed. + /// Terminates the specified Job, marking it as completed. /// /// /// When a Terminate Job request is received, the Batch service sets - /// the job to 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 + /// the Job to 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. + /// The ID of the Job to terminate. /// /// - /// The text you want to appear as the job's TerminateReason. The + /// The text you want to appear as the Job's TerminateReason. The /// default is 'UserTerminate'. /// /// @@ -278,22 +278,22 @@ public partial interface IJobOperations /// Task> TerminateWithHttpMessagesAsync(string jobId, string terminateReason = default(string), JobTerminateOptions jobTerminateOptions = default(JobTerminateOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Adds a job to the specified account. + /// Adds a Job to the specified Account. /// /// /// The Batch service supports two ways to control the work done as - /// part of a job. In the first approach, the user specifies a Job - /// Manager task. The Batch service launches this task when it is ready - /// to start the job. The Job Manager task controls all other tasks - /// that run under this job, by using the Task APIs. In the second - /// approach, the user directly controls the execution of tasks under - /// an active job, by using the Task APIs. Also note: when naming jobs, + /// part of a Job. In the first approach, the user specifies a Job + /// Manager Task. The Batch service launches this Task when it is ready + /// to start the Job. The Job Manager Task controls all other Tasks + /// that run under this Job, by using the Task APIs. In the second + /// approach, the user directly controls the execution of Tasks under + /// an active Job, by using the Task APIs. Also note: when naming Jobs, /// avoid including sensitive information such as user names or secret /// project names. This information may appear in telemetry logs /// accessible to Microsoft Support engineers. /// /// - /// The job to be added. + /// The Job to be added. /// /// /// Additional parameters for the operation @@ -312,7 +312,7 @@ public partial interface IJobOperations /// Task> AddWithHttpMessagesAsync(JobAddParameter job, JobAddOptions jobAddOptions = default(JobAddOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Lists all of the jobs in the specified account. + /// Lists all of the Jobs in the specified Account. /// /// /// Additional parameters for the operation @@ -334,12 +334,12 @@ public partial interface IJobOperations /// Task,JobListHeaders>> ListWithHttpMessagesAsync(JobListOptions jobListOptions = default(JobListOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Lists the jobs that have been created under the specified job - /// schedule. + /// Lists the Jobs that have been created under the specified Job + /// Schedule. /// /// - /// The ID of the job schedule from which you want to get a list of - /// jobs. + /// The ID of the Job Schedule from which you want to get a list of + /// Jobs. /// /// /// Additional parameters for the operation @@ -362,19 +362,20 @@ public partial interface IJobOperations Task,JobListFromJobScheduleHeaders>> ListFromJobScheduleWithHttpMessagesAsync(string jobScheduleId, JobListFromJobScheduleOptions jobListFromJobScheduleOptions = default(JobListFromJobScheduleOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// /// Lists the execution status of the Job Preparation and Job Release - /// task for the specified job across the compute nodes where the job + /// Task for the specified Job across the Compute Nodes where the Job /// has run. /// /// - /// This API returns the Job Preparation and Job Release task status on - /// all compute nodes that have run the Job Preparation or Job Release - /// task. This includes nodes which have since been removed from the - /// pool. If this API is invoked on a job which has no Job Preparation - /// or Job Release task, the Batch service returns HTTP status code 409 - /// (Conflict) with an error code of JobPreparationTaskNotSpecified. + /// This API returns the Job Preparation and Job Release Task status on + /// all Compute Nodes that have run the Job Preparation or Job Release + /// Task. This includes Compute Nodes which have since been removed + /// from the Pool. If this API is invoked on a Job which has no Job + /// Preparation or Job Release Task, the Batch service returns HTTP + /// status code 409 (Conflict) with an error code of + /// JobPreparationTaskNotSpecified. /// /// - /// The ID of the job. + /// The ID of the Job. /// /// /// Additional parameters for the operation @@ -396,15 +397,15 @@ public partial interface IJobOperations /// Task,JobListPreparationAndReleaseTaskStatusHeaders>> ListPreparationAndReleaseTaskStatusWithHttpMessagesAsync(string jobId, JobListPreparationAndReleaseTaskStatusOptions jobListPreparationAndReleaseTaskStatusOptions = default(JobListPreparationAndReleaseTaskStatusOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Gets the task counts for the specified job. + /// Gets the Task counts for the specified Job. /// /// - /// Task counts provide a count of the tasks by active, running or - /// completed task state, and a count of tasks which succeeded or + /// Task counts provide a count of the Tasks by active, running or + /// completed Task state, and a count of Tasks which succeeded or /// failed. Tasks in the preparing state are counted as running. /// /// - /// The ID of the job. + /// The ID of the Job. /// /// /// Additional parameters for the operation @@ -426,7 +427,7 @@ public partial interface IJobOperations /// Task> GetTaskCountsWithHttpMessagesAsync(string jobId, JobGetTaskCountsOptions jobGetTaskCountsOptions = default(JobGetTaskCountsOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Lists all of the jobs in the specified account. + /// Lists all of the Jobs in the specified Account. /// /// /// The NextLink from the previous successful call to List operation. @@ -451,8 +452,8 @@ public partial interface IJobOperations /// Task,JobListHeaders>> ListNextWithHttpMessagesAsync(string nextPageLink, JobListNextOptions jobListNextOptions = default(JobListNextOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Lists the jobs that have been created under the specified job - /// schedule. + /// Lists the Jobs that have been created under the specified Job + /// Schedule. /// /// /// The NextLink from the previous successful call to List operation. @@ -478,16 +479,17 @@ public partial interface IJobOperations Task,JobListFromJobScheduleHeaders>> ListFromJobScheduleNextWithHttpMessagesAsync(string nextPageLink, JobListFromJobScheduleNextOptions jobListFromJobScheduleNextOptions = default(JobListFromJobScheduleNextOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// /// Lists the execution status of the Job Preparation and Job Release - /// task for the specified job across the compute nodes where the job + /// Task for the specified Job across the Compute Nodes where the Job /// has run. /// /// - /// This API returns the Job Preparation and Job Release task status on - /// all compute nodes that have run the Job Preparation or Job Release - /// task. This includes nodes which have since been removed from the - /// pool. If this API is invoked on a job which has no Job Preparation - /// or Job Release task, the Batch service returns HTTP status code 409 - /// (Conflict) with an error code of JobPreparationTaskNotSpecified. + /// This API returns the Job Preparation and Job Release Task status on + /// all Compute Nodes that have run the Job Preparation or Job Release + /// Task. This includes Compute Nodes which have since been removed + /// from the Pool. If this API is invoked on a Job which has no Job + /// Preparation or Job Release Task, the Batch service returns HTTP + /// status code 409 (Conflict) with an error code of + /// JobPreparationTaskNotSpecified. /// /// /// The NextLink from the previous successful call to List operation. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IJobScheduleOperations.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IJobScheduleOperations.cs index e8c9e6b1825b..86dac0523c20 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IJobScheduleOperations.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IJobScheduleOperations.cs @@ -24,10 +24,10 @@ namespace Microsoft.Azure.Batch.Protocol public partial interface IJobScheduleOperations { /// - /// Checks the specified job schedule exists. + /// Checks the specified Job Schedule exists. /// /// - /// The ID of the job schedule which you want to check. + /// The ID of the Job Schedule which you want to check. /// /// /// Additional parameters for the operation @@ -46,18 +46,18 @@ public partial interface IJobScheduleOperations /// Task> ExistsWithHttpMessagesAsync(string jobScheduleId, JobScheduleExistsOptions jobScheduleExistsOptions = default(JobScheduleExistsOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Deletes a job schedule from the specified account. + /// Deletes a Job Schedule from the specified Account. /// /// - /// When you delete a job schedule, this also deletes all jobs and - /// tasks under that schedule. When tasks are deleted, all the files in - /// their working directories on the compute nodes are also deleted - /// (the retention period is ignored). The job schedule statistics are - /// no longer accessible once the job schedule is deleted, though they - /// are still counted towards account lifetime statistics. + /// When you delete a Job Schedule, this also deletes all Jobs and + /// Tasks under that schedule. When Tasks are deleted, all the files in + /// their working directories on the Compute Nodes are also deleted + /// (the retention period is ignored). The Job Schedule statistics are + /// no longer accessible once the Job Schedule is deleted, though they + /// are still counted towards Account lifetime statistics. /// /// - /// The ID of the job schedule to delete. + /// The ID of the Job Schedule to delete. /// /// /// Additional parameters for the operation @@ -76,10 +76,10 @@ public partial interface IJobScheduleOperations /// Task> DeleteWithHttpMessagesAsync(string jobScheduleId, JobScheduleDeleteOptions jobScheduleDeleteOptions = default(JobScheduleDeleteOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Gets information about the specified job schedule. + /// Gets information about the specified Job Schedule. /// /// - /// The ID of the job schedule to get. + /// The ID of the Job Schedule to get. /// /// /// Additional parameters for the operation @@ -101,18 +101,18 @@ public partial interface IJobScheduleOperations /// Task> GetWithHttpMessagesAsync(string jobScheduleId, JobScheduleGetOptions jobScheduleGetOptions = default(JobScheduleGetOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Updates the properties of the specified job schedule. + /// Updates the properties of the specified Job Schedule. /// /// - /// This replaces only the job schedule properties specified in the + /// This replaces only the Job Schedule properties specified in the /// request. For example, if the schedule property is not specified /// with this request, then the Batch service will keep the existing - /// schedule. Changes to a job schedule only impact jobs created by the - /// schedule after the update has taken place; currently running jobs + /// schedule. Changes to a Job Schedule only impact Jobs created by the + /// schedule after the update has taken place; currently running Jobs /// are unaffected. /// /// - /// The ID of the job schedule to update. + /// The ID of the Job Schedule to update. /// /// /// The parameters for the request. @@ -134,18 +134,18 @@ public partial interface IJobScheduleOperations /// Task> PatchWithHttpMessagesAsync(string jobScheduleId, JobSchedulePatchParameter jobSchedulePatchParameter, JobSchedulePatchOptions jobSchedulePatchOptions = default(JobSchedulePatchOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Updates the properties of the specified job schedule. + /// Updates the properties of the specified Job Schedule. /// /// - /// This fully replaces all the updatable properties of the job - /// schedule. For example, if the schedule property is not specified + /// This fully replaces all the updatable properties of the Job + /// Schedule. For example, if the schedule property is not specified /// with this request, then the Batch service will remove the existing - /// schedule. Changes to a job schedule only impact jobs created by the - /// schedule after the update has taken place; currently running jobs + /// schedule. Changes to a Job Schedule only impact Jobs created by the + /// schedule after the update has taken place; currently running Jobs /// are unaffected. /// /// - /// The ID of the job schedule to update. + /// The ID of the Job Schedule to update. /// /// /// The parameters for the request. @@ -167,14 +167,14 @@ public partial interface IJobScheduleOperations /// Task> UpdateWithHttpMessagesAsync(string jobScheduleId, JobScheduleUpdateParameter jobScheduleUpdateParameter, JobScheduleUpdateOptions jobScheduleUpdateOptions = default(JobScheduleUpdateOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Disables a job schedule. + /// Disables a Job Schedule. /// /// - /// No new jobs will be created until the job schedule is enabled + /// No new Jobs will be created until the Job Schedule is enabled /// again. /// /// - /// The ID of the job schedule to disable. + /// The ID of the Job Schedule to disable. /// /// /// Additional parameters for the operation @@ -193,10 +193,10 @@ public partial interface IJobScheduleOperations /// Task> DisableWithHttpMessagesAsync(string jobScheduleId, JobScheduleDisableOptions jobScheduleDisableOptions = default(JobScheduleDisableOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Enables a job schedule. + /// Enables a Job Schedule. /// /// - /// The ID of the job schedule to enable. + /// The ID of the Job Schedule to enable. /// /// /// Additional parameters for the operation @@ -215,10 +215,10 @@ public partial interface IJobScheduleOperations /// Task> EnableWithHttpMessagesAsync(string jobScheduleId, JobScheduleEnableOptions jobScheduleEnableOptions = default(JobScheduleEnableOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Terminates a job schedule. + /// Terminates a Job Schedule. /// /// - /// The ID of the job schedule to terminates. + /// The ID of the Job Schedule to terminates. /// /// /// Additional parameters for the operation @@ -237,10 +237,10 @@ public partial interface IJobScheduleOperations /// Task> TerminateWithHttpMessagesAsync(string jobScheduleId, JobScheduleTerminateOptions jobScheduleTerminateOptions = default(JobScheduleTerminateOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Adds a job schedule to the specified account. + /// Adds a Job Schedule to the specified Account. /// /// - /// The job schedule to be added. + /// The Job Schedule to be added. /// /// /// Additional parameters for the operation @@ -259,7 +259,7 @@ public partial interface IJobScheduleOperations /// Task> AddWithHttpMessagesAsync(JobScheduleAddParameter cloudJobSchedule, JobScheduleAddOptions jobScheduleAddOptions = default(JobScheduleAddOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Lists all of the job schedules in the specified account. + /// Lists all of the Job Schedules in the specified Account. /// /// /// Additional parameters for the operation @@ -281,7 +281,7 @@ public partial interface IJobScheduleOperations /// Task,JobScheduleListHeaders>> ListWithHttpMessagesAsync(JobScheduleListOptions jobScheduleListOptions = default(JobScheduleListOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Lists all of the job schedules in the specified account. + /// Lists all of the Job Schedules in the specified Account. /// /// /// The NextLink from the previous successful call to List operation. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IPoolOperations.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IPoolOperations.cs index 7438b4ddc2bf..6f562dfc7adf 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IPoolOperations.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/IPoolOperations.cs @@ -24,12 +24,12 @@ namespace Microsoft.Azure.Batch.Protocol public partial interface IPoolOperations { /// - /// Lists the usage metrics, aggregated by pool across individual time - /// intervals, for the specified account. + /// Lists the usage metrics, aggregated by Pool across individual time + /// intervals, for the specified Account. /// /// /// If you do not specify a $filter clause including a poolId, the - /// response includes all pools that existed in the account in the time + /// response includes all Pools that existed in the Account in the time /// range of the returned aggregation intervals. If you do not specify /// a $filter clause including a startTime or endTime these filters /// default to the start and end times of the last aggregation interval @@ -56,12 +56,12 @@ public partial interface IPoolOperations /// Task,PoolListUsageMetricsHeaders>> ListUsageMetricsWithHttpMessagesAsync(PoolListUsageMetricsOptions poolListUsageMetricsOptions = default(PoolListUsageMetricsOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Gets lifetime summary statistics for all of the pools in the - /// specified account. + /// Gets lifetime summary statistics for all of the Pools in the + /// specified Account. /// /// - /// Statistics are aggregated across all pools that have ever existed - /// in the account, from account creation to the last update time of + /// 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. @@ -86,15 +86,15 @@ public partial interface IPoolOperations /// Task> GetAllLifetimeStatisticsWithHttpMessagesAsync(PoolGetAllLifetimeStatisticsOptions poolGetAllLifetimeStatisticsOptions = default(PoolGetAllLifetimeStatisticsOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Adds a pool to the specified account. + /// Adds a Pool to the specified Account. /// /// - /// When naming pools, avoid including sensitive information such as + /// When naming Pools, avoid including sensitive information such as /// user names or secret project names. This information may appear in /// telemetry logs accessible to Microsoft Support engineers. /// /// - /// The pool to be added. + /// The Pool to be added. /// /// /// Additional parameters for the operation @@ -113,7 +113,7 @@ public partial interface IPoolOperations /// Task> AddWithHttpMessagesAsync(PoolAddParameter pool, PoolAddOptions poolAddOptions = default(PoolAddOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Lists all of the pools in the specified account. + /// Lists all of the Pools in the specified Account. /// /// /// Additional parameters for the operation @@ -135,26 +135,26 @@ public partial interface IPoolOperations /// Task,PoolListHeaders>> ListWithHttpMessagesAsync(PoolListOptions poolListOptions = default(PoolListOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Deletes a pool from the specified account. + /// Deletes a Pool from the specified Account. /// /// - /// When you request that a pool be deleted, the following actions - /// occur: the pool state is set to deleting; any ongoing resize - /// operation on the pool are stopped; the Batch service starts - /// resizing the pool to zero nodes; any tasks running on existing - /// nodes are terminated and requeued (as if a resize pool operation - /// had been requested with the default requeue option); finally, the - /// pool is removed from the system. Because running tasks are - /// requeued, the user can rerun these tasks by updating their job to - /// target a different pool. The tasks can then run on the new pool. If - /// you want to override the requeue behavior, then you should call - /// resize pool explicitly to shrink the pool to zero size before - /// deleting the pool. If you call an Update, Patch or Delete API on a - /// pool in the deleting state, it will fail with HTTP status code 409 + /// When you request that a Pool be deleted, the following actions + /// occur: the Pool state is set to deleting; any ongoing resize + /// operation on the Pool are stopped; the Batch service starts + /// resizing the Pool to zero Compute Nodes; any Tasks running on + /// existing Compute Nodes are terminated and requeued (as if a resize + /// Pool operation had been requested with the default requeue option); + /// finally, the Pool is removed from the system. Because running Tasks + /// are requeued, the user can rerun these Tasks by updating their Job + /// to target a different Pool. The Tasks can then run on the new Pool. + /// If you want to override the requeue behavior, then you should call + /// resize Pool explicitly to shrink the Pool to zero size before + /// deleting the Pool. If you call an Update, Patch or Delete API on a + /// Pool in the deleting state, it will fail with HTTP status code 409 /// with error code PoolBeingDeleted. /// /// - /// The ID of the pool to delete. + /// The ID of the Pool to delete. /// /// /// Additional parameters for the operation @@ -173,10 +173,10 @@ public partial interface IPoolOperations /// Task> DeleteWithHttpMessagesAsync(string poolId, PoolDeleteOptions poolDeleteOptions = default(PoolDeleteOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Gets basic properties of a pool. + /// Gets basic properties of a Pool. /// /// - /// The ID of the pool to get. + /// The ID of the Pool to get. /// /// /// Additional parameters for the operation @@ -195,10 +195,10 @@ public partial interface IPoolOperations /// Task> ExistsWithHttpMessagesAsync(string poolId, PoolExistsOptions poolExistsOptions = default(PoolExistsOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Gets information about the specified pool. + /// Gets information about the specified Pool. /// /// - /// The ID of the pool to get. + /// The ID of the Pool to get. /// /// /// Additional parameters for the operation @@ -220,16 +220,16 @@ public partial interface IPoolOperations /// Task> GetWithHttpMessagesAsync(string poolId, PoolGetOptions poolGetOptions = default(PoolGetOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Updates the properties of the specified pool. + /// Updates the properties of the specified Pool. /// /// - /// This only replaces the pool properties specified in the request. - /// For example, if the pool has a start task associated with it, and a - /// request does not specify a start task element, then the pool keeps - /// the existing start task. + /// This only replaces the Pool properties specified in the request. + /// For example, if the Pool has a StartTask associated with it, and a + /// request does not specify a StartTask element, then the Pool keeps + /// the existing StartTask. /// /// - /// The ID of the pool to update. + /// The ID of the Pool to update. /// /// /// The parameters for the request. @@ -251,10 +251,10 @@ public partial interface IPoolOperations /// Task> PatchWithHttpMessagesAsync(string poolId, PoolPatchParameter poolPatchParameter, PoolPatchOptions poolPatchOptions = default(PoolPatchOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Disables automatic scaling for a pool. + /// Disables automatic scaling for a Pool. /// /// - /// The ID of the pool on which to disable automatic scaling. + /// The ID of the Pool on which to disable automatic scaling. /// /// /// Additional parameters for the operation @@ -273,19 +273,19 @@ public partial interface IPoolOperations /// Task> DisableAutoScaleWithHttpMessagesAsync(string poolId, PoolDisableAutoScaleOptions poolDisableAutoScaleOptions = default(PoolDisableAutoScaleOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Enables automatic scaling for a pool. + /// Enables automatic scaling for a Pool. /// /// - /// You cannot enable automatic scaling on a pool if a resize operation - /// is in progress on the pool. If automatic scaling of the pool is + /// You cannot enable automatic scaling on a Pool if a resize operation + /// is in progress on the Pool. If automatic scaling of the Pool is /// currently disabled, you must specify a valid autoscale formula as - /// part of the request. If automatic scaling of the pool is already + /// part of the request. If automatic scaling of the Pool is already /// enabled, you may specify a new autoscale formula and/or a new - /// evaluation interval. You cannot call this API for the same pool + /// evaluation interval. You cannot call this API for the same Pool /// more than once every 30 seconds. /// /// - /// The ID of the pool on which to enable automatic scaling. + /// The ID of the Pool on which to enable automatic scaling. /// /// /// The parameters for the request. @@ -308,25 +308,25 @@ public partial interface IPoolOperations Task> EnableAutoScaleWithHttpMessagesAsync(string poolId, PoolEnableAutoScaleParameter poolEnableAutoScaleParameter, PoolEnableAutoScaleOptions poolEnableAutoScaleOptions = default(PoolEnableAutoScaleOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// /// Gets the result of evaluating an automatic scaling formula on the - /// pool. + /// Pool. /// /// /// This API is primarily for validating an autoscale formula, as it - /// simply returns the result without applying the formula to the pool. - /// The pool must have auto scaling enabled in order to evaluate a + /// simply returns the result without applying the formula to the Pool. + /// The Pool must have auto scaling enabled in order to evaluate a /// formula. /// /// - /// The ID of the pool on which to evaluate the automatic scaling + /// The ID of the Pool on which to evaluate the automatic scaling /// formula. /// /// - /// The formula for the desired number of compute nodes in the pool. + /// The formula for the desired number of Compute Nodes in the Pool. /// The formula is validated and its results calculated, but it is not - /// applied to the pool. To apply the formula to the pool, 'Enable - /// automatic scaling on a pool'. For more information about specifying - /// this formula, see Automatically scale compute nodes in an Azure - /// Batch pool + /// applied to the Pool. To apply the formula to the Pool, 'Enable + /// automatic scaling on a Pool'. For more information about specifying + /// this formula, see Automatically scale Compute Nodes in an Azure + /// Batch Pool /// (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling). /// /// @@ -349,20 +349,21 @@ public partial interface IPoolOperations /// Task> EvaluateAutoScaleWithHttpMessagesAsync(string poolId, string autoScaleFormula, PoolEvaluateAutoScaleOptions poolEvaluateAutoScaleOptions = default(PoolEvaluateAutoScaleOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Changes the number of compute nodes that are assigned to a pool. + /// Changes the number of Compute Nodes that are assigned to a Pool. /// /// - /// You can only resize a pool when its allocation state is steady. If - /// the pool is already resizing, the request fails with status code - /// 409. When you resize a pool, the pool's allocation state changes - /// from steady to resizing. You cannot resize pools which are + /// You can only resize a Pool when its allocation state is steady. If + /// the Pool is already resizing, the request fails with status code + /// 409. When you resize a Pool, the Pool's allocation state changes + /// from steady to resizing. You cannot resize Pools which are /// configured for automatic scaling. If you try to do this, the Batch - /// service returns an error 409. If you resize a pool downwards, the - /// Batch service chooses which nodes to remove. To remove specific - /// nodes, use the pool remove nodes API instead. + /// service returns an error 409. If you resize a Pool downwards, the + /// Batch service chooses which Compute Nodes to remove. To remove + /// specific Compute Nodes, use the Pool remove Compute Nodes API + /// instead. /// /// - /// The ID of the pool to resize. + /// The ID of the Pool to resize. /// /// /// The parameters for the request. @@ -384,20 +385,21 @@ public partial interface IPoolOperations /// Task> ResizeWithHttpMessagesAsync(string poolId, PoolResizeParameter poolResizeParameter, PoolResizeOptions poolResizeOptions = default(PoolResizeOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Stops an ongoing resize operation on the pool. + /// Stops an ongoing resize operation on the Pool. /// /// - /// This does not restore the pool to its previous state before the + /// This does not restore the Pool to its previous state before the /// resize operation: it only stops any further changes being made, and - /// the pool maintains its current state. After stopping, the pool - /// stabilizes at the number of nodes it was at when the stop operation - /// was done. During the stop operation, the pool allocation state - /// changes first to stopping and then to steady. A resize operation - /// need not be an explicit resize pool request; this API can also be - /// used to halt the initial sizing of the pool when it is created. + /// the Pool maintains its current state. After stopping, the Pool + /// stabilizes at the number of Compute Nodes it was at when the stop + /// operation was done. During the stop operation, the Pool allocation + /// state changes first to stopping and then to steady. A resize + /// operation need not be an explicit resize Pool request; this API can + /// also be used to halt the initial sizing of the Pool when it is + /// created. /// /// - /// The ID of the pool whose resizing you want to stop. + /// The ID of the Pool whose resizing you want to stop. /// /// /// Additional parameters for the operation @@ -416,16 +418,16 @@ public partial interface IPoolOperations /// Task> StopResizeWithHttpMessagesAsync(string poolId, PoolStopResizeOptions poolStopResizeOptions = default(PoolStopResizeOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Updates the properties of the specified pool. + /// Updates the properties of the specified Pool. /// /// - /// This fully replaces all the updatable properties of the pool. For - /// example, if the pool has a start task associated with it and if - /// start task is not specified with this request, then the Batch - /// service will remove the existing start task. + /// This fully replaces all the updatable properties of the Pool. For + /// example, if the Pool has a StartTask associated with it and if + /// StartTask is not specified with this request, then the Batch + /// service will remove the existing StartTask. /// /// - /// The ID of the pool to update. + /// The ID of the Pool to update. /// /// /// The parameters for the request. @@ -447,15 +449,15 @@ public partial interface IPoolOperations /// Task> UpdatePropertiesWithHttpMessagesAsync(string poolId, PoolUpdatePropertiesParameter poolUpdatePropertiesParameter, PoolUpdatePropertiesOptions poolUpdatePropertiesOptions = default(PoolUpdatePropertiesOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Removes compute nodes from the specified pool. + /// Removes Compute Nodes from the specified Pool. /// /// - /// This operation can only run when the allocation state of the pool + /// This operation can only run when the allocation state of the Pool /// is steady. When this operation runs, the allocation state changes /// from steady to resizing. /// /// - /// The ID of the pool from which you want to remove nodes. + /// The ID of the Pool from which you want to remove Compute Nodes. /// /// /// The parameters for the request. @@ -477,12 +479,12 @@ public partial interface IPoolOperations /// Task> RemoveNodesWithHttpMessagesAsync(string poolId, NodeRemoveParameter nodeRemoveParameter, PoolRemoveNodesOptions poolRemoveNodesOptions = default(PoolRemoveNodesOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Lists the usage metrics, aggregated by pool across individual time - /// intervals, for the specified account. + /// Lists the usage metrics, aggregated by Pool across individual time + /// intervals, for the specified Account. /// /// /// If you do not specify a $filter clause including a poolId, the - /// response includes all pools that existed in the account in the time + /// response includes all Pools that existed in the Account in the time /// range of the returned aggregation intervals. If you do not specify /// a $filter clause including a startTime or endTime these filters /// default to the start and end times of the last aggregation interval @@ -512,7 +514,7 @@ public partial interface IPoolOperations /// Task,PoolListUsageMetricsHeaders>> ListUsageMetricsNextWithHttpMessagesAsync(string nextPageLink, PoolListUsageMetricsNextOptions poolListUsageMetricsNextOptions = default(PoolListUsageMetricsNextOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Lists all of the pools in the specified account. + /// Lists all of the Pools in the specified Account. /// /// /// The NextLink from the previous successful call to List operation. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ITaskOperations.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ITaskOperations.cs index dc1f86870440..92f07fbfc648 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ITaskOperations.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/ITaskOperations.cs @@ -24,19 +24,19 @@ namespace Microsoft.Azure.Batch.Protocol public partial interface ITaskOperations { /// - /// Adds a task to the specified job. + /// Adds a Task to the specified Job. /// /// - /// The maximum lifetime of a task from addition to completion is 180 - /// days. If a task has not completed within 180 days of being added it + /// The maximum lifetime of a Task from addition to completion is 180 + /// days. If a Task has not completed within 180 days of being added it /// will be terminated by the Batch service and left in whatever state /// it was in at that time. /// /// - /// The ID of the job to which the task is to be added. + /// The ID of the Job to which the Task is to be added. /// /// - /// The task to be added. + /// The Task to be added. /// /// /// Additional parameters for the operation @@ -55,15 +55,15 @@ public partial interface ITaskOperations /// Task> AddWithHttpMessagesAsync(string jobId, TaskAddParameter task, TaskAddOptions taskAddOptions = default(TaskAddOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Lists all of the tasks that are associated with the specified job. + /// Lists all of the Tasks that are associated with the specified Job. /// /// - /// For multi-instance tasks, information such as affinityId, - /// executionInfo and nodeInfo refer to the primary task. Use the list + /// For multi-instance Tasks, information such as affinityId, + /// executionInfo and nodeInfo refer to the primary Task. Use the list /// subtasks API to retrieve information about subtasks. /// /// - /// The ID of the job. + /// The ID of the Job. /// /// /// Additional parameters for the operation @@ -85,37 +85,37 @@ public partial interface ITaskOperations /// Task,TaskListHeaders>> ListWithHttpMessagesAsync(string jobId, TaskListOptions taskListOptions = default(TaskListOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Adds a collection of tasks to the specified job. + /// Adds a collection of Tasks to the specified Job. /// /// - /// Note that each task must have a unique ID. The Batch service may - /// not return the results for each task in the same order the tasks + /// Note that each Task must have a unique ID. The Batch service may + /// not return the results for each Task in the same order the Tasks /// were submitted in this request. If the server times out or the /// connection is closed during the request, the request may have been /// partially or fully processed, or not at all. In such cases, the /// user should re-issue the request. Note that it is up to the user to /// correctly handle failures when re-issuing a request. For example, - /// you should use the same task IDs during a retry so that if the - /// prior operation succeeded, the retry will not create extra tasks - /// unexpectedly. If the response contains any tasks which failed to + /// you should use the same Task IDs during a retry so that if the + /// prior operation succeeded, the retry will not create extra Tasks + /// unexpectedly. If the response contains any Tasks which failed to /// add, a client can retry the request. In a retry, it is most - /// efficient to resubmit only tasks that failed to add, and to omit - /// tasks that were successfully added on the first attempt. The - /// maximum lifetime of a task from addition to completion is 180 days. - /// If a task has not completed within 180 days of being added it will + /// efficient to resubmit only Tasks that failed to add, and to omit + /// Tasks that were successfully added on the first attempt. The + /// maximum lifetime of a Task from addition to completion is 180 days. + /// If a Task has not completed within 180 days of being added it will /// be terminated by the Batch service and left in whatever state it /// was in at that time. /// /// - /// The ID of the job to which the task collection is to be added. + /// The ID of the Job to which the Task collection is to be added. /// /// - /// The collection of tasks to add. The maximum count of tasks is 100. + /// The collection of Tasks to add. The maximum count of Tasks is 100. /// The total serialized size of this collection must be less than 1MB. - /// If it is greater than 1MB (for example if each task has 100's of + /// If it is greater than 1MB (for example if each Task has 100's of /// resource files or environment variables), the request will fail /// with code 'RequestBodyTooLarge' and should be retried again with - /// fewer tasks. + /// fewer Tasks. /// /// /// Additional parameters for the operation @@ -137,20 +137,20 @@ public partial interface ITaskOperations /// Task> AddCollectionWithHttpMessagesAsync(string jobId, IList value, TaskAddCollectionOptions taskAddCollectionOptions = default(TaskAddCollectionOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Deletes a task from the specified job. + /// Deletes a Task from the specified Job. /// /// - /// When a task is deleted, all of the files in its directory on the - /// compute node where it ran are also deleted (regardless of the - /// retention time). For multi-instance tasks, the delete task + /// When a Task is deleted, all of the files in its directory on the + /// Compute Node where it ran are also deleted (regardless of the + /// retention time). For multi-instance Tasks, the delete Task /// operation applies synchronously to the primary task; subtasks and /// their files are then deleted asynchronously in the background. /// /// - /// The ID of the job from which to delete the task. + /// The ID of the Job from which to delete the Task. /// /// - /// The ID of the task to delete. + /// The ID of the Task to delete. /// /// /// Additional parameters for the operation @@ -169,18 +169,18 @@ public partial interface ITaskOperations /// Task> DeleteWithHttpMessagesAsync(string jobId, string taskId, TaskDeleteOptions taskDeleteOptions = default(TaskDeleteOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Gets information about the specified task. + /// Gets information about the specified Task. /// /// - /// For multi-instance tasks, information such as affinityId, - /// executionInfo and nodeInfo refer to the primary task. Use the list + /// For multi-instance Tasks, information such as affinityId, + /// executionInfo and nodeInfo refer to the primary Task. Use the list /// subtasks API to retrieve information about subtasks. /// /// - /// The ID of the job that contains the task. + /// The ID of the Job that contains the Task. /// /// - /// The ID of the task to get information about. + /// The ID of the Task to get information about. /// /// /// Additional parameters for the operation @@ -202,18 +202,18 @@ public partial interface ITaskOperations /// Task> GetWithHttpMessagesAsync(string jobId, string taskId, TaskGetOptions taskGetOptions = default(TaskGetOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Updates the properties of the specified task. + /// Updates the properties of the specified Task. /// /// - /// The ID of the job containing the task. + /// The ID of the Job containing the Task. /// /// - /// The ID of the task to update. + /// The ID of the Task to update. /// /// - /// Constraints that apply to this task. If omitted, the task is given - /// the default constraints. For multi-instance tasks, updating the - /// retention time applies only to the primary task and not subtasks. + /// Constraints that apply to this Task. If omitted, the Task is given + /// the default constraints. For multi-instance Tasks, updating the + /// retention time applies only to the primary Task and not subtasks. /// /// /// Additional parameters for the operation @@ -233,17 +233,17 @@ public partial interface ITaskOperations Task> UpdateWithHttpMessagesAsync(string jobId, string taskId, TaskConstraints constraints = default(TaskConstraints), TaskUpdateOptions taskUpdateOptions = default(TaskUpdateOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// /// Lists all of the subtasks that are associated with the specified - /// multi-instance task. + /// multi-instance Task. /// /// - /// If the task is not a multi-instance task then this returns an empty + /// If the Task is not a multi-instance Task then this returns an empty /// collection. /// /// - /// The ID of the job. + /// The ID of the Job. /// /// - /// The ID of the task. + /// The ID of the Task. /// /// /// Additional parameters for the operation @@ -265,19 +265,19 @@ public partial interface ITaskOperations /// Task> ListSubtasksWithHttpMessagesAsync(string jobId, string taskId, TaskListSubtasksOptions taskListSubtasksOptions = default(TaskListSubtasksOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Terminates the specified task. + /// Terminates the specified Task. /// /// - /// When the task has been terminated, it moves to the completed state. - /// For multi-instance tasks, the terminate task operation applies + /// When the Task has been terminated, it moves to the completed state. + /// For multi-instance Tasks, the terminate Task operation applies /// synchronously to the primary task; subtasks are then terminated /// asynchronously in the background. /// /// - /// The ID of the job containing the task. + /// The ID of the Job containing the Task. /// /// - /// The ID of the task to terminate. + /// The ID of the Task to terminate. /// /// /// Additional parameters for the operation @@ -296,25 +296,25 @@ public partial interface ITaskOperations /// Task> TerminateWithHttpMessagesAsync(string jobId, string taskId, TaskTerminateOptions taskTerminateOptions = default(TaskTerminateOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Reactivates a task, allowing it to run again even if its retry + /// Reactivates a Task, allowing it to run again even if its retry /// count has been exhausted. /// /// - /// Reactivation makes a task eligible to be retried again up to its - /// maximum retry count. The task's state is changed to active. As the - /// task is no longer in the completed state, any previous exit code or + /// Reactivation makes a Task eligible to be retried again up to its + /// maximum retry count. The Task's state is changed to active. As the + /// Task is no longer in the completed state, any previous exit code or /// failure information is no longer available after reactivation. Each - /// time a task is reactivated, its retry count is reset to 0. - /// Reactivation will fail for tasks that are not completed or that + /// time a Task is reactivated, its retry count is reset to 0. + /// Reactivation will fail for Tasks that are not completed or that /// previously completed successfully (with an exit code of 0). - /// Additionally, it will fail if the job has completed (or is + /// Additionally, it will fail if the Job has completed (or is /// terminating or deleting). /// /// - /// The ID of the job containing the task. + /// The ID of the Job containing the Task. /// /// - /// The ID of the task to reactivate. + /// The ID of the Task to reactivate. /// /// /// Additional parameters for the operation @@ -333,11 +333,11 @@ public partial interface ITaskOperations /// Task> ReactivateWithHttpMessagesAsync(string jobId, string taskId, TaskReactivateOptions taskReactivateOptions = default(TaskReactivateOptions), Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); /// - /// Lists all of the tasks that are associated with the specified job. + /// Lists all of the Tasks that are associated with the specified Job. /// /// - /// For multi-instance tasks, information such as affinityId, - /// executionInfo and nodeInfo refer to the primary task. Use the list + /// For multi-instance Tasks, information such as affinityId, + /// executionInfo and nodeInfo refer to the primary Task. Use the list /// subtasks API to retrieve information about subtasks. /// /// diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/JobOperations.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/JobOperations.cs index bed743285dea..3d34b6d4769e 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/JobOperations.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/JobOperations.cs @@ -52,12 +52,12 @@ internal JobOperations(BatchServiceClient client) public BatchServiceClient Client { get; private set; } /// - /// Gets lifetime summary statistics for all of the jobs in the specified - /// account. + /// Gets lifetime summary statistics for all of the Jobs in the specified + /// 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. /// @@ -300,20 +300,20 @@ internal JobOperations(BatchServiceClient client) } /// - /// Deletes a job. + /// Deletes a Job. /// /// - /// Deleting a job also deletes all tasks that are part of that job, and all - /// job statistics. This also overrides the retention period for task data; - /// that is, if the job contains tasks which are still retained on compute - /// nodes, the Batch services deletes those tasks' working directories and all + /// Deleting a Job also deletes all Tasks that are part of that Job, and all + /// Job statistics. This also overrides the retention period for Task data; + /// that is, if the Job contains Tasks which are still retained on Compute + /// Nodes, the Batch services deletes those Tasks' working directories and all /// their contents. When a Delete Job request is received, the Batch service - /// sets the job to the deleting state. All update operations on a job that is + /// sets the Job to the deleting state. All update operations on a Job that is /// in deleting state will fail with status code 409 (Conflict), with - /// additional information indicating that the job is being deleted. + /// additional information indicating that the Job is being deleted. /// /// - /// The ID of the job to delete. + /// The ID of the Job to delete. /// /// /// Additional parameters for the operation @@ -595,10 +595,10 @@ internal JobOperations(BatchServiceClient client) } /// - /// Gets information about the specified job. + /// Gets information about the specified Job. /// /// - /// The ID of the job. + /// The ID of the Job. /// /// /// Additional parameters for the operation @@ -921,15 +921,15 @@ internal JobOperations(BatchServiceClient client) } /// - /// Updates the properties of the specified job. + /// Updates the properties of the specified Job. /// /// - /// This replaces only the job properties specified in the request. For - /// example, if the job has constraints, and a request does not specify the - /// constraints element, then the job keeps the existing constraints. + /// This replaces only the Job properties specified in the request. For + /// example, if the Job has constraints, and a request does not specify the + /// constraints element, then the Job keeps the existing constraints. /// /// - /// The ID of the job whose properties you want to update. + /// The ID of the Job whose properties you want to update. /// /// /// The parameters for the request. @@ -1225,16 +1225,16 @@ internal JobOperations(BatchServiceClient client) } /// - /// Updates the properties of the specified job. + /// Updates the properties of the specified Job. /// /// - /// This fully replaces all the updatable properties of the job. For example, - /// if the job has constraints associated with it and if constraints is not + /// This fully replaces all the updatable properties of the Job. For example, + /// if the Job has constraints associated with it and if constraints is not /// specified with this request, then the Batch service will remove the /// existing constraints. /// /// - /// The ID of the job whose properties you want to update. + /// The ID of the Job whose properties you want to update. /// /// /// The parameters for the request. @@ -1530,23 +1530,23 @@ internal JobOperations(BatchServiceClient client) } /// - /// Disables the specified job, preventing new tasks from running. + /// Disables the specified Job, preventing new Tasks from running. /// /// - /// The Batch Service immediately moves the job to the disabling state. Batch + /// The Batch Service immediately moves the Job to the disabling state. Batch /// then uses the disableTasks parameter to determine what to do with the - /// currently running tasks of the job. The job remains in the disabling state - /// until the disable operation is completed and all tasks have been dealt with - /// according to the disableTasks option; the job then moves to the disabled - /// state. No new tasks are started under the job until it moves back to active - /// state. If you try to disable a job that is in any state other than active, + /// currently running Tasks of the Job. The Job remains in the disabling state + /// until the disable operation is completed and all Tasks have been dealt with + /// according to the disableTasks option; the Job then moves to the disabled + /// state. No new Tasks are started under the Job until it moves back to active + /// state. If you try to disable a Job that is in any state other than active, /// disabling, or disabled, the request fails with status code 409. /// /// - /// The ID of the job to disable. + /// The ID of the Job to disable. /// /// - /// What to do with active tasks associated with the job. Possible values + /// What to do with active Tasks associated with the Job. Possible values /// include: 'requeue', 'terminate', 'wait' /// /// @@ -1838,18 +1838,18 @@ internal JobOperations(BatchServiceClient client) } /// - /// Enables the specified job, allowing new tasks to run. + /// Enables the specified Job, allowing new Tasks to run. /// /// - /// When you call this API, the Batch service sets a disabled job to the - /// enabling state. After the this operation is completed, the job moves to the - /// active state, and scheduling of new tasks under the job resumes. The Batch - /// service does not allow a task to remain in the active state for more than - /// 180 days. Therefore, if you enable a job containing active tasks which were - /// added more than 180 days ago, those tasks will not run. + /// When you call this API, the Batch service sets a disabled Job to the + /// enabling state. After the this operation is completed, the Job moves to the + /// active state, and scheduling of new Tasks under the Job resumes. The Batch + /// service does not allow a Task to remain in the active state for more than + /// 180 days. Therefore, if you enable a Job containing active Tasks which were + /// added more than 180 days ago, those Tasks will not run. /// /// - /// The ID of the job to enable. + /// The ID of the Job to enable. /// /// /// Additional parameters for the operation @@ -2131,22 +2131,22 @@ internal JobOperations(BatchServiceClient client) } /// - /// Terminates the specified job, marking it as completed. + /// Terminates the specified Job, marking it as completed. /// /// - /// When a Terminate Job request is received, the Batch service sets the job to - /// 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 + /// When a Terminate Job request is received, the Batch service sets the Job to + /// 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. + /// The ID of the Job to terminate. /// /// - /// The text you want to appear as the job's TerminateReason. The default is + /// The text you want to appear as the Job's TerminateReason. The default is /// 'UserTerminate'. /// /// @@ -2442,21 +2442,21 @@ internal JobOperations(BatchServiceClient client) } /// - /// Adds a job to the specified account. + /// Adds a Job to the specified Account. /// /// /// The Batch service supports two ways to control the work done as part of a - /// job. In the first approach, the user specifies a Job Manager task. The - /// Batch service launches this task when it is ready to start the job. The Job - /// Manager task controls all other tasks that run under this job, by using the + /// Job. In the first approach, the user specifies a Job Manager Task. The + /// Batch service launches this Task when it is ready to start the Job. The Job + /// Manager Task controls all other Tasks that run under this Job, by using the /// Task APIs. In the second approach, the user directly controls the execution - /// of tasks under an active job, by using the Task APIs. Also note: when - /// naming jobs, avoid including sensitive information such as user names or + /// of Tasks under an active Job, by using the Task APIs. Also note: when + /// naming Jobs, avoid including sensitive information such as user names or /// secret project names. This information may appear in telemetry logs /// accessible to Microsoft Support engineers. /// /// - /// The job to be added. + /// The Job to be added. /// /// /// Additional parameters for the operation @@ -2687,7 +2687,7 @@ internal JobOperations(BatchServiceClient client) } /// - /// Lists all of the jobs in the specified account. + /// Lists all of the Jobs in the specified Account. /// /// /// Additional parameters for the operation @@ -2968,10 +2968,10 @@ internal JobOperations(BatchServiceClient client) } /// - /// Lists the jobs that have been created under the specified job schedule. + /// Lists the Jobs that have been created under the specified Job Schedule. /// /// - /// The ID of the job schedule from which you want to get a list of jobs. + /// The ID of the Job Schedule from which you want to get a list of Jobs. /// /// /// Additional parameters for the operation @@ -3258,19 +3258,19 @@ internal JobOperations(BatchServiceClient client) } /// - /// Lists the execution status of the Job Preparation and Job Release task for - /// the specified job across the compute nodes where the job has run. + /// Lists the execution status of the Job Preparation and Job Release Task for + /// the specified Job across the Compute Nodes where the Job has run. /// /// - /// This API returns the Job Preparation and Job Release task status on all - /// compute nodes that have run the Job Preparation or Job Release task. This - /// includes nodes which have since been removed from the pool. If this API is - /// invoked on a job which has no Job Preparation or Job Release task, the - /// Batch service returns HTTP status code 409 (Conflict) with an error code of - /// JobPreparationTaskNotSpecified. + /// This API returns the Job Preparation and Job Release Task status on all + /// Compute Nodes that have run the Job Preparation or Job Release Task. This + /// includes Compute Nodes which have since been removed from the Pool. If this + /// API is invoked on a Job which has no Job Preparation or Job Release Task, + /// the Batch service returns HTTP status code 409 (Conflict) with an error + /// code of JobPreparationTaskNotSpecified. /// /// - /// The ID of the job. + /// The ID of the Job. /// /// /// Additional parameters for the operation @@ -3547,15 +3547,15 @@ internal JobOperations(BatchServiceClient client) } /// - /// Gets the task counts for the specified job. + /// Gets the Task counts for the specified Job. /// /// - /// Task counts provide a count of the tasks by active, running or completed - /// task state, and a count of tasks which succeeded or failed. Tasks in the + /// Task counts provide a count of the Tasks by active, running or completed + /// Task state, and a count of Tasks which succeeded or failed. Tasks in the /// preparing state are counted as running. /// /// - /// The ID of the job. + /// The ID of the Job. /// /// /// Additional parameters for the operation @@ -3802,7 +3802,7 @@ internal JobOperations(BatchServiceClient client) } /// - /// Lists all of the jobs in the specified account. + /// Lists all of the Jobs in the specified Account. /// /// /// The NextLink from the previous successful call to List operation. @@ -4028,7 +4028,7 @@ internal JobOperations(BatchServiceClient client) } /// - /// Lists the jobs that have been created under the specified job schedule. + /// Lists the Jobs that have been created under the specified Job Schedule. /// /// /// The NextLink from the previous successful call to List operation. @@ -4254,16 +4254,16 @@ internal JobOperations(BatchServiceClient client) } /// - /// Lists the execution status of the Job Preparation and Job Release task for - /// the specified job across the compute nodes where the job has run. + /// Lists the execution status of the Job Preparation and Job Release Task for + /// the specified Job across the Compute Nodes where the Job has run. /// /// - /// This API returns the Job Preparation and Job Release task status on all - /// compute nodes that have run the Job Preparation or Job Release task. This - /// includes nodes which have since been removed from the pool. If this API is - /// invoked on a job which has no Job Preparation or Job Release task, the - /// Batch service returns HTTP status code 409 (Conflict) with an error code of - /// JobPreparationTaskNotSpecified. + /// This API returns the Job Preparation and Job Release Task status on all + /// Compute Nodes that have run the Job Preparation or Job Release Task. This + /// includes Compute Nodes which have since been removed from the Pool. If this + /// API is invoked on a Job which has no Job Preparation or Job Release Task, + /// the Batch service returns HTTP status code 409 (Conflict) with an error + /// code of JobPreparationTaskNotSpecified. /// /// /// The NextLink from the previous successful call to List operation. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/JobOperationsExtensions.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/JobOperationsExtensions.cs index c0ac8f13e40f..b83a2dde0111 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/JobOperationsExtensions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/JobOperationsExtensions.cs @@ -22,12 +22,12 @@ namespace Microsoft.Azure.Batch.Protocol public static partial class JobOperationsExtensions { /// - /// Gets lifetime summary statistics for all of the jobs in the specified - /// account. + /// Gets lifetime summary statistics for all of the Jobs in the specified + /// 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. /// @@ -43,12 +43,12 @@ public static partial class JobOperationsExtensions } /// - /// Gets lifetime summary statistics for all of the jobs in the specified - /// account. + /// Gets lifetime summary statistics for all of the Jobs in the specified + /// 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. /// @@ -70,23 +70,23 @@ public static partial class JobOperationsExtensions } /// - /// Deletes a job. + /// Deletes a Job. /// /// - /// Deleting a job also deletes all tasks that are part of that job, and all - /// job statistics. This also overrides the retention period for task data; - /// that is, if the job contains tasks which are still retained on compute - /// nodes, the Batch services deletes those tasks' working directories and all + /// Deleting a Job also deletes all Tasks that are part of that Job, and all + /// Job statistics. This also overrides the retention period for Task data; + /// that is, if the Job contains Tasks which are still retained on Compute + /// Nodes, the Batch services deletes those Tasks' working directories and all /// their contents. When a Delete Job request is received, the Batch service - /// sets the job to the deleting state. All update operations on a job that is + /// sets the Job to the deleting state. All update operations on a Job that is /// in deleting state will fail with status code 409 (Conflict), with - /// additional information indicating that the job is being deleted. + /// additional information indicating that the Job is being deleted. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job to delete. + /// The ID of the Job to delete. /// /// /// Additional parameters for the operation @@ -97,23 +97,23 @@ public static partial class JobOperationsExtensions } /// - /// Deletes a job. + /// Deletes a Job. /// /// - /// Deleting a job also deletes all tasks that are part of that job, and all - /// job statistics. This also overrides the retention period for task data; - /// that is, if the job contains tasks which are still retained on compute - /// nodes, the Batch services deletes those tasks' working directories and all + /// Deleting a Job also deletes all Tasks that are part of that Job, and all + /// Job statistics. This also overrides the retention period for Task data; + /// that is, if the Job contains Tasks which are still retained on Compute + /// Nodes, the Batch services deletes those Tasks' working directories and all /// their contents. When a Delete Job request is received, the Batch service - /// sets the job to the deleting state. All update operations on a job that is + /// sets the Job to the deleting state. All update operations on a Job that is /// in deleting state will fail with status code 409 (Conflict), with - /// additional information indicating that the job is being deleted. + /// additional information indicating that the Job is being deleted. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job to delete. + /// The ID of the Job to delete. /// /// /// Additional parameters for the operation @@ -130,13 +130,13 @@ public static partial class JobOperationsExtensions } /// - /// Gets information about the specified job. + /// Gets information about the specified Job. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job. + /// The ID of the Job. /// /// /// Additional parameters for the operation @@ -147,13 +147,13 @@ public static partial class JobOperationsExtensions } /// - /// Gets information about the specified job. + /// Gets information about the specified Job. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job. + /// The ID of the Job. /// /// /// Additional parameters for the operation @@ -170,18 +170,18 @@ public static partial class JobOperationsExtensions } /// - /// Updates the properties of the specified job. + /// Updates the properties of the specified Job. /// /// - /// This replaces only the job properties specified in the request. For - /// example, if the job has constraints, and a request does not specify the - /// constraints element, then the job keeps the existing constraints. + /// This replaces only the Job properties specified in the request. For + /// example, if the Job has constraints, and a request does not specify the + /// constraints element, then the Job keeps the existing constraints. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job whose properties you want to update. + /// The ID of the Job whose properties you want to update. /// /// /// The parameters for the request. @@ -195,18 +195,18 @@ public static partial class JobOperationsExtensions } /// - /// Updates the properties of the specified job. + /// Updates the properties of the specified Job. /// /// - /// This replaces only the job properties specified in the request. For - /// example, if the job has constraints, and a request does not specify the - /// constraints element, then the job keeps the existing constraints. + /// This replaces only the Job properties specified in the request. For + /// example, if the Job has constraints, and a request does not specify the + /// constraints element, then the Job keeps the existing constraints. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job whose properties you want to update. + /// The ID of the Job whose properties you want to update. /// /// /// The parameters for the request. @@ -226,11 +226,11 @@ public static partial class JobOperationsExtensions } /// - /// Updates the properties of the specified job. + /// Updates the properties of the specified Job. /// /// - /// This fully replaces all the updatable properties of the job. For example, - /// if the job has constraints associated with it and if constraints is not + /// This fully replaces all the updatable properties of the Job. For example, + /// if the Job has constraints associated with it and if constraints is not /// specified with this request, then the Batch service will remove the /// existing constraints. /// @@ -238,7 +238,7 @@ public static partial class JobOperationsExtensions /// The operations group for this extension method. /// /// - /// The ID of the job whose properties you want to update. + /// The ID of the Job whose properties you want to update. /// /// /// The parameters for the request. @@ -252,11 +252,11 @@ public static partial class JobOperationsExtensions } /// - /// Updates the properties of the specified job. + /// Updates the properties of the specified Job. /// /// - /// This fully replaces all the updatable properties of the job. For example, - /// if the job has constraints associated with it and if constraints is not + /// This fully replaces all the updatable properties of the Job. For example, + /// if the Job has constraints associated with it and if constraints is not /// specified with this request, then the Batch service will remove the /// existing constraints. /// @@ -264,7 +264,7 @@ public static partial class JobOperationsExtensions /// The operations group for this extension method. /// /// - /// The ID of the job whose properties you want to update. + /// The ID of the Job whose properties you want to update. /// /// /// The parameters for the request. @@ -284,26 +284,26 @@ public static partial class JobOperationsExtensions } /// - /// Disables the specified job, preventing new tasks from running. + /// Disables the specified Job, preventing new Tasks from running. /// /// - /// The Batch Service immediately moves the job to the disabling state. Batch + /// The Batch Service immediately moves the Job to the disabling state. Batch /// then uses the disableTasks parameter to determine what to do with the - /// currently running tasks of the job. The job remains in the disabling state - /// until the disable operation is completed and all tasks have been dealt with - /// according to the disableTasks option; the job then moves to the disabled - /// state. No new tasks are started under the job until it moves back to active - /// state. If you try to disable a job that is in any state other than active, + /// currently running Tasks of the Job. The Job remains in the disabling state + /// until the disable operation is completed and all Tasks have been dealt with + /// according to the disableTasks option; the Job then moves to the disabled + /// state. No new Tasks are started under the Job until it moves back to active + /// state. If you try to disable a Job that is in any state other than active, /// disabling, or disabled, the request fails with status code 409. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job to disable. + /// The ID of the Job to disable. /// /// - /// What to do with active tasks associated with the job. Possible values + /// What to do with active Tasks associated with the Job. Possible values /// include: 'requeue', 'terminate', 'wait' /// /// @@ -315,26 +315,26 @@ public static partial class JobOperationsExtensions } /// - /// Disables the specified job, preventing new tasks from running. + /// Disables the specified Job, preventing new Tasks from running. /// /// - /// The Batch Service immediately moves the job to the disabling state. Batch + /// The Batch Service immediately moves the Job to the disabling state. Batch /// then uses the disableTasks parameter to determine what to do with the - /// currently running tasks of the job. The job remains in the disabling state - /// until the disable operation is completed and all tasks have been dealt with - /// according to the disableTasks option; the job then moves to the disabled - /// state. No new tasks are started under the job until it moves back to active - /// state. If you try to disable a job that is in any state other than active, + /// currently running Tasks of the Job. The Job remains in the disabling state + /// until the disable operation is completed and all Tasks have been dealt with + /// according to the disableTasks option; the Job then moves to the disabled + /// state. No new Tasks are started under the Job until it moves back to active + /// state. If you try to disable a Job that is in any state other than active, /// disabling, or disabled, the request fails with status code 409. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job to disable. + /// The ID of the Job to disable. /// /// - /// What to do with active tasks associated with the job. Possible values + /// What to do with active Tasks associated with the Job. Possible values /// include: 'requeue', 'terminate', 'wait' /// /// @@ -352,21 +352,21 @@ public static partial class JobOperationsExtensions } /// - /// Enables the specified job, allowing new tasks to run. + /// Enables the specified Job, allowing new Tasks to run. /// /// - /// When you call this API, the Batch service sets a disabled job to the - /// enabling state. After the this operation is completed, the job moves to the - /// active state, and scheduling of new tasks under the job resumes. The Batch - /// service does not allow a task to remain in the active state for more than - /// 180 days. Therefore, if you enable a job containing active tasks which were - /// added more than 180 days ago, those tasks will not run. + /// When you call this API, the Batch service sets a disabled Job to the + /// enabling state. After the this operation is completed, the Job moves to the + /// active state, and scheduling of new Tasks under the Job resumes. The Batch + /// service does not allow a Task to remain in the active state for more than + /// 180 days. Therefore, if you enable a Job containing active Tasks which were + /// added more than 180 days ago, those Tasks will not run. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job to enable. + /// The ID of the Job to enable. /// /// /// Additional parameters for the operation @@ -377,21 +377,21 @@ public static partial class JobOperationsExtensions } /// - /// Enables the specified job, allowing new tasks to run. + /// Enables the specified Job, allowing new Tasks to run. /// /// - /// When you call this API, the Batch service sets a disabled job to the - /// enabling state. After the this operation is completed, the job moves to the - /// active state, and scheduling of new tasks under the job resumes. The Batch - /// service does not allow a task to remain in the active state for more than - /// 180 days. Therefore, if you enable a job containing active tasks which were - /// added more than 180 days ago, those tasks will not run. + /// When you call this API, the Batch service sets a disabled Job to the + /// enabling state. After the this operation is completed, the Job moves to the + /// active state, and scheduling of new Tasks under the Job resumes. The Batch + /// service does not allow a Task to remain in the active state for more than + /// 180 days. Therefore, if you enable a Job containing active Tasks which were + /// added more than 180 days ago, those Tasks will not run. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job to enable. + /// The ID of the Job to enable. /// /// /// Additional parameters for the operation @@ -408,25 +408,25 @@ public static partial class JobOperationsExtensions } /// - /// Terminates the specified job, marking it as completed. + /// Terminates the specified Job, marking it as completed. /// /// - /// When a Terminate Job request is received, the Batch service sets the job to - /// 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 + /// When a Terminate Job request is received, the Batch service sets the Job to + /// 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. /// /// - /// The ID of the job to terminate. + /// The ID of the Job to terminate. /// /// - /// The text you want to appear as the job's TerminateReason. The default is + /// The text you want to appear as the Job's TerminateReason. The default is /// 'UserTerminate'. /// /// @@ -438,25 +438,25 @@ public static partial class JobOperationsExtensions } /// - /// Terminates the specified job, marking it as completed. + /// Terminates the specified Job, marking it as completed. /// /// - /// When a Terminate Job request is received, the Batch service sets the job to - /// 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 + /// When a Terminate Job request is received, the Batch service sets the Job to + /// 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. /// /// - /// The ID of the job to terminate. + /// The ID of the Job to terminate. /// /// - /// The text you want to appear as the job's TerminateReason. The default is + /// The text you want to appear as the Job's TerminateReason. The default is /// 'UserTerminate'. /// /// @@ -474,16 +474,16 @@ public static partial class JobOperationsExtensions } /// - /// Adds a job to the specified account. + /// Adds a Job to the specified Account. /// /// /// The Batch service supports two ways to control the work done as part of a - /// job. In the first approach, the user specifies a Job Manager task. The - /// Batch service launches this task when it is ready to start the job. The Job - /// Manager task controls all other tasks that run under this job, by using the + /// Job. In the first approach, the user specifies a Job Manager Task. The + /// Batch service launches this Task when it is ready to start the Job. The Job + /// Manager Task controls all other Tasks that run under this Job, by using the /// Task APIs. In the second approach, the user directly controls the execution - /// of tasks under an active job, by using the Task APIs. Also note: when - /// naming jobs, avoid including sensitive information such as user names or + /// of Tasks under an active Job, by using the Task APIs. Also note: when + /// naming Jobs, avoid including sensitive information such as user names or /// secret project names. This information may appear in telemetry logs /// accessible to Microsoft Support engineers. /// @@ -491,7 +491,7 @@ public static partial class JobOperationsExtensions /// The operations group for this extension method. /// /// - /// The job to be added. + /// The Job to be added. /// /// /// Additional parameters for the operation @@ -502,16 +502,16 @@ public static partial class JobOperationsExtensions } /// - /// Adds a job to the specified account. + /// Adds a Job to the specified Account. /// /// /// The Batch service supports two ways to control the work done as part of a - /// job. In the first approach, the user specifies a Job Manager task. The - /// Batch service launches this task when it is ready to start the job. The Job - /// Manager task controls all other tasks that run under this job, by using the + /// Job. In the first approach, the user specifies a Job Manager Task. The + /// Batch service launches this Task when it is ready to start the Job. The Job + /// Manager Task controls all other Tasks that run under this Job, by using the /// Task APIs. In the second approach, the user directly controls the execution - /// of tasks under an active job, by using the Task APIs. Also note: when - /// naming jobs, avoid including sensitive information such as user names or + /// of Tasks under an active Job, by using the Task APIs. Also note: when + /// naming Jobs, avoid including sensitive information such as user names or /// secret project names. This information may appear in telemetry logs /// accessible to Microsoft Support engineers. /// @@ -519,7 +519,7 @@ public static partial class JobOperationsExtensions /// The operations group for this extension method. /// /// - /// The job to be added. + /// The Job to be added. /// /// /// Additional parameters for the operation @@ -536,7 +536,7 @@ public static partial class JobOperationsExtensions } /// - /// Lists all of the jobs in the specified account. + /// Lists all of the Jobs in the specified Account. /// /// /// The operations group for this extension method. @@ -550,7 +550,7 @@ public static partial class JobOperationsExtensions } /// - /// Lists all of the jobs in the specified account. + /// Lists all of the Jobs in the specified Account. /// /// /// The operations group for this extension method. @@ -570,13 +570,13 @@ public static partial class JobOperationsExtensions } /// - /// Lists the jobs that have been created under the specified job schedule. + /// Lists the Jobs that have been created under the specified Job Schedule. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job schedule from which you want to get a list of jobs. + /// The ID of the Job Schedule from which you want to get a list of Jobs. /// /// /// Additional parameters for the operation @@ -587,13 +587,13 @@ public static partial class JobOperationsExtensions } /// - /// Lists the jobs that have been created under the specified job schedule. + /// Lists the Jobs that have been created under the specified Job Schedule. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job schedule from which you want to get a list of jobs. + /// The ID of the Job Schedule from which you want to get a list of Jobs. /// /// /// Additional parameters for the operation @@ -610,22 +610,22 @@ public static partial class JobOperationsExtensions } /// - /// Lists the execution status of the Job Preparation and Job Release task for - /// the specified job across the compute nodes where the job has run. + /// Lists the execution status of the Job Preparation and Job Release Task for + /// the specified Job across the Compute Nodes where the Job has run. /// /// - /// This API returns the Job Preparation and Job Release task status on all - /// compute nodes that have run the Job Preparation or Job Release task. This - /// includes nodes which have since been removed from the pool. If this API is - /// invoked on a job which has no Job Preparation or Job Release task, the - /// Batch service returns HTTP status code 409 (Conflict) with an error code of - /// JobPreparationTaskNotSpecified. + /// This API returns the Job Preparation and Job Release Task status on all + /// Compute Nodes that have run the Job Preparation or Job Release Task. This + /// includes Compute Nodes which have since been removed from the Pool. If this + /// API is invoked on a Job which has no Job Preparation or Job Release Task, + /// the Batch service returns HTTP status code 409 (Conflict) with an error + /// code of JobPreparationTaskNotSpecified. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job. + /// The ID of the Job. /// /// /// Additional parameters for the operation @@ -636,22 +636,22 @@ public static partial class JobOperationsExtensions } /// - /// Lists the execution status of the Job Preparation and Job Release task for - /// the specified job across the compute nodes where the job has run. + /// Lists the execution status of the Job Preparation and Job Release Task for + /// the specified Job across the Compute Nodes where the Job has run. /// /// - /// This API returns the Job Preparation and Job Release task status on all - /// compute nodes that have run the Job Preparation or Job Release task. This - /// includes nodes which have since been removed from the pool. If this API is - /// invoked on a job which has no Job Preparation or Job Release task, the - /// Batch service returns HTTP status code 409 (Conflict) with an error code of - /// JobPreparationTaskNotSpecified. + /// This API returns the Job Preparation and Job Release Task status on all + /// Compute Nodes that have run the Job Preparation or Job Release Task. This + /// includes Compute Nodes which have since been removed from the Pool. If this + /// API is invoked on a Job which has no Job Preparation or Job Release Task, + /// the Batch service returns HTTP status code 409 (Conflict) with an error + /// code of JobPreparationTaskNotSpecified. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job. + /// The ID of the Job. /// /// /// Additional parameters for the operation @@ -668,18 +668,18 @@ public static partial class JobOperationsExtensions } /// - /// Gets the task counts for the specified job. + /// Gets the Task counts for the specified Job. /// /// - /// Task counts provide a count of the tasks by active, running or completed - /// task state, and a count of tasks which succeeded or failed. Tasks in the + /// Task counts provide a count of the Tasks by active, running or completed + /// Task state, and a count of Tasks which succeeded or failed. Tasks in the /// preparing state are counted as running. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job. + /// The ID of the Job. /// /// /// Additional parameters for the operation @@ -690,18 +690,18 @@ public static partial class JobOperationsExtensions } /// - /// Gets the task counts for the specified job. + /// Gets the Task counts for the specified Job. /// /// - /// Task counts provide a count of the tasks by active, running or completed - /// task state, and a count of tasks which succeeded or failed. Tasks in the + /// Task counts provide a count of the Tasks by active, running or completed + /// Task state, and a count of Tasks which succeeded or failed. Tasks in the /// preparing state are counted as running. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job. + /// The ID of the Job. /// /// /// Additional parameters for the operation @@ -718,7 +718,7 @@ public static partial class JobOperationsExtensions } /// - /// Lists all of the jobs in the specified account. + /// Lists all of the Jobs in the specified Account. /// /// /// The operations group for this extension method. @@ -735,7 +735,7 @@ public static partial class JobOperationsExtensions } /// - /// Lists all of the jobs in the specified account. + /// Lists all of the Jobs in the specified Account. /// /// /// The operations group for this extension method. @@ -758,7 +758,7 @@ public static partial class JobOperationsExtensions } /// - /// Lists the jobs that have been created under the specified job schedule. + /// Lists the Jobs that have been created under the specified Job Schedule. /// /// /// The operations group for this extension method. @@ -775,7 +775,7 @@ public static partial class JobOperationsExtensions } /// - /// Lists the jobs that have been created under the specified job schedule. + /// Lists the Jobs that have been created under the specified Job Schedule. /// /// /// The operations group for this extension method. @@ -798,16 +798,16 @@ public static partial class JobOperationsExtensions } /// - /// Lists the execution status of the Job Preparation and Job Release task for - /// the specified job across the compute nodes where the job has run. + /// Lists the execution status of the Job Preparation and Job Release Task for + /// the specified Job across the Compute Nodes where the Job has run. /// /// - /// This API returns the Job Preparation and Job Release task status on all - /// compute nodes that have run the Job Preparation or Job Release task. This - /// includes nodes which have since been removed from the pool. If this API is - /// invoked on a job which has no Job Preparation or Job Release task, the - /// Batch service returns HTTP status code 409 (Conflict) with an error code of - /// JobPreparationTaskNotSpecified. + /// This API returns the Job Preparation and Job Release Task status on all + /// Compute Nodes that have run the Job Preparation or Job Release Task. This + /// includes Compute Nodes which have since been removed from the Pool. If this + /// API is invoked on a Job which has no Job Preparation or Job Release Task, + /// the Batch service returns HTTP status code 409 (Conflict) with an error + /// code of JobPreparationTaskNotSpecified. /// /// /// The operations group for this extension method. @@ -824,16 +824,16 @@ public static partial class JobOperationsExtensions } /// - /// Lists the execution status of the Job Preparation and Job Release task for - /// the specified job across the compute nodes where the job has run. + /// Lists the execution status of the Job Preparation and Job Release Task for + /// the specified Job across the Compute Nodes where the Job has run. /// /// - /// This API returns the Job Preparation and Job Release task status on all - /// compute nodes that have run the Job Preparation or Job Release task. This - /// includes nodes which have since been removed from the pool. If this API is - /// invoked on a job which has no Job Preparation or Job Release task, the - /// Batch service returns HTTP status code 409 (Conflict) with an error code of - /// JobPreparationTaskNotSpecified. + /// This API returns the Job Preparation and Job Release Task status on all + /// Compute Nodes that have run the Job Preparation or Job Release Task. This + /// includes Compute Nodes which have since been removed from the Pool. If this + /// API is invoked on a Job which has no Job Preparation or Job Release Task, + /// the Batch service returns HTTP status code 409 (Conflict) with an error + /// code of JobPreparationTaskNotSpecified. /// /// /// The operations group for this extension method. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/JobScheduleOperations.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/JobScheduleOperations.cs index 12543f3b3e92..2b9f7691de56 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/JobScheduleOperations.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/JobScheduleOperations.cs @@ -52,10 +52,10 @@ internal JobScheduleOperations(BatchServiceClient client) public BatchServiceClient Client { get; private set; } /// - /// Checks the specified job schedule exists. + /// Checks the specified Job Schedule exists. /// /// - /// The ID of the job schedule which you want to check. + /// The ID of the Job Schedule which you want to check. /// /// /// Additional parameters for the operation @@ -338,18 +338,18 @@ internal JobScheduleOperations(BatchServiceClient client) } /// - /// Deletes a job schedule from the specified account. + /// Deletes a Job Schedule from the specified Account. /// /// - /// When you delete a job schedule, this also deletes all jobs and tasks under - /// that schedule. When tasks are deleted, all the files in their working - /// directories on the compute nodes are also deleted (the retention period is - /// ignored). The job schedule statistics are no longer accessible once the job - /// schedule is deleted, though they are still counted towards account lifetime + /// When you delete a Job Schedule, this also deletes all Jobs and Tasks under + /// that schedule. When Tasks are deleted, all the files in their working + /// directories on the Compute Nodes are also deleted (the retention period is + /// ignored). The Job Schedule statistics are no longer accessible once the Job + /// Schedule is deleted, though they are still counted towards Account lifetime /// statistics. /// /// - /// The ID of the job schedule to delete. + /// The ID of the Job Schedule to delete. /// /// /// Additional parameters for the operation @@ -631,10 +631,10 @@ internal JobScheduleOperations(BatchServiceClient client) } /// - /// Gets information about the specified job schedule. + /// Gets information about the specified Job Schedule. /// /// - /// The ID of the job schedule to get. + /// The ID of the Job Schedule to get. /// /// /// Additional parameters for the operation @@ -957,17 +957,17 @@ internal JobScheduleOperations(BatchServiceClient client) } /// - /// Updates the properties of the specified job schedule. + /// Updates the properties of the specified Job Schedule. /// /// - /// This replaces only the job schedule properties specified in the request. + /// This replaces only the Job Schedule properties specified in the request. /// For example, if the schedule property is not specified with this request, - /// then the Batch service will keep the existing schedule. Changes to a job - /// schedule only impact jobs created by the schedule after the update has - /// taken place; currently running jobs are unaffected. + /// then the Batch service will keep the existing schedule. Changes to a Job + /// Schedule only impact Jobs created by the schedule after the update has + /// taken place; currently running Jobs are unaffected. /// /// - /// The ID of the job schedule to update. + /// The ID of the Job Schedule to update. /// /// /// The parameters for the request. @@ -1263,17 +1263,17 @@ internal JobScheduleOperations(BatchServiceClient client) } /// - /// Updates the properties of the specified job schedule. + /// Updates the properties of the specified Job Schedule. /// /// - /// This fully replaces all the updatable properties of the job schedule. For + /// This fully replaces all the updatable properties of the Job Schedule. For /// example, if the schedule property is not specified with this request, then - /// the Batch service will remove the existing schedule. Changes to a job - /// schedule only impact jobs created by the schedule after the update has - /// taken place; currently running jobs are unaffected. + /// the Batch service will remove the existing schedule. Changes to a Job + /// Schedule only impact Jobs created by the schedule after the update has + /// taken place; currently running Jobs are unaffected. /// /// - /// The ID of the job schedule to update. + /// The ID of the Job Schedule to update. /// /// /// The parameters for the request. @@ -1569,13 +1569,13 @@ internal JobScheduleOperations(BatchServiceClient client) } /// - /// Disables a job schedule. + /// Disables a Job Schedule. /// /// - /// No new jobs will be created until the job schedule is enabled again. + /// No new Jobs will be created until the Job Schedule is enabled again. /// /// - /// The ID of the job schedule to disable. + /// The ID of the Job Schedule to disable. /// /// /// Additional parameters for the operation @@ -1857,10 +1857,10 @@ internal JobScheduleOperations(BatchServiceClient client) } /// - /// Enables a job schedule. + /// Enables a Job Schedule. /// /// - /// The ID of the job schedule to enable. + /// The ID of the Job Schedule to enable. /// /// /// Additional parameters for the operation @@ -2142,10 +2142,10 @@ internal JobScheduleOperations(BatchServiceClient client) } /// - /// Terminates a job schedule. + /// Terminates a Job Schedule. /// /// - /// The ID of the job schedule to terminates. + /// The ID of the Job Schedule to terminates. /// /// /// Additional parameters for the operation @@ -2427,10 +2427,10 @@ internal JobScheduleOperations(BatchServiceClient client) } /// - /// Adds a job schedule to the specified account. + /// Adds a Job Schedule to the specified Account. /// /// - /// The job schedule to be added. + /// The Job Schedule to be added. /// /// /// Additional parameters for the operation @@ -2661,7 +2661,7 @@ internal JobScheduleOperations(BatchServiceClient client) } /// - /// Lists all of the job schedules in the specified account. + /// Lists all of the Job Schedules in the specified Account. /// /// /// Additional parameters for the operation @@ -2942,7 +2942,7 @@ internal JobScheduleOperations(BatchServiceClient client) } /// - /// Lists all of the job schedules in the specified account. + /// Lists all of the Job Schedules in the specified Account. /// /// /// The NextLink from the previous successful call to List operation. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/JobScheduleOperationsExtensions.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/JobScheduleOperationsExtensions.cs index ee9d0904b513..276f573013cb 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/JobScheduleOperationsExtensions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/JobScheduleOperationsExtensions.cs @@ -22,13 +22,13 @@ namespace Microsoft.Azure.Batch.Protocol public static partial class JobScheduleOperationsExtensions { /// - /// Checks the specified job schedule exists. + /// Checks the specified Job Schedule exists. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job schedule which you want to check. + /// The ID of the Job Schedule which you want to check. /// /// /// Additional parameters for the operation @@ -39,13 +39,13 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Checks the specified job schedule exists. + /// Checks the specified Job Schedule exists. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job schedule which you want to check. + /// The ID of the Job Schedule which you want to check. /// /// /// Additional parameters for the operation @@ -62,21 +62,21 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Deletes a job schedule from the specified account. + /// Deletes a Job Schedule from the specified Account. /// /// - /// When you delete a job schedule, this also deletes all jobs and tasks under - /// that schedule. When tasks are deleted, all the files in their working - /// directories on the compute nodes are also deleted (the retention period is - /// ignored). The job schedule statistics are no longer accessible once the job - /// schedule is deleted, though they are still counted towards account lifetime + /// When you delete a Job Schedule, this also deletes all Jobs and Tasks under + /// that schedule. When Tasks are deleted, all the files in their working + /// directories on the Compute Nodes are also deleted (the retention period is + /// ignored). The Job Schedule statistics are no longer accessible once the Job + /// Schedule is deleted, though they are still counted towards Account lifetime /// statistics. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job schedule to delete. + /// The ID of the Job Schedule to delete. /// /// /// Additional parameters for the operation @@ -87,21 +87,21 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Deletes a job schedule from the specified account. + /// Deletes a Job Schedule from the specified Account. /// /// - /// When you delete a job schedule, this also deletes all jobs and tasks under - /// that schedule. When tasks are deleted, all the files in their working - /// directories on the compute nodes are also deleted (the retention period is - /// ignored). The job schedule statistics are no longer accessible once the job - /// schedule is deleted, though they are still counted towards account lifetime + /// When you delete a Job Schedule, this also deletes all Jobs and Tasks under + /// that schedule. When Tasks are deleted, all the files in their working + /// directories on the Compute Nodes are also deleted (the retention period is + /// ignored). The Job Schedule statistics are no longer accessible once the Job + /// Schedule is deleted, though they are still counted towards Account lifetime /// statistics. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job schedule to delete. + /// The ID of the Job Schedule to delete. /// /// /// Additional parameters for the operation @@ -118,13 +118,13 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Gets information about the specified job schedule. + /// Gets information about the specified Job Schedule. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job schedule to get. + /// The ID of the Job Schedule to get. /// /// /// Additional parameters for the operation @@ -135,13 +135,13 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Gets information about the specified job schedule. + /// Gets information about the specified Job Schedule. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job schedule to get. + /// The ID of the Job Schedule to get. /// /// /// Additional parameters for the operation @@ -158,20 +158,20 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Updates the properties of the specified job schedule. + /// Updates the properties of the specified Job Schedule. /// /// - /// This replaces only the job schedule properties specified in the request. + /// This replaces only the Job Schedule properties specified in the request. /// For example, if the schedule property is not specified with this request, - /// then the Batch service will keep the existing schedule. Changes to a job - /// schedule only impact jobs created by the schedule after the update has - /// taken place; currently running jobs are unaffected. + /// then the Batch service will keep the existing schedule. Changes to a Job + /// Schedule only impact Jobs created by the schedule after the update has + /// taken place; currently running Jobs are unaffected. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job schedule to update. + /// The ID of the Job Schedule to update. /// /// /// The parameters for the request. @@ -185,20 +185,20 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Updates the properties of the specified job schedule. + /// Updates the properties of the specified Job Schedule. /// /// - /// This replaces only the job schedule properties specified in the request. + /// This replaces only the Job Schedule properties specified in the request. /// For example, if the schedule property is not specified with this request, - /// then the Batch service will keep the existing schedule. Changes to a job - /// schedule only impact jobs created by the schedule after the update has - /// taken place; currently running jobs are unaffected. + /// then the Batch service will keep the existing schedule. Changes to a Job + /// Schedule only impact Jobs created by the schedule after the update has + /// taken place; currently running Jobs are unaffected. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job schedule to update. + /// The ID of the Job Schedule to update. /// /// /// The parameters for the request. @@ -218,20 +218,20 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Updates the properties of the specified job schedule. + /// Updates the properties of the specified Job Schedule. /// /// - /// This fully replaces all the updatable properties of the job schedule. For + /// This fully replaces all the updatable properties of the Job Schedule. For /// example, if the schedule property is not specified with this request, then - /// the Batch service will remove the existing schedule. Changes to a job - /// schedule only impact jobs created by the schedule after the update has - /// taken place; currently running jobs are unaffected. + /// the Batch service will remove the existing schedule. Changes to a Job + /// Schedule only impact Jobs created by the schedule after the update has + /// taken place; currently running Jobs are unaffected. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job schedule to update. + /// The ID of the Job Schedule to update. /// /// /// The parameters for the request. @@ -245,20 +245,20 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Updates the properties of the specified job schedule. + /// Updates the properties of the specified Job Schedule. /// /// - /// This fully replaces all the updatable properties of the job schedule. For + /// This fully replaces all the updatable properties of the Job Schedule. For /// example, if the schedule property is not specified with this request, then - /// the Batch service will remove the existing schedule. Changes to a job - /// schedule only impact jobs created by the schedule after the update has - /// taken place; currently running jobs are unaffected. + /// the Batch service will remove the existing schedule. Changes to a Job + /// Schedule only impact Jobs created by the schedule after the update has + /// taken place; currently running Jobs are unaffected. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job schedule to update. + /// The ID of the Job Schedule to update. /// /// /// The parameters for the request. @@ -278,16 +278,16 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Disables a job schedule. + /// Disables a Job Schedule. /// /// - /// No new jobs will be created until the job schedule is enabled again. + /// No new Jobs will be created until the Job Schedule is enabled again. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job schedule to disable. + /// The ID of the Job Schedule to disable. /// /// /// Additional parameters for the operation @@ -298,16 +298,16 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Disables a job schedule. + /// Disables a Job Schedule. /// /// - /// No new jobs will be created until the job schedule is enabled again. + /// No new Jobs will be created until the Job Schedule is enabled again. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job schedule to disable. + /// The ID of the Job Schedule to disable. /// /// /// Additional parameters for the operation @@ -324,13 +324,13 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Enables a job schedule. + /// Enables a Job Schedule. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job schedule to enable. + /// The ID of the Job Schedule to enable. /// /// /// Additional parameters for the operation @@ -341,13 +341,13 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Enables a job schedule. + /// Enables a Job Schedule. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job schedule to enable. + /// The ID of the Job Schedule to enable. /// /// /// Additional parameters for the operation @@ -364,13 +364,13 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Terminates a job schedule. + /// Terminates a Job Schedule. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job schedule to terminates. + /// The ID of the Job Schedule to terminates. /// /// /// Additional parameters for the operation @@ -381,13 +381,13 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Terminates a job schedule. + /// Terminates a Job Schedule. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job schedule to terminates. + /// The ID of the Job Schedule to terminates. /// /// /// Additional parameters for the operation @@ -404,13 +404,13 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Adds a job schedule to the specified account. + /// Adds a Job Schedule to the specified Account. /// /// /// The operations group for this extension method. /// /// - /// The job schedule to be added. + /// The Job Schedule to be added. /// /// /// Additional parameters for the operation @@ -421,13 +421,13 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Adds a job schedule to the specified account. + /// Adds a Job Schedule to the specified Account. /// /// /// The operations group for this extension method. /// /// - /// The job schedule to be added. + /// The Job Schedule to be added. /// /// /// Additional parameters for the operation @@ -444,7 +444,7 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Lists all of the job schedules in the specified account. + /// Lists all of the Job Schedules in the specified Account. /// /// /// The operations group for this extension method. @@ -458,7 +458,7 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Lists all of the job schedules in the specified account. + /// Lists all of the Job Schedules in the specified Account. /// /// /// The operations group for this extension method. @@ -478,7 +478,7 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Lists all of the job schedules in the specified account. + /// Lists all of the Job Schedules in the specified Account. /// /// /// The operations group for this extension method. @@ -495,7 +495,7 @@ public static partial class JobScheduleOperationsExtensions } /// - /// Lists all of the job schedules in the specified account. + /// Lists all of the Job Schedules in the specified Account. /// /// /// The operations group for this extension method. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AccessScope.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AccessScope.cs index 04a7a82f2c64..dc4e65dbf692 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AccessScope.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AccessScope.cs @@ -22,8 +22,8 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum AccessScope { /// - /// Grants access to perform all operations on the job containing the - /// task. + /// Grants access to perform all operations on the Job containing the + /// Task. /// [EnumMember(Value = "job")] Job diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AccountListPoolNodeCountsHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AccountListPoolNodeCountsHeaders.cs index e844db92a650..e2f0a189a085 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AccountListPoolNodeCountsHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AccountListPoolNodeCountsHeaders.cs @@ -39,8 +39,8 @@ public AccountListPoolNodeCountsHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. public AccountListPoolNodeCountsHeaders(System.Guid? clientRequestId = default(System.Guid?), System.Guid? requestId = default(System.Guid?)) { ClientRequestId = clientRequestId; @@ -67,8 +67,8 @@ public AccountListPoolNodeCountsHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AccountListSupportedImagesHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AccountListSupportedImagesHeaders.cs index 7765970a7ca6..b02ca414e187 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AccountListSupportedImagesHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AccountListSupportedImagesHeaders.cs @@ -41,8 +41,8 @@ public AccountListSupportedImagesHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -78,8 +78,8 @@ public AccountListSupportedImagesHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AffinityInformation.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AffinityInformation.cs index 32ee4f5e0f60..e28d72c5649f 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AffinityInformation.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AffinityInformation.cs @@ -15,7 +15,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models /// /// A locality hint that can be used by the Batch service to select a - /// compute node on which to start a task. + /// Compute Node on which to start a Task. /// public partial class AffinityInformation { @@ -31,7 +31,7 @@ public AffinityInformation() /// Initializes a new instance of the AffinityInformation class. /// /// An opaque string representing the location - /// of a compute node or a task that has run previously. + /// of a Compute Node or a Task that has run previously. public AffinityInformation(string affinityId) { AffinityId = affinityId; @@ -45,13 +45,13 @@ public AffinityInformation(string affinityId) /// /// Gets or sets an opaque string representing the location of a - /// compute node or a task that has run previously. + /// Compute Node or a Task that has run previously. /// /// - /// You can pass the affinityId of a compute node to indicate that this - /// task needs to run on that compute node. Note that this is just a - /// soft affinity. If the target node is busy or unavailable at the - /// time the task is scheduled, then the task will be scheduled + /// You can pass the affinityId of a Node to indicate that this Task + /// needs to run on that Compute Node. Note that this is just a soft + /// affinity. If the target Compute Node is busy or unavailable at the + /// time the Task is scheduled, then the Task will be scheduled /// elsewhere. /// [JsonProperty(PropertyName = "affinityId")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AllocationState.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AllocationState.cs index e8b67e438eb2..1d899440d490 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AllocationState.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AllocationState.cs @@ -22,21 +22,21 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum AllocationState { /// - /// The pool is not resizing. There are no changes to the number of - /// nodes in the pool in progress. A pool enters this state when it is - /// created and when no operations are being performed on the pool to - /// change the number of nodes. + /// The Pool is not resizing. There are no changes to the number of + /// Compute Nodes in the Pool in progress. A Pool enters this state + /// when it is created and when no operations are being performed on + /// the Pool to change the number of Compute Nodes. /// [EnumMember(Value = "steady")] Steady, /// - /// The pool is resizing; that is, compute nodes are being added to or - /// removed from the pool. + /// The Pool is resizing; that is, Compute Nodes are being added to or + /// removed from the Pool. /// [EnumMember(Value = "resizing")] Resizing, /// - /// The pool was resizing, but the user has requested that the resize + /// The Pool was resizing, but the user has requested that the resize /// be stopped, but the stop request has not yet been completed. /// [EnumMember(Value = "stopping")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ApplicationGetHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ApplicationGetHeaders.cs index c6792de8aa0b..b42dd9d27608 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ApplicationGetHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ApplicationGetHeaders.cs @@ -39,8 +39,8 @@ public ApplicationGetHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -76,8 +76,8 @@ public ApplicationGetHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ApplicationListHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ApplicationListHeaders.cs index 99a4c9cab292..397ba2cbb5f4 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ApplicationListHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ApplicationListHeaders.cs @@ -39,8 +39,8 @@ public ApplicationListHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -76,8 +76,8 @@ public ApplicationListHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ApplicationPackageReference.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ApplicationPackageReference.cs index 48c9f4d0d47e..0c9f7f527768 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ApplicationPackageReference.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ApplicationPackageReference.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// A reference to an application package to be deployed to compute nodes. + /// A reference to an Package to be deployed to Compute Nodes. /// public partial class ApplicationPackageReference { @@ -58,11 +58,11 @@ public ApplicationPackageReference() /// the default version is deployed. /// /// - /// If this is omitted on a pool, and no default version is specified + /// If this is omitted on a Pool, and no default version is specified /// for this application, the request fails with the error code /// InvalidApplicationPackageReferences and HTTP status code 409. If - /// this is omitted on a task, and no default version is specified for - /// this application, the task fails with a pre-processing error. + /// this is omitted on a Task, and no default version is specified for + /// this application, the Task fails with a pre-processing error. /// [JsonProperty(PropertyName = "version")] public string Version { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ApplicationSummary.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ApplicationSummary.cs index dc78c951c064..ebfa7effa346 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ApplicationSummary.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ApplicationSummary.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Contains information about an application in an Azure Batch account. + /// Contains information about an application in an Azure Batch Account. /// public partial class ApplicationSummary { @@ -32,7 +32,7 @@ public ApplicationSummary() /// Initializes a new instance of the ApplicationSummary class. /// /// A string that uniquely identifies the application - /// within the account. + /// within the Account. /// The display name for the /// application. /// The list of available versions of the @@ -52,7 +52,7 @@ public ApplicationSummary(string id, string displayName, IList versions) /// /// Gets or sets a string that uniquely identifies the application - /// within the account. + /// within the Account. /// [JsonProperty(PropertyName = "id")] public string Id { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AuthenticationTokenSettings.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AuthenticationTokenSettings.cs index 40f34a18e6ed..55ff372f68c9 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AuthenticationTokenSettings.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AuthenticationTokenSettings.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The settings for an authentication token that the task can use to + /// The settings for an authentication token that the Task can use to /// perform Batch service operations. /// public partial class AuthenticationTokenSettings @@ -54,7 +54,7 @@ public AuthenticationTokenSettings() /// The authentication token grants access to a limited set of Batch /// service operations. Currently the only supported value for the /// access property is 'job', which grants access to all operations - /// related to the job which contains the task. + /// related to the Job which contains the Task. /// [JsonProperty(PropertyName = "access")] public IList Access { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AutoPoolSpecification.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AutoPoolSpecification.cs index 87635588e7d8..ec54d25f15fa 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AutoPoolSpecification.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AutoPoolSpecification.cs @@ -15,7 +15,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models /// /// Specifies characteristics for a temporary 'auto pool'. The Batch - /// service will create this auto pool when the job is submitted. + /// service will create this auto Pool when the Job is submitted. /// public partial class AutoPoolSpecification { @@ -31,14 +31,14 @@ public AutoPoolSpecification() /// Initializes a new instance of the AutoPoolSpecification class. /// /// The minimum lifetime of created - /// auto pools, and how multiple jobs on a schedule are assigned to - /// pools. + /// auto Pools, and how multiple Jobs on a schedule are assigned to + /// Pools. /// A prefix to be added to the unique - /// identifier when a pool is automatically created. - /// Whether to keep an auto pool alive after + /// identifier when a Pool is automatically created. + /// Whether to keep an auto Pool alive after /// its lifetime expires. - /// The pool specification for the auto - /// pool. + /// The Pool specification for the auto + /// Pool. public AutoPoolSpecification(PoolLifetimeOption poolLifetimeOption, string autoPoolIdPrefix = default(string), bool? keepAlive = default(bool?), PoolSpecification pool = default(PoolSpecification)) { AutoPoolIdPrefix = autoPoolIdPrefix; @@ -55,11 +55,11 @@ public AutoPoolSpecification() /// /// Gets or sets a prefix to be added to the unique identifier when a - /// pool is automatically created. + /// Pool is automatically created. /// /// - /// The Batch service assigns each auto pool a unique identifier on - /// creation. To distinguish between pools created for different + /// The Batch service assigns each auto Pool a unique identifier on + /// creation. To distinguish between Pools created for different /// purposes, you can specify this element to add a prefix to the ID /// that is assigned. The prefix can be up to 20 characters long. /// @@ -67,8 +67,8 @@ public AutoPoolSpecification() public string AutoPoolIdPrefix { get; set; } /// - /// Gets or sets the minimum lifetime of created auto pools, and how - /// multiple jobs on a schedule are assigned to pools. + /// Gets or sets the minimum lifetime of created auto Pools, and how + /// multiple Jobs on a schedule are assigned to Pools. /// /// /// Possible values include: 'jobSchedule', 'job' @@ -77,21 +77,21 @@ public AutoPoolSpecification() public PoolLifetimeOption PoolLifetimeOption { get; set; } /// - /// Gets or sets whether to keep an auto pool alive after its lifetime + /// Gets or sets whether to keep an auto Pool alive after its lifetime /// expires. /// /// - /// If false, the Batch service deletes the pool once its lifetime (as + /// If false, the Batch service deletes the Pool once its lifetime (as /// determined by the poolLifetimeOption setting) expires; that is, - /// when the job or job schedule completes. If true, the Batch service - /// does not delete the pool automatically. It is up to the user to - /// delete auto pools created with this option. + /// when the Job or Job Schedule completes. If true, the Batch service + /// does not delete the Pool automatically. It is up to the user to + /// delete auto Pools created with this option. /// [JsonProperty(PropertyName = "keepAlive")] public bool? KeepAlive { get; set; } /// - /// Gets or sets the pool specification for the auto pool. + /// Gets or sets the Pool specification for the auto Pool. /// [JsonProperty(PropertyName = "pool")] public PoolSpecification Pool { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AutoScaleRun.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AutoScaleRun.cs index 1648c10ad5e9..32ffd1745df3 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AutoScaleRun.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AutoScaleRun.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The results and errors from an execution of a pool autoscale formula. + /// The results and errors from an execution of a Pool autoscale formula. /// public partial class AutoScaleRun { @@ -34,7 +34,7 @@ public AutoScaleRun() /// The final values of all variables used in the /// evaluation of the autoscale formula. /// Details of the error encountered evaluating the - /// autoscale formula on the pool, if the evaluation was + /// autoscale formula on the Pool, if the evaluation was /// unsuccessful. public AutoScaleRun(System.DateTime timestamp, string results = default(string), AutoScaleRunError error = default(AutoScaleRunError)) { @@ -69,7 +69,7 @@ public AutoScaleRun() /// /// Gets or sets details of the error encountered evaluating the - /// autoscale formula on the pool, if the evaluation was unsuccessful. + /// autoscale formula on the Pool, if the evaluation was unsuccessful. /// [JsonProperty(PropertyName = "error")] public AutoScaleRunError Error { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AutoScaleRunError.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AutoScaleRunError.cs index 85a4d658d17d..fe60451de532 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AutoScaleRunError.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AutoScaleRunError.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// An error that occurred when executing or evaluating a pool autoscale + /// An error that occurred when executing or evaluating a Pool autoscale /// formula. /// public partial class AutoScaleRunError diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AutoUserScope.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AutoUserScope.cs index cac6212328a0..986a1b8bc931 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AutoUserScope.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AutoUserScope.cs @@ -22,13 +22,13 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum AutoUserScope { /// - /// Specifies that the service should create a new user for the task. + /// Specifies that the service should create a new user for the Task. /// [EnumMember(Value = "task")] Task, /// - /// Specifies that the task runs as the common auto user account which - /// is created on every node in a pool. + /// Specifies that the Task runs as the common auto user Account which + /// is created on every Compute Node in a Pool. /// [EnumMember(Value = "pool")] Pool diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AutoUserSpecification.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AutoUserSpecification.cs index e4bd45c308c7..b8aa34227532 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AutoUserSpecification.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AutoUserSpecification.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Specifies the parameters for the auto user that runs a task on the + /// Specifies the parameters for the auto user that runs a Task on the /// Batch service. /// public partial class AutoUserSpecification @@ -49,7 +49,13 @@ public AutoUserSpecification() /// Gets or sets the scope for the auto user /// /// - /// The default value is task. Possible values include: 'task', 'pool' + /// The default value is pool. If the pool is running Windows a value + /// of Task should be specified if stricter isolation between tasks is + /// required. For example, if the task mutates the registry in a way + /// which could impact other tasks, or if certificates have been + /// specified on the pool which should not be accessible by normal + /// tasks but should be accessible by StartTasks. Possible values + /// include: 'task', 'pool' /// [JsonProperty(PropertyName = "scope")] public AutoUserScope? Scope { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AzureBlobFileSystemConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AzureBlobFileSystemConfiguration.cs new file mode 100644 index 000000000000..b3cb8432f58e --- /dev/null +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AzureBlobFileSystemConfiguration.cs @@ -0,0 +1,116 @@ +// +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License.txt in the project root for +// license information. +// +// Code generated by Microsoft (R) AutoRest Code Generator. +// Changes may cause incorrect behavior and will be lost if the code is +// regenerated. +// + +namespace Microsoft.Azure.Batch.Protocol.Models +{ + using Newtonsoft.Json; + using System.Linq; + + /// + /// Information used to connect to an Azure Storage Container using + /// Blobfuse. + /// + public partial class AzureBlobFileSystemConfiguration + { + /// + /// Initializes a new instance of the AzureBlobFileSystemConfiguration + /// class. + /// + public AzureBlobFileSystemConfiguration() + { + CustomInit(); + } + + /// + /// Initializes a new instance of the AzureBlobFileSystemConfiguration + /// class. + /// + /// The Azure Storage Account name. + /// The Azure Blob Storage Container + /// name. + /// The relative path on the compute + /// node where the file system will be mounted + /// The Azure Storage Account key. + /// The Azure Storage SAS token. + /// Additional command line options to + /// pass to the mount command. + public AzureBlobFileSystemConfiguration(string accountName, string containerName, string relativeMountPath, string accountKey = default(string), string sasKey = default(string), string blobfuseOptions = default(string)) + { + AccountName = accountName; + ContainerName = containerName; + AccountKey = accountKey; + SasKey = sasKey; + BlobfuseOptions = blobfuseOptions; + RelativeMountPath = relativeMountPath; + CustomInit(); + } + + /// + /// An initialization method that performs custom operations like setting defaults + /// + partial void CustomInit(); + + /// + /// Gets or sets the Azure Storage Account name. + /// + [JsonProperty(PropertyName = "accountName")] + public string AccountName { get; set; } + + /// + /// Gets or sets the Azure Blob Storage Container name. + /// + [JsonProperty(PropertyName = "containerName")] + public string ContainerName { get; set; } + + /// + /// Gets or sets the Azure Storage Account key. + /// + /// + /// This property is mutually exclusive with sasKey and one must be + /// specified. + /// + [JsonProperty(PropertyName = "accountKey")] + public string AccountKey { get; set; } + + /// + /// Gets or sets the Azure Storage SAS token. + /// + /// + /// This property is mutually exclusive with accountKey and one must be + /// specified. + /// + [JsonProperty(PropertyName = "sasKey")] + public string SasKey { get; set; } + + /// + /// Gets or sets additional command line options to pass to the mount + /// command. + /// + /// + /// These are 'net use' options in Windows and 'mount' options in + /// Linux. + /// + [JsonProperty(PropertyName = "blobfuseOptions")] + public string BlobfuseOptions { get; set; } + + /// + /// Gets or sets the relative path on the compute node where the file + /// system will be mounted + /// + /// + /// All file systems are mounted relative to the Batch mounts + /// directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment + /// variable. + /// + [JsonProperty(PropertyName = "relativeMountPath")] + public string RelativeMountPath { get; set; } + + } +} diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AzureFileShareConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AzureFileShareConfiguration.cs new file mode 100644 index 000000000000..e2b309cea991 --- /dev/null +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/AzureFileShareConfiguration.cs @@ -0,0 +1,101 @@ +// +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License.txt in the project root for +// license information. +// +// Code generated by Microsoft (R) AutoRest Code Generator. +// Changes may cause incorrect behavior and will be lost if the code is +// regenerated. +// + +namespace Microsoft.Azure.Batch.Protocol.Models +{ + using Newtonsoft.Json; + using System.Linq; + + /// + /// Information used to connect to an Azure Fileshare. + /// + public partial class AzureFileShareConfiguration + { + /// + /// Initializes a new instance of the AzureFileShareConfiguration + /// class. + /// + public AzureFileShareConfiguration() + { + CustomInit(); + } + + /// + /// Initializes a new instance of the AzureFileShareConfiguration + /// class. + /// + /// The Azure Storage account name. + /// The Azure Files URL. + /// The Azure Storage account key. + /// The relative path on the compute + /// node where the file system will be mounted + /// Additional command line options to pass + /// to the mount command. + public AzureFileShareConfiguration(string accountName, string azureFileUrl, string accountKey, string relativeMountPath, string mountOptions = default(string)) + { + AccountName = accountName; + AzureFileUrl = azureFileUrl; + AccountKey = accountKey; + RelativeMountPath = relativeMountPath; + MountOptions = mountOptions; + CustomInit(); + } + + /// + /// An initialization method that performs custom operations like setting defaults + /// + partial void CustomInit(); + + /// + /// Gets or sets the Azure Storage account name. + /// + [JsonProperty(PropertyName = "accountName")] + public string AccountName { get; set; } + + /// + /// Gets or sets the Azure Files URL. + /// + /// + /// This is of the form 'https://{account}.file.core.windows.net/'. + /// + [JsonProperty(PropertyName = "azureFileUrl")] + public string AzureFileUrl { get; set; } + + /// + /// Gets or sets the Azure Storage account key. + /// + [JsonProperty(PropertyName = "accountKey")] + public string AccountKey { get; set; } + + /// + /// Gets or sets the relative path on the compute node where the file + /// system will be mounted + /// + /// + /// All file systems are mounted relative to the Batch mounts + /// directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment + /// variable. + /// + [JsonProperty(PropertyName = "relativeMountPath")] + public string RelativeMountPath { get; set; } + + /// + /// Gets or sets additional command line options to pass to the mount + /// command. + /// + /// + /// These are 'net use' options in Windows and 'mount' options in + /// Linux. + /// + [JsonProperty(PropertyName = "mountOptions")] + public string MountOptions { get; set; } + + } +} diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CIFSMountConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CIFSMountConfiguration.cs new file mode 100644 index 000000000000..648ea20f47da --- /dev/null +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CIFSMountConfiguration.cs @@ -0,0 +1,100 @@ +// +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License.txt in the project root for +// license information. +// +// Code generated by Microsoft (R) AutoRest Code Generator. +// Changes may cause incorrect behavior and will be lost if the code is +// regenerated. +// + +namespace Microsoft.Azure.Batch.Protocol.Models +{ + using Newtonsoft.Json; + using System.Linq; + + /// + /// Information used to connect to a CIFS file system. + /// + public partial class CIFSMountConfiguration + { + /// + /// Initializes a new instance of the CIFSMountConfiguration class. + /// + public CIFSMountConfiguration() + { + CustomInit(); + } + + /// + /// Initializes a new instance of the CIFSMountConfiguration class. + /// + /// The user to use for authentication against + /// the CIFS file system. + /// The URI of the file system to mount. + /// The relative path on the compute + /// node where the file system will be mounted + /// The password to use for authentication + /// against the CIFS file system. + /// Additional command line options to pass + /// to the mount command. + public CIFSMountConfiguration(string username, string source, string relativeMountPath, string password, string mountOptions = default(string)) + { + Username = username; + Source = source; + RelativeMountPath = relativeMountPath; + MountOptions = mountOptions; + Password = password; + CustomInit(); + } + + /// + /// An initialization method that performs custom operations like setting defaults + /// + partial void CustomInit(); + + /// + /// Gets or sets the user to use for authentication against the CIFS + /// file system. + /// + [JsonProperty(PropertyName = "username")] + public string Username { get; set; } + + /// + /// Gets or sets the URI of the file system to mount. + /// + [JsonProperty(PropertyName = "source")] + public string Source { get; set; } + + /// + /// Gets or sets the relative path on the compute node where the file + /// system will be mounted + /// + /// + /// All file systems are mounted relative to the Batch mounts + /// directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment + /// variable. + /// + [JsonProperty(PropertyName = "relativeMountPath")] + public string RelativeMountPath { get; set; } + + /// + /// Gets or sets additional command line options to pass to the mount + /// command. + /// + /// + /// These are 'net use' options in Windows and 'mount' options in + /// Linux. + /// + [JsonProperty(PropertyName = "mountOptions")] + public string MountOptions { get; set; } + + /// + /// Gets or sets the password to use for authentication against the + /// CIFS file system. + /// + [JsonProperty(PropertyName = "password")] + public string Password { get; set; } + + } +} diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/Certificate.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/Certificate.cs index b64fe7f0710b..dc9e50f0cd05 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/Certificate.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/Certificate.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// A certificate that can be installed on compute nodes and can be used to + /// A Certificate that can be installed on Compute Nodes and can be used to /// authenticate operations on the machine. /// public partial class Certificate @@ -30,22 +30,22 @@ public Certificate() /// /// Initializes a new instance of the Certificate class. /// - /// The X.509 thumbprint of the certificate. + /// The X.509 thumbprint of the Certificate. /// This is a sequence of up to 40 hex digits. /// The algorithm used to derive the /// thumbprint. - /// The URL of the certificate. - /// The current state of the certificate. - /// The time at which the certificate + /// The URL of the Certificate. + /// The current state of the Certificate. + /// The time at which the Certificate /// entered its current state. /// The previous state of the - /// certificate. + /// Certificate. /// The time at which the - /// certificate entered its previous state. - /// The public part of the certificate as a + /// Certificate entered its previous state. + /// The public part of the Certificate as a /// base-64 encoded .cer file. /// The error that occurred on the - /// last attempt to delete this certificate. + /// last attempt to delete this Certificate. public Certificate(string thumbprint = default(string), string thumbprintAlgorithm = default(string), string url = default(string), CertificateState? state = default(CertificateState?), System.DateTime? stateTransitionTime = default(System.DateTime?), CertificateState? previousState = default(CertificateState?), System.DateTime? previousStateTransitionTime = default(System.DateTime?), string publicData = default(string), DeleteCertificateError deleteCertificateError = default(DeleteCertificateError)) { Thumbprint = thumbprint; @@ -66,7 +66,7 @@ public Certificate() partial void CustomInit(); /// - /// Gets or sets the X.509 thumbprint of the certificate. This is a + /// Gets or sets the X.509 thumbprint of the Certificate. This is a /// sequence of up to 40 hex digits. /// [JsonProperty(PropertyName = "thumbprint")] @@ -79,13 +79,13 @@ public Certificate() public string ThumbprintAlgorithm { get; set; } /// - /// Gets or sets the URL of the certificate. + /// Gets or sets the URL of the Certificate. /// [JsonProperty(PropertyName = "url")] public string Url { get; set; } /// - /// Gets or sets the current state of the certificate. + /// Gets or sets the current state of the Certificate. /// /// /// Possible values include: 'active', 'deleting', 'deleteFailed' @@ -94,17 +94,17 @@ public Certificate() public CertificateState? State { get; set; } /// - /// Gets or sets the time at which the certificate entered its current + /// Gets or sets the time at which the Certificate entered its current /// state. /// [JsonProperty(PropertyName = "stateTransitionTime")] public System.DateTime? StateTransitionTime { get; set; } /// - /// Gets or sets the previous state of the certificate. + /// Gets or sets the previous state of the Certificate. /// /// - /// This property is not set if the certificate is in its initial + /// This property is not set if the Certificate is in its initial /// active state. Possible values include: 'active', 'deleting', /// 'deleteFailed' /// @@ -112,18 +112,18 @@ public Certificate() public CertificateState? PreviousState { get; set; } /// - /// Gets or sets the time at which the certificate entered its previous + /// Gets or sets the time at which the Certificate entered its previous /// state. /// /// - /// This property is not set if the certificate is in its initial + /// This property is not set if the Certificate is in its initial /// Active state. /// [JsonProperty(PropertyName = "previousStateTransitionTime")] public System.DateTime? PreviousStateTransitionTime { get; set; } /// - /// Gets or sets the public part of the certificate as a base-64 + /// Gets or sets the public part of the Certificate as a base-64 /// encoded .cer file. /// [JsonProperty(PropertyName = "publicData")] @@ -131,10 +131,10 @@ public Certificate() /// /// Gets or sets the error that occurred on the last attempt to delete - /// this certificate. + /// this Certificate. /// /// - /// This property is set only if the certificate is in the DeleteFailed + /// This property is set only if the Certificate is in the DeleteFailed /// state. /// [JsonProperty(PropertyName = "deleteCertificateError")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateAddHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateAddHeaders.cs index f13deaf0c6f4..0b49a98b2841 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateAddHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateAddHeaders.cs @@ -39,8 +39,8 @@ public CertificateAddHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public CertificateAddHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateAddParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateAddParameter.cs index 396e0031af9e..9acb8cf12675 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateAddParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateAddParameter.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// A certificate that can be installed on compute nodes and can be used to + /// A Certificate that can be installed on Compute Nodes and can be used to /// authenticate operations on the machine. /// public partial class CertificateAddParameter @@ -30,16 +30,16 @@ public CertificateAddParameter() /// /// Initializes a new instance of the CertificateAddParameter class. /// - /// The X.509 thumbprint of the certificate. + /// The X.509 thumbprint of the Certificate. /// This is a sequence of up to 40 hex digits (it may include spaces /// but these are removed). /// The algorithm used to derive the /// thumbprint. This must be sha1. - /// The base64-encoded contents of the certificate. + /// The base64-encoded contents of the Certificate. /// The maximum size is 10KB. - /// The format of the certificate + /// The format of the Certificate /// data. - /// The password to access the certificate's + /// The password to access the Certificate's /// private key. public CertificateAddParameter(string thumbprint, string thumbprintAlgorithm, string data, CertificateFormat? certificateFormat = default(CertificateFormat?), string password = default(string)) { @@ -57,7 +57,7 @@ public CertificateAddParameter() partial void CustomInit(); /// - /// Gets or sets the X.509 thumbprint of the certificate. This is a + /// Gets or sets the X.509 thumbprint of the Certificate. This is a /// sequence of up to 40 hex digits (it may include spaces but these /// are removed). /// @@ -72,14 +72,14 @@ public CertificateAddParameter() public string ThumbprintAlgorithm { get; set; } /// - /// Gets or sets the base64-encoded contents of the certificate. The + /// Gets or sets the base64-encoded contents of the Certificate. The /// maximum size is 10KB. /// [JsonProperty(PropertyName = "data")] public string Data { get; set; } /// - /// Gets or sets the format of the certificate data. + /// Gets or sets the format of the Certificate data. /// /// /// Possible values include: 'pfx', 'cer' @@ -88,11 +88,11 @@ public CertificateAddParameter() public CertificateFormat? CertificateFormat { get; set; } /// - /// Gets or sets the password to access the certificate's private key. + /// Gets or sets the password to access the Certificate's private key. /// /// - /// This is required if the certificate format is pfx. It should be - /// omitted if the certificate format is cer. + /// This is required if the Certificate format is pfx. It should be + /// omitted if the Certificate format is cer. /// [JsonProperty(PropertyName = "password")] public string Password { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateCancelDeletionHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateCancelDeletionHeaders.cs index 03d5194430b3..21e812cf068a 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateCancelDeletionHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateCancelDeletionHeaders.cs @@ -41,8 +41,8 @@ public CertificateCancelDeletionHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -81,8 +81,8 @@ public CertificateCancelDeletionHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateDeleteHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateDeleteHeaders.cs index e2ad5becb5eb..a34745e60f52 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateDeleteHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateDeleteHeaders.cs @@ -39,8 +39,8 @@ public CertificateDeleteHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -76,8 +76,8 @@ public CertificateDeleteHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateFormat.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateFormat.cs index 884c026f83ea..ea311997861e 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateFormat.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateFormat.cs @@ -22,13 +22,13 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum CertificateFormat { /// - /// The certificate is a PFX (PKCS#12) formatted certificate or - /// certificate chain. + /// The Certificate is a PFX (PKCS#12) formatted Certificate or + /// Certificate chain. /// [EnumMember(Value = "pfx")] Pfx, /// - /// The certificate is a base64-encoded X.509 certificate. + /// The Certificate is a base64-encoded X.509 Certificate. /// [EnumMember(Value = "cer")] Cer diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateGetHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateGetHeaders.cs index 747c8147c20e..cef26715e840 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateGetHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateGetHeaders.cs @@ -39,8 +39,8 @@ public CertificateGetHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -76,8 +76,8 @@ public CertificateGetHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateListHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateListHeaders.cs index ccf1bfc94651..67ce3ca310d3 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateListHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateListHeaders.cs @@ -39,8 +39,8 @@ public CertificateListHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -76,8 +76,8 @@ public CertificateListHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateListOptions.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateListOptions.cs index f0c978fb8a4b..059e00fa0b85 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateListOptions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateListOptions.cs @@ -36,7 +36,7 @@ public CertificateListOptions() /// https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates. /// An OData $select clause. /// The maximum number of items to return in - /// the response. A maximum of 1000 certificates can be + /// the response. A maximum of 1000 Certificates can be /// returned. /// The maximum time that the server can spend /// processing the request, in seconds. The default is 30 @@ -82,7 +82,7 @@ public CertificateListOptions() /// /// Gets or sets the maximum number of items to return in the response. - /// A maximum of 1000 certificates can be returned. + /// A maximum of 1000 Certificates can be returned. /// [Newtonsoft.Json.JsonIgnore] public int? MaxResults { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateReference.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateReference.cs index 63a6635ab4c2..bee63c30e13e 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateReference.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateReference.cs @@ -16,8 +16,8 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// A reference to a certificate to be installed on compute nodes in a - /// pool. + /// A reference to a Certificate to be installed on Compute Nodes in a + /// Pool. /// public partial class CertificateReference { @@ -32,15 +32,15 @@ public CertificateReference() /// /// Initializes a new instance of the CertificateReference class. /// - /// The thumbprint of the certificate. + /// The thumbprint of the Certificate. /// The algorithm with which the /// thumbprint is associated. This must be sha1. - /// The location of the certificate store - /// on the compute node into which to install the certificate. - /// The name of the certificate store on the - /// compute node into which to install the certificate. - /// Which user accounts on the compute node - /// should have access to the private data of the certificate. + /// The location of the Certificate store + /// on the Compute Node into which to install the Certificate. + /// The name of the Certificate store on the + /// Compute Node into which to install the Certificate. + /// Which user Accounts on the Compute Node + /// should have access to the private data of the Certificate. public CertificateReference(string thumbprint, string thumbprintAlgorithm, CertificateStoreLocation? storeLocation = default(CertificateStoreLocation?), string storeName = default(string), IList visibility = default(IList)) { Thumbprint = thumbprint; @@ -57,7 +57,7 @@ public CertificateReference() partial void CustomInit(); /// - /// Gets or sets the thumbprint of the certificate. + /// Gets or sets the thumbprint of the Certificate. /// [JsonProperty(PropertyName = "thumbprint")] public string Thumbprint { get; set; } @@ -70,33 +70,33 @@ public CertificateReference() public string ThumbprintAlgorithm { get; set; } /// - /// Gets or sets the location of the certificate store on the compute - /// node into which to install the certificate. + /// Gets or sets the location of the Certificate store on the Compute + /// Node into which to install the Certificate. /// /// /// The default value is currentuser. This property is applicable only - /// for pools configured with Windows nodes (that is, created with - /// cloudServiceConfiguration, or with virtualMachineConfiguration - /// using a Windows image reference). For Linux compute nodes, the - /// certificates are stored in a directory inside the task working + /// for Pools configured with Windows Compute Nodes (that is, created + /// with cloudServiceConfiguration, or with virtualMachineConfiguration + /// using a Windows Image reference). For Linux Compute Nodes, the + /// Certificates are stored in a directory inside the Task working /// directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is - /// supplied to the task to query for this location. For certificates + /// supplied to the Task to query for this location. For Certificates /// with visibility of 'remoteUser', a 'certs' directory is created in /// the user's home directory (e.g., /home/{user-name}/certs) and - /// certificates are placed in that directory. Possible values include: + /// Certificates are placed in that directory. Possible values include: /// 'currentUser', 'localMachine' /// [JsonProperty(PropertyName = "storeLocation")] public CertificateStoreLocation? StoreLocation { get; set; } /// - /// Gets or sets the name of the certificate store on the compute node - /// into which to install the certificate. + /// Gets or sets the name of the Certificate store on the Compute Node + /// into which to install the Certificate. /// /// - /// This property is applicable only for pools configured with Windows - /// nodes (that is, created with cloudServiceConfiguration, or with - /// virtualMachineConfiguration using a Windows image reference). + /// This property is applicable only for Pools configured with Windows + /// Compute Nodes (that is, created with cloudServiceConfiguration, or + /// with virtualMachineConfiguration using a Windows Image reference). /// Common store names include: My, Root, CA, Trust, Disallowed, /// TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any /// custom store name can also be used. The default value is My. @@ -105,12 +105,12 @@ public CertificateReference() public string StoreName { get; set; } /// - /// Gets or sets which user accounts on the compute node should have - /// access to the private data of the certificate. + /// Gets or sets which user Accounts on the Compute Node should have + /// access to the private data of the Certificate. /// /// /// You can specify more than one visibility in this collection. The - /// default is all accounts. + /// default is all Accounts. /// [JsonProperty(PropertyName = "visibility")] public IList Visibility { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateState.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateState.cs index 9fe2ef997094..d28487d80816 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateState.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateState.cs @@ -22,26 +22,26 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum CertificateState { /// - /// The certificate is available for use in pools. + /// The Certificate is available for use in Pools. /// [EnumMember(Value = "active")] Active, /// - /// The user has requested that the certificate be deleted, but the + /// The user has requested that the Certificate be deleted, but the /// delete operation has not yet completed. You may not reference the - /// certificate when creating or updating pools. + /// Certificate when creating or updating Pools. /// [EnumMember(Value = "deleting")] Deleting, /// - /// The user requested that the certificate be deleted, but there are - /// pools that still have references to the certificate, or it is still - /// installed on one or more compute nodes. (The latter can occur if - /// the certificate has been removed from the pool, but the node has - /// not yet restarted. Nodes refresh their certificates only when they - /// restart.) You may use the cancel certificate delete operation to - /// cancel the delete, or the delete certificate operation to retry the - /// delete. + /// The user requested that the Certificate be deleted, but there are + /// Pools that still have references to the Certificate, or it is still + /// installed on one or more Nodes. (The latter can occur if the + /// Certificate has been removed from the Pool, but the Compute Node + /// has not yet restarted. Compute Nodes refresh their Certificates + /// only when they restart.) You may use the cancel Certificate delete + /// operation to cancel the delete, or the delete Certificate operation + /// to retry the delete. /// [EnumMember(Value = "deletefailed")] DeleteFailed diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateStoreLocation.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateStoreLocation.cs index 65a925db7971..c7cc95073272 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateStoreLocation.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateStoreLocation.cs @@ -22,13 +22,13 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum CertificateStoreLocation { /// - /// Certificates should be installed to the CurrentUser certificate + /// Certificates should be installed to the CurrentUser Certificate /// store. /// [EnumMember(Value = "currentuser")] CurrentUser, /// - /// Certificates should be installed to the LocalMachine certificate + /// Certificates should be installed to the LocalMachine Certificate /// store. /// [EnumMember(Value = "localmachine")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateVisibility.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateVisibility.cs index 0a161f01798c..2600e5293789 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateVisibility.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CertificateVisibility.cs @@ -22,20 +22,22 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum CertificateVisibility { /// - /// The certificate should be visible to the user account under which - /// the start task is run. + /// The Certificate should be visible to the user account under which + /// the StartTask is run. Note that if AutoUser Scope is Pool for both + /// the StartTask and a Task, this certificate will be visible to the + /// Task as well. /// [EnumMember(Value = "starttask")] StartTask, /// - /// The certificate should be visible to the user accounts under which - /// job tasks are run. + /// The Certificate should be visible to the user accounts under which + /// Job Tasks are run. /// [EnumMember(Value = "task")] Task, /// - /// The certificate should be visible to the user accounts under which - /// users remotely access the node. + /// The Certificate should be visible to the user accounts under which + /// users remotely access the Compute Node. /// [EnumMember(Value = "remoteuser")] RemoteUser diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudJob.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudJob.cs index 6b45ae56972b..350c67da94d6 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudJob.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudJob.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// An Azure Batch job. + /// An Azure Batch Job. /// public partial class CloudJob { @@ -31,48 +31,48 @@ public CloudJob() /// /// Initializes a new instance of the CloudJob class. /// - /// A string that uniquely identifies the job within - /// the account. - /// The display name for the job. - /// Whether tasks in the job can + /// A string that uniquely identifies the Job within + /// the Account. + /// The display name for the Job. + /// Whether Tasks in the Job can /// define dependencies on each other. The default is false. - /// The URL of the job. - /// The ETag of the job. + /// The URL of the Job. + /// The ETag of the Job. /// The last modified time of the - /// job. - /// The creation time of the job. - /// The current state of the job. - /// The time at which the job entered + /// Job. + /// The creation time of the Job. + /// The current state of the Job. + /// The time at which the Job entered /// its current state. - /// The previous state of the job. - /// The time at which the job + /// The previous state of the Job. + /// The time at which the Job /// entered its previous state. - /// The priority of the job. + /// The priority of the Job. /// The execution constraints for the - /// job. - /// Details of a Job Manager task to be - /// launched when the job is started. - /// The Job Preparation task. - /// The Job Release task. + /// Job. + /// Details of a Job Manager Task to be + /// launched when the Job is started. + /// The Job Preparation Task. + /// The Job Release Task. /// The list of common /// environment variable settings. These environment variables are set - /// for all tasks in the job (including the Job Manager, Job - /// Preparation and Job Release tasks). - /// The pool settings associated with the - /// job. + /// for all Tasks in the Job (including the Job Manager, Job + /// Preparation and Job Release Tasks). + /// The Pool settings associated with the + /// Job. /// The action the Batch service - /// should take when all tasks in the job are in the completed + /// should take when all Tasks in the Job are in the completed /// state. /// The action the Batch service should - /// take when any task in the job fails. + /// take when any Task in the Job fails. /// The network configuration for - /// the job. + /// the Job. /// A list of name-value pairs associated with - /// the job as metadata. + /// the Job as metadata. /// The execution information for the - /// job. + /// Job. /// Resource usage statistics for the entire - /// lifetime of the job. + /// lifetime of the Job. 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?), JobNetworkConfiguration networkConfiguration = default(JobNetworkConfiguration), IList metadata = default(IList), JobExecutionInformation executionInfo = default(JobExecutionInformation), JobStatistics stats = default(JobStatistics)) { Id = id; @@ -108,66 +108,66 @@ public CloudJob() partial void CustomInit(); /// - /// Gets or sets a string that uniquely identifies the job within the - /// account. + /// Gets or sets a string that uniquely identifies the Job within the + /// Account. /// /// /// The ID is case-preserving and case-insensitive (that is, you may - /// not have two IDs within an account that differ only by case). + /// not have two IDs within an Account that differ only by case). /// [JsonProperty(PropertyName = "id")] public string Id { get; set; } /// - /// Gets or sets the display name for the job. + /// Gets or sets the display name for the Job. /// [JsonProperty(PropertyName = "displayName")] public string DisplayName { get; set; } /// - /// Gets or sets whether tasks in the job can define dependencies on + /// Gets or sets whether Tasks in the Job can define dependencies on /// each other. The default is false. /// [JsonProperty(PropertyName = "usesTaskDependencies")] public bool? UsesTaskDependencies { get; set; } /// - /// Gets or sets the URL of the job. + /// Gets or sets the URL of the Job. /// [JsonProperty(PropertyName = "url")] public string Url { get; set; } /// - /// Gets or sets the ETag of the job. + /// Gets or sets the ETag of the Job. /// /// - /// This is an opaque string. You can use it to detect whether the job + /// This is an opaque string. You can use it to detect whether the Job /// has changed between requests. In particular, you can be pass the - /// ETag when updating a job to specify that your changes should take - /// effect only if nobody else has modified the job in the meantime. + /// ETag when updating a Job to specify that your changes should take + /// effect only if nobody else has modified the Job in the meantime. /// [JsonProperty(PropertyName = "eTag")] public string ETag { get; set; } /// - /// Gets or sets the last modified time of the job. + /// Gets or sets the last modified time of the Job. /// /// - /// This is the last time at which the job level data, such as the job + /// This is the last time at which the Job level data, such as the Job /// state or priority, changed. It does not factor in task-level - /// changes such as adding new tasks or tasks changing state. + /// changes such as adding new Tasks or Tasks changing state. /// [JsonProperty(PropertyName = "lastModified")] public System.DateTime? LastModified { get; set; } /// - /// Gets or sets the creation time of the job. + /// Gets or sets the creation time of the Job. /// [JsonProperty(PropertyName = "creationTime")] public System.DateTime? CreationTime { get; set; } /// - /// Gets or sets the current state of the job. + /// Gets or sets the current state of the Job. /// /// /// Possible values include: 'active', 'disabling', 'disabled', @@ -177,16 +177,16 @@ public CloudJob() public JobState? State { get; set; } /// - /// Gets or sets the time at which the job entered its current state. + /// Gets or sets the time at which the Job entered its current state. /// [JsonProperty(PropertyName = "stateTransitionTime")] public System.DateTime? StateTransitionTime { get; set; } /// - /// Gets or sets the previous state of the job. + /// Gets or sets the previous state of the Job. /// /// - /// This property is not set if the job is in its initial Active state. + /// This property is not set if the Job is in its initial Active state. /// Possible values include: 'active', 'disabling', 'disabled', /// 'enabling', 'terminating', 'completed', 'deleting' /// @@ -194,16 +194,16 @@ public CloudJob() public JobState? PreviousState { get; set; } /// - /// Gets or sets the time at which the job entered its previous state. + /// Gets or sets the time at which the Job entered its previous state. /// /// - /// This property is not set if the job is in its initial Active state. + /// This property is not set if the Job is in its initial Active state. /// [JsonProperty(PropertyName = "previousStateTransitionTime")] public System.DateTime? PreviousStateTransitionTime { get; set; } /// - /// Gets or sets the priority of the job. + /// Gets or sets the priority of the Job. /// /// /// Priority values can range from -1000 to 1000, with -1000 being the @@ -214,59 +214,59 @@ public CloudJob() public int? Priority { get; set; } /// - /// Gets or sets the execution constraints for the job. + /// Gets or sets the execution constraints for the Job. /// [JsonProperty(PropertyName = "constraints")] public JobConstraints Constraints { get; set; } /// - /// Gets or sets details of a Job Manager task to be launched when the - /// job is started. + /// Gets or sets details of a Job Manager Task to be launched when the + /// Job is started. /// [JsonProperty(PropertyName = "jobManagerTask")] public JobManagerTask JobManagerTask { get; set; } /// - /// Gets or sets the Job Preparation task. + /// Gets or sets the Job Preparation Task. /// /// - /// The Job Preparation task is a special task run on each node before - /// any other task of the job. + /// The Job Preparation Task is a special Task run on each Compute Node + /// before any other Task of the Job. /// [JsonProperty(PropertyName = "jobPreparationTask")] public JobPreparationTask JobPreparationTask { get; set; } /// - /// Gets or sets the Job Release task. + /// Gets or sets the Job Release Task. /// /// - /// The Job Release task is a special task run at the end of the job on - /// each node that has run any other task of the job. + /// The Job Release Task is a special Task run at the end of the Job on + /// each Compute Node that has run any other Task of the Job. /// [JsonProperty(PropertyName = "jobReleaseTask")] public JobReleaseTask JobReleaseTask { get; set; } /// /// Gets or sets the list of common environment variable settings. - /// These environment variables are set for all tasks in the job - /// (including the Job Manager, Job Preparation and Job Release tasks). + /// These environment variables are set for all Tasks in the Job + /// (including the Job Manager, Job Preparation and Job Release Tasks). /// /// - /// Individual tasks can override an environment setting specified here + /// Individual Tasks can override an environment setting specified here /// by specifying the same setting name with a different value. /// [JsonProperty(PropertyName = "commonEnvironmentSettings")] public IList CommonEnvironmentSettings { get; set; } /// - /// Gets or sets the pool settings associated with the job. + /// Gets or sets the Pool settings associated with the Job. /// [JsonProperty(PropertyName = "poolInfo")] public PoolInformation PoolInfo { get; set; } /// /// Gets or sets the action the Batch service should take when all - /// tasks in the job are in the completed state. + /// Tasks in the Job are in the completed state. /// /// /// The default is noaction. Possible values include: 'noAction', @@ -276,14 +276,14 @@ public CloudJob() public OnAllTasksComplete? OnAllTasksComplete { get; set; } /// - /// Gets or sets the action the Batch service should take when any task - /// in the job fails. + /// Gets or sets the action the Batch service should take when any Task + /// in the Job fails. /// /// - /// A task is considered to have failed if has a failureInfo. A - /// failureInfo is set if the task completes with a non-zero exit code + /// A Task is considered to have failed if has a failureInfo. A + /// failureInfo is set if the Task completes with a non-zero exit code /// after exhausting its retry count, or if there was an error starting - /// the task, for example due to a resource file download error. The + /// the Task, for example due to a resource file download error. The /// default is noaction. Possible values include: 'noAction', /// 'performExitOptionsJobAction' /// @@ -291,13 +291,13 @@ public CloudJob() public OnTaskFailure? OnTaskFailure { get; set; } /// - /// Gets or sets the network configuration for the job. + /// Gets or sets the network configuration for the Job. /// [JsonProperty(PropertyName = "networkConfiguration")] public JobNetworkConfiguration NetworkConfiguration { get; set; } /// - /// Gets or sets a list of name-value pairs associated with the job as + /// Gets or sets a list of name-value pairs associated with the Job as /// metadata. /// /// @@ -308,14 +308,14 @@ public CloudJob() public IList Metadata { get; set; } /// - /// Gets or sets the execution information for the job. + /// Gets or sets the execution information for the Job. /// [JsonProperty(PropertyName = "executionInfo")] public JobExecutionInformation ExecutionInfo { get; set; } /// /// Gets or sets resource usage statistics for the entire lifetime of - /// the job. + /// the Job. /// /// /// This property is populated only if the CloudJob was retrieved with diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudJobSchedule.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudJobSchedule.cs index d7c6f9c12209..39db9a24bf79 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudJobSchedule.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudJobSchedule.cs @@ -16,8 +16,8 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// A job schedule that allows recurring jobs by specifying when to run - /// jobs and a specification used to create each job. + /// A Job Schedule that allows recurring Jobs by specifying when to run + /// Jobs and a specification used to create each Job. /// public partial class CloudJobSchedule { @@ -33,32 +33,32 @@ public CloudJobSchedule() /// Initializes a new instance of the CloudJobSchedule class. /// /// A string that uniquely identifies the schedule - /// within the account. + /// within the Account. /// The display name for the /// schedule. - /// The URL of the job schedule. - /// The ETag of the job schedule. - /// The last modified time of the job - /// schedule. - /// The creation time of the job - /// schedule. - /// The current state of the job schedule. - /// The time at which the job - /// schedule entered the current state. - /// The previous state of the job - /// schedule. - /// The time at which the job - /// schedule entered its previous state. - /// The schedule according to which jobs will be + /// The URL of the Job Schedule. + /// The ETag of the Job Schedule. + /// The last modified time of the Job + /// Schedule. + /// The creation time of the Job + /// Schedule. + /// The current state of the Job Schedule. + /// The time at which the Job + /// Schedule entered the current state. + /// The previous state of the Job + /// Schedule. + /// The time at which the Job + /// Schedule entered its previous state. + /// The schedule according to which Jobs will be /// created. - /// The details of the jobs to be + /// The details of the Jobs to be /// created on this schedule. - /// Information about jobs that have been + /// Information about Jobs that have been /// and will be run under this schedule. /// A list of name-value pairs associated with /// the schedule as metadata. /// The lifetime resource usage statistics for the - /// job schedule. The statistics may not be immediately available. The + /// 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)) @@ -88,7 +88,7 @@ public CloudJobSchedule() /// /// Gets or sets a string that uniquely identifies the schedule within - /// the account. + /// the Account. /// [JsonProperty(PropertyName = "id")] public string Id { get; set; } @@ -100,17 +100,17 @@ public CloudJobSchedule() public string DisplayName { get; set; } /// - /// Gets or sets the URL of the job schedule. + /// Gets or sets the URL of the Job Schedule. /// [JsonProperty(PropertyName = "url")] public string Url { get; set; } /// - /// Gets or sets the ETag of the job schedule. + /// Gets or sets the ETag of the Job Schedule. /// /// - /// This is an opaque string. You can use it to detect whether the job - /// schedule has changed between requests. In particular, you can be + /// This is an opaque string. You can use it to detect whether the Job + /// Schedule has changed between requests. In particular, you can be /// pass the ETag with an Update Job Schedule request to specify that /// your changes should take effect only if nobody else has modified /// the schedule in the meantime. @@ -119,25 +119,25 @@ public CloudJobSchedule() public string ETag { get; set; } /// - /// Gets or sets the last modified time of the job schedule. + /// Gets or sets the last modified time of the Job Schedule. /// /// /// This is the last time at which the schedule level data, such as the - /// job specification or recurrence information, changed. It does not - /// factor in job-level changes such as new jobs being created or jobs + /// Job specification or recurrence information, changed. It does not + /// factor in job-level changes such as new Jobs being created or Jobs /// changing state. /// [JsonProperty(PropertyName = "lastModified")] public System.DateTime? LastModified { get; set; } /// - /// Gets or sets the creation time of the job schedule. + /// Gets or sets the creation time of the Job Schedule. /// [JsonProperty(PropertyName = "creationTime")] public System.DateTime? CreationTime { get; set; } /// - /// Gets or sets the current state of the job schedule. + /// Gets or sets the current state of the Job Schedule. /// /// /// Possible values include: 'active', 'completed', 'disabled', @@ -147,17 +147,17 @@ public CloudJobSchedule() public JobScheduleState? State { get; set; } /// - /// Gets or sets the time at which the job schedule entered the current + /// Gets or sets the time at which the Job Schedule entered the current /// state. /// [JsonProperty(PropertyName = "stateTransitionTime")] public System.DateTime? StateTransitionTime { get; set; } /// - /// Gets or sets the previous state of the job schedule. + /// Gets or sets the previous state of the Job Schedule. /// /// - /// This property is not present if the job schedule is in its initial + /// This property is not present if the Job Schedule is in its initial /// active state. Possible values include: 'active', 'completed', /// 'disabled', 'terminating', 'deleting' /// @@ -165,31 +165,31 @@ public CloudJobSchedule() public JobScheduleState? PreviousState { get; set; } /// - /// Gets or sets the time at which the job schedule entered its + /// Gets or sets the time at which the Job Schedule entered its /// previous state. /// /// - /// This property is not present if the job schedule is in its initial + /// This property is not present if the Job Schedule is in its initial /// active state. /// [JsonProperty(PropertyName = "previousStateTransitionTime")] public System.DateTime? PreviousStateTransitionTime { get; set; } /// - /// Gets or sets the schedule according to which jobs will be created. + /// Gets or sets the schedule according to which Jobs will be created. /// [JsonProperty(PropertyName = "schedule")] public Schedule Schedule { get; set; } /// - /// Gets or sets the details of the jobs to be created on this + /// Gets or sets the details of the Jobs to be created on this /// schedule. /// [JsonProperty(PropertyName = "jobSpecification")] public JobSpecification JobSpecification { get; set; } /// - /// Gets or sets information about jobs that have been and will be run + /// Gets or sets information about Jobs that have been and will be run /// under this schedule. /// [JsonProperty(PropertyName = "executionInfo")] @@ -207,8 +207,8 @@ public CloudJobSchedule() public IList Metadata { get; set; } /// - /// Gets or sets the lifetime resource usage statistics for the job - /// schedule. The statistics may not be immediately available. The + /// Gets or sets the lifetime resource usage statistics for the 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. /// diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudPool.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudPool.cs index 7f55a51903fb..56ecdf4c18c2 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudPool.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudPool.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// A pool in the Azure Batch service. + /// A Pool in the Azure Batch service. /// public partial class CloudPool { @@ -31,71 +31,73 @@ public CloudPool() /// /// Initializes a new instance of the CloudPool class. /// - /// A string that uniquely identifies the pool within - /// the account. - /// The display name for the pool. - /// The URL of the pool. - /// The ETag of the pool. + /// A string that uniquely identifies the Pool within + /// the Account. + /// The display name for the Pool. + /// The URL of the Pool. + /// The ETag of the Pool. /// The last modified time of the - /// pool. - /// The creation time of the pool. - /// The current state of the pool. - /// The time at which the pool + /// Pool. + /// The creation time of the Pool. + /// The current state of the Pool. + /// The time at which the Pool /// entered its current state. - /// Whether the pool is resizing. + /// Whether the Pool is resizing. /// The time at which the - /// pool entered its current allocation state. - /// The size of virtual machines in the pool. All - /// virtual machines in a pool are the same size. + /// Pool entered its current allocation state. + /// The size of virtual machines in the Pool. All + /// virtual machines in a Pool are the same size. /// The cloud service - /// configuration for the pool. + /// configuration for the Pool. /// The virtual machine - /// configuration for the pool. - /// The timeout for allocation of compute - /// nodes to the pool. + /// configuration for the Pool. + /// The timeout for allocation of Compute + /// Nodes to the Pool. /// A list of errors encountered while - /// performing the last resize on the pool. - /// The number of dedicated compute - /// nodes currently in the pool. + /// performing the last resize on the Pool. + /// The number of dedicated Compute + /// Nodes currently in the Pool. /// The number of low-priority - /// compute nodes currently in the pool. + /// Compute Nodes currently in the Pool. /// The desired number of dedicated - /// compute nodes in the pool. + /// Compute Nodes in the Pool. /// The desired number of - /// low-priority compute nodes in the pool. - /// Whether the pool size should + /// low-priority Compute Nodes in the Pool. + /// Whether the Pool size should /// automatically adjust over time. /// A formula for the desired number of - /// compute nodes in the pool. + /// Compute Nodes in the Pool. /// The time interval at - /// which to automatically adjust the pool size according to the + /// which to automatically adjust the Pool size according to the /// autoscale formula. /// The results and errors from the last /// execution of the autoscale formula. - /// Whether the pool permits - /// direct communication between nodes. + /// Whether the Pool permits + /// direct communication between Compute Nodes. /// The network configuration for - /// the pool. - /// A task specified to run on each compute - /// node as it joins the pool. - /// The list of certificates to be - /// installed on each compute node in the pool. - /// The list of application - /// packages to be installed on each compute node in the pool. + /// the Pool. + /// A Task specified to run on each Compute + /// Node as it joins the Pool. + /// The list of Certificates to be + /// installed on each Compute Node in the Pool. + /// The list of Packages to + /// be installed on each Compute Node in the Pool. /// The list of application licenses - /// the Batch service will make available on each compute node in the - /// pool. - /// The maximum number of tasks that can - /// run concurrently on a single compute node in the pool. - /// How tasks are distributed across - /// compute nodes in a pool. - /// The list of user accounts to be created - /// on each node in the pool. + /// the Batch service will make available on each Compute Node in the + /// Pool. + /// The maximum number of Tasks that can + /// run concurrently on a single Compute Node in the Pool. + /// How Tasks are distributed across + /// Compute Nodes in a Pool. + /// The list of user Accounts to be created + /// on each Compute Node in the Pool. /// A list of name-value pairs associated with - /// the pool as metadata. + /// the Pool as metadata. /// Utilization and resource usage statistics for - /// the entire lifetime of the pool. - 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)) + /// the entire lifetime of the Pool. + /// A list of file systems to mount on + /// each node in the pool. + 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), IList mountConfiguration = default(IList)) { Id = id; DisplayName = displayName; @@ -131,6 +133,7 @@ public CloudPool() UserAccounts = userAccounts; Metadata = metadata; Stats = stats; + MountConfiguration = mountConfiguration; CustomInit(); } @@ -140,21 +143,21 @@ public CloudPool() partial void CustomInit(); /// - /// Gets or sets a string that uniquely identifies the pool within the - /// account. + /// Gets or sets a string that uniquely identifies the Pool within the + /// Account. /// /// /// The ID can contain any combination of alphanumeric characters /// including hyphens and underscores, and cannot contain more than 64 /// characters. The ID is case-preserving and case-insensitive (that - /// is, you may not have two IDs within an account that differ only by + /// is, you may not have two IDs within an Account that differ only by /// case). /// [JsonProperty(PropertyName = "id")] public string Id { get; set; } /// - /// Gets or sets the display name for the pool. + /// Gets or sets the display name for the Pool. /// /// /// The display name need not be unique and can contain any Unicode @@ -164,43 +167,43 @@ public CloudPool() public string DisplayName { get; set; } /// - /// Gets or sets the URL of the pool. + /// Gets or sets the URL of the Pool. /// [JsonProperty(PropertyName = "url")] public string Url { get; set; } /// - /// Gets or sets the ETag of the pool. + /// Gets or sets the ETag of the Pool. /// /// - /// This is an opaque string. You can use it to detect whether the pool + /// This is an opaque string. You can use it to detect whether the Pool /// has changed between requests. In particular, you can be pass the - /// ETag when updating a pool to specify that your changes should take - /// effect only if nobody else has modified the pool in the meantime. + /// ETag when updating a Pool to specify that your changes should take + /// effect only if nobody else has modified the Pool in the meantime. /// [JsonProperty(PropertyName = "eTag")] public string ETag { get; set; } /// - /// Gets or sets the last modified time of the pool. + /// Gets or sets the last modified time of the Pool. /// /// - /// This is the last time at which the pool level data, such as the + /// This is the last time at which the Pool level data, such as the /// targetDedicatedNodes or enableAutoscale settings, changed. It does - /// not factor in node-level changes such as a compute node changing + /// not factor in node-level changes such as a Compute Node changing /// state. /// [JsonProperty(PropertyName = "lastModified")] public System.DateTime? LastModified { get; set; } /// - /// Gets or sets the creation time of the pool. + /// Gets or sets the creation time of the Pool. /// [JsonProperty(PropertyName = "creationTime")] public System.DateTime? CreationTime { get; set; } /// - /// Gets or sets the current state of the pool. + /// Gets or sets the current state of the Pool. /// /// /// Possible values include: 'active', 'deleting' @@ -209,13 +212,13 @@ public CloudPool() public PoolState? State { get; set; } /// - /// Gets or sets the time at which the pool entered its current state. + /// Gets or sets the time at which the Pool entered its current state. /// [JsonProperty(PropertyName = "stateTransitionTime")] public System.DateTime? StateTransitionTime { get; set; } /// - /// Gets or sets whether the pool is resizing. + /// Gets or sets whether the Pool is resizing. /// /// /// Possible values include: 'steady', 'resizing', 'stopping' @@ -224,38 +227,38 @@ public CloudPool() public AllocationState? AllocationState { get; set; } /// - /// Gets or sets the time at which the pool entered its current + /// Gets or sets the time at which the Pool entered its current /// allocation state. /// [JsonProperty(PropertyName = "allocationStateTransitionTime")] public System.DateTime? AllocationStateTransitionTime { get; set; } /// - /// Gets or sets the size of virtual machines in the pool. All virtual - /// machines in a pool are the same size. + /// Gets or sets the size of virtual machines in the Pool. All virtual + /// machines in a Pool are the same size. /// /// - /// For information about available sizes of virtual machines in pools, - /// see Choose a VM size for compute nodes in an Azure Batch pool + /// For information about available sizes of virtual machines in Pools, + /// see Choose a VM size for Compute Nodes in an Azure Batch Pool /// (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). /// [JsonProperty(PropertyName = "vmSize")] public string VmSize { get; set; } /// - /// Gets or sets the cloud service configuration for the pool. + /// Gets or sets the cloud service configuration for the Pool. /// /// /// This property and virtualMachineConfiguration are mutually /// exclusive and one of the properties must be specified. This - /// property cannot be specified if the Batch account was created with + /// property cannot be specified if the Batch Account was created with /// its poolAllocationMode property set to 'UserSubscription'. /// [JsonProperty(PropertyName = "cloudServiceConfiguration")] public CloudServiceConfiguration CloudServiceConfiguration { get; set; } /// - /// Gets or sets the virtual machine configuration for the pool. + /// Gets or sets the virtual machine configuration for the Pool. /// /// /// This property and cloudServiceConfiguration are mutually exclusive @@ -265,12 +268,12 @@ public CloudPool() public VirtualMachineConfiguration VirtualMachineConfiguration { get; set; } /// - /// Gets or sets the timeout for allocation of compute nodes to the - /// pool. + /// Gets or sets the timeout for allocation of Compute Nodes to the + /// Pool. /// /// /// This is the timeout for the most recent resize operation. (The - /// initial sizing when the pool is created counts as a resize.) The + /// initial sizing when the Pool is created counts as a resize.) The /// default value is 15 minutes. /// [JsonProperty(PropertyName = "resizeTimeout")] @@ -278,66 +281,66 @@ public CloudPool() /// /// Gets or sets a list of errors encountered while performing the last - /// resize on the pool. + /// resize on the Pool. /// /// /// This property is set only if one or more errors occurred during the - /// last pool resize, and only when the pool allocationState is Steady. + /// last Pool resize, and only when the Pool allocationState is Steady. /// [JsonProperty(PropertyName = "resizeErrors")] public IList ResizeErrors { get; set; } /// - /// Gets or sets the number of dedicated compute nodes currently in the - /// pool. + /// Gets or sets the number of dedicated Compute Nodes currently in the + /// Pool. /// [JsonProperty(PropertyName = "currentDedicatedNodes")] public int? CurrentDedicatedNodes { get; set; } /// - /// Gets or sets the number of low-priority compute nodes currently in - /// the pool. + /// Gets or sets the number of low-priority Compute Nodes currently in + /// the Pool. /// /// - /// Low-priority compute nodes which have been preempted are included + /// Low-priority Compute Nodes which have been preempted are included /// in this count. /// [JsonProperty(PropertyName = "currentLowPriorityNodes")] public int? CurrentLowPriorityNodes { get; set; } /// - /// Gets or sets the desired number of dedicated compute nodes in the - /// pool. + /// Gets or sets the desired number of dedicated Compute Nodes in the + /// Pool. /// [JsonProperty(PropertyName = "targetDedicatedNodes")] public int? TargetDedicatedNodes { get; set; } /// - /// Gets or sets the desired number of low-priority compute nodes in - /// the pool. + /// Gets or sets the desired number of low-priority Compute Nodes in + /// the Pool. /// [JsonProperty(PropertyName = "targetLowPriorityNodes")] public int? TargetLowPriorityNodes { get; set; } /// - /// Gets or sets whether the pool size should automatically adjust over + /// Gets or sets whether the Pool size should automatically adjust over /// time. /// /// /// If false, at least one of targetDedicateNodes and /// targetLowPriorityNodes must be specified. If true, the - /// autoScaleFormula property is required and the pool automatically + /// autoScaleFormula property is required and the Pool automatically /// resizes according to the formula. The default value is false. /// [JsonProperty(PropertyName = "enableAutoScale")] public bool? EnableAutoScale { get; set; } /// - /// Gets or sets a formula for the desired number of compute nodes in - /// the pool. + /// Gets or sets a formula for the desired number of Compute Nodes in + /// the Pool. /// /// - /// This property is set only if the pool automatically scales, i.e. + /// This property is set only if the Pool automatically scales, i.e. /// enableAutoScale is true. /// [JsonProperty(PropertyName = "autoScaleFormula")] @@ -345,10 +348,10 @@ public CloudPool() /// /// Gets or sets the time interval at which to automatically adjust the - /// pool size according to the autoscale formula. + /// Pool size according to the autoscale formula. /// /// - /// This property is set only if the pool automatically scales, i.e. + /// This property is set only if the Pool automatically scales, i.e. /// enableAutoScale is true. /// [JsonProperty(PropertyName = "autoScaleEvaluationInterval")] @@ -359,107 +362,110 @@ public CloudPool() /// autoscale formula. /// /// - /// This property is set only if the pool automatically scales, i.e. + /// This property is set only if the Pool automatically scales, i.e. /// enableAutoScale is true. /// [JsonProperty(PropertyName = "autoScaleRun")] public AutoScaleRun AutoScaleRun { get; set; } /// - /// Gets or sets whether the pool permits direct communication between - /// nodes. + /// Gets or sets whether the Pool permits direct communication between + /// Compute Nodes. /// /// - /// This imposes restrictions on which nodes can be assigned to the - /// pool. Specifying this value can reduce the chance of the requested - /// number of nodes to be allocated in the pool. + /// This imposes restrictions on which Compute Nodes can be assigned to + /// the Pool. Specifying this value can reduce the chance of the + /// requested number of Compute Nodes to be allocated in the Pool. /// [JsonProperty(PropertyName = "enableInterNodeCommunication")] public bool? EnableInterNodeCommunication { get; set; } /// - /// Gets or sets the network configuration for the pool. + /// Gets or sets the network configuration for the Pool. /// [JsonProperty(PropertyName = "networkConfiguration")] public NetworkConfiguration NetworkConfiguration { get; set; } /// - /// Gets or sets a task specified to run on each compute node as it - /// joins the pool. + /// Gets or sets a Task specified to run on each Compute Node as it + /// joins the Pool. /// [JsonProperty(PropertyName = "startTask")] public StartTask StartTask { get; set; } /// - /// Gets or sets the list of certificates to be installed on each - /// compute node in the pool. + /// Gets or sets the list of Certificates to be installed on each + /// Compute Node in the Pool. /// /// - /// For Windows compute nodes, the Batch service installs the - /// certificates to the specified certificate store and location. For - /// Linux compute nodes, the certificates are stored in a directory - /// inside the task working directory and an environment variable - /// AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this - /// location. For certificates with visibility of 'remoteUser', a + /// For Windows Nodes, the Batch service installs the Certificates to + /// the specified Certificate store and location. For Linux Compute + /// Nodes, the Certificates are stored in a directory inside the Task + /// working directory and an environment variable + /// AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this + /// location. For Certificates with visibility of 'remoteUser', a /// 'certs' directory is created in the user's home directory (e.g., - /// /home/{user-name}/certs) and certificates are placed in that + /// /home/{user-name}/certs) and Certificates are placed in that /// directory. /// [JsonProperty(PropertyName = "certificateReferences")] public IList CertificateReferences { get; set; } /// - /// Gets or sets the list of application packages to be installed on - /// each compute node in the pool. + /// Gets or sets the list of Packages to be installed on each Compute + /// Node in the Pool. /// /// - /// Changes to application package references affect all new compute - /// nodes joining the pool, but do not affect compute nodes that are - /// already in the pool until they are rebooted or reimaged. There is a - /// maximum of 10 application package references on any given pool. + /// Changes to Package references affect all new Nodes joining the + /// Pool, but do not affect Compute Nodes that are already in the Pool + /// until they are rebooted or reimaged. There is a maximum of 10 + /// Package references on any given Pool. /// [JsonProperty(PropertyName = "applicationPackageReferences")] public IList ApplicationPackageReferences { get; set; } /// /// Gets or sets the list of application licenses the Batch service - /// will make available on each compute node in the pool. + /// will make available on each Compute Node in the Pool. /// /// /// The list of application licenses must be a subset of available /// Batch service application licenses. If a license is requested which - /// is not supported, pool creation will fail. + /// is not supported, Pool creation will fail. /// [JsonProperty(PropertyName = "applicationLicenses")] public IList ApplicationLicenses { get; set; } /// - /// Gets or sets the maximum number of tasks that can run concurrently - /// on a single compute node in the pool. + /// Gets or sets the maximum number of Tasks that can run concurrently + /// on a single Compute Node in the Pool. /// /// /// The default value is 1. The maximum value is the smaller of 4 times - /// the number of cores of the vmSize of the pool or 256. + /// the number of cores of the vmSize of the Pool or 256. /// [JsonProperty(PropertyName = "maxTasksPerNode")] public int? MaxTasksPerNode { get; set; } /// - /// Gets or sets how tasks are distributed across compute nodes in a - /// pool. + /// Gets or sets how Tasks are distributed across Compute Nodes in a + /// Pool. /// + /// + /// If not specified, the default is spread. + /// [JsonProperty(PropertyName = "taskSchedulingPolicy")] public TaskSchedulingPolicy TaskSchedulingPolicy { get; set; } /// - /// Gets or sets the list of user accounts to be created on each node - /// in the pool. + /// Gets or sets the list of user Accounts to be created on each + /// Compute Node in the Pool. /// [JsonProperty(PropertyName = "userAccounts")] public IList UserAccounts { get; set; } /// - /// Gets or sets a list of name-value pairs associated with the pool as + /// Gets or sets a list of name-value pairs associated with the Pool as /// metadata. /// [JsonProperty(PropertyName = "metadata")] @@ -467,7 +473,7 @@ public CloudPool() /// /// Gets or sets utilization and resource usage statistics for the - /// entire lifetime of the pool. + /// entire lifetime of the Pool. /// /// /// This property is populated only if the CloudPool was retrieved with @@ -479,5 +485,15 @@ public CloudPool() [JsonProperty(PropertyName = "stats")] public PoolStatistics Stats { get; set; } + /// + /// Gets or sets a list of file systems to mount on each node in the + /// pool. + /// + /// + /// This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. + /// + [JsonProperty(PropertyName = "mountConfiguration")] + public IList MountConfiguration { get; set; } + } } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudServiceConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudServiceConfiguration.cs index 657923f5e50a..5cb44e39547a 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudServiceConfiguration.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudServiceConfiguration.cs @@ -14,8 +14,8 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The configuration for nodes in a pool based on the Azure Cloud Services - /// platform. + /// The configuration for Compute Nodes in a Pool based on the Azure Cloud + /// Services platform. /// public partial class CloudServiceConfiguration { @@ -31,9 +31,9 @@ public CloudServiceConfiguration() /// Initializes a new instance of the CloudServiceConfiguration class. /// /// The Azure Guest OS family to be installed on - /// the virtual machines in the pool. + /// the virtual machines in the Pool. /// The Azure Guest OS version to be installed - /// on the virtual machines in the pool. + /// on the virtual machines in the Pool. public CloudServiceConfiguration(string osFamily, string osVersion = default(string)) { OsFamily = osFamily; @@ -48,7 +48,7 @@ public CloudServiceConfiguration() /// /// Gets or sets the Azure Guest OS family to be installed on the - /// virtual machines in the pool. + /// virtual machines in the Pool. /// /// /// Possible values are: @@ -65,7 +65,7 @@ public CloudServiceConfiguration() /// /// Gets or sets the Azure Guest OS version to be installed on the - /// virtual machines in the pool. + /// virtual machines in the Pool. /// /// /// The default value is * which specifies the latest operating system diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudTask.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudTask.cs index 5f1d3b28730a..6ca95e1d17de 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudTask.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudTask.cs @@ -16,20 +16,19 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// An Azure Batch task. + /// 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. + /// Batch will retry Tasks when a recovery operation is triggered on a + /// Node. Examples of recovery operations include (but are not limited to) + /// when an unhealthy 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 { @@ -44,55 +43,55 @@ public CloudTask() /// /// Initializes a new instance of the CloudTask class. /// - /// A string that uniquely identifies the task within - /// the job. - /// A display name for the task. - /// The URL of the task. - /// The ETag of the task. + /// A string that uniquely identifies the Task within + /// the Job. + /// A display name for the Task. + /// The URL of the Task. + /// The ETag of the Task. /// The last modified time of the - /// task. - /// The creation time of the task. + /// Task. + /// The creation time of the Task. /// How the Batch service should respond - /// when the task completes. - /// The current state of the task. - /// The time at which the task + /// when the Task completes. + /// The current state of the Task. + /// The time at which the Task /// entered its current state. - /// The previous state of the task. + /// The previous state of the Task. /// The time at which the - /// task entered its previous state. - /// The command line of the task. + /// Task entered its previous state. + /// The command line of the Task. /// The settings for the container - /// under which the task runs. + /// under which the Task runs. /// A list of files that the Batch service - /// will download to the compute node before running the command + /// will download to the Compute Node before running the command /// line. /// A list of files that the Batch service - /// will upload from the compute node after running the command + /// will upload from the Compute Node after running the command /// line. /// A list of environment variable - /// settings for the task. + /// settings for the Task. /// A locality hint that can be used by the - /// Batch service to select a compute node on which to start the new - /// task. + /// Batch service to select a Compute Node on which to start the new + /// Task. /// The execution constraints that apply to - /// this task. - /// The user identity under which the task + /// this Task. + /// The user identity under which the Task /// runs. /// Information about the execution of the - /// task. - /// Information about the compute node on which - /// the task ran. + /// Task. + /// Information about the Compute Node on which + /// the Task ran. /// An object that indicates that - /// the task is a multi-instance task, and contains information about - /// how to run the multi-instance task. - /// Resource usage statistics for the task. - /// The tasks that this task depends + /// the Task is a multi-instance Task, and contains information about + /// how to run the multi-instance Task. + /// Resource usage statistics for the Task. + /// The Tasks that this Task depends /// on. - /// A list of application - /// packages that the Batch service will deploy to the compute node - /// before running the command line. + /// A list of Packages that + /// the Batch service will deploy to the Compute Node before running + /// the command line. /// The settings for an - /// authentication token that the task can use to perform Batch service + /// authentication token that the Task can use to perform Batch service /// operations. public CloudTask(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?), ExitConditions exitConditions = default(ExitConditions), TaskState? state = default(TaskState?), System.DateTime? stateTransitionTime = default(System.DateTime?), TaskState? previousState = default(TaskState?), System.DateTime? previousStateTransitionTime = default(System.DateTime?), string commandLine = default(string), TaskContainerSettings containerSettings = default(TaskContainerSettings), IList resourceFiles = default(IList), IList outputFiles = default(IList), IList environmentSettings = default(IList), AffinityInformation affinityInfo = default(AffinityInformation), TaskConstraints constraints = default(TaskConstraints), UserIdentity userIdentity = default(UserIdentity), TaskExecutionInformation executionInfo = default(TaskExecutionInformation), ComputeNodeInformation nodeInfo = default(ComputeNodeInformation), MultiInstanceSettings multiInstanceSettings = default(MultiInstanceSettings), TaskStatistics stats = default(TaskStatistics), TaskDependencies dependsOn = default(TaskDependencies), IList applicationPackageReferences = default(IList), AuthenticationTokenSettings authenticationTokenSettings = default(AuthenticationTokenSettings)) { @@ -131,8 +130,8 @@ public CloudTask() partial void CustomInit(); /// - /// Gets or sets a string that uniquely identifies the task within the - /// job. + /// Gets or sets a string that uniquely identifies the Task within the + /// Job. /// /// /// The ID can contain any combination of alphanumeric characters @@ -143,7 +142,7 @@ public CloudTask() public string Id { get; set; } /// - /// Gets or sets a display name for the task. + /// Gets or sets a display name for the Task. /// /// /// The display name need not be unique and can contain any Unicode @@ -153,44 +152,44 @@ public CloudTask() public string DisplayName { get; set; } /// - /// Gets or sets the URL of the task. + /// Gets or sets the URL of the Task. /// [JsonProperty(PropertyName = "url")] public string Url { get; set; } /// - /// Gets or sets the ETag of the task. + /// Gets or sets the ETag of the Task. /// /// - /// This is an opaque string. You can use it to detect whether the task + /// This is an opaque string. You can use it to detect whether the Task /// has changed between requests. In particular, you can be pass the - /// ETag when updating a task to specify that your changes should take - /// effect only if nobody else has modified the task in the meantime. + /// ETag when updating a Task to specify that your changes should take + /// effect only if nobody else has modified the Task in the meantime. /// [JsonProperty(PropertyName = "eTag")] public string ETag { get; set; } /// - /// Gets or sets the last modified time of the task. + /// Gets or sets the last modified time of the Task. /// [JsonProperty(PropertyName = "lastModified")] public System.DateTime? LastModified { get; set; } /// - /// Gets or sets the creation time of the task. + /// Gets or sets the creation time of the Task. /// [JsonProperty(PropertyName = "creationTime")] public System.DateTime? CreationTime { get; set; } /// - /// Gets or sets how the Batch service should respond when the task + /// Gets or sets how the Batch service should respond when the Task /// completes. /// [JsonProperty(PropertyName = "exitConditions")] public ExitConditions ExitConditions { get; set; } /// - /// Gets or sets the current state of the task. + /// Gets or sets the current state of the Task. /// /// /// Possible values include: 'active', 'preparing', 'running', @@ -200,16 +199,16 @@ public CloudTask() public TaskState? State { get; set; } /// - /// Gets or sets the time at which the task entered its current state. + /// Gets or sets the time at which the Task entered its current state. /// [JsonProperty(PropertyName = "stateTransitionTime")] public System.DateTime? StateTransitionTime { get; set; } /// - /// Gets or sets the previous state of the task. + /// Gets or sets the previous state of the Task. /// /// - /// This property is not set if the task is in its initial Active + /// This property is not set if the Task is in its initial Active /// state. Possible values include: 'active', 'preparing', 'running', /// 'completed' /// @@ -217,28 +216,28 @@ public CloudTask() public TaskState? PreviousState { get; set; } /// - /// Gets or sets the time at which the task entered its previous state. + /// Gets or sets the time at which the Task entered its previous state. /// /// - /// This property is not set if the task is in its initial Active + /// This property is not set if the Task is in its initial Active /// state. /// [JsonProperty(PropertyName = "previousStateTransitionTime")] public System.DateTime? PreviousStateTransitionTime { get; set; } /// - /// Gets or sets the command line of the task. + /// Gets or sets the command line of the Task. /// /// - /// For multi-instance tasks, the command line is executed as the - /// primary task, after the primary task and all subtasks have finished + /// For multi-instance Tasks, the command line is executed as the + /// primary Task, after the primary Task and all subtasks have finished /// executing the coordination command line. 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 + /// 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). /// @@ -246,17 +245,17 @@ public CloudTask() public string CommandLine { get; set; } /// - /// Gets or sets the settings for the container under which the task + /// Gets or sets the settings for the container under which the Task /// runs. /// /// - /// If the pool that will run this task has containerConfiguration set, - /// this must be set as well. If the pool that will run this task + /// If the Pool that will run this Task has containerConfiguration set, + /// this must be set as well. If the Pool that will run this Task /// doesn't have containerConfiguration 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 + /// 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. Files produced in the container outside /// of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, /// meaning that Batch file APIs will not be able to access those @@ -267,11 +266,11 @@ public CloudTask() /// /// Gets or sets a list of files that the Batch service will download - /// to the compute node before running the command line. + /// to the Compute Node before running the command line. /// /// - /// For multi-instance tasks, the resource files will only be - /// downloaded to the compute node on which the primary task is + /// For multi-instance Tasks, the resource files will only be + /// downloaded to the Compute Node on which the primary Task is /// executed. There is a maximum size for the list of resource files. /// When the max size is exceeded, the request will fail and the /// response error code will be RequestEntityTooLarge. If this occurs, @@ -284,111 +283,111 @@ public CloudTask() /// /// Gets or sets a list of files that the Batch service will upload - /// from the compute node after running the command line. + /// from the Compute Node after running the command line. /// /// - /// For multi-instance tasks, the files will only be uploaded from the - /// compute node on which the primary task is executed. + /// For multi-instance Tasks, the files will only be uploaded from the + /// Compute Node on which the primary Task is executed. /// [JsonProperty(PropertyName = "outputFiles")] public IList OutputFiles { get; set; } /// - /// Gets or sets a list of environment variable settings for the task. + /// Gets or sets a list of environment variable settings for the Task. /// [JsonProperty(PropertyName = "environmentSettings")] public IList EnvironmentSettings { get; set; } /// /// Gets or sets a locality hint that can be used by the Batch service - /// to select a compute node on which to start the new task. + /// to select a Compute Node on which to start the new Task. /// [JsonProperty(PropertyName = "affinityInfo")] public AffinityInformation AffinityInfo { get; set; } /// - /// Gets or sets the execution constraints that apply to this task. + /// Gets or sets the execution constraints that apply to this Task. /// [JsonProperty(PropertyName = "constraints")] public TaskConstraints Constraints { get; set; } /// - /// Gets or sets the user identity under which the task runs. + /// Gets or sets the user identity under which the Task runs. /// /// - /// If omitted, the task runs as a non-administrative user unique to - /// the task. + /// If omitted, the Task runs as a non-administrative user unique to + /// the Task. /// [JsonProperty(PropertyName = "userIdentity")] public UserIdentity UserIdentity { get; set; } /// - /// Gets or sets information about the execution of the task. + /// Gets or sets information about the execution of the Task. /// [JsonProperty(PropertyName = "executionInfo")] public TaskExecutionInformation ExecutionInfo { get; set; } /// - /// Gets or sets information about the compute node on which the task + /// Gets or sets information about the Compute Node on which the Task /// ran. /// [JsonProperty(PropertyName = "nodeInfo")] public ComputeNodeInformation NodeInfo { get; set; } /// - /// Gets or sets an object that indicates that the task is a - /// multi-instance task, and contains information about how to run the - /// multi-instance task. + /// Gets or sets an object that indicates that the Task is a + /// multi-instance Task, and contains information about how to run the + /// multi-instance Task. /// [JsonProperty(PropertyName = "multiInstanceSettings")] public MultiInstanceSettings MultiInstanceSettings { get; set; } /// - /// Gets or sets resource usage statistics for the task. + /// Gets or sets resource usage statistics for the Task. /// [JsonProperty(PropertyName = "stats")] public TaskStatistics Stats { get; set; } /// - /// Gets or sets the tasks that this task depends on. + /// Gets or sets the Tasks that this Task depends on. /// /// - /// This task will not be scheduled until all tasks that it depends on - /// have completed successfully. If any of those tasks fail and exhaust - /// their retry counts, this task will never be scheduled. + /// This Task will not be scheduled until all Tasks that it depends on + /// have completed successfully. If any of those Tasks fail and exhaust + /// their retry counts, this Task will never be scheduled. /// [JsonProperty(PropertyName = "dependsOn")] public TaskDependencies DependsOn { get; set; } /// - /// Gets or sets a list of application packages that the Batch service - /// will deploy to the compute node before running the command line. + /// Gets or sets a list of Packages that the Batch service will deploy + /// to the Compute Node before running the command line. /// /// /// Application packages are downloaded and deployed to a shared - /// directory, not the task working directory. Therefore, if a - /// referenced package is already on the compute node, and is up to - /// date, then it is not re-downloaded; the existing copy on the - /// compute node is used. If a referenced application package cannot be - /// installed, for example because the package has been deleted or - /// because download failed, the task fails. + /// directory, not the Task working directory. Therefore, if a + /// referenced package is already on the Node, and is up to date, then + /// it is not re-downloaded; the existing copy on the Compute Node is + /// used. If a referenced Package cannot be installed, for example + /// because the package has been deleted or because download failed, + /// the Task fails. /// [JsonProperty(PropertyName = "applicationPackageReferences")] public IList ApplicationPackageReferences { get; set; } /// - /// Gets or sets the settings for an authentication token that the task + /// Gets or sets the settings for an authentication token that the Task /// can use to perform Batch service operations. /// /// - /// If this property is set, the Batch service provides the task with + /// 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 + /// 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 under the job. + /// 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 under the Job. /// [JsonProperty(PropertyName = "authenticationTokenSettings")] public AuthenticationTokenSettings AuthenticationTokenSettings { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudTaskListSubtasksResult.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudTaskListSubtasksResult.cs index ea5481da6b5f..435cca10f70a 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudTaskListSubtasksResult.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/CloudTaskListSubtasksResult.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The result of listing the subtasks of a task. + /// The result of listing the subtasks of a Task. /// public partial class CloudTaskListSubtasksResult { diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNode.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNode.cs index 3f7d92b6df7d..dee210b4799f 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNode.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNode.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// A compute node in the Batch service. + /// A Compute Node in the Batch service. /// public partial class ComputeNode { @@ -31,51 +31,53 @@ public ComputeNode() /// /// Initializes a new instance of the ComputeNode class. /// - /// The ID of the compute node. - /// The URL of the compute node. - /// The current state of the compute node. - /// Whether the compute node is available - /// for task scheduling. - /// The time at which the compute - /// node entered its current state. - /// The last time at which the compute node + /// The ID of the Compute Node. + /// The URL of the Compute Node. + /// The current state of the Compute Node. + /// Whether the Compute Node is available + /// for Task scheduling. + /// The time at which the Compute + /// Node entered its current state. + /// The last time at which the Compute Node /// was started. - /// The time at which this compute node - /// was allocated to the pool. - /// The IP address that other compute nodes can - /// use to communicate with this compute node. + /// The time at which this Compute Node + /// was allocated to the Pool. + /// The IP address that other Nodes can use to + /// communicate with this Compute Node. /// An identifier which can be passed when - /// adding a task to request that the task be scheduled on this - /// node. + /// adding a Task to request that the Task be scheduled on this Compute + /// Node. /// The size of the virtual machine hosting the - /// compute node. - /// The total number of job tasks completed - /// on the compute node. This includes Job Manager tasks and normal - /// tasks, but not Job Preparation, Job Release or Start tasks. + /// Compute Node. + /// The total number of Job Tasks completed + /// on the Compute Node. This includes Job Manager Tasks and normal + /// Tasks, but not Job Preparation, Job Release or Start Tasks. /// The total number of currently - /// running job tasks on the compute node. This includes Job Manager - /// tasks and normal tasks, but not Job Preparation, Job Release or - /// Start tasks. - /// The total number of job tasks - /// which completed successfully (with exitCode 0) on the compute node. - /// This includes Job Manager tasks and normal tasks, but not Job - /// Preparation, Job Release or Start tasks. - /// A list of tasks whose state has recently + /// running Job Tasks on the Compute Node. This includes Job Manager + /// Tasks and normal Tasks, but not Job Preparation, Job Release or + /// Start Tasks. + /// The total number of Job Tasks + /// which completed successfully (with exitCode 0) on the Compute Node. + /// This includes Job Manager Tasks and normal Tasks, but not Job + /// Preparation, Job Release or Start Tasks. + /// A list of Tasks whose state has recently /// changed. - /// The task specified to run on the compute - /// node as it joins the pool. + /// The Task specified to run on the Compute + /// Node as it joins the Pool. /// Runtime information about the execution - /// of the start task on the compute node. - /// The list of certificates - /// installed on the compute node. + /// of the StartTask on the Compute Node. + /// The list of Certificates + /// installed on the Compute Node. /// The list of errors that are currently being - /// encountered by the compute node. - /// Whether this compute node is a dedicated - /// node. If false, the node is a low-priority node. + /// encountered by the Compute Node. + /// Whether this Compute Node is a dedicated + /// Compute Node. If false, the Compute Node is a low-priority Compute + /// Node. /// The endpoint configuration for - /// the compute node. - /// Information about the node agent - /// version and the time the node upgraded to a new version. + /// the Compute Node. + /// Information about the Compute Node + /// agent version and the time the Compute Node upgraded to a new + /// version. public ComputeNode(string id = default(string), string url = default(string), ComputeNodeState? state = default(ComputeNodeState?), SchedulingState? schedulingState = default(SchedulingState?), System.DateTime? stateTransitionTime = default(System.DateTime?), System.DateTime? lastBootTime = default(System.DateTime?), System.DateTime? allocationTime = default(System.DateTime?), string ipAddress = default(string), string affinityId = default(string), string vmSize = default(string), int? totalTasksRun = default(int?), int? runningTasksCount = default(int?), int? totalTasksSucceeded = default(int?), IList recentTasks = default(IList), StartTask startTask = default(StartTask), StartTaskInformation startTaskInfo = default(StartTaskInformation), IList certificateReferences = default(IList), IList errors = default(IList), bool? isDedicated = default(bool?), ComputeNodeEndpointConfiguration endpointConfiguration = default(ComputeNodeEndpointConfiguration), NodeAgentInformation nodeAgentInfo = default(NodeAgentInformation)) { Id = id; @@ -108,38 +110,39 @@ public ComputeNode() partial void CustomInit(); /// - /// Gets or sets the ID of the compute node. + /// Gets or sets the ID of the Compute Node. /// /// - /// Every node that is added to a pool is assigned a unique ID. - /// Whenever a node is removed from a pool, all of its local files are - /// deleted, and the ID is reclaimed and could be reused for new nodes. + /// Every Compute Node that is added to a Pool is assigned a unique ID. + /// Whenever a Compute Node is removed from a Pool, all of its local + /// files are deleted, and the ID is reclaimed and could be reused for + /// new Compute Nodes. /// [JsonProperty(PropertyName = "id")] public string Id { get; set; } /// - /// Gets or sets the URL of the compute node. + /// Gets or sets the URL of the Compute Node. /// [JsonProperty(PropertyName = "url")] public string Url { get; set; } /// - /// Gets or sets the current state of the compute node. + /// Gets or sets the current state of the Compute Node. /// /// - /// The low-priority node has been preempted. Tasks which were running - /// on the node when it was preempted will be rescheduled when another - /// node becomes available. Possible values include: 'idle', - /// 'rebooting', 'reimaging', 'running', 'unusable', 'creating', - /// 'starting', 'waitingForStartTask', 'startTaskFailed', 'unknown', - /// 'leavingPool', 'offline', 'preempted' + /// The low-priority Compute Node has been preempted. Tasks which were + /// running on the Compute Node when it was preempted will be + /// rescheduled when another Compute Node becomes available. Possible + /// values include: 'idle', 'rebooting', 'reimaging', 'running', + /// 'unusable', 'creating', 'starting', 'waitingForStartTask', + /// 'startTaskFailed', 'unknown', 'leavingPool', 'offline', 'preempted' /// [JsonProperty(PropertyName = "state")] public ComputeNodeState? State { get; set; } /// - /// Gets or sets whether the compute node is available for task + /// Gets or sets whether the Compute Node is available for Task /// scheduling. /// /// @@ -149,132 +152,133 @@ public ComputeNode() public SchedulingState? SchedulingState { get; set; } /// - /// Gets or sets the time at which the compute node entered its current + /// Gets or sets the time at which the Compute Node entered its current /// state. /// [JsonProperty(PropertyName = "stateTransitionTime")] public System.DateTime? StateTransitionTime { get; set; } /// - /// Gets or sets the last time at which the compute node was started. + /// Gets or sets the last time at which the Compute Node was started. /// /// - /// This property may not be present if the node state is unusable. + /// This property may not be present if the Compute Node state is + /// unusable. /// [JsonProperty(PropertyName = "lastBootTime")] public System.DateTime? LastBootTime { get; set; } /// - /// Gets or sets the time at which this compute node was allocated to - /// the pool. + /// Gets or sets the time at which this Compute Node was allocated to + /// the Pool. /// /// - /// This is the time when the node was initially allocated and doesn't - /// change once set. It is not updated when the node is service healed - /// or preempted. + /// This is the time when the Compute Node was initially allocated and + /// doesn't change once set. It is not updated when the Compute Node is + /// service healed or preempted. /// [JsonProperty(PropertyName = "allocationTime")] public System.DateTime? AllocationTime { get; set; } /// - /// Gets or sets the IP address that other compute nodes can use to - /// communicate with this compute node. + /// Gets or sets the IP address that other Nodes can use to communicate + /// with this Compute Node. /// /// - /// Every node that is added to a pool is assigned a unique IP address. - /// Whenever a node is removed from a pool, all of its local files are - /// deleted, and the IP address is reclaimed and could be reused for - /// new nodes. + /// Every Compute Node that is added to a Pool is assigned a unique IP + /// address. Whenever a Compute Node is removed from a Pool, all of its + /// local files are deleted, and the IP address is reclaimed and could + /// be reused for new Compute Nodes. /// [JsonProperty(PropertyName = "ipAddress")] public string IpAddress { get; set; } /// - /// Gets or sets an identifier which can be passed when adding a task - /// to request that the task be scheduled on this node. + /// Gets or sets an identifier which can be passed when adding a Task + /// to request that the Task be scheduled on this Compute Node. /// /// - /// Note that this is just a soft affinity. If the target node is busy - /// or unavailable at the time the task is scheduled, then the task - /// will be scheduled elsewhere. + /// Note that this is just a soft affinity. If the target Compute Node + /// is busy or unavailable at the time the Task is scheduled, then the + /// Task will be scheduled elsewhere. /// [JsonProperty(PropertyName = "affinityId")] public string AffinityId { get; set; } /// - /// Gets or sets the size of the virtual machine hosting the compute - /// node. + /// Gets or sets the size of the virtual machine hosting the Compute + /// Node. /// /// - /// For information about available sizes of virtual machines in pools, - /// see Choose a VM size for compute nodes in an Azure Batch pool + /// For information about available sizes of virtual machines in Pools, + /// see Choose a VM size for Compute Nodes in an Azure Batch Pool /// (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). /// [JsonProperty(PropertyName = "vmSize")] public string VmSize { get; set; } /// - /// Gets or sets the total number of job tasks completed on the compute - /// node. This includes Job Manager tasks and normal tasks, but not Job - /// Preparation, Job Release or Start tasks. + /// Gets or sets the total number of Job Tasks completed on the Compute + /// Node. This includes Job Manager Tasks and normal Tasks, but not Job + /// Preparation, Job Release or Start Tasks. /// [JsonProperty(PropertyName = "totalTasksRun")] public int? TotalTasksRun { get; set; } /// - /// Gets or sets the total number of currently running job tasks on the - /// compute node. This includes Job Manager tasks and normal tasks, but - /// not Job Preparation, Job Release or Start tasks. + /// Gets or sets the total number of currently running Job Tasks on the + /// Compute Node. This includes Job Manager Tasks and normal Tasks, but + /// not Job Preparation, Job Release or Start Tasks. /// [JsonProperty(PropertyName = "runningTasksCount")] public int? RunningTasksCount { get; set; } /// - /// Gets or sets the total number of job tasks which completed - /// successfully (with exitCode 0) on the compute node. This includes - /// Job Manager tasks and normal tasks, but not Job Preparation, Job - /// Release or Start tasks. + /// Gets or sets the total number of Job Tasks which completed + /// successfully (with exitCode 0) on the Compute Node. This includes + /// Job Manager Tasks and normal Tasks, but not Job Preparation, Job + /// Release or Start Tasks. /// [JsonProperty(PropertyName = "totalTasksSucceeded")] public int? TotalTasksSucceeded { get; set; } /// - /// Gets or sets a list of tasks whose state has recently changed. + /// Gets or sets a list of Tasks whose state has recently changed. /// /// - /// This property is present only if at least one task has run on this - /// node since it was assigned to the pool. + /// This property is present only if at least one Task has run on this + /// Compute Node since it was assigned to the Pool. /// [JsonProperty(PropertyName = "recentTasks")] public IList RecentTasks { get; set; } /// - /// Gets or sets the task specified to run on the compute node as it - /// joins the pool. + /// Gets or sets the Task specified to run on the Compute Node as it + /// joins the Pool. /// [JsonProperty(PropertyName = "startTask")] public StartTask StartTask { get; set; } /// - /// Gets or sets runtime information about the execution of the start - /// task on the compute node. + /// Gets or sets runtime information about the execution of the + /// StartTask on the Compute Node. /// [JsonProperty(PropertyName = "startTaskInfo")] public StartTaskInformation StartTaskInfo { get; set; } /// - /// Gets or sets the list of certificates installed on the compute - /// node. + /// Gets or sets the list of Certificates installed on the Compute + /// Node. /// /// - /// For Windows compute nodes, the Batch service installs the - /// certificates to the specified certificate store and location. For - /// Linux compute nodes, the certificates are stored in a directory - /// inside the task working directory and an environment variable - /// AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this - /// location. For certificates with visibility of 'remoteUser', a + /// For Windows Nodes, the Batch service installs the Certificates to + /// the specified Certificate store and location. For Linux Compute + /// Nodes, the Certificates are stored in a directory inside the Task + /// working directory and an environment variable + /// AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this + /// location. For Certificates with visibility of 'remoteUser', a /// 'certs' directory is created in the user's home directory (e.g., - /// /home/{user-name}/certs) and certificates are placed in that + /// /home/{user-name}/certs) and Certificates are placed in that /// directory. /// [JsonProperty(PropertyName = "certificateReferences")] @@ -282,27 +286,27 @@ public ComputeNode() /// /// Gets or sets the list of errors that are currently being - /// encountered by the compute node. + /// encountered by the Compute Node. /// [JsonProperty(PropertyName = "errors")] public IList Errors { get; set; } /// - /// Gets or sets whether this compute node is a dedicated node. If - /// false, the node is a low-priority node. + /// Gets or sets whether this Compute Node is a dedicated Compute Node. + /// If false, the Compute Node is a low-priority Compute Node. /// [JsonProperty(PropertyName = "isDedicated")] public bool? IsDedicated { get; set; } /// - /// Gets or sets the endpoint configuration for the compute node. + /// Gets or sets the endpoint configuration for the Compute Node. /// [JsonProperty(PropertyName = "endpointConfiguration")] public ComputeNodeEndpointConfiguration EndpointConfiguration { get; set; } /// - /// Gets or sets information about the node agent version and the time - /// the node upgraded to a new version. + /// Gets or sets information about the Compute Node agent version and + /// the time the Compute Node upgraded to a new version. /// [JsonProperty(PropertyName = "nodeAgentInfo")] public NodeAgentInformation NodeAgentInfo { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeAddUserHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeAddUserHeaders.cs index 4cbc70bdf7d8..b909ca915c12 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeAddUserHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeAddUserHeaders.cs @@ -39,8 +39,8 @@ public ComputeNodeAddUserHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public ComputeNodeAddUserHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeDeallocationOption.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeDeallocationOption.cs index 77afa4647b9e..2cd2bdacc757 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeDeallocationOption.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeDeallocationOption.cs @@ -22,29 +22,30 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum ComputeNodeDeallocationOption { /// - /// Terminate running task processes and requeue the tasks. The tasks - /// will run again when a node is available. Remove nodes as soon as - /// tasks have been terminated. + /// Terminate running Task processes and requeue the Tasks. The Tasks + /// will run again when a Compute Node is available. Remove Compute + /// Nodes as soon as Tasks have been terminated. /// [EnumMember(Value = "requeue")] Requeue, /// - /// Terminate running tasks. The tasks will be completed with + /// Terminate running Tasks. The Tasks will be completed with /// failureInfo indicating that they were terminated, and will not run - /// again. Remove nodes as soon as tasks have been terminated. + /// again. Remove Compute Nodes as soon as Tasks have been terminated. /// [EnumMember(Value = "terminate")] Terminate, /// - /// Allow currently running tasks to complete. Schedule no new tasks - /// while waiting. Remove nodes when all tasks have completed. + /// Allow currently running Tasks to complete. Schedule no new Tasks + /// while waiting. Remove Compute Nodes when all Tasks have completed. /// [EnumMember(Value = "taskcompletion")] TaskCompletion, /// - /// Allow currently running tasks to complete, then wait for all task - /// data retention periods to expire. Schedule no new tasks while - /// waiting. Remove nodes when all task retention periods have expired. + /// Allow currently running Tasks to complete, then wait for all Task + /// data retention periods to expire. Schedule no new Tasks while + /// waiting. Remove Compute Nodes when all Task retention periods have + /// expired. /// [EnumMember(Value = "retaineddata")] RetainedData diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeDeleteUserHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeDeleteUserHeaders.cs index 3b907e653be8..e1b619312c56 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeDeleteUserHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeDeleteUserHeaders.cs @@ -39,8 +39,8 @@ public ComputeNodeDeleteUserHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. public ComputeNodeDeleteUserHeaders(string clientRequestId = default(string), string requestId = default(string)) { ClientRequestId = clientRequestId; @@ -67,8 +67,8 @@ public ComputeNodeDeleteUserHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public string RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeDisableSchedulingHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeDisableSchedulingHeaders.cs index bc90e39dac49..c1bfaffd1d3b 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeDisableSchedulingHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeDisableSchedulingHeaders.cs @@ -41,8 +41,8 @@ public ComputeNodeDisableSchedulingHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -81,8 +81,8 @@ public ComputeNodeDisableSchedulingHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeEnableSchedulingHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeEnableSchedulingHeaders.cs index e42adce58f16..3d6569a49b52 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeEnableSchedulingHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeEnableSchedulingHeaders.cs @@ -41,8 +41,8 @@ public ComputeNodeEnableSchedulingHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -81,8 +81,8 @@ public ComputeNodeEnableSchedulingHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeEndpointConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeEndpointConfiguration.cs index 8ac2a0f381ea..fb4ddd9a7dae 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeEndpointConfiguration.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeEndpointConfiguration.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The endpoint configuration for the compute node. + /// The endpoint configuration for the Compute Node. /// public partial class ComputeNodeEndpointConfiguration { @@ -34,7 +34,7 @@ public ComputeNodeEndpointConfiguration() /// class. /// /// The list of inbound endpoints that - /// are accessible on the compute node. + /// are accessible on the Compute Node. public ComputeNodeEndpointConfiguration(IList inboundEndpoints) { InboundEndpoints = inboundEndpoints; @@ -48,7 +48,7 @@ public ComputeNodeEndpointConfiguration(IList inboundEndpoints) /// /// Gets or sets the list of inbound endpoints that are accessible on - /// the compute node. + /// the Compute Node. /// [JsonProperty(PropertyName = "inboundEndpoints")] public IList InboundEndpoints { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeError.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeError.cs index 1cd2943f50d7..83f43069b7cd 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeError.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeError.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// An error encountered by a compute node. + /// An error encountered by a Compute Node. /// public partial class ComputeNodeError { @@ -31,13 +31,13 @@ public ComputeNodeError() /// /// Initializes a new instance of the ComputeNodeError class. /// - /// An identifier for the compute node error. Codes + /// An identifier for the Compute Node error. Codes /// are invariant and are intended to be consumed /// programmatically. - /// A message describing the compute node error, + /// A message describing the Compute Node error, /// intended to be suitable for display in a user interface. /// The list of additional error details - /// related to the compute node error. + /// related to the Compute Node error. public ComputeNodeError(string code = default(string), string message = default(string), IList errorDetails = default(IList)) { Code = code; @@ -52,14 +52,14 @@ public ComputeNodeError() partial void CustomInit(); /// - /// Gets or sets an identifier for the compute node error. Codes are + /// Gets or sets an identifier for the Compute Node error. Codes are /// invariant and are intended to be consumed programmatically. /// [JsonProperty(PropertyName = "code")] public string Code { get; set; } /// - /// Gets or sets a message describing the compute node error, intended + /// Gets or sets a message describing the Compute Node error, intended /// to be suitable for display in a user interface. /// [JsonProperty(PropertyName = "message")] @@ -67,7 +67,7 @@ public ComputeNodeError() /// /// Gets or sets the list of additional error details related to the - /// compute node error. + /// Compute Node error. /// [JsonProperty(PropertyName = "errorDetails")] public IList ErrorDetails { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeFillType.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeFillType.cs index ca1fc3c70083..9bebb8852446 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeFillType.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeFillType.cs @@ -22,14 +22,15 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum ComputeNodeFillType { /// - /// Tasks should be assigned evenly across all nodes in the pool. + /// Tasks should be assigned evenly across all Compute Nodes in the + /// Pool. /// [EnumMember(Value = "spread")] Spread, /// - /// As many tasks as possible (maxTasksPerNode) should be assigned to - /// each node in the pool before any tasks are assigned to the next - /// node in the pool. + /// As many Tasks as possible (maxTasksPerNode) should be assigned to + /// each Compute Node in the Pool before any Tasks are assigned to the + /// next Compute Node in the Pool. /// [EnumMember(Value = "pack")] Pack diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeGetHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeGetHeaders.cs index 9a67a76055bf..cac0707fd6bb 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeGetHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeGetHeaders.cs @@ -39,8 +39,8 @@ public ComputeNodeGetHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -76,8 +76,8 @@ public ComputeNodeGetHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeGetRemoteDesktopHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeGetRemoteDesktopHeaders.cs index 85e94f161e03..efcf7f4ad969 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeGetRemoteDesktopHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeGetRemoteDesktopHeaders.cs @@ -41,8 +41,8 @@ public ComputeNodeGetRemoteDesktopHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -78,8 +78,8 @@ public ComputeNodeGetRemoteDesktopHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeGetRemoteLoginSettingsHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeGetRemoteLoginSettingsHeaders.cs index 7bfd4cc15af6..4fa7710cbbe7 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeGetRemoteLoginSettingsHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeGetRemoteLoginSettingsHeaders.cs @@ -41,8 +41,8 @@ public ComputeNodeGetRemoteLoginSettingsHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -78,8 +78,8 @@ public ComputeNodeGetRemoteLoginSettingsHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeGetRemoteLoginSettingsResult.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeGetRemoteLoginSettingsResult.cs index 51d384131d70..e5385aa71e61 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeGetRemoteLoginSettingsResult.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeGetRemoteLoginSettingsResult.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The remote login settings for a compute node. + /// The remote login settings for a Compute Node. /// public partial class ComputeNodeGetRemoteLoginSettingsResult { @@ -32,9 +32,9 @@ public ComputeNodeGetRemoteLoginSettingsResult() /// ComputeNodeGetRemoteLoginSettingsResult class. /// /// The IP address used for remote - /// login to the compute node. + /// login to the Compute Node. /// The port used for remote login to the - /// compute node. + /// Compute Node. public ComputeNodeGetRemoteLoginSettingsResult(string remoteLoginIPAddress, int remoteLoginPort) { RemoteLoginIPAddress = remoteLoginIPAddress; @@ -48,14 +48,14 @@ public ComputeNodeGetRemoteLoginSettingsResult(string remoteLoginIPAddress, int partial void CustomInit(); /// - /// Gets or sets the IP address used for remote login to the compute - /// node. + /// Gets or sets the IP address used for remote login to the Compute + /// Node. /// [JsonProperty(PropertyName = "remoteLoginIPAddress")] public string RemoteLoginIPAddress { get; set; } /// - /// Gets or sets the port used for remote login to the compute node. + /// Gets or sets the port used for remote login to the Compute Node. /// [JsonProperty(PropertyName = "remoteLoginPort")] public int RemoteLoginPort { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeInformation.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeInformation.cs index 1fec2c7e64c3..ca2594beb647 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeInformation.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeInformation.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Information about the compute node on which a task ran. + /// Information about the Compute Node on which a Task ran. /// public partial class ComputeNodeInformation { @@ -29,19 +29,19 @@ public ComputeNodeInformation() /// /// Initializes a new instance of the ComputeNodeInformation class. /// - /// An identifier for the compute node on - /// which the task ran, which can be passed when adding a task to - /// request that the task be scheduled on this compute node. - /// The URL of the node on which the task ran. - /// - /// The ID of the pool on which the task + /// An identifier for the Node on which the + /// Task ran, which can be passed when adding a Task to request that + /// the Task be scheduled on this Compute Node. + /// The URL of the Compute Node on which the Task + /// ran. + /// The ID of the Pool on which the Task /// ran. - /// The ID of the node on which the task + /// The ID of the Compute Node on which the Task /// ran. - /// The root directory of the task on - /// the compute node. + /// The root directory of the Task on + /// the Compute Node. /// The URL to the root directory of - /// the task on the compute node. + /// the Task on the Compute Node. public ComputeNodeInformation(string affinityId = default(string), string nodeUrl = default(string), string poolId = default(string), string nodeId = default(string), string taskRootDirectory = default(string), string taskRootDirectoryUrl = default(string)) { AffinityId = affinityId; @@ -59,40 +59,40 @@ public ComputeNodeInformation() partial void CustomInit(); /// - /// Gets or sets an identifier for the compute node on which the task - /// ran, which can be passed when adding a task to request that the - /// task be scheduled on this compute node. + /// Gets or sets an identifier for the Node on which the Task ran, + /// which can be passed when adding a Task to request that the Task be + /// scheduled on this Compute Node. /// [JsonProperty(PropertyName = "affinityId")] public string AffinityId { get; set; } /// - /// Gets or sets the URL of the node on which the task ran. + /// Gets or sets the URL of the Compute Node on which the Task ran. /// [JsonProperty(PropertyName = "nodeUrl")] public string NodeUrl { get; set; } /// - /// Gets or sets the ID of the pool on which the task ran. + /// Gets or sets the ID of the Pool on which the Task ran. /// [JsonProperty(PropertyName = "poolId")] public string PoolId { get; set; } /// - /// Gets or sets the ID of the node on which the task ran. + /// Gets or sets the ID of the Compute Node on which the Task ran. /// [JsonProperty(PropertyName = "nodeId")] public string NodeId { get; set; } /// - /// Gets or sets the root directory of the task on the compute node. + /// Gets or sets the root directory of the Task on the Compute Node. /// [JsonProperty(PropertyName = "taskRootDirectory")] public string TaskRootDirectory { get; set; } /// - /// Gets or sets the URL to the root directory of the task on the - /// compute node. + /// Gets or sets the URL to the root directory of the Task on the + /// Compute Node. /// [JsonProperty(PropertyName = "taskRootDirectoryUrl")] public string TaskRootDirectoryUrl { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeListHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeListHeaders.cs index 843986ddfa2c..55d8d8cf55b1 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeListHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeListHeaders.cs @@ -39,8 +39,8 @@ public ComputeNodeListHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -76,8 +76,8 @@ public ComputeNodeListHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeListOptions.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeListOptions.cs index cc1ec97cbe71..120f5985099d 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeListOptions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeListOptions.cs @@ -36,7 +36,8 @@ public ComputeNodeListOptions() /// https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool. /// An OData $select clause. /// The maximum number of items to return in - /// the response. A maximum of 1000 nodes can be returned. + /// the response. A maximum of 1000 Compute Nodes can be + /// returned. /// The maximum time that the server can spend /// processing the request, in seconds. The default is 30 /// seconds. @@ -81,7 +82,7 @@ public ComputeNodeListOptions() /// /// Gets or sets the maximum number of items to return in the response. - /// A maximum of 1000 nodes can be returned. + /// A maximum of 1000 Compute Nodes can be returned. /// [Newtonsoft.Json.JsonIgnore] public int? MaxResults { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeRebootHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeRebootHeaders.cs index ea277f952995..849aba089c00 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeRebootHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeRebootHeaders.cs @@ -39,8 +39,8 @@ public ComputeNodeRebootHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public ComputeNodeRebootHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeRebootOption.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeRebootOption.cs index 894b0d028da9..da557c4e857f 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeRebootOption.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeRebootOption.cs @@ -22,30 +22,32 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum ComputeNodeRebootOption { /// - /// Terminate running task processes and requeue the tasks. The tasks - /// will run again when a node is available. Restart the node as soon - /// as tasks have been terminated. + /// Terminate running Task processes and requeue the Tasks. The Tasks + /// will run again when a Compute Node is available. Restart the + /// Compute Node as soon as Tasks have been terminated. /// [EnumMember(Value = "requeue")] Requeue, /// - /// Terminate running tasks. The tasks will be completed with + /// Terminate running Tasks. The Tasks will be completed with /// failureInfo indicating that they were terminated, and will not run - /// again. Restart the node as soon as tasks have been terminated. + /// again. Restart the Compute Node as soon as Tasks have been + /// terminated. /// [EnumMember(Value = "terminate")] Terminate, /// - /// Allow currently running tasks to complete. Schedule no new tasks - /// while waiting. Restart the node when all tasks have completed. + /// Allow currently running Tasks to complete. Schedule no new Tasks + /// while waiting. Restart the Compute Node when all Tasks have + /// completed. /// [EnumMember(Value = "taskcompletion")] TaskCompletion, /// - /// Allow currently running tasks to complete, then wait for all task - /// data retention periods to expire. Schedule no new tasks while - /// waiting. Restart the node when all task retention periods have - /// expired. + /// Allow currently running Tasks to complete, then wait for all Task + /// data retention periods to expire. Schedule no new Tasks while + /// waiting. Restart the Compute Node when all Task retention periods + /// have expired. /// [EnumMember(Value = "retaineddata")] RetainedData diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeReimageHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeReimageHeaders.cs index dc9a69f858d2..cbe986f6dc41 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeReimageHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeReimageHeaders.cs @@ -39,8 +39,8 @@ public ComputeNodeReimageHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public ComputeNodeReimageHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeReimageOption.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeReimageOption.cs index 930e8505a91a..86b40b869009 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeReimageOption.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeReimageOption.cs @@ -22,30 +22,32 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum ComputeNodeReimageOption { /// - /// Terminate running task processes and requeue the tasks. The tasks - /// will run again when a node is available. Reimage the node as soon - /// as tasks have been terminated. + /// Terminate running Task processes and requeue the Tasks. The Tasks + /// will run again when a Compute Node is available. Reimage the + /// Compute Node as soon as Tasks have been terminated. /// [EnumMember(Value = "requeue")] Requeue, /// - /// Terminate running tasks. The tasks will be completed with + /// Terminate running Tasks. The Tasks will be completed with /// failureInfo indicating that they were terminated, and will not run - /// again. Reimage the node as soon as tasks have been terminated. + /// again. Reimage the Compute Node as soon as Tasks have been + /// terminated. /// [EnumMember(Value = "terminate")] Terminate, /// - /// Allow currently running tasks to complete. Schedule no new tasks - /// while waiting. Reimage the node when all tasks have completed. + /// Allow currently running Tasks to complete. Schedule no new Tasks + /// while waiting. Reimage the Compute Node when all Tasks have + /// completed. /// [EnumMember(Value = "taskcompletion")] TaskCompletion, /// - /// Allow currently running tasks to complete, then wait for all task - /// data retention periods to expire. Schedule no new tasks while - /// waiting. Reimage the node when all task retention periods have - /// expired. + /// Allow currently running Tasks to complete, then wait for all Task + /// data retention periods to expire. Schedule no new Tasks while + /// waiting. Reimage the Compute Node when all Task retention periods + /// have expired. /// [EnumMember(Value = "retaineddata")] RetainedData diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeState.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeState.cs index 41cf4dc2fa33..8193ecbcf0fa 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeState.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeState.cs @@ -22,33 +22,34 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum ComputeNodeState { /// - /// The node is not currently running a task. + /// The Compute Node is not currently running a Task. /// [EnumMember(Value = "idle")] Idle, /// - /// The node is rebooting. + /// The Compute Node is rebooting. /// [EnumMember(Value = "rebooting")] Rebooting, /// - /// The node is reimaging. + /// The Compute Node is reimaging. /// [EnumMember(Value = "reimaging")] Reimaging, /// - /// The node is running one or more tasks (other than a start task). + /// The Compute Node is running one or more Tasks (other than a + /// StartTask). /// [EnumMember(Value = "running")] Running, /// - /// The node cannot be used for task execution due to errors. + /// The Compute Node cannot be used for Task execution due to errors. /// [EnumMember(Value = "unusable")] Unusable, /// /// The Batch service has obtained the underlying virtual machine from - /// Azure Compute, but it has not yet started to join the pool. + /// Azure Compute, but it has not yet started to join the Pool. /// [EnumMember(Value = "creating")] Creating, @@ -58,40 +59,41 @@ public enum ComputeNodeState [EnumMember(Value = "starting")] Starting, /// - /// The start task has started running on the compute node, but - /// waitForSuccess is set and the start task has not yet completed. + /// The StartTask has started running on the Compute Node, but + /// waitForSuccess is set and the StartTask has not yet completed. /// [EnumMember(Value = "waitingforstarttask")] WaitingForStartTask, /// - /// The start task has failed on the compute node (and exhausted all - /// retries), and waitForSuccess is set. The node is not usable for - /// running tasks. + /// The StartTask has failed on the Compute Node (and exhausted all + /// retries), and waitForSuccess is set. The Compute Node is not usable + /// for running Tasks. /// [EnumMember(Value = "starttaskfailed")] StartTaskFailed, /// - /// The Batch service has lost contact with the node, and does not know - /// its true state. + /// The Batch service has lost contact with the Compute Node, and does + /// not know its true state. /// [EnumMember(Value = "unknown")] Unknown, /// - /// The node is leaving the pool, either because the user explicitly - /// removed it or because the pool is resizing or autoscaling down. + /// The Compute Node is leaving the Pool, either because the user + /// explicitly removed it or because the Pool is resizing or + /// autoscaling down. /// [EnumMember(Value = "leavingpool")] LeavingPool, /// - /// The node is not currently running a task, and scheduling of new - /// tasks to the node is disabled. + /// The Compute Node is not currently running a Task, and scheduling of + /// new Tasks to the Compute Node is disabled. /// [EnumMember(Value = "offline")] Offline, /// - /// The low-priority node has been preempted. Tasks which were running - /// on the node when it was preempted will be rescheduled when another - /// node becomes available. + /// The low-priority Compute Node has been preempted. Tasks which were + /// running on the Compute Node when it was preempted will be + /// rescheduled when another Compute Node becomes available. /// [EnumMember(Value = "preempted")] Preempted diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeUpdateUserHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeUpdateUserHeaders.cs index 05e04e11f37f..d14f2ac84522 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeUpdateUserHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeUpdateUserHeaders.cs @@ -41,8 +41,8 @@ public ComputeNodeUpdateUserHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -81,8 +81,8 @@ public ComputeNodeUpdateUserHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeUploadBatchServiceLogsHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeUploadBatchServiceLogsHeaders.cs index 0f0bd8044ecb..4e300311cab8 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeUploadBatchServiceLogsHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeUploadBatchServiceLogsHeaders.cs @@ -39,8 +39,8 @@ public ComputeNodeUploadBatchServiceLogsHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. public ComputeNodeUploadBatchServiceLogsHeaders(System.Guid? clientRequestId = default(System.Guid?), System.Guid? requestId = default(System.Guid?)) { ClientRequestId = clientRequestId; @@ -67,8 +67,8 @@ public ComputeNodeUploadBatchServiceLogsHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeUser.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeUser.cs index 7538545a2cbd..9baa10e54b85 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeUser.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ComputeNodeUser.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// A user account for RDP or SSH access on a compute node. + /// A user Account for RDP or SSH access on a Compute Node. /// public partial class ComputeNodeUser { @@ -29,14 +29,14 @@ public ComputeNodeUser() /// /// Initializes a new instance of the ComputeNodeUser class. /// - /// The user name of the account. - /// Whether the account should be an - /// administrator on the compute node. - /// The time at which the account should + /// The user name of the Account. + /// Whether the Account should be an + /// administrator on the Compute Node. + /// The time at which the Account should /// expire. - /// The password of the account. + /// The password of the Account. /// The SSH public key that can be used for - /// remote login to the compute node. + /// remote login to the Compute Node. public ComputeNodeUser(string name, bool? isAdmin = default(bool?), System.DateTime? expiryTime = default(System.DateTime?), string password = default(string), string sshPublicKey = default(string)) { Name = name; @@ -53,14 +53,14 @@ public ComputeNodeUser() partial void CustomInit(); /// - /// Gets or sets the user name of the account. + /// Gets or sets the user name of the Account. /// [JsonProperty(PropertyName = "name")] public string Name { get; set; } /// - /// Gets or sets whether the account should be an administrator on the - /// compute node. + /// Gets or sets whether the Account should be an administrator on the + /// Compute Node. /// /// /// The default value is false. @@ -69,23 +69,23 @@ public ComputeNodeUser() public bool? IsAdmin { get; set; } /// - /// Gets or sets the time at which the account should expire. + /// Gets or sets the time at which the Account should expire. /// /// /// If omitted, the default is 1 day from the current time. For Linux - /// compute nodes, the expiryTime has a precision up to a day. + /// Compute Nodes, the expiryTime has a precision up to a day. /// [JsonProperty(PropertyName = "expiryTime")] public System.DateTime? ExpiryTime { get; set; } /// - /// Gets or sets the password of the account. + /// Gets or sets the password of the Account. /// /// - /// The password is required for Windows nodes (those created with - /// 'cloudServiceConfiguration', or created with - /// 'virtualMachineConfiguration' using a Windows image reference). For - /// Linux compute nodes, the password can optionally be specified along + /// The password is required for Windows Compute Nodes (those created + /// with 'cloudServiceConfiguration', or created with + /// 'virtualMachineConfiguration' using a Windows Image reference). For + /// Linux Compute Nodes, the password can optionally be specified along /// with the sshPublicKey property. /// [JsonProperty(PropertyName = "password")] @@ -93,14 +93,15 @@ public ComputeNodeUser() /// /// Gets or sets the SSH public key that can be used for remote login - /// to the compute node. + /// to the Compute Node. /// /// /// The public key should be compatible with OpenSSH encoding and /// should be base 64 encoded. This property can be specified only for - /// Linux nodes. If this is specified for a Windows node, then the - /// Batch service rejects the request; if you are calling the REST API - /// directly, the HTTP status code is 400 (Bad Request). + /// Linux Compute Nodes. If this is specified for a Windows Compute + /// Node, then the Batch service rejects the request; if you are + /// calling the REST API directly, the HTTP status code is 400 (Bad + /// Request). /// [JsonProperty(PropertyName = "sshPublicKey")] public string SshPublicKey { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ContainerConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ContainerConfiguration.cs index 77ecd196147c..43dcd1280e13 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ContainerConfiguration.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ContainerConfiguration.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The configuration for container-enabled pools. + /// The configuration for container-enabled Pools. /// public partial class ContainerConfiguration { @@ -31,7 +31,7 @@ public ContainerConfiguration() /// /// Initializes a new instance of the ContainerConfiguration class. /// - /// The collection of container image + /// The collection of container Image /// names. /// Additional private registries /// from which containers can be pulled. @@ -55,12 +55,12 @@ static ContainerConfiguration() partial void CustomInit(); /// - /// Gets or sets the collection of container image names. + /// Gets or sets the collection of container Image names. /// /// - /// This is the full image reference, as would be specified to "docker - /// pull". An image will be sourced from the default Docker registry - /// unless the image is fully qualified with an alternative registry. + /// This is the full Image reference, as would be specified to "docker + /// pull". An Image will be sourced from the default Docker registry + /// unless the Image is fully qualified with an alternative registry. /// [JsonProperty(PropertyName = "containerImageNames")] public IList ContainerImageNames { get; set; } @@ -70,7 +70,7 @@ static ContainerConfiguration() /// can be pulled. /// /// - /// If any images must be downloaded from a private registry which + /// If any Images must be downloaded from a private registry which /// requires credentials, then those credentials must be provided here. /// [JsonProperty(PropertyName = "containerRegistries")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ContainerWorkingDirectory.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ContainerWorkingDirectory.cs index 0444dbbc2d2b..d54f0132aa72 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ContainerWorkingDirectory.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ContainerWorkingDirectory.cs @@ -22,13 +22,13 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum ContainerWorkingDirectory { /// - /// Use the standard Batch service task working directory, which will + /// Use the standard Batch service Task working directory, which will /// contain the Task Resource Files populated by Batch. /// [EnumMember(Value = "taskWorkingDirectory")] TaskWorkingDirectory, /// - /// Use the working directory defined in the container image. Beware + /// Use the working directory defined in the container Image. Beware /// that this directory will not contain the Resource Files downloaded /// by Batch. /// diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/DataDisk.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/DataDisk.cs index 0ac8b8d7b2fe..aba77f5f43c8 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/DataDisk.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/DataDisk.cs @@ -14,8 +14,9 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Settings which will be used by the data disks associated to compute - /// nodes in the pool. + /// Settings which will be used by the data disks associated to Compute + /// Nodes in the Pool. When using attached data disks, you need to mount + /// and format the disks from within a VM to use them. /// public partial class DataDisk { @@ -35,7 +36,7 @@ public DataDisk() /// gigabytes. /// The type of caching to be enabled for the /// data disks. - /// The storage account type to be + /// The storage Account type to be /// used for the data disk. public DataDisk(int lun, int diskSizeGB, CachingType? caching = default(CachingType?), StorageAccountType? storageAccountType = default(StorageAccountType?)) { @@ -80,7 +81,7 @@ public DataDisk() public int DiskSizeGB { get; set; } /// - /// Gets or sets the storage account type to be used for the data disk. + /// Gets or sets the storage Account type to be used for the data disk. /// /// /// If omitted, the default is "standard_lrs". Possible values include: diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/DeleteCertificateError.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/DeleteCertificateError.cs index befcfcb6c0dc..2173ae101713 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/DeleteCertificateError.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/DeleteCertificateError.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// An error encountered by the Batch service when deleting a certificate. + /// An error encountered by the Batch service when deleting a Certificate. /// public partial class DeleteCertificateError { @@ -31,14 +31,14 @@ public DeleteCertificateError() /// /// Initializes a new instance of the DeleteCertificateError class. /// - /// An identifier for the certificate deletion + /// An identifier for the Certificate deletion /// error. Codes are invariant and are intended to be consumed /// programmatically. - /// A message describing the certificate deletion + /// A message describing the Certificate deletion /// error, intended to be suitable for display in a user /// interface. /// A list of additional error details related to - /// the certificate deletion error. + /// the Certificate deletion error. public DeleteCertificateError(string code = default(string), string message = default(string), IList values = default(IList)) { Code = code; @@ -53,7 +53,7 @@ public DeleteCertificateError() partial void CustomInit(); /// - /// Gets or sets an identifier for the certificate deletion error. + /// Gets or sets an identifier for the Certificate deletion error. /// Codes are invariant and are intended to be consumed /// programmatically. /// @@ -61,7 +61,7 @@ public DeleteCertificateError() public string Code { get; set; } /// - /// Gets or sets a message describing the certificate deletion error, + /// Gets or sets a message describing the Certificate deletion error, /// intended to be suitable for display in a user interface. /// [JsonProperty(PropertyName = "message")] @@ -69,12 +69,12 @@ public DeleteCertificateError() /// /// Gets or sets a list of additional error details related to the - /// certificate deletion error. + /// Certificate deletion error. /// /// - /// This list includes details such as the active pools and nodes - /// referencing this certificate. However, if a large number of - /// resources reference the certificate, the list contains only about + /// This list includes details such as the active Pools and Compute + /// Nodes referencing this Certificate. However, if a large number of + /// resources reference the Certificate, the list contains only about /// the first hundred. /// [JsonProperty(PropertyName = "values")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/DependencyAction.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/DependencyAction.cs index 0f54828c7d0a..3132b9eec38c 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/DependencyAction.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/DependencyAction.cs @@ -22,12 +22,14 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum DependencyAction { /// - /// Satisfy the task's dependencies. + /// Satisfy tasks waiting on this task; once all dependencies are + /// satisfied, the task will be scheduled to run. /// [EnumMember(Value = "satisfy")] Satisfy, /// - /// Block the task's dependencies. + /// Blocks tasks waiting on this task, preventing them from being + /// scheduled. /// [EnumMember(Value = "block")] Block diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/DisableComputeNodeSchedulingOption.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/DisableComputeNodeSchedulingOption.cs index 0b022d7f1dad..aeb18a566d32 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/DisableComputeNodeSchedulingOption.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/DisableComputeNodeSchedulingOption.cs @@ -22,23 +22,23 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum DisableComputeNodeSchedulingOption { /// - /// Terminate running task processes and requeue the tasks. The tasks - /// may run again on other compute nodes, or when task scheduling is - /// re-enabled on this node. Enter offline state as soon as tasks have - /// been terminated. + /// Terminate running Task processes and requeue the Tasks. The Tasks + /// may run again on other Compute Nodes, or when Task scheduling is + /// re-enabled on this Compute Node. Enter offline state as soon as + /// Tasks have been terminated. /// [EnumMember(Value = "requeue")] Requeue, /// - /// Terminate running tasks. The tasks will be completed with + /// Terminate running Tasks. The Tasks will be completed with /// failureInfo indicating that they were terminated, and will not run - /// again. Enter offline state as soon as tasks have been terminated. + /// again. Enter offline state as soon as Tasks have been terminated. /// [EnumMember(Value = "terminate")] Terminate, /// - /// Allow currently running tasks to complete. Schedule no new tasks - /// while waiting. Enter offline state when all tasks have completed. + /// Allow currently running Tasks to complete. Schedule no new Tasks + /// while waiting. Enter offline state when all Tasks have completed. /// [EnumMember(Value = "taskcompletion")] TaskCompletion diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/DisableJobOption.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/DisableJobOption.cs index c135f263eac1..252f3b2648ff 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/DisableJobOption.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/DisableJobOption.cs @@ -22,20 +22,20 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum DisableJobOption { /// - /// Terminate running tasks and requeue them. The tasks will run again - /// when the job is enabled. + /// Terminate running Tasks and requeue them. The Tasks will run again + /// when the Job is enabled. /// [EnumMember(Value = "requeue")] Requeue, /// - /// Terminate running tasks. The tasks will be completed with + /// Terminate running Tasks. The Tasks will be completed with /// failureInfo indicating that they were terminated, and will not run /// again. /// [EnumMember(Value = "terminate")] Terminate, /// - /// Allow currently running tasks to complete. + /// Allow currently running Tasks to complete. /// [EnumMember(Value = "wait")] Wait diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/EnvironmentSetting.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/EnvironmentSetting.cs index e8a492669a2c..2eedd58c65d0 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/EnvironmentSetting.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/EnvironmentSetting.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// An environment variable to be set on a task process. + /// An environment variable to be set on a Task process. /// public partial class EnvironmentSetting { diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ExitCodeMapping.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ExitCodeMapping.cs index 7ee4246562fe..c1781afeaa6b 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ExitCodeMapping.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ExitCodeMapping.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// How the Batch service should respond if a task exits with a particular + /// How the Batch service should respond if a Task exits with a particular /// exit code. /// public partial class ExitCodeMapping @@ -32,7 +32,7 @@ public ExitCodeMapping() /// /// A process exit code. /// How the Batch service should respond if - /// the task exits with this exit code. + /// the Task exits with this exit code. public ExitCodeMapping(int code, ExitOptions exitOptions) { Code = code; @@ -52,7 +52,7 @@ public ExitCodeMapping(int code, ExitOptions exitOptions) public int Code { get; set; } /// - /// Gets or sets how the Batch service should respond if the task exits + /// Gets or sets how the Batch service should respond if the Task exits /// with this exit code. /// [JsonProperty(PropertyName = "exitOptions")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ExitCodeRangeMapping.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ExitCodeRangeMapping.cs index 8dad55872e15..ff19b09a7104 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ExitCodeRangeMapping.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ExitCodeRangeMapping.cs @@ -33,7 +33,7 @@ public ExitCodeRangeMapping() /// The first exit code in the range. /// The last exit code in the range. /// How the Batch service should respond if - /// the task exits with an exit code in the range start to end + /// the Task exits with an exit code in the range start to end /// (inclusive). public ExitCodeRangeMapping(int start, int end, ExitOptions exitOptions) { @@ -61,7 +61,7 @@ public ExitCodeRangeMapping(int start, int end, ExitOptions exitOptions) public int End { get; set; } /// - /// Gets or sets how the Batch service should respond if the task exits + /// Gets or sets how the Batch service should respond if the Task exits /// with an exit code in the range start to end (inclusive). /// [JsonProperty(PropertyName = "exitOptions")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ExitConditions.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ExitConditions.cs index 29e1d5261a3b..f35fbe752c15 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ExitConditions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ExitConditions.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Specifies how the Batch service should respond when the task completes. + /// Specifies how the Batch service should respond when the Task completes. /// public partial class ExitConditions { @@ -31,16 +31,16 @@ public ExitConditions() /// /// Initializes a new instance of the ExitConditions class. /// - /// A list of individual task exit codes and + /// A list of individual Task exit codes and /// how the Batch service should respond to them. - /// A list of task exit code ranges and + /// A list of Task exit code ranges and /// how the Batch service should respond to them. /// How the Batch service should - /// respond if the task fails to start due to an error. + /// respond if the Task fails to start due to an error. /// How the Batch service should respond /// if a file upload error occurs. /// How the Batch service should respond - /// if the task fails with an exit condition not covered by any of the + /// if the Task fails with an exit condition not covered by any of the /// other properties. public ExitConditions(IList exitCodes = default(IList), IList exitCodeRanges = default(IList), ExitOptions preProcessingError = default(ExitOptions), ExitOptions fileUploadError = default(ExitOptions), ExitOptions defaultProperty = default(ExitOptions)) { @@ -58,21 +58,21 @@ public ExitConditions() partial void CustomInit(); /// - /// Gets or sets a list of individual task exit codes and how the Batch + /// Gets or sets a list of individual Task exit codes and how the Batch /// service should respond to them. /// [JsonProperty(PropertyName = "exitCodes")] public IList ExitCodes { get; set; } /// - /// Gets or sets a list of task exit code ranges and how the Batch + /// Gets or sets a list of Task exit code ranges and how the Batch /// service should respond to them. /// [JsonProperty(PropertyName = "exitCodeRanges")] public IList ExitCodeRanges { get; set; } /// - /// Gets or sets how the Batch service should respond if the task fails + /// Gets or sets how the Batch service should respond if the Task fails /// to start due to an error. /// [JsonProperty(PropertyName = "preProcessingError")] @@ -83,7 +83,7 @@ public ExitConditions() /// error occurs. /// /// - /// If the task exited with an exit code that was specified via + /// If the Task exited with an exit code that was specified via /// exitCodes or exitCodeRanges, and then encountered a file upload /// error, then the action specified by the exit code takes precedence. /// @@ -91,11 +91,11 @@ public ExitConditions() public ExitOptions FileUploadError { get; set; } /// - /// Gets or sets how the Batch service should respond if the task fails + /// Gets or sets how the Batch service should respond if the Task fails /// with an exit condition not covered by any of the other properties. /// /// - /// This value is used if the task exits with any nonzero exit code not + /// This value is used if the Task exits with any nonzero exit code not /// listed in the exitCodes or exitCodeRanges collection, with a /// pre-processing error if the preProcessingError property is not /// present, or with a file upload error if the fileUploadError diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ExitOptions.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ExitOptions.cs index 0184422e799e..8a9ee3c50cec 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ExitOptions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ExitOptions.cs @@ -30,12 +30,12 @@ public ExitOptions() /// /// Initializes a new instance of the ExitOptions class. /// - /// An action to take on the job containing the - /// task, if the task completes with the given exit condition and the - /// job's onTaskFailed property is + /// An action to take on the Job containing the + /// Task, if the Task completes with the given exit condition and the + /// Job's onTaskFailed property is /// 'performExitOptionsJobAction'. /// An action that the Batch service - /// performs on tasks that depend on this task. + /// performs on Tasks that depend on this Task. public ExitOptions(JobAction? jobAction = default(JobAction?), DependencyAction? dependencyAction = default(DependencyAction?)) { JobAction = jobAction; @@ -49,14 +49,14 @@ public ExitOptions() partial void CustomInit(); /// - /// Gets or sets an action to take on the job containing the task, if - /// the task completes with the given exit condition and the job's + /// Gets or sets an action to take on the Job containing the Task, if + /// the Task completes with the given exit condition and the Job's /// onTaskFailed property is 'performExitOptionsJobAction'. /// /// /// The default is none for exit code 0 and terminate for all other - /// exit conditions. If the job's onTaskFailed property is noaction, - /// then specifying this property returns an error and the add task + /// exit conditions. If the Job's onTaskFailed property is noaction, + /// then specifying this property returns an error and the add Task /// request fails with an invalid property value error; if you are /// calling the REST API directly, the HTTP status code is 400 (Bad /// Request). Possible values include: 'none', 'disable', 'terminate' @@ -65,17 +65,14 @@ public ExitOptions() public JobAction? JobAction { get; set; } /// - /// Gets or sets an action that the Batch service performs on tasks - /// that depend on this task. + /// Gets or sets an action that the Batch service performs on Tasks + /// that depend on this Task. /// /// - /// The default is 'satisfy' for exit code 0, and 'block' for all other - /// exit conditions. If the job's usesTaskDependencies property is set - /// to false, then specifying the dependencyAction property returns an - /// error and the add task request fails with an invalid property value - /// error; if you are calling the REST API directly, the HTTP status - /// code is 400 (Bad Request). Possible values include: 'satisfy', - /// 'block' + /// Possible values are 'satisfy' (allowing dependent tasks to + /// progress) and 'block' (dependent tasks continue to wait). Batch + /// does not yet support cancellation of dependent tasks. Possible + /// values include: 'satisfy', 'block' /// [JsonProperty(PropertyName = "dependencyAction")] public DependencyAction? DependencyAction { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileDeleteFromComputeNodeHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileDeleteFromComputeNodeHeaders.cs index 34433f690988..f154cb9f948c 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileDeleteFromComputeNodeHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileDeleteFromComputeNodeHeaders.cs @@ -39,8 +39,8 @@ public FileDeleteFromComputeNodeHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. public FileDeleteFromComputeNodeHeaders(string clientRequestId = default(string), string requestId = default(string)) { ClientRequestId = clientRequestId; @@ -67,8 +67,8 @@ public FileDeleteFromComputeNodeHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public string RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileDeleteFromTaskHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileDeleteFromTaskHeaders.cs index 7c35a972f055..a41bce3a1a43 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileDeleteFromTaskHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileDeleteFromTaskHeaders.cs @@ -37,8 +37,8 @@ public FileDeleteFromTaskHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. public FileDeleteFromTaskHeaders(string clientRequestId = default(string), string requestId = default(string)) { ClientRequestId = clientRequestId; @@ -65,8 +65,8 @@ public FileDeleteFromTaskHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public string RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileGetFromComputeNodeHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileGetFromComputeNodeHeaders.cs index a2e9321c353d..087f0e877381 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileGetFromComputeNodeHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileGetFromComputeNodeHeaders.cs @@ -41,8 +41,8 @@ public FileGetFromComputeNodeHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -92,8 +92,8 @@ public FileGetFromComputeNodeHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileGetFromTaskHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileGetFromTaskHeaders.cs index 4402c2932472..7bd98f4b92fd 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileGetFromTaskHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileGetFromTaskHeaders.cs @@ -39,8 +39,8 @@ public FileGetFromTaskHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -90,8 +90,8 @@ public FileGetFromTaskHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileGetPropertiesFromComputeNodeHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileGetPropertiesFromComputeNodeHeaders.cs index b560a85b9ffc..22ef3c9678f6 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileGetPropertiesFromComputeNodeHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileGetPropertiesFromComputeNodeHeaders.cs @@ -41,8 +41,8 @@ public FileGetPropertiesFromComputeNodeHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -92,8 +92,8 @@ public FileGetPropertiesFromComputeNodeHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileGetPropertiesFromTaskHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileGetPropertiesFromTaskHeaders.cs index 5e31bfb37cb6..73d86a315159 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileGetPropertiesFromTaskHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileGetPropertiesFromTaskHeaders.cs @@ -41,8 +41,8 @@ public FileGetPropertiesFromTaskHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -92,8 +92,8 @@ public FileGetPropertiesFromTaskHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileListFromComputeNodeHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileListFromComputeNodeHeaders.cs index 6907a0000579..b65309132b61 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileListFromComputeNodeHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileListFromComputeNodeHeaders.cs @@ -41,8 +41,8 @@ public FileListFromComputeNodeHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -78,8 +78,8 @@ public FileListFromComputeNodeHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileListFromTaskHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileListFromTaskHeaders.cs index da4310a724fa..d0b64ab4f0ae 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileListFromTaskHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileListFromTaskHeaders.cs @@ -39,8 +39,8 @@ public FileListFromTaskHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -76,8 +76,8 @@ public FileListFromTaskHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileProperties.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileProperties.cs index 9e5963fb5cb6..bced00815a5a 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileProperties.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/FileProperties.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The properties of a file on a compute node. + /// The properties of a file on a Compute Node. /// public partial class FileProperties { @@ -55,7 +55,7 @@ public FileProperties() /// Gets or sets the file creation time. /// /// - /// The creation time is not returned for files on Linux compute nodes. + /// The creation time is not returned for files on Linux Compute Nodes. /// [JsonProperty(PropertyName = "creationTime")] public System.DateTime? CreationTime { get; set; } @@ -82,7 +82,7 @@ public FileProperties() /// Gets or sets the file mode attribute in octal format. /// /// - /// The file mode is returned only for files on Linux compute nodes. + /// The file mode is returned only for files on Linux Compute Nodes. /// [JsonProperty(PropertyName = "fileMode")] public string FileMode { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ImageInformation.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ImageInformation.cs index 42ee2446f08a..4687839a3d80 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ImageInformation.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ImageInformation.cs @@ -32,19 +32,19 @@ public ImageInformation() /// /// Initializes a new instance of the ImageInformation class. /// - /// The ID of the node agent SKU which the - /// Image supports. + /// The ID of the Compute Node agent SKU + /// which the Image supports. /// The reference to the Azure Virtual /// Machine's Marketplace Image. /// The type of operating system (e.g. Windows or /// Linux) of the Image. /// Whether the Azure Batch service /// actively verifies that the Image is compatible with the associated - /// node agent SKU. + /// Compute Node agent SKU. /// The capabilities or features which the /// Image supports. /// The time when the Azure Batch - /// service will stop accepting create pool requests for the + /// service will stop accepting create Pool requests for the /// Image. public ImageInformation(string nodeAgentSKUId, ImageReference imageReference, OSType osType, VerificationType verificationType, IList capabilities = default(IList), System.DateTime? batchSupportEndOfLife = default(System.DateTime?)) { @@ -63,7 +63,8 @@ public ImageInformation() partial void CustomInit(); /// - /// Gets or sets the ID of the node agent SKU which the Image supports. + /// Gets or sets the ID of the Compute Node agent SKU which the Image + /// supports. /// [JsonProperty(PropertyName = "nodeAgentSKUId")] public string NodeAgentSKUId { get; set; } @@ -98,14 +99,14 @@ public ImageInformation() /// /// Gets or sets the time when the Azure Batch service will stop - /// accepting create pool requests for the Image. + /// accepting create Pool requests for the Image. /// [JsonProperty(PropertyName = "batchSupportEndOfLife")] public System.DateTime? BatchSupportEndOfLife { get; set; } /// /// Gets or sets whether the Azure Batch service actively verifies that - /// the Image is compatible with the associated node agent SKU. + /// the Image is compatible with the associated Compute Node agent SKU. /// /// /// Possible values include: 'verified', 'unverified' diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ImageReference.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ImageReference.cs index 3f3954cc543d..c4a9f420d8c6 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ImageReference.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ImageReference.cs @@ -41,9 +41,13 @@ public ImageReference() /// The version of the Azure Virtual Machines /// Marketplace Image. /// The ARM resource identifier of - /// the Virtual Machine Image. Computes nodes of the pool will be - /// created using this custom image. This is of the form - /// /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName} + /// the Virtual Machine Image or Shared Image Gallery Image. Computes + /// Compute Nodes of the Pool will be created using this Image Id. This + /// is of either the form + /// /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName} + /// for Virtual Machine Image or + /// /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId} + /// for SIG image. public ImageReference(string publisher = default(string), string offer = default(string), string sku = default(string), string version = default(string), string virtualMachineImageId = default(string)) { Publisher = publisher; @@ -84,7 +88,7 @@ public ImageReference() /// Image. /// /// - /// For example, 14.04.0-LTS or 2012-R2-Datacenter. + /// For example, 18.04-LTS or 2019-Datacenter. /// [JsonProperty(PropertyName = "sku")] public string Sku { get; set; } @@ -102,16 +106,21 @@ public ImageReference() /// /// Gets or sets the ARM resource identifier of the Virtual Machine - /// Image. Computes nodes of the pool will be created using this custom - /// image. This is of the form + /// Image or Shared Image Gallery Image. Computes Compute Nodes of the + /// Pool will be created using this Image Id. This is of either the + /// form /// /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName} + /// for Virtual Machine Image or + /// /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId} + /// for SIG image. /// /// /// This property is mutually exclusive with other ImageReference - /// properties. The Virtual Machine Image must be in the same region - /// and subscription as the Azure Batch account. For information about - /// the firewall settings for the Batch node agent to communicate with - /// the Batch service see + /// properties. For Virtual Machine Image it must be in the same region + /// and subscription as the Azure Batch account. For SIG image it must + /// have replicas in the same region as the Azure Batch account. For + /// information about the firewall settings for the Batch Compute Node + /// agent to communicate with the Batch service see /// https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. /// [JsonProperty(PropertyName = "virtualMachineImageId")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/InboundEndpoint.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/InboundEndpoint.cs index 0c1efe21c037..569c246cd6ec 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/InboundEndpoint.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/InboundEndpoint.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// An inbound endpoint on a compute node. + /// An inbound endpoint on a Compute Node. /// public partial class InboundEndpoint { @@ -31,10 +31,10 @@ public InboundEndpoint() /// /// The name of the endpoint. /// The protocol of the endpoint. - /// The public IP address of the compute - /// node. + /// The public IP address of the Compute + /// Node. /// The public fully qualified domain name for - /// the compute node. + /// the Compute Node. /// The public port number of the /// endpoint. /// The backend port number of the @@ -71,14 +71,14 @@ public InboundEndpoint(string name, InboundEndpointProtocol protocol, string pub public InboundEndpointProtocol Protocol { get; set; } /// - /// Gets or sets the public IP address of the compute node. + /// Gets or sets the public IP address of the Compute Node. /// [JsonProperty(PropertyName = "publicIPAddress")] public string PublicIPAddress { get; set; } /// - /// Gets or sets the public fully qualified domain name for the compute - /// node. + /// Gets or sets the public fully qualified domain name for the Compute + /// Node. /// [JsonProperty(PropertyName = "publicFQDN")] public string PublicFQDN { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/InboundNatPool.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/InboundNatPool.cs index 15c60e4dbe4b..81bafa27ff80 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/InboundNatPool.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/InboundNatPool.cs @@ -16,8 +16,8 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// A inbound NAT pool that can be used to address specific ports on - /// compute nodes in a Batch pool externally. + /// A inbound NAT Pool that can be used to address specific ports on + /// Compute Nodes in a Batch Pool externally. /// public partial class InboundNATPool { @@ -34,14 +34,14 @@ public InboundNATPool() /// /// The name of the endpoint. /// The protocol of the endpoint. - /// The port number on the compute - /// node. + /// The port number on the Compute + /// Node. /// The first port number in the /// range of external ports that will be used to provide inbound access - /// to the backendPort on individual compute nodes. + /// to the backendPort on individual Compute Nodes. /// The last port number in the /// range of external ports that will be used to provide inbound access - /// to the backendPort on individual compute nodes. + /// to the backendPort on individual Compute Nodes. /// A list of network security /// group rules that will be applied to the endpoint. public InboundNATPool(string name, InboundEndpointProtocol protocol, int backendPort, int frontendPortRangeStart, int frontendPortRangeEnd, IList networkSecurityGroupRules = default(IList)) @@ -64,7 +64,7 @@ public InboundNATPool() /// Gets or sets the name of the endpoint. /// /// - /// The name must be unique within a Batch pool, can contain letters, + /// The name must be unique within a Batch Pool, can contain letters, /// numbers, underscores, periods, and hyphens. Names must start with a /// letter or number, must end with a letter, number, or underscore, /// and cannot exceed 77 characters. If any invalid values are @@ -83,10 +83,10 @@ public InboundNATPool() public InboundEndpointProtocol Protocol { get; set; } /// - /// Gets or sets the port number on the compute node. + /// Gets or sets the port number on the Compute Node. /// /// - /// This must be unique within a Batch pool. Acceptable values are + /// This must be unique within a Batch Pool. Acceptable values are /// between 1 and 65535 except for 22, 3389, 29876 and 29877 as these /// are reserved. If any reserved values are provided the request fails /// with HTTP status code 400. @@ -97,11 +97,11 @@ public InboundNATPool() /// /// Gets or sets the first port number in the range of external ports /// that will be used to provide inbound access to the backendPort on - /// individual compute nodes. + /// individual Compute Nodes. /// /// /// Acceptable values range between 1 and 65534 except ports from 50000 - /// to 55000 which are reserved. All ranges within a pool must be + /// to 55000 which are reserved. All ranges within a Pool must be /// distinct and cannot overlap. Each range must contain at least 40 /// ports. If any reserved or overlapping values are provided the /// request fails with HTTP status code 400. @@ -112,12 +112,12 @@ public InboundNATPool() /// /// Gets or sets the last port number in the range of external ports /// that will be used to provide inbound access to the backendPort on - /// individual compute nodes. + /// individual Compute Nodes. /// /// /// Acceptable values range between 1 and 65534 except ports from 50000 /// to 55000 which are reserved by the Batch service. All ranges within - /// a pool must be distinct and cannot overlap. Each range must contain + /// a Pool must be distinct and cannot overlap. Each range must contain /// at least 40 ports. If any reserved or overlapping values are /// provided the request fails with HTTP status code 400. /// @@ -130,7 +130,7 @@ public InboundNATPool() /// /// /// The maximum number of rules that can be specified across all the - /// endpoints on a Batch pool is 25. If no network security group rules + /// endpoints on a Batch Pool is 25. If no network security group rules /// are specified, a default rule will be created to allow inbound /// access to the specified backendPort. If the maximum number of /// network security group rules is exceeded the request fails with diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobAction.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobAction.cs index c75cceada9d1..d7408e6bc36e 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobAction.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobAction.cs @@ -27,13 +27,13 @@ public enum JobAction [EnumMember(Value = "none")] None, /// - /// Disable the job. This is equivalent to calling the disable job API, + /// Disable the Job. This is equivalent to calling the disable Job API, /// with a disableTasks value of requeue. /// [EnumMember(Value = "disable")] Disable, /// - /// Terminate the job. The terminateReason in the job's executionInfo + /// Terminate the Job. The terminateReason in the Job's executionInfo /// is set to "TaskFailed". /// [EnumMember(Value = "terminate")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobAddHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobAddHeaders.cs index a9ff9665d714..cc487d1e22d1 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobAddHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobAddHeaders.cs @@ -39,8 +39,8 @@ public JobAddHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public JobAddHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobAddParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobAddParameter.cs index 171bb6222d58..79e5fa0ff27a 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobAddParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobAddParameter.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// An Azure Batch job to add. + /// An Azure Batch Job to add. /// public partial class JobAddParameter { @@ -32,33 +32,33 @@ public JobAddParameter() /// /// Initializes a new instance of the JobAddParameter class. /// - /// A string that uniquely identifies the job within - /// the account. - /// The pool on which the Batch service runs the - /// job's tasks. - /// The display name for the job. - /// The priority of the job. + /// A string that uniquely identifies the Job within + /// the Account. + /// The Pool on which the Batch service runs the + /// Job's Tasks. + /// The display name for the Job. + /// The priority of the Job. /// The execution constraints for the - /// job. - /// Details of a Job Manager task to be - /// launched when the job is started. - /// The Job Preparation task. - /// The Job Release task. + /// Job. + /// Details of a Job Manager Task to be + /// launched when the Job is started. + /// The Job Preparation Task. + /// The Job Release Task. /// The list of common /// environment variable settings. These environment variables are set - /// for all tasks in the job (including the Job Manager, Job - /// Preparation and Job Release tasks). + /// for all Tasks in the Job (including the Job Manager, Job + /// Preparation and Job Release Tasks). /// The action the Batch service - /// should take when all tasks in the job are in the completed + /// should take when all Tasks in the Job are in the completed /// state. /// The action the Batch service should - /// take when any task in the job fails. + /// take when any Task in the Job fails. /// A list of name-value pairs associated with - /// the job as metadata. - /// Whether tasks in the job can + /// the Job as metadata. + /// Whether Tasks in the Job can /// define dependencies on each other. The default is false. /// The network configuration for - /// the job. + /// the Job. public JobAddParameter(string id, PoolInformation poolInfo, string displayName = default(string), int? priority = default(int?), JobConstraints constraints = default(JobConstraints), JobManagerTask jobManagerTask = default(JobManagerTask), JobPreparationTask jobPreparationTask = default(JobPreparationTask), JobReleaseTask jobReleaseTask = default(JobReleaseTask), IList commonEnvironmentSettings = default(IList), OnAllTasksComplete? onAllTasksComplete = default(OnAllTasksComplete?), OnTaskFailure? onTaskFailure = default(OnTaskFailure?), IList metadata = default(IList), bool? usesTaskDependencies = default(bool?), JobNetworkConfiguration networkConfiguration = default(JobNetworkConfiguration)) { Id = id; @@ -84,21 +84,21 @@ public JobAddParameter() partial void CustomInit(); /// - /// Gets or sets a string that uniquely identifies the job within the - /// account. + /// Gets or sets a string that uniquely identifies the Job within the + /// Account. /// /// /// The ID can contain any combination of alphanumeric characters /// including hyphens and underscores, and cannot contain more than 64 /// characters. The ID is case-preserving and case-insensitive (that - /// is, you may not have two IDs within an account that differ only by + /// is, you may not have two IDs within an Account that differ only by /// case). /// [JsonProperty(PropertyName = "id")] public string Id { get; set; } /// - /// Gets or sets the display name for the job. + /// Gets or sets the display name for the Job. /// /// /// The display name need not be unique and can contain any Unicode @@ -108,7 +108,7 @@ public JobAddParameter() public string DisplayName { get; set; } /// - /// Gets or sets the priority of the job. + /// Gets or sets the priority of the Job. /// /// /// Priority values can range from -1000 to 1000, with -1000 being the @@ -119,103 +119,103 @@ public JobAddParameter() public int? Priority { get; set; } /// - /// Gets or sets the execution constraints for the job. + /// Gets or sets the execution constraints for the Job. /// [JsonProperty(PropertyName = "constraints")] public JobConstraints Constraints { get; set; } /// - /// Gets or sets details of a Job Manager task to be launched when the - /// job is started. + /// Gets or sets details of a Job Manager Task to be launched when the + /// Job is started. /// /// - /// If the job does not specify a Job Manager task, the user must - /// explicitly add tasks to the job. If the job does specify a Job - /// Manager task, the Batch service creates the Job Manager task when - /// the job is created, and will try to schedule the Job Manager task - /// before scheduling other tasks in the job. The Job Manager task's - /// typical purpose is to control and/or monitor job execution, for - /// example by deciding what additional tasks to run, determining when - /// the work is complete, etc. (However, a Job Manager task is not - /// restricted to these activities - it is a fully-fledged task in the - /// system and perform whatever actions are required for the job.) For - /// example, a Job Manager task might download a file specified as a + /// If the Job does not specify a Job Manager Task, the user must + /// explicitly add Tasks to the Job. If the Job does specify a Job + /// Manager Task, the Batch service creates the Job Manager Task when + /// the Job is created, and will try to schedule the Job Manager Task + /// before scheduling other Tasks in the Job. The Job Manager Task's + /// typical purpose is to control and/or monitor Job execution, for + /// example by deciding what additional Tasks to run, determining when + /// the work is complete, etc. (However, a Job Manager Task is not + /// restricted to these activities - it is a fully-fledged Task in the + /// system and perform whatever actions are required for the Job.) For + /// example, a Job Manager Task might download a file specified as a /// parameter, analyze the contents of that file and submit additional - /// tasks based on those contents. + /// Tasks based on those contents. /// [JsonProperty(PropertyName = "jobManagerTask")] public JobManagerTask JobManagerTask { get; set; } /// - /// Gets or sets the Job Preparation task. + /// Gets or sets the Job Preparation Task. /// /// - /// If a job has a Job Preparation task, the Batch service will run the - /// Job Preparation task on a compute node before starting any tasks of - /// that job on that compute node. + /// If a Job has a Job Preparation Task, the Batch service will run the + /// Job Preparation Task on a Node before starting any Tasks of that + /// Job on that Compute Node. /// [JsonProperty(PropertyName = "jobPreparationTask")] public JobPreparationTask JobPreparationTask { get; set; } /// - /// Gets or sets the Job Release task. + /// Gets or sets the Job Release Task. /// /// - /// A Job Release task cannot be specified without also specifying a - /// Job Preparation task for the job. The Batch service runs the Job - /// Release task on the compute nodes that have run the Job Preparation - /// task. The primary purpose of the Job Release task is to undo - /// changes to compute nodes made by the Job Preparation task. Example - /// activities include deleting local files, or shutting down services - /// that were started as part of job preparation. + /// A Job Release Task cannot be specified without also specifying a + /// Job Preparation Task for the Job. The Batch service runs the Job + /// Release Task on the Nodes that have run the Job Preparation Task. + /// The primary purpose of the Job Release Task is to undo changes to + /// Compute Nodes made by the Job Preparation Task. Example activities + /// include deleting local files, or shutting down services that were + /// started as part of Job preparation. /// [JsonProperty(PropertyName = "jobReleaseTask")] public JobReleaseTask JobReleaseTask { get; set; } /// /// Gets or sets the list of common environment variable settings. - /// These environment variables are set for all tasks in the job - /// (including the Job Manager, Job Preparation and Job Release tasks). + /// These environment variables are set for all Tasks in the Job + /// (including the Job Manager, Job Preparation and Job Release Tasks). /// /// - /// Individual tasks can override an environment setting specified here + /// Individual Tasks can override an environment setting specified here /// by specifying the same setting name with a different value. /// [JsonProperty(PropertyName = "commonEnvironmentSettings")] public IList CommonEnvironmentSettings { get; set; } /// - /// Gets or sets the pool on which the Batch service runs the job's - /// tasks. + /// Gets or sets the Pool on which the Batch service runs the Job's + /// Tasks. /// [JsonProperty(PropertyName = "poolInfo")] public PoolInformation PoolInfo { get; set; } /// /// Gets or sets the action the Batch service should take when all - /// tasks in the job are in the completed state. + /// Tasks in the Job are in the completed state. /// /// - /// Note that if a job contains no tasks, then all tasks are considered + /// Note that if a Job contains no Tasks, then all Tasks are considered /// complete. This option is therefore most commonly used with a Job - /// Manager task; if you want to use automatic job termination without + /// Manager task; if you want to use automatic Job termination without /// a Job Manager, you should initially set onAllTasksComplete to - /// noaction and update the job properties to set onAllTasksComplete to - /// terminatejob once you have finished adding tasks. The default is + /// noaction and update the Job properties to set onAllTasksComplete to + /// terminatejob once you have finished adding Tasks. The default is /// noaction. Possible values include: 'noAction', 'terminateJob' /// [JsonProperty(PropertyName = "onAllTasksComplete")] public OnAllTasksComplete? OnAllTasksComplete { get; set; } /// - /// Gets or sets the action the Batch service should take when any task - /// in the job fails. + /// Gets or sets the action the Batch service should take when any Task + /// in the Job fails. /// /// - /// A task is considered to have failed if has a failureInfo. A - /// failureInfo is set if the task completes with a non-zero exit code + /// A Task is considered to have failed if has a failureInfo. A + /// failureInfo is set if the Task completes with a non-zero exit code /// after exhausting its retry count, or if there was an error starting - /// the task, for example due to a resource file download error. The + /// the Task, for example due to a resource file download error. The /// default is noaction. Possible values include: 'noAction', /// 'performExitOptionsJobAction' /// @@ -223,7 +223,7 @@ public JobAddParameter() public OnTaskFailure? OnTaskFailure { get; set; } /// - /// Gets or sets a list of name-value pairs associated with the job as + /// Gets or sets a list of name-value pairs associated with the Job as /// metadata. /// /// @@ -234,14 +234,14 @@ public JobAddParameter() public IList Metadata { get; set; } /// - /// Gets or sets whether tasks in the job can define dependencies on + /// Gets or sets whether Tasks in the Job can define dependencies on /// each other. The default is false. /// [JsonProperty(PropertyName = "usesTaskDependencies")] public bool? UsesTaskDependencies { get; set; } /// - /// Gets or sets the network configuration for the job. + /// Gets or sets the network configuration for the Job. /// [JsonProperty(PropertyName = "networkConfiguration")] public JobNetworkConfiguration NetworkConfiguration { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobConstraints.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobConstraints.cs index 8d85cd9ff44c..d023c6042a3e 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobConstraints.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobConstraints.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The execution constraints for a job. + /// The execution constraints for a Job. /// public partial class JobConstraints { @@ -30,9 +30,9 @@ public JobConstraints() /// Initializes a new instance of the JobConstraints class. /// /// The maximum elapsed time that the - /// job may run, measured from the time the job is created. + /// Job may run, measured from the time the Job is created. /// The maximum number of times each - /// task may be retried. The Batch service retries a task if its exit + /// Task may be retried. The Batch service retries a Task if its exit /// code is nonzero. public JobConstraints(System.TimeSpan? maxWallClockTime = default(System.TimeSpan?), int? maxTaskRetryCount = default(int?)) { @@ -47,30 +47,30 @@ public JobConstraints() partial void CustomInit(); /// - /// Gets or sets the maximum elapsed time that the job may run, - /// measured from the time the job is created. + /// Gets or sets the maximum elapsed time that the Job may run, + /// measured from the time the Job is created. /// /// - /// If the job does not complete within the time limit, the Batch - /// service terminates it and any tasks that are still running. In this + /// If the Job does not complete within the time limit, the Batch + /// service terminates it and any Tasks that are still running. In this /// case, the termination reason will be MaxWallClockTimeExpiry. If /// this property is not specified, there is no time limit on how long - /// the job may run. + /// the Job may run. /// [JsonProperty(PropertyName = "maxWallClockTime")] public System.TimeSpan? MaxWallClockTime { get; set; } /// - /// Gets or sets the maximum number of times each task may be retried. - /// The Batch service retries a task if its exit code is nonzero. + /// Gets or sets the maximum number of times each Task may be retried. + /// 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 each task once, and may then retry up to + /// The Batch service will try each Task once, and may then retry up to /// this limit. For example, if the maximum retry count is 3, Batch - /// tries a task up to 4 times (one initial try and 3 retries). If the - /// maximum retry count is 0, the Batch service does not retry tasks. - /// If the maximum retry count is -1, the Batch service retries tasks + /// tries a Task up to 4 times (one initial try and 3 retries). If the + /// maximum retry count is 0, the Batch service does not retry Tasks. + /// If the maximum retry count is -1, the Batch service retries Tasks /// without limit. The default value is 0 (no retries). /// [JsonProperty(PropertyName = "maxTaskRetryCount")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobDeleteHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobDeleteHeaders.cs index 342db11591ab..8882cc09fac7 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobDeleteHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobDeleteHeaders.cs @@ -37,8 +37,8 @@ public JobDeleteHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. public JobDeleteHeaders(string clientRequestId = default(string), string requestId = default(string)) { ClientRequestId = clientRequestId; @@ -65,8 +65,8 @@ public JobDeleteHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public string RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobDisableHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobDisableHeaders.cs index a4bf54b3e9db..a890af9736e9 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobDisableHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobDisableHeaders.cs @@ -39,8 +39,8 @@ public JobDisableHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public JobDisableHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobDisableParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobDisableParameter.cs index de6b2b61223c..e4730db292a5 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobDisableParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobDisableParameter.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Options when disabling a job. + /// Options when disabling a Job. /// public partial class JobDisableParameter { @@ -29,8 +29,8 @@ public JobDisableParameter() /// /// Initializes a new instance of the JobDisableParameter class. /// - /// What to do with active tasks associated - /// with the job. + /// What to do with active Tasks associated + /// with the Job. public JobDisableParameter(DisableJobOption disableTasks) { DisableTasks = disableTasks; @@ -43,7 +43,7 @@ public JobDisableParameter(DisableJobOption disableTasks) partial void CustomInit(); /// - /// Gets or sets what to do with active tasks associated with the job. + /// Gets or sets what to do with active Tasks associated with the Job. /// /// /// Possible values include: 'requeue', 'terminate', 'wait' diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobEnableHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobEnableHeaders.cs index a4c21705a54d..7c968ff18956 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobEnableHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobEnableHeaders.cs @@ -39,8 +39,8 @@ public JobEnableHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public JobEnableHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobExecutionInformation.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobExecutionInformation.cs index 19f59f42435b..a6a96921ab7c 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobExecutionInformation.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobExecutionInformation.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Contains information about the execution of a job in the Azure Batch + /// Contains information about the execution of a Job in the Azure Batch /// service. /// public partial class JobExecutionInformation @@ -30,14 +30,14 @@ public JobExecutionInformation() /// /// Initializes a new instance of the JobExecutionInformation class. /// - /// The start time of the job. - /// The completion time of the job. - /// The ID of the pool to which this job is + /// The start time of the Job. + /// The completion time of the Job. + /// The ID of the Pool to which this Job is /// assigned. /// Details of any error encountered by - /// the service in starting the job. + /// the service in starting the Job. /// A string describing the reason the - /// job ended. + /// Job ended. public JobExecutionInformation(System.DateTime startTime, System.DateTime? endTime = default(System.DateTime?), string poolId = default(string), JobSchedulingError schedulingError = default(JobSchedulingError), string terminateReason = default(string)) { StartTime = startTime; @@ -54,65 +54,65 @@ public JobExecutionInformation() partial void CustomInit(); /// - /// Gets or sets the start time of the job. + /// Gets or sets the start time of the Job. /// /// - /// This is the time at which the job was created. + /// This is the time at which the Job was created. /// [JsonProperty(PropertyName = "startTime")] public System.DateTime StartTime { get; set; } /// - /// Gets or sets the completion time of the job. + /// Gets or sets the completion time of the Job. /// /// - /// This property is set only if the job is in the completed state. + /// This property is set only if the Job is in the completed state. /// [JsonProperty(PropertyName = "endTime")] public System.DateTime? EndTime { get; set; } /// - /// Gets or sets the ID of the pool to which this job is assigned. + /// Gets or sets the ID of the Pool to which this Job is assigned. /// /// - /// This element contains the actual pool where the job is assigned. - /// When you get job details from the service, they also contain a - /// poolInfo element, which contains the pool configuration data from - /// when the job was added or updated. That poolInfo element may also + /// This element contains the actual Pool where the Job is assigned. + /// When you get Job details from the service, they also contain a + /// poolInfo element, which contains the Pool configuration data from + /// when the Job was added or updated. That poolInfo element may also /// contain a poolId element. If it does, the two IDs are the same. If - /// it does not, it means the job ran on an auto pool, and this - /// property contains the ID of that auto pool. + /// it does not, it means the Job ran on an auto Pool, and this + /// property contains the ID of that auto Pool. /// [JsonProperty(PropertyName = "poolId")] public string PoolId { get; set; } /// /// Gets or sets details of any error encountered by the service in - /// starting the job. + /// starting the Job. /// /// - /// This property is not set if there was no error starting the job. + /// This property is not set if there was no error starting the Job. /// [JsonProperty(PropertyName = "schedulingError")] public JobSchedulingError SchedulingError { get; set; } /// - /// Gets or sets a string describing the reason the job ended. + /// Gets or sets a string describing the reason the Job ended. /// /// - /// This property is set only if the job is in the completed state. If - /// the Batch service terminates the job, it sets the reason as - /// follows: JMComplete - the Job Manager task completed, and + /// This property is set only if the Job is in the completed state. If + /// the Batch service terminates the Job, it sets the reason as + /// follows: JMComplete - the Job Manager Task completed, and /// killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the - /// job reached its maxWallClockTime constraint. TerminateJobSchedule - - /// the job ran as part of a schedule, and the schedule terminated. - /// AllTasksComplete - the job's onAllTasksComplete attribute is set to - /// terminatejob, and all tasks in the job are complete. TaskFailed - - /// the job's onTaskFailure attribute is set to - /// performExitOptionsJobAction, and a task in the job failed with an + /// Job reached its maxWallClockTime constraint. TerminateJobSchedule - + /// the Job ran as part of a schedule, and the schedule terminated. + /// AllTasksComplete - the Job's onAllTasksComplete attribute is set to + /// terminatejob, and all Tasks in the Job are complete. TaskFailed - + /// the Job's onTaskFailure attribute is set to + /// performExitOptionsJobAction, and a Task in the Job failed with an /// exit condition that specified a jobAction of terminatejob. Any /// other string is a user-defined reason specified in a call to the - /// 'Terminate a job' operation. + /// 'Terminate a Job' operation. /// [JsonProperty(PropertyName = "terminateReason")] public string TerminateReason { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobGetAllLifetimeStatisticsHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobGetAllLifetimeStatisticsHeaders.cs index a1d0cd60e900..641a3757878d 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobGetAllLifetimeStatisticsHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobGetAllLifetimeStatisticsHeaders.cs @@ -41,8 +41,8 @@ public JobGetAllLifetimeStatisticsHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -78,8 +78,8 @@ public JobGetAllLifetimeStatisticsHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobGetHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobGetHeaders.cs index a946a1a8b20b..eb0864205a20 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobGetHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobGetHeaders.cs @@ -39,8 +39,8 @@ public JobGetHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -76,8 +76,8 @@ public JobGetHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobGetTaskCountsHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobGetTaskCountsHeaders.cs index 0f204059bbe3..6004a4f20fdd 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobGetTaskCountsHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobGetTaskCountsHeaders.cs @@ -37,8 +37,8 @@ public JobGetTaskCountsHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. public JobGetTaskCountsHeaders(System.Guid? clientRequestId = default(System.Guid?), System.Guid? requestId = default(System.Guid?)) { ClientRequestId = clientRequestId; @@ -65,8 +65,8 @@ public JobGetTaskCountsHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListFromJobScheduleHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListFromJobScheduleHeaders.cs index 856665cf8eea..ca7cdd002232 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListFromJobScheduleHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListFromJobScheduleHeaders.cs @@ -41,8 +41,8 @@ public JobListFromJobScheduleHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -78,8 +78,8 @@ public JobListFromJobScheduleHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListFromJobScheduleOptions.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListFromJobScheduleOptions.cs index 30672477ce96..98199e3d0226 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListFromJobScheduleOptions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListFromJobScheduleOptions.cs @@ -39,7 +39,7 @@ public JobListFromJobScheduleOptions() /// An OData $select clause. /// An OData $expand clause. /// The maximum number of items to return in - /// the response. A maximum of 1000 jobs can be returned. + /// the response. A maximum of 1000 Jobs can be returned. /// The maximum time that the server can spend /// processing the request, in seconds. The default is 30 /// seconds. @@ -91,7 +91,7 @@ public JobListFromJobScheduleOptions() /// /// Gets or sets the maximum number of items to return in the response. - /// A maximum of 1000 jobs can be returned. + /// A maximum of 1000 Jobs can be returned. /// [Newtonsoft.Json.JsonIgnore] public int? MaxResults { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListHeaders.cs index de04d0aeac8f..6fa47ef6b0ce 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListHeaders.cs @@ -39,8 +39,8 @@ public JobListHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -76,8 +76,8 @@ public JobListHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListOptions.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListOptions.cs index 7f85af06c1f8..4baa7ee1af69 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListOptions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListOptions.cs @@ -37,7 +37,7 @@ public JobListOptions() /// An OData $select clause. /// An OData $expand clause. /// The maximum number of items to return in - /// the response. A maximum of 1000 jobs can be returned. + /// the response. A maximum of 1000 Jobs can be returned. /// The maximum time that the server can spend /// processing the request, in seconds. The default is 30 /// seconds. @@ -89,7 +89,7 @@ public JobListOptions() /// /// Gets or sets the maximum number of items to return in the response. - /// A maximum of 1000 jobs can be returned. + /// A maximum of 1000 Jobs can be returned. /// [Newtonsoft.Json.JsonIgnore] public int? MaxResults { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListPreparationAndReleaseTaskStatusHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListPreparationAndReleaseTaskStatusHeaders.cs index c87f69802112..7a32d444c06f 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListPreparationAndReleaseTaskStatusHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListPreparationAndReleaseTaskStatusHeaders.cs @@ -41,8 +41,8 @@ public JobListPreparationAndReleaseTaskStatusHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -78,8 +78,8 @@ public JobListPreparationAndReleaseTaskStatusHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListPreparationAndReleaseTaskStatusOptions.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListPreparationAndReleaseTaskStatusOptions.cs index 477da9f0b380..b24c633e04b3 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListPreparationAndReleaseTaskStatusOptions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobListPreparationAndReleaseTaskStatusOptions.cs @@ -39,7 +39,7 @@ public JobListPreparationAndReleaseTaskStatusOptions() /// https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status. /// An OData $select clause. /// The maximum number of items to return in - /// the response. A maximum of 1000 tasks can be returned. + /// the response. A maximum of 1000 Tasks can be returned. /// The maximum time that the server can spend /// processing the request, in seconds. The default is 30 /// seconds. @@ -84,7 +84,7 @@ public JobListPreparationAndReleaseTaskStatusOptions() /// /// Gets or sets the maximum number of items to return in the response. - /// A maximum of 1000 tasks can be returned. + /// A maximum of 1000 Tasks can be returned. /// [Newtonsoft.Json.JsonIgnore] public int? MaxResults { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobManagerTask.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobManagerTask.cs index ac937b6773a9..67360f132bd9 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobManagerTask.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobManagerTask.cs @@ -16,33 +16,33 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Specifies details of a Job Manager task. + /// Specifies details of a Job Manager Task. /// /// - /// The Job Manager task is automatically started when the job is created. - /// The Batch service tries to schedule the Job Manager task before any - /// other tasks in the job. When shrinking a pool, the Batch service tries - /// to preserve compute nodes where Job Manager tasks are running for as - /// long as possible (that is, nodes running 'normal' tasks are removed - /// before nodes running Job Manager tasks). When a Job Manager task fails - /// and needs to be restarted, the system tries to schedule it at the - /// highest priority. If there are no idle nodes available, the system may - /// terminate one of the running tasks in the pool and return it to the - /// queue in order to make room for the Job Manager task to restart. Note - /// 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. 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 + /// The Job Manager Task is automatically started when the Job is created. + /// The Batch service tries to schedule the Job Manager Task before any + /// other Tasks in the Job. When shrinking a Pool, the Batch service tries + /// to preserve Nodes where Job Manager Tasks are running for as long as + /// possible (that is, Compute Nodes running 'normal' Tasks are removed + /// before Compute Nodes running Job Manager Tasks). When a Job Manager + /// Task fails and needs to be restarted, the system tries to schedule it + /// at the highest priority. If there are no idle Compute Nodes available, + /// the system may terminate one of the running Tasks in the Pool and + /// return it to the queue in order to make room for the Job Manager Task + /// to restart. Note 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. Batch will retry Tasks when a recovery operation is triggered on a + /// Node. Examples of recovery operations include (but are not limited to) + /// when an unhealthy 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 + /// 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. + /// Tasks is to use some form of checkpointing. /// public partial class JobManagerTask { @@ -58,37 +58,37 @@ public JobManagerTask() /// Initializes a new instance of the JobManagerTask class. /// /// A string that uniquely identifies the Job Manager - /// task within the job. + /// Task within the Job. /// The command line of the Job Manager - /// task. + /// Task. /// The display name of the Job Manager - /// task. + /// Task. /// The settings for the container - /// under which the Job Manager task runs. + /// under which the Job Manager Task runs. /// A list of files that the Batch service - /// will download to the compute node before running the command + /// will download to the Compute Node before running the command /// line. /// A list of files that the Batch service - /// will upload from the compute node after running the command + /// will upload from the Compute Node after running the command /// line. /// A list of environment variable - /// settings for the Job Manager task. + /// settings for the Job Manager Task. /// Constraints that apply to the Job Manager - /// task. + /// Task. /// Whether completion of the Job - /// Manager task signifies completion of the entire job. + /// Manager Task signifies completion of the entire Job. /// The user identity under which the Job - /// Manager task runs. - /// Whether the Job Manager task requires - /// exclusive use of the compute node where it runs. - /// A list of application - /// packages that the Batch service will deploy to the compute node + /// Manager Task runs. + /// Whether the Job Manager Task requires + /// exclusive use of the Compute Node where it runs. + /// A list of Application + /// Packages that the Batch service will deploy to the Compute Node /// before running the command line. /// The settings for an - /// authentication token that the task can use to perform Batch service + /// authentication token that the Task can use to perform Batch service /// operations. - /// Whether the Job Manager task may - /// run on a low-priority compute node. + /// Whether the Job Manager Task may + /// run on a low-priority Compute Node. public JobManagerTask(string id, string commandLine, string displayName = default(string), TaskContainerSettings containerSettings = default(TaskContainerSettings), IList resourceFiles = default(IList), IList outputFiles = default(IList), IList environmentSettings = default(IList), TaskConstraints constraints = default(TaskConstraints), bool? killJobOnCompletion = default(bool?), UserIdentity userIdentity = default(UserIdentity), bool? runExclusive = default(bool?), IList applicationPackageReferences = default(IList), AuthenticationTokenSettings authenticationTokenSettings = default(AuthenticationTokenSettings), bool? allowLowPriorityNode = default(bool?)) { Id = id; @@ -114,8 +114,8 @@ public JobManagerTask() partial void CustomInit(); /// - /// Gets or sets a string that uniquely identifies the Job Manager task - /// within the job. + /// Gets or sets a string that uniquely identifies the Job Manager Task + /// within the Job. /// /// /// The ID can contain any combination of alphanumeric characters @@ -126,7 +126,7 @@ public JobManagerTask() public string Id { get; set; } /// - /// Gets or sets the display name of the Job Manager task. + /// Gets or sets the display name of the Job Manager Task. /// /// /// It need not be unique and can contain any Unicode characters up to @@ -136,7 +136,7 @@ public JobManagerTask() public string DisplayName { get; set; } /// - /// Gets or sets the command line of the Job Manager task. + /// Gets or sets the command line of the Job Manager Task. /// /// /// The command line does not run under a shell, and therefore cannot @@ -145,7 +145,7 @@ public JobManagerTask() /// 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 + /// (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). /// @@ -154,16 +154,16 @@ public JobManagerTask() /// /// Gets or sets the settings for the container under which the Job - /// Manager task runs. + /// Manager Task runs. /// /// - /// If the pool that will run this task has containerConfiguration set, - /// this must be set as well. If the pool that will run this task + /// If the Pool that will run this Task has containerConfiguration set, + /// this must be set as well. If the Pool that will run this Task /// doesn't have containerConfiguration 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 + /// 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. Files produced in the container outside /// of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, /// meaning that Batch file APIs will not be able to access those @@ -174,10 +174,10 @@ public JobManagerTask() /// /// Gets or sets a list of files that the Batch service will download - /// to the compute node before running the command line. + /// to the Compute Node before running the command line. /// /// - /// Files listed under this element are located in the task's working + /// Files listed under this element are located in the Task's working /// directory. There is a maximum size for the list of resource files. /// When the max size is exceeded, the request will fail and the /// response error code will be RequestEntityTooLarge. If this occurs, @@ -190,112 +190,112 @@ public JobManagerTask() /// /// Gets or sets a list of files that the Batch service will upload - /// from the compute node after running the command line. + /// from the Compute Node after running the command line. /// /// - /// For multi-instance tasks, the files will only be uploaded from the - /// compute node on which the primary task is executed. + /// For multi-instance Tasks, the files will only be uploaded from the + /// Compute Node on which the primary Task is executed. /// [JsonProperty(PropertyName = "outputFiles")] public IList OutputFiles { get; set; } /// /// Gets or sets a list of environment variable settings for the Job - /// Manager task. + /// Manager Task. /// [JsonProperty(PropertyName = "environmentSettings")] public IList EnvironmentSettings { get; set; } /// - /// Gets or sets constraints that apply to the Job Manager task. + /// Gets or sets constraints that apply to the Job Manager Task. /// [JsonProperty(PropertyName = "constraints")] public TaskConstraints Constraints { get; set; } /// - /// Gets or sets whether completion of the Job Manager task signifies - /// completion of the entire job. + /// Gets or sets whether completion of the Job Manager Task signifies + /// completion of the entire Job. /// /// - /// If true, when the Job Manager task completes, the Batch service - /// marks the job as complete. If any tasks are still running at this - /// time (other than Job Release), those tasks are terminated. If - /// false, the completion of the Job Manager task does not affect the - /// job status. In this case, you should either use the - /// onAllTasksComplete attribute to terminate the job, or have a client - /// or user terminate the job explicitly. An example of this is if the - /// Job Manager creates a set of tasks but then takes no further role + /// If true, when the Job Manager Task completes, the Batch service + /// marks the Job as complete. If any Tasks are still running at this + /// time (other than Job Release), those Tasks are terminated. If + /// false, the completion of the Job Manager Task does not affect the + /// Job status. In this case, you should either use the + /// onAllTasksComplete attribute to terminate the Job, or have a client + /// or user terminate the Job explicitly. An example of this is if the + /// Job Manager creates a set of Tasks but then takes no further role /// in their execution. The default value is true. If you are using the - /// onAllTasksComplete and onTaskFailure attributes to control job - /// lifetime, and using the Job Manager task only to create the tasks - /// for the job (not to monitor progress), then it is important to set + /// onAllTasksComplete and onTaskFailure attributes to control Job + /// lifetime, and using the Job Manager Task only to create the Tasks + /// for the Job (not to monitor progress), then it is important to set /// killJobOnCompletion to false. /// [JsonProperty(PropertyName = "killJobOnCompletion")] public bool? KillJobOnCompletion { get; set; } /// - /// Gets or sets the user identity under which the Job Manager task + /// Gets or sets the user identity under which the Job Manager Task /// runs. /// /// - /// If omitted, the task runs as a non-administrative user unique to - /// the task. + /// If omitted, the Task runs as a non-administrative user unique to + /// the Task. /// [JsonProperty(PropertyName = "userIdentity")] public UserIdentity UserIdentity { get; set; } /// - /// Gets or sets whether the Job Manager task requires exclusive use of - /// the compute node where it runs. + /// Gets or sets whether the Job Manager Task requires exclusive use of + /// the Compute Node where it runs. /// /// - /// If true, no other tasks will run on the same compute node for as - /// long as the Job Manager is running. If false, other tasks can run - /// simultaneously with the Job Manager on a compute node. The Job - /// Manager task counts normally against the node's concurrent task - /// limit, so this is only relevant if the node allows multiple - /// concurrent tasks. The default value is true. + /// If true, no other Tasks will run on the same Node for as long as + /// the Job Manager is running. If false, other Tasks can run + /// simultaneously with the Job Manager on a Compute Node. The Job + /// Manager Task counts normally against the Compute Node's concurrent + /// Task limit, so this is only relevant if the Compute Node allows + /// multiple concurrent Tasks. The default value is true. /// [JsonProperty(PropertyName = "runExclusive")] public bool? RunExclusive { get; set; } /// - /// Gets or sets a list of application packages that the Batch service - /// will deploy to the compute node before running the command line. + /// Gets or sets a list of Application Packages that the Batch service + /// will deploy to the Compute Node before running the command line. /// /// - /// Application packages are downloaded and deployed to a shared - /// directory, not the task working directory. Therefore, if a - /// referenced package is already on the compute node, and is up to - /// date, then it is not re-downloaded; the existing copy on the - /// compute node is used. If a referenced application package cannot be - /// installed, for example because the package has been deleted or - /// because download failed, the task fails. + /// Application Packages are downloaded and deployed to a shared + /// directory, not the Task working directory. Therefore, if a + /// referenced Application Package is already on the Compute Node, and + /// is up to date, then it is not re-downloaded; the existing copy on + /// the Compute Node is used. If a referenced Application Package + /// cannot be installed, for example because the package has been + /// deleted or because download failed, the Task fails. /// [JsonProperty(PropertyName = "applicationPackageReferences")] public IList ApplicationPackageReferences { get; set; } /// - /// Gets or sets the settings for an authentication token that the task + /// Gets or sets the settings for an authentication token that the Task /// can use to perform Batch service operations. /// /// - /// If this property is set, the Batch service provides the task with + /// 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 + /// 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 under the job. + /// 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 under the Job. /// [JsonProperty(PropertyName = "authenticationTokenSettings")] public AuthenticationTokenSettings AuthenticationTokenSettings { get; set; } /// - /// Gets or sets whether the Job Manager task may run on a low-priority - /// compute node. + /// Gets or sets whether the Job Manager Task may run on a low-priority + /// Compute Node. /// /// /// The default value is true. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobNetworkConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobNetworkConfiguration.cs index 4419886b699a..c471cf658753 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobNetworkConfiguration.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobNetworkConfiguration.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The network configuration for the job. + /// The network configuration for the Job. /// public partial class JobNetworkConfiguration { @@ -30,9 +30,9 @@ public JobNetworkConfiguration() /// Initializes a new instance of the JobNetworkConfiguration class. /// /// The ARM resource identifier of the virtual - /// network subnet which nodes running tasks from the job will join for - /// the duration of the task. This will only work with a - /// VirtualMachineConfiguration pool. + /// network subnet which Compute Nodes running Tasks from the Job will + /// join for the duration of the Task. This will only work with a + /// VirtualMachineConfiguration Pool. public JobNetworkConfiguration(string subnetId) { SubnetId = subnetId; @@ -46,27 +46,27 @@ public JobNetworkConfiguration(string subnetId) /// /// Gets or sets the ARM resource identifier of the virtual network - /// subnet which nodes running tasks from the job will join for the - /// duration of the task. This will only work with a - /// VirtualMachineConfiguration pool. + /// subnet which Compute Nodes running Tasks from the Job will join for + /// the duration of the Task. This will only work with a + /// VirtualMachineConfiguration Pool. /// /// /// The virtual network must be in the same region and subscription as - /// the Azure Batch account. The specified subnet should have enough - /// free IP addresses to accommodate the number of nodes which will run - /// tasks from the job. This can be up to the number of nodes in the - /// pool. The 'MicrosoftAzureBatch' service principal must have the - /// 'Classic Virtual Machine Contributor' Role-Based Access Control - /// (RBAC) role for the specified VNet so that Azure Batch service can - /// schedule tasks on the compute nodes. This can be verified by - /// checking if the specified VNet has any associated Network Security - /// Groups (NSG). If communication to the compute nodes in the + /// the Azure Batch Account. The specified subnet should have enough + /// free IP addresses to accommodate the number of Compute Nodes which + /// will run Tasks from the Job. This can be up to the number of + /// Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service + /// principal must have the 'Classic Virtual Machine Contributor' + /// Role-Based Access Control (RBAC) role for the specified VNet so + /// that Azure Batch service can schedule Tasks on the Nodes. This can + /// be verified by checking if the specified VNet has any associated + /// Network Security Groups (NSG). If communication to the Nodes in the /// specified subnet is denied by an NSG, then the Batch service will - /// set the state of the compute nodes to unusable. This is of the form + /// set the state of the Compute Nodes to unusable. This is of the form /// /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. /// If the specified VNet has any associated Network Security Groups /// (NSG), then a few reserved system ports must be enabled for inbound - /// communication from the Azure Batch service. For pools created with + /// communication from the Azure Batch service. For Pools created with /// a Virtual Machine configuration, enable ports 29876 and 29877, as /// well as port 22 for Linux and port 3389 for Windows. Port 443 is /// also required to be open for outbound connections for diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPatchHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPatchHeaders.cs index 5e14a0e43802..200637f1ec41 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPatchHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPatchHeaders.cs @@ -39,8 +39,8 @@ public JobPatchHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public JobPatchHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPatchParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPatchParameter.cs index 20f467dde5ec..be75da1f8472 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPatchParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPatchParameter.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The set of changes to be made to a job. + /// The set of changes to be made to a Job. /// public partial class JobPatchParameter { @@ -31,16 +31,16 @@ public JobPatchParameter() /// /// Initializes a new instance of the JobPatchParameter class. /// - /// The priority of the job. + /// The priority of the Job. /// The action the Batch service - /// should take when all tasks in the job are in the completed + /// should take when all Tasks in the Job are in the completed /// state. /// The execution constraints for the - /// job. - /// The pool on which the Batch service runs the - /// job's tasks. + /// Job. + /// The Pool on which the Batch service runs the + /// Job's Tasks. /// A list of name-value pairs associated with - /// the job as metadata. + /// the Job as metadata. public JobPatchParameter(int? priority = default(int?), OnAllTasksComplete? onAllTasksComplete = default(OnAllTasksComplete?), JobConstraints constraints = default(JobConstraints), PoolInformation poolInfo = default(PoolInformation), IList metadata = default(IList)) { Priority = priority; @@ -57,24 +57,24 @@ public JobPatchParameter() partial void CustomInit(); /// - /// Gets or sets the priority of the job. + /// Gets or sets the priority of the Job. /// /// /// Priority values can range from -1000 to 1000, with -1000 being the /// lowest priority and 1000 being the highest priority. If omitted, - /// the priority of the job is left unchanged. + /// the priority of the Job is left unchanged. /// [JsonProperty(PropertyName = "priority")] public int? Priority { get; set; } /// /// Gets or sets the action the Batch service should take when all - /// tasks in the job are in the completed state. + /// Tasks in the Job are in the completed state. /// /// /// If omitted, the completion behavior is left unchanged. You may not /// change the value from terminatejob to noaction - that is, once you - /// have engaged automatic job termination, you cannot turn it off + /// have engaged automatic Job termination, you cannot turn it off /// again. If you try to do this, the request fails with an 'invalid /// property value' error response; if you are calling the REST API /// directly, the HTTP status code is 400 (Bad Request). Possible @@ -84,7 +84,7 @@ public JobPatchParameter() public OnAllTasksComplete? OnAllTasksComplete { get; set; } /// - /// Gets or sets the execution constraints for the job. + /// Gets or sets the execution constraints for the Job. /// /// /// If omitted, the existing execution constraints are left unchanged. @@ -93,27 +93,28 @@ public JobPatchParameter() public JobConstraints Constraints { get; set; } /// - /// Gets or sets the pool on which the Batch service runs the job's - /// tasks. + /// Gets or sets the Pool on which the Batch service runs the Job's + /// Tasks. /// /// - /// You may change the pool for a job only when the job is disabled. + /// You may change the Pool for a Job only when the Job is disabled. /// The Patch Job call will fail if you include the poolInfo element - /// and the job is not disabled. If you specify an - /// autoPoolSpecification specification in the poolInfo, only the - /// keepAlive property can be updated, and then only if the auto pool - /// has a poolLifetimeOption of job. If omitted, the job continues to - /// run on its current pool. + /// and the Job is not disabled. If you specify an + /// autoPoolSpecification in the poolInfo, only the keepAlive property + /// of the autoPoolSpecification can be updated, and then only if the + /// autoPoolSpecification has a poolLifetimeOption of Job (other job + /// properties can be updated as normal). If omitted, the Job continues + /// to run on its current Pool. /// [JsonProperty(PropertyName = "poolInfo")] public PoolInformation PoolInfo { get; set; } /// - /// Gets or sets a list of name-value pairs associated with the job as + /// Gets or sets a list of name-value pairs associated with the Job as /// metadata. /// /// - /// If omitted, the existing job metadata is left unchanged. + /// If omitted, the existing Job metadata is left unchanged. /// [JsonProperty(PropertyName = "metadata")] public IList Metadata { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPreparationAndReleaseTaskExecutionInformation.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPreparationAndReleaseTaskExecutionInformation.cs index 3f54e238c1ee..5043b4dde9c7 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPreparationAndReleaseTaskExecutionInformation.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPreparationAndReleaseTaskExecutionInformation.cs @@ -14,8 +14,8 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The status of the Job Preparation and Job Release tasks on a compute - /// node. + /// The status of the Job Preparation and Job Release Tasks on a Compute + /// Node. /// public partial class JobPreparationAndReleaseTaskExecutionInformation { @@ -32,18 +32,18 @@ public JobPreparationAndReleaseTaskExecutionInformation() /// Initializes a new instance of the /// JobPreparationAndReleaseTaskExecutionInformation class. /// - /// The ID of the pool containing the compute node + /// The ID of the Pool containing the Compute Node /// to which this entry refers. - /// The ID of the compute node to which this entry + /// The ID of the Compute Node to which this entry /// refers. - /// The URL of the compute node to which this + /// The URL of the Compute Node to which this /// entry refers. /// Information about the - /// execution status of the Job Preparation task on this compute - /// node. + /// execution status of the Job Preparation Task on this Compute + /// Node. /// Information about the - /// execution status of the Job Release task on this compute - /// node. + /// execution status of the Job Release Task on this Compute + /// Node. public JobPreparationAndReleaseTaskExecutionInformation(string poolId = default(string), string nodeId = default(string), string nodeUrl = default(string), JobPreparationTaskExecutionInformation jobPreparationTaskExecutionInfo = default(JobPreparationTaskExecutionInformation), JobReleaseTaskExecutionInformation jobReleaseTaskExecutionInfo = default(JobReleaseTaskExecutionInformation)) { PoolId = poolId; @@ -60,20 +60,20 @@ public JobPreparationAndReleaseTaskExecutionInformation() partial void CustomInit(); /// - /// Gets or sets the ID of the pool containing the compute node to + /// Gets or sets the ID of the Pool containing the Compute Node to /// which this entry refers. /// [JsonProperty(PropertyName = "poolId")] public string PoolId { get; set; } /// - /// Gets or sets the ID of the compute node to which this entry refers. + /// Gets or sets the ID of the Compute Node to which this entry refers. /// [JsonProperty(PropertyName = "nodeId")] public string NodeId { get; set; } /// - /// Gets or sets the URL of the compute node to which this entry + /// Gets or sets the URL of the Compute Node to which this entry /// refers. /// [JsonProperty(PropertyName = "nodeUrl")] @@ -81,18 +81,18 @@ public JobPreparationAndReleaseTaskExecutionInformation() /// /// Gets or sets information about the execution status of the Job - /// Preparation task on this compute node. + /// Preparation Task on this Compute Node. /// [JsonProperty(PropertyName = "jobPreparationTaskExecutionInfo")] public JobPreparationTaskExecutionInformation JobPreparationTaskExecutionInfo { get; set; } /// /// Gets or sets information about the execution status of the Job - /// Release task on this compute node. + /// Release Task on this Compute Node. /// /// - /// This property is set only if the Job Release task has run on the - /// node. + /// This property is set only if the Job Release Task has run on the + /// Compute Node. /// [JsonProperty(PropertyName = "jobReleaseTaskExecutionInfo")] public JobReleaseTaskExecutionInformation JobReleaseTaskExecutionInfo { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPreparationTask.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPreparationTask.cs index d7e1b183a9ab..d5fae71a020a 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPreparationTask.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPreparationTask.cs @@ -16,39 +16,37 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// A Job Preparation task to run before any tasks of the job on any given - /// compute node. + /// A Job Preparation Task to run before any Tasks of the Job on any given + /// Compute Node. /// /// - /// You can use Job Preparation to prepare a compute node to run tasks for - /// the job. Activities commonly performed in Job Preparation include: - /// Downloading common resource files used by all the tasks in the job. The - /// Job Preparation task can download these common resource files to the - /// shared location on the compute node. (AZ_BATCH_NODE_ROOT_DIR\shared), - /// or starting a local service on the compute node so that all tasks of - /// that job can communicate with it. If the Job Preparation task fails - /// (that is, exhausts its retry count before exiting with exit code 0), - /// Batch will not run tasks of this job on the compute node. The node - /// remains ineligible to run tasks of this job until it is reimaged. The - /// node remains active and can be used for other jobs. The Job Preparation - /// task can run multiple times on the same compute node. Therefore, you - /// should write the Job Preparation task to handle re-execution. If the - /// compute node is rebooted, the Job Preparation task is run again on the - /// node before scheduling any other task of the job, if - /// 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. + /// You can use Job Preparation to prepare a Node to run Tasks for the Job. + /// Activities commonly performed in Job Preparation include: Downloading + /// common resource files used by all the Tasks in the Job. The Job + /// Preparation Task can download these common resource files to the shared + /// location on the Node. (AZ_BATCH_NODE_ROOT_DIR\shared), or starting a + /// local service on the Node so that all Tasks of that Job can communicate + /// with it. If the Job Preparation Task fails (that is, exhausts its retry + /// count before exiting with exit code 0), Batch will not run Tasks of + /// this Job on the Node. The Compute Node remains ineligible to run Tasks + /// of this Job until it is reimaged. The Compute Node remains active and + /// can be used for other Jobs. The Job Preparation Task can run multiple + /// times on the same Node. Therefore, you should write the Job Preparation + /// Task to handle re-execution. If the Node is rebooted, the Job + /// Preparation Task is run again on the Compute Node before scheduling any + /// other Task of the Job, if rerunOnNodeRebootAfterSuccess is true or if + /// the Job Preparation Task did not previously complete. If the 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 Node. Examples of recovery operations include (but are + /// not limited to) when an unhealthy 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 { @@ -64,27 +62,27 @@ public JobPreparationTask() /// Initializes a new instance of the JobPreparationTask class. /// /// The command line of the Job Preparation - /// task. + /// Task. /// A string that uniquely identifies the Job - /// Preparation task within the job. + /// Preparation Task within the Job. /// The settings for the container - /// under which the Job Preparation task runs. + /// under which the Job Preparation Task runs. /// A list of files that the Batch service - /// will download to the compute node before running the command + /// will download to the Compute Node before running the command /// line. /// A list of environment variable - /// settings for the Job Preparation task. + /// settings for the Job Preparation Task. /// Constraints that apply to the Job - /// Preparation task. + /// Preparation Task. /// Whether the Batch service should wait - /// for the Job Preparation task to complete successfully before - /// scheduling any other tasks of the job on the compute node. A Job - /// Preparation task has completed successfully if it exits with exit + /// for the Job Preparation Task to complete successfully before + /// scheduling any other Tasks of the Job on the Compute Node. A Job + /// Preparation Task has completed successfully if it exits with exit /// code 0. /// The user identity under which the Job - /// Preparation task runs. + /// Preparation Task runs. /// Whether the Batch - /// service should rerun the Job Preparation task after a compute node + /// service should rerun the Job Preparation Task after a Compute Node /// reboots. public JobPreparationTask(string commandLine, string id = default(string), TaskContainerSettings containerSettings = default(TaskContainerSettings), IList resourceFiles = default(IList), IList environmentSettings = default(IList), TaskConstraints constraints = default(TaskConstraints), bool? waitForSuccess = default(bool?), UserIdentity userIdentity = default(UserIdentity), bool? rerunOnNodeRebootAfterSuccess = default(bool?)) { @@ -107,15 +105,15 @@ public JobPreparationTask() /// /// Gets or sets a string that uniquely identifies the Job Preparation - /// task within the job. + /// Task within the Job. /// /// /// The ID can contain any combination of alphanumeric characters /// including hyphens and underscores and cannot contain more than 64 /// characters. If you do not specify this property, the Batch service - /// assigns a default value of 'jobpreparation'. No other task in the - /// job can have the same ID as the Job Preparation task. If you try to - /// submit a task with the same id, the Batch service rejects the + /// assigns a default value of 'jobpreparation'. No other Task in the + /// Job can have the same ID as the Job Preparation Task. If you try to + /// submit a Task with the same id, the Batch service rejects the /// request with error code TaskIdSameAsJobPreparationTask; if you are /// calling the REST API directly, the HTTP status code is 409 /// (Conflict). @@ -124,7 +122,7 @@ public JobPreparationTask() public string Id { get; set; } /// - /// Gets or sets the command line of the Job Preparation task. + /// Gets or sets the command line of the Job Preparation Task. /// /// /// The command line does not run under a shell, and therefore cannot @@ -133,7 +131,7 @@ public JobPreparationTask() /// 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 + /// (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). /// @@ -142,13 +140,13 @@ public JobPreparationTask() /// /// Gets or sets the settings for the container under which the Job - /// Preparation task runs. + /// Preparation Task runs. /// /// /// 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 + /// 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. Files produced in the container outside /// of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, /// meaning that Batch file APIs will not be able to access those @@ -159,10 +157,10 @@ public JobPreparationTask() /// /// Gets or sets a list of files that the Batch service will download - /// to the compute node before running the command line. + /// to the Compute Node before running the command line. /// /// - /// Files listed under this element are located in the task's working + /// Files listed under this element are located in the Task's working /// directory. There is a maximum size for the list of resource files. /// When the max size is exceeded, the request will fail and the /// response error code will be RequestEntityTooLarge. If this occurs, @@ -175,61 +173,61 @@ public JobPreparationTask() /// /// Gets or sets a list of environment variable settings for the Job - /// Preparation task. + /// Preparation Task. /// [JsonProperty(PropertyName = "environmentSettings")] public IList EnvironmentSettings { get; set; } /// - /// Gets or sets constraints that apply to the Job Preparation task. + /// Gets or sets constraints that apply to the Job Preparation Task. /// [JsonProperty(PropertyName = "constraints")] public TaskConstraints Constraints { get; set; } /// /// Gets or sets whether the Batch service should wait for the Job - /// Preparation task to complete successfully before scheduling any - /// other tasks of the job on the compute node. A Job Preparation task + /// Preparation Task to complete successfully before scheduling any + /// other Tasks of the Job on the Compute Node. A Job Preparation Task /// has completed successfully if it exits with exit code 0. /// /// - /// If true and the Job Preparation task fails on a compute node, the - /// Batch service retries the Job Preparation task up to its maximum - /// retry count (as specified in the constraints element). If the task - /// has still not completed successfully after all retries, then the - /// Batch service will not schedule tasks of the job to the compute - /// node. The compute node remains active and eligible to run tasks of - /// other jobs. If false, the Batch service will not wait for the Job - /// Preparation task to complete. In this case, other tasks of the job - /// can start executing on the compute node while the Job Preparation - /// task is still running; and even if the Job Preparation task fails, - /// new tasks will continue to be scheduled on the node. The default - /// value is true. + /// If true and the Job Preparation Task fails on a Node, the Batch + /// service retries the Job Preparation Task up to its maximum retry + /// count (as specified in the constraints element). If the Task has + /// still not completed successfully after all retries, then the Batch + /// service will not schedule Tasks of the Job to the Node. The Node + /// remains active and eligible to run Tasks of other Jobs. If false, + /// the Batch service will not wait for the Job Preparation Task to + /// complete. In this case, other Tasks of the Job can start executing + /// on the Compute Node while the Job Preparation Task is still + /// running; and even if the Job Preparation Task fails, new Tasks will + /// continue to be scheduled on the Compute Node. The default value is + /// true. /// [JsonProperty(PropertyName = "waitForSuccess")] public bool? WaitForSuccess { get; set; } /// - /// Gets or sets the user identity under which the Job Preparation task + /// Gets or sets the user identity under which the Job Preparation Task /// runs. /// /// - /// If omitted, the task runs as a non-administrative user unique to - /// the task on Windows nodes, or a non-administrative user unique to - /// the pool on Linux nodes. + /// If omitted, the Task runs as a non-administrative user unique to + /// the Task on Windows Compute Nodes, or a non-administrative user + /// unique to the Pool on Linux Compute Nodes. /// [JsonProperty(PropertyName = "userIdentity")] public UserIdentity UserIdentity { get; set; } /// /// Gets or sets whether the Batch service should rerun the Job - /// Preparation task after a compute node reboots. + /// Preparation Task after a Compute Node reboots. /// /// - /// 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 + /// 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. The default value is /// true. /// diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPreparationTaskExecutionInformation.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPreparationTaskExecutionInformation.cs index ff52d04887db..a2cab6cd2a6e 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPreparationTaskExecutionInformation.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPreparationTaskExecutionInformation.cs @@ -14,8 +14,8 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Contains information about the execution of a Job Preparation task on a - /// compute node. + /// Contains information about the execution of a Job Preparation Task on a + /// Compute Node. /// public partial class JobPreparationTaskExecutionInformation { @@ -32,32 +32,32 @@ public JobPreparationTaskExecutionInformation() /// Initializes a new instance of the /// JobPreparationTaskExecutionInformation class. /// - /// The time at which the task started + /// The time at which the Task started /// running. - /// The current state of the Job Preparation task - /// on the compute node. - /// The number of times the task has been + /// The current state of the Job Preparation Task + /// on the Compute Node. + /// The number of times the Task has been /// retried by the Batch service. Task application failures (non-zero - /// exit code) are retried, pre-processing errors (the task could not + /// exit code) are retried, pre-processing errors (the Task could not /// be run) and file upload errors are not retried. The Batch service - /// will retry the task up to the limit specified by the + /// will retry the Task up to the limit specified by the /// constraints. - /// The time at which the Job Preparation task + /// The time at which the Job Preparation Task /// completed. /// The root directory of the Job - /// Preparation task on the compute node. You can use this path to - /// retrieve files created by the task, such as log files. + /// Preparation Task on the Compute Node. You can use this path to + /// retrieve files created by the Task, such as log files. /// The URL to the root directory of - /// the Job Preparation task on the compute node. + /// the Job Preparation Task on the Compute Node. /// The exit code of the program specified on - /// the task command line. + /// the Task command line. /// Information about the container under - /// which the task is executing. - /// Information describing the task failure, + /// which the Task is executing. + /// Information describing the Task failure, /// if any. /// The most recent time at which a retry - /// of the Job Preparation task started running. - /// The result of the task execution. + /// of the Job Preparation Task started running. + /// The result of the Task execution. public JobPreparationTaskExecutionInformation(System.DateTime startTime, JobPreparationTaskState state, int retryCount, System.DateTime? endTime = default(System.DateTime?), string taskRootDirectory = default(string), string taskRootDirectoryUrl = default(string), int? exitCode = default(int?), TaskContainerExecutionInformation containerInfo = default(TaskContainerExecutionInformation), TaskFailureInformation failureInfo = default(TaskFailureInformation), System.DateTime? lastRetryTime = default(System.DateTime?), TaskExecutionResult? result = default(TaskExecutionResult?)) { StartTime = startTime; @@ -80,27 +80,27 @@ public JobPreparationTaskExecutionInformation() partial void CustomInit(); /// - /// Gets or sets the time at which the task started running. + /// Gets or sets the time at which the Task started running. /// /// - /// If the task has been restarted or retried, this is the most recent - /// time at which the task started running. + /// If the Task has been restarted or retried, this is the most recent + /// time at which the Task started running. /// [JsonProperty(PropertyName = "startTime")] public System.DateTime StartTime { get; set; } /// - /// Gets or sets the time at which the Job Preparation task completed. + /// Gets or sets the time at which the Job Preparation Task completed. /// /// - /// This property is set only if the task is in the Completed state. + /// This property is set only if the Task is in the Completed state. /// [JsonProperty(PropertyName = "endTime")] public System.DateTime? EndTime { get; set; } /// - /// Gets or sets the current state of the Job Preparation task on the - /// compute node. + /// Gets or sets the current state of the Job Preparation Task on the + /// Compute Node. /// /// /// Possible values include: 'running', 'completed' @@ -109,68 +109,68 @@ public JobPreparationTaskExecutionInformation() public JobPreparationTaskState State { get; set; } /// - /// Gets or sets the root directory of the Job Preparation task on the - /// compute node. You can use this path to retrieve files created by - /// the task, such as log files. + /// Gets or sets the root directory of the Job Preparation Task on the + /// Compute Node. You can use this path to retrieve files created by + /// the Task, such as log files. /// [JsonProperty(PropertyName = "taskRootDirectory")] public string TaskRootDirectory { get; set; } /// /// Gets or sets the URL to the root directory of the Job Preparation - /// task on the compute node. + /// Task on the Compute Node. /// [JsonProperty(PropertyName = "taskRootDirectoryUrl")] public string TaskRootDirectoryUrl { get; set; } /// - /// Gets or sets the exit code of the program specified on the task + /// Gets or sets the exit code of the program specified on the Task /// command line. /// /// - /// This parameter is returned only if the task is in the completed + /// This parameter is returned only if the Task is in the completed /// state. The exit code for a process reflects the specific convention /// implemented by the application developer for that process. If you /// use the exit code value to make decisions in your code, be sure /// that you know the exit code convention used by the application /// process. Note that the exit code may also be generated by the - /// compute node operating system, such as when a process is forcibly + /// Compute Node operating system, such as when a process is forcibly /// terminated. /// [JsonProperty(PropertyName = "exitCode")] public int? ExitCode { get; set; } /// - /// Gets or sets information about the container under which the task + /// Gets or sets information about the container under which the Task /// is executing. /// /// - /// This property is set only if the task runs in a container context. + /// This property is set only if the Task runs in a container context. /// [JsonProperty(PropertyName = "containerInfo")] public TaskContainerExecutionInformation ContainerInfo { get; set; } /// - /// Gets or sets information describing the task failure, if any. + /// Gets or sets information describing the Task failure, if any. /// /// - /// This property is set only if the task is in the completed state and + /// This property is set only if the Task is in the completed state and /// encountered a failure. /// [JsonProperty(PropertyName = "failureInfo")] public TaskFailureInformation FailureInfo { get; set; } /// - /// Gets or sets the number of times the task has been retried by the + /// Gets or sets the number of times the Task has been retried by the /// Batch service. Task application failures (non-zero exit code) are - /// retried, pre-processing errors (the task could not be run) and file + /// retried, pre-processing errors (the Task could not be run) and file /// upload errors are not retried. The Batch service will retry the - /// task up to the limit specified by the constraints. + /// Task up to the limit specified by the constraints. /// /// /// Task application failures (non-zero exit code) are retried, - /// pre-processing errors (the task could not be run) and file upload - /// errors are not retried. The Batch service will retry the task up to + /// pre-processing errors (the Task could not be run) and file upload + /// errors are not retried. The Batch service will retry the Task up to /// the limit specified by the constraints. /// [JsonProperty(PropertyName = "retryCount")] @@ -178,13 +178,13 @@ public JobPreparationTaskExecutionInformation() /// /// Gets or sets the most recent time at which a retry of the Job - /// Preparation task started running. + /// Preparation Task started running. /// /// - /// This property is set only if the task was retried (i.e. retryCount + /// This property is set only if the Task was retried (i.e. retryCount /// is nonzero). If present, this is typically the same as startTime, - /// but may be different if the task has been restarted for reasons - /// other than retry; for example, if the compute node was rebooted + /// but may be different if the Task has been restarted for reasons + /// other than retry; for example, if the Compute Node was rebooted /// during a retry, then the startTime is updated but the lastRetryTime /// is not. /// @@ -192,7 +192,7 @@ public JobPreparationTaskExecutionInformation() public System.DateTime? LastRetryTime { get; set; } /// - /// Gets or sets the result of the task execution. + /// Gets or sets the result of the Task execution. /// /// /// If the value is 'failed', then the details of the failure can be diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPreparationTaskState.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPreparationTaskState.cs index 36411697d574..d80b3d884294 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPreparationTaskState.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobPreparationTaskState.cs @@ -22,14 +22,14 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum JobPreparationTaskState { /// - /// The task is currently running (including retrying). + /// The Task is currently running (including retrying). /// [EnumMember(Value = "running")] Running, /// - /// The task has exited with exit code 0, or the task has exhausted its - /// retry limit, or the Batch service was unable to start the task due - /// to task preparation errors (such as resource file download + /// The Task has exited with exit code 0, or the Task has exhausted its + /// retry limit, or the Batch service was unable to start the Task due + /// to Task preparation errors (such as resource file download /// failures). /// [EnumMember(Value = "completed")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobReleaseTask.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobReleaseTask.cs index 13b39868c362..9357de3538e1 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobReleaseTask.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobReleaseTask.cs @@ -16,27 +16,27 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// A Job Release task to run on job completion on any compute node where - /// the job has run. + /// A Job Release Task to run on Job completion on any Compute Node where + /// the Job has run. /// /// - /// The Job Release task runs when the job ends, because of one of the + /// The Job Release Task runs when the Job ends, because of one of the /// following: The user calls the Terminate Job API, or the Delete Job API - /// while the job is still active, the job's maximum wall clock time - /// constraint is reached, and the job is still active, or the job's Job - /// Manager task completed, and the job is configured to terminate when the - /// Job Manager completes. The Job Release task runs on each compute node - /// where tasks of the job have run and the Job Preparation task ran and - /// completed. If you reimage a compute node after it has run the Job - /// Preparation task, and the job ends without any further tasks of the job - /// running on that compute node (and hence the Job Preparation task does - /// not re-run), then the Job Release task does not run on that node. If a - /// compute node reboots while the Job Release task is still running, the - /// Job Release task runs again when the compute node starts up. The job is - /// not marked as complete until all Job Release tasks have completed. The - /// Job Release task runs in the background. It does not occupy a - /// scheduling slot; that is, it does not count towards the maxTasksPerNode - /// limit specified on the pool. + /// while the Job is still active, the Job's maximum wall clock time + /// constraint is reached, and the Job is still active, or the Job's Job + /// Manager Task completed, and the Job is configured to terminate when the + /// Job Manager completes. The Job Release Task runs on each Node where + /// Tasks of the Job have run and the Job Preparation Task ran and + /// completed. If you reimage a Node after it has run the Job Preparation + /// Task, and the Job ends without any further Tasks of the Job running on + /// that Node (and hence the Job Preparation Task does not re-run), then + /// the Job Release Task does not run on that Compute Node. If a Node + /// reboots while the Job Release Task is still running, the Job Release + /// Task runs again when the Compute Node starts up. The Job is not marked + /// as complete until all Job Release Tasks have completed. The Job Release + /// Task runs in the background. It does not occupy a scheduling slot; that + /// is, it does not count towards the maxTasksPerNode limit specified on + /// the Pool. /// public partial class JobReleaseTask { @@ -52,13 +52,13 @@ public JobReleaseTask() /// Initializes a new instance of the JobReleaseTask class. /// /// The command line of the Job Release - /// task. + /// Task. /// A string that uniquely identifies the Job Release - /// task within the job. + /// Task within the Job. /// The settings for the container - /// under which the Job Release task runs. + /// under which the Job Release Task runs. /// A list of files that the Batch service - /// will download to the compute node before running the command line. + /// will download to the Compute Node before running the command line. /// There is a maximum size for the list of resource files. When the /// max size is exceeded, the request will fail and the response error /// code will be RequestEntityTooLarge. If this occurs, the collection @@ -66,21 +66,21 @@ public JobReleaseTask() /// using .zip files, Application Packages, or Docker /// Containers. /// A list of environment variable - /// settings for the Job Release task. + /// settings for the Job Release Task. /// The maximum elapsed time that the - /// Job Release task may run on a given compute node, measured from the - /// time the task starts. If the task does not complete within the time + /// Job Release Task may run on a given Compute Node, measured from the + /// time the Task starts. If the Task does not complete within the time /// limit, the Batch service terminates it. The default value is 15 /// minutes. You may not specify a timeout longer than 15 minutes. If /// you do, the Batch service rejects it with an error; if you are /// calling the REST API directly, the HTTP status code is 400 (Bad /// Request). - /// The minimum time to retain the task - /// directory for the Job Release task on the compute node. After this - /// time, the Batch service may delete the task directory and all its + /// The minimum time to retain the Task + /// directory for the Job Release Task on the Compute Node. After this + /// time, the Batch service may delete the Task directory and all its /// contents. /// The user identity under which the Job - /// Release task runs. + /// Release Task runs. public JobReleaseTask(string commandLine, string id = default(string), TaskContainerSettings containerSettings = default(TaskContainerSettings), IList resourceFiles = default(IList), IList environmentSettings = default(IList), System.TimeSpan? maxWallClockTime = default(System.TimeSpan?), System.TimeSpan? retentionTime = default(System.TimeSpan?), UserIdentity userIdentity = default(UserIdentity)) { Id = id; @@ -100,16 +100,16 @@ public JobReleaseTask() partial void CustomInit(); /// - /// Gets or sets a string that uniquely identifies the Job Release task - /// within the job. + /// Gets or sets a string that uniquely identifies the Job Release Task + /// within the Job. /// /// /// The ID can contain any combination of alphanumeric characters /// including hyphens and underscores and cannot contain more than 64 /// characters. If you do not specify this property, the Batch service - /// assigns a default value of 'jobrelease'. No other task in the job - /// can have the same ID as the Job Release task. If you try to submit - /// a task with the same id, the Batch service rejects the request with + /// assigns a default value of 'jobrelease'. No other Task in the Job + /// can have the same ID as the Job Release Task. If you try to submit + /// a Task with the same id, the Batch service rejects the request with /// error code TaskIdSameAsJobReleaseTask; if you are calling the REST /// API directly, the HTTP status code is 409 (Conflict). /// @@ -117,7 +117,7 @@ public JobReleaseTask() public string Id { get; set; } /// - /// Gets or sets the command line of the Job Release task. + /// Gets or sets the command line of the Job Release Task. /// /// /// The command line does not run under a shell, and therefore cannot @@ -126,7 +126,7 @@ public JobReleaseTask() /// 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 + /// (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). /// @@ -135,13 +135,13 @@ public JobReleaseTask() /// /// Gets or sets the settings for the container under which the Job - /// Release task runs. + /// Release Task runs. /// /// /// 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 + /// 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. Files produced in the container outside /// of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, /// meaning that Batch file APIs will not be able to access those @@ -152,7 +152,7 @@ public JobReleaseTask() /// /// Gets or sets a list of files that the Batch service will download - /// to the compute node before running the command line. There is a + /// to the Compute Node before running the command line. There is a /// maximum size for the list of resource files. When the max size is /// exceeded, the request will fail and the response error code will be /// RequestEntityTooLarge. If this occurs, the collection of @@ -160,7 +160,7 @@ public JobReleaseTask() /// .zip files, Application Packages, or Docker Containers. /// /// - /// Files listed under this element are located in the task's working + /// Files listed under this element are located in the Task's working /// directory. /// [JsonProperty(PropertyName = "resourceFiles")] @@ -168,15 +168,15 @@ public JobReleaseTask() /// /// Gets or sets a list of environment variable settings for the Job - /// Release task. + /// Release Task. /// [JsonProperty(PropertyName = "environmentSettings")] public IList EnvironmentSettings { get; set; } /// - /// Gets or sets the maximum elapsed time that the Job Release task may - /// run on a given compute node, measured from the time the task - /// starts. If the task does not complete within the time limit, the + /// Gets or sets the maximum elapsed time that the Job Release Task may + /// run on a given Compute Node, measured from the time the Task + /// starts. If the Task does not complete within the time limit, the /// Batch service terminates it. The default value is 15 minutes. You /// may not specify a timeout longer than 15 minutes. If you do, the /// Batch service rejects it with an error; if you are calling the REST @@ -186,24 +186,24 @@ public JobReleaseTask() public System.TimeSpan? MaxWallClockTime { get; set; } /// - /// Gets or sets the minimum time to retain the task directory for the - /// Job Release task on the compute node. After this time, the Batch - /// service may delete the task directory and all its contents. + /// Gets or sets the minimum time to retain the Task directory for the + /// Job Release Task on the Compute Node. After this time, the Batch + /// service may delete the Task directory and all its contents. /// /// - /// The default is 7 days, i.e. the task directory will be retained for - /// 7 days unless the compute node is removed or the job is deleted. + /// The default is 7 days, i.e. the Task directory will be retained for + /// 7 days unless the Compute Node is removed or the Job is deleted. /// [JsonProperty(PropertyName = "retentionTime")] public System.TimeSpan? RetentionTime { get; set; } /// - /// Gets or sets the user identity under which the Job Release task + /// Gets or sets the user identity under which the Job Release Task /// runs. /// /// - /// If omitted, the task runs as a non-administrative user unique to - /// the task. + /// If omitted, the Task runs as a non-administrative user unique to + /// the Task. /// [JsonProperty(PropertyName = "userIdentity")] public UserIdentity UserIdentity { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobReleaseTaskExecutionInformation.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobReleaseTaskExecutionInformation.cs index 99b3e2372338..6182890b1ee0 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobReleaseTaskExecutionInformation.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobReleaseTaskExecutionInformation.cs @@ -14,8 +14,8 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Contains information about the execution of a Job Release task on a - /// compute node. + /// Contains information about the execution of a Job Release Task on a + /// Compute Node. /// public partial class JobReleaseTaskExecutionInformation { @@ -32,24 +32,24 @@ public JobReleaseTaskExecutionInformation() /// Initializes a new instance of the /// JobReleaseTaskExecutionInformation class. /// - /// The time at which the task started + /// The time at which the Task started /// running. - /// The current state of the Job Release task on - /// the compute node. - /// The time at which the Job Release task + /// The current state of the Job Release Task on + /// the Compute Node. + /// The time at which the Job Release Task /// completed. /// The root directory of the Job - /// Release task on the compute node. You can use this path to retrieve - /// files created by the task, such as log files. + /// Release Task on the Compute Node. You can use this path to retrieve + /// files created by the Task, such as log files. /// The URL to the root directory of - /// the Job Release task on the compute node. + /// the Job Release Task on the Compute Node. /// The exit code of the program specified on - /// the task command line. + /// the Task command line. /// Information about the container under - /// which the task is executing. - /// Information describing the task failure, + /// which the Task is executing. + /// Information describing the Task failure, /// if any. - /// The result of the task execution. + /// The result of the Task execution. public JobReleaseTaskExecutionInformation(System.DateTime startTime, JobReleaseTaskState state, System.DateTime? endTime = default(System.DateTime?), string taskRootDirectory = default(string), string taskRootDirectoryUrl = default(string), int? exitCode = default(int?), TaskContainerExecutionInformation containerInfo = default(TaskContainerExecutionInformation), TaskFailureInformation failureInfo = default(TaskFailureInformation), TaskExecutionResult? result = default(TaskExecutionResult?)) { StartTime = startTime; @@ -70,27 +70,27 @@ public JobReleaseTaskExecutionInformation() partial void CustomInit(); /// - /// Gets or sets the time at which the task started running. + /// Gets or sets the time at which the Task started running. /// /// - /// If the task has been restarted or retried, this is the most recent - /// time at which the task started running. + /// If the Task has been restarted or retried, this is the most recent + /// time at which the Task started running. /// [JsonProperty(PropertyName = "startTime")] public System.DateTime StartTime { get; set; } /// - /// Gets or sets the time at which the Job Release task completed. + /// Gets or sets the time at which the Job Release Task completed. /// /// - /// This property is set only if the task is in the Completed state. + /// This property is set only if the Task is in the Completed state. /// [JsonProperty(PropertyName = "endTime")] public System.DateTime? EndTime { get; set; } /// - /// Gets or sets the current state of the Job Release task on the - /// compute node. + /// Gets or sets the current state of the Job Release Task on the + /// Compute Node. /// /// /// Possible values include: 'running', 'completed' @@ -99,59 +99,59 @@ public JobReleaseTaskExecutionInformation() public JobReleaseTaskState State { get; set; } /// - /// Gets or sets the root directory of the Job Release task on the - /// compute node. You can use this path to retrieve files created by - /// the task, such as log files. + /// Gets or sets the root directory of the Job Release Task on the + /// Compute Node. You can use this path to retrieve files created by + /// the Task, such as log files. /// [JsonProperty(PropertyName = "taskRootDirectory")] public string TaskRootDirectory { get; set; } /// - /// Gets or sets the URL to the root directory of the Job Release task - /// on the compute node. + /// Gets or sets the URL to the root directory of the Job Release Task + /// on the Compute Node. /// [JsonProperty(PropertyName = "taskRootDirectoryUrl")] public string TaskRootDirectoryUrl { get; set; } /// - /// Gets or sets the exit code of the program specified on the task + /// Gets or sets the exit code of the program specified on the Task /// command line. /// /// - /// This parameter is returned only if the task is in the completed + /// This parameter is returned only if the Task is in the completed /// state. The exit code for a process reflects the specific convention /// implemented by the application developer for that process. If you /// use the exit code value to make decisions in your code, be sure /// that you know the exit code convention used by the application /// process. Note that the exit code may also be generated by the - /// compute node operating system, such as when a process is forcibly + /// Compute Node operating system, such as when a process is forcibly /// terminated. /// [JsonProperty(PropertyName = "exitCode")] public int? ExitCode { get; set; } /// - /// Gets or sets information about the container under which the task + /// Gets or sets information about the container under which the Task /// is executing. /// /// - /// This property is set only if the task runs in a container context. + /// This property is set only if the Task runs in a container context. /// [JsonProperty(PropertyName = "containerInfo")] public TaskContainerExecutionInformation ContainerInfo { get; set; } /// - /// Gets or sets information describing the task failure, if any. + /// Gets or sets information describing the Task failure, if any. /// /// - /// This property is set only if the task is in the completed state and + /// This property is set only if the Task is in the completed state and /// encountered a failure. /// [JsonProperty(PropertyName = "failureInfo")] public TaskFailureInformation FailureInfo { get; set; } /// - /// Gets or sets the result of the task execution. + /// Gets or sets the result of the Task execution. /// /// /// If the value is 'failed', then the details of the failure can be diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobReleaseTaskState.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobReleaseTaskState.cs index c7466e921311..cfa1defed14d 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobReleaseTaskState.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobReleaseTaskState.cs @@ -22,14 +22,14 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum JobReleaseTaskState { /// - /// The task is currently running (including retrying). + /// The Task is currently running (including retrying). /// [EnumMember(Value = "running")] Running, /// - /// The task has exited with exit code 0, or the task has exhausted its - /// retry limit, or the Batch service was unable to start the task due - /// to task preparation errors (such as resource file download + /// The Task has exited with exit code 0, or the Task has exhausted its + /// retry limit, or the Batch service was unable to start the Task due + /// to Task preparation errors (such as resource file download /// failures). /// [EnumMember(Value = "completed")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleAddHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleAddHeaders.cs index 524ea99958dc..7798439c420a 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleAddHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleAddHeaders.cs @@ -39,8 +39,8 @@ public JobScheduleAddHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public JobScheduleAddHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleAddParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleAddParameter.cs index 966fdc886fcb..7c2dfbd17b71 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleAddParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleAddParameter.cs @@ -16,8 +16,8 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// A job schedule that allows recurring jobs by specifying when to run - /// jobs and a specification used to create each job. + /// A Job Schedule that allows recurring Jobs by specifying when to run + /// Jobs and a specification used to create each Job. /// public partial class JobScheduleAddParameter { @@ -34,10 +34,10 @@ public JobScheduleAddParameter() /// Initializes a new instance of the JobScheduleAddParameter class. /// /// A string that uniquely identifies the schedule - /// within the account. - /// The schedule according to which jobs will be + /// within the Account. + /// The schedule according to which Jobs will be /// created. - /// The details of the jobs to be + /// The details of the Jobs to be /// created on this schedule. /// The display name for the /// schedule. @@ -60,13 +60,13 @@ public JobScheduleAddParameter() /// /// Gets or sets a string that uniquely identifies the schedule within - /// the account. + /// the Account. /// /// /// The ID can contain any combination of alphanumeric characters /// including hyphens and underscores, and cannot contain more than 64 /// characters. The ID is case-preserving and case-insensitive (that - /// is, you may not have two IDs within an account that differ only by + /// is, you may not have two IDs within an Account that differ only by /// case). /// [JsonProperty(PropertyName = "id")] @@ -83,13 +83,13 @@ public JobScheduleAddParameter() public string DisplayName { get; set; } /// - /// Gets or sets the schedule according to which jobs will be created. + /// Gets or sets the schedule according to which Jobs will be created. /// [JsonProperty(PropertyName = "schedule")] public Schedule Schedule { get; set; } /// - /// Gets or sets the details of the jobs to be created on this + /// Gets or sets the details of the Jobs to be created on this /// schedule. /// [JsonProperty(PropertyName = "jobSpecification")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleDeleteHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleDeleteHeaders.cs index b8d5f36bc6de..7b26a7f6407b 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleDeleteHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleDeleteHeaders.cs @@ -37,8 +37,8 @@ public JobScheduleDeleteHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. public JobScheduleDeleteHeaders(string clientRequestId = default(string), string requestId = default(string)) { ClientRequestId = clientRequestId; @@ -65,8 +65,8 @@ public JobScheduleDeleteHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public string RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleDisableHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleDisableHeaders.cs index bcbde406acf1..5fe33b0ce293 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleDisableHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleDisableHeaders.cs @@ -39,8 +39,8 @@ public JobScheduleDisableHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public JobScheduleDisableHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleEnableHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleEnableHeaders.cs index 61b5f3895598..d089d09af910 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleEnableHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleEnableHeaders.cs @@ -39,8 +39,8 @@ public JobScheduleEnableHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public JobScheduleEnableHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleExecutionInformation.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleExecutionInformation.cs index 3138c466e737..abdb4bd09d99 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleExecutionInformation.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleExecutionInformation.cs @@ -14,8 +14,8 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Contains information about jobs that have been and will be run under a - /// job schedule. + /// Contains information about Jobs that have been and will be run under a + /// Job Schedule. /// public partial class JobScheduleExecutionInformation { @@ -32,10 +32,10 @@ public JobScheduleExecutionInformation() /// Initializes a new instance of the JobScheduleExecutionInformation /// class. /// - /// The next time at which a job will be + /// The next time at which a Job will be /// created under this schedule. - /// Information about the most recent job under - /// the job schedule. + /// Information about the most recent Job under + /// the Job Schedule. /// The time at which the schedule ended. public JobScheduleExecutionInformation(System.DateTime? nextRunTime = default(System.DateTime?), RecentJob recentJob = default(RecentJob), System.DateTime? endTime = default(System.DateTime?)) { @@ -51,24 +51,24 @@ public JobScheduleExecutionInformation() partial void CustomInit(); /// - /// Gets or sets the next time at which a job will be created under + /// Gets or sets the next time at which a Job will be created under /// this schedule. /// /// /// This property is meaningful only if the schedule is in the active /// state when the time comes around. For example, if the schedule is - /// disabled, no job will be created at nextRunTime unless the job is + /// disabled, no Job will be created at nextRunTime unless the Job is /// enabled before then. /// [JsonProperty(PropertyName = "nextRunTime")] public System.DateTime? NextRunTime { get; set; } /// - /// Gets or sets information about the most recent job under the job - /// schedule. + /// Gets or sets information about the most recent Job under the Job + /// Schedule. /// /// - /// This property is present only if the at least one job has run under + /// This property is present only if the at least one Job has run under /// the schedule. /// [JsonProperty(PropertyName = "recentJob")] @@ -78,7 +78,7 @@ public JobScheduleExecutionInformation() /// Gets or sets the time at which the schedule ended. /// /// - /// This property is set only if the job schedule is in the completed + /// This property is set only if the Job Schedule is in the completed /// state. /// [JsonProperty(PropertyName = "endTime")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleExistsHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleExistsHeaders.cs index 228ad72cb865..1b59c9ea8652 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleExistsHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleExistsHeaders.cs @@ -39,8 +39,8 @@ public JobScheduleExistsHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -76,8 +76,8 @@ public JobScheduleExistsHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleGetHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleGetHeaders.cs index 00d72a575280..3cae886f1b22 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleGetHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleGetHeaders.cs @@ -39,8 +39,8 @@ public JobScheduleGetHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -76,8 +76,8 @@ public JobScheduleGetHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleListHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleListHeaders.cs index 585fef752384..75ef87f79828 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleListHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleListHeaders.cs @@ -39,8 +39,8 @@ public JobScheduleListHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -76,8 +76,8 @@ public JobScheduleListHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleListOptions.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleListOptions.cs index fb4b7f084dfc..18da42ee9dfa 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleListOptions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleListOptions.cs @@ -37,7 +37,7 @@ public JobScheduleListOptions() /// An OData $select clause. /// An OData $expand clause. /// The maximum number of items to return in - /// the response. A maximum of 1000 job schedules can be + /// the response. A maximum of 1000 Job Schedules can be /// returned. /// The maximum time that the server can spend /// processing the request, in seconds. The default is 30 @@ -90,7 +90,7 @@ public JobScheduleListOptions() /// /// Gets or sets the maximum number of items to return in the response. - /// A maximum of 1000 job schedules can be returned. + /// A maximum of 1000 Job Schedules can be returned. /// [Newtonsoft.Json.JsonIgnore] public int? MaxResults { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobSchedulePatchHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobSchedulePatchHeaders.cs index 49f2fbb1dab5..b611889cf4a1 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobSchedulePatchHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobSchedulePatchHeaders.cs @@ -39,8 +39,8 @@ public JobSchedulePatchHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public JobSchedulePatchHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobSchedulePatchParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobSchedulePatchParameter.cs index 2cfd8d1892ea..93b76824dbb4 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobSchedulePatchParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobSchedulePatchParameter.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The set of changes to be made to a job schedule. + /// The set of changes to be made to a Job Schedule. /// public partial class JobSchedulePatchParameter { @@ -31,12 +31,12 @@ public JobSchedulePatchParameter() /// /// Initializes a new instance of the JobSchedulePatchParameter class. /// - /// The schedule according to which jobs will be + /// The schedule according to which Jobs will be /// created. - /// The details of the jobs to be + /// The details of the Jobs to be /// created on this schedule. /// A list of name-value pairs associated with - /// the job schedule as metadata. + /// the Job Schedule as metadata. public JobSchedulePatchParameter(Schedule schedule = default(Schedule), JobSpecification jobSpecification = default(JobSpecification), IList metadata = default(IList)) { Schedule = schedule; @@ -51,7 +51,7 @@ public JobSchedulePatchParameter() partial void CustomInit(); /// - /// Gets or sets the schedule according to which jobs will be created. + /// Gets or sets the schedule according to which Jobs will be created. /// /// /// If you do not specify this element, the existing schedule is left @@ -61,20 +61,20 @@ public JobSchedulePatchParameter() public Schedule Schedule { get; set; } /// - /// Gets or sets the details of the jobs to be created on this + /// Gets or sets the details of the Jobs to be created on this /// schedule. /// /// - /// Updates affect only jobs that are started after the update has - /// taken place. Any currently active job continues with the older + /// Updates affect only Jobs that are started after the update has + /// taken place. Any currently active Job continues with the older /// specification. /// [JsonProperty(PropertyName = "jobSpecification")] public JobSpecification JobSpecification { get; set; } /// - /// Gets or sets a list of name-value pairs associated with the job - /// schedule as metadata. + /// Gets or sets a list of name-value pairs associated with the Job + /// Schedule as metadata. /// /// /// If you do not specify this element, existing metadata is left diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleState.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleState.cs index 99abcdc35125..d58e21d30b09 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleState.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleState.cs @@ -22,39 +22,39 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum JobScheduleState { /// - /// The job schedule is active and will create jobs as per its + /// The Job Schedule is active and will create Jobs as per its /// schedule. /// [EnumMember(Value = "active")] Active, /// - /// The schedule has terminated, either by reaching its end time or by - /// the user terminating it explicitly. + /// The Job Schedule has terminated, either by reaching its end time or + /// by the user terminating it explicitly. /// [EnumMember(Value = "completed")] Completed, /// - /// The user has disabled the schedule. The scheduler will not initiate - /// any new jobs will on this schedule, but any existing active job - /// will continue to run. + /// The user has disabled the Job Schedule. The scheduler will not + /// initiate any new Jobs will on this schedule, but any existing + /// active Job will continue to run. /// [EnumMember(Value = "disabled")] Disabled, /// - /// The schedule has no more work to do, or has been explicitly + /// The Job Schedule has no more work to do, or has been explicitly /// terminated by the user, but the termination operation is still in - /// progress. The scheduler will not initiate any new jobs for this - /// schedule, nor is any existing job active. + /// progress. The scheduler will not initiate any new Jobs for this Job + /// Schedule, nor is any existing Job active. /// [EnumMember(Value = "terminating")] Terminating, /// - /// The user has requested that the schedule be deleted, but the delete - /// operation is still in progress. The scheduler will not initiate any - /// new jobs for this schedule, and will delete any existing jobs and - /// tasks under the schedule, including any active job. The schedule - /// will be deleted when all jobs and tasks under the schedule have - /// been deleted. + /// The user has requested that the Job Schedule be deleted, but the + /// delete operation is still in progress. The scheduler will not + /// initiate any new Jobs for this Job Schedule, and will delete any + /// existing Jobs and Tasks under the Job Schedule, including any + /// active Job. The Job Schedule will be deleted when all Jobs and + /// Tasks under the Job Schedule have been deleted. /// [EnumMember(Value = "deleting")] Deleting diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleStatistics.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleStatistics.cs index f11ab592d425..ca5fce433acc 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleStatistics.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleStatistics.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Resource usage statistics for a job schedule. + /// Resource usage statistics for a Job Schedule. /// public partial class JobScheduleStatistics { @@ -36,37 +36,37 @@ public JobScheduleStatistics() /// last updated. All statistics are limited to the range between /// startTime and lastUpdateTime. /// The total user mode CPU time (summed - /// across all cores and all compute nodes) consumed by all tasks in - /// all jobs created under the schedule. + /// across all cores and all Compute Nodes) consumed by all Tasks in + /// all Jobs created under the schedule. /// The total kernel mode CPU time (summed - /// across all cores and all compute nodes) consumed by all tasks in - /// all jobs created under the schedule. + /// across all cores and all Compute Nodes) consumed by all Tasks in + /// all Jobs created under the schedule. /// The total wall clock time of all the - /// tasks in all the jobs created under the schedule. + /// Tasks in all the Jobs created under the schedule. /// The total number of disk read operations - /// made by all tasks in all jobs created under the schedule. + /// made by all Tasks in all Jobs created under the schedule. /// The total number of disk write operations - /// made by all tasks in all jobs created under the schedule. + /// made by all Tasks in all Jobs created under the schedule. /// The total gibibytes read from disk by all - /// tasks in all jobs created under the schedule. + /// Tasks in all Jobs created under the schedule. /// The total gibibytes written to disk by all - /// tasks in all jobs created under the schedule. - /// The total number of tasks - /// successfully completed during the given time range in jobs created - /// under the schedule. A task completes successfully if it returns + /// Tasks in all Jobs created under the schedule. + /// The total number of Tasks + /// successfully completed during the given time range in Jobs created + /// under the schedule. A Task completes successfully if it returns /// exit code 0. - /// The total number of tasks that failed - /// during the given time range in jobs created under the schedule. A - /// task fails if it exhausts its maximum retry count without returning + /// The total number of Tasks that failed + /// during the given time range in Jobs created under the schedule. A + /// Task fails if it exhausts its maximum retry count without returning /// exit code 0. /// The total number of retries during the - /// given time range on all tasks in all jobs created under the + /// given time range on all Tasks in all Jobs created under the /// schedule. - /// The total wait time of all tasks in all jobs - /// created under the schedule. The wait time for a task is defined as - /// the elapsed time between the creation of the task and the start of - /// task execution. (If the task is retried due to failures, the wait - /// time is the time to the most recent task execution.) + /// The total wait time of all Tasks in all Jobs + /// created under the schedule. The wait time for a Task is defined as + /// the elapsed time between the creation of the Task and the start of + /// Task execution. (If the Task is retried due to failures, the wait + /// time is the time to the most recent Task execution.) public JobScheduleStatistics(string url, System.DateTime startTime, System.DateTime lastUpdateTime, System.TimeSpan userCPUTime, System.TimeSpan kernelCPUTime, System.TimeSpan wallClockTime, long readIOps, long writeIOps, double readIOGiB, double writeIOGiB, long numSucceededTasks, long numFailedTasks, long numTaskRetries, System.TimeSpan waitTime) { Url = url; @@ -114,7 +114,7 @@ public JobScheduleStatistics(string url, System.DateTime startTime, System.DateT /// /// Gets or sets the total user mode CPU time (summed across all cores - /// and all compute nodes) consumed by all tasks in all jobs created + /// and all Compute Nodes) consumed by all Tasks in all Jobs created /// under the schedule. /// [JsonProperty(PropertyName = "userCPUTime")] @@ -122,65 +122,65 @@ public JobScheduleStatistics(string url, System.DateTime startTime, System.DateT /// /// Gets or sets the total kernel mode CPU time (summed across all - /// cores and all compute nodes) consumed by all tasks in all jobs + /// cores and all Compute Nodes) consumed by all Tasks in all Jobs /// created under the schedule. /// [JsonProperty(PropertyName = "kernelCPUTime")] public System.TimeSpan KernelCPUTime { get; set; } /// - /// Gets or sets the total wall clock time of all the tasks in all the - /// jobs created under the schedule. + /// Gets or sets the total wall clock time of all the Tasks in all the + /// Jobs created under the schedule. /// /// - /// The wall clock time is the elapsed time from when the task started - /// running on a compute node to when it finished (or to the last time - /// the statistics were updated, if the task had not finished by then). - /// If a task was retried, this includes the wall clock time of all the - /// task retries. + /// The wall clock time is the elapsed time from when the Task started + /// running on a Compute Node to when it finished (or to the last time + /// the statistics were updated, if the Task had not finished by then). + /// If a Task was retried, this includes the wall clock time of all the + /// Task retries. /// [JsonProperty(PropertyName = "wallClockTime")] public System.TimeSpan WallClockTime { get; set; } /// /// Gets or sets the total number of disk read operations made by all - /// tasks in all jobs created under the schedule. + /// Tasks in all Jobs created under the schedule. /// [JsonProperty(PropertyName = "readIOps")] public long ReadIOps { get; set; } /// /// Gets or sets the total number of disk write operations made by all - /// tasks in all jobs created under the schedule. + /// Tasks in all Jobs created under the schedule. /// [JsonProperty(PropertyName = "writeIOps")] public long WriteIOps { get; set; } /// - /// Gets or sets the total gibibytes read from disk by all tasks in all - /// jobs created under the schedule. + /// Gets or sets the total gibibytes read from disk by all Tasks in all + /// Jobs created under the schedule. /// [JsonProperty(PropertyName = "readIOGiB")] public double ReadIOGiB { get; set; } /// - /// Gets or sets the total gibibytes written to disk by all tasks in - /// all jobs created under the schedule. + /// Gets or sets the total gibibytes written to disk by all Tasks in + /// all Jobs created under the schedule. /// [JsonProperty(PropertyName = "writeIOGiB")] public double WriteIOGiB { get; set; } /// - /// Gets or sets the total number of tasks successfully completed - /// during the given time range in jobs created under the schedule. A - /// task completes successfully if it returns exit code 0. + /// Gets or sets the total number of Tasks successfully completed + /// during the given time range in Jobs created under the schedule. A + /// Task completes successfully if it returns exit code 0. /// [JsonProperty(PropertyName = "numSucceededTasks")] public long NumSucceededTasks { get; set; } /// - /// Gets or sets the total number of tasks that failed during the given - /// time range in jobs created under the schedule. A task fails if it + /// Gets or sets the total number of Tasks that failed during the given + /// time range in Jobs created under the schedule. A Task fails if it /// exhausts its maximum retry count without returning exit code 0. /// [JsonProperty(PropertyName = "numFailedTasks")] @@ -188,21 +188,21 @@ public JobScheduleStatistics(string url, System.DateTime startTime, System.DateT /// /// Gets or sets the total number of retries during the given time - /// range on all tasks in all jobs created under the schedule. + /// range on all Tasks in all Jobs created under the schedule. /// [JsonProperty(PropertyName = "numTaskRetries")] public long NumTaskRetries { get; set; } /// - /// Gets or sets the total wait time of all tasks in all jobs created - /// under the schedule. The wait time for a task is defined as the - /// elapsed time between the creation of the task and the start of task - /// execution. (If the task is retried due to failures, the wait time - /// is the time to the most recent task execution.) + /// Gets or sets the total wait time of all Tasks in all Jobs created + /// under the schedule. The wait time for a Task is defined as the + /// elapsed time between the creation of the Task and the start of Task + /// execution. (If the Task is retried due to failures, the wait time + /// is the time to the most recent Task execution.) /// /// - /// This value is only reported in the account lifetime statistics; it - /// is not included in the job statistics. + /// This value is only reported in the Account lifetime statistics; it + /// is not included in the Job statistics. /// [JsonProperty(PropertyName = "waitTime")] public System.TimeSpan WaitTime { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleTerminateHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleTerminateHeaders.cs index 347d9af55be9..be077949558d 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleTerminateHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleTerminateHeaders.cs @@ -41,8 +41,8 @@ public JobScheduleTerminateHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -81,8 +81,8 @@ public JobScheduleTerminateHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleUpdateHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleUpdateHeaders.cs index e3e1b777718e..f1639520b9fd 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleUpdateHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleUpdateHeaders.cs @@ -39,8 +39,8 @@ public JobScheduleUpdateHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public JobScheduleUpdateHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleUpdateParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleUpdateParameter.cs index 4541c8b39ad3..1a15341cefd7 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleUpdateParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobScheduleUpdateParameter.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The set of changes to be made to a job schedule. + /// The set of changes to be made to a Job Schedule. /// public partial class JobScheduleUpdateParameter { @@ -32,12 +32,12 @@ public JobScheduleUpdateParameter() /// /// Initializes a new instance of the JobScheduleUpdateParameter class. /// - /// The schedule according to which jobs will be + /// The schedule according to which Jobs will be /// created. - /// Details of the jobs to be created on + /// Details of the Jobs to be created on /// this schedule. /// A list of name-value pairs associated with - /// the job schedule as metadata. + /// the Job Schedule as metadata. public JobScheduleUpdateParameter(Schedule schedule, JobSpecification jobSpecification, IList metadata = default(IList)) { Schedule = schedule; @@ -52,30 +52,30 @@ public JobScheduleUpdateParameter() partial void CustomInit(); /// - /// Gets or sets the schedule according to which jobs will be created. + /// Gets or sets the schedule according to which Jobs will be created. /// /// /// If you do not specify this element, it is equivalent to passing the - /// default schedule: that is, a single job scheduled to run + /// default schedule: that is, a single Job scheduled to run /// immediately. /// [JsonProperty(PropertyName = "schedule")] public Schedule Schedule { get; set; } /// - /// Gets or sets details of the jobs to be created on this schedule. + /// Gets or sets details of the Jobs to be created on this schedule. /// /// - /// Updates affect only jobs that are started after the update has - /// taken place. Any currently active job continues with the older + /// Updates affect only Jobs that are started after the update has + /// taken place. Any currently active Job continues with the older /// specification. /// [JsonProperty(PropertyName = "jobSpecification")] public JobSpecification JobSpecification { get; set; } /// - /// Gets or sets a list of name-value pairs associated with the job - /// schedule as metadata. + /// Gets or sets a list of name-value pairs associated with the Job + /// Schedule as metadata. /// /// /// If you do not specify this element, it takes the default value of diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobSchedulingError.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobSchedulingError.cs index dd63ba57a0ca..4515c0bb40f1 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobSchedulingError.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobSchedulingError.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// An error encountered by the Batch service when scheduling a job. + /// An error encountered by the Batch service when scheduling a Job. /// public partial class JobSchedulingError { @@ -31,12 +31,12 @@ public JobSchedulingError() /// /// Initializes a new instance of the JobSchedulingError class. /// - /// The category of the job scheduling + /// The category of the Job scheduling /// error. - /// An identifier for the job scheduling error. + /// An identifier for the Job scheduling error. /// Codes are invariant and are intended to be consumed /// programmatically. - /// A message describing the job scheduling + /// A message describing the Job scheduling /// error, intended to be suitable for display in a user /// interface. /// A list of additional error details related to @@ -56,7 +56,7 @@ public JobSchedulingError() partial void CustomInit(); /// - /// Gets or sets the category of the job scheduling error. + /// Gets or sets the category of the Job scheduling error. /// /// /// Possible values include: 'userError', 'serverError' @@ -65,14 +65,14 @@ public JobSchedulingError() public ErrorCategory Category { get; set; } /// - /// Gets or sets an identifier for the job scheduling error. Codes are + /// Gets or sets an identifier for the Job scheduling error. Codes are /// invariant and are intended to be consumed programmatically. /// [JsonProperty(PropertyName = "code")] public string Code { get; set; } /// - /// Gets or sets a message describing the job scheduling error, + /// Gets or sets a message describing the Job scheduling error, /// intended to be suitable for display in a user interface. /// [JsonProperty(PropertyName = "message")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobSpecification.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobSpecification.cs index 4c1377dbb59f..95706a307765 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobSpecification.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobSpecification.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Specifies details of the jobs to be created on a schedule. + /// Specifies details of the Jobs to be created on a schedule. /// public partial class JobSpecification { @@ -32,40 +32,40 @@ public JobSpecification() /// /// Initializes a new instance of the JobSpecification class. /// - /// The pool on which the Batch service runs the - /// tasks of jobs created under this schedule. - /// The priority of jobs created under this + /// The Pool on which the Batch service runs the + /// Tasks of Jobs created under this schedule. + /// The priority of Jobs created under this /// schedule. - /// The display name for jobs created under + /// The display name for Jobs created under /// this schedule. - /// Whether tasks in the job can + /// Whether Tasks in the Job can /// define dependencies on each other. The default is false. /// The action the Batch service - /// should take when all tasks in a job created under this schedule are + /// should take when all Tasks in a Job created under this schedule are /// in the completed state. /// The action the Batch service should - /// take when any task fails in a job created under this schedule. A - /// task is considered to have failed if it have failed if has a - /// failureInfo. A failureInfo is set if the task completes with a + /// take when any Task fails in a Job created under this schedule. A + /// Task is considered to have failed if it have failed if has a + /// failureInfo. A failureInfo is set if the Task completes with a /// non-zero exit code after exhausting its retry count, or if there - /// was an error starting the task, for example due to a resource file + /// was an error starting the Task, for example due to a resource file /// download error. /// The network configuration for - /// the job. - /// The execution constraints for jobs + /// the Job. + /// The execution constraints for Jobs /// created under this schedule. - /// The details of a Job Manager task to - /// be launched when a job is started under this schedule. - /// The Job Preparation task for jobs + /// The details of a Job Manager Task to + /// be launched when a Job is started under this schedule. + /// The Job Preparation Task for Jobs /// created under this schedule. - /// The Job Release task for jobs created + /// The Job Release Task for Jobs created /// under this schedule. /// A list of common /// environment variable settings. These environment variables are set - /// for all tasks in jobs created under this schedule (including the - /// Job Manager, Job Preparation and Job Release tasks). + /// for all Tasks in Jobs created under this schedule (including the + /// Job Manager, Job Preparation and Job Release Tasks). /// A list of name-value pairs associated with - /// each job created under this schedule as metadata. + /// each Job created under this schedule as metadata. public JobSpecification(PoolInformation poolInfo, int? priority = default(int?), string displayName = default(string), bool? usesTaskDependencies = default(bool?), OnAllTasksComplete? onAllTasksComplete = default(OnAllTasksComplete?), OnTaskFailure? onTaskFailure = default(OnTaskFailure?), JobNetworkConfiguration networkConfiguration = default(JobNetworkConfiguration), JobConstraints constraints = default(JobConstraints), JobManagerTask jobManagerTask = default(JobManagerTask), JobPreparationTask jobPreparationTask = default(JobPreparationTask), JobReleaseTask jobReleaseTask = default(JobReleaseTask), IList commonEnvironmentSettings = default(IList), IList metadata = default(IList)) { Priority = priority; @@ -90,20 +90,20 @@ public JobSpecification() partial void CustomInit(); /// - /// Gets or sets the priority of jobs created under this schedule. + /// Gets or sets the priority of Jobs created under this schedule. /// /// /// Priority values can range from -1000 to 1000, with -1000 being the /// lowest priority and 1000 being the highest priority. The default - /// value is 0. This priority is used as the default for all jobs under - /// the job schedule. You can update a job's priority after it has been - /// created using by using the update job API. + /// value is 0. This priority is used as the default for all Jobs under + /// the Job Schedule. You can update a Job's priority after it has been + /// created using by using the update Job API. /// [JsonProperty(PropertyName = "priority")] public int? Priority { get; set; } /// - /// Gets or sets the display name for jobs created under this schedule. + /// Gets or sets the display name for Jobs created under this schedule. /// /// /// The name need not be unique and can contain any Unicode characters @@ -113,7 +113,7 @@ public JobSpecification() public string DisplayName { get; set; } /// - /// Gets or sets whether tasks in the job can define dependencies on + /// Gets or sets whether Tasks in the Job can define dependencies on /// each other. The default is false. /// [JsonProperty(PropertyName = "usesTaskDependencies")] @@ -121,28 +121,28 @@ public JobSpecification() /// /// Gets or sets the action the Batch service should take when all - /// tasks in a job created under this schedule are in the completed + /// Tasks in a Job created under this schedule are in the completed /// state. /// /// - /// Note that if a job contains no tasks, then all tasks are considered + /// Note that if a Job contains no Tasks, then all Tasks are considered /// complete. This option is therefore most commonly used with a Job - /// Manager task; if you want to use automatic job termination without + /// Manager task; if you want to use automatic Job termination without /// a Job Manager, you should initially set onAllTasksComplete to - /// noaction and update the job properties to set onAllTasksComplete to - /// terminatejob once you have finished adding tasks. The default is + /// noaction and update the Job properties to set onAllTasksComplete to + /// terminatejob once you have finished adding Tasks. The default is /// noaction. Possible values include: 'noAction', 'terminateJob' /// [JsonProperty(PropertyName = "onAllTasksComplete")] public OnAllTasksComplete? OnAllTasksComplete { get; set; } /// - /// Gets or sets the action the Batch service should take when any task - /// fails in a job created under this schedule. A task is considered to + /// Gets or sets the action the Batch service should take when any Task + /// fails in a Job created under this schedule. A Task is considered to /// have failed if it have failed if has a failureInfo. A failureInfo - /// is set if the task completes with a non-zero exit code after + /// is set if the Task completes with a non-zero exit code after /// exhausting its retry count, or if there was an error starting the - /// task, for example due to a resource file download error. + /// Task, for example due to a resource file download error. /// /// /// The default is noaction. Possible values include: 'noAction', @@ -152,82 +152,82 @@ public JobSpecification() public OnTaskFailure? OnTaskFailure { get; set; } /// - /// Gets or sets the network configuration for the job. + /// Gets or sets the network configuration for the Job. /// [JsonProperty(PropertyName = "networkConfiguration")] public JobNetworkConfiguration NetworkConfiguration { get; set; } /// - /// Gets or sets the execution constraints for jobs created under this + /// Gets or sets the execution constraints for Jobs created under this /// schedule. /// [JsonProperty(PropertyName = "constraints")] public JobConstraints Constraints { get; set; } /// - /// Gets or sets the details of a Job Manager task to be launched when - /// a job is started under this schedule. + /// Gets or sets the details of a Job Manager Task to be launched when + /// a Job is started under this schedule. /// /// - /// If the job does not specify a Job Manager task, the user must - /// explicitly add tasks to the job using the Task API. If the job does - /// specify a Job Manager task, the Batch service creates the Job - /// Manager task when the job is created, and will try to schedule the - /// Job Manager task before scheduling other tasks in the job. + /// If the Job does not specify a Job Manager Task, the user must + /// explicitly add Tasks to the Job using the Task API. If the Job does + /// specify a Job Manager Task, the Batch service creates the Job + /// Manager Task when the Job is created, and will try to schedule the + /// Job Manager Task before scheduling other Tasks in the Job. /// [JsonProperty(PropertyName = "jobManagerTask")] public JobManagerTask JobManagerTask { get; set; } /// - /// Gets or sets the Job Preparation task for jobs created under this + /// Gets or sets the Job Preparation Task for Jobs created under this /// schedule. /// /// - /// If a job has a Job Preparation task, the Batch service will run the - /// Job Preparation task on a compute node before starting any tasks of - /// that job on that compute node. + /// If a Job has a Job Preparation Task, the Batch service will run the + /// Job Preparation Task on a Node before starting any Tasks of that + /// Job on that Compute Node. /// [JsonProperty(PropertyName = "jobPreparationTask")] public JobPreparationTask JobPreparationTask { get; set; } /// - /// Gets or sets the Job Release task for jobs created under this + /// Gets or sets the Job Release Task for Jobs created under this /// schedule. /// /// - /// The primary purpose of the Job Release task is to undo changes to - /// compute nodes made by the Job Preparation task. Example activities - /// include deleting local files, or shutting down services that were - /// started as part of job preparation. A Job Release task cannot be - /// specified without also specifying a Job Preparation task for the - /// job. The Batch service runs the Job Release task on the compute - /// nodes that have run the Job Preparation task. + /// The primary purpose of the Job Release Task is to undo changes to + /// Nodes made by the Job Preparation Task. Example activities include + /// deleting local files, or shutting down services that were started + /// as part of Job preparation. A Job Release Task cannot be specified + /// without also specifying a Job Preparation Task for the Job. The + /// Batch service runs the Job Release Task on the Compute Nodes that + /// have run the Job Preparation Task. /// [JsonProperty(PropertyName = "jobReleaseTask")] public JobReleaseTask JobReleaseTask { get; set; } /// /// Gets or sets a list of common environment variable settings. These - /// environment variables are set for all tasks in jobs created under + /// environment variables are set for all Tasks in Jobs created under /// this schedule (including the Job Manager, Job Preparation and Job - /// Release tasks). + /// Release Tasks). /// /// - /// Individual tasks can override an environment setting specified here + /// Individual Tasks can override an environment setting specified here /// by specifying the same setting name with a different value. /// [JsonProperty(PropertyName = "commonEnvironmentSettings")] public IList CommonEnvironmentSettings { get; set; } /// - /// Gets or sets the pool on which the Batch service runs the tasks of - /// jobs created under this schedule. + /// Gets or sets the Pool on which the Batch service runs the Tasks of + /// Jobs created under this schedule. /// [JsonProperty(PropertyName = "poolInfo")] public PoolInformation PoolInfo { get; set; } /// - /// Gets or sets a list of name-value pairs associated with each job + /// Gets or sets a list of name-value pairs associated with each Job /// created under this schedule as metadata. /// /// diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobState.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobState.cs index 3474b84c24ba..c006a4585065 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobState.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobState.cs @@ -22,47 +22,47 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum JobState { /// - /// The job is available to have tasks scheduled. + /// The Job is available to have Tasks scheduled. /// [EnumMember(Value = "active")] Active, /// - /// A user has requested that the job be disabled, but the disable - /// operation is still in progress (for example, waiting for tasks to + /// A user has requested that the Job be disabled, but the disable + /// operation is still in progress (for example, waiting for Tasks to /// terminate). /// [EnumMember(Value = "disabling")] Disabling, /// - /// A user has disabled the job. No tasks are running, and no new tasks + /// A user has disabled the Job. No Tasks are running, and no new Tasks /// will be scheduled. /// [EnumMember(Value = "disabled")] Disabled, /// - /// A user has requested that the job be enabled, but the enable + /// A user has requested that the Job be enabled, but the enable /// operation is still in progress. /// [EnumMember(Value = "enabling")] Enabling, /// - /// The job is about to complete, either because a Job Manager task has - /// completed or because the user has terminated the job, but the + /// The Job is about to complete, either because a Job Manager Task has + /// completed or because the user has terminated the Job, but the /// terminate operation is still in progress (for example, because Job - /// Release tasks are running). + /// Release Tasks are running). /// [EnumMember(Value = "terminating")] Terminating, /// - /// All tasks have terminated, and the system will not accept any more - /// tasks or any further changes to the job. + /// All Tasks have terminated, and the system will not accept any more + /// Tasks or any further changes to the Job. /// [EnumMember(Value = "completed")] Completed, /// - /// A user has requested that the job be deleted, but the delete + /// A user has requested that the Job be deleted, but the delete /// operation is still in progress (for example, because the system is - /// still terminating running tasks). + /// still terminating running Tasks). /// [EnumMember(Value = "deleting")] Deleting diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobStatistics.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobStatistics.cs index 35b199637087..a1ceacb87cfe 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobStatistics.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobStatistics.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Resource usage statistics for a job. + /// Resource usage statistics for a Job. /// public partial class JobStatistics { @@ -36,30 +36,30 @@ public JobStatistics() /// last updated. All statistics are limited to the range between /// startTime and lastUpdateTime. /// The total user mode CPU time (summed - /// across all cores and all compute nodes) consumed by all tasks in - /// the job. + /// across all cores and all Compute Nodes) consumed by all Tasks in + /// the Job. /// The total kernel mode CPU time (summed - /// across all cores and all compute nodes) consumed by all tasks in - /// the job. - /// The total wall clock time of all tasks - /// in the job. + /// across all cores and all Compute Nodes) consumed by all Tasks in + /// the Job. + /// The total wall clock time of all Tasks + /// in the Job. /// The total number of disk read operations - /// made by all tasks in the job. + /// made by all Tasks in the Job. /// The total number of disk write operations - /// made by all tasks in the job. + /// made by all Tasks in the Job. /// The total amount of data in GiB read from - /// disk by all tasks in the job. + /// disk by all Tasks in the Job. /// The total amount of data in GiB written to - /// disk by all tasks in the job. - /// The total number of tasks - /// successfully completed in the job during the given time + /// disk by all Tasks in the Job. + /// The total number of Tasks + /// successfully completed in the Job during the given time /// range. - /// The total number of tasks in the job + /// The total number of Tasks in the Job /// that failed during the given time range. /// The total number of retries on all the - /// tasks in the job during the given time range. - /// The total wait time of all tasks in the - /// job. + /// Tasks in the Job during the given time range. + /// The total wait time of all Tasks in the + /// Job. public JobStatistics(string url, System.DateTime startTime, System.DateTime lastUpdateTime, System.TimeSpan userCPUTime, System.TimeSpan kernelCPUTime, System.TimeSpan wallClockTime, long readIOps, long writeIOps, double readIOGiB, double writeIOGiB, long numSucceededTasks, long numFailedTasks, long numTaskRetries, System.TimeSpan waitTime) { Url = url; @@ -107,96 +107,96 @@ public JobStatistics(string url, System.DateTime startTime, System.DateTime last /// /// Gets or sets the total user mode CPU time (summed across all cores - /// and all compute nodes) consumed by all tasks in the job. + /// and all Compute Nodes) consumed by all Tasks in the Job. /// [JsonProperty(PropertyName = "userCPUTime")] public System.TimeSpan UserCPUTime { get; set; } /// /// Gets or sets the total kernel mode CPU time (summed across all - /// cores and all compute nodes) consumed by all tasks in the job. + /// cores and all Compute Nodes) consumed by all Tasks in the Job. /// [JsonProperty(PropertyName = "kernelCPUTime")] public System.TimeSpan KernelCPUTime { get; set; } /// - /// Gets or sets the total wall clock time of all tasks in the job. + /// Gets or sets the total wall clock time of all Tasks in the Job. /// /// - /// The wall clock time is the elapsed time from when the task started - /// running on a compute node to when it finished (or to the last time - /// the statistics were updated, if the task had not finished by then). - /// If a task was retried, this includes the wall clock time of all the - /// task retries. + /// The wall clock time is the elapsed time from when the Task started + /// running on a Compute Node to when it finished (or to the last time + /// the statistics were updated, if the Task had not finished by then). + /// If a Task was retried, this includes the wall clock time of all the + /// Task retries. /// [JsonProperty(PropertyName = "wallClockTime")] public System.TimeSpan WallClockTime { get; set; } /// /// Gets or sets the total number of disk read operations made by all - /// tasks in the job. + /// Tasks in the Job. /// [JsonProperty(PropertyName = "readIOps")] public long ReadIOps { get; set; } /// /// Gets or sets the total number of disk write operations made by all - /// tasks in the job. + /// Tasks in the Job. /// [JsonProperty(PropertyName = "writeIOps")] public long WriteIOps { get; set; } /// /// Gets or sets the total amount of data in GiB read from disk by all - /// tasks in the job. + /// Tasks in the Job. /// [JsonProperty(PropertyName = "readIOGiB")] public double ReadIOGiB { get; set; } /// /// Gets or sets the total amount of data in GiB written to disk by all - /// tasks in the job. + /// Tasks in the Job. /// [JsonProperty(PropertyName = "writeIOGiB")] public double WriteIOGiB { get; set; } /// - /// Gets or sets the total number of tasks successfully completed in - /// the job during the given time range. + /// Gets or sets the total number of Tasks successfully completed in + /// the Job during the given time range. /// /// - /// A task completes successfully if it returns exit code 0. + /// A Task completes successfully if it returns exit code 0. /// [JsonProperty(PropertyName = "numSucceededTasks")] public long NumSucceededTasks { get; set; } /// - /// Gets or sets the total number of tasks in the job that failed + /// Gets or sets the total number of Tasks in the Job that failed /// during the given time range. /// /// - /// A task fails if it exhausts its maximum retry count without + /// A Task fails if it exhausts its maximum retry count without /// returning exit code 0. /// [JsonProperty(PropertyName = "numFailedTasks")] public long NumFailedTasks { get; set; } /// - /// Gets or sets the total number of retries on all the tasks in the - /// job during the given time range. + /// Gets or sets the total number of retries on all the Tasks in the + /// Job during the given time range. /// [JsonProperty(PropertyName = "numTaskRetries")] public long NumTaskRetries { get; set; } /// - /// Gets or sets the total wait time of all tasks in the job. + /// Gets or sets the total wait time of all Tasks in the Job. /// /// - /// The wait time for a task is defined as the elapsed time between the - /// creation of the task and the start of task execution. (If the task + /// The wait time for a Task is defined as the elapsed time between the + /// creation of the Task and the start of Task execution. (If the Task /// is retried due to failures, the wait time is the time to the most - /// recent task execution.) This value is only reported in the account - /// lifetime statistics; it is not included in the job statistics. + /// recent Task execution.) This value is only reported in the Account + /// lifetime statistics; it is not included in the Job statistics. /// [JsonProperty(PropertyName = "waitTime")] public System.TimeSpan WaitTime { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobTerminateHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobTerminateHeaders.cs index ee38dd9ca8cb..691325b2b088 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobTerminateHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobTerminateHeaders.cs @@ -39,8 +39,8 @@ public JobTerminateHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public JobTerminateHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobTerminateParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobTerminateParameter.cs index 57fc93c898a1..1973bb601a33 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobTerminateParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobTerminateParameter.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Options when terminating a job. + /// Options when terminating a Job. /// public partial class JobTerminateParameter { @@ -30,7 +30,7 @@ public JobTerminateParameter() /// Initializes a new instance of the JobTerminateParameter class. /// /// The text you want to appear as the - /// job's TerminateReason. The default is 'UserTerminate'. + /// Job's TerminateReason. The default is 'UserTerminate'. public JobTerminateParameter(string terminateReason = default(string)) { TerminateReason = terminateReason; @@ -43,7 +43,7 @@ public JobTerminateParameter() partial void CustomInit(); /// - /// Gets or sets the text you want to appear as the job's + /// Gets or sets the text you want to appear as the Job's /// TerminateReason. The default is 'UserTerminate'. /// [JsonProperty(PropertyName = "terminateReason")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobUpdateHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobUpdateHeaders.cs index f6c060a6b701..1ec43325b975 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobUpdateHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobUpdateHeaders.cs @@ -39,8 +39,8 @@ public JobUpdateHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public JobUpdateHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobUpdateParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobUpdateParameter.cs index 9fb01d8fa52e..6ba1f96c29a6 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobUpdateParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/JobUpdateParameter.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The set of changes to be made to a job. + /// The set of changes to be made to a Job. /// public partial class JobUpdateParameter { @@ -32,15 +32,15 @@ public JobUpdateParameter() /// /// Initializes a new instance of the JobUpdateParameter class. /// - /// The pool on which the Batch service runs the - /// job's tasks. - /// The priority of the job. + /// The Pool on which the Batch service runs the + /// Job's Tasks. + /// The priority of the Job. /// The execution constraints for the - /// job. + /// Job. /// A list of name-value pairs associated with - /// the job as metadata. + /// the Job as metadata. /// The action the Batch service - /// should take when all tasks in the job are in the completed + /// should take when all Tasks in the Job are in the completed /// state. public JobUpdateParameter(PoolInformation poolInfo, int? priority = default(int?), JobConstraints constraints = default(JobConstraints), IList metadata = default(IList), OnAllTasksComplete? onAllTasksComplete = default(OnAllTasksComplete?)) { @@ -58,7 +58,7 @@ public JobUpdateParameter() partial void CustomInit(); /// - /// Gets or sets the priority of the job. + /// Gets or sets the priority of the Job. /// /// /// Priority values can range from -1000 to 1000, with -1000 being the @@ -69,7 +69,7 @@ public JobUpdateParameter() public int? Priority { get; set; } /// - /// Gets or sets the execution constraints for the job. + /// Gets or sets the execution constraints for the Job. /// /// /// If omitted, the constraints are cleared. @@ -78,22 +78,23 @@ public JobUpdateParameter() public JobConstraints Constraints { get; set; } /// - /// Gets or sets the pool on which the Batch service runs the job's - /// tasks. + /// Gets or sets the Pool on which the Batch service runs the Job's + /// Tasks. /// /// - /// You may change the pool for a job only when the job is disabled. + /// You may change the Pool for a Job only when the Job is disabled. /// The Update Job call will fail if you include the poolInfo element - /// and the job is not disabled. If you specify an - /// autoPoolSpecification specification in the poolInfo, only the - /// keepAlive property can be updated, and then only if the auto pool - /// has a poolLifetimeOption of job. + /// and the Job is not disabled. If you specify an + /// autoPoolSpecification in the poolInfo, only the keepAlive property + /// of the autoPoolSpecification can be updated, and then only if the + /// autoPoolSpecification has a poolLifetimeOption of Job (other job + /// properties can be updated as normal). /// [JsonProperty(PropertyName = "poolInfo")] public PoolInformation PoolInfo { get; set; } /// - /// Gets or sets a list of name-value pairs associated with the job as + /// Gets or sets a list of name-value pairs associated with the Job as /// metadata. /// /// @@ -105,14 +106,14 @@ public JobUpdateParameter() /// /// Gets or sets the action the Batch service should take when all - /// tasks in the job are in the completed state. + /// Tasks in the Job are in the completed state. /// /// /// If omitted, the completion behavior is set to noaction. If the - /// current value is terminatejob, this is an error because a job's + /// current value is terminatejob, this is an error because a Job's /// completion behavior may not be changed from terminatejob to /// noaction. You may not change the value from terminatejob to - /// noaction - that is, once you have engaged automatic job + /// noaction - that is, once you have engaged automatic Job /// termination, you cannot turn it off again. If you try to do this, /// the request fails and Batch returns status code 400 (Bad Request) /// and an 'invalid property value' error response. If you do not diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/LinuxUserConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/LinuxUserConfiguration.cs index 52c03564f001..4c244b63a37c 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/LinuxUserConfiguration.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/LinuxUserConfiguration.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Properties used to create a user account on a Linux node. + /// Properties used to create a user Account on a Linux Compute Node. /// public partial class LinuxUserConfiguration { @@ -29,10 +29,10 @@ public LinuxUserConfiguration() /// /// Initializes a new instance of the LinuxUserConfiguration class. /// - /// The user ID of the user account. - /// The group ID for the user account. + /// The user ID of the user Account. + /// The group ID for the user Account. /// The SSH private key for the user - /// account. + /// Account. public LinuxUserConfiguration(int? uid = default(int?), int? gid = default(int?), string sshPrivateKey = default(string)) { Uid = uid; @@ -47,7 +47,7 @@ public LinuxUserConfiguration() partial void CustomInit(); /// - /// Gets or sets the user ID of the user account. + /// Gets or sets the user ID of the user Account. /// /// /// The uid and gid properties must be specified together or not at @@ -58,7 +58,7 @@ public LinuxUserConfiguration() public int? Uid { get; set; } /// - /// Gets or sets the group ID for the user account. + /// Gets or sets the group ID for the user Account. /// /// /// The uid and gid properties must be specified together or not at @@ -69,17 +69,17 @@ public LinuxUserConfiguration() public int? Gid { get; set; } /// - /// Gets or sets the SSH private key for the user account. + /// Gets or sets the SSH private key for the user Account. /// /// /// The private key must not be password protected. The private key is /// used to automatically configure asymmetric-key based authentication - /// for SSH between nodes in a Linux pool when the pool's + /// for SSH between Compute Nodes in a Linux Pool when the Pool's /// enableInterNodeCommunication property is true (it is ignored if /// enableInterNodeCommunication is false). It does this by placing the /// key pair into the user's .ssh directory. If not specified, - /// password-less SSH is not configured between nodes (no modification - /// of the user's .ssh directory is done). + /// password-less SSH is not configured between Compute Nodes (no + /// modification of the user's .ssh directory is done). /// [JsonProperty(PropertyName = "sshPrivateKey")] public string SshPrivateKey { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/LoginMode.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/LoginMode.cs index 9e53c50095f0..e5f6d343df82 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/LoginMode.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/LoginMode.cs @@ -29,10 +29,10 @@ public enum LoginMode Batch, /// /// The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on - /// Windows VirtualMachineConfiguration pools. If this option is used + /// Windows VirtualMachineConfiguration Pools. If this option is used /// with an elevated user identity in a Windows - /// VirtualMachineConfiguration pool, the user session will not be - /// elevated unless the application executed by the task command line + /// VirtualMachineConfiguration Pool, the user session will not be + /// elevated unless the application executed by the Task command line /// is configured to always require administrative privilege or to /// always require maximum privilege. /// diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/MountConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/MountConfiguration.cs new file mode 100644 index 000000000000..1dfa10d34a0a --- /dev/null +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/MountConfiguration.cs @@ -0,0 +1,92 @@ +// +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License.txt in the project root for +// license information. +// +// Code generated by Microsoft (R) AutoRest Code Generator. +// Changes may cause incorrect behavior and will be lost if the code is +// regenerated. +// + +namespace Microsoft.Azure.Batch.Protocol.Models +{ + using Newtonsoft.Json; + using System.Linq; + + /// + /// The file system to mount on each node. + /// + public partial class MountConfiguration + { + /// + /// Initializes a new instance of the MountConfiguration class. + /// + public MountConfiguration() + { + CustomInit(); + } + + /// + /// Initializes a new instance of the MountConfiguration class. + /// + /// The Azure Storage + /// Container to mount using blob FUSE on each node. + /// The NFS file system to mount on + /// each node. + /// The CIFS/SMB file system to + /// mount on each node. + /// The Azure File Share to + /// mount on each node. + public MountConfiguration(AzureBlobFileSystemConfiguration azureBlobFileSystemConfiguration = default(AzureBlobFileSystemConfiguration), NFSMountConfiguration nfsMountConfiguration = default(NFSMountConfiguration), CIFSMountConfiguration cifsMountConfiguration = default(CIFSMountConfiguration), AzureFileShareConfiguration azureFileShareConfiguration = default(AzureFileShareConfiguration)) + { + AzureBlobFileSystemConfiguration = azureBlobFileSystemConfiguration; + NfsMountConfiguration = nfsMountConfiguration; + CifsMountConfiguration = cifsMountConfiguration; + AzureFileShareConfiguration = azureFileShareConfiguration; + CustomInit(); + } + + /// + /// An initialization method that performs custom operations like setting defaults + /// + partial void CustomInit(); + + /// + /// Gets or sets the Azure Storage Container to mount using blob FUSE + /// on each node. + /// + /// + /// This property is mutually exclusive with all other properties. + /// + [JsonProperty(PropertyName = "azureBlobFileSystemConfiguration")] + public AzureBlobFileSystemConfiguration AzureBlobFileSystemConfiguration { get; set; } + + /// + /// Gets or sets the NFS file system to mount on each node. + /// + /// + /// This property is mutually exclusive with all other properties. + /// + [JsonProperty(PropertyName = "nfsMountConfiguration")] + public NFSMountConfiguration NfsMountConfiguration { get; set; } + + /// + /// Gets or sets the CIFS/SMB file system to mount on each node. + /// + /// + /// This property is mutually exclusive with all other properties. + /// + [JsonProperty(PropertyName = "cifsMountConfiguration")] + public CIFSMountConfiguration CifsMountConfiguration { get; set; } + + /// + /// Gets or sets the Azure File Share to mount on each node. + /// + /// + /// This property is mutually exclusive with all other properties. + /// + [JsonProperty(PropertyName = "azureFileShareConfiguration")] + public AzureFileShareConfiguration AzureFileShareConfiguration { get; set; } + + } +} diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/MultiInstanceSettings.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/MultiInstanceSettings.cs index 844f3522572e..060f052127aa 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/MultiInstanceSettings.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/MultiInstanceSettings.cs @@ -16,13 +16,13 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Settings which specify how to run a multi-instance task. + /// Settings which specify how to run a multi-instance Task. /// /// - /// Multi-instance tasks are commonly used to support MPI tasks. In the MPI + /// Multi-instance Tasks are commonly used to support MPI Tasks. In the MPI /// case, if any of the subtasks fail (for example due to exiting with a - /// non-zero exit code) the entire multi-instance task fails. The - /// multi-instance task is then terminated and retried, up to its retry + /// non-zero exit code) the entire multi-instance Task fails. The + /// multi-instance Task is then terminated and retried, up to its retry /// limit. /// public partial class MultiInstanceSettings @@ -39,10 +39,10 @@ public MultiInstanceSettings() /// Initializes a new instance of the MultiInstanceSettings class. /// /// The command line to run on - /// all the compute nodes to enable them to coordinate when the primary - /// runs the main task command. - /// The number of compute nodes - /// required by the task. + /// all the Compute Nodes to enable them to coordinate when the primary + /// runs the main Task command. + /// The number of Compute Nodes + /// required by the Task. /// A list of files that the Batch /// service will download before running the coordination command /// line. @@ -60,7 +60,7 @@ public MultiInstanceSettings() partial void CustomInit(); /// - /// Gets or sets the number of compute nodes required by the task. + /// Gets or sets the number of Compute Nodes required by the Task. /// /// /// If omitted, the default is 1. @@ -69,8 +69,8 @@ public MultiInstanceSettings() public int? NumberOfInstances { get; set; } /// - /// Gets or sets the command line to run on all the compute nodes to - /// enable them to coordinate when the primary runs the main task + /// Gets or sets the command line to run on all the Compute Nodes to + /// enable them to coordinate when the primary runs the main Task /// command. /// /// @@ -86,12 +86,12 @@ public MultiInstanceSettings() /// before running the coordination command line. /// /// - /// The difference between common resource files and task resource + /// The difference between common resource files and Task resource /// files is that common resource files are downloaded for all subtasks - /// including the primary, whereas task resource files are downloaded + /// including the primary, whereas Task resource files are downloaded /// only for the primary. Also note that these resource files are not - /// downloaded to the task working directory, but instead are - /// downloaded to the task root directory (one directory above the + /// downloaded to the Task working directory, but instead are + /// downloaded to the Task root directory (one directory above the /// working directory). There is a maximum size for the list of /// resource files. When the max size is exceeded, the request will /// fail and the response error code will be RequestEntityTooLarge. If diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NFSMountConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NFSMountConfiguration.cs new file mode 100644 index 000000000000..8db9a3cab5b7 --- /dev/null +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NFSMountConfiguration.cs @@ -0,0 +1,80 @@ +// +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License.txt in the project root for +// license information. +// +// Code generated by Microsoft (R) AutoRest Code Generator. +// Changes may cause incorrect behavior and will be lost if the code is +// regenerated. +// + +namespace Microsoft.Azure.Batch.Protocol.Models +{ + using Newtonsoft.Json; + using System.Linq; + + /// + /// Information used to connect to an NFS file system. + /// + public partial class NFSMountConfiguration + { + /// + /// Initializes a new instance of the NFSMountConfiguration class. + /// + public NFSMountConfiguration() + { + CustomInit(); + } + + /// + /// Initializes a new instance of the NFSMountConfiguration class. + /// + /// The URI of the file system to mount. + /// The relative path on the compute + /// node where the file system will be mounted + /// Additional command line options to pass + /// to the mount command. + public NFSMountConfiguration(string source, string relativeMountPath, string mountOptions = default(string)) + { + Source = source; + RelativeMountPath = relativeMountPath; + MountOptions = mountOptions; + CustomInit(); + } + + /// + /// An initialization method that performs custom operations like setting defaults + /// + partial void CustomInit(); + + /// + /// Gets or sets the URI of the file system to mount. + /// + [JsonProperty(PropertyName = "source")] + public string Source { get; set; } + + /// + /// Gets or sets the relative path on the compute node where the file + /// system will be mounted + /// + /// + /// All file systems are mounted relative to the Batch mounts + /// directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment + /// variable. + /// + [JsonProperty(PropertyName = "relativeMountPath")] + public string RelativeMountPath { get; set; } + + /// + /// Gets or sets additional command line options to pass to the mount + /// command. + /// + /// + /// These are 'net use' options in Windows and 'mount' options in + /// Linux. + /// + [JsonProperty(PropertyName = "mountOptions")] + public string MountOptions { get; set; } + + } +} diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NetworkConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NetworkConfiguration.cs index 296538109f02..e8f53856940e 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NetworkConfiguration.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NetworkConfiguration.cs @@ -11,10 +11,12 @@ namespace Microsoft.Azure.Batch.Protocol.Models { using Newtonsoft.Json; + using System.Collections; + using System.Collections.Generic; using System.Linq; /// - /// The network configuration for a pool. + /// The network configuration for a Pool. /// public partial class NetworkConfiguration { @@ -30,18 +32,21 @@ public NetworkConfiguration() /// Initializes a new instance of the NetworkConfiguration class. /// /// The ARM resource identifier of the virtual - /// network subnet which the compute nodes of the pool will join. This + /// network subnet which the Compute Nodes of the Pool will join. This /// is of the form /// /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. /// The scope of dynamic vnet /// assignment. /// The configuration for endpoints - /// on compute nodes in the Batch pool. - public NetworkConfiguration(string subnetId = default(string), DynamicVNetAssignmentScope? dynamicVNetAssignmentScope = default(DynamicVNetAssignmentScope?), PoolEndpointConfiguration endpointConfiguration = default(PoolEndpointConfiguration)) + /// on Compute Nodes in the Batch Pool. + /// The list of public IPs which the Batch + /// service will use when provisioning Compute Nodes. + public NetworkConfiguration(string subnetId = default(string), DynamicVNetAssignmentScope? dynamicVNetAssignmentScope = default(DynamicVNetAssignmentScope?), PoolEndpointConfiguration endpointConfiguration = default(PoolEndpointConfiguration), IList publicIPs = default(IList)) { SubnetId = subnetId; DynamicVNetAssignmentScope = dynamicVNetAssignmentScope; EndpointConfiguration = endpointConfiguration; + PublicIPs = publicIPs; CustomInit(); } @@ -52,36 +57,36 @@ public NetworkConfiguration() /// /// Gets or sets the ARM resource identifier of the virtual network - /// subnet which the compute nodes of the pool will join. This is of + /// subnet which the Compute Nodes of the Pool will join. This is of /// the form /// /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. /// /// /// The virtual network must be in the same region and subscription as - /// the Azure Batch account. The specified subnet should have enough - /// free IP addresses to accommodate the number of nodes in the pool. - /// If the subnet doesn't have enough free IP addresses, the pool will - /// partially allocate compute nodes, and a resize error will occur. - /// The 'MicrosoftAzureBatch' service principal must have the 'Classic + /// the Azure Batch Account. The specified subnet should have enough + /// free IP addresses to accommodate the number of Compute Nodes in the + /// Pool. If the subnet doesn't have enough free IP addresses, the Pool + /// will partially allocate Nodes, and a resize error will occur. The + /// 'MicrosoftAzureBatch' service principal must have the 'Classic /// Virtual Machine Contributor' Role-Based Access Control (RBAC) role /// for the specified VNet. The specified subnet must allow /// communication from the Azure Batch service to be able to schedule - /// tasks on the compute nodes. This can be verified by checking if the + /// Tasks on the Nodes. This can be verified by checking if the /// specified VNet has any associated Network Security Groups (NSG). If - /// communication to the compute nodes in the specified subnet is - /// denied by an NSG, then the Batch service will set the state of the - /// compute nodes to unusable. For pools created with - /// virtualMachineConfiguration only ARM virtual networks - /// ('Microsoft.Network/virtualNetworks') are supported, but for pools - /// created with cloudServiceConfiguration both ARM and classic virtual - /// networks are supported. If the specified VNet has any associated - /// Network Security Groups (NSG), then a few reserved system ports - /// must be enabled for inbound communication. For pools created with a - /// virtual machine configuration, enable ports 29876 and 29877, as - /// well as port 22 for Linux and port 3389 for Windows. For pools - /// created with a cloud service configuration, enable ports 10100, - /// 20100, and 30100. Also enable outbound connections to Azure Storage - /// on port 443. For more details see: + /// communication to the Nodes in the specified subnet is denied by an + /// NSG, then the Batch service will set the state of the Compute Nodes + /// to unusable. For Pools created with virtualMachineConfiguration + /// only ARM virtual networks ('Microsoft.Network/virtualNetworks') are + /// supported, but for Pools created with cloudServiceConfiguration + /// both ARM and classic virtual networks are supported. If the + /// specified VNet has any associated Network Security Groups (NSG), + /// then a few reserved system ports must be enabled for inbound + /// communication. For Pools created with a virtual machine + /// configuration, enable ports 29876 and 29877, as well as port 22 for + /// Linux and port 3389 for Windows. For Pools created with a cloud + /// service configuration, enable ports 10100, 20100, and 30100. Also + /// enable outbound connections to Azure Storage on port 443. For more + /// details see: /// https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration /// [JsonProperty(PropertyName = "subnetId")] @@ -97,15 +102,30 @@ public NetworkConfiguration() public DynamicVNetAssignmentScope? DynamicVNetAssignmentScope { get; set; } /// - /// Gets or sets the configuration for endpoints on compute nodes in - /// the Batch pool. + /// Gets or sets the configuration for endpoints on Compute Nodes in + /// the Batch Pool. /// /// - /// Pool endpoint configuration is only supported on pools with the + /// Pool endpoint configuration is only supported on Pools with the /// virtualMachineConfiguration property. /// [JsonProperty(PropertyName = "endpointConfiguration")] public PoolEndpointConfiguration EndpointConfiguration { get; set; } + /// + /// Gets or sets the list of public IPs which the Batch service will + /// use when provisioning Compute Nodes. + /// + /// + /// The number of IPs specified here limits the maximum size of the + /// Pool - 50 dedicated nodes or 20 low-priority nodes can be allocated + /// for each public IP. For example, a pool needing 150 dedicated VMs + /// would need at least 3 public IPs specified. Each element of this + /// collection is of the form: + /// /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. + /// + [JsonProperty(PropertyName = "publicIPs")] + public IList PublicIPs { get; set; } + } } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NetworkSecurityGroupRule.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NetworkSecurityGroupRule.cs index a20eedf6015e..22dc802cd9be 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NetworkSecurityGroupRule.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NetworkSecurityGroupRule.cs @@ -56,7 +56,7 @@ public NetworkSecurityGroupRule() /// Gets or sets the priority for this rule. /// /// - /// Priorities within a pool must be unique and are evaluated in order + /// Priorities within a Pool must be unique and are evaluated in order /// of priority. The lower the number the higher the priority. For /// example, rules could be specified with order numbers of 150, 250, /// and 350. The rule with the order number of 150 takes precedence diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeAgentInformation.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeAgentInformation.cs index f1da106b1506..bbd2f83868e9 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeAgentInformation.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeAgentInformation.cs @@ -14,11 +14,11 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Information about the node agent. + /// Information about the Compute Node agent. /// /// - /// The Batch node agent is a program that runs on each node in the pool - /// and provides Batch capability on the compute node. + /// The Batch Compute Node agent is a program that runs on each Compute + /// Node in the Pool and provides Batch capability on the Compute Node. /// public partial class NodeAgentInformation { @@ -33,10 +33,10 @@ public NodeAgentInformation() /// /// Initializes a new instance of the NodeAgentInformation class. /// - /// The version of the Batch node agent running - /// on the compute node. - /// The time when the node agent was - /// updated on the compute node. + /// The version of the Batch Compute Node agent + /// running on the Compute Node. + /// The time when the Compute Node agent + /// was updated on the Compute Node. public NodeAgentInformation(string version, System.DateTime lastUpdateTime) { Version = version; @@ -50,24 +50,24 @@ public NodeAgentInformation(string version, System.DateTime lastUpdateTime) partial void CustomInit(); /// - /// Gets or sets the version of the Batch node agent running on the - /// compute node. + /// Gets or sets the version of the Batch Compute Node agent running on + /// the Compute Node. /// /// - /// This version number can be checked against the node agent release - /// notes located at + /// This version number can be checked against the Compute Node agent + /// release notes located at /// https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md. /// [JsonProperty(PropertyName = "version")] public string Version { get; set; } /// - /// Gets or sets the time when the node agent was updated on the - /// compute node. + /// Gets or sets the time when the Compute Node agent was updated on + /// the Compute Node. /// /// - /// This is the most recent time that the node agent was updated to a - /// new version. + /// This is the most recent time that the Compute Node agent was + /// updated to a new version. /// [JsonProperty(PropertyName = "lastUpdateTime")] public System.DateTime LastUpdateTime { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeCounts.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeCounts.cs index 3b6659c9b655..3a1bebf43ad8 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeCounts.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeCounts.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The number of nodes in each node state. + /// The number of Compute Nodes in each Compute Node state. /// public partial class NodeCounts { @@ -29,32 +29,33 @@ public NodeCounts() /// /// Initializes a new instance of the NodeCounts class. /// - /// The number of nodes in the creating + /// The number of Compute Nodes in the creating /// state. - /// The number of nodes in the idle state. - /// The number of nodes in the offline + /// The number of Compute Nodes in the idle /// state. - /// The number of nodes in the preempted + /// The number of Compute Nodes in the offline /// state. - /// The count of nodes in the rebooting + /// The number of Compute Nodes in the + /// preempted state. + /// The count of Compute Nodes in the rebooting /// state. - /// The number of nodes in the reimaging + /// The number of Compute Nodes in the + /// reimaging state. + /// The number of Compute Nodes in the running /// state. - /// The number of nodes in the running + /// The number of Compute Nodes in the starting /// state. - /// The number of nodes in the starting - /// state. - /// The number of nodes in the + /// The number of Compute Nodes in the /// startTaskFailed state. - /// The number of nodes in the leavingPool - /// state. - /// The number of nodes in the unknown + /// The number of Compute Nodes in the + /// leavingPool state. + /// The number of Compute Nodes in the unknown /// state. - /// The number of nodes in the unusable + /// The number of Compute Nodes in the unusable /// state. - /// The number of nodes in the - /// waitingForStartTask state. - /// The total number of nodes. + /// The number of Compute Nodes in + /// the waitingForStartTask state. + /// The total number of Compute Nodes. 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; @@ -80,85 +81,87 @@ public NodeCounts(int creating, int idle, int offline, int preempted, int reboot partial void CustomInit(); /// - /// Gets or sets the number of nodes in the creating state. + /// Gets or sets the number of Compute Nodes in the creating state. /// [JsonProperty(PropertyName = "creating")] public int Creating { get; set; } /// - /// Gets or sets the number of nodes in the idle state. + /// Gets or sets the number of Compute Nodes in the idle state. /// [JsonProperty(PropertyName = "idle")] public int Idle { get; set; } /// - /// Gets or sets the number of nodes in the offline state. + /// Gets or sets the number of Compute Nodes in the offline state. /// [JsonProperty(PropertyName = "offline")] public int Offline { get; set; } /// - /// Gets or sets the number of nodes in the preempted state. + /// Gets or sets the number of Compute Nodes in the preempted state. /// [JsonProperty(PropertyName = "preempted")] public int Preempted { get; set; } /// - /// Gets or sets the count of nodes in the rebooting state. + /// Gets or sets the count of Compute Nodes in the rebooting state. /// [JsonProperty(PropertyName = "rebooting")] public int Rebooting { get; set; } /// - /// Gets or sets the number of nodes in the reimaging state. + /// Gets or sets the number of Compute Nodes in the reimaging state. /// [JsonProperty(PropertyName = "reimaging")] public int Reimaging { get; set; } /// - /// Gets or sets the number of nodes in the running state. + /// Gets or sets the number of Compute Nodes in the running state. /// [JsonProperty(PropertyName = "running")] public int Running { get; set; } /// - /// Gets or sets the number of nodes in the starting state. + /// Gets or sets the number of Compute Nodes in the starting state. /// [JsonProperty(PropertyName = "starting")] public int Starting { get; set; } /// - /// Gets or sets the number of nodes in the startTaskFailed state. + /// Gets or sets the number of Compute Nodes in the startTaskFailed + /// state. /// [JsonProperty(PropertyName = "startTaskFailed")] public int StartTaskFailed { get; set; } /// - /// Gets or sets the number of nodes in the leavingPool state. + /// Gets or sets the number of Compute Nodes in the leavingPool state. /// [JsonProperty(PropertyName = "leavingPool")] public int LeavingPool { get; set; } /// - /// Gets or sets the number of nodes in the unknown state. + /// Gets or sets the number of Compute Nodes in the unknown state. /// [JsonProperty(PropertyName = "unknown")] public int Unknown { get; set; } /// - /// Gets or sets the number of nodes in the unusable state. + /// Gets or sets the number of Compute Nodes in the unusable state. /// [JsonProperty(PropertyName = "unusable")] public int Unusable { get; set; } /// - /// Gets or sets the number of nodes in the waitingForStartTask state. + /// Gets or sets the number of Compute Nodes in the waitingForStartTask + /// state. /// [JsonProperty(PropertyName = "waitingForStartTask")] public int WaitingForStartTask { get; set; } /// - /// Gets or sets the total number of nodes. + /// Gets or sets the total number of Compute Nodes. /// [JsonProperty(PropertyName = "total")] public int Total { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeDisableSchedulingParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeDisableSchedulingParameter.cs index a08d24cca557..a1435b7d83a2 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeDisableSchedulingParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeDisableSchedulingParameter.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Options for disabling scheduling on a compute node. + /// Options for disabling scheduling on a Compute Node. /// public partial class NodeDisableSchedulingParameter { @@ -32,8 +32,8 @@ public NodeDisableSchedulingParameter() /// class. /// /// What to do with currently - /// running tasks when disabling task scheduling on the compute - /// node. + /// running Tasks when disabling Task scheduling on the Compute + /// Node. public NodeDisableSchedulingParameter(DisableComputeNodeSchedulingOption? nodeDisableSchedulingOption = default(DisableComputeNodeSchedulingOption?)) { NodeDisableSchedulingOption = nodeDisableSchedulingOption; @@ -46,8 +46,8 @@ public NodeDisableSchedulingParameter() partial void CustomInit(); /// - /// Gets or sets what to do with currently running tasks when disabling - /// task scheduling on the compute node. + /// Gets or sets what to do with currently running Tasks when disabling + /// Task scheduling on the Compute Node. /// /// /// The default value is requeue. Possible values include: 'requeue', diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeFile.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeFile.cs index 9348d477746c..ca3e964442e2 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeFile.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeFile.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Information about a file or directory on a compute node. + /// Information about a file or directory on a Compute Node. /// public partial class NodeFile { diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeRebootParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeRebootParameter.cs index e28c381446d1..49e92daeffdf 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeRebootParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeRebootParameter.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Options for rebooting a compute node. + /// Options for rebooting a Compute Node. /// public partial class NodeRebootParameter { @@ -29,8 +29,8 @@ public NodeRebootParameter() /// /// Initializes a new instance of the NodeRebootParameter class. /// - /// When to reboot the compute node and - /// what to do with currently running tasks. + /// When to reboot the Compute Node and + /// what to do with currently running Tasks. public NodeRebootParameter(ComputeNodeRebootOption? nodeRebootOption = default(ComputeNodeRebootOption?)) { NodeRebootOption = nodeRebootOption; @@ -43,8 +43,8 @@ public NodeRebootParameter() partial void CustomInit(); /// - /// Gets or sets when to reboot the compute node and what to do with - /// currently running tasks. + /// Gets or sets when to reboot the Compute Node and what to do with + /// currently running Tasks. /// /// /// The default value is requeue. Possible values include: 'requeue', diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeReimageParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeReimageParameter.cs index ad51693b37f3..9fa3be28db93 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeReimageParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeReimageParameter.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Options for reimaging a compute node. + /// Options for reimaging a Compute Node. /// public partial class NodeReimageParameter { @@ -29,8 +29,8 @@ public NodeReimageParameter() /// /// Initializes a new instance of the NodeReimageParameter class. /// - /// When to reimage the compute node - /// and what to do with currently running tasks. + /// When to reimage the Compute Node + /// and what to do with currently running Tasks. public NodeReimageParameter(ComputeNodeReimageOption? nodeReimageOption = default(ComputeNodeReimageOption?)) { NodeReimageOption = nodeReimageOption; @@ -43,8 +43,8 @@ public NodeReimageParameter() partial void CustomInit(); /// - /// Gets or sets when to reimage the compute node and what to do with - /// currently running tasks. + /// Gets or sets when to reimage the Compute Node and what to do with + /// currently running Tasks. /// /// /// The default value is requeue. Possible values include: 'requeue', diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeRemoveParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeRemoveParameter.cs index 1591f8607e80..de3f49ab8f3d 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeRemoveParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeRemoveParameter.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Options for removing compute nodes from a pool. + /// Options for removing Compute Nodes from a Pool. /// public partial class NodeRemoveParameter { @@ -31,12 +31,12 @@ public NodeRemoveParameter() /// /// Initializes a new instance of the NodeRemoveParameter class. /// - /// A list containing the IDs of the compute - /// nodes to be removed from the specified pool. - /// The timeout for removal of compute - /// nodes to the pool. + /// A list containing the IDs of the Compute + /// Nodes to be removed from the specified Pool. + /// The timeout for removal of Compute + /// Nodes to the Pool. /// Determines what to do with a - /// node and its running task(s) after it has been selected for + /// Compute Node and its running task(s) after it has been selected for /// deallocation. public NodeRemoveParameter(IList nodeList, System.TimeSpan? resizeTimeout = default(System.TimeSpan?), ComputeNodeDeallocationOption? nodeDeallocationOption = default(ComputeNodeDeallocationOption?)) { @@ -52,14 +52,14 @@ public NodeRemoveParameter() partial void CustomInit(); /// - /// Gets or sets a list containing the IDs of the compute nodes to be - /// removed from the specified pool. + /// Gets or sets a list containing the IDs of the Compute Nodes to be + /// removed from the specified Pool. /// [JsonProperty(PropertyName = "nodeList")] public IList NodeList { get; set; } /// - /// Gets or sets the timeout for removal of compute nodes to the pool. + /// Gets or sets the timeout for removal of Compute Nodes to the Pool. /// /// /// The default value is 15 minutes. The minimum value is 5 minutes. If @@ -71,8 +71,8 @@ public NodeRemoveParameter() public System.TimeSpan? ResizeTimeout { get; set; } /// - /// Gets or sets determines what to do with a node and its running - /// task(s) after it has been selected for deallocation. + /// Gets or sets determines what to do with a Compute Node and its + /// running task(s) after it has been selected for deallocation. /// /// /// The default value is requeue. Possible values include: 'requeue', diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeUpdateUserParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeUpdateUserParameter.cs index 7fb4b6d095ad..f62c5a127335 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeUpdateUserParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/NodeUpdateUserParameter.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The set of changes to be made to a user account on a node. + /// The set of changes to be made to a user Account on a Compute Node. /// public partial class NodeUpdateUserParameter { @@ -29,11 +29,11 @@ public NodeUpdateUserParameter() /// /// Initializes a new instance of the NodeUpdateUserParameter class. /// - /// The password of the account. - /// The time at which the account should + /// The password of the Account. + /// The time at which the Account should /// expire. /// The SSH public key that can be used for - /// remote login to the compute node. + /// remote login to the Compute Node. public NodeUpdateUserParameter(string password = default(string), System.DateTime? expiryTime = default(System.DateTime?), string sshPublicKey = default(string)) { Password = password; @@ -48,13 +48,13 @@ public NodeUpdateUserParameter() partial void CustomInit(); /// - /// Gets or sets the password of the account. + /// Gets or sets the password of the Account. /// /// - /// The password is required for Windows nodes (those created with - /// 'cloudServiceConfiguration', or created with - /// 'virtualMachineConfiguration' using a Windows image reference). For - /// Linux compute nodes, the password can optionally be specified along + /// The password is required for Windows Compute Nodes (those created + /// with 'cloudServiceConfiguration', or created with + /// 'virtualMachineConfiguration' using a Windows Image reference). For + /// Linux Compute Nodes, the password can optionally be specified along /// with the sshPublicKey property. If omitted, any existing password /// is removed. /// @@ -62,26 +62,26 @@ public NodeUpdateUserParameter() public string Password { get; set; } /// - /// Gets or sets the time at which the account should expire. + /// Gets or sets the time at which the Account should expire. /// /// /// If omitted, the default is 1 day from the current time. For Linux - /// compute nodes, the expiryTime has a precision up to a day. + /// Compute Nodes, the expiryTime has a precision up to a day. /// [JsonProperty(PropertyName = "expiryTime")] public System.DateTime? ExpiryTime { get; set; } /// /// Gets or sets the SSH public key that can be used for remote login - /// to the compute node. + /// to the Compute Node. /// /// /// The public key should be compatible with OpenSSH encoding and /// should be base 64 encoded. This property can be specified only for - /// Linux nodes. If this is specified for a Windows node, then the - /// Batch service rejects the request; if you are calling the REST API - /// directly, the HTTP status code is 400 (Bad Request). If omitted, - /// any existing SSH public key is removed. + /// Linux Compute Nodes. If this is specified for a Windows Compute + /// Node, then the Batch service rejects the request; if you are + /// calling the REST API directly, the HTTP status code is 400 (Bad + /// Request). If omitted, any existing SSH public key is removed. /// [JsonProperty(PropertyName = "sshPublicKey")] public string SshPublicKey { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/OnAllTasksComplete.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/OnAllTasksComplete.cs index 9a8b0341c27f..258f639ec339 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/OnAllTasksComplete.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/OnAllTasksComplete.cs @@ -22,13 +22,13 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum OnAllTasksComplete { /// - /// Do nothing. The job remains active unless terminated or disabled by + /// Do nothing. The Job remains active unless terminated or disabled by /// some other means. /// [EnumMember(Value = "noaction")] NoAction, /// - /// Terminate the job. The job's terminateReason is set to + /// Terminate the Job. The Job's terminateReason is set to /// 'AllTasksComplete'. /// [EnumMember(Value = "terminatejob")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/OnTaskFailure.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/OnTaskFailure.cs index d38aa5dd175e..b0350b2ae92b 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/OnTaskFailure.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/OnTaskFailure.cs @@ -22,15 +22,15 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum OnTaskFailure { /// - /// Do nothing. The job remains active unless terminated or disabled by + /// Do nothing. The Job remains active unless terminated or disabled by /// some other means. /// [EnumMember(Value = "noaction")] NoAction, /// - /// Take the action associated with the task exit condition in the - /// task's exitConditions collection. (This may still result in no - /// action being taken, if that is what the task specifies.) + /// Take the action associated with the Task exit condition in the + /// Task's exitConditions collection. (This may still result in no + /// action being taken, if that is what the Task specifies.) /// [EnumMember(Value = "performexitoptionsjobaction")] PerformExitOptionsJobAction diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/OutputFile.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/OutputFile.cs index 203fa90df53d..3010e86e1085 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/OutputFile.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/OutputFile.cs @@ -14,9 +14,9 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// A specification for uploading files from an Azure Batch node to another - /// location after the Batch service has finished executing the task - /// process. + /// A specification for uploading files from an Azure Batch Compute Node to + /// another location after the Batch service has finished executing the + /// Task process. /// public partial class OutputFile { @@ -56,7 +56,7 @@ public OutputFile(string filePattern, OutputFileDestination destination, OutputF /// /// /// Both relative and absolute paths are supported. Relative paths are - /// relative to the task working directory. The following wildcards are + /// relative to the Task working directory. The following wildcards are /// supported: * matches 0 or more characters (for example pattern abc* /// would match abc or abcdef), ** matches any directory, ? matches any /// single character, [abc] matches one character in the brackets, and @@ -66,7 +66,7 @@ public OutputFile(string filePattern, OutputFileDestination destination, OutputF /// "." it is ignored by default but may be matched by specifying it /// explicitly (for example *.gif will not match .a.gif, but .*.gif /// will). A simple example: **\*.txt matches any file that does not - /// start in '.' and ends with .txt in the task working directory or + /// start in '.' and ends with .txt in the Task working directory or /// any subdirectory. If the filename contains a wildcard character it /// can be escaped using brackets (for example abc[*] would match a /// file named abc*). Note that both \ and / are treated as directory diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/OutputFileUploadCondition.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/OutputFileUploadCondition.cs index 4aa401e13cdf..e5b1cd74f628 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/OutputFileUploadCondition.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/OutputFileUploadCondition.cs @@ -22,19 +22,19 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum OutputFileUploadCondition { /// - /// Upload the file(s) only after the task process exits with an exit + /// Upload the file(s) only after the Task process exits with an exit /// code of 0. /// [EnumMember(Value = "tasksuccess")] TaskSuccess, /// - /// Upload the file(s) only after the task process exits with a nonzero + /// Upload the file(s) only after the Task process exits with a nonzero /// exit code. /// [EnumMember(Value = "taskfailure")] TaskFailure, /// - /// Upload the file(s) after the task process exits, no matter what the + /// Upload the file(s) after the Task process exits, no matter what the /// exit code was. /// [EnumMember(Value = "taskcompletion")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/OutputFileUploadOptions.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/OutputFileUploadOptions.cs index ff1371803232..4f90c3988efe 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/OutputFileUploadOptions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/OutputFileUploadOptions.cs @@ -30,7 +30,7 @@ public OutputFileUploadOptions() /// /// Initializes a new instance of the OutputFileUploadOptions class. /// - /// The conditions under which the task + /// The conditions under which the Task /// output file or set of files should be uploaded. public OutputFileUploadOptions(OutputFileUploadCondition uploadCondition) { @@ -44,7 +44,7 @@ public OutputFileUploadOptions(OutputFileUploadCondition uploadCondition) partial void CustomInit(); /// - /// Gets or sets the conditions under which the task output file or set + /// Gets or sets the conditions under which the Task output file or set /// of files should be uploaded. /// /// diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolAddHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolAddHeaders.cs index 056c54e78c9d..1dba429c9f1c 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolAddHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolAddHeaders.cs @@ -39,8 +39,8 @@ public PoolAddHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public PoolAddHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolAddParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolAddParameter.cs index 05d7a0bea550..ea7fdaf04848 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolAddParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolAddParameter.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// A pool in the Azure Batch service to add. + /// A Pool in the Azure Batch service to add. /// public partial class PoolAddParameter { @@ -31,50 +31,52 @@ public PoolAddParameter() /// /// Initializes a new instance of the PoolAddParameter class. /// - /// A string that uniquely identifies the pool within - /// the account. - /// The size of virtual machines in the pool. All - /// virtual machines in a pool are the same size. - /// The display name for the pool. + /// A string that uniquely identifies the Pool within + /// the Account. + /// The size of virtual machines in the Pool. All + /// virtual machines in a Pool are the same size. + /// The display name for the Pool. /// The cloud service - /// configuration for the pool. + /// configuration for the Pool. /// The virtual machine - /// configuration for the pool. - /// The timeout for allocation of compute - /// nodes to the pool. + /// configuration for the Pool. + /// The timeout for allocation of Compute + /// Nodes to the Pool. /// The desired number of dedicated - /// compute nodes in the pool. + /// Compute Nodes in the Pool. /// The desired number of - /// low-priority compute nodes in the pool. - /// Whether the pool size should + /// low-priority Compute Nodes in the Pool. + /// Whether the Pool size should /// automatically adjust over time. /// A formula for the desired number of - /// compute nodes in the pool. + /// Compute Nodes in the Pool. /// The time interval at - /// which to automatically adjust the pool size according to the + /// which to automatically adjust the Pool size according to the /// autoscale formula. - /// Whether the pool permits - /// direct communication between nodes. + /// Whether the Pool permits + /// direct communication between Compute Nodes. /// The network configuration for - /// the pool. - /// A task specified to run on each compute - /// node as it joins the pool. - /// The list of certificates to be - /// installed on each compute node in the pool. - /// The list of application - /// packages to be installed on each compute node in the pool. + /// the Pool. + /// A Task specified to run on each Compute + /// Node as it joins the Pool. + /// The list of Certificates to be + /// installed on each Compute Node in the Pool. + /// The list of Packages to + /// be installed on each Compute Node in the Pool. /// The list of application licenses - /// the Batch service will make available on each compute node in the - /// pool. - /// The maximum number of tasks that can - /// run concurrently on a single compute node in the pool. - /// How tasks are distributed across - /// compute nodes in a pool. - /// The list of user accounts to be created - /// on each node in the pool. + /// the Batch service will make available on each Compute Node in the + /// Pool. + /// The maximum number of Tasks that can + /// run concurrently on a single Compute Node in the Pool. + /// How Tasks are distributed across + /// Compute Nodes in a Pool. + /// The list of user Accounts to be created + /// on each Compute Node in the Pool. /// A list of name-value pairs associated with - /// the pool as metadata. - public PoolAddParameter(string id, string vmSize, string displayName = default(string), CloudServiceConfiguration cloudServiceConfiguration = default(CloudServiceConfiguration), VirtualMachineConfiguration virtualMachineConfiguration = default(VirtualMachineConfiguration), System.TimeSpan? resizeTimeout = default(System.TimeSpan?), int? targetDedicatedNodes = default(int?), int? targetLowPriorityNodes = default(int?), bool? enableAutoScale = default(bool?), string autoScaleFormula = default(string), System.TimeSpan? autoScaleEvaluationInterval = default(System.TimeSpan?), 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)) + /// the Pool as metadata. + /// Mount storage using specified file + /// system for the entire lifetime of the pool. + public PoolAddParameter(string id, string vmSize, string displayName = default(string), CloudServiceConfiguration cloudServiceConfiguration = default(CloudServiceConfiguration), VirtualMachineConfiguration virtualMachineConfiguration = default(VirtualMachineConfiguration), System.TimeSpan? resizeTimeout = default(System.TimeSpan?), int? targetDedicatedNodes = default(int?), int? targetLowPriorityNodes = default(int?), bool? enableAutoScale = default(bool?), string autoScaleFormula = default(string), System.TimeSpan? autoScaleEvaluationInterval = default(System.TimeSpan?), 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), IList mountConfiguration = default(IList)) { Id = id; DisplayName = displayName; @@ -97,6 +99,7 @@ public PoolAddParameter() TaskSchedulingPolicy = taskSchedulingPolicy; UserAccounts = userAccounts; Metadata = metadata; + MountConfiguration = mountConfiguration; CustomInit(); } @@ -106,21 +109,21 @@ public PoolAddParameter() partial void CustomInit(); /// - /// Gets or sets a string that uniquely identifies the pool within the - /// account. + /// Gets or sets a string that uniquely identifies the Pool within the + /// Account. /// /// /// The ID can contain any combination of alphanumeric characters /// including hyphens and underscores, and cannot contain more than 64 /// characters. The ID is case-preserving and case-insensitive (that - /// is, you may not have two pool IDs within an account that differ + /// is, you may not have two Pool IDs within an Account that differ /// only by case). /// [JsonProperty(PropertyName = "id")] public string Id { get; set; } /// - /// Gets or sets the display name for the pool. + /// Gets or sets the display name for the Pool. /// /// /// The display name need not be unique and can contain any Unicode @@ -130,17 +133,17 @@ public PoolAddParameter() public string DisplayName { get; set; } /// - /// Gets or sets the size of virtual machines in the pool. All virtual - /// machines in a pool are the same size. + /// Gets or sets the size of virtual machines in the Pool. All virtual + /// machines in a Pool are the same size. /// /// /// For information about available sizes of virtual machines for Cloud - /// Services pools (pools created with cloudServiceConfiguration), see + /// Services Pools (pools created with cloudServiceConfiguration), see /// Sizes for Cloud Services /// (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 + /// and A2V2. For information about available VM sizes for Pools using + /// Images from the Virtual Machines Marketplace (pools created with /// virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) /// (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) /// or Sizes for Virtual Machines (Windows) @@ -153,19 +156,19 @@ public PoolAddParameter() public string VmSize { get; set; } /// - /// Gets or sets the cloud service configuration for the pool. + /// Gets or sets the cloud service configuration for the Pool. /// /// /// This property and virtualMachineConfiguration are mutually /// exclusive and one of the properties must be specified. This - /// property cannot be specified if the Batch account was created with + /// property cannot be specified if the Batch Account was created with /// its poolAllocationMode property set to 'UserSubscription'. /// [JsonProperty(PropertyName = "cloudServiceConfiguration")] public CloudServiceConfiguration CloudServiceConfiguration { get; set; } /// - /// Gets or sets the virtual machine configuration for the pool. + /// Gets or sets the virtual machine configuration for the Pool. /// /// /// This property and cloudServiceConfiguration are mutually exclusive @@ -175,8 +178,8 @@ public PoolAddParameter() public VirtualMachineConfiguration VirtualMachineConfiguration { get; set; } /// - /// Gets or sets the timeout for allocation of compute nodes to the - /// pool. + /// Gets or sets the timeout for allocation of Compute Nodes to the + /// Pool. /// /// /// This timeout applies only to manual scaling; it has no effect when @@ -189,8 +192,8 @@ public PoolAddParameter() public System.TimeSpan? ResizeTimeout { get; set; } /// - /// Gets or sets the desired number of dedicated compute nodes in the - /// pool. + /// Gets or sets the desired number of dedicated Compute Nodes in the + /// Pool. /// /// /// This property must not be specified if enableAutoScale is set to @@ -201,8 +204,8 @@ public PoolAddParameter() public int? TargetDedicatedNodes { get; set; } /// - /// Gets or sets the desired number of low-priority compute nodes in - /// the pool. + /// Gets or sets the desired number of low-priority Compute Nodes in + /// the Pool. /// /// /// This property must not be specified if enableAutoScale is set to @@ -213,30 +216,30 @@ public PoolAddParameter() public int? TargetLowPriorityNodes { get; set; } /// - /// Gets or sets whether the pool size should automatically adjust over + /// Gets or sets whether the Pool size should automatically adjust over /// time. /// /// /// If false, at least one of targetDedicateNodes and /// targetLowPriorityNodes must be specified. If true, the - /// autoScaleFormula property is required and the pool automatically + /// autoScaleFormula property is required and the Pool automatically /// resizes according to the formula. The default value is false. /// [JsonProperty(PropertyName = "enableAutoScale")] public bool? EnableAutoScale { get; set; } /// - /// Gets or sets a formula for the desired number of compute nodes in - /// the pool. + /// Gets or sets a formula for the desired number of Compute Nodes in + /// the Pool. /// /// /// This property must not be specified if enableAutoScale is set to /// false. It is required if enableAutoScale is set to true. The - /// formula is checked for validity before the pool is created. If the + /// formula is checked for validity before the Pool is created. If the /// formula is not valid, the Batch service rejects the request with /// detailed error information. For more information about specifying - /// this formula, see 'Automatically scale compute nodes in an Azure - /// Batch pool' + /// this formula, see 'Automatically scale Compute Nodes in an Azure + /// Batch Pool' /// (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/). /// [JsonProperty(PropertyName = "autoScaleFormula")] @@ -244,7 +247,7 @@ public PoolAddParameter() /// /// Gets or sets the time interval at which to automatically adjust the - /// pool size according to the autoscale formula. + /// Pool size according to the autoscale formula. /// /// /// The default value is 15 minutes. The minimum and maximum value are @@ -257,105 +260,108 @@ public PoolAddParameter() public System.TimeSpan? AutoScaleEvaluationInterval { get; set; } /// - /// Gets or sets whether the pool permits direct communication between - /// nodes. + /// Gets or sets whether the Pool permits direct communication between + /// Compute Nodes. /// /// /// Enabling inter-node communication limits the maximum size of the - /// pool due to deployment restrictions on the nodes of the pool. This - /// may result in the pool not reaching its desired size. The default - /// value is false. + /// Pool due to deployment restrictions on the Compute Nodes of the + /// Pool. This may result in the Pool not reaching its desired size. + /// The default value is false. /// [JsonProperty(PropertyName = "enableInterNodeCommunication")] public bool? EnableInterNodeCommunication { get; set; } /// - /// Gets or sets the network configuration for the pool. + /// Gets or sets the network configuration for the Pool. /// [JsonProperty(PropertyName = "networkConfiguration")] public NetworkConfiguration NetworkConfiguration { get; set; } /// - /// Gets or sets a task specified to run on each compute node as it - /// joins the pool. + /// Gets or sets a Task specified to run on each Compute Node as it + /// joins the Pool. /// /// - /// The task runs when the node is added to the pool or when the node - /// is restarted. + /// The Task runs when the Compute Node is added to the Pool or when + /// the Compute Node is restarted. /// [JsonProperty(PropertyName = "startTask")] public StartTask StartTask { get; set; } /// - /// Gets or sets the list of certificates to be installed on each - /// compute node in the pool. + /// Gets or sets the list of Certificates to be installed on each + /// Compute Node in the Pool. /// /// - /// For Windows compute nodes, the Batch service installs the - /// certificates to the specified certificate store and location. For - /// Linux compute nodes, the certificates are stored in a directory - /// inside the task working directory and an environment variable - /// AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this - /// location. For certificates with visibility of 'remoteUser', a + /// For Windows Nodes, the Batch service installs the Certificates to + /// the specified Certificate store and location. For Linux Compute + /// Nodes, the Certificates are stored in a directory inside the Task + /// working directory and an environment variable + /// AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this + /// location. For Certificates with visibility of 'remoteUser', a /// 'certs' directory is created in the user's home directory (e.g., - /// /home/{user-name}/certs) and certificates are placed in that + /// /home/{user-name}/certs) and Certificates are placed in that /// directory. /// [JsonProperty(PropertyName = "certificateReferences")] public IList CertificateReferences { get; set; } /// - /// Gets or sets the list of application packages to be installed on - /// each compute node in the pool. + /// Gets or sets the list of Packages to be installed on each Compute + /// Node in the Pool. /// /// - /// Changes to application package references affect all new compute - /// nodes joining the pool, but do not affect compute nodes that are - /// already in the pool until they are rebooted or reimaged. There is a - /// maximum of 10 application package references on any given pool. + /// Changes to Package references affect all new Nodes joining the + /// Pool, but do not affect Compute Nodes that are already in the Pool + /// until they are rebooted or reimaged. There is a maximum of 10 + /// Package references on any given Pool. /// [JsonProperty(PropertyName = "applicationPackageReferences")] public IList ApplicationPackageReferences { get; set; } /// /// Gets or sets the list of application licenses the Batch service - /// will make available on each compute node in the pool. + /// will make available on each Compute Node in the Pool. /// /// /// The list of application licenses must be a subset of available /// Batch service application licenses. If a license is requested which - /// is not supported, pool creation will fail. + /// is not supported, Pool creation will fail. /// [JsonProperty(PropertyName = "applicationLicenses")] public IList ApplicationLicenses { get; set; } /// - /// Gets or sets the maximum number of tasks that can run concurrently - /// on a single compute node in the pool. + /// Gets or sets the maximum number of Tasks that can run concurrently + /// on a single Compute Node in the Pool. /// /// /// The default value is 1. The maximum value is the smaller of 4 times - /// the number of cores of the vmSize of the pool or 256. + /// the number of cores of the vmSize of the Pool or 256. /// [JsonProperty(PropertyName = "maxTasksPerNode")] public int? MaxTasksPerNode { get; set; } /// - /// Gets or sets how tasks are distributed across compute nodes in a - /// pool. + /// Gets or sets how Tasks are distributed across Compute Nodes in a + /// Pool. /// + /// + /// If not specified, the default is spread. + /// [JsonProperty(PropertyName = "taskSchedulingPolicy")] public TaskSchedulingPolicy TaskSchedulingPolicy { get; set; } /// - /// Gets or sets the list of user accounts to be created on each node - /// in the pool. + /// Gets or sets the list of user Accounts to be created on each + /// Compute Node in the Pool. /// [JsonProperty(PropertyName = "userAccounts")] public IList UserAccounts { get; set; } /// - /// Gets or sets a list of name-value pairs associated with the pool as + /// Gets or sets a list of name-value pairs associated with the Pool as /// metadata. /// /// @@ -365,5 +371,16 @@ public PoolAddParameter() [JsonProperty(PropertyName = "metadata")] public IList Metadata { get; set; } + /// + /// Gets or sets mount storage using specified file system for the + /// entire lifetime of the pool. + /// + /// + /// Mount the storage using Azure fileshare, NFS, CIFS or Blobfuse + /// based file system. + /// + [JsonProperty(PropertyName = "mountConfiguration")] + public IList MountConfiguration { get; set; } + } } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolDeleteHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolDeleteHeaders.cs index bbf42fb72f04..4e4334924046 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolDeleteHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolDeleteHeaders.cs @@ -37,8 +37,8 @@ public PoolDeleteHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. public PoolDeleteHeaders(string clientRequestId = default(string), string requestId = default(string)) { ClientRequestId = clientRequestId; @@ -65,8 +65,8 @@ public PoolDeleteHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public string RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolDisableAutoScaleHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolDisableAutoScaleHeaders.cs index 3590bb523c8c..9b60a71c8f45 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolDisableAutoScaleHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolDisableAutoScaleHeaders.cs @@ -41,8 +41,8 @@ public PoolDisableAutoScaleHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -81,8 +81,8 @@ public PoolDisableAutoScaleHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolEnableAutoScaleHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolEnableAutoScaleHeaders.cs index b2e47a0053d8..3e3a4d53eac4 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolEnableAutoScaleHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolEnableAutoScaleHeaders.cs @@ -39,8 +39,8 @@ public PoolEnableAutoScaleHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public PoolEnableAutoScaleHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolEnableAutoScaleParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolEnableAutoScaleParameter.cs index 534a52e74081..405ceab6a43a 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolEnableAutoScaleParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolEnableAutoScaleParameter.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Options for enabling automatic scaling on a pool. + /// Options for enabling automatic scaling on a Pool. /// public partial class PoolEnableAutoScaleParameter { @@ -32,9 +32,9 @@ public PoolEnableAutoScaleParameter() /// class. /// /// The formula for the desired number - /// of compute nodes in the pool. + /// of Compute Nodes in the Pool. /// The time interval at - /// which to automatically adjust the pool size according to the + /// which to automatically adjust the Pool size according to the /// autoscale formula. public PoolEnableAutoScaleParameter(string autoScaleFormula = default(string), System.TimeSpan? autoScaleEvaluationInterval = default(System.TimeSpan?)) { @@ -49,15 +49,15 @@ public PoolEnableAutoScaleParameter() partial void CustomInit(); /// - /// Gets or sets the formula for the desired number of compute nodes in - /// the pool. + /// Gets or sets the formula for the desired number of Compute Nodes in + /// the Pool. /// /// /// The formula is checked for validity before it is applied to the - /// pool. If the formula is not valid, the Batch service rejects the + /// Pool. If the formula is not valid, the Batch service rejects the /// request with detailed error information. For more information about - /// specifying this formula, see Automatically scale compute nodes in - /// an Azure Batch pool + /// specifying this formula, see Automatically scale Compute Nodes in + /// an Azure Batch Pool /// (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling). /// [JsonProperty(PropertyName = "autoScaleFormula")] @@ -65,7 +65,7 @@ public PoolEnableAutoScaleParameter() /// /// Gets or sets the time interval at which to automatically adjust the - /// pool size according to the autoscale formula. + /// Pool size according to the autoscale formula. /// /// /// The default value is 15 minutes. The minimum and maximum value are diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolEndpointConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolEndpointConfiguration.cs index 500730b26348..e6e4933de266 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolEndpointConfiguration.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolEndpointConfiguration.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The endpoint configuration for a pool. + /// The endpoint configuration for a Pool. /// public partial class PoolEndpointConfiguration { @@ -31,8 +31,8 @@ public PoolEndpointConfiguration() /// /// Initializes a new instance of the PoolEndpointConfiguration class. /// - /// A list of inbound NAT pools that can - /// be used to address specific ports on an individual compute node + /// A list of inbound NAT Pools that can + /// be used to address specific ports on an individual Compute Node /// externally. public PoolEndpointConfiguration(IList inboundNATPools) { @@ -46,12 +46,12 @@ public PoolEndpointConfiguration(IList inboundNATPools) partial void CustomInit(); /// - /// Gets or sets a list of inbound NAT pools that can be used to - /// address specific ports on an individual compute node externally. + /// Gets or sets a list of inbound NAT Pools that can be used to + /// address specific ports on an individual Compute Node externally. /// /// - /// The maximum number of inbound NAT pools per Batch pool is 5. If the - /// maximum number of inbound NAT pools is exceeded the request fails + /// The maximum number of inbound NAT Pools per Batch Pool is 5. If the + /// maximum number of inbound NAT Pools is exceeded the request fails /// with HTTP status code 400. /// [JsonProperty(PropertyName = "inboundNATPools")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolEvaluateAutoScaleHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolEvaluateAutoScaleHeaders.cs index 1c0f65d168c6..abb8eb439e44 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolEvaluateAutoScaleHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolEvaluateAutoScaleHeaders.cs @@ -41,8 +41,8 @@ public PoolEvaluateAutoScaleHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -81,8 +81,8 @@ public PoolEvaluateAutoScaleHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolEvaluateAutoScaleParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolEvaluateAutoScaleParameter.cs index 0badce296db6..53805faa7cf1 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolEvaluateAutoScaleParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolEvaluateAutoScaleParameter.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Options for evaluating an automatic scaling formula on a pool. + /// Options for evaluating an automatic scaling formula on a Pool. /// public partial class PoolEvaluateAutoScaleParameter { @@ -32,7 +32,7 @@ public PoolEvaluateAutoScaleParameter() /// class. /// /// The formula for the desired number - /// of compute nodes in the pool. + /// of Compute Nodes in the Pool. public PoolEvaluateAutoScaleParameter(string autoScaleFormula) { AutoScaleFormula = autoScaleFormula; @@ -45,15 +45,15 @@ public PoolEvaluateAutoScaleParameter(string autoScaleFormula) partial void CustomInit(); /// - /// Gets or sets the formula for the desired number of compute nodes in - /// the pool. + /// Gets or sets the formula for the desired number of Compute Nodes in + /// the Pool. /// /// /// The formula is validated and its results calculated, but it is not - /// applied to the pool. To apply the formula to the pool, 'Enable - /// automatic scaling on a pool'. For more information about specifying - /// this formula, see Automatically scale compute nodes in an Azure - /// Batch pool + /// applied to the Pool. To apply the formula to the Pool, 'Enable + /// automatic scaling on a Pool'. For more information about specifying + /// this formula, see Automatically scale Compute Nodes in an Azure + /// Batch Pool /// (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling). /// [JsonProperty(PropertyName = "autoScaleFormula")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolExistsHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolExistsHeaders.cs index 4cbee1006a1c..cad9ae00d7d2 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolExistsHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolExistsHeaders.cs @@ -39,8 +39,8 @@ public PoolExistsHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -76,8 +76,8 @@ public PoolExistsHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolGetAllLifetimeStatisticsHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolGetAllLifetimeStatisticsHeaders.cs index 7e8fb8a1c1ff..53719114b5fb 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolGetAllLifetimeStatisticsHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolGetAllLifetimeStatisticsHeaders.cs @@ -41,8 +41,8 @@ public PoolGetAllLifetimeStatisticsHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -78,8 +78,8 @@ public PoolGetAllLifetimeStatisticsHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolGetHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolGetHeaders.cs index 0a18ff96db44..6186a89bf8e4 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolGetHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolGetHeaders.cs @@ -39,8 +39,8 @@ public PoolGetHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -76,8 +76,8 @@ public PoolGetHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolInformation.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolInformation.cs index dcb733356a45..743d497b3df6 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolInformation.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolInformation.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Specifies how a job should be assigned to a pool. + /// Specifies how a Job should be assigned to a Pool. /// public partial class PoolInformation { @@ -29,11 +29,11 @@ public PoolInformation() /// /// Initializes a new instance of the PoolInformation class. /// - /// The ID of an existing pool. All the tasks of - /// the job will run on the specified pool. + /// The ID of an existing Pool. All the Tasks of + /// the Job will run on the specified Pool. /// Characteristics for a temporary - /// 'auto pool'. The Batch service will create this auto pool when the - /// job is submitted. + /// 'auto pool'. The Batch service will create this auto Pool when the + /// Job is submitted. public PoolInformation(string poolId = default(string), AutoPoolSpecification autoPoolSpecification = default(AutoPoolSpecification)) { PoolId = poolId; @@ -47,16 +47,16 @@ public PoolInformation() partial void CustomInit(); /// - /// Gets or sets the ID of an existing pool. All the tasks of the job - /// will run on the specified pool. + /// Gets or sets the ID of an existing Pool. All the Tasks of the Job + /// will run on the specified Pool. /// /// - /// You must ensure that the pool referenced by this property exists. - /// If the pool does not exist at the time the Batch service tries to - /// schedule a job, no tasks for the job will run until you create a - /// pool with that id. Note that the Batch service will not reject the - /// job request; it will simply not run tasks until the pool exists. - /// You must specify either the pool ID or the auto pool specification, + /// You must ensure that the Pool referenced by this property exists. + /// If the Pool does not exist at the time the Batch service tries to + /// schedule a Job, no Tasks for the Job will run until you create a + /// Pool with that id. Note that the Batch service will not reject the + /// Job request; it will simply not run Tasks until the Pool exists. + /// You must specify either the Pool ID or the auto Pool specification, /// but not both. /// [JsonProperty(PropertyName = "poolId")] @@ -64,16 +64,16 @@ public PoolInformation() /// /// Gets or sets characteristics for a temporary 'auto pool'. The Batch - /// service will create this auto pool when the job is submitted. + /// service will create this auto Pool when the Job is submitted. /// /// - /// If auto pool creation fails, the Batch service moves the job to a - /// completed state, and the pool creation error is set in the job's + /// If auto Pool creation fails, the Batch service moves the Job to a + /// completed state, and the Pool creation error is set in the Job's /// scheduling error property. The Batch service manages the lifetime /// (both creation and, unless keepAlive is specified, deletion) of the - /// auto pool. Any user actions that affect the lifetime of the auto - /// pool while the job is active will result in unexpected behavior. - /// You must specify either the pool ID or the auto pool specification, + /// auto Pool. Any user actions that affect the lifetime of the auto + /// Pool while the Job is active will result in unexpected behavior. + /// You must specify either the Pool ID or the auto Pool specification, /// but not both. /// [JsonProperty(PropertyName = "autoPoolSpecification")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolLifetimeOption.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolLifetimeOption.cs index 66eebc860f95..1870037c23f4 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolLifetimeOption.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolLifetimeOption.cs @@ -22,18 +22,18 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum PoolLifetimeOption { /// - /// The pool exists for the lifetime of the job schedule. The Batch - /// Service creates the pool when it creates the first job on the - /// schedule. You may apply this option only to job schedules, not to - /// jobs. + /// The Pool exists for the lifetime of the Job Schedule. The Batch + /// Service creates the Pool when it creates the first Job on the + /// schedule. You may apply this option only to Job Schedules, not to + /// Jobs. /// [EnumMember(Value = "jobschedule")] JobSchedule, /// - /// The pool exists for the lifetime of the job to which it is - /// dedicated. The Batch service creates the pool when it creates the - /// job. If the 'job' option is applied to a job schedule, the Batch - /// service creates a new auto pool for every job created on the + /// The Pool exists for the lifetime of the Job to which it is + /// dedicated. The Batch service creates the Pool when it creates the + /// Job. If the 'job' option is applied to a Job Schedule, the Batch + /// service creates a new auto Pool for every Job created on the /// schedule. /// [EnumMember(Value = "job")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolListHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolListHeaders.cs index 0ef97693a392..3cc5daf9dfe9 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolListHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolListHeaders.cs @@ -39,8 +39,8 @@ public PoolListHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -76,8 +76,8 @@ public PoolListHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolListOptions.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolListOptions.cs index 61a27d4ce342..c2494f09c1f5 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolListOptions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolListOptions.cs @@ -37,7 +37,7 @@ public PoolListOptions() /// An OData $select clause. /// An OData $expand clause. /// The maximum number of items to return in - /// the response. A maximum of 1000 pools can be returned. + /// the response. A maximum of 1000 Pools can be returned. /// The maximum time that the server can spend /// processing the request, in seconds. The default is 30 /// seconds. @@ -89,7 +89,7 @@ public PoolListOptions() /// /// Gets or sets the maximum number of items to return in the response. - /// A maximum of 1000 pools can be returned. + /// A maximum of 1000 Pools can be returned. /// [Newtonsoft.Json.JsonIgnore] public int? MaxResults { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolListUsageMetricsHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolListUsageMetricsHeaders.cs index 5d22f55e2981..42a8a280990b 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolListUsageMetricsHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolListUsageMetricsHeaders.cs @@ -41,8 +41,8 @@ public PoolListUsageMetricsHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -78,8 +78,8 @@ public PoolListUsageMetricsHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolNodeCounts.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolNodeCounts.cs index 5387f45f2dcc..d29b1bc0f7f9 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolNodeCounts.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolNodeCounts.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The number of nodes in each state for a pool. + /// The number of Compute Nodes in each state for a Pool. /// public partial class PoolNodeCounts { @@ -29,11 +29,11 @@ public PoolNodeCounts() /// /// Initializes a new instance of the PoolNodeCounts class. /// - /// The ID of the pool. - /// The number of dedicated nodes in each - /// state. - /// The number of low priority nodes in each - /// state. + /// The ID of the Pool. + /// The number of dedicated Compute Nodes in + /// each state. + /// The number of low priority Compute Nodes + /// in each state. public PoolNodeCounts(string poolId, NodeCounts dedicated = default(NodeCounts), NodeCounts lowPriority = default(NodeCounts)) { PoolId = poolId; @@ -48,19 +48,20 @@ public PoolNodeCounts() partial void CustomInit(); /// - /// Gets or sets the ID of the pool. + /// Gets or sets the ID of the Pool. /// [JsonProperty(PropertyName = "poolId")] public string PoolId { get; set; } /// - /// Gets or sets the number of dedicated nodes in each state. + /// Gets or sets the number of dedicated Compute Nodes in each state. /// [JsonProperty(PropertyName = "dedicated")] public NodeCounts Dedicated { get; set; } /// - /// Gets or sets the number of low priority nodes in each state. + /// Gets or sets the number of low priority Compute Nodes in each + /// state. /// [JsonProperty(PropertyName = "lowPriority")] public NodeCounts LowPriority { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolPatchHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolPatchHeaders.cs index 80e98477329f..82668178a278 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolPatchHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolPatchHeaders.cs @@ -39,8 +39,8 @@ public PoolPatchHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public PoolPatchHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolPatchParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolPatchParameter.cs index 42d2b4653be6..a21efd81c47d 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolPatchParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolPatchParameter.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The set of changes to be made to a pool. + /// The set of changes to be made to a Pool. /// public partial class PoolPatchParameter { @@ -31,15 +31,15 @@ public PoolPatchParameter() /// /// Initializes a new instance of the PoolPatchParameter class. /// - /// A task to run on each compute node as it - /// joins the pool. The task runs when the node is added to the pool or - /// when the node is restarted. - /// A list of certificates to be - /// installed on each compute node in the pool. - /// A list of application - /// packages to be installed on each compute node in the pool. + /// A Task to run on each Compute Node as it + /// joins the Pool. The Task runs when the Compute Node is added to the + /// Pool or when the Compute Node is restarted. + /// A list of Certificates to be + /// installed on each Compute Node in the Pool. + /// A list of Packages to be + /// installed on each Compute Node in the Pool. /// A list of name-value pairs associated with - /// the pool as metadata. + /// the Pool as metadata. public PoolPatchParameter(StartTask startTask = default(StartTask), IList certificateReferences = default(IList), IList applicationPackageReferences = default(IList), IList metadata = default(IList)) { StartTask = startTask; @@ -55,62 +55,60 @@ public PoolPatchParameter() partial void CustomInit(); /// - /// Gets or sets a task to run on each compute node as it joins the - /// pool. The task runs when the node is added to the pool or when the - /// node is restarted. + /// Gets or sets a Task to run on each Compute Node as it joins the + /// Pool. The Task runs when the Compute Node is added to the Pool or + /// when the Compute Node is restarted. /// /// - /// If this element is present, it overwrites any existing start task. - /// If omitted, any existing start task is left unchanged. + /// If this element is present, it overwrites any existing StartTask. + /// If omitted, any existing StartTask is left unchanged. /// [JsonProperty(PropertyName = "startTask")] public StartTask StartTask { get; set; } /// - /// Gets or sets a list of certificates to be installed on each compute - /// node in the pool. + /// Gets or sets a list of Certificates to be installed on each Compute + /// Node in the Pool. /// /// - /// If this element is present, it replaces any existing certificate - /// references configured on the pool. If omitted, any existing - /// certificate references are left unchanged. For Windows compute - /// nodes, the Batch service installs the certificates to the specified - /// certificate store and location. For Linux compute nodes, the - /// certificates are stored in a directory inside the task working + /// If this element is present, it replaces any existing Certificate + /// references configured on the Pool. If omitted, any existing + /// Certificate references are left unchanged. For Windows Nodes, the + /// Batch service installs the Certificates to the specified + /// Certificate store and location. For Linux Compute Nodes, the + /// Certificates are stored in a directory inside the Task working /// directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is - /// supplied to the task to query for this location. For certificates + /// supplied to the Task to query for this location. For Certificates /// with visibility of 'remoteUser', a 'certs' directory is created in /// the user's home directory (e.g., /home/{user-name}/certs) and - /// certificates are placed in that directory. + /// Certificates are placed in that directory. /// [JsonProperty(PropertyName = "certificateReferences")] public IList CertificateReferences { get; set; } /// - /// Gets or sets a list of application packages to be installed on each - /// compute node in the pool. + /// Gets or sets a list of Packages to be installed on each Compute + /// Node in the Pool. /// /// - /// Changes to application package references affect all new compute - /// nodes joining the pool, but do not affect compute nodes that are - /// already in the pool until they are rebooted or reimaged. If this - /// element is present, it replaces any existing application package - /// references. If you specify an empty collection, then all - /// application package references are removed from the pool. If - /// omitted, any existing application package references are left - /// unchanged. + /// Changes to Package references affect all new Nodes joining the + /// Pool, but do not affect Compute Nodes that are already in the Pool + /// until they are rebooted or reimaged. If this element is present, it + /// replaces any existing Package references. If you specify an empty + /// collection, then all Package references are removed from the Pool. + /// If omitted, any existing Package references are left unchanged. /// [JsonProperty(PropertyName = "applicationPackageReferences")] public IList ApplicationPackageReferences { get; set; } /// - /// Gets or sets a list of name-value pairs associated with the pool as + /// Gets or sets a list of name-value pairs associated with the Pool as /// metadata. /// /// /// If this element is present, it replaces any existing metadata - /// configured on the pool. If you specify an empty collection, any - /// metadata is removed from the pool. If omitted, any existing + /// configured on the Pool. If you specify an empty collection, any + /// metadata is removed from the Pool. If omitted, any existing /// metadata is left unchanged. /// [JsonProperty(PropertyName = "metadata")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolRemoveNodesHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolRemoveNodesHeaders.cs index 65351a590b21..df2dce4fb647 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolRemoveNodesHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolRemoveNodesHeaders.cs @@ -39,8 +39,8 @@ public PoolRemoveNodesHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public PoolRemoveNodesHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolResizeHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolResizeHeaders.cs index 1faaf5cb8ac6..6a74163c5f8d 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolResizeHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolResizeHeaders.cs @@ -39,8 +39,8 @@ public PoolResizeHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public PoolResizeHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolResizeParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolResizeParameter.cs index 5ba26488c183..0ad802b8a90e 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolResizeParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolResizeParameter.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Options for changing the size of a pool. + /// Options for changing the size of a Pool. /// public partial class PoolResizeParameter { @@ -30,14 +30,13 @@ public PoolResizeParameter() /// Initializes a new instance of the PoolResizeParameter class. /// /// The desired number of dedicated - /// compute nodes in the pool. + /// Compute Nodes in the Pool. /// The desired number of - /// low-priority compute nodes in the pool. - /// The timeout for allocation of compute - /// nodes to the pool or removal of compute nodes from the - /// pool. + /// low-priority Compute Nodes in the Pool. + /// The timeout for allocation of Nodes to + /// the Pool or removal of Compute Nodes from the Pool. /// Determines what to do with a - /// node and its running task(s) if the pool size is + /// Compute Node and its running task(s) if the Pool size is /// decreasing. public PoolResizeParameter(int? targetDedicatedNodes = default(int?), int? targetLowPriorityNodes = default(int?), System.TimeSpan? resizeTimeout = default(System.TimeSpan?), ComputeNodeDeallocationOption? nodeDeallocationOption = default(ComputeNodeDeallocationOption?)) { @@ -54,22 +53,22 @@ public PoolResizeParameter() partial void CustomInit(); /// - /// Gets or sets the desired number of dedicated compute nodes in the - /// pool. + /// Gets or sets the desired number of dedicated Compute Nodes in the + /// Pool. /// [JsonProperty(PropertyName = "targetDedicatedNodes")] public int? TargetDedicatedNodes { get; set; } /// - /// Gets or sets the desired number of low-priority compute nodes in - /// the pool. + /// Gets or sets the desired number of low-priority Compute Nodes in + /// the Pool. /// [JsonProperty(PropertyName = "targetLowPriorityNodes")] public int? TargetLowPriorityNodes { get; set; } /// - /// Gets or sets the timeout for allocation of compute nodes to the - /// pool or removal of compute nodes from the pool. + /// Gets or sets the timeout for allocation of Nodes to the Pool or + /// removal of Compute Nodes from the Pool. /// /// /// The default value is 15 minutes. The minimum value is 5 minutes. If @@ -81,8 +80,8 @@ public PoolResizeParameter() public System.TimeSpan? ResizeTimeout { get; set; } /// - /// Gets or sets determines what to do with a node and its running - /// task(s) if the pool size is decreasing. + /// Gets or sets determines what to do with a Compute Node and its + /// running task(s) if the Pool size is decreasing. /// /// /// The default value is requeue. Possible values include: 'requeue', diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolSpecification.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolSpecification.cs index 10c2e1b92417..da021eb90220 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolSpecification.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolSpecification.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Specification for creating a new pool. + /// Specification for creating a new Pool. /// public partial class PoolSpecification { @@ -31,49 +31,51 @@ public PoolSpecification() /// /// Initializes a new instance of the PoolSpecification class. /// - /// The size of the virtual machines in the pool. - /// All virtual machines in a pool are the same size. - /// The display name for the pool. + /// The size of the virtual machines in the Pool. + /// All virtual machines in a Pool are the same size. + /// The display name for the Pool. /// The cloud service - /// configuration for the pool. + /// configuration for the Pool. /// The virtual machine - /// configuration for the pool. - /// The maximum number of tasks that can - /// run concurrently on a single compute node in the pool. - /// How tasks are distributed across - /// compute nodes in a pool. - /// The timeout for allocation of compute - /// nodes to the pool. + /// configuration for the Pool. + /// The maximum number of Tasks that can + /// run concurrently on a single Compute Node in the Pool. + /// How Tasks are distributed across + /// Compute Nodes in a Pool. + /// The timeout for allocation of Compute + /// Nodes to the Pool. /// The desired number of dedicated - /// compute nodes in the pool. + /// Compute Nodes in the Pool. /// The desired number of - /// low-priority compute nodes in the pool. - /// Whether the pool size should + /// low-priority Compute Nodes in the Pool. + /// Whether the Pool size should /// automatically adjust over time. /// The formula for the desired number - /// of compute nodes in the pool. + /// of Compute Nodes in the Pool. /// The time interval at - /// which to automatically adjust the pool size according to the + /// which to automatically adjust the Pool size according to the /// autoscale formula. - /// Whether the pool permits - /// direct communication between nodes. + /// Whether the Pool permits + /// direct communication between Compute Nodes. /// The network configuration for - /// the pool. - /// A task to run on each compute node as it - /// joins the pool. The task runs when the node is added to the pool or - /// when the node is restarted. - /// A list of certificates to be - /// installed on each compute node in the pool. - /// The list of application - /// packages to be installed on each compute node in the pool. + /// the Pool. + /// A Task to run on each Compute Node as it + /// joins the Pool. The Task runs when the Compute Node is added to the + /// Pool or when the Compute Node is restarted. + /// A list of Certificates to be + /// installed on each Compute Node in the Pool. + /// The list of Packages to + /// be installed on each Compute Node in the Pool. /// The list of application licenses - /// the Batch service will make available on each compute node in the - /// pool. - /// The list of user accounts to be created - /// on each node in the pool. + /// the Batch service will make available on each Compute Node in the + /// Pool. + /// The list of user Accounts to be created + /// on each Compute Node in the Pool. /// A list of name-value pairs associated with - /// the pool as metadata. - public PoolSpecification(string vmSize, string displayName = default(string), CloudServiceConfiguration cloudServiceConfiguration = default(CloudServiceConfiguration), VirtualMachineConfiguration virtualMachineConfiguration = default(VirtualMachineConfiguration), int? maxTasksPerNode = default(int?), TaskSchedulingPolicy taskSchedulingPolicy = default(TaskSchedulingPolicy), System.TimeSpan? resizeTimeout = default(System.TimeSpan?), int? targetDedicatedNodes = default(int?), int? targetLowPriorityNodes = default(int?), bool? enableAutoScale = default(bool?), string autoScaleFormula = default(string), System.TimeSpan? autoScaleEvaluationInterval = default(System.TimeSpan?), bool? enableInterNodeCommunication = default(bool?), NetworkConfiguration networkConfiguration = default(NetworkConfiguration), StartTask startTask = default(StartTask), IList certificateReferences = default(IList), IList applicationPackageReferences = default(IList), IList applicationLicenses = default(IList), IList userAccounts = default(IList), IList metadata = default(IList)) + /// the Pool as metadata. + /// A list of file systems to mount on + /// each node in the pool. + public PoolSpecification(string vmSize, string displayName = default(string), CloudServiceConfiguration cloudServiceConfiguration = default(CloudServiceConfiguration), VirtualMachineConfiguration virtualMachineConfiguration = default(VirtualMachineConfiguration), int? maxTasksPerNode = default(int?), TaskSchedulingPolicy taskSchedulingPolicy = default(TaskSchedulingPolicy), System.TimeSpan? resizeTimeout = default(System.TimeSpan?), int? targetDedicatedNodes = default(int?), int? targetLowPriorityNodes = default(int?), bool? enableAutoScale = default(bool?), string autoScaleFormula = default(string), System.TimeSpan? autoScaleEvaluationInterval = default(System.TimeSpan?), bool? enableInterNodeCommunication = default(bool?), NetworkConfiguration networkConfiguration = default(NetworkConfiguration), StartTask startTask = default(StartTask), IList certificateReferences = default(IList), IList applicationPackageReferences = default(IList), IList applicationLicenses = default(IList), IList userAccounts = default(IList), IList metadata = default(IList), IList mountConfiguration = default(IList)) { DisplayName = displayName; VmSize = vmSize; @@ -95,6 +97,7 @@ public PoolSpecification() ApplicationLicenses = applicationLicenses; UserAccounts = userAccounts; Metadata = metadata; + MountConfiguration = mountConfiguration; CustomInit(); } @@ -104,7 +107,7 @@ public PoolSpecification() partial void CustomInit(); /// - /// Gets or sets the display name for the pool. + /// Gets or sets the display name for the Pool. /// /// /// The display name need not be unique and can contain any Unicode @@ -114,38 +117,38 @@ public PoolSpecification() public string DisplayName { get; set; } /// - /// Gets or sets the size of the virtual machines in the pool. All - /// virtual machines in a pool are the same size. + /// Gets or sets the size of the virtual machines in the Pool. All + /// virtual machines in a Pool are the same size. /// /// - /// For information about available sizes of virtual machines in pools, - /// see Choose a VM size for compute nodes in an Azure Batch pool + /// For information about available sizes of virtual machines in Pools, + /// see Choose a VM size for Compute Nodes in an Azure Batch Pool /// (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). /// [JsonProperty(PropertyName = "vmSize")] public string VmSize { get; set; } /// - /// Gets or sets the cloud service configuration for the pool. + /// Gets or sets the cloud service configuration for the Pool. /// /// - /// This property must be specified if the pool needs to be created + /// This property must be specified if the Pool needs to be created /// with Azure PaaS VMs. This property and virtualMachineConfiguration /// are mutually exclusive and one of the properties must be specified. /// If neither is specified then the Batch service returns an error; if /// you are calling the REST API directly, the HTTP status code is 400 /// (Bad Request). This property cannot be specified if the Batch - /// account was created with its poolAllocationMode property set to + /// Account was created with its poolAllocationMode property set to /// 'UserSubscription'. /// [JsonProperty(PropertyName = "cloudServiceConfiguration")] public CloudServiceConfiguration CloudServiceConfiguration { get; set; } /// - /// Gets or sets the virtual machine configuration for the pool. + /// Gets or sets the virtual machine configuration for the Pool. /// /// - /// This property must be specified if the pool needs to be created + /// This property must be specified if the Pool needs to be created /// with Azure IaaS VMs. This property and cloudServiceConfiguration /// are mutually exclusive and one of the properties must be specified. /// If neither is specified then the Batch service returns an error; if @@ -156,26 +159,29 @@ public PoolSpecification() public VirtualMachineConfiguration VirtualMachineConfiguration { get; set; } /// - /// Gets or sets the maximum number of tasks that can run concurrently - /// on a single compute node in the pool. + /// Gets or sets the maximum number of Tasks that can run concurrently + /// on a single Compute Node in the Pool. /// /// /// The default value is 1. The maximum value is the smaller of 4 times - /// the number of cores of the vmSize of the pool or 256. + /// the number of cores of the vmSize of the Pool or 256. /// [JsonProperty(PropertyName = "maxTasksPerNode")] public int? MaxTasksPerNode { get; set; } /// - /// Gets or sets how tasks are distributed across compute nodes in a - /// pool. + /// Gets or sets how Tasks are distributed across Compute Nodes in a + /// Pool. /// + /// + /// If not specified, the default is spread. + /// [JsonProperty(PropertyName = "taskSchedulingPolicy")] public TaskSchedulingPolicy TaskSchedulingPolicy { get; set; } /// - /// Gets or sets the timeout for allocation of compute nodes to the - /// pool. + /// Gets or sets the timeout for allocation of Compute Nodes to the + /// Pool. /// /// /// This timeout applies only to manual scaling; it has no effect when @@ -189,8 +195,8 @@ public PoolSpecification() public System.TimeSpan? ResizeTimeout { get; set; } /// - /// Gets or sets the desired number of dedicated compute nodes in the - /// pool. + /// Gets or sets the desired number of dedicated Compute Nodes in the + /// Pool. /// /// /// This property must not be specified if enableAutoScale is set to @@ -201,8 +207,8 @@ public PoolSpecification() public int? TargetDedicatedNodes { get; set; } /// - /// Gets or sets the desired number of low-priority compute nodes in - /// the pool. + /// Gets or sets the desired number of low-priority Compute Nodes in + /// the Pool. /// /// /// This property must not be specified if enableAutoScale is set to @@ -213,26 +219,26 @@ public PoolSpecification() public int? TargetLowPriorityNodes { get; set; } /// - /// Gets or sets whether the pool size should automatically adjust over + /// Gets or sets whether the Pool size should automatically adjust over /// time. /// /// /// If false, at least one of targetDedicateNodes and /// targetLowPriorityNodes must be specified. If true, the - /// autoScaleFormula element is required. The pool automatically + /// autoScaleFormula element is required. The Pool automatically /// resizes according to the formula. The default value is false. /// [JsonProperty(PropertyName = "enableAutoScale")] public bool? EnableAutoScale { get; set; } /// - /// Gets or sets the formula for the desired number of compute nodes in - /// the pool. + /// Gets or sets the formula for the desired number of Compute Nodes in + /// the Pool. /// /// /// This property must not be specified if enableAutoScale is set to /// false. It is required if enableAutoScale is set to true. The - /// formula is checked for validity before the pool is created. If the + /// formula is checked for validity before the Pool is created. If the /// formula is not valid, the Batch service rejects the request with /// detailed error information. /// @@ -241,7 +247,7 @@ public PoolSpecification() /// /// Gets or sets the time interval at which to automatically adjust the - /// pool size according to the autoscale formula. + /// Pool size according to the autoscale formula. /// /// /// The default value is 15 minutes. The minimum and maximum value are @@ -255,87 +261,87 @@ public PoolSpecification() public System.TimeSpan? AutoScaleEvaluationInterval { get; set; } /// - /// Gets or sets whether the pool permits direct communication between - /// nodes. + /// Gets or sets whether the Pool permits direct communication between + /// Compute Nodes. /// /// /// Enabling inter-node communication limits the maximum size of the - /// pool due to deployment restrictions on the nodes of the pool. This - /// may result in the pool not reaching its desired size. The default - /// value is false. + /// Pool due to deployment restrictions on the Compute Nodes of the + /// Pool. This may result in the Pool not reaching its desired size. + /// The default value is false. /// [JsonProperty(PropertyName = "enableInterNodeCommunication")] public bool? EnableInterNodeCommunication { get; set; } /// - /// Gets or sets the network configuration for the pool. + /// Gets or sets the network configuration for the Pool. /// [JsonProperty(PropertyName = "networkConfiguration")] public NetworkConfiguration NetworkConfiguration { get; set; } /// - /// Gets or sets a task to run on each compute node as it joins the - /// pool. The task runs when the node is added to the pool or when the - /// node is restarted. + /// Gets or sets a Task to run on each Compute Node as it joins the + /// Pool. The Task runs when the Compute Node is added to the Pool or + /// when the Compute Node is restarted. /// [JsonProperty(PropertyName = "startTask")] public StartTask StartTask { get; set; } /// - /// Gets or sets a list of certificates to be installed on each compute - /// node in the pool. + /// Gets or sets a list of Certificates to be installed on each Compute + /// Node in the Pool. /// /// - /// For Windows compute nodes, the Batch service installs the - /// certificates to the specified certificate store and location. For - /// Linux compute nodes, the certificates are stored in a directory - /// inside the task working directory and an environment variable - /// AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this - /// location. For certificates with visibility of 'remoteUser', a + /// For Windows Nodes, the Batch service installs the Certificates to + /// the specified Certificate store and location. For Linux Compute + /// Nodes, the Certificates are stored in a directory inside the Task + /// working directory and an environment variable + /// AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this + /// location. For Certificates with visibility of 'remoteUser', a /// 'certs' directory is created in the user's home directory (e.g., - /// /home/{user-name}/certs) and certificates are placed in that + /// /home/{user-name}/certs) and Certificates are placed in that /// directory. /// [JsonProperty(PropertyName = "certificateReferences")] public IList CertificateReferences { get; set; } /// - /// Gets or sets the list of application packages to be installed on - /// each compute node in the pool. + /// Gets or sets the list of Packages to be installed on each Compute + /// Node in the Pool. /// /// - /// Changes to application package references affect all new compute - /// nodes joining the pool, but do not affect compute nodes that are - /// already in the pool until they are rebooted or reimaged. There is a - /// maximum of 10 application package references on any given pool. + /// Changes to Package references affect all new Nodes joining the + /// Pool, but do not affect Compute Nodes that are already in the Pool + /// until they are rebooted or reimaged. There is a maximum of 10 + /// Package references on any given Pool. /// [JsonProperty(PropertyName = "applicationPackageReferences")] public IList ApplicationPackageReferences { get; set; } /// /// Gets or sets the list of application licenses the Batch service - /// will make available on each compute node in the pool. + /// will make available on each Compute Node in the Pool. /// /// /// The list of application licenses must be a subset of available /// Batch service application licenses. If a license is requested which - /// is not supported, pool creation will fail. The permitted licenses - /// available on the pool are 'maya', 'vray', '3dsmax', 'arnold'. An + /// is not supported, Pool creation will fail. The permitted licenses + /// available on the Pool are 'maya', 'vray', '3dsmax', 'arnold'. An /// additional charge applies for each application license added to the - /// pool. + /// Pool. /// [JsonProperty(PropertyName = "applicationLicenses")] public IList ApplicationLicenses { get; set; } /// - /// Gets or sets the list of user accounts to be created on each node - /// in the pool. + /// Gets or sets the list of user Accounts to be created on each + /// Compute Node in the Pool. /// [JsonProperty(PropertyName = "userAccounts")] public IList UserAccounts { get; set; } /// - /// Gets or sets a list of name-value pairs associated with the pool as + /// Gets or sets a list of name-value pairs associated with the Pool as /// metadata. /// /// @@ -345,5 +351,15 @@ public PoolSpecification() [JsonProperty(PropertyName = "metadata")] public IList Metadata { get; set; } + /// + /// Gets or sets a list of file systems to mount on each node in the + /// pool. + /// + /// + /// This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. + /// + [JsonProperty(PropertyName = "mountConfiguration")] + public IList MountConfiguration { get; set; } + } } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolState.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolState.cs index e90e09836acb..646dddbd135f 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolState.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolState.cs @@ -22,13 +22,13 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum PoolState { /// - /// The pool is available to run tasks subject to the availability of - /// compute nodes. + /// The Pool is available to run Tasks subject to the availability of + /// Compute Nodes. /// [EnumMember(Value = "active")] Active, /// - /// The user has requested that the pool be deleted, but the delete + /// The user has requested that the Pool be deleted, but the delete /// operation has not yet completed. /// [EnumMember(Value = "deleting")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolStatistics.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolStatistics.cs index 83e28dfeb2cf..037b14d4cdba 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolStatistics.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolStatistics.cs @@ -15,7 +15,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models /// /// Contains utilization and resource usage statistics for the lifetime of - /// a pool. + /// a Pool. /// public partial class PoolStatistics { @@ -36,10 +36,10 @@ public PoolStatistics() /// The time at which the statistics were /// last updated. All statistics are limited to the range between /// startTime and lastUpdateTime. - /// Statistics related to pool usage, such as + /// Statistics related to Pool usage, such as /// the amount of core-time used. /// Statistics related to resource - /// consumption by compute nodes in the pool. + /// consumption by Compute Nodes in the Pool. public PoolStatistics(string url, System.DateTime startTime, System.DateTime lastUpdateTime, UsageStatistics usageStats = default(UsageStatistics), ResourceStatistics resourceStats = default(ResourceStatistics)) { Url = url; @@ -77,15 +77,15 @@ public PoolStatistics() public System.DateTime LastUpdateTime { get; set; } /// - /// Gets or sets statistics related to pool usage, such as the amount + /// Gets or sets statistics related to Pool usage, such as the amount /// of core-time used. /// [JsonProperty(PropertyName = "usageStats")] public UsageStatistics UsageStats { get; set; } /// - /// Gets or sets statistics related to resource consumption by compute - /// nodes in the pool. + /// Gets or sets statistics related to resource consumption by Compute + /// Nodes in the Pool. /// [JsonProperty(PropertyName = "resourceStats")] public ResourceStatistics ResourceStats { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolStopResizeHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolStopResizeHeaders.cs index c83338997057..30d0f05f1747 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolStopResizeHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolStopResizeHeaders.cs @@ -39,8 +39,8 @@ public PoolStopResizeHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public PoolStopResizeHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolUpdatePropertiesHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolUpdatePropertiesHeaders.cs index 1c1e3aec5c02..a329ee856652 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolUpdatePropertiesHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolUpdatePropertiesHeaders.cs @@ -41,8 +41,8 @@ public PoolUpdatePropertiesHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -81,8 +81,8 @@ public PoolUpdatePropertiesHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolUpdatePropertiesParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolUpdatePropertiesParameter.cs index 68cd1b3802e7..547e5c3506ed 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolUpdatePropertiesParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolUpdatePropertiesParameter.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The set of changes to be made to a pool. + /// The set of changes to be made to a Pool. /// public partial class PoolUpdatePropertiesParameter { @@ -33,15 +33,15 @@ public PoolUpdatePropertiesParameter() /// Initializes a new instance of the PoolUpdatePropertiesParameter /// class. /// - /// A list of certificates to be - /// installed on each compute node in the pool. - /// The list of application - /// packages to be installed on each compute node in the pool. + /// A list of Certificates to be + /// installed on each Compute Node in the Pool. + /// The list of Application + /// Packages to be installed on each Compute Node in the Pool. /// A list of name-value pairs associated with - /// the pool as metadata. - /// A task to run on each compute node as it - /// joins the pool. The task runs when the node is added to the pool or - /// when the node is restarted. + /// the Pool as metadata. + /// A Task to run on each Compute Node as it + /// joins the Pool. The Task runs when the Compute Node is added to the + /// Pool or when the Compute Node is restarted. public PoolUpdatePropertiesParameter(IList certificateReferences, IList applicationPackageReferences, IList metadata, StartTask startTask = default(StartTask)) { StartTask = startTask; @@ -57,62 +57,62 @@ public PoolUpdatePropertiesParameter() partial void CustomInit(); /// - /// Gets or sets a task to run on each compute node as it joins the - /// pool. The task runs when the node is added to the pool or when the - /// node is restarted. + /// Gets or sets a Task to run on each Compute Node as it joins the + /// Pool. The Task runs when the Compute Node is added to the Pool or + /// when the Compute Node is restarted. /// /// - /// If this element is present, it overwrites any existing start task. - /// If omitted, any existing start task is removed from the pool. + /// If this element is present, it overwrites any existing StartTask. + /// If omitted, any existing StartTask is removed from the Pool. /// [JsonProperty(PropertyName = "startTask")] public StartTask StartTask { get; set; } /// - /// Gets or sets a list of certificates to be installed on each compute - /// node in the pool. + /// Gets or sets a list of Certificates to be installed on each Compute + /// Node in the Pool. /// /// - /// This list replaces any existing certificate references configured - /// on the pool. If you specify an empty collection, any existing - /// certificate references are removed from the pool. For Windows - /// compute nodes, the Batch service installs the certificates to the - /// specified certificate store and location. For Linux compute nodes, - /// the certificates are stored in a directory inside the task working + /// This list replaces any existing Certificate references configured + /// on the Pool. If you specify an empty collection, any existing + /// Certificate references are removed from the Pool. For Windows + /// Nodes, the Batch service installs the Certificates to the specified + /// Certificate store and location. For Linux Compute Nodes, the + /// Certificates are stored in a directory inside the Task working /// directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is - /// supplied to the task to query for this location. For certificates + /// supplied to the Task to query for this location. For Certificates /// with visibility of 'remoteUser', a 'certs' directory is created in /// the user's home directory (e.g., /home/{user-name}/certs) and - /// certificates are placed in that directory. + /// Certificates are placed in that directory. /// [JsonProperty(PropertyName = "certificateReferences")] public IList CertificateReferences { get; set; } /// - /// Gets or sets the list of application packages to be installed on - /// each compute node in the pool. + /// Gets or sets the list of Application Packages to be installed on + /// each Compute Node in the Pool. /// /// - /// The list replaces any existing application package references on - /// the pool. Changes to application package references affect all new - /// compute nodes joining the pool, but do not affect compute nodes - /// that are already in the pool until they are rebooted or reimaged. - /// There is a maximum of 10 application package references on any - /// given pool. If omitted, or if you specify an empty collection, any - /// existing application packages references are removed from the pool. - /// A maximum of 10 references may be specified on a given pool. + /// The list replaces any existing Application Package references on + /// the Pool. Changes to Application Package references affect all new + /// Compute Nodes joining the Pool, but do not affect Compute Nodes + /// that are already in the Pool until they are rebooted or reimaged. + /// There is a maximum of 10 Application Package references on any + /// given Pool. If omitted, or if you specify an empty collection, any + /// existing Application Packages references are removed from the Pool. + /// A maximum of 10 references may be specified on a given Pool. /// [JsonProperty(PropertyName = "applicationPackageReferences")] public IList ApplicationPackageReferences { get; set; } /// - /// Gets or sets a list of name-value pairs associated with the pool as + /// Gets or sets a list of name-value pairs associated with the Pool as /// metadata. /// /// - /// This list replaces any existing metadata configured on the pool. If + /// This list replaces any existing metadata configured on the Pool. If /// omitted, or if you specify an empty collection, any existing - /// metadata is removed from the pool. + /// metadata is removed from the Pool. /// [JsonProperty(PropertyName = "metadata")] public IList Metadata { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolUsageMetrics.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolUsageMetrics.cs index 9587cc603df2..f4c7529d122f 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolUsageMetrics.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/PoolUsageMetrics.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Usage metrics for a pool across an aggregation interval. + /// Usage metrics for a Pool across an aggregation interval. /// public partial class PoolUsageMetrics { @@ -29,15 +29,15 @@ public PoolUsageMetrics() /// /// Initializes a new instance of the PoolUsageMetrics class. /// - /// The ID of the pool whose metrics are + /// The ID of the Pool whose metrics are /// aggregated in this entry. /// The start time of the aggregation interval /// covered by this entry. /// The end time of the aggregation interval /// covered by this entry. - /// The size of virtual machines in the pool. All - /// VMs in a pool are the same size. - /// The total core hours used in the pool + /// The size of virtual machines in the Pool. All + /// VMs in a Pool are the same size. + /// The total core hours used in the Pool /// during this aggregation interval. public PoolUsageMetrics(string poolId, System.DateTime startTime, System.DateTime endTime, string vmSize, double totalCoreHours) { @@ -55,7 +55,7 @@ public PoolUsageMetrics(string poolId, System.DateTime startTime, System.DateTim partial void CustomInit(); /// - /// Gets or sets the ID of the pool whose metrics are aggregated in + /// Gets or sets the ID of the Pool whose metrics are aggregated in /// this entry. /// [JsonProperty(PropertyName = "poolId")] @@ -76,19 +76,19 @@ public PoolUsageMetrics(string poolId, System.DateTime startTime, System.DateTim public System.DateTime EndTime { get; set; } /// - /// Gets or sets the size of virtual machines in the pool. All VMs in a - /// pool are the same size. + /// Gets or sets the size of virtual machines in the Pool. All VMs in a + /// Pool are the same size. /// /// - /// For information about available sizes of virtual machines in pools, - /// see Choose a VM size for compute nodes in an Azure Batch pool + /// For information about available sizes of virtual machines in Pools, + /// see Choose a VM size for Compute Nodes in an Azure Batch Pool /// (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). /// [JsonProperty(PropertyName = "vmSize")] public string VmSize { get; set; } /// - /// Gets or sets the total core hours used in the pool during this + /// Gets or sets the total core hours used in the Pool during this /// aggregation interval. /// [JsonProperty(PropertyName = "totalCoreHours")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/RecentJob.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/RecentJob.cs index 150f5b8ab6db..7e8510dc7a2f 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/RecentJob.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/RecentJob.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Information about the most recent job to run under the job schedule. + /// Information about the most recent Job to run under the Job Schedule. /// public partial class RecentJob { @@ -29,8 +29,8 @@ public RecentJob() /// /// Initializes a new instance of the RecentJob class. /// - /// The ID of the job. - /// The URL of the job. + /// The ID of the Job. + /// The URL of the Job. public RecentJob(string id = default(string), string url = default(string)) { Id = id; @@ -44,13 +44,13 @@ public RecentJob() partial void CustomInit(); /// - /// Gets or sets the ID of the job. + /// Gets or sets the ID of the Job. /// [JsonProperty(PropertyName = "id")] public string Id { get; set; } /// - /// Gets or sets the URL of the job. + /// Gets or sets the URL of the Job. /// [JsonProperty(PropertyName = "url")] public string Url { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ResizeError.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ResizeError.cs index 4522826e0a81..3f1c7f21b9df 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ResizeError.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ResizeError.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// An error that occurred when resizing a pool. + /// An error that occurred when resizing a Pool. /// public partial class ResizeError { @@ -31,13 +31,13 @@ public ResizeError() /// /// Initializes a new instance of the ResizeError class. /// - /// An identifier for the pool resize error. Codes + /// An identifier for the Pool resize error. Codes /// are invariant and are intended to be consumed /// programmatically. - /// A message describing the pool resize error, + /// A message describing the Pool resize error, /// intended to be suitable for display in a user interface. /// A list of additional error details related to - /// the pool resize error. + /// the Pool resize error. public ResizeError(string code = default(string), string message = default(string), IList values = default(IList)) { Code = code; @@ -52,21 +52,21 @@ public ResizeError() partial void CustomInit(); /// - /// Gets or sets an identifier for the pool resize error. Codes are + /// Gets or sets an identifier for the Pool resize error. Codes are /// invariant and are intended to be consumed programmatically. /// [JsonProperty(PropertyName = "code")] public string Code { get; set; } /// - /// Gets or sets a message describing the pool resize error, intended + /// Gets or sets a message describing the Pool resize error, intended /// to be suitable for display in a user interface. /// [JsonProperty(PropertyName = "message")] public string Message { get; set; } /// - /// Gets or sets a list of additional error details related to the pool + /// Gets or sets a list of additional error details related to the Pool /// resize error. /// [JsonProperty(PropertyName = "values")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ResourceFile.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ResourceFile.cs index 69abdb735657..de8357125632 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ResourceFile.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ResourceFile.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// A single file or multiple files to be downloaded to a compute node. + /// A single file or multiple files to be downloaded to a Compute Node. /// public partial class ResourceFile { @@ -30,15 +30,15 @@ public ResourceFile() /// Initializes a new instance of the ResourceFile class. /// /// The storage container name - /// in the auto storage account. + /// in the auto storage Account. /// The URL of the blob container /// within Azure Blob Storage. /// The URL of the file to download. /// The blob prefix to use when downloading /// blobs from an Azure Storage container. Only the blobs whose names /// begin with the specified prefix will be downloaded. - /// The location on the compute node to which to - /// download the file(s), relative to the task's working + /// The location on the Compute Node to which to + /// download the file(s), relative to the Task's working /// directory. /// The file permission mode attribute in octal /// format. @@ -60,7 +60,7 @@ public ResourceFile() /// /// Gets or sets the storage container name in the auto storage - /// account. + /// Account. /// /// /// The autoStorageContainerName, storageContainerUrl and httpUrl @@ -119,8 +119,8 @@ public ResourceFile() public string BlobPrefix { get; set; } /// - /// Gets or sets the location on the compute node to which to download - /// the file(s), relative to the task's working directory. + /// Gets or sets the location on the Compute Node to which to download + /// the file(s), relative to the Task's working directory. /// /// /// If the httpUrl property is specified, the filePath is required and @@ -131,7 +131,7 @@ public ResourceFile() /// filePath is used as a directory, any directory structure already /// associated with the input data will be retained in full and /// appended to the specified filePath directory. The specified - /// relative path cannot break out of the task's working directory (for + /// relative path cannot break out of the Task's working directory (for /// example by using '..'). /// [JsonProperty(PropertyName = "filePath")] @@ -142,10 +142,10 @@ public ResourceFile() /// /// /// This property applies only to files being downloaded to Linux - /// compute nodes. It will be ignored if it is specified for a - /// resourceFile which will be downloaded to a Windows node. If this - /// property is not specified for a Linux node, then a default value of - /// 0770 is applied to the file. + /// Compute Nodes. It will be ignored if it is specified for a + /// resourceFile which will be downloaded to a Windows Compute Node. If + /// this property is not specified for a Linux Compute Node, then a + /// default value of 0770 is applied to the file. /// [JsonProperty(PropertyName = "fileMode")] public string FileMode { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ResourceStatistics.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ResourceStatistics.cs index 707558561157..50ceedd26826 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ResourceStatistics.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/ResourceStatistics.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Statistics related to resource consumption by compute nodes in a pool. + /// Statistics related to resource consumption by Compute Nodes in a Pool. /// public partial class ResourceStatistics { @@ -35,27 +35,27 @@ public ResourceStatistics() /// last updated. All statistics are limited to the range between /// startTime and lastUpdateTime. /// The average CPU usage across all - /// nodes in the pool (percentage per node). + /// Compute Nodes in the Pool (percentage per node). /// The average memory usage in GiB across - /// all nodes in the pool. + /// all Compute Nodes in the Pool. /// The peak memory usage in GiB across all - /// nodes in the pool. + /// Compute Nodes in the Pool. /// The average used disk space in GiB across - /// all nodes in the pool. + /// all Compute Nodes in the Pool. /// The peak used disk space in GiB across - /// all nodes in the pool. + /// all Compute Nodes in the Pool. /// The total number of disk read operations - /// across all nodes in the pool. + /// across all Compute Nodes in the Pool. /// The total number of disk write - /// operations across all nodes in the pool. + /// operations across all Compute Nodes in the Pool. /// The total amount of data in GiB of disk - /// reads across all nodes in the pool. + /// reads across all Compute Nodes in the Pool. /// The total amount of data in GiB of disk - /// writes across all nodes in the pool. + /// writes across all Compute Nodes in the Pool. /// The total amount of data in GiB of - /// network reads across all nodes in the pool. + /// network reads across all Compute Nodes in the Pool. /// The total amount of data in GiB of - /// network writes across all nodes in the pool. + /// network writes across all Compute Nodes in the Pool. public ResourceStatistics(System.DateTime startTime, System.DateTime lastUpdateTime, double avgCPUPercentage, double avgMemoryGiB, double peakMemoryGiB, double avgDiskGiB, double peakDiskGiB, long diskReadIOps, long diskWriteIOps, double diskReadGiB, double diskWriteGiB, double networkReadGiB, double networkWriteGiB) { StartTime = startTime; @@ -95,78 +95,78 @@ public ResourceStatistics(System.DateTime startTime, System.DateTime lastUpdateT public System.DateTime LastUpdateTime { get; set; } /// - /// Gets or sets the average CPU usage across all nodes in the pool - /// (percentage per node). + /// Gets or sets the average CPU usage across all Compute Nodes in the + /// Pool (percentage per node). /// [JsonProperty(PropertyName = "avgCPUPercentage")] public double AvgCPUPercentage { get; set; } /// - /// Gets or sets the average memory usage in GiB across all nodes in - /// the pool. + /// Gets or sets the average memory usage in GiB across all Compute + /// Nodes in the Pool. /// [JsonProperty(PropertyName = "avgMemoryGiB")] public double AvgMemoryGiB { get; set; } /// - /// Gets or sets the peak memory usage in GiB across all nodes in the - /// pool. + /// Gets or sets the peak memory usage in GiB across all Compute Nodes + /// in the Pool. /// [JsonProperty(PropertyName = "peakMemoryGiB")] public double PeakMemoryGiB { get; set; } /// - /// Gets or sets the average used disk space in GiB across all nodes in - /// the pool. + /// Gets or sets the average used disk space in GiB across all Compute + /// Nodes in the Pool. /// [JsonProperty(PropertyName = "avgDiskGiB")] public double AvgDiskGiB { get; set; } /// - /// Gets or sets the peak used disk space in GiB across all nodes in - /// the pool. + /// Gets or sets the peak used disk space in GiB across all Compute + /// Nodes in the Pool. /// [JsonProperty(PropertyName = "peakDiskGiB")] public double PeakDiskGiB { get; set; } /// /// Gets or sets the total number of disk read operations across all - /// nodes in the pool. + /// Compute Nodes in the Pool. /// [JsonProperty(PropertyName = "diskReadIOps")] public long DiskReadIOps { get; set; } /// /// Gets or sets the total number of disk write operations across all - /// nodes in the pool. + /// Compute Nodes in the Pool. /// [JsonProperty(PropertyName = "diskWriteIOps")] public long DiskWriteIOps { get; set; } /// /// Gets or sets the total amount of data in GiB of disk reads across - /// all nodes in the pool. + /// all Compute Nodes in the Pool. /// [JsonProperty(PropertyName = "diskReadGiB")] public double DiskReadGiB { get; set; } /// /// Gets or sets the total amount of data in GiB of disk writes across - /// all nodes in the pool. + /// all Compute Nodes in the Pool. /// [JsonProperty(PropertyName = "diskWriteGiB")] public double DiskWriteGiB { get; set; } /// /// Gets or sets the total amount of data in GiB of network reads - /// across all nodes in the pool. + /// across all Compute Nodes in the Pool. /// [JsonProperty(PropertyName = "networkReadGiB")] public double NetworkReadGiB { get; set; } /// /// Gets or sets the total amount of data in GiB of network writes - /// across all nodes in the pool. + /// across all Compute Nodes in the Pool. /// [JsonProperty(PropertyName = "networkWriteGiB")] public double NetworkWriteGiB { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/Schedule.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/Schedule.cs index ab7b4fca3346..afec677f64d8 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/Schedule.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/Schedule.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The schedule according to which jobs will be created + /// The schedule according to which Jobs will be created /// public partial class Schedule { @@ -29,18 +29,18 @@ public Schedule() /// /// Initializes a new instance of the Schedule class. /// - /// The earliest time at which any job may - /// be created under this job schedule. - /// A time after which no job will be - /// created under this job schedule. The schedule will move to the + /// The earliest time at which any Job may + /// be created under this Job Schedule. + /// A time after which no Job will be + /// created under this Job Schedule. The schedule will move to the /// completed state as soon as this deadline is past and there is no - /// active job under this job schedule. + /// active Job under this Job Schedule. /// The time interval, starting from the time - /// at which the schedule indicates a job should be created, within - /// which a job must be created. + /// at which the schedule indicates a Job should be created, within + /// which a Job must be created. /// The time interval between the - /// start times of two successive jobs under the job schedule. A job - /// schedule can have at most one active job under it at any given + /// start times of two successive Jobs under the Job Schedule. A Job + /// Schedule can have at most one active Job under it at any given /// time. public Schedule(System.DateTime? doNotRunUntil = default(System.DateTime?), System.DateTime? doNotRunAfter = default(System.DateTime?), System.TimeSpan? startWindow = default(System.TimeSpan?), System.TimeSpan? recurrenceInterval = default(System.TimeSpan?)) { @@ -57,25 +57,25 @@ public Schedule() partial void CustomInit(); /// - /// Gets or sets the earliest time at which any job may be created - /// under this job schedule. + /// Gets or sets the earliest time at which any Job may be created + /// under this Job Schedule. /// /// /// If you do not specify a doNotRunUntil time, the schedule becomes - /// ready to create jobs immediately. + /// ready to create Jobs immediately. /// [JsonProperty(PropertyName = "doNotRunUntil")] public System.DateTime? DoNotRunUntil { get; set; } /// - /// Gets or sets a time after which no job will be created under this - /// job schedule. The schedule will move to the completed state as soon - /// as this deadline is past and there is no active job under this job - /// schedule. + /// Gets or sets a time after which no Job will be created under this + /// Job Schedule. The schedule will move to the completed state as soon + /// as this deadline is past and there is no active Job under this Job + /// Schedule. /// /// /// If you do not specify a doNotRunAfter time, and you are creating a - /// recurring job schedule, the job schedule will remain active until + /// recurring Job Schedule, the Job Schedule will remain active until /// you explicitly terminate it. /// [JsonProperty(PropertyName = "doNotRunAfter")] @@ -83,15 +83,15 @@ public Schedule() /// /// Gets or sets the time interval, starting from the time at which the - /// schedule indicates a job should be created, within which a job must + /// schedule indicates a Job should be created, within which a Job must /// be created. /// /// - /// If a job is not created within the startWindow interval, then the - /// 'opportunity' is lost; no job will be created until the next + /// If a Job is not created within the startWindow interval, then the + /// 'opportunity' is lost; no Job will be created until the next /// recurrence of the schedule. If the schedule is recurring, and the /// startWindow is longer than the recurrence interval, then this is - /// equivalent to an infinite startWindow, because the job that is + /// equivalent to an infinite startWindow, because the Job that is /// 'due' in one recurrenceInterval is not carried forward into the /// next recurrence interval. The default is infinite. The minimum /// value is 1 minute. If you specify a lower value, the Batch service @@ -103,24 +103,24 @@ public Schedule() /// /// Gets or sets the time interval between the start times of two - /// successive jobs under the job schedule. A job schedule can have at - /// most one active job under it at any given time. + /// successive Jobs under the Job Schedule. A Job Schedule can have at + /// most one active Job under it at any given time. /// /// - /// Because a job schedule can have at most one active job under it at - /// any given time, if it is time to create a new job under a job - /// schedule, but the previous job is still running, the Batch service - /// will not create the new job until the previous job finishes. If the - /// previous job does not finish within the startWindow period of the - /// new recurrenceInterval, then no new job will be scheduled for that - /// interval. For recurring jobs, you should normally specify a + /// Because a Job Schedule can have at most one active Job under it at + /// any given time, if it is time to create a new Job under a Job + /// Schedule, but the previous Job is still running, the Batch service + /// will not create the new Job until the previous Job finishes. If the + /// previous Job does not finish within the startWindow period of the + /// new recurrenceInterval, then no new Job will be scheduled for that + /// interval. For recurring Jobs, you should normally specify a /// jobManagerTask in the jobSpecification. If you do not use /// jobManagerTask, you will need an external process to monitor when - /// jobs are created, add tasks to the jobs and terminate the jobs + /// Jobs are created, add Tasks to the Jobs and terminate the Jobs /// ready for the next recurrence. The default is that the schedule - /// does not recur: one job is created, within the startWindow after + /// does not recur: one Job is created, within the startWindow after /// the doNotRunUntil time, and the schedule is complete as soon as - /// that job finishes. The minimum value is 1 minute. If you specify a + /// that Job finishes. The minimum value is 1 minute. If you specify a /// lower value, the Batch service rejects the schedule with an error; /// if you are calling the REST API directly, the HTTP status code is /// 400 (Bad Request). diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/SchedulingState.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/SchedulingState.cs index f05ca9d4b22f..c355b260ce62 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/SchedulingState.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/SchedulingState.cs @@ -22,14 +22,14 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum SchedulingState { /// - /// Tasks can be scheduled on the node. + /// Tasks can be scheduled on the Compute Node. /// [EnumMember(Value = "enabled")] Enabled, /// - /// No new tasks will be scheduled on the node. Tasks already running - /// on the node may still run to completion. All nodes start with - /// scheduling enabled. + /// No new Tasks will be scheduled on the Compute Node. Tasks already + /// running on the Compute Node may still run to completion. All + /// Compute Nodes start with scheduling enabled. /// [EnumMember(Value = "disabled")] Disabled diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/StartTask.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/StartTask.cs index 1bb4b29ba5cc..bb9f8fcfcac5 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/StartTask.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/StartTask.cs @@ -16,25 +16,24 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// 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. + /// A Task which is run when a 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. In some cases the start task may be re-run even though - /// the node was not rebooted. Special care should be taken to avoid start - /// tasks which create breakaway process or install/launch services from - /// the start task working directory, as this will block Batch from being - /// able to re-run the start task. + /// Batch will retry Tasks when a recovery operation is triggered on a + /// Node. Examples of recovery operations include (but are not limited to) + /// when an unhealthy 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. In some cases the StartTask + /// may be re-run even though the Compute Node was not rebooted. Special + /// care should be taken to avoid StartTasks which create breakaway process + /// or install/launch services from the StartTask working directory, as + /// this will block Batch from being able to re-run the StartTask. /// public partial class StartTask { @@ -49,12 +48,12 @@ public StartTask() /// /// Initializes a new instance of the StartTask class. /// - /// The command line of the start - /// task. + /// The command line of the + /// StartTask. /// The settings for the container - /// under which the start task runs. + /// under which the StartTask runs. /// A list of files that the Batch service - /// will download to the compute node before running the command line. + /// will download to the Compute Node before running the command line. /// There is a maximum size for the list of resource files. When the /// max size is exceeded, the request will fail and the response error /// code will be RequestEntityTooLarge. If this occurs, the collection @@ -62,15 +61,15 @@ public StartTask() /// using .zip files, Application Packages, or Docker /// Containers. /// A list of environment variable - /// settings for the start task. - /// The user identity under which the start - /// task runs. + /// settings for the StartTask. + /// The user identity under which the + /// StartTask runs. /// The maximum number of times the - /// task may be retried. + /// Task may be retried. /// Whether the Batch service should wait - /// for the start task to complete successfully (that is, to exit with - /// exit code 0) before scheduling any tasks on the compute - /// node. + /// for the StartTask to complete successfully (that is, to exit with + /// exit code 0) before scheduling any Tasks on the Compute + /// Node. public StartTask(string commandLine, TaskContainerSettings containerSettings = default(TaskContainerSettings), IList resourceFiles = default(IList), IList environmentSettings = default(IList), UserIdentity userIdentity = default(UserIdentity), int? maxTaskRetryCount = default(int?), bool? waitForSuccess = default(bool?)) { CommandLine = commandLine; @@ -89,7 +88,7 @@ public StartTask() partial void CustomInit(); /// - /// Gets or sets the command line of the start task. + /// Gets or sets the command line of the StartTask. /// /// /// The command line does not run under a shell, and therefore cannot @@ -98,7 +97,7 @@ public StartTask() /// 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 + /// (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). /// @@ -106,14 +105,14 @@ public StartTask() public string CommandLine { get; set; } /// - /// Gets or sets the settings for the container under which the start - /// task runs. + /// Gets or sets the settings for the container under which the + /// StartTask runs. /// /// /// 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 + /// 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. Files produced in the container outside /// of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, /// meaning that Batch file APIs will not be able to access those @@ -124,7 +123,7 @@ public StartTask() /// /// Gets or sets a list of files that the Batch service will download - /// to the compute node before running the command line. There is a + /// to the Compute Node before running the command line. There is a /// maximum size for the list of resource files. When the max size is /// exceeded, the request will fail and the response error code will be /// RequestEntityTooLarge. If this occurs, the collection of @@ -132,62 +131,62 @@ public StartTask() /// .zip files, Application Packages, or Docker Containers. /// /// - /// Files listed under this element are located in the task's working + /// Files listed under this element are located in the Task's working /// directory. /// [JsonProperty(PropertyName = "resourceFiles")] public IList ResourceFiles { get; set; } /// - /// Gets or sets a list of environment variable settings for the start - /// task. + /// Gets or sets a list of environment variable settings for the + /// StartTask. /// [JsonProperty(PropertyName = "environmentSettings")] public IList EnvironmentSettings { get; set; } /// - /// Gets or sets the user identity under which the start task runs. + /// Gets or sets the user identity under which the StartTask runs. /// /// - /// If omitted, the task runs as a non-administrative user unique to - /// the task. + /// If omitted, the Task runs as a non-administrative user unique to + /// the Task. /// [JsonProperty(PropertyName = "userIdentity")] public UserIdentity UserIdentity { get; set; } /// - /// Gets or sets the maximum number of times the task may be retried. + /// Gets or sets the maximum number of times the Task may be retried. /// /// - /// The Batch service retries a task if its exit code is nonzero. Note + /// 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 + /// 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 + /// 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. + /// Task. If the maximum retry count is -1, the Batch service retries + /// the Task without limit. /// [JsonProperty(PropertyName = "maxTaskRetryCount")] public int? MaxTaskRetryCount { get; set; } /// - /// Gets or sets whether the Batch service should wait for the start - /// task to complete successfully (that is, to exit with exit code 0) - /// before scheduling any tasks on the compute node. + /// Gets or sets whether the Batch service should wait for the + /// StartTask to complete successfully (that is, to exit with exit code + /// 0) before scheduling any Tasks on the Compute Node. /// /// - /// If true and the start task fails on a compute node, the Batch - /// service retries the start task up to its maximum retry count - /// (maxTaskRetryCount). If the task has still not completed + /// If true and the StartTask fails on a Node, the Batch service + /// retries the StartTask up to its maximum retry count + /// (maxTaskRetryCount). If the Task has still not completed /// successfully after all retries, then the Batch service marks the - /// compute node unusable, and will not schedule tasks to it. This - /// condition can be detected via the node state and failure info - /// details. If false, the Batch service will not wait for the start - /// task to complete. In this case, other tasks can start executing on - /// the compute node while the start task is still running; and even if - /// the start task fails, new tasks will continue to be scheduled on - /// the node. The default is false. + /// Node unusable, and will not schedule Tasks to it. This condition + /// can be detected via the Compute Node state and failure info + /// details. If false, the Batch service will not wait for the + /// StartTask to complete. In this case, other Tasks can start + /// executing on the Compute Node while the StartTask is still running; + /// and even if the StartTask fails, new Tasks will continue to be + /// scheduled on the Compute Node. The default is true. /// [JsonProperty(PropertyName = "waitForSuccess")] public bool? WaitForSuccess { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/StartTaskInformation.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/StartTaskInformation.cs index b5ac3caf7901..60724bd808cf 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/StartTaskInformation.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/StartTaskInformation.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Information about a start task running on a compute node. + /// Information about a StartTask running on a Compute Node. /// public partial class StartTaskInformation { @@ -29,23 +29,23 @@ public StartTaskInformation() /// /// Initializes a new instance of the StartTaskInformation class. /// - /// The state of the start task on the compute - /// node. - /// The time at which the start task started + /// The state of the StartTask on the Compute + /// Node. + /// The time at which the StartTask started /// running. - /// The number of times the task has been + /// The number of times the Task has been /// retried by the Batch service. - /// The time at which the start task stopped + /// The time at which the StartTask stopped /// running. /// The exit code of the program specified on - /// the start task command line. + /// the StartTask command line. /// Information about the container under - /// which the task is executing. - /// Information describing the task failure, + /// which the Task is executing. + /// Information describing the Task failure, /// if any. /// The most recent time at which a retry - /// of the task started running. - /// The result of the task execution. + /// of the Task started running. + /// The result of the Task execution. public StartTaskInformation(StartTaskState state, System.DateTime startTime, int retryCount, System.DateTime? endTime = default(System.DateTime?), int? exitCode = default(int?), TaskContainerExecutionInformation containerInfo = default(TaskContainerExecutionInformation), TaskFailureInformation failureInfo = default(TaskFailureInformation), System.DateTime? lastRetryTime = default(System.DateTime?), TaskExecutionResult? result = default(TaskExecutionResult?)) { State = state; @@ -66,7 +66,7 @@ public StartTaskInformation() partial void CustomInit(); /// - /// Gets or sets the state of the start task on the compute node. + /// Gets or sets the state of the StartTask on the Compute Node. /// /// /// Possible values include: 'running', 'completed' @@ -75,87 +75,87 @@ public StartTaskInformation() public StartTaskState State { get; set; } /// - /// Gets or sets the time at which the start task started running. + /// Gets or sets the time at which the StartTask started running. /// /// - /// This value is reset every time the task is restarted or retried - /// (that is, this is the most recent time at which the start task + /// This value is reset every time the Task is restarted or retried + /// (that is, this is the most recent time at which the StartTask /// started running). /// [JsonProperty(PropertyName = "startTime")] public System.DateTime StartTime { get; set; } /// - /// Gets or sets the time at which the start task stopped running. + /// Gets or sets the time at which the StartTask stopped running. /// /// - /// This is the end time of the most recent run of the start task, if + /// This is the end time of the most recent run of the StartTask, if /// that run has completed (even if that run failed and a retry is - /// pending). This element is not present if the start task is - /// currently running. + /// pending). This element is not present if the StartTask is currently + /// running. /// [JsonProperty(PropertyName = "endTime")] public System.DateTime? EndTime { get; set; } /// - /// Gets or sets the exit code of the program specified on the start - /// task command line. + /// Gets or sets the exit code of the program specified on the + /// StartTask command line. /// /// - /// This property is set only if the start task is in the completed + /// This property is set only if the StartTask is in the completed /// state. In general, the exit code for a process reflects the /// specific convention implemented by the application developer for /// that process. If you use the exit code value to make decisions in /// your code, be sure that you know the exit code convention used by /// the application process. However, if the Batch service terminates - /// the start task (due to timeout, or user termination via the API) - /// you may see an operating system-defined exit code. + /// the StartTask (due to timeout, or user termination via the API) you + /// may see an operating system-defined exit code. /// [JsonProperty(PropertyName = "exitCode")] public int? ExitCode { get; set; } /// - /// Gets or sets information about the container under which the task + /// Gets or sets information about the container under which the Task /// is executing. /// /// - /// This property is set only if the task runs in a container context. + /// This property is set only if the Task runs in a container context. /// [JsonProperty(PropertyName = "containerInfo")] public TaskContainerExecutionInformation ContainerInfo { get; set; } /// - /// Gets or sets information describing the task failure, if any. + /// Gets or sets information describing the Task failure, if any. /// /// - /// This property is set only if the task is in the completed state and + /// This property is set only if the Task is in the completed state and /// encountered a failure. /// [JsonProperty(PropertyName = "failureInfo")] public TaskFailureInformation FailureInfo { get; set; } /// - /// Gets or sets the number of times the task has been retried by the + /// Gets or sets the number of times the Task has been retried by the /// Batch service. /// /// /// Task application failures (non-zero exit code) are retried, - /// pre-processing errors (the task could not be run) and file upload - /// errors are not retried. The Batch service will retry the task up to + /// pre-processing errors (the Task could not be run) and file upload + /// errors are not retried. The Batch service will retry the Task up to /// the limit specified by the constraints. /// [JsonProperty(PropertyName = "retryCount")] public int RetryCount { get; set; } /// - /// Gets or sets the most recent time at which a retry of the task + /// Gets or sets the most recent time at which a retry of the Task /// started running. /// /// - /// This element is present only if the task was retried (i.e. + /// This element is present only if the Task was retried (i.e. /// retryCount is nonzero). If present, this is typically the same as - /// startTime, but may be different if the task has been restarted for - /// reasons other than retry; for example, if the compute node was + /// startTime, but may be different if the Task has been restarted for + /// reasons other than retry; for example, if the Compute Node was /// rebooted during a retry, then the startTime is updated but the /// lastRetryTime is not. /// @@ -163,7 +163,7 @@ public StartTaskInformation() public System.DateTime? LastRetryTime { get; set; } /// - /// Gets or sets the result of the task execution. + /// Gets or sets the result of the Task execution. /// /// /// If the value is 'failed', then the details of the failure can be diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/StartTaskState.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/StartTaskState.cs index 192c15e0b224..973f6c3c0dd7 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/StartTaskState.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/StartTaskState.cs @@ -22,14 +22,14 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum StartTaskState { /// - /// The start task is currently running. + /// The StartTask is currently running. /// [EnumMember(Value = "running")] Running, /// - /// The start task has exited with exit code 0, or the start task has - /// failed and the retry limit has reached, or the start task process - /// did not run due to task preparation errors (such as resource file + /// The StartTask has exited with exit code 0, or the StartTask has + /// failed and the retry limit has reached, or the StartTask process + /// did not run due to Task preparation errors (such as resource file /// download failures). /// [EnumMember(Value = "completed")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/SubtaskInformation.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/SubtaskInformation.cs index e81c3ecd0b2e..c6a5a2e91014 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/SubtaskInformation.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/SubtaskInformation.cs @@ -30,7 +30,7 @@ public SubtaskInformation() /// Initializes a new instance of the SubtaskInformation class. /// /// The ID of the subtask. - /// Information about the compute node on which + /// Information about the Compute Node on which /// the subtask ran. /// The time at which the subtask started /// running. If the subtask has been restarted or retried, this is the @@ -40,8 +40,8 @@ public SubtaskInformation() /// The exit code of the program specified on /// the subtask command line. /// Information about the container under - /// which the task is executing. - /// Information describing the task failure, + /// which the Task is executing. + /// Information describing the Task failure, /// if any. /// The current state of the subtask. /// The time at which the subtask @@ -50,7 +50,7 @@ public SubtaskInformation() /// subtask. /// The time at which the /// subtask entered its previous state. - /// The result of the task execution. + /// The result of the Task execution. public SubtaskInformation(int? id = default(int?), ComputeNodeInformation nodeInfo = default(ComputeNodeInformation), System.DateTime? startTime = default(System.DateTime?), System.DateTime? endTime = default(System.DateTime?), int? exitCode = default(int?), TaskContainerExecutionInformation containerInfo = default(TaskContainerExecutionInformation), TaskFailureInformation failureInfo = default(TaskFailureInformation), SubtaskState? state = default(SubtaskState?), System.DateTime? stateTransitionTime = default(System.DateTime?), SubtaskState? previousState = default(SubtaskState?), System.DateTime? previousStateTransitionTime = default(System.DateTime?), TaskExecutionResult? result = default(TaskExecutionResult?)) { Id = id; @@ -80,7 +80,7 @@ public SubtaskInformation() public int? Id { get; set; } /// - /// Gets or sets information about the compute node on which the + /// Gets or sets information about the Compute Node on which the /// subtask ran. /// [JsonProperty(PropertyName = "nodeInfo")] @@ -121,20 +121,20 @@ public SubtaskInformation() public int? ExitCode { get; set; } /// - /// Gets or sets information about the container under which the task + /// Gets or sets information about the container under which the Task /// is executing. /// /// - /// This property is set only if the task runs in a container context. + /// This property is set only if the Task runs in a container context. /// [JsonProperty(PropertyName = "containerInfo")] public TaskContainerExecutionInformation ContainerInfo { get; set; } /// - /// Gets or sets information describing the task failure, if any. + /// Gets or sets information describing the Task failure, if any. /// /// - /// This property is set only if the task is in the completed state and + /// This property is set only if the Task is in the completed state and /// encountered a failure. /// [JsonProperty(PropertyName = "failureInfo")] @@ -178,7 +178,7 @@ public SubtaskInformation() public System.DateTime? PreviousStateTransitionTime { get; set; } /// - /// Gets or sets the result of the task execution. + /// Gets or sets the result of the Task execution. /// /// /// If the value is 'failed', then the details of the failure can be diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/SubtaskState.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/SubtaskState.cs index 20cdf546ca4a..63f2e58b199c 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/SubtaskState.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/SubtaskState.cs @@ -22,27 +22,27 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum SubtaskState { /// - /// The task has been assigned to a compute node, but is waiting for a - /// required Job Preparation task to complete on the node. If the Job - /// Preparation task succeeds, the task will move to running. If the - /// Job Preparation task fails, the task will return to active and will - /// be eligible to be assigned to a different node. + /// The Task has been assigned to a Compute Node, but is waiting for a + /// required Job Preparation Task to complete on the Compute Node. If + /// the Job Preparation Task succeeds, the Task will move to running. + /// If the Job Preparation Task fails, the Task will return to active + /// and will be eligible to be assigned to a different Compute Node. /// [EnumMember(Value = "preparing")] Preparing, /// - /// The task is running on a compute node. This includes task-level + /// The Task is running on a Compute Node. This includes task-level /// preparation such as downloading resource files or deploying - /// application packages specified on the task - it does not - /// necessarily mean that the task command line has started executing. + /// Packages specified on the Task - it does not necessarily mean that + /// the Task command line has started executing. /// [EnumMember(Value = "running")] Running, /// - /// The task is no longer eligible to run, usually because the task has - /// finished successfully, or the task has finished unsuccessfully and - /// has exhausted its retry limit. A task is also marked as completed - /// if an error occurred launching the task, or when the task has been + /// The Task is no longer eligible to run, usually because the Task has + /// finished successfully, or the Task has finished unsuccessfully and + /// has exhausted its retry limit. A Task is also marked as completed + /// if an error occurred launching the Task, or when the Task has been /// terminated. /// [EnumMember(Value = "completed")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddCollectionHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddCollectionHeaders.cs index c2a07a1bac3a..a673ac064504 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddCollectionHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddCollectionHeaders.cs @@ -37,8 +37,8 @@ public TaskAddCollectionHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. public TaskAddCollectionHeaders(string clientRequestId = default(string), string requestId = default(string)) { ClientRequestId = clientRequestId; @@ -65,8 +65,8 @@ public TaskAddCollectionHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public string RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddCollectionParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddCollectionParameter.cs index ade0fa2f61fe..6a97d39903f1 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddCollectionParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddCollectionParameter.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// A collection of Azure Batch tasks to add. + /// A collection of Azure Batch Tasks to add. /// public partial class TaskAddCollectionParameter { @@ -31,8 +31,8 @@ public TaskAddCollectionParameter() /// /// Initializes a new instance of the TaskAddCollectionParameter class. /// - /// The collection of tasks to add. The maximum - /// count of tasks is 100. + /// The collection of Tasks to add. The maximum + /// count of Tasks is 100. public TaskAddCollectionParameter(IList value) { Value = value; @@ -45,15 +45,15 @@ public TaskAddCollectionParameter(IList value) partial void CustomInit(); /// - /// Gets or sets the collection of tasks to add. The maximum count of - /// tasks is 100. + /// Gets or sets the collection of Tasks to add. The maximum count of + /// Tasks is 100. /// /// /// The total serialized size of this collection must be less than 1MB. - /// If it is greater than 1MB (for example if each task has 100's of + /// If it is greater than 1MB (for example if each Task has 100's of /// resource files or environment variables), the request will fail /// with code 'RequestBodyTooLarge' and should be retried again with - /// fewer tasks. + /// fewer Tasks. /// [JsonProperty(PropertyName = "value")] public IList Value { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddCollectionResult.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddCollectionResult.cs index 0ece252c8b9d..b386a27a973a 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddCollectionResult.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddCollectionResult.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The result of adding a collection of tasks to a job. + /// The result of adding a collection of Tasks to a Job. /// public partial class TaskAddCollectionResult { @@ -31,7 +31,7 @@ public TaskAddCollectionResult() /// /// Initializes a new instance of the TaskAddCollectionResult class. /// - /// The results of the add task collection + /// The results of the add Task collection /// operation. public TaskAddCollectionResult(IList value = default(IList)) { @@ -45,7 +45,7 @@ public TaskAddCollectionResult() partial void CustomInit(); /// - /// Gets or sets the results of the add task collection operation. + /// Gets or sets the results of the add Task collection operation. /// [JsonProperty(PropertyName = "value")] public IList Value { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddHeaders.cs index c68b242cc13b..255ba94ec012 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddHeaders.cs @@ -39,8 +39,8 @@ public TaskAddHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public TaskAddHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddParameter.cs index c8f53e48cdb8..77d985d7c7ef 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddParameter.cs @@ -16,20 +16,19 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// An Azure Batch task to add. + /// 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. + /// Batch will retry Tasks when a recovery operation is triggered on a + /// Node. Examples of recovery operations include (but are not limited to) + /// when an unhealthy 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 { @@ -44,39 +43,39 @@ public TaskAddParameter() /// /// Initializes a new instance of the TaskAddParameter class. /// - /// A string that uniquely identifies the task within - /// the job. - /// The command line of the task. - /// A display name for the task. + /// A string that uniquely identifies the Task within + /// the Job. + /// The command line of the Task. + /// A display name for the Task. /// The settings for the container - /// under which the task runs. + /// under which the Task runs. /// How the Batch service should respond - /// when the task completes. + /// when the Task completes. /// A list of files that the Batch service - /// will download to the compute node before running the command + /// will download to the Compute Node before running the command /// line. /// A list of files that the Batch service - /// will upload from the compute node after running the command + /// will upload from the Compute Node after running the command /// line. /// A list of environment variable - /// settings for the task. + /// settings for the Task. /// A locality hint that can be used by the - /// Batch service to select a compute node on which to start the new - /// task. + /// Batch service to select a Compute Node on which to start the new + /// Task. /// The execution constraints that apply to - /// this task. - /// The user identity under which the task + /// this Task. + /// The user identity under which the Task /// runs. /// An object that indicates that - /// the task is a multi-instance task, and contains information about - /// how to run the multi-instance task. - /// The tasks that this task depends + /// the Task is a multi-instance Task, and contains information about + /// how to run the multi-instance Task. + /// The Tasks that this Task depends /// on. - /// A list of application - /// packages that the Batch service will deploy to the compute node - /// before running the command line. + /// A list of Packages that + /// the Batch service will deploy to the Compute Node before running + /// the command line. /// The settings for an - /// authentication token that the task can use to perform Batch service + /// authentication token that the Task can use to perform Batch service /// operations. public TaskAddParameter(string id, string commandLine, string displayName = default(string), TaskContainerSettings containerSettings = default(TaskContainerSettings), ExitConditions exitConditions = default(ExitConditions), IList resourceFiles = default(IList), IList outputFiles = default(IList), IList environmentSettings = default(IList), AffinityInformation affinityInfo = default(AffinityInformation), TaskConstraints constraints = default(TaskConstraints), UserIdentity userIdentity = default(UserIdentity), MultiInstanceSettings multiInstanceSettings = default(MultiInstanceSettings), TaskDependencies dependsOn = default(TaskDependencies), IList applicationPackageReferences = default(IList), AuthenticationTokenSettings authenticationTokenSettings = default(AuthenticationTokenSettings)) { @@ -104,21 +103,21 @@ public TaskAddParameter() partial void CustomInit(); /// - /// Gets or sets a string that uniquely identifies the task within the - /// job. + /// Gets or sets a string that uniquely identifies the Task within the + /// Job. /// /// /// The ID can contain any combination of alphanumeric characters /// including hyphens and underscores, and cannot contain more than 64 /// characters. The ID is case-preserving and case-insensitive (that - /// is, you may not have two IDs within a job that differ only by + /// is, you may not have two IDs within a Job that differ only by /// case). /// [JsonProperty(PropertyName = "id")] public string Id { get; set; } /// - /// Gets or sets a display name for the task. + /// Gets or sets a display name for the Task. /// /// /// The display name need not be unique and can contain any Unicode @@ -128,18 +127,18 @@ public TaskAddParameter() public string DisplayName { get; set; } /// - /// Gets or sets the command line of the task. + /// Gets or sets the command line of the Task. /// /// - /// For multi-instance tasks, the command line is executed as the - /// primary task, after the primary task and all subtasks have finished + /// For multi-instance Tasks, the command line is executed as the + /// primary Task, after the primary Task and all subtasks have finished /// executing the coordination command line. 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 + /// 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). /// @@ -147,17 +146,17 @@ public TaskAddParameter() public string CommandLine { get; set; } /// - /// Gets or sets the settings for the container under which the task + /// Gets or sets the settings for the container under which the Task /// runs. /// /// - /// If the pool that will run this task has containerConfiguration set, - /// this must be set as well. If the pool that will run this task + /// If the Pool that will run this Task has containerConfiguration set, + /// this must be set as well. If the Pool that will run this Task /// doesn't have containerConfiguration 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 + /// 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. Files produced in the container outside /// of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, /// meaning that Batch file APIs will not be able to access those @@ -167,7 +166,7 @@ public TaskAddParameter() public TaskContainerSettings ContainerSettings { get; set; } /// - /// Gets or sets how the Batch service should respond when the task + /// Gets or sets how the Batch service should respond when the Task /// completes. /// [JsonProperty(PropertyName = "exitConditions")] @@ -175,11 +174,11 @@ public TaskAddParameter() /// /// Gets or sets a list of files that the Batch service will download - /// to the compute node before running the command line. + /// to the Compute Node before running the command line. /// /// - /// For multi-instance tasks, the resource files will only be - /// downloaded to the compute node on which the primary task is + /// For multi-instance Tasks, the resource files will only be + /// downloaded to the Compute Node on which the primary Task is /// executed. There is a maximum size for the list of resource files. /// When the max size is exceeded, the request will fail and the /// response error code will be RequestEntityTooLarge. If this occurs, @@ -192,64 +191,64 @@ public TaskAddParameter() /// /// Gets or sets a list of files that the Batch service will upload - /// from the compute node after running the command line. + /// from the Compute Node after running the command line. /// /// - /// For multi-instance tasks, the files will only be uploaded from the - /// compute node on which the primary task is executed. + /// For multi-instance Tasks, the files will only be uploaded from the + /// Compute Node on which the primary Task is executed. /// [JsonProperty(PropertyName = "outputFiles")] public IList OutputFiles { get; set; } /// - /// Gets or sets a list of environment variable settings for the task. + /// Gets or sets a list of environment variable settings for the Task. /// [JsonProperty(PropertyName = "environmentSettings")] public IList EnvironmentSettings { get; set; } /// /// Gets or sets a locality hint that can be used by the Batch service - /// to select a compute node on which to start the new task. + /// to select a Compute Node on which to start the new Task. /// [JsonProperty(PropertyName = "affinityInfo")] public AffinityInformation AffinityInfo { get; set; } /// - /// Gets or sets the execution constraints that apply to this task. + /// Gets or sets the execution constraints that apply to this Task. /// /// /// If you do not specify constraints, the maxTaskRetryCount is the - /// maxTaskRetryCount specified for the job, the maxWallClockTime is + /// maxTaskRetryCount specified for the Job, the maxWallClockTime is /// infinite, and the retentionTime is 7 days. /// [JsonProperty(PropertyName = "constraints")] public TaskConstraints Constraints { get; set; } /// - /// Gets or sets the user identity under which the task runs. + /// Gets or sets the user identity under which the Task runs. /// /// - /// If omitted, the task runs as a non-administrative user unique to - /// the task. + /// If omitted, the Task runs as a non-administrative user unique to + /// the Task. /// [JsonProperty(PropertyName = "userIdentity")] public UserIdentity UserIdentity { get; set; } /// - /// Gets or sets an object that indicates that the task is a - /// multi-instance task, and contains information about how to run the - /// multi-instance task. + /// Gets or sets an object that indicates that the Task is a + /// multi-instance Task, and contains information about how to run the + /// multi-instance Task. /// [JsonProperty(PropertyName = "multiInstanceSettings")] public MultiInstanceSettings MultiInstanceSettings { get; set; } /// - /// Gets or sets the tasks that this task depends on. + /// Gets or sets the Tasks that this Task depends on. /// /// - /// This task will not be scheduled until all tasks that it depends on - /// have completed successfully. If any of those tasks fail and exhaust - /// their retry counts, this task will never be scheduled. If the job + /// This Task will not be scheduled until all Tasks that it depends on + /// have completed successfully. If any of those Tasks fail and exhaust + /// their retry counts, this Task will never be scheduled. If the Job /// does not have usesTaskDependencies set to true, and this element is /// present, the request fails with error code /// TaskDependenciesNotSpecifiedOnJob. @@ -258,34 +257,34 @@ public TaskAddParameter() public TaskDependencies DependsOn { get; set; } /// - /// Gets or sets a list of application packages that the Batch service - /// will deploy to the compute node before running the command line. + /// Gets or sets a list of Packages that the Batch service will deploy + /// to the Compute Node before running the command line. /// /// /// Application packages are downloaded and deployed to a shared - /// directory, not the task working directory. Therefore, if a - /// referenced package is already on the compute node, and is up to - /// date, then it is not re-downloaded; the existing copy on the - /// compute node is used. If a referenced application package cannot be - /// installed, for example because the package has been deleted or - /// because download failed, the task fails. + /// directory, not the Task working directory. Therefore, if a + /// referenced package is already on the Node, and is up to date, then + /// it is not re-downloaded; the existing copy on the Compute Node is + /// used. If a referenced Package cannot be installed, for example + /// because the package has been deleted or because download failed, + /// the Task fails. /// [JsonProperty(PropertyName = "applicationPackageReferences")] public IList ApplicationPackageReferences { get; set; } /// - /// Gets or sets the settings for an authentication token that the task + /// Gets or sets the settings for an authentication token that the Task /// can use to perform Batch service operations. /// /// - /// If this property is set, the Batch service provides the task with + /// 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 + /// 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 under the job. + /// 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 under the Job. /// [JsonProperty(PropertyName = "authenticationTokenSettings")] public AuthenticationTokenSettings AuthenticationTokenSettings { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddResult.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddResult.cs index a035358179dc..e8446c09fc88 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddResult.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddResult.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Result for a single task added as part of an add task collection + /// Result for a single Task added as part of an add Task collection /// operation. /// public partial class TaskAddResult @@ -30,17 +30,17 @@ public TaskAddResult() /// /// Initializes a new instance of the TaskAddResult class. /// - /// The status of the add task request. - /// The ID of the task for which this is the + /// The status of the add Task request. + /// The ID of the Task for which this is the /// result. - /// The ETag of the task, if the task was + /// The ETag of the Task, if the Task was /// successfully added. /// The last modified time of the - /// task. - /// The URL of the task, if the task was + /// Task. + /// The URL of the Task, if the Task was /// successfully added. /// The error encountered while attempting to add - /// the task. + /// the Task. public TaskAddResult(TaskAddStatus status, string taskId, string eTag = default(string), System.DateTime? lastModified = default(System.DateTime?), string location = default(string), BatchError error = default(BatchError)) { Status = status; @@ -58,7 +58,7 @@ public TaskAddResult() partial void CustomInit(); /// - /// Gets or sets the status of the add task request. + /// Gets or sets the status of the add Task request. /// /// /// Possible values include: 'success', 'clientError', 'serverError' @@ -67,32 +67,32 @@ public TaskAddResult() public TaskAddStatus Status { get; set; } /// - /// Gets or sets the ID of the task for which this is the result. + /// Gets or sets the ID of the Task for which this is the result. /// [JsonProperty(PropertyName = "taskId")] public string TaskId { get; set; } /// - /// Gets or sets the ETag of the task, if the task was successfully + /// Gets or sets the ETag of the Task, if the Task was successfully /// added. /// /// - /// You can use this to detect whether the task has changed between + /// You can use this to detect whether the Task has changed between /// requests. In particular, you can be pass the ETag with an Update /// Task request to specify that your changes should take effect only - /// if nobody else has modified the job in the meantime. + /// if nobody else has modified the Job in the meantime. /// [JsonProperty(PropertyName = "eTag")] public string ETag { get; set; } /// - /// Gets or sets the last modified time of the task. + /// Gets or sets the last modified time of the Task. /// [JsonProperty(PropertyName = "lastModified")] public System.DateTime? LastModified { get; set; } /// - /// Gets or sets the URL of the task, if the task was successfully + /// Gets or sets the URL of the Task, if the Task was successfully /// added. /// [JsonProperty(PropertyName = "location")] @@ -100,7 +100,7 @@ public TaskAddResult() /// /// Gets or sets the error encountered while attempting to add the - /// task. + /// Task. /// [JsonProperty(PropertyName = "error")] public BatchError Error { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddStatus.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddStatus.cs index eaa8c79241f2..77afabe10bd7 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddStatus.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskAddStatus.cs @@ -22,12 +22,12 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum TaskAddStatus { /// - /// The task was added successfully. + /// The Task was added successfully. /// [EnumMember(Value = "success")] Success, /// - /// The task failed to add due to a client error and should not be + /// The Task failed to add due to a client error and should not be /// retried without modifying the request as appropriate. /// [EnumMember(Value = "clienterror")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskConstraints.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskConstraints.cs index 66293faa4c69..41bb5e8d4f3a 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskConstraints.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskConstraints.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Execution constraints to apply to a task. + /// Execution constraints to apply to a Task. /// public partial class TaskConstraints { @@ -30,15 +30,15 @@ public TaskConstraints() /// Initializes a new instance of the TaskConstraints class. /// /// The maximum elapsed time that the - /// task may run, measured from the time the task starts. If the task + /// Task may run, measured from the time the Task starts. If the Task /// does not complete within the time limit, the Batch service /// terminates it. - /// The minimum time to retain the task - /// directory on the compute node where it ran, from the time it + /// The minimum time to retain the Task + /// directory on the Compute Node where it ran, from the time it /// completes execution. After this time, the Batch service may delete - /// the task directory and all its contents. + /// the Task directory and all its contents. /// The maximum number of times the - /// task may be retried. The Batch service retries a task if its exit + /// Task may be retried. The Batch service retries a Task if its exit /// code is nonzero. public TaskConstraints(System.TimeSpan? maxWallClockTime = default(System.TimeSpan?), System.TimeSpan? retentionTime = default(System.TimeSpan?), int? maxTaskRetryCount = default(int?)) { @@ -54,43 +54,43 @@ public TaskConstraints() partial void CustomInit(); /// - /// Gets or sets the maximum elapsed time that the task may run, - /// measured from the time the task starts. If the task does not + /// Gets or sets the maximum elapsed time that the Task may run, + /// measured from the time the Task starts. If the Task does not /// complete within the time limit, the Batch service terminates it. /// /// /// If this is not specified, there is no time limit on how long the - /// task may run. + /// Task may run. /// [JsonProperty(PropertyName = "maxWallClockTime")] public System.TimeSpan? MaxWallClockTime { get; set; } /// - /// Gets or sets the minimum time to retain the task directory on the - /// compute node where it ran, from the time it completes execution. - /// After this time, the Batch service may delete the task directory + /// Gets or sets the minimum time to retain the Task directory on the + /// Compute Node where it ran, from the time it completes execution. + /// After this time, the Batch service may delete the Task directory /// and all its contents. /// /// - /// The default is 7 days, i.e. the task directory will be retained for - /// 7 days unless the compute node is removed or the job is deleted. + /// The default is 7 days, i.e. the Task directory will be retained for + /// 7 days unless the Compute Node is removed or the Job is deleted. /// [JsonProperty(PropertyName = "retentionTime")] public System.TimeSpan? RetentionTime { get; set; } /// - /// Gets or sets the maximum number of times the task may be retried. - /// The Batch service retries a task if its exit code is nonzero. + /// Gets or sets the maximum number of times the Task may be retried. + /// The Batch service retries a Task if its exit code is nonzero. /// /// /// 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 + /// 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 + /// 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. + /// Batch service retries the Task without limit. /// [JsonProperty(PropertyName = "maxTaskRetryCount")] public int? MaxTaskRetryCount { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskContainerExecutionInformation.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskContainerExecutionInformation.cs index 28ff602dab7e..8d5efb6eca53 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskContainerExecutionInformation.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskContainerExecutionInformation.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Contains information about the container which a task is executing. + /// Contains information about the container which a Task is executing. /// public partial class TaskContainerExecutionInformation { diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskContainerSettings.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskContainerSettings.cs index c6078ac9ab4e..cc8bb2b95f59 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskContainerSettings.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskContainerSettings.cs @@ -29,13 +29,13 @@ public TaskContainerSettings() /// /// Initializes a new instance of the TaskContainerSettings class. /// - /// The image to use to create the container in - /// which the task will run. + /// The Image to use to create the container in + /// which the Task will run. /// Additional options to the /// container create command. /// The private registry which contains the - /// container image. - /// The location of the container task + /// container Image. + /// The location of the container Task /// working directory. public TaskContainerSettings(string imageName, string containerRunOptions = default(string), ContainerRegistry registry = default(ContainerRegistry), ContainerWorkingDirectory? workingDirectory = default(ContainerWorkingDirectory?)) { @@ -63,12 +63,12 @@ public TaskContainerSettings() public string ContainerRunOptions { get; set; } /// - /// Gets or sets the image to use to create the container in which the - /// task will run. + /// Gets or sets the Image to use to create the container in which the + /// Task will run. /// /// - /// This is the full image reference, as would be specified to "docker - /// pull". If no tag is provided as part of the image name, the tag + /// This is the full Image reference, as would be specified to "docker + /// pull". If no tag is provided as part of the Image name, the tag /// ":latest" is used as a default. /// [JsonProperty(PropertyName = "imageName")] @@ -76,17 +76,17 @@ public TaskContainerSettings() /// /// Gets or sets the private registry which contains the container - /// image. + /// Image. /// /// - /// This setting can be omitted if was already provided at pool + /// This setting can be omitted if was already provided at Pool /// creation. /// [JsonProperty(PropertyName = "registry")] public ContainerRegistry Registry { get; set; } /// - /// Gets or sets the location of the container task working directory. + /// Gets or sets the location of the container Task working directory. /// /// /// The default is 'taskWorkingDirectory'. Possible values include: diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskCounts.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskCounts.cs index 38f04496c3a8..ac802dbbb156 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskCounts.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskCounts.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The task counts for a job. + /// The Task counts for a Job. /// public partial class TaskCounts { @@ -29,16 +29,16 @@ public TaskCounts() /// /// Initializes a new instance of the TaskCounts class. /// - /// The number of tasks in the active + /// The number of Tasks in the active /// state. - /// The number of tasks in the running or + /// The number of Tasks in the running or /// preparing state. - /// The number of tasks in the completed + /// The number of Tasks in the completed /// state. - /// The number of tasks which succeeded. A task + /// The number of Tasks which succeeded. A Task /// succeeds if its result (found in the executionInfo property) is /// 'success'. - /// The number of tasks which failed. A task fails + /// The number of Tasks which failed. A Task fails /// if its result (found in the executionInfo property) is /// 'failure'. public TaskCounts(int active, int running, int completed, int succeeded, int failed) @@ -57,32 +57,32 @@ public TaskCounts(int active, int running, int completed, int succeeded, int fai partial void CustomInit(); /// - /// Gets or sets the number of tasks in the active state. + /// Gets or sets the number of Tasks in the active state. /// [JsonProperty(PropertyName = "active")] public int Active { get; set; } /// - /// Gets or sets the number of tasks in the running or preparing state. + /// Gets or sets the number of Tasks in the running or preparing state. /// [JsonProperty(PropertyName = "running")] public int Running { get; set; } /// - /// Gets or sets the number of tasks in the completed state. + /// Gets or sets the number of Tasks in the completed state. /// [JsonProperty(PropertyName = "completed")] public int Completed { get; set; } /// - /// Gets or sets the number of tasks which succeeded. A task succeeds + /// Gets or sets the number of Tasks which succeeded. A Task succeeds /// if its result (found in the executionInfo property) is 'success'. /// [JsonProperty(PropertyName = "succeeded")] public int Succeeded { get; set; } /// - /// Gets or sets the number of tasks which failed. A task fails if its + /// Gets or sets the number of Tasks which failed. A Task fails if its /// result (found in the executionInfo property) is 'failure'. /// [JsonProperty(PropertyName = "failed")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskDeleteHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskDeleteHeaders.cs index 19aa98686f4a..722d0fe4b893 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskDeleteHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskDeleteHeaders.cs @@ -37,8 +37,8 @@ public TaskDeleteHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. public TaskDeleteHeaders(string clientRequestId = default(string), string requestId = default(string)) { ClientRequestId = clientRequestId; @@ -65,8 +65,8 @@ public TaskDeleteHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public string RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskDependencies.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskDependencies.cs index 68cbce034f61..776ca828d64a 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskDependencies.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskDependencies.cs @@ -16,9 +16,9 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Specifies any dependencies of a task. Any task that is explicitly + /// 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. + /// dependant Task will be scheduled. /// public partial class TaskDependencies { @@ -33,12 +33,12 @@ public TaskDependencies() /// /// Initializes a new instance of the TaskDependencies class. /// - /// The list of task IDs that this task depends - /// on. All tasks in this list must complete successfully before the - /// dependent task can be scheduled. - /// The list of task ID ranges that this - /// task depends on. All tasks in all ranges must complete successfully - /// before the dependent task can be scheduled. + /// The list of Task IDs that this Task depends + /// on. All Tasks in this list must complete successfully before the + /// dependent Task can be scheduled. + /// The list of Task ID ranges that this + /// Task depends on. All Tasks in all ranges must complete successfully + /// before the dependent Task can be scheduled. public TaskDependencies(IList taskIds = default(IList), IList taskIdRanges = default(IList)) { TaskIds = taskIds; @@ -52,24 +52,24 @@ public TaskDependencies() partial void CustomInit(); /// - /// Gets or sets the list of task IDs that this task depends on. All - /// tasks in this list must complete successfully before the dependent - /// task can be scheduled. + /// Gets or sets the list of Task IDs that this Task depends on. All + /// Tasks in this list must complete successfully before the dependent + /// Task can be scheduled. /// /// /// The taskIds collection is limited to 64000 characters total (i.e. - /// the combined length of all task IDs). If the taskIds collection + /// the combined length of all Task IDs). If the taskIds collection /// exceeds the maximum length, the Add Task request fails with error - /// code TaskDependencyListTooLong. In this case consider using task ID + /// code TaskDependencyListTooLong. In this case consider using Task ID /// ranges instead. /// [JsonProperty(PropertyName = "taskIds")] public IList TaskIds { get; set; } /// - /// Gets or sets the list of task ID ranges that this task depends on. - /// All tasks in all ranges must complete successfully before the - /// dependent task can be scheduled. + /// Gets or sets the list of Task ID ranges that this Task depends on. + /// All Tasks in all ranges must complete successfully before the + /// dependent Task can be scheduled. /// [JsonProperty(PropertyName = "taskIdRanges")] public IList TaskIdRanges { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskExecutionInformation.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskExecutionInformation.cs index 7ffdc3e8efc5..93039fe07a46 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskExecutionInformation.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskExecutionInformation.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Information about the execution of a task. + /// Information about the execution of a Task. /// public partial class TaskExecutionInformation { @@ -29,26 +29,26 @@ public TaskExecutionInformation() /// /// Initializes a new instance of the TaskExecutionInformation class. /// - /// The number of times the task has been + /// The number of times the Task has been /// retried by the Batch service. - /// The number of times the task has been + /// The number of times the Task has been /// requeued by the Batch service as the result of a user /// request. - /// The time at which the task started + /// The time at which the Task started /// running. - /// The time at which the task completed. + /// The time at which the Task completed. /// The exit code of the program specified on - /// the task command line. + /// the Task command line. /// Information about the container under - /// which the task is executing. - /// Information describing the task failure, + /// which the Task is executing. + /// Information describing the Task failure, /// if any. /// The most recent time at which a retry - /// of the task started running. + /// of the Task started running. /// The most recent time at which the - /// task has been requeued by the Batch service as the result of a user + /// Task has been requeued by the Batch service as the result of a user /// request. - /// The result of the task execution. + /// The result of the Task execution. public TaskExecutionInformation(int retryCount, int requeueCount, System.DateTime? startTime = default(System.DateTime?), System.DateTime? endTime = default(System.DateTime?), int? exitCode = default(int?), TaskContainerExecutionInformation containerInfo = default(TaskContainerExecutionInformation), TaskFailureInformation failureInfo = default(TaskFailureInformation), System.DateTime? lastRetryTime = default(System.DateTime?), System.DateTime? lastRequeueTime = default(System.DateTime?), TaskExecutionResult? result = default(TaskExecutionResult?)) { StartTime = startTime; @@ -70,88 +70,87 @@ public TaskExecutionInformation() partial void CustomInit(); /// - /// Gets or sets the time at which the task started running. + /// Gets or sets the time at which the Task started running. /// /// - /// 'Running' corresponds to the running state, so if the task - /// specifies resource files or application packages, then the start - /// time reflects the time at which the task started downloading or - /// deploying these. If the task has been restarted or retried, this is - /// the most recent time at which the task started running. This - /// property is present only for tasks that are in the running or - /// completed state. + /// 'Running' corresponds to the running state, so if the Task + /// specifies resource files or Packages, then the start time reflects + /// the time at which the Task started downloading or deploying these. + /// If the Task has been restarted or retried, this is the most recent + /// time at which the Task started running. This property is present + /// only for Tasks that are in the running or completed state. /// [JsonProperty(PropertyName = "startTime")] public System.DateTime? StartTime { get; set; } /// - /// Gets or sets the time at which the task completed. + /// Gets or sets the time at which the Task completed. /// /// - /// This property is set only if the task is in the Completed state. + /// This property is set only if the Task is in the Completed state. /// [JsonProperty(PropertyName = "endTime")] public System.DateTime? EndTime { get; set; } /// - /// Gets or sets the exit code of the program specified on the task + /// Gets or sets the exit code of the program specified on the Task /// command line. /// /// - /// This property is set only if the task is in the completed state. In + /// This property is set only if the Task is in the completed state. In /// general, the exit code for a process reflects the specific /// convention implemented by the application developer for that /// process. If you use the exit code value to make decisions in your /// code, be sure that you know the exit code convention used by the /// application process. However, if the Batch service terminates the - /// task (due to timeout, or user termination via the API) you may see + /// Task (due to timeout, or user termination via the API) you may see /// an operating system-defined exit code. /// [JsonProperty(PropertyName = "exitCode")] public int? ExitCode { get; set; } /// - /// Gets or sets information about the container under which the task + /// Gets or sets information about the container under which the Task /// is executing. /// /// - /// This property is set only if the task runs in a container context. + /// This property is set only if the Task runs in a container context. /// [JsonProperty(PropertyName = "containerInfo")] public TaskContainerExecutionInformation ContainerInfo { get; set; } /// - /// Gets or sets information describing the task failure, if any. + /// Gets or sets information describing the Task failure, if any. /// /// - /// This property is set only if the task is in the completed state and + /// This property is set only if the Task is in the completed state and /// encountered a failure. /// [JsonProperty(PropertyName = "failureInfo")] public TaskFailureInformation FailureInfo { get; set; } /// - /// Gets or sets the number of times the task has been retried by the + /// Gets or sets the number of times the Task has been retried by the /// Batch service. /// /// /// Task application failures (non-zero exit code) are retried, - /// pre-processing errors (the task could not be run) and file upload - /// errors are not retried. The Batch service will retry the task up to + /// pre-processing errors (the Task could not be run) and file upload + /// errors are not retried. The Batch service will retry the Task up to /// the limit specified by the constraints. /// [JsonProperty(PropertyName = "retryCount")] public int RetryCount { get; set; } /// - /// Gets or sets the most recent time at which a retry of the task + /// Gets or sets the most recent time at which a retry of the Task /// started running. /// /// - /// This element is present only if the task was retried (i.e. + /// This element is present only if the Task was retried (i.e. /// retryCount is nonzero). If present, this is typically the same as - /// startTime, but may be different if the task has been restarted for - /// reasons other than retry; for example, if the compute node was + /// startTime, but may be different if the Task has been restarted for + /// reasons other than retry; for example, if the Compute Node was /// rebooted during a retry, then the startTime is updated but the /// lastRetryTime is not. /// @@ -159,20 +158,21 @@ public TaskExecutionInformation() public System.DateTime? LastRetryTime { get; set; } /// - /// Gets or sets the number of times the task has been requeued by the + /// Gets or sets the number of times the Task has been requeued by the /// Batch service as the result of a user request. /// /// - /// When the user removes nodes from a pool (by resizing/shrinking the - /// pool) or when the job is being disabled, the user can specify that - /// running tasks on the nodes be requeued for execution. This count - /// tracks how many times the task has been requeued for these reasons. + /// When the user removes Compute Nodes from a Pool (by + /// resizing/shrinking the pool) or when the Job is being disabled, the + /// user can specify that running Tasks on the Compute Nodes be + /// requeued for execution. This count tracks how many times the Task + /// has been requeued for these reasons. /// [JsonProperty(PropertyName = "requeueCount")] public int RequeueCount { get; set; } /// - /// Gets or sets the most recent time at which the task has been + /// Gets or sets the most recent time at which the Task has been /// requeued by the Batch service as the result of a user request. /// /// @@ -182,7 +182,7 @@ public TaskExecutionInformation() public System.DateTime? LastRequeueTime { get; set; } /// - /// Gets or sets the result of the task execution. + /// Gets or sets the result of the Task execution. /// /// /// If the value is 'failed', then the details of the failure can be diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskExecutionResult.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskExecutionResult.cs index f31df987675b..9bcfdc82d06e 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskExecutionResult.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskExecutionResult.cs @@ -22,14 +22,14 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum TaskExecutionResult { /// - /// The task ran successfully. + /// The Task ran successfully. /// [EnumMember(Value = "success")] Success, /// - /// There was an error during processing of the task. The failure may - /// have occurred before the task process was launched, while the task - /// process was executing, or after the task process exited. + /// There was an error during processing of the Task. The failure may + /// have occurred before the Task process was launched, while the Task + /// process was executing, or after the Task process exited. /// [EnumMember(Value = "failure")] Failure diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskFailureInformation.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskFailureInformation.cs index 82ec8a54c003..475d20107793 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskFailureInformation.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskFailureInformation.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Information about a task failure. + /// Information about a Task failure. /// public partial class TaskFailureInformation { @@ -31,10 +31,10 @@ public TaskFailureInformation() /// /// Initializes a new instance of the TaskFailureInformation class. /// - /// The category of the task error. - /// An identifier for the task error. Codes are + /// The category of the Task error. + /// An identifier for the Task error. Codes are /// invariant and are intended to be consumed programmatically. - /// A message describing the task error, intended + /// A message describing the Task error, intended /// to be suitable for display in a user interface. /// A list of additional details related to the /// error. @@ -53,7 +53,7 @@ public TaskFailureInformation() partial void CustomInit(); /// - /// Gets or sets the category of the task error. + /// Gets or sets the category of the Task error. /// /// /// Possible values include: 'userError', 'serverError' @@ -62,14 +62,14 @@ public TaskFailureInformation() public ErrorCategory Category { get; set; } /// - /// Gets or sets an identifier for the task error. Codes are invariant + /// Gets or sets an identifier for the Task error. Codes are invariant /// and are intended to be consumed programmatically. /// [JsonProperty(PropertyName = "code")] public string Code { get; set; } /// - /// Gets or sets a message describing the task error, intended to be + /// Gets or sets a message describing the Task error, intended to be /// suitable for display in a user interface. /// [JsonProperty(PropertyName = "message")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskGetHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskGetHeaders.cs index 12e7b033a275..11737faacbe1 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskGetHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskGetHeaders.cs @@ -39,8 +39,8 @@ public TaskGetHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public TaskGetHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskIdRange.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskIdRange.cs index 3d9059b933b2..aafdbbf88022 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskIdRange.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskIdRange.cs @@ -14,13 +14,13 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// A range of task IDs that a task can depend on. All tasks with IDs in - /// the range must complete successfully before the dependent task can be + /// A range of Task IDs that a Task can depend on. All Tasks with IDs in + /// the range must complete successfully before the dependent Task can be /// scheduled. /// /// /// The start and end of the range are inclusive. For example, if a range - /// has start 9 and end 12, then it represents tasks '9', '10', '11' and + /// has start 9 and end 12, then it represents Tasks '9', '10', '11' and /// '12'. /// public partial class TaskIdRange @@ -36,8 +36,8 @@ public TaskIdRange() /// /// Initializes a new instance of the TaskIdRange class. /// - /// The first task ID in the range. - /// The last task ID in the range. + /// The first Task ID in the range. + /// The last Task ID in the range. public TaskIdRange(int start, int end) { Start = start; @@ -51,13 +51,13 @@ public TaskIdRange(int start, int end) partial void CustomInit(); /// - /// Gets or sets the first task ID in the range. + /// Gets or sets the first Task ID in the range. /// [JsonProperty(PropertyName = "start")] public int Start { get; set; } /// - /// Gets or sets the last task ID in the range. + /// Gets or sets the last Task ID in the range. /// [JsonProperty(PropertyName = "end")] public int End { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskInformation.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskInformation.cs index 4534f0710dca..8929f817463d 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskInformation.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskInformation.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Information about a task running on a compute node. + /// Information about a Task running on a Compute Node. /// public partial class TaskInformation { @@ -29,15 +29,15 @@ public TaskInformation() /// /// Initializes a new instance of the TaskInformation class. /// - /// The current state of the task. - /// The URL of the task. - /// The ID of the job to which the task + /// The current state of the Task. + /// The URL of the Task. + /// The ID of the Job to which the Task /// belongs. - /// The ID of the task. - /// The ID of the subtask if the task is a - /// multi-instance task. + /// The ID of the Task. + /// The ID of the subtask if the Task is a + /// multi-instance Task. /// Information about the execution of the - /// task. + /// Task. public TaskInformation(TaskState taskState, string taskUrl = default(string), string jobId = default(string), string taskId = default(string), int? subtaskId = default(int?), TaskExecutionInformation executionInfo = default(TaskExecutionInformation)) { TaskUrl = taskUrl; @@ -55,32 +55,32 @@ public TaskInformation() partial void CustomInit(); /// - /// Gets or sets the URL of the task. + /// Gets or sets the URL of the Task. /// [JsonProperty(PropertyName = "taskUrl")] public string TaskUrl { get; set; } /// - /// Gets or sets the ID of the job to which the task belongs. + /// Gets or sets the ID of the Job to which the Task belongs. /// [JsonProperty(PropertyName = "jobId")] public string JobId { get; set; } /// - /// Gets or sets the ID of the task. + /// Gets or sets the ID of the Task. /// [JsonProperty(PropertyName = "taskId")] public string TaskId { get; set; } /// - /// Gets or sets the ID of the subtask if the task is a multi-instance - /// task. + /// Gets or sets the ID of the subtask if the Task is a multi-instance + /// Task. /// [JsonProperty(PropertyName = "subtaskId")] public int? SubtaskId { get; set; } /// - /// Gets or sets the current state of the task. + /// Gets or sets the current state of the Task. /// /// /// Possible values include: 'active', 'preparing', 'running', @@ -90,7 +90,7 @@ public TaskInformation() public TaskState TaskState { get; set; } /// - /// Gets or sets information about the execution of the task. + /// Gets or sets information about the execution of the Task. /// [JsonProperty(PropertyName = "executionInfo")] public TaskExecutionInformation ExecutionInfo { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskListHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskListHeaders.cs index 26af71a8486a..e96874f8d7ef 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskListHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskListHeaders.cs @@ -39,8 +39,8 @@ public TaskListHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -76,8 +76,8 @@ public TaskListHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskListOptions.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskListOptions.cs index 6890d06d0e55..a9e435e8591c 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskListOptions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskListOptions.cs @@ -37,7 +37,7 @@ public TaskListOptions() /// An OData $select clause. /// An OData $expand clause. /// The maximum number of items to return in - /// the response. A maximum of 1000 tasks can be returned. + /// the response. A maximum of 1000 Tasks can be returned. /// The maximum time that the server can spend /// processing the request, in seconds. The default is 30 /// seconds. @@ -89,7 +89,7 @@ public TaskListOptions() /// /// Gets or sets the maximum number of items to return in the response. - /// A maximum of 1000 tasks can be returned. + /// A maximum of 1000 Tasks can be returned. /// [Newtonsoft.Json.JsonIgnore] public int? MaxResults { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskListSubtasksHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskListSubtasksHeaders.cs index a5a45b2add95..a58d8799abd0 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskListSubtasksHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskListSubtasksHeaders.cs @@ -39,8 +39,8 @@ public TaskListSubtasksHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -76,8 +76,8 @@ public TaskListSubtasksHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskReactivateHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskReactivateHeaders.cs index a25d0f77f150..918a3d96f471 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskReactivateHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskReactivateHeaders.cs @@ -39,8 +39,8 @@ public TaskReactivateHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public TaskReactivateHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskSchedulingPolicy.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskSchedulingPolicy.cs index c65858700170..09b647b7d478 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskSchedulingPolicy.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskSchedulingPolicy.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Specifies how tasks should be distributed across compute nodes. + /// Specifies how Tasks should be distributed across Compute Nodes. /// public partial class TaskSchedulingPolicy { @@ -29,8 +29,8 @@ public TaskSchedulingPolicy() /// /// Initializes a new instance of the TaskSchedulingPolicy class. /// - /// How tasks are distributed across compute - /// nodes in a pool. + /// How Tasks are distributed across Compute + /// Nodes in a Pool. public TaskSchedulingPolicy(ComputeNodeFillType nodeFillType) { NodeFillType = nodeFillType; @@ -43,8 +43,8 @@ public TaskSchedulingPolicy(ComputeNodeFillType nodeFillType) partial void CustomInit(); /// - /// Gets or sets how tasks are distributed across compute nodes in a - /// pool. + /// Gets or sets how Tasks are distributed across Compute Nodes in a + /// Pool. /// /// /// If not specified, the default is spread. Possible values include: diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskState.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskState.cs index 988a21463f75..353d77e14fc1 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskState.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskState.cs @@ -22,35 +22,35 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum TaskState { /// - /// The task is queued and able to run, but is not currently assigned - /// to a compute node. A task enters this state when it is created, + /// The Task is queued and able to run, but is not currently assigned + /// to a Compute Node. A Task enters this state when it is created, /// when it is enabled after being disabled, or when it is awaiting a /// retry after a failed run. /// [EnumMember(Value = "active")] Active, /// - /// The task has been assigned to a compute node, but is waiting for a - /// required Job Preparation task to complete on the node. If the Job - /// Preparation task succeeds, the task will move to running. If the - /// Job Preparation task fails, the task will return to active and will - /// be eligible to be assigned to a different node. + /// The Task has been assigned to a Compute Node, but is waiting for a + /// required Job Preparation Task to complete on the Compute Node. If + /// the Job Preparation Task succeeds, the Task will move to running. + /// If the Job Preparation Task fails, the Task will return to active + /// and will be eligible to be assigned to a different Compute Node. /// [EnumMember(Value = "preparing")] Preparing, /// - /// The task is running on a compute node. This includes task-level + /// The Task is running on a Compute Node. This includes task-level /// preparation such as downloading resource files or deploying - /// application packages specified on the task - it does not - /// necessarily mean that the task command line has started executing. + /// Packages specified on the Task - it does not necessarily mean that + /// the Task command line has started executing. /// [EnumMember(Value = "running")] Running, /// - /// The task is no longer eligible to run, usually because the task has - /// finished successfully, or the task has finished unsuccessfully and - /// has exhausted its retry limit. A task is also marked as completed - /// if an error occurred launching the task, or when the task has been + /// The Task is no longer eligible to run, usually because the Task has + /// finished successfully, or the Task has finished unsuccessfully and + /// has exhausted its retry limit. A Task is also marked as completed + /// if an error occurred launching the Task, or when the Task has been /// terminated. /// [EnumMember(Value = "completed")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskStatistics.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskStatistics.cs index b86ebc87b174..d747ea260fea 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskStatistics.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskStatistics.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Resource usage statistics for a task. + /// Resource usage statistics for a Task. /// public partial class TaskStatistics { @@ -36,26 +36,26 @@ public TaskStatistics() /// last updated. All statistics are limited to the range between /// startTime and lastUpdateTime. /// The total user mode CPU time (summed - /// across all cores and all compute nodes) consumed by the - /// task. + /// across all cores and all Compute Nodes) consumed by the + /// Task. /// The total kernel mode CPU time (summed - /// across all cores and all compute nodes) consumed by the - /// task. + /// across all cores and all Compute Nodes) consumed by the + /// Task. /// The total wall clock time of the - /// task. + /// Task. /// The total number of disk read operations - /// made by the task. + /// made by the Task. /// The total number of disk write operations - /// made by the task. + /// made by the Task. /// The total gibibytes read from disk by the - /// task. + /// Task. /// The total gibibytes written to disk by the - /// task. - /// The total wait time of the task. The wait - /// time for a task is defined as the elapsed time between the creation - /// of the task and the start of task execution. (If the task is + /// Task. + /// The total wait time of the Task. The wait + /// time for a Task is defined as the elapsed time between the creation + /// of the Task and the start of Task execution. (If the Task is /// retried due to failures, the wait time is the time to the most - /// recent task execution.) + /// recent Task execution.) public TaskStatistics(string url, System.DateTime startTime, System.DateTime lastUpdateTime, System.TimeSpan userCPUTime, System.TimeSpan kernelCPUTime, System.TimeSpan wallClockTime, long readIOps, long writeIOps, double readIOGiB, double writeIOGiB, System.TimeSpan waitTime) { Url = url; @@ -100,62 +100,62 @@ public TaskStatistics(string url, System.DateTime startTime, System.DateTime las /// /// Gets or sets the total user mode CPU time (summed across all cores - /// and all compute nodes) consumed by the task. + /// and all Compute Nodes) consumed by the Task. /// [JsonProperty(PropertyName = "userCPUTime")] public System.TimeSpan UserCPUTime { get; set; } /// /// Gets or sets the total kernel mode CPU time (summed across all - /// cores and all compute nodes) consumed by the task. + /// cores and all Compute Nodes) consumed by the Task. /// [JsonProperty(PropertyName = "kernelCPUTime")] public System.TimeSpan KernelCPUTime { get; set; } /// - /// Gets or sets the total wall clock time of the task. + /// Gets or sets the total wall clock time of the Task. /// /// - /// The wall clock time is the elapsed time from when the task started - /// running on a compute node to when it finished (or to the last time - /// the statistics were updated, if the task had not finished by then). - /// If the task was retried, this includes the wall clock time of all - /// the task retries. + /// The wall clock time is the elapsed time from when the Task started + /// running on a Compute Node to when it finished (or to the last time + /// the statistics were updated, if the Task had not finished by then). + /// If the Task was retried, this includes the wall clock time of all + /// the Task retries. /// [JsonProperty(PropertyName = "wallClockTime")] public System.TimeSpan WallClockTime { get; set; } /// /// Gets or sets the total number of disk read operations made by the - /// task. + /// Task. /// [JsonProperty(PropertyName = "readIOps")] public long ReadIOps { get; set; } /// /// Gets or sets the total number of disk write operations made by the - /// task. + /// Task. /// [JsonProperty(PropertyName = "writeIOps")] public long WriteIOps { get; set; } /// - /// Gets or sets the total gibibytes read from disk by the task. + /// Gets or sets the total gibibytes read from disk by the Task. /// [JsonProperty(PropertyName = "readIOGiB")] public double ReadIOGiB { get; set; } /// - /// Gets or sets the total gibibytes written to disk by the task. + /// Gets or sets the total gibibytes written to disk by the Task. /// [JsonProperty(PropertyName = "writeIOGiB")] public double WriteIOGiB { get; set; } /// - /// Gets or sets the total wait time of the task. The wait time for a - /// task is defined as the elapsed time between the creation of the - /// task and the start of task execution. (If the task is retried due - /// to failures, the wait time is the time to the most recent task + /// Gets or sets the total wait time of the Task. The wait time for a + /// Task is defined as the elapsed time between the creation of the + /// Task and the start of Task execution. (If the Task is retried due + /// to failures, the wait time is the time to the most recent Task /// execution.) /// [JsonProperty(PropertyName = "waitTime")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskTerminateHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskTerminateHeaders.cs index b6eabf651e61..ca95d106734a 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskTerminateHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskTerminateHeaders.cs @@ -39,8 +39,8 @@ public TaskTerminateHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public TaskTerminateHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskUpdateHeaders.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskUpdateHeaders.cs index 05a252cba3d7..790aace66ddd 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskUpdateHeaders.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskUpdateHeaders.cs @@ -39,8 +39,8 @@ public TaskUpdateHeaders() /// and you have verified that the request is properly formulated, you /// may use this value to report the error to Microsoft. In your /// report, include the value of this request ID, the approximate time - /// that the request was made, the Batch account against which the - /// request was made, and the region that account resides in. + /// that the request was made, the Batch Account against which the + /// request was made, and the region that Account resides in. /// The ETag HTTP response header. This is an opaque /// string. You can use it to detect whether the resource has changed /// between requests. In particular, you can pass the ETag to one of @@ -79,8 +79,8 @@ public TaskUpdateHeaders() /// have verified that the request is properly formulated, you may use /// this value to report the error to Microsoft. In your report, /// include the value of this request ID, the approximate time that the - /// request was made, the Batch account against which the request was - /// made, and the region that account resides in. + /// request was made, the Batch Account against which the request was + /// made, and the region that Account resides in. /// [JsonProperty(PropertyName = "request-id")] public System.Guid? RequestId { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskUpdateParameter.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskUpdateParameter.cs index fedff0632895..c4e800e3fa89 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskUpdateParameter.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/TaskUpdateParameter.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The set of changes to be made to a task. + /// The set of changes to be made to a Task. /// public partial class TaskUpdateParameter { @@ -30,7 +30,7 @@ public TaskUpdateParameter() /// Initializes a new instance of the TaskUpdateParameter class. /// /// Constraints that apply to this - /// task. + /// Task. public TaskUpdateParameter(TaskConstraints constraints = default(TaskConstraints)) { Constraints = constraints; @@ -43,12 +43,12 @@ public TaskUpdateParameter() partial void CustomInit(); /// - /// Gets or sets constraints that apply to this task. + /// Gets or sets constraints that apply to this Task. /// /// - /// If omitted, the task is given the default constraints. For - /// multi-instance tasks, updating the retention time applies only to - /// the primary task and not subtasks. + /// If omitted, the Task is given the default constraints. For + /// multi-instance Tasks, updating the retention time applies only to + /// the primary Task and not subtasks. /// [JsonProperty(PropertyName = "constraints")] public TaskConstraints Constraints { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/UploadBatchServiceLogsConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/UploadBatchServiceLogsConfiguration.cs index 9792e962e275..dfe6945aa515 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/UploadBatchServiceLogsConfiguration.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/UploadBatchServiceLogsConfiguration.cs @@ -14,8 +14,8 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The Azure Batch service log files upload configuration for a compute - /// node. + /// The Azure Batch service log files upload configuration for a Compute + /// Node. /// public partial class UploadBatchServiceLogsConfiguration { diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/UploadBatchServiceLogsResult.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/UploadBatchServiceLogsResult.cs index a850b5c3c884..b4c54f409e8d 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/UploadBatchServiceLogsResult.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/UploadBatchServiceLogsResult.cs @@ -14,8 +14,8 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The result of uploading Batch service log files from a specific compute - /// node. + /// The result of uploading Batch service log files from a specific Compute + /// Node. /// public partial class UploadBatchServiceLogsResult { diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/UsageStatistics.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/UsageStatistics.cs index c2107e71be02..3f18a1bd09a6 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/UsageStatistics.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/UsageStatistics.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Statistics related to pool usage information. + /// Statistics related to Pool usage information. /// public partial class UsageStatistics { @@ -35,7 +35,7 @@ public UsageStatistics() /// last updated. All statistics are limited to the range between /// startTime and lastUpdateTime. /// The aggregated wall-clock time of - /// the dedicated compute node cores being part of the pool. + /// the dedicated Compute Node cores being part of the Pool. public UsageStatistics(System.DateTime startTime, System.DateTime lastUpdateTime, System.TimeSpan dedicatedCoreTime) { StartTime = startTime; @@ -66,7 +66,7 @@ public UsageStatistics(System.DateTime startTime, System.DateTime lastUpdateTime /// /// Gets or sets the aggregated wall-clock time of the dedicated - /// compute node cores being part of the pool. + /// Compute Node cores being part of the Pool. /// [JsonProperty(PropertyName = "dedicatedCoreTime")] public System.TimeSpan DedicatedCoreTime { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/UserAccount.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/UserAccount.cs index 1445bbaa9bf9..0a072e8cc764 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/UserAccount.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/UserAccount.cs @@ -14,8 +14,8 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Properties used to create a user used to execute tasks on an Azure - /// Batch node. + /// Properties used to create a user used to execute Tasks on an Azure + /// Batch Compute Node. /// public partial class UserAccount { @@ -30,14 +30,14 @@ public UserAccount() /// /// Initializes a new instance of the UserAccount class. /// - /// The name of the user account. - /// The password for the user account. + /// The name of the user Account. + /// The password for the user Account. /// The elevation level of the user - /// account. + /// Account. /// The Linux-specific user - /// configuration for the user account. + /// configuration for the user Account. /// The Windows-specific user - /// configuration for the user account. + /// configuration for the user Account. public UserAccount(string name, string password, ElevationLevel? elevationLevel = default(ElevationLevel?), LinuxUserConfiguration linuxUserConfiguration = default(LinuxUserConfiguration), WindowsUserConfiguration windowsUserConfiguration = default(WindowsUserConfiguration)) { Name = name; @@ -54,19 +54,19 @@ public UserAccount() partial void CustomInit(); /// - /// Gets or sets the name of the user account. + /// Gets or sets the name of the user Account. /// [JsonProperty(PropertyName = "name")] public string Name { get; set; } /// - /// Gets or sets the password for the user account. + /// Gets or sets the password for the user Account. /// [JsonProperty(PropertyName = "password")] public string Password { get; set; } /// - /// Gets or sets the elevation level of the user account. + /// Gets or sets the elevation level of the user Account. /// /// /// The default value is nonAdmin. Possible values include: 'nonAdmin', @@ -77,10 +77,10 @@ public UserAccount() /// /// Gets or sets the Linux-specific user configuration for the user - /// account. + /// Account. /// /// - /// This property is ignored if specified on a Windows pool. If not + /// This property is ignored if specified on a Windows Pool. If not /// specified, the user is created with the default options. /// [JsonProperty(PropertyName = "linuxUserConfiguration")] @@ -88,11 +88,11 @@ public UserAccount() /// /// Gets or sets the Windows-specific user configuration for the user - /// account. + /// Account. /// /// /// This property can only be specified if the user is on a Windows - /// pool. If not specified and on a Windows pool, the user is created + /// Pool. If not specified and on a Windows Pool, the user is created /// with the default options. /// [JsonProperty(PropertyName = "windowsUserConfiguration")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/UserIdentity.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/UserIdentity.cs index 282829e6b9dc..ca82cd9e6949 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/UserIdentity.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/UserIdentity.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models 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. /// /// /// Specify either the userName or autoUser property, but not both. @@ -33,8 +33,8 @@ public UserIdentity() /// Initializes a new instance of the UserIdentity class. /// /// The name of the user identity under which - /// the task is run. - /// The auto user under which the task is + /// the Task is run. + /// The auto user under which the Task is /// run. public UserIdentity(string userName = default(string), AutoUserSpecification autoUser = default(AutoUserSpecification)) { @@ -49,7 +49,7 @@ public UserIdentity() partial void CustomInit(); /// - /// Gets or sets the name of the user identity under which the task is + /// Gets or sets the name of the user identity under which the Task is /// run. /// /// @@ -60,7 +60,7 @@ public UserIdentity() public string UserName { get; set; } /// - /// Gets or sets the auto user under which the task is run. + /// Gets or sets the auto user under which the Task is run. /// /// /// The userName and autoUser properties are mutually exclusive; you diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/VerificationType.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/VerificationType.cs index 5d6449e9c4d2..50270258ce67 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/VerificationType.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/VerificationType.cs @@ -22,15 +22,16 @@ namespace Microsoft.Azure.Batch.Protocol.Models public enum VerificationType { /// - /// The Image is guaranteed to be compatible with the associated node - /// agent SKU and all Batch features have been confirmed to work as - /// expected. + /// The Image is guaranteed to be compatible with the associated + /// Compute Node agent SKU and all Batch features have been confirmed + /// to work as expected. /// [EnumMember(Value = "verified")] Verified, /// - /// The associated node agent SKU should have binary compatibility with - /// the Image, but specific functionality has not been verified. + /// The associated Compute Node agent SKU should have binary + /// compatibility with the Image, but specific functionality has not + /// been verified. /// [EnumMember(Value = "unverified")] Unverified diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/VirtualMachineConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/VirtualMachineConfiguration.cs index dcc625c4eb68..931ef01830cf 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/VirtualMachineConfiguration.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/VirtualMachineConfiguration.cs @@ -16,7 +16,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// The configuration for compute nodes in a pool based on the Azure + /// The configuration for Compute Nodes in a Pool based on the Azure /// Virtual Machines infrastructure. /// public partial class VirtualMachineConfiguration @@ -35,18 +35,18 @@ public VirtualMachineConfiguration() /// class. /// /// A reference to the Azure Virtual - /// Machines Marketplace image or the custom Virtual Machine Image to + /// Machines Marketplace Image or the custom Virtual Machine Image to /// use. - /// The SKU of the Batch node agent to be - /// provisioned on compute nodes in the pool. + /// The SKU of the Batch Compute Node + /// agent to be provisioned on Compute Nodes in the Pool. /// Windows operating system /// settings on the virtual machine. /// The configuration for data disks attached - /// to the compute nodes in the pool. + /// to the Compute Nodes in the Pool. /// The type of on-premises license to be /// used when deploying the operating system. /// The container configuration - /// for the pool. + /// for the Pool. public VirtualMachineConfiguration(ImageReference imageReference, string nodeAgentSKUId, WindowsConfiguration windowsConfiguration = default(WindowsConfiguration), IList dataDisks = default(IList), string licenseType = default(string), ContainerConfiguration containerConfiguration = default(ContainerConfiguration)) { ImageReference = imageReference; @@ -65,24 +65,25 @@ public VirtualMachineConfiguration() /// /// Gets or sets a reference to the Azure Virtual Machines Marketplace - /// image or the custom Virtual Machine Image to use. + /// Image or the custom Virtual Machine Image to use. /// [JsonProperty(PropertyName = "imageReference")] public ImageReference ImageReference { get; set; } /// - /// Gets or sets the SKU of the Batch node agent to be provisioned on - /// compute nodes in the pool. + /// Gets or sets the SKU of the Batch Compute Node agent to be + /// provisioned on Compute Nodes in the Pool. /// /// - /// 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. You - /// must specify a node agent SKU which matches the selected image - /// reference. To get the list of supported node agent SKUs along with - /// their list of verified image references, see the 'List supported - /// node agent SKUs' operation. + /// The Batch Compute Node agent is a program that runs on each Compute + /// Node in the Pool, and provides the command-and-control interface + /// between the Compute Node and the Batch service. There are different + /// implementations of the Compute Node agent, known as SKUs, for + /// different operating systems. You must specify a Compute Node agent + /// SKU which matches the selected Image reference. To get the list of + /// supported Compute Node agent SKUs along with their list of verified + /// Image references, see the 'List supported Compute Node agent SKUs' + /// operation. /// [JsonProperty(PropertyName = "nodeAgentSKUId")] public string NodeAgentSKUId { get; set; } @@ -93,24 +94,24 @@ public VirtualMachineConfiguration() /// /// /// This property must not be specified if the imageReference property - /// specifies a Linux OS image. + /// specifies a Linux OS Image. /// [JsonProperty(PropertyName = "windowsConfiguration")] public WindowsConfiguration WindowsConfiguration { get; set; } /// /// Gets or sets the configuration for data disks attached to the - /// compute nodes in the pool. + /// Compute Nodes in the Pool. /// /// - /// This property must be specified if the compute nodes in the pool + /// This property must be specified if the Compute Nodes in the Pool /// need to have empty data disks attached to them. This cannot be - /// updated. Each node gets its own disk (the disk is not a file - /// share). Existing disks cannot be attached, each attached disk is - /// empty. When the node is removed from the pool, the disk and all - /// data associated with it is also deleted. The disk is not formatted - /// after being attached, it must be formatted before use - for more - /// information see + /// updated. Each Compute Node gets its own disk (the disk is not a + /// file share). Existing disks cannot be attached, each attached disk + /// is empty. When the Compute Node is removed from the Pool, the disk + /// and all data associated with it is also deleted. The disk is not + /// formatted after being attached, it must be formatted before use - + /// for more information see /// https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux /// and /// https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. @@ -123,10 +124,10 @@ public VirtualMachineConfiguration() /// deploying the operating system. /// /// - /// This only applies to images that contain the Windows operating + /// This only applies to Images that contain the Windows operating /// system, and should only be used when you hold valid on-premises - /// licenses for the nodes which will be deployed. If omitted, no - /// on-premises licensing discount is applied. Values are: + /// licenses for the Compute Nodes which will be deployed. If omitted, + /// no on-premises licensing discount is applied. Values are: /// /// Windows_Server - The on-premises license is for Windows Server. /// Windows_Client - The on-premises license is for Windows Client. @@ -136,13 +137,13 @@ public VirtualMachineConfiguration() public string LicenseType { get; set; } /// - /// Gets or sets the container configuration for the pool. + /// Gets or sets the container configuration for the Pool. /// /// - /// If specified, setup is performed on each node in the pool to allow - /// tasks to run in containers. All regular tasks and job manager tasks - /// run on this pool must specify the containerSettings property, and - /// all other tasks may specify it. + /// If specified, setup is performed on each Compute Node in the Pool + /// to allow Tasks to run in containers. All regular Tasks and Job + /// manager Tasks run on this Pool must specify the containerSettings + /// property, and all other Tasks may specify it. /// [JsonProperty(PropertyName = "containerConfiguration")] public ContainerConfiguration ContainerConfiguration { get; set; } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/WindowsUserConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/WindowsUserConfiguration.cs index 09ff9146615c..ae335beed06f 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/WindowsUserConfiguration.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/Models/WindowsUserConfiguration.cs @@ -14,7 +14,7 @@ namespace Microsoft.Azure.Batch.Protocol.Models using System.Linq; /// - /// Properties used to create a user account on a Windows node. + /// Properties used to create a user Account on a Windows Compute Node. /// public partial class WindowsUserConfiguration { @@ -45,8 +45,8 @@ public WindowsUserConfiguration() /// Gets or sets the login mode for the user /// /// - /// The default value for VirtualMachineConfiguration pools is 'batch' - /// and for CloudServiceConfiguration pools is 'interactive'. Possible + /// The default value for VirtualMachineConfiguration Pools is 'batch' + /// and for CloudServiceConfiguration Pools is 'interactive'. Possible /// values include: 'batch', 'interactive' /// [JsonProperty(PropertyName = "loginMode")] diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/PoolOperations.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/PoolOperations.cs index c1dc62a510ba..5c961fb88336 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/PoolOperations.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/PoolOperations.cs @@ -52,12 +52,12 @@ internal PoolOperations(BatchServiceClient client) public BatchServiceClient Client { get; private set; } /// - /// Lists the usage metrics, aggregated by pool across individual time - /// intervals, for the specified account. + /// Lists the usage metrics, aggregated by Pool across individual time + /// intervals, for the specified Account. /// /// /// If you do not specify a $filter clause including a poolId, the response - /// includes all pools that existed in the account in the time range of the + /// includes all Pools that existed in the Account in the time range of the /// returned aggregation intervals. If you do not specify a $filter clause /// including a startTime or endTime these filters default to the start and end /// times of the last aggregation interval currently available; that is, only @@ -342,12 +342,12 @@ internal PoolOperations(BatchServiceClient client) } /// - /// Gets lifetime summary statistics for all of the pools in the specified - /// account. + /// Gets lifetime summary statistics for all of the Pools in the specified + /// 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. /// @@ -590,15 +590,15 @@ internal PoolOperations(BatchServiceClient client) } /// - /// Adds a pool to the specified account. + /// Adds a Pool to the specified Account. /// /// - /// When naming pools, avoid including sensitive information such as user names + /// When naming Pools, avoid including sensitive information such as user names /// or secret project names. This information may appear in telemetry logs /// accessible to Microsoft Support engineers. /// /// - /// The pool to be added. + /// The Pool to be added. /// /// /// Additional parameters for the operation @@ -829,7 +829,7 @@ internal PoolOperations(BatchServiceClient client) } /// - /// Lists all of the pools in the specified account. + /// Lists all of the Pools in the specified Account. /// /// /// Additional parameters for the operation @@ -1110,24 +1110,24 @@ internal PoolOperations(BatchServiceClient client) } /// - /// Deletes a pool from the specified account. + /// Deletes a Pool from the specified Account. /// /// - /// When you request that a pool be deleted, the following actions occur: the - /// pool state is set to deleting; any ongoing resize operation on the pool are - /// stopped; the Batch service starts resizing the pool to zero nodes; any - /// tasks running on existing nodes are terminated and requeued (as if a resize - /// pool operation had been requested with the default requeue option); - /// finally, the pool is removed from the system. Because running tasks are - /// requeued, the user can rerun these tasks by updating their job to target a - /// different pool. The tasks can then run on the new pool. If you want to - /// override the requeue behavior, then you should call resize pool explicitly - /// to shrink the pool to zero size before deleting the pool. If you call an - /// Update, Patch or Delete API on a pool in the deleting state, it will fail - /// with HTTP status code 409 with error code PoolBeingDeleted. + /// When you request that a Pool be deleted, the following actions occur: the + /// Pool state is set to deleting; any ongoing resize operation on the Pool are + /// stopped; the Batch service starts resizing the Pool to zero Compute Nodes; + /// any Tasks running on existing Compute Nodes are terminated and requeued (as + /// if a resize Pool operation had been requested with the default requeue + /// option); finally, the Pool is removed from the system. Because running + /// Tasks are requeued, the user can rerun these Tasks by updating their Job to + /// target a different Pool. The Tasks can then run on the new Pool. If you + /// want to override the requeue behavior, then you should call resize Pool + /// explicitly to shrink the Pool to zero size before deleting the Pool. If you + /// call an Update, Patch or Delete API on a Pool in the deleting state, it + /// will fail with HTTP status code 409 with error code PoolBeingDeleted. /// /// - /// The ID of the pool to delete. + /// The ID of the Pool to delete. /// /// /// Additional parameters for the operation @@ -1409,10 +1409,10 @@ internal PoolOperations(BatchServiceClient client) } /// - /// Gets basic properties of a pool. + /// Gets basic properties of a Pool. /// /// - /// The ID of the pool to get. + /// The ID of the Pool to get. /// /// /// Additional parameters for the operation @@ -1695,10 +1695,10 @@ internal PoolOperations(BatchServiceClient client) } /// - /// Gets information about the specified pool. + /// Gets information about the specified Pool. /// /// - /// The ID of the pool to get. + /// The ID of the Pool to get. /// /// /// Additional parameters for the operation @@ -2021,16 +2021,16 @@ internal PoolOperations(BatchServiceClient client) } /// - /// Updates the properties of the specified pool. + /// Updates the properties of the specified Pool. /// /// - /// This only replaces the pool properties specified in the request. For - /// example, if the pool has a start task associated with it, and a request - /// does not specify a start task element, then the pool keeps the existing - /// start task. + /// This only replaces the Pool properties specified in the request. For + /// example, if the Pool has a StartTask associated with it, and a request does + /// not specify a StartTask element, then the Pool keeps the existing + /// StartTask. /// /// - /// The ID of the pool to update. + /// The ID of the Pool to update. /// /// /// The parameters for the request. @@ -2326,10 +2326,10 @@ internal PoolOperations(BatchServiceClient client) } /// - /// Disables automatic scaling for a pool. + /// Disables automatic scaling for a Pool. /// /// - /// The ID of the pool on which to disable automatic scaling. + /// The ID of the Pool on which to disable automatic scaling. /// /// /// Additional parameters for the operation @@ -2555,18 +2555,18 @@ internal PoolOperations(BatchServiceClient client) } /// - /// Enables automatic scaling for a pool. + /// Enables automatic scaling for a Pool. /// /// - /// You cannot enable automatic scaling on a pool if a resize operation is in - /// progress on the pool. If automatic scaling of the pool is currently + /// You cannot enable automatic scaling on a Pool if a resize operation is in + /// progress on the Pool. If automatic scaling of the Pool is currently /// disabled, you must specify a valid autoscale formula as part of the - /// request. If automatic scaling of the pool is already enabled, you may + /// request. If automatic scaling of the Pool is already enabled, you may /// specify a new autoscale formula and/or a new evaluation interval. You - /// cannot call this API for the same pool more than once every 30 seconds. + /// cannot call this API for the same Pool more than once every 30 seconds. /// /// - /// The ID of the pool on which to enable automatic scaling. + /// The ID of the Pool on which to enable automatic scaling. /// /// /// The parameters for the request. @@ -2862,22 +2862,22 @@ internal PoolOperations(BatchServiceClient client) } /// - /// Gets the result of evaluating an automatic scaling formula on the pool. + /// Gets the result of evaluating an automatic scaling formula on the Pool. /// /// /// This API is primarily for validating an autoscale formula, as it simply - /// returns the result without applying the formula to the pool. The pool must + /// returns the result without applying the formula to the Pool. The Pool must /// have auto scaling enabled in order to evaluate a formula. /// /// - /// The ID of the pool on which to evaluate the automatic scaling formula. + /// The ID of the Pool on which to evaluate the automatic scaling formula. /// /// - /// The formula for the desired number of compute nodes in the pool. The + /// The formula for the desired number of Compute Nodes in the Pool. The /// formula is validated and its results calculated, but it is not applied to - /// the pool. To apply the formula to the pool, 'Enable automatic scaling on a - /// pool'. For more information about specifying this formula, see - /// Automatically scale compute nodes in an Azure Batch pool + /// the Pool. To apply the formula to the Pool, 'Enable automatic scaling on a + /// Pool'. For more information about specifying this formula, see + /// Automatically scale Compute Nodes in an Azure Batch Pool /// (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling). /// /// @@ -3141,19 +3141,20 @@ internal PoolOperations(BatchServiceClient client) } /// - /// Changes the number of compute nodes that are assigned to a pool. + /// Changes the number of Compute Nodes that are assigned to a Pool. /// /// - /// You can only resize a pool when its allocation state is steady. If the pool + /// You can only resize a Pool when its allocation state is steady. If the Pool /// is already resizing, the request fails with status code 409. When you - /// resize a pool, the pool's allocation state changes from steady to resizing. - /// You cannot resize pools which are configured for automatic scaling. If you + /// resize a Pool, the Pool's allocation state changes from steady to resizing. + /// You cannot resize Pools which are configured for automatic scaling. If you /// try to do this, the Batch service returns an error 409. If you resize a - /// pool downwards, the Batch service chooses which nodes to remove. To remove - /// specific nodes, use the pool remove nodes API instead. + /// Pool downwards, the Batch service chooses which Compute Nodes to remove. To + /// remove specific Compute Nodes, use the Pool remove Compute Nodes API + /// instead. /// /// - /// The ID of the pool to resize. + /// The ID of the Pool to resize. /// /// /// The parameters for the request. @@ -3449,20 +3450,20 @@ internal PoolOperations(BatchServiceClient client) } /// - /// Stops an ongoing resize operation on the pool. + /// Stops an ongoing resize operation on the Pool. /// /// - /// This does not restore the pool to its previous state before the resize - /// operation: it only stops any further changes being made, and the pool - /// maintains its current state. After stopping, the pool stabilizes at the - /// number of nodes it was at when the stop operation was done. During the stop - /// operation, the pool allocation state changes first to stopping and then to - /// steady. A resize operation need not be an explicit resize pool request; - /// this API can also be used to halt the initial sizing of the pool when it is - /// created. + /// This does not restore the Pool to its previous state before the resize + /// operation: it only stops any further changes being made, and the Pool + /// maintains its current state. After stopping, the Pool stabilizes at the + /// number of Compute Nodes it was at when the stop operation was done. During + /// the stop operation, the Pool allocation state changes first to stopping and + /// then to steady. A resize operation need not be an explicit resize Pool + /// request; this API can also be used to halt the initial sizing of the Pool + /// when it is created. /// /// - /// The ID of the pool whose resizing you want to stop. + /// The ID of the Pool whose resizing you want to stop. /// /// /// Additional parameters for the operation @@ -3744,16 +3745,16 @@ internal PoolOperations(BatchServiceClient client) } /// - /// Updates the properties of the specified pool. + /// Updates the properties of the specified Pool. /// /// - /// This fully replaces all the updatable properties of the pool. For example, - /// if the pool has a start task associated with it and if start task is not + /// This fully replaces all the updatable properties of the Pool. For example, + /// if the Pool has a StartTask associated with it and if StartTask is not /// specified with this request, then the Batch service will remove the - /// existing start task. + /// existing StartTask. /// /// - /// The ID of the pool to update. + /// The ID of the Pool to update. /// /// /// The parameters for the request. @@ -3993,15 +3994,15 @@ internal PoolOperations(BatchServiceClient client) } /// - /// Removes compute nodes from the specified pool. + /// Removes Compute Nodes from the specified Pool. /// /// - /// This operation can only run when the allocation state of the pool is + /// This operation can only run when the allocation state of the Pool is /// steady. When this operation runs, the allocation state changes from steady /// to resizing. /// /// - /// The ID of the pool from which you want to remove nodes. + /// The ID of the Pool from which you want to remove Compute Nodes. /// /// /// The parameters for the request. @@ -4297,12 +4298,12 @@ internal PoolOperations(BatchServiceClient client) } /// - /// Lists the usage metrics, aggregated by pool across individual time - /// intervals, for the specified account. + /// Lists the usage metrics, aggregated by Pool across individual time + /// intervals, for the specified Account. /// /// /// If you do not specify a $filter clause including a poolId, the response - /// includes all pools that existed in the account in the time range of the + /// includes all Pools that existed in the Account in the time range of the /// returned aggregation intervals. If you do not specify a $filter clause /// including a startTime or endTime these filters default to the start and end /// times of the last aggregation interval currently available; that is, only @@ -4532,7 +4533,7 @@ internal PoolOperations(BatchServiceClient client) } /// - /// Lists all of the pools in the specified account. + /// Lists all of the Pools in the specified Account. /// /// /// The NextLink from the previous successful call to List operation. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/PoolOperationsExtensions.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/PoolOperationsExtensions.cs index 54ead0df41d6..cc0026632d0a 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/PoolOperationsExtensions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/PoolOperationsExtensions.cs @@ -22,12 +22,12 @@ namespace Microsoft.Azure.Batch.Protocol public static partial class PoolOperationsExtensions { /// - /// Lists the usage metrics, aggregated by pool across individual time - /// intervals, for the specified account. + /// Lists the usage metrics, aggregated by Pool across individual time + /// intervals, for the specified Account. /// /// /// If you do not specify a $filter clause including a poolId, the response - /// includes all pools that existed in the account in the time range of the + /// includes all Pools that existed in the Account in the time range of the /// returned aggregation intervals. If you do not specify a $filter clause /// including a startTime or endTime these filters default to the start and end /// times of the last aggregation interval currently available; that is, only @@ -45,12 +45,12 @@ public static partial class PoolOperationsExtensions } /// - /// Lists the usage metrics, aggregated by pool across individual time - /// intervals, for the specified account. + /// Lists the usage metrics, aggregated by Pool across individual time + /// intervals, for the specified Account. /// /// /// If you do not specify a $filter clause including a poolId, the response - /// includes all pools that existed in the account in the time range of the + /// includes all Pools that existed in the Account in the time range of the /// returned aggregation intervals. If you do not specify a $filter clause /// including a startTime or endTime these filters default to the start and end /// times of the last aggregation interval currently available; that is, only @@ -74,12 +74,12 @@ public static partial class PoolOperationsExtensions } /// - /// Gets lifetime summary statistics for all of the pools in the specified - /// account. + /// Gets lifetime summary statistics for all of the Pools in the specified + /// 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. /// @@ -95,12 +95,12 @@ public static partial class PoolOperationsExtensions } /// - /// Gets lifetime summary statistics for all of the pools in the specified - /// account. + /// Gets lifetime summary statistics for all of the Pools in the specified + /// 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. /// @@ -122,10 +122,10 @@ public static partial class PoolOperationsExtensions } /// - /// Adds a pool to the specified account. + /// Adds a Pool to the specified Account. /// /// - /// When naming pools, avoid including sensitive information such as user names + /// When naming Pools, avoid including sensitive information such as user names /// or secret project names. This information may appear in telemetry logs /// accessible to Microsoft Support engineers. /// @@ -133,7 +133,7 @@ public static partial class PoolOperationsExtensions /// The operations group for this extension method. /// /// - /// The pool to be added. + /// The Pool to be added. /// /// /// Additional parameters for the operation @@ -144,10 +144,10 @@ public static partial class PoolOperationsExtensions } /// - /// Adds a pool to the specified account. + /// Adds a Pool to the specified Account. /// /// - /// When naming pools, avoid including sensitive information such as user names + /// When naming Pools, avoid including sensitive information such as user names /// or secret project names. This information may appear in telemetry logs /// accessible to Microsoft Support engineers. /// @@ -155,7 +155,7 @@ public static partial class PoolOperationsExtensions /// The operations group for this extension method. /// /// - /// The pool to be added. + /// The Pool to be added. /// /// /// Additional parameters for the operation @@ -172,7 +172,7 @@ public static partial class PoolOperationsExtensions } /// - /// Lists all of the pools in the specified account. + /// Lists all of the Pools in the specified Account. /// /// /// The operations group for this extension method. @@ -186,7 +186,7 @@ public static partial class PoolOperationsExtensions } /// - /// Lists all of the pools in the specified account. + /// Lists all of the Pools in the specified Account. /// /// /// The operations group for this extension method. @@ -206,27 +206,27 @@ public static partial class PoolOperationsExtensions } /// - /// Deletes a pool from the specified account. + /// Deletes a Pool from the specified Account. /// /// - /// When you request that a pool be deleted, the following actions occur: the - /// pool state is set to deleting; any ongoing resize operation on the pool are - /// stopped; the Batch service starts resizing the pool to zero nodes; any - /// tasks running on existing nodes are terminated and requeued (as if a resize - /// pool operation had been requested with the default requeue option); - /// finally, the pool is removed from the system. Because running tasks are - /// requeued, the user can rerun these tasks by updating their job to target a - /// different pool. The tasks can then run on the new pool. If you want to - /// override the requeue behavior, then you should call resize pool explicitly - /// to shrink the pool to zero size before deleting the pool. If you call an - /// Update, Patch or Delete API on a pool in the deleting state, it will fail - /// with HTTP status code 409 with error code PoolBeingDeleted. + /// When you request that a Pool be deleted, the following actions occur: the + /// Pool state is set to deleting; any ongoing resize operation on the Pool are + /// stopped; the Batch service starts resizing the Pool to zero Compute Nodes; + /// any Tasks running on existing Compute Nodes are terminated and requeued (as + /// if a resize Pool operation had been requested with the default requeue + /// option); finally, the Pool is removed from the system. Because running + /// Tasks are requeued, the user can rerun these Tasks by updating their Job to + /// target a different Pool. The Tasks can then run on the new Pool. If you + /// want to override the requeue behavior, then you should call resize Pool + /// explicitly to shrink the Pool to zero size before deleting the Pool. If you + /// call an Update, Patch or Delete API on a Pool in the deleting state, it + /// will fail with HTTP status code 409 with error code PoolBeingDeleted. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool to delete. + /// The ID of the Pool to delete. /// /// /// Additional parameters for the operation @@ -237,27 +237,27 @@ public static partial class PoolOperationsExtensions } /// - /// Deletes a pool from the specified account. + /// Deletes a Pool from the specified Account. /// /// - /// When you request that a pool be deleted, the following actions occur: the - /// pool state is set to deleting; any ongoing resize operation on the pool are - /// stopped; the Batch service starts resizing the pool to zero nodes; any - /// tasks running on existing nodes are terminated and requeued (as if a resize - /// pool operation had been requested with the default requeue option); - /// finally, the pool is removed from the system. Because running tasks are - /// requeued, the user can rerun these tasks by updating their job to target a - /// different pool. The tasks can then run on the new pool. If you want to - /// override the requeue behavior, then you should call resize pool explicitly - /// to shrink the pool to zero size before deleting the pool. If you call an - /// Update, Patch or Delete API on a pool in the deleting state, it will fail - /// with HTTP status code 409 with error code PoolBeingDeleted. + /// When you request that a Pool be deleted, the following actions occur: the + /// Pool state is set to deleting; any ongoing resize operation on the Pool are + /// stopped; the Batch service starts resizing the Pool to zero Compute Nodes; + /// any Tasks running on existing Compute Nodes are terminated and requeued (as + /// if a resize Pool operation had been requested with the default requeue + /// option); finally, the Pool is removed from the system. Because running + /// Tasks are requeued, the user can rerun these Tasks by updating their Job to + /// target a different Pool. The Tasks can then run on the new Pool. If you + /// want to override the requeue behavior, then you should call resize Pool + /// explicitly to shrink the Pool to zero size before deleting the Pool. If you + /// call an Update, Patch or Delete API on a Pool in the deleting state, it + /// will fail with HTTP status code 409 with error code PoolBeingDeleted. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool to delete. + /// The ID of the Pool to delete. /// /// /// Additional parameters for the operation @@ -274,13 +274,13 @@ public static partial class PoolOperationsExtensions } /// - /// Gets basic properties of a pool. + /// Gets basic properties of a Pool. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool to get. + /// The ID of the Pool to get. /// /// /// Additional parameters for the operation @@ -291,13 +291,13 @@ public static partial class PoolOperationsExtensions } /// - /// Gets basic properties of a pool. + /// Gets basic properties of a Pool. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool to get. + /// The ID of the Pool to get. /// /// /// Additional parameters for the operation @@ -314,13 +314,13 @@ public static partial class PoolOperationsExtensions } /// - /// Gets information about the specified pool. + /// Gets information about the specified Pool. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool to get. + /// The ID of the Pool to get. /// /// /// Additional parameters for the operation @@ -331,13 +331,13 @@ public static partial class PoolOperationsExtensions } /// - /// Gets information about the specified pool. + /// Gets information about the specified Pool. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool to get. + /// The ID of the Pool to get. /// /// /// Additional parameters for the operation @@ -354,19 +354,19 @@ public static partial class PoolOperationsExtensions } /// - /// Updates the properties of the specified pool. + /// Updates the properties of the specified Pool. /// /// - /// This only replaces the pool properties specified in the request. For - /// example, if the pool has a start task associated with it, and a request - /// does not specify a start task element, then the pool keeps the existing - /// start task. + /// This only replaces the Pool properties specified in the request. For + /// example, if the Pool has a StartTask associated with it, and a request does + /// not specify a StartTask element, then the Pool keeps the existing + /// StartTask. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool to update. + /// The ID of the Pool to update. /// /// /// The parameters for the request. @@ -380,19 +380,19 @@ public static partial class PoolOperationsExtensions } /// - /// Updates the properties of the specified pool. + /// Updates the properties of the specified Pool. /// /// - /// This only replaces the pool properties specified in the request. For - /// example, if the pool has a start task associated with it, and a request - /// does not specify a start task element, then the pool keeps the existing - /// start task. + /// This only replaces the Pool properties specified in the request. For + /// example, if the Pool has a StartTask associated with it, and a request does + /// not specify a StartTask element, then the Pool keeps the existing + /// StartTask. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool to update. + /// The ID of the Pool to update. /// /// /// The parameters for the request. @@ -412,13 +412,13 @@ public static partial class PoolOperationsExtensions } /// - /// Disables automatic scaling for a pool. + /// Disables automatic scaling for a Pool. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool on which to disable automatic scaling. + /// The ID of the Pool on which to disable automatic scaling. /// /// /// Additional parameters for the operation @@ -429,13 +429,13 @@ public static partial class PoolOperationsExtensions } /// - /// Disables automatic scaling for a pool. + /// Disables automatic scaling for a Pool. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool on which to disable automatic scaling. + /// The ID of the Pool on which to disable automatic scaling. /// /// /// Additional parameters for the operation @@ -452,21 +452,21 @@ public static partial class PoolOperationsExtensions } /// - /// Enables automatic scaling for a pool. + /// Enables automatic scaling for a Pool. /// /// - /// You cannot enable automatic scaling on a pool if a resize operation is in - /// progress on the pool. If automatic scaling of the pool is currently + /// You cannot enable automatic scaling on a Pool if a resize operation is in + /// progress on the Pool. If automatic scaling of the Pool is currently /// disabled, you must specify a valid autoscale formula as part of the - /// request. If automatic scaling of the pool is already enabled, you may + /// request. If automatic scaling of the Pool is already enabled, you may /// specify a new autoscale formula and/or a new evaluation interval. You - /// cannot call this API for the same pool more than once every 30 seconds. + /// cannot call this API for the same Pool more than once every 30 seconds. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool on which to enable automatic scaling. + /// The ID of the Pool on which to enable automatic scaling. /// /// /// The parameters for the request. @@ -480,21 +480,21 @@ public static partial class PoolOperationsExtensions } /// - /// Enables automatic scaling for a pool. + /// Enables automatic scaling for a Pool. /// /// - /// You cannot enable automatic scaling on a pool if a resize operation is in - /// progress on the pool. If automatic scaling of the pool is currently + /// You cannot enable automatic scaling on a Pool if a resize operation is in + /// progress on the Pool. If automatic scaling of the Pool is currently /// disabled, you must specify a valid autoscale formula as part of the - /// request. If automatic scaling of the pool is already enabled, you may + /// request. If automatic scaling of the Pool is already enabled, you may /// specify a new autoscale formula and/or a new evaluation interval. You - /// cannot call this API for the same pool more than once every 30 seconds. + /// cannot call this API for the same Pool more than once every 30 seconds. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool on which to enable automatic scaling. + /// The ID of the Pool on which to enable automatic scaling. /// /// /// The parameters for the request. @@ -514,25 +514,25 @@ public static partial class PoolOperationsExtensions } /// - /// Gets the result of evaluating an automatic scaling formula on the pool. + /// Gets the result of evaluating an automatic scaling formula on the Pool. /// /// /// This API is primarily for validating an autoscale formula, as it simply - /// returns the result without applying the formula to the pool. The pool must + /// returns the result without applying the formula to the Pool. The Pool must /// have auto scaling enabled in order to evaluate a formula. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool on which to evaluate the automatic scaling formula. + /// The ID of the Pool on which to evaluate the automatic scaling formula. /// /// - /// The formula for the desired number of compute nodes in the pool. The + /// The formula for the desired number of Compute Nodes in the Pool. The /// formula is validated and its results calculated, but it is not applied to - /// the pool. To apply the formula to the pool, 'Enable automatic scaling on a - /// pool'. For more information about specifying this formula, see - /// Automatically scale compute nodes in an Azure Batch pool + /// the Pool. To apply the formula to the Pool, 'Enable automatic scaling on a + /// Pool'. For more information about specifying this formula, see + /// Automatically scale Compute Nodes in an Azure Batch Pool /// (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling). /// /// @@ -544,25 +544,25 @@ public static partial class PoolOperationsExtensions } /// - /// Gets the result of evaluating an automatic scaling formula on the pool. + /// Gets the result of evaluating an automatic scaling formula on the Pool. /// /// /// This API is primarily for validating an autoscale formula, as it simply - /// returns the result without applying the formula to the pool. The pool must + /// returns the result without applying the formula to the Pool. The Pool must /// have auto scaling enabled in order to evaluate a formula. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool on which to evaluate the automatic scaling formula. + /// The ID of the Pool on which to evaluate the automatic scaling formula. /// /// - /// The formula for the desired number of compute nodes in the pool. The + /// The formula for the desired number of Compute Nodes in the Pool. The /// formula is validated and its results calculated, but it is not applied to - /// the pool. To apply the formula to the pool, 'Enable automatic scaling on a - /// pool'. For more information about specifying this formula, see - /// Automatically scale compute nodes in an Azure Batch pool + /// the Pool. To apply the formula to the Pool, 'Enable automatic scaling on a + /// Pool'. For more information about specifying this formula, see + /// Automatically scale Compute Nodes in an Azure Batch Pool /// (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling). /// /// @@ -580,22 +580,23 @@ public static partial class PoolOperationsExtensions } /// - /// Changes the number of compute nodes that are assigned to a pool. + /// Changes the number of Compute Nodes that are assigned to a Pool. /// /// - /// You can only resize a pool when its allocation state is steady. If the pool + /// You can only resize a Pool when its allocation state is steady. If the Pool /// is already resizing, the request fails with status code 409. When you - /// resize a pool, the pool's allocation state changes from steady to resizing. - /// You cannot resize pools which are configured for automatic scaling. If you + /// resize a Pool, the Pool's allocation state changes from steady to resizing. + /// You cannot resize Pools which are configured for automatic scaling. If you /// try to do this, the Batch service returns an error 409. If you resize a - /// pool downwards, the Batch service chooses which nodes to remove. To remove - /// specific nodes, use the pool remove nodes API instead. + /// Pool downwards, the Batch service chooses which Compute Nodes to remove. To + /// remove specific Compute Nodes, use the Pool remove Compute Nodes API + /// instead. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool to resize. + /// The ID of the Pool to resize. /// /// /// The parameters for the request. @@ -609,22 +610,23 @@ public static partial class PoolOperationsExtensions } /// - /// Changes the number of compute nodes that are assigned to a pool. + /// Changes the number of Compute Nodes that are assigned to a Pool. /// /// - /// You can only resize a pool when its allocation state is steady. If the pool + /// You can only resize a Pool when its allocation state is steady. If the Pool /// is already resizing, the request fails with status code 409. When you - /// resize a pool, the pool's allocation state changes from steady to resizing. - /// You cannot resize pools which are configured for automatic scaling. If you + /// resize a Pool, the Pool's allocation state changes from steady to resizing. + /// You cannot resize Pools which are configured for automatic scaling. If you /// try to do this, the Batch service returns an error 409. If you resize a - /// pool downwards, the Batch service chooses which nodes to remove. To remove - /// specific nodes, use the pool remove nodes API instead. + /// Pool downwards, the Batch service chooses which Compute Nodes to remove. To + /// remove specific Compute Nodes, use the Pool remove Compute Nodes API + /// instead. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool to resize. + /// The ID of the Pool to resize. /// /// /// The parameters for the request. @@ -644,23 +646,23 @@ public static partial class PoolOperationsExtensions } /// - /// Stops an ongoing resize operation on the pool. + /// Stops an ongoing resize operation on the Pool. /// /// - /// This does not restore the pool to its previous state before the resize - /// operation: it only stops any further changes being made, and the pool - /// maintains its current state. After stopping, the pool stabilizes at the - /// number of nodes it was at when the stop operation was done. During the stop - /// operation, the pool allocation state changes first to stopping and then to - /// steady. A resize operation need not be an explicit resize pool request; - /// this API can also be used to halt the initial sizing of the pool when it is - /// created. + /// This does not restore the Pool to its previous state before the resize + /// operation: it only stops any further changes being made, and the Pool + /// maintains its current state. After stopping, the Pool stabilizes at the + /// number of Compute Nodes it was at when the stop operation was done. During + /// the stop operation, the Pool allocation state changes first to stopping and + /// then to steady. A resize operation need not be an explicit resize Pool + /// request; this API can also be used to halt the initial sizing of the Pool + /// when it is created. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool whose resizing you want to stop. + /// The ID of the Pool whose resizing you want to stop. /// /// /// Additional parameters for the operation @@ -671,23 +673,23 @@ public static partial class PoolOperationsExtensions } /// - /// Stops an ongoing resize operation on the pool. + /// Stops an ongoing resize operation on the Pool. /// /// - /// This does not restore the pool to its previous state before the resize - /// operation: it only stops any further changes being made, and the pool - /// maintains its current state. After stopping, the pool stabilizes at the - /// number of nodes it was at when the stop operation was done. During the stop - /// operation, the pool allocation state changes first to stopping and then to - /// steady. A resize operation need not be an explicit resize pool request; - /// this API can also be used to halt the initial sizing of the pool when it is - /// created. + /// This does not restore the Pool to its previous state before the resize + /// operation: it only stops any further changes being made, and the Pool + /// maintains its current state. After stopping, the Pool stabilizes at the + /// number of Compute Nodes it was at when the stop operation was done. During + /// the stop operation, the Pool allocation state changes first to stopping and + /// then to steady. A resize operation need not be an explicit resize Pool + /// request; this API can also be used to halt the initial sizing of the Pool + /// when it is created. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool whose resizing you want to stop. + /// The ID of the Pool whose resizing you want to stop. /// /// /// Additional parameters for the operation @@ -704,19 +706,19 @@ public static partial class PoolOperationsExtensions } /// - /// Updates the properties of the specified pool. + /// Updates the properties of the specified Pool. /// /// - /// This fully replaces all the updatable properties of the pool. For example, - /// if the pool has a start task associated with it and if start task is not + /// This fully replaces all the updatable properties of the Pool. For example, + /// if the Pool has a StartTask associated with it and if StartTask is not /// specified with this request, then the Batch service will remove the - /// existing start task. + /// existing StartTask. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool to update. + /// The ID of the Pool to update. /// /// /// The parameters for the request. @@ -730,19 +732,19 @@ public static partial class PoolOperationsExtensions } /// - /// Updates the properties of the specified pool. + /// Updates the properties of the specified Pool. /// /// - /// This fully replaces all the updatable properties of the pool. For example, - /// if the pool has a start task associated with it and if start task is not + /// This fully replaces all the updatable properties of the Pool. For example, + /// if the Pool has a StartTask associated with it and if StartTask is not /// specified with this request, then the Batch service will remove the - /// existing start task. + /// existing StartTask. /// /// /// The operations group for this extension method. /// /// - /// The ID of the pool to update. + /// The ID of the Pool to update. /// /// /// The parameters for the request. @@ -762,10 +764,10 @@ public static partial class PoolOperationsExtensions } /// - /// Removes compute nodes from the specified pool. + /// Removes Compute Nodes from the specified Pool. /// /// - /// This operation can only run when the allocation state of the pool is + /// This operation can only run when the allocation state of the Pool is /// steady. When this operation runs, the allocation state changes from steady /// to resizing. /// @@ -773,7 +775,7 @@ public static partial class PoolOperationsExtensions /// The operations group for this extension method. /// /// - /// The ID of the pool from which you want to remove nodes. + /// The ID of the Pool from which you want to remove Compute Nodes. /// /// /// The parameters for the request. @@ -787,10 +789,10 @@ public static partial class PoolOperationsExtensions } /// - /// Removes compute nodes from the specified pool. + /// Removes Compute Nodes from the specified Pool. /// /// - /// This operation can only run when the allocation state of the pool is + /// This operation can only run when the allocation state of the Pool is /// steady. When this operation runs, the allocation state changes from steady /// to resizing. /// @@ -798,7 +800,7 @@ public static partial class PoolOperationsExtensions /// The operations group for this extension method. /// /// - /// The ID of the pool from which you want to remove nodes. + /// The ID of the Pool from which you want to remove Compute Nodes. /// /// /// The parameters for the request. @@ -818,12 +820,12 @@ public static partial class PoolOperationsExtensions } /// - /// Lists the usage metrics, aggregated by pool across individual time - /// intervals, for the specified account. + /// Lists the usage metrics, aggregated by Pool across individual time + /// intervals, for the specified Account. /// /// /// If you do not specify a $filter clause including a poolId, the response - /// includes all pools that existed in the account in the time range of the + /// includes all Pools that existed in the Account in the time range of the /// returned aggregation intervals. If you do not specify a $filter clause /// including a startTime or endTime these filters default to the start and end /// times of the last aggregation interval currently available; that is, only @@ -844,12 +846,12 @@ public static partial class PoolOperationsExtensions } /// - /// Lists the usage metrics, aggregated by pool across individual time - /// intervals, for the specified account. + /// Lists the usage metrics, aggregated by Pool across individual time + /// intervals, for the specified Account. /// /// /// If you do not specify a $filter clause including a poolId, the response - /// includes all pools that existed in the account in the time range of the + /// includes all Pools that existed in the Account in the time range of the /// returned aggregation intervals. If you do not specify a $filter clause /// including a startTime or endTime these filters default to the start and end /// times of the last aggregation interval currently available; that is, only @@ -876,7 +878,7 @@ public static partial class PoolOperationsExtensions } /// - /// Lists all of the pools in the specified account. + /// Lists all of the Pools in the specified Account. /// /// /// The operations group for this extension method. @@ -893,7 +895,7 @@ public static partial class PoolOperationsExtensions } /// - /// Lists all of the pools in the specified account. + /// Lists all of the Pools in the specified Account. /// /// /// The operations group for this extension method. diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/SdkInfo_BatchService.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/SdkInfo_BatchService.cs index 28dc8b84a96c..0c4c07879201 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/SdkInfo_BatchService.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/SdkInfo_BatchService.cs @@ -19,15 +19,15 @@ public static IEnumerable> ApiInfo_BatchService { return new Tuple[] { - new Tuple("BatchService", "Account", "2019-06-01.9.0"), - new Tuple("BatchService", "Application", "2019-06-01.9.0"), - new Tuple("BatchService", "Certificate", "2019-06-01.9.0"), - new Tuple("BatchService", "ComputeNode", "2019-06-01.9.0"), - new Tuple("BatchService", "File", "2019-06-01.9.0"), - new Tuple("BatchService", "Job", "2019-06-01.9.0"), - new Tuple("BatchService", "JobSchedule", "2019-06-01.9.0"), - new Tuple("BatchService", "Pool", "2019-06-01.9.0"), - new Tuple("BatchService", "Task", "2019-06-01.9.0"), + new Tuple("BatchService", "Account", "2019-08-01.10.0"), + new Tuple("BatchService", "Application", "2019-08-01.10.0"), + new Tuple("BatchService", "Certificate", "2019-08-01.10.0"), + new Tuple("BatchService", "ComputeNode", "2019-08-01.10.0"), + new Tuple("BatchService", "File", "2019-08-01.10.0"), + new Tuple("BatchService", "Job", "2019-08-01.10.0"), + new Tuple("BatchService", "JobSchedule", "2019-08-01.10.0"), + new Tuple("BatchService", "Pool", "2019-08-01.10.0"), + new Tuple("BatchService", "Task", "2019-08-01.10.0"), }.AsEnumerable(); } } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/TaskOperations.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/TaskOperations.cs index d001c1529992..79d6d8607272 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/TaskOperations.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/TaskOperations.cs @@ -52,19 +52,19 @@ internal TaskOperations(BatchServiceClient client) public BatchServiceClient Client { get; private set; } /// - /// Adds a task to the specified job. + /// Adds a Task to the specified Job. /// /// - /// The maximum lifetime of a task from addition to completion is 180 days. If - /// a task has not completed within 180 days of being added it will be + /// The maximum lifetime of a Task from addition to completion is 180 days. If + /// a Task has not completed within 180 days of being added it will be /// terminated by the Batch service and left in whatever state it was in at /// that time. /// /// - /// The ID of the job to which the task is to be added. + /// The ID of the Job to which the Task is to be added. /// /// - /// The task to be added. + /// The Task to be added. /// /// /// Additional parameters for the operation @@ -301,15 +301,15 @@ internal TaskOperations(BatchServiceClient client) } /// - /// Lists all of the tasks that are associated with the specified job. + /// Lists all of the Tasks that are associated with the specified Job. /// /// - /// For multi-instance tasks, information such as affinityId, executionInfo and - /// nodeInfo refer to the primary task. Use the list subtasks API to retrieve + /// For multi-instance Tasks, information such as affinityId, executionInfo and + /// nodeInfo refer to the primary Task. Use the list subtasks API to retrieve /// information about subtasks. /// /// - /// The ID of the job. + /// The ID of the Job. /// /// /// Additional parameters for the operation @@ -596,34 +596,34 @@ internal TaskOperations(BatchServiceClient client) } /// - /// Adds a collection of tasks to the specified job. + /// Adds a collection of Tasks to the specified Job. /// /// - /// Note that each task must have a unique ID. The Batch service may not return - /// the results for each task in the same order the tasks were submitted in + /// Note that each Task must have a unique ID. The Batch service may not return + /// the results for each Task in the same order the Tasks were submitted in /// this request. If the server times out or the connection is closed during /// the request, the request may have been partially or fully processed, or not /// at all. In such cases, the user should re-issue the request. Note that it /// is up to the user to correctly handle failures when re-issuing a request. - /// For example, you should use the same task IDs during a retry so that if the - /// prior operation succeeded, the retry will not create extra tasks - /// unexpectedly. If the response contains any tasks which failed to add, a + /// For example, you should use the same Task IDs during a retry so that if the + /// prior operation succeeded, the retry will not create extra Tasks + /// unexpectedly. If the response contains any Tasks which failed to add, a /// client can retry the request. In a retry, it is most efficient to resubmit - /// only tasks that failed to add, and to omit tasks that were successfully - /// added on the first attempt. The maximum lifetime of a task from addition to - /// completion is 180 days. If a task has not completed within 180 days of + /// only Tasks that failed to add, and to omit Tasks that were successfully + /// added on the first attempt. The maximum lifetime of a Task from addition to + /// completion is 180 days. If a Task has not completed within 180 days of /// being added it will be terminated by the Batch service and left in whatever /// state it was in at that time. /// /// - /// The ID of the job to which the task collection is to be added. + /// The ID of the Job to which the Task collection is to be added. /// /// - /// The collection of tasks to add. The maximum count of tasks is 100. The + /// The collection of Tasks to add. The maximum count of Tasks is 100. The /// total serialized size of this collection must be less than 1MB. If it is - /// greater than 1MB (for example if each task has 100's of resource files or + /// greater than 1MB (for example if each Task has 100's of resource files or /// environment variables), the request will fail with code - /// 'RequestBodyTooLarge' and should be retried again with fewer tasks. + /// 'RequestBodyTooLarge' and should be retried again with fewer Tasks. /// /// /// Additional parameters for the operation @@ -886,20 +886,20 @@ internal TaskOperations(BatchServiceClient client) } /// - /// Deletes a task from the specified job. + /// Deletes a Task from the specified Job. /// /// - /// When a task is deleted, all of the files in its directory on the compute - /// node where it ran are also deleted (regardless of the retention time). For - /// multi-instance tasks, the delete task operation applies synchronously to + /// When a Task is deleted, all of the files in its directory on the Compute + /// Node where it ran are also deleted (regardless of the retention time). For + /// multi-instance Tasks, the delete Task operation applies synchronously to /// the primary task; subtasks and their files are then deleted asynchronously /// in the background. /// /// - /// The ID of the job from which to delete the task. + /// The ID of the Job from which to delete the Task. /// /// - /// The ID of the task to delete. + /// The ID of the Task to delete. /// /// /// Additional parameters for the operation @@ -1187,18 +1187,18 @@ internal TaskOperations(BatchServiceClient client) } /// - /// Gets information about the specified task. + /// Gets information about the specified Task. /// /// - /// For multi-instance tasks, information such as affinityId, executionInfo and - /// nodeInfo refer to the primary task. Use the list subtasks API to retrieve + /// For multi-instance Tasks, information such as affinityId, executionInfo and + /// nodeInfo refer to the primary Task. Use the list subtasks API to retrieve /// information about subtasks. /// /// - /// The ID of the job that contains the task. + /// The ID of the Job that contains the Task. /// /// - /// The ID of the task to get information about. + /// The ID of the Task to get information about. /// /// /// Additional parameters for the operation @@ -1527,18 +1527,18 @@ internal TaskOperations(BatchServiceClient client) } /// - /// Updates the properties of the specified task. + /// Updates the properties of the specified Task. /// /// - /// The ID of the job containing the task. + /// The ID of the Job containing the Task. /// /// - /// The ID of the task to update. + /// The ID of the Task to update. /// /// - /// Constraints that apply to this task. If omitted, the task is given the - /// default constraints. For multi-instance tasks, updating the retention time - /// applies only to the primary task and not subtasks. + /// Constraints that apply to this Task. If omitted, the Task is given the + /// default constraints. For multi-instance Tasks, updating the retention time + /// applies only to the primary Task and not subtasks. /// /// /// Additional parameters for the operation @@ -1839,17 +1839,17 @@ internal TaskOperations(BatchServiceClient client) /// /// Lists all of the subtasks that are associated with the specified - /// multi-instance task. + /// multi-instance Task. /// /// - /// If the task is not a multi-instance task then this returns an empty + /// If the Task is not a multi-instance Task then this returns an empty /// collection. /// /// - /// The ID of the job. + /// The ID of the Job. /// /// - /// The ID of the task. + /// The ID of the Task. /// /// /// Additional parameters for the operation @@ -2112,19 +2112,19 @@ internal TaskOperations(BatchServiceClient client) } /// - /// Terminates the specified task. + /// Terminates the specified Task. /// /// - /// When the task has been terminated, it moves to the completed state. For - /// multi-instance tasks, the terminate task operation applies synchronously to + /// When the Task has been terminated, it moves to the completed state. For + /// multi-instance Tasks, the terminate Task operation applies synchronously to /// the primary task; subtasks are then terminated asynchronously in the /// background. /// /// - /// The ID of the job containing the task. + /// The ID of the Job containing the Task. /// /// - /// The ID of the task to terminate. + /// The ID of the Task to terminate. /// /// /// Additional parameters for the operation @@ -2412,24 +2412,24 @@ internal TaskOperations(BatchServiceClient client) } /// - /// Reactivates a task, allowing it to run again even if its retry count has + /// Reactivates a Task, allowing it to run again even if its retry count has /// been exhausted. /// /// - /// Reactivation makes a task eligible to be retried again up to its maximum - /// retry count. The task's state is changed to active. As the task is no + /// Reactivation makes a Task eligible to be retried again up to its maximum + /// retry count. The Task's state is changed to active. As the Task is no /// longer in the completed state, any previous exit code or failure - /// information is no longer available after reactivation. Each time a task is + /// information is no longer available after reactivation. Each time a Task is /// reactivated, its retry count is reset to 0. Reactivation will fail for - /// tasks that are not completed or that previously completed successfully - /// (with an exit code of 0). Additionally, it will fail if the job has + /// Tasks that are not completed or that previously completed successfully + /// (with an exit code of 0). Additionally, it will fail if the Job has /// completed (or is terminating or deleting). /// /// - /// The ID of the job containing the task. + /// The ID of the Job containing the Task. /// /// - /// The ID of the task to reactivate. + /// The ID of the Task to reactivate. /// /// /// Additional parameters for the operation @@ -2717,11 +2717,11 @@ internal TaskOperations(BatchServiceClient client) } /// - /// Lists all of the tasks that are associated with the specified job. + /// Lists all of the Tasks that are associated with the specified Job. /// /// - /// For multi-instance tasks, information such as affinityId, executionInfo and - /// nodeInfo refer to the primary task. Use the list subtasks API to retrieve + /// For multi-instance Tasks, information such as affinityId, executionInfo and + /// nodeInfo refer to the primary Task. Use the list subtasks API to retrieve /// information about subtasks. /// /// diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/TaskOperationsExtensions.cs b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/TaskOperationsExtensions.cs index 48b2c0d9c4c3..81869053438a 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/TaskOperationsExtensions.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GeneratedProtocol/TaskOperationsExtensions.cs @@ -24,11 +24,11 @@ namespace Microsoft.Azure.Batch.Protocol public static partial class TaskOperationsExtensions { /// - /// Adds a task to the specified job. + /// Adds a Task to the specified Job. /// /// - /// The maximum lifetime of a task from addition to completion is 180 days. If - /// a task has not completed within 180 days of being added it will be + /// The maximum lifetime of a Task from addition to completion is 180 days. If + /// a Task has not completed within 180 days of being added it will be /// terminated by the Batch service and left in whatever state it was in at /// that time. /// @@ -36,10 +36,10 @@ public static partial class TaskOperationsExtensions /// The operations group for this extension method. /// /// - /// The ID of the job to which the task is to be added. + /// The ID of the Job to which the Task is to be added. /// /// - /// The task to be added. + /// The Task to be added. /// /// /// Additional parameters for the operation @@ -50,11 +50,11 @@ public static partial class TaskOperationsExtensions } /// - /// Adds a task to the specified job. + /// Adds a Task to the specified Job. /// /// - /// The maximum lifetime of a task from addition to completion is 180 days. If - /// a task has not completed within 180 days of being added it will be + /// The maximum lifetime of a Task from addition to completion is 180 days. If + /// a Task has not completed within 180 days of being added it will be /// terminated by the Batch service and left in whatever state it was in at /// that time. /// @@ -62,10 +62,10 @@ public static partial class TaskOperationsExtensions /// The operations group for this extension method. /// /// - /// The ID of the job to which the task is to be added. + /// The ID of the Job to which the Task is to be added. /// /// - /// The task to be added. + /// The Task to be added. /// /// /// Additional parameters for the operation @@ -82,18 +82,18 @@ public static partial class TaskOperationsExtensions } /// - /// Lists all of the tasks that are associated with the specified job. + /// Lists all of the Tasks that are associated with the specified Job. /// /// - /// For multi-instance tasks, information such as affinityId, executionInfo and - /// nodeInfo refer to the primary task. Use the list subtasks API to retrieve + /// For multi-instance Tasks, information such as affinityId, executionInfo and + /// nodeInfo refer to the primary Task. Use the list subtasks API to retrieve /// information about subtasks. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job. + /// The ID of the Job. /// /// /// Additional parameters for the operation @@ -104,18 +104,18 @@ public static partial class TaskOperationsExtensions } /// - /// Lists all of the tasks that are associated with the specified job. + /// Lists all of the Tasks that are associated with the specified Job. /// /// - /// For multi-instance tasks, information such as affinityId, executionInfo and - /// nodeInfo refer to the primary task. Use the list subtasks API to retrieve + /// For multi-instance Tasks, information such as affinityId, executionInfo and + /// nodeInfo refer to the primary Task. Use the list subtasks API to retrieve /// information about subtasks. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job. + /// The ID of the Job. /// /// /// Additional parameters for the operation @@ -132,22 +132,22 @@ public static partial class TaskOperationsExtensions } /// - /// Adds a collection of tasks to the specified job. + /// Adds a collection of Tasks to the specified Job. /// /// - /// Note that each task must have a unique ID. The Batch service may not return - /// the results for each task in the same order the tasks were submitted in + /// Note that each Task must have a unique ID. The Batch service may not return + /// the results for each Task in the same order the Tasks were submitted in /// this request. If the server times out or the connection is closed during /// the request, the request may have been partially or fully processed, or not /// at all. In such cases, the user should re-issue the request. Note that it /// is up to the user to correctly handle failures when re-issuing a request. - /// For example, you should use the same task IDs during a retry so that if the - /// prior operation succeeded, the retry will not create extra tasks - /// unexpectedly. If the response contains any tasks which failed to add, a + /// For example, you should use the same Task IDs during a retry so that if the + /// prior operation succeeded, the retry will not create extra Tasks + /// unexpectedly. If the response contains any Tasks which failed to add, a /// client can retry the request. In a retry, it is most efficient to resubmit - /// only tasks that failed to add, and to omit tasks that were successfully - /// added on the first attempt. The maximum lifetime of a task from addition to - /// completion is 180 days. If a task has not completed within 180 days of + /// only Tasks that failed to add, and to omit Tasks that were successfully + /// added on the first attempt. The maximum lifetime of a Task from addition to + /// completion is 180 days. If a Task has not completed within 180 days of /// being added it will be terminated by the Batch service and left in whatever /// state it was in at that time. /// @@ -155,14 +155,14 @@ public static partial class TaskOperationsExtensions /// The operations group for this extension method. /// /// - /// The ID of the job to which the task collection is to be added. + /// The ID of the Job to which the Task collection is to be added. /// /// - /// The collection of tasks to add. The maximum count of tasks is 100. The + /// The collection of Tasks to add. The maximum count of Tasks is 100. The /// total serialized size of this collection must be less than 1MB. If it is - /// greater than 1MB (for example if each task has 100's of resource files or + /// greater than 1MB (for example if each Task has 100's of resource files or /// environment variables), the request will fail with code - /// 'RequestBodyTooLarge' and should be retried again with fewer tasks. + /// 'RequestBodyTooLarge' and should be retried again with fewer Tasks. /// /// /// Additional parameters for the operation @@ -173,22 +173,22 @@ public static partial class TaskOperationsExtensions } /// - /// Adds a collection of tasks to the specified job. + /// Adds a collection of Tasks to the specified Job. /// /// - /// Note that each task must have a unique ID. The Batch service may not return - /// the results for each task in the same order the tasks were submitted in + /// Note that each Task must have a unique ID. The Batch service may not return + /// the results for each Task in the same order the Tasks were submitted in /// this request. If the server times out or the connection is closed during /// the request, the request may have been partially or fully processed, or not /// at all. In such cases, the user should re-issue the request. Note that it /// is up to the user to correctly handle failures when re-issuing a request. - /// For example, you should use the same task IDs during a retry so that if the - /// prior operation succeeded, the retry will not create extra tasks - /// unexpectedly. If the response contains any tasks which failed to add, a + /// For example, you should use the same Task IDs during a retry so that if the + /// prior operation succeeded, the retry will not create extra Tasks + /// unexpectedly. If the response contains any Tasks which failed to add, a /// client can retry the request. In a retry, it is most efficient to resubmit - /// only tasks that failed to add, and to omit tasks that were successfully - /// added on the first attempt. The maximum lifetime of a task from addition to - /// completion is 180 days. If a task has not completed within 180 days of + /// only Tasks that failed to add, and to omit Tasks that were successfully + /// added on the first attempt. The maximum lifetime of a Task from addition to + /// completion is 180 days. If a Task has not completed within 180 days of /// being added it will be terminated by the Batch service and left in whatever /// state it was in at that time. /// @@ -196,14 +196,14 @@ public static partial class TaskOperationsExtensions /// The operations group for this extension method. /// /// - /// The ID of the job to which the task collection is to be added. + /// The ID of the Job to which the Task collection is to be added. /// /// - /// The collection of tasks to add. The maximum count of tasks is 100. The + /// The collection of Tasks to add. The maximum count of Tasks is 100. The /// total serialized size of this collection must be less than 1MB. If it is - /// greater than 1MB (for example if each task has 100's of resource files or + /// greater than 1MB (for example if each Task has 100's of resource files or /// environment variables), the request will fail with code - /// 'RequestBodyTooLarge' and should be retried again with fewer tasks. + /// 'RequestBodyTooLarge' and should be retried again with fewer Tasks. /// /// /// Additional parameters for the operation @@ -220,12 +220,12 @@ public static partial class TaskOperationsExtensions } /// - /// Deletes a task from the specified job. + /// Deletes a Task from the specified Job. /// /// - /// When a task is deleted, all of the files in its directory on the compute - /// node where it ran are also deleted (regardless of the retention time). For - /// multi-instance tasks, the delete task operation applies synchronously to + /// When a Task is deleted, all of the files in its directory on the Compute + /// Node where it ran are also deleted (regardless of the retention time). For + /// multi-instance Tasks, the delete Task operation applies synchronously to /// the primary task; subtasks and their files are then deleted asynchronously /// in the background. /// @@ -233,10 +233,10 @@ public static partial class TaskOperationsExtensions /// The operations group for this extension method. /// /// - /// The ID of the job from which to delete the task. + /// The ID of the Job from which to delete the Task. /// /// - /// The ID of the task to delete. + /// The ID of the Task to delete. /// /// /// Additional parameters for the operation @@ -247,12 +247,12 @@ public static partial class TaskOperationsExtensions } /// - /// Deletes a task from the specified job. + /// Deletes a Task from the specified Job. /// /// - /// When a task is deleted, all of the files in its directory on the compute - /// node where it ran are also deleted (regardless of the retention time). For - /// multi-instance tasks, the delete task operation applies synchronously to + /// When a Task is deleted, all of the files in its directory on the Compute + /// Node where it ran are also deleted (regardless of the retention time). For + /// multi-instance Tasks, the delete Task operation applies synchronously to /// the primary task; subtasks and their files are then deleted asynchronously /// in the background. /// @@ -260,10 +260,10 @@ public static partial class TaskOperationsExtensions /// The operations group for this extension method. /// /// - /// The ID of the job from which to delete the task. + /// The ID of the Job from which to delete the Task. /// /// - /// The ID of the task to delete. + /// The ID of the Task to delete. /// /// /// Additional parameters for the operation @@ -280,21 +280,21 @@ public static partial class TaskOperationsExtensions } /// - /// Gets information about the specified task. + /// Gets information about the specified Task. /// /// - /// For multi-instance tasks, information such as affinityId, executionInfo and - /// nodeInfo refer to the primary task. Use the list subtasks API to retrieve + /// For multi-instance Tasks, information such as affinityId, executionInfo and + /// nodeInfo refer to the primary Task. Use the list subtasks API to retrieve /// information about subtasks. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job that contains the task. + /// The ID of the Job that contains the Task. /// /// - /// The ID of the task to get information about. + /// The ID of the Task to get information about. /// /// /// Additional parameters for the operation @@ -305,21 +305,21 @@ public static partial class TaskOperationsExtensions } /// - /// Gets information about the specified task. + /// Gets information about the specified Task. /// /// - /// For multi-instance tasks, information such as affinityId, executionInfo and - /// nodeInfo refer to the primary task. Use the list subtasks API to retrieve + /// For multi-instance Tasks, information such as affinityId, executionInfo and + /// nodeInfo refer to the primary Task. Use the list subtasks API to retrieve /// information about subtasks. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job that contains the task. + /// The ID of the Job that contains the Task. /// /// - /// The ID of the task to get information about. + /// The ID of the Task to get information about. /// /// /// Additional parameters for the operation @@ -336,21 +336,21 @@ public static partial class TaskOperationsExtensions } /// - /// Updates the properties of the specified task. + /// Updates the properties of the specified Task. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job containing the task. + /// The ID of the Job containing the Task. /// /// - /// The ID of the task to update. + /// The ID of the Task to update. /// /// - /// Constraints that apply to this task. If omitted, the task is given the - /// default constraints. For multi-instance tasks, updating the retention time - /// applies only to the primary task and not subtasks. + /// Constraints that apply to this Task. If omitted, the Task is given the + /// default constraints. For multi-instance Tasks, updating the retention time + /// applies only to the primary Task and not subtasks. /// /// /// Additional parameters for the operation @@ -361,21 +361,21 @@ public static partial class TaskOperationsExtensions } /// - /// Updates the properties of the specified task. + /// Updates the properties of the specified Task. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job containing the task. + /// The ID of the Job containing the Task. /// /// - /// The ID of the task to update. + /// The ID of the Task to update. /// /// - /// Constraints that apply to this task. If omitted, the task is given the - /// default constraints. For multi-instance tasks, updating the retention time - /// applies only to the primary task and not subtasks. + /// Constraints that apply to this Task. If omitted, the Task is given the + /// default constraints. For multi-instance Tasks, updating the retention time + /// applies only to the primary Task and not subtasks. /// /// /// Additional parameters for the operation @@ -393,20 +393,20 @@ public static partial class TaskOperationsExtensions /// /// Lists all of the subtasks that are associated with the specified - /// multi-instance task. + /// multi-instance Task. /// /// - /// If the task is not a multi-instance task then this returns an empty + /// If the Task is not a multi-instance Task then this returns an empty /// collection. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job. + /// The ID of the Job. /// /// - /// The ID of the task. + /// The ID of the Task. /// /// /// Additional parameters for the operation @@ -418,20 +418,20 @@ public static partial class TaskOperationsExtensions /// /// Lists all of the subtasks that are associated with the specified - /// multi-instance task. + /// multi-instance Task. /// /// - /// If the task is not a multi-instance task then this returns an empty + /// If the Task is not a multi-instance Task then this returns an empty /// collection. /// /// /// The operations group for this extension method. /// /// - /// The ID of the job. + /// The ID of the Job. /// /// - /// The ID of the task. + /// The ID of the Task. /// /// /// Additional parameters for the operation @@ -448,11 +448,11 @@ public static partial class TaskOperationsExtensions } /// - /// Terminates the specified task. + /// Terminates the specified Task. /// /// - /// When the task has been terminated, it moves to the completed state. For - /// multi-instance tasks, the terminate task operation applies synchronously to + /// When the Task has been terminated, it moves to the completed state. For + /// multi-instance Tasks, the terminate Task operation applies synchronously to /// the primary task; subtasks are then terminated asynchronously in the /// background. /// @@ -460,10 +460,10 @@ public static partial class TaskOperationsExtensions /// The operations group for this extension method. /// /// - /// The ID of the job containing the task. + /// The ID of the Job containing the Task. /// /// - /// The ID of the task to terminate. + /// The ID of the Task to terminate. /// /// /// Additional parameters for the operation @@ -474,11 +474,11 @@ public static partial class TaskOperationsExtensions } /// - /// Terminates the specified task. + /// Terminates the specified Task. /// /// - /// When the task has been terminated, it moves to the completed state. For - /// multi-instance tasks, the terminate task operation applies synchronously to + /// When the Task has been terminated, it moves to the completed state. For + /// multi-instance Tasks, the terminate Task operation applies synchronously to /// the primary task; subtasks are then terminated asynchronously in the /// background. /// @@ -486,10 +486,10 @@ public static partial class TaskOperationsExtensions /// The operations group for this extension method. /// /// - /// The ID of the job containing the task. + /// The ID of the Job containing the Task. /// /// - /// The ID of the task to terminate. + /// The ID of the Task to terminate. /// /// /// Additional parameters for the operation @@ -506,27 +506,27 @@ public static partial class TaskOperationsExtensions } /// - /// Reactivates a task, allowing it to run again even if its retry count has + /// Reactivates a Task, allowing it to run again even if its retry count has /// been exhausted. /// /// - /// Reactivation makes a task eligible to be retried again up to its maximum - /// retry count. The task's state is changed to active. As the task is no + /// Reactivation makes a Task eligible to be retried again up to its maximum + /// retry count. The Task's state is changed to active. As the Task is no /// longer in the completed state, any previous exit code or failure - /// information is no longer available after reactivation. Each time a task is + /// information is no longer available after reactivation. Each time a Task is /// reactivated, its retry count is reset to 0. Reactivation will fail for - /// tasks that are not completed or that previously completed successfully - /// (with an exit code of 0). Additionally, it will fail if the job has + /// Tasks that are not completed or that previously completed successfully + /// (with an exit code of 0). Additionally, it will fail if the Job has /// completed (or is terminating or deleting). /// /// /// The operations group for this extension method. /// /// - /// The ID of the job containing the task. + /// The ID of the Job containing the Task. /// /// - /// The ID of the task to reactivate. + /// The ID of the Task to reactivate. /// /// /// Additional parameters for the operation @@ -537,27 +537,27 @@ public static partial class TaskOperationsExtensions } /// - /// Reactivates a task, allowing it to run again even if its retry count has + /// Reactivates a Task, allowing it to run again even if its retry count has /// been exhausted. /// /// - /// Reactivation makes a task eligible to be retried again up to its maximum - /// retry count. The task's state is changed to active. As the task is no + /// Reactivation makes a Task eligible to be retried again up to its maximum + /// retry count. The Task's state is changed to active. As the Task is no /// longer in the completed state, any previous exit code or failure - /// information is no longer available after reactivation. Each time a task is + /// information is no longer available after reactivation. Each time a Task is /// reactivated, its retry count is reset to 0. Reactivation will fail for - /// tasks that are not completed or that previously completed successfully - /// (with an exit code of 0). Additionally, it will fail if the job has + /// Tasks that are not completed or that previously completed successfully + /// (with an exit code of 0). Additionally, it will fail if the Job has /// completed (or is terminating or deleting). /// /// /// The operations group for this extension method. /// /// - /// The ID of the job containing the task. + /// The ID of the Job containing the Task. /// /// - /// The ID of the task to reactivate. + /// The ID of the Task to reactivate. /// /// /// Additional parameters for the operation @@ -574,11 +574,11 @@ public static partial class TaskOperationsExtensions } /// - /// Lists all of the tasks that are associated with the specified job. + /// Lists all of the Tasks that are associated with the specified Job. /// /// - /// For multi-instance tasks, information such as affinityId, executionInfo and - /// nodeInfo refer to the primary task. Use the list subtasks API to retrieve + /// For multi-instance Tasks, information such as affinityId, executionInfo and + /// nodeInfo refer to the primary Task. Use the list subtasks API to retrieve /// information about subtasks. /// /// @@ -596,11 +596,11 @@ public static partial class TaskOperationsExtensions } /// - /// Lists all of the tasks that are associated with the specified job. + /// Lists all of the Tasks that are associated with the specified Job. /// /// - /// For multi-instance tasks, information such as affinityId, executionInfo and - /// nodeInfo refer to the primary task. Use the list subtasks API to retrieve + /// For multi-instance Tasks, information such as affinityId, executionInfo and + /// nodeInfo refer to the primary Task. Use the list subtasks API to retrieve /// information about subtasks. /// /// diff --git a/sdk/batch/Microsoft.Azure.Batch/src/GetFileRequestByteRange.cs b/sdk/batch/Microsoft.Azure.Batch/src/GetFileRequestByteRange.cs index 0808b0988ced..8a45a33fd052 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/GetFileRequestByteRange.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/GetFileRequestByteRange.cs @@ -35,7 +35,7 @@ public GetFileRequestByteRange(int startRange, int endRange) internal string GetOcpRangeHeader() { - return string.Format(OcpRangeFormat, this.StartRange, this.EndRange); + return string.Format(System.Globalization.CultureInfo.InvariantCulture, OcpRangeFormat, this.StartRange, this.EndRange); } } } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/ImageReference.cs b/sdk/batch/Microsoft.Azure.Batch/src/ImageReference.cs index a454f4f41b02..7aaf303a42b7 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/ImageReference.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/ImageReference.cs @@ -28,8 +28,9 @@ public ImageReference( /// Initializes a new instance of the class. /// /// - /// The ARM resource identifier of the virtual machine image. Computes nodes of the pool will be created using - /// this custom image. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName} + /// The ARM resource identifier of the Virtual Machine Image or Shared Image Gallery Image. Computes Compute Nodes of the Pool will be created using this Image Id. + /// This is of either the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName} for Virtual Machine Image or + /// /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId} for SIG image. /// public ImageReference( string virtualMachineImageId) diff --git a/sdk/batch/Microsoft.Azure.Batch/src/JobManagerTask.cs b/sdk/batch/Microsoft.Azure.Batch/src/JobManagerTask.cs index dfb2cbadf1f3..ed941e3dad9e 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/JobManagerTask.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/JobManagerTask.cs @@ -7,6 +7,9 @@ public partial class JobManagerTask { + /// + /// Initializes a new instance of the class. + /// public JobManagerTask() : this(id: null, commandLine: null) { } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/JobPreparationTask.cs b/sdk/batch/Microsoft.Azure.Batch/src/JobPreparationTask.cs index ad4449c95833..30efa4fdf5af 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/JobPreparationTask.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/JobPreparationTask.cs @@ -7,8 +7,11 @@ public partial class JobPreparationTask { - public JobPreparationTask() : this(commandLine: null) - { - } + /// + /// Initializes a new instance of the class. + /// + public JobPreparationTask() : this(commandLine: null) + { + } } } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/JobReleaseTask.cs b/sdk/batch/Microsoft.Azure.Batch/src/JobReleaseTask.cs index d689dbdb0f68..023a562bf0e6 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/JobReleaseTask.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/JobReleaseTask.cs @@ -8,6 +8,9 @@ namespace Microsoft.Azure.Batch public partial class JobReleaseTask { + /// + /// Initializes a new instance of the class. + /// public JobReleaseTask() : this(commandLine: null) { } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/JobSpecification.cs b/sdk/batch/Microsoft.Azure.Batch/src/JobSpecification.cs index c3ca62c873fb..2e4f1c7b80ec 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/JobSpecification.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/JobSpecification.cs @@ -8,6 +8,9 @@ namespace Microsoft.Azure.Batch public partial class JobSpecification { + /// + /// Initializes a new instance of the class. + /// public JobSpecification() : this(poolInformation: null) { } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/Microsoft.Azure.Batch.csproj b/sdk/batch/Microsoft.Azure.Batch/src/Microsoft.Azure.Batch.csproj index d9dfd1dc62f6..777925e45571 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/Microsoft.Azure.Batch.csproj +++ b/sdk/batch/Microsoft.Azure.Batch/src/Microsoft.Azure.Batch.csproj @@ -1,14 +1,14 @@  This client library provides access to the Microsoft Azure Batch service. - 11.0.0 + 12.0.0 $(DefineConstants);CODESIGN true Microsoft Azure Batch Microsoft;Azure;Batch;windowsazureofficial bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml true - 1591;NU5105 + 1591;NU5105;CA1308;CA1825;CA2237 @@ -34,4 +34,14 @@ --> + + + + all + runtime; build; native; contentfiles; analyzers; reliability + + + + AzureBatch.ruleset + diff --git a/sdk/batch/Microsoft.Azure.Batch/src/MountConfiguration.cs b/sdk/batch/Microsoft.Azure.Batch/src/MountConfiguration.cs new file mode 100644 index 000000000000..558cfd23b7bd --- /dev/null +++ b/sdk/batch/Microsoft.Azure.Batch/src/MountConfiguration.cs @@ -0,0 +1,38 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License.txt in the project root for license information. + +namespace Microsoft.Azure.Batch +{ + using System; + + public partial class MountConfiguration + { + /// + /// Initializes a new instance of the class with an . + /// + public MountConfiguration(AzureBlobFileSystemConfiguration configuration) : this(azureBlobFileSystemConfiguration: configuration) + { + } + + /// + /// Initializes a new instance of the class with an . + /// + public MountConfiguration(AzureFileShareConfiguration configuration) : this(azureFileShareConfiguration: configuration) + { + } + + /// + /// Initializes a new instance of the class with an . + /// + public MountConfiguration(NfsMountConfiguration configuration) : this(nfsMountConfiguration: configuration) + { + } + + /// + /// Initializes a new instance of the class with an . + /// + public MountConfiguration(CifsMountConfiguration configuration) : this(cifsMountConfiguration: configuration) + { + } + } +} diff --git a/sdk/batch/Microsoft.Azure.Batch/src/ODATADetailLevel.cs b/sdk/batch/Microsoft.Azure.Batch/src/ODATADetailLevel.cs index 340a2d91a599..fb8d2fa9aa68 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/ODATADetailLevel.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/ODATADetailLevel.cs @@ -5,6 +5,7 @@ { using System; using System.Collections.Generic; + using System.Globalization; using Protocol.Models; /// @@ -143,6 +144,7 @@ public ODATADetailLevelIntercept(ODATADetailLevel odataDetaillevel) base.ModificationInterceptHandler = SetODATAPredicates; } + [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2208:VariableNamesShouldNotMatchFieldNames")] private void SetODATAPredicates(Protocol.IBatchRequest request) { IODataFilter filterOptions = request.Options as IODataFilter; @@ -156,7 +158,7 @@ private void SetODATAPredicates(Protocol.IBatchRequest request) else if (!string.IsNullOrEmpty(this._details.FilterClause)) { //Note: We explicitly set this to be "detailLevel" for clarity for the customer even though at this scope there is no detailLevel param - throw new ArgumentException(string.Format(BatchErrorMessages.TypeDoesNotSupportFilterClause, request.GetType()), "detailLevel"); + throw new ArgumentException(string.Format(CultureInfo.InvariantCulture, BatchErrorMessages.TypeDoesNotSupportFilterClause, request.GetType()), "detailLevel"); } if (expandOptions != null) @@ -166,7 +168,7 @@ private void SetODATAPredicates(Protocol.IBatchRequest request) else if (!string.IsNullOrEmpty(this._details.ExpandClause)) { //Note: We explicitly set this to be "detailLevel" for clarity for the customer even though at this scope there is no detailLevel param - throw new ArgumentException(string.Format(BatchErrorMessages.TypeDoesNotSupportExpandClause, request.GetType()), "detailLevel"); + throw new ArgumentException(string.Format(CultureInfo.InvariantCulture, BatchErrorMessages.TypeDoesNotSupportExpandClause, request.GetType()), "detailLevel"); } if (selectOptions != null) @@ -176,7 +178,7 @@ private void SetODATAPredicates(Protocol.IBatchRequest request) else if (!string.IsNullOrEmpty(this._details.SelectClause)) { //Note: We explicitly set this to be "detailLevel" for clarity for the customer even though at this scope there is no detailLevel param - throw new ArgumentException(string.Format(BatchErrorMessages.TypeDoesNotSupportSelectClause, request.GetType()), "detailLevel"); + throw new ArgumentException(string.Format(CultureInfo.InvariantCulture, BatchErrorMessages.TypeDoesNotSupportSelectClause, request.GetType()), "detailLevel"); } } } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/PropertyAccessController.cs b/sdk/batch/Microsoft.Azure.Batch/src/PropertyAccessController.cs index fb380b39f2ac..c57166c7dd4c 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/PropertyAccessController.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/PropertyAccessController.cs @@ -4,6 +4,7 @@ namespace Microsoft.Azure.Batch { using System; + using System.Globalization; /// /// Controls access to a set of properties. All reads/writes pass through here. @@ -38,7 +39,7 @@ public T ReadProperty(Func propertyReadAction, BindingAccess allowedAccess { if (!this.IsAccessAllowed(BindingAccess.Read, allowedAccess)) { - throw new InvalidOperationException(string.Format(BatchErrorMessages.PropertiesReadAccessViolation, propertyName, this.bindingState.ToString())); + throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, BatchErrorMessages.PropertiesReadAccessViolation, propertyName, this.bindingState.ToString())); } return propertyReadAction(); @@ -54,7 +55,7 @@ public void WriteProperty(Action propertyWriteAction, BindingAccess allowedAcces { if (!this.IsAccessAllowed(BindingAccess.Write, allowedAccess)) { - throw new InvalidOperationException(string.Format(BatchErrorMessages.PropertiesWriteAccessViolation, propertyName, this.bindingState.ToString())); + throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, BatchErrorMessages.PropertiesWriteAccessViolation, propertyName, this.bindingState.ToString())); } propertyWriteAction(); diff --git a/sdk/batch/Microsoft.Azure.Batch/src/Protocol/BatchSharedKeyCredential.cs b/sdk/batch/Microsoft.Azure.Batch/src/Protocol/BatchSharedKeyCredential.cs index 034cfd1bf044..a827f5603de1 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/Protocol/BatchSharedKeyCredential.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/Protocol/BatchSharedKeyCredential.cs @@ -1,7 +1,6 @@ // // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT License. See License.txt in the project root for license information. - // namespace Microsoft.Azure.Batch.Protocol @@ -9,6 +8,7 @@ namespace Microsoft.Azure.Batch.Protocol using System; using System.Collections.Generic; using System.Collections.Specialized; + using System.Globalization; using System.Linq; using System.Net; using System.Net.Http; @@ -66,7 +66,7 @@ public override Task ProcessHttpRequestAsync(HttpRequestMessage httpRequest, Can //First set ocp-date always if (!httpRequest.Headers.Contains(OCPDateHeaderString)) { - httpRequest.Headers.TryAddWithoutValidation(OCPDateHeaderString, string.Format("{0:R}", DateTime.UtcNow)); + httpRequest.Headers.TryAddWithoutValidation(OCPDateHeaderString, string.Format(CultureInfo.InvariantCulture, "{0:R}", DateTime.UtcNow)); } // Set Headers diff --git a/sdk/batch/Microsoft.Azure.Batch/src/Protocol/BatchTokenProvider.cs b/sdk/batch/Microsoft.Azure.Batch/src/Protocol/BatchTokenProvider.cs index 439cd7fe21ab..33f1c0e49975 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/Protocol/BatchTokenProvider.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/Protocol/BatchTokenProvider.cs @@ -17,6 +17,10 @@ public class BatchTokenProvider : ITokenProvider private Func> TokenProvider { get; } + /// + /// Initializes a new instance of the class. + /// + /// A token provider function which retrieves an AAD token. public BatchTokenProvider(Func> tokenProvider) { this.TokenProvider = tokenProvider; diff --git a/sdk/batch/Microsoft.Azure.Batch/src/StartTask.cs b/sdk/batch/Microsoft.Azure.Batch/src/StartTask.cs index 2fbc0610bbdb..d5e68a2d0c3b 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/StartTask.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/StartTask.cs @@ -7,6 +7,9 @@ public partial class StartTask { + /// + /// Initializes a new instance of the class. + /// public StartTask() : this(commandLine: null) { } diff --git a/sdk/batch/Microsoft.Azure.Batch/src/TaskStateMonitor.cs b/sdk/batch/Microsoft.Azure.Batch/src/TaskStateMonitor.cs index 8836ded3def1..23968eafa3ba 100644 --- a/sdk/batch/Microsoft.Azure.Batch/src/TaskStateMonitor.cs +++ b/sdk/batch/Microsoft.Azure.Batch/src/TaskStateMonitor.cs @@ -5,6 +5,7 @@ { using System; using System.Collections.Generic; + using System.Globalization; using System.Threading; using System.Threading.Tasks; @@ -92,7 +93,7 @@ await this.WhenAllImplAsync( if (cancellationException.CancellationToken == tokenSource.Token) { throw new TimeoutException( - string.Format(BatchErrorMessages.ODataMonitorTimedOut, timeout), + string.Format(CultureInfo.InvariantCulture, BatchErrorMessages.ODataMonitorTimedOut, timeout), cancellationException); } diff --git a/sdk/batch/Microsoft.Azure.Batch/tests/IntegrationTests/CloudPoolIntegrationTests.cs b/sdk/batch/Microsoft.Azure.Batch/tests/IntegrationTests/CloudPoolIntegrationTests.cs index 6d4c53053bc0..2886980e4e4b 100644 --- a/sdk/batch/Microsoft.Azure.Batch/tests/IntegrationTests/CloudPoolIntegrationTests.cs +++ b/sdk/batch/Microsoft.Azure.Batch/tests/IntegrationTests/CloudPoolIntegrationTests.cs @@ -23,6 +23,9 @@ namespace BatchClientIntegrationTests using Xunit; using Xunit.Abstractions; using Protocol = Microsoft.Azure.Batch.Protocol; + using Microsoft.WindowsAzure.Storage; + using Microsoft.WindowsAzure.Storage.Auth; + using Microsoft.WindowsAzure.Storage.Blob; public class CloudPoolIntegrationTests { @@ -1074,6 +1077,68 @@ public void ListSupportedImages() SynchronizationContextHelper.RunTest(test, timeout: TimeSpan.FromSeconds(60)); } + [Fact] + [LiveTest] + [Trait(TestTraits.Duration.TraitName, TestTraits.Duration.Values.ShortDuration)] + public async Task CreatePool_WithBlobFuseMountConfiguration() + { + Func test = async () => + { + using (BatchClient batchCli = await TestUtilities.OpenBatchClientFromEnvironmentAsync().ConfigureAwait(false)) + { + string poolId = TestUtilities.GenerateResourceId(); + + const string containerName = "blobfusecontainer"; + StagingStorageAccount storageAccount = TestUtilities.GetStorageCredentialsFromEnvironment(); + CloudStorageAccount cloudStorageAccount = new CloudStorageAccount( + new StorageCredentials(storageAccount.StorageAccount, storageAccount.StorageAccountKey), + blobEndpoint: storageAccount.BlobUri, + queueEndpoint: null, + tableEndpoint: null, + fileEndpoint: null); + CloudBlobClient blobClient = cloudStorageAccount.CreateCloudBlobClient(); + + var container = blobClient.GetContainerReference(containerName); + await container.CreateIfNotExistsAsync(); + + try + { + var imageDetails = IaasLinuxPoolFixture.GetUbuntuImageDetails(batchCli); + + CloudPool pool = batchCli.PoolOperations.CreatePool( + poolId, + PoolFixture.VMSize, + new VirtualMachineConfiguration( + imageDetails.ImageReference, + imageDetails.NodeAgentSkuId)); + + pool.MountConfiguration = new List + { + new MountConfiguration( + new AzureBlobFileSystemConfiguration( + storageAccount.StorageAccount, + containerName, + "foo", + AzureStorageAuthenticationKey.FromAccountKey(storageAccount.StorageAccountKey))) + }; + + await pool.CommitAsync().ConfigureAwait(false); + await pool.RefreshAsync().ConfigureAwait(false); + + Assert.NotNull(pool.MountConfiguration); + Assert.NotEmpty(pool.MountConfiguration); + Assert.Equal(storageAccount.StorageAccount, pool.MountConfiguration.Single().AzureBlobFileSystemConfiguration.AccountName); + Assert.Equal(containerName, pool.MountConfiguration.Single().AzureBlobFileSystemConfiguration.ContainerName); + } + finally + { + await TestUtilities.DeletePoolIfExistsAsync(batchCli, poolId).ConfigureAwait(false); + } + } + }; + await SynchronizationContextHelper.RunTestAsync(test, TestTimeout); + } + #region Test helpers /// diff --git a/sdk/core/Azure.Core/src/Azure.Core.csproj b/sdk/core/Azure.Core/src/Azure.Core.csproj index 395497e9db03..ee3f2f6005dc 100644 --- a/sdk/core/Azure.Core/src/Azure.Core.csproj +++ b/sdk/core/Azure.Core/src/Azure.Core.csproj @@ -6,6 +6,11 @@ Microsoft Azure Client Pipeline diff --git a/sdk/core/Microsoft.Extensions.Azure/src/Microsoft.Extensions.Azure.csproj b/sdk/core/Microsoft.Extensions.Azure/src/Microsoft.Extensions.Azure.csproj index 0c26e74acae8..e10fdb82f22b 100644 --- a/sdk/core/Microsoft.Extensions.Azure/src/Microsoft.Extensions.Azure.csproj +++ b/sdk/core/Microsoft.Extensions.Azure/src/Microsoft.Extensions.Azure.csproj @@ -7,8 +7,9 @@ 1.0.0 Microsoft Azure Client Pipeline AspNetCore Extensions - + Added TokenCredential support. + Added client version support. + Added default client support. @@ -22,6 +23,7 @@ + @@ -29,9 +31,6 @@ - - - - + diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/CHANGELOG.md b/sdk/eventhub/Azure.Messaging.EventHubs/CHANGELOG.md index ea41b80cb848..7cca38403cbe 100755 --- a/sdk/eventhub/Azure.Messaging.EventHubs/CHANGELOG.md +++ b/sdk/eventhub/Azure.Messaging.EventHubs/CHANGELOG.md @@ -1,6 +1,47 @@ -# Release History +# Release History + +## 5.0.0-preview.2 (2019-08-06) + +### General + +- Public members of type `DateTime` were converted to `DateTimeOffset` to explicitly represent that they are UTC + +- Members of type `DateTimeOffset` have had the `Utc` suffix removed from their names, as the `DateTimeOffset` type removes ambiguity about the time zone + +- Members representing a partition offset that were incorrectly exposed as `string` have been converted to `int` to provide a unified type. + +- Renamed all instances of `EventHubPath` to `EventHubName` to align with the usage context and unify on the chosen semantics across the client library for different languages. + +- Ongoing minor tweaks to formatting, wording, and spelling of documentation and XML document comments. + +### Publishing events + +- Reintroduced the `EventDataBatch`, allowing for publication of a batch of events with known size constraint. This is intended to ensure that publishers can build batches without the potential for an error when sending and to allow publishers with bandwidth concerns to control the size of each batch published. + +- Enhanced the `EventHubProducer` to allow creation of an `EventDataBatch` and to accept them for publication. + +### Consuming events + +- Added a means to subscribe to the events exposed by an `EventHubConsumer` in the form of an asynchronous iterator. Using the iterator, consumers are able to use the familiar `foreach` pattern to enumerate events as they are available and process them. Optionally, consumers may specify a maximum time to wait for events to arrive which, when exceeded, will emit a null event if none were available, returning control to the loop and allowing cancellation or other processing needs. + +- Introduced the initial concept of a new version of the `EventProcessor`, intended as a neutral framework for processing events across all partitions for a given Event Hub and in the context of a specific Consumer Group. This early preview is intended to allow consumers to test the new design using a single instance that does not persist checkpoints to any durable store. + +### Exceptions + +- Created an exception hierarchy that incorporates the exceptions exposed by the legacy client library, covering the same set of scenarios with minor changes to naming to better clarify the context. + +- Ensured that custom Event Hubs exceptions are properly translated to the new versions, no longer exposing legacy exception types. + +### Retries and timeouts + +- Removed the exposed retry policies in favor of a set of retry options based on the options found in `Azure.Core` in order to keep the API familiar. + +- An abstract `EventHubsRetryPolicy` has been created to serve as the contract for custom retry policy implementations. + +- An option for fixed retry has been added to accompany the exponential retry that was in place previously. +Operation timeouts have been moved from the associated client options and incorporated into the retry options and retry policies. ## 5.0.0-preview.1 (2019-07-01) -Version 5.0.0-preview.1 is a preview of our efforts in creating a client library that is developer-friendly, idiomatic to the .NET ecosystem, and as consistent across different languages and platforms as possible. The principles that guide our efforts can be found in the [Azure SDK Design Guidelines for .NET](https://azuresdkspecs.z5.web.core.windows.net/DotNetSpec.html). +Version 5.0.0-preview.1 is a preview of our efforts in creating a client library that is developer-friendly, idiomatic to the .NET ecosystem, and as consistent across different languages and platforms as possible. The principles that guide our efforts can be found in the [Azure SDK Design Guidelines for .NET](https://azure.github.io/azure-sdk/dotnet_introduction.html). For more information, please visit: [https://aka.ms/azure-sdk-preview1-net](https://aka.ms/azure-sdk-preview1-net). \ No newline at end of file diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/README.md b/sdk/eventhub/Azure.Messaging.EventHubs/README.md index 1486bf6a550e..8a1b5ef0db66 100755 --- a/sdk/eventhub/Azure.Messaging.EventHubs/README.md +++ b/sdk/eventhub/Azure.Messaging.EventHubs/README.md @@ -99,9 +99,9 @@ await using (EventHubProducer producer = client.CreateProducer()) } ``` -### Consume events from an Event Hub +### Consume events from an Event Hub partition -In order to consume events, you'll need to create an `EventHubConsumer` for a specific partition and consumer group combination. When an Event Hub is created, it starts with a default consumer group that can be used to get started. A consumer also needs to specify where in the event stream to begin receiving events; in our example, we will focus on reading all published events in a partition. +In order to consume events for an Event Hub partition, you'll need to create an `EventHubConsumer` for that partition and consumer group combination. When an Event Hub is created, it provides a default consumer group that can be used to get started. A consumer also needs to specify where in the event stream to begin receiving events; in our example, we will focus on reading all published events in a partition using an iterator. ```csharp var connectionString = "<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>"; @@ -115,20 +115,76 @@ await using (var client = new EventHubClient(connectionString, eventHubName)) await using (EventHubConsumer consumer = client.CreateConsumer(consumerGroup, firstPartition, startingPosition)) { - int maximumEventBatchSize = 25; - IEnumerable eventBatch = await consumer.Receive(maximumEventBatchSize); - - // At this point, the eventBatch may have no events or may have as many as the maximum size requested, - // depending on how many events were available in the partition. + using CancellationTokenSource cancellationSource = new CancellationTokenSource(); + cancellationSource.CancelAfter(TimeSpan.FromSeconds(45)); + + await foreach (EventData receivedEvent in consumer.SubcribeToEvents(cancellationSource.Token)) + { + // At this point, the loop will wait for events to be available in the partition. When an event + // is available, the loop will iterate with the received event available. Because we did not + // specify a maximum wait time, the loop will wait forever unless cancellation is requested using + // the cancellation token. + } } } ``` +### Consume events using an Event Processor + +To consume events for all partitions of an Event Hub, you'll create an `EventProcessor` for a specific consumer group. When an Event Hub is created, it provides a default consumer group that can be used to get started. + +The `EventProcessor` will delegate processing of events to a `IPartitionProcessor` implementation that you provide, allowing your logic to focus on the logic needed to provide value while the processor holds responsibility for managing the underlying consumer operations. In our example, we will focus on building the `EventProcessor` and use a very minimal partition processor that does no actual processing. + +```csharp +public class SimplePartitionProcessor : IPartitionProcessor +{ + public Task InitializeAsync() => Task.CompletedTask; + public Task CloseAsync((PartitionProcessorCloseReason reason) => Task.CompletedTask; + public Task ProcessEventsAsync(IEnumerable events, CancellationToken cancellationToken) => Task.CompletedTask; + public Task ProcessErrorAsync(Exception exception, CancellationToken cancellationToken) => Task.CompletedTask; +} + +// This function is used by the EventProcessor to create a new partition processor for each partition of the +// Event Hub. +// +// Its implementation may take various forms, such as a local function (as illustrated), a class or +// static method, an inline lambda, or a variable of type Func. + +IPartitionProcessor SimpleProcessorFactory(PartitionContext context, CheckpointManager manager) +{ + return new SimplePartitionProcessor(); +} + +var connectionString = "<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>"; +var eventHubName = "<< NAME OF THE EVENT HUB >>"; + +await using (var client = new EventHubClient(connectionString, eventHubName)) +{ + string consumerGroup = EventHubConsumer.DefaultConsumerGroup; + PartitionManager partitionManager = new InMemoryPartitionManager(Console.WriteLine); + + EventProcessor processor = new EventProcessor(consumerGroup, client, SimpleProcessorFactory); + await processor.StartAsync(); + + // At this point, the processor is consuming events from each partition of the Event Hub and + // delegating them to the SimplePartitionProcessor instance created for that partition. This + // processing takes place in the background and will not block. + // + // It is important to note that the processor does not own the EventHubClient that was passed into it. + // You are responsible for ensuring that it is disposed after processing. It is also important that it + // not be closed or disposed during the time that the EventProcessor is running. + // + // In this example, we'll stop processing after five minutes. + + await Task.Delay(TimeSpan.FromMinutes(5)); + await processor.StopAsync(); +} +``` ## Troubleshooting ### Common exceptions -#### Operation Cancelled +#### Operation Canceled This occurs when an operation has been requested on a client, producer, or consumer that has already been closed or disposed of. It is recommended to check the application code and ensure that objects from the Event Hubs client library are created and closed/disposed in the intended scope. @@ -154,32 +210,43 @@ Each of the samples is self-contained and focused on illustrating one specific s The available samples are: -- [Hello world](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample1_HelloWorld.cs) +- [Hello world](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample01_HelloWorld.cs) An introduction to Event Hubs, illustrating how to connect and query the service. -- [Create an Event Hub client with custom options](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample2_ClientWithCustomOptions.cs) +- [Create an Event Hub client with custom options](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample02_ClientWithCustomOptions.cs) An introduction to Event Hubs, exploring additional options for creating an Event Hub client. -- [Publish an event to an Event Hub](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample3_PublishAnEvent3.cs) +- [Publish an event to an Event Hub](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample03_PublishAnEvent.cs) An introduction to publishing events, using a simple Event Hub producer. -- [Publish events using a partition key](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample4_PublishEventsWithPartitionKey.cs) +- [Publish events using a partition key](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample04_PublishEventsWithPartitionKey.cs) An introduction to publishing events, using a partition key to group them together. -- [Publish events to a specific Event Hub partition](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample5_PublishEventsToSpecificPartitions.cs) +- [Publish a size-limited batch of events](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample05_PublishAnEventBatch.cs) + An introduction to publishing events, using a size-aware batch to ensure the size does not exceed the transport size limits. + +- [Publish events to a specific Event Hub partition](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample06_PublishEventsToSpecificPartitions.cs) An introduction to publishing events, using an Event Hub producer that is associated with a specific partition. -- [Publish events with custom metadata](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample6_PublishEventsWithCustomMetadata.cs) +- [Publish events with custom metadata](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample07_PublishEventsWithCustomMetadata.cs) An example of publishing events, extending the event data with custom metadata. -- [Consume events from an Event Hub partition](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample7_ConsumeEvents.cs) +- [Consume events from an Event Hub partition](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample08_ConsumeEvents.cs) An introduction to consuming events, using a simple Event Hub consumer. -- [Consume events from an Event Hub partition in batches](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample8_ConsumeEventsByBatch.cs) +- [Consume events from an Event Hub partition, limiting the period of time to wait for an event](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample09_ConsumeEventsWithMaximumWaitTime.cs) + An introduction to consuming events, using an Event Hub consumer with maximum wait time. + +- [Consume events from a known position in the Event Hub partition](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample10_ConsumeEventsFromAKnownPosition.cs) + An example of consuming events, starting at a well-known position in the Event Hub partition. + +- [Consume events from an Event Hub partition in batches](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample11_ConsumeEventsByBatch.cs) + An example of consuming events, using a batch approach to control throughput. -- [Consume events from a known position in the Event Hub partition](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample9_ConsumeEventsFromAKnownPosition.cs) - An example of consuming events, starting at a well-known position in the Event Hub partition. +- [Consume events from all partitions of an Event Hub with the Event Processor](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample12_ConsumeEventsWithEventProcessor.cs) + + An example of consuming events from all Event Hub partitions at once, using the Event Processor. ## Contributing diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Program.cs b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Program.cs index eea43cb6c5c0..56d0d421f603 100755 --- a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Program.cs +++ b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Program.cs @@ -76,13 +76,10 @@ public static async Task Main(string[] args) } Console.WriteLine(); - Console.Write("Please enter the number of a sample to run or press \"X\" to exit: "); + var choice = ReadSelection(samples.Count); - var key = ReadSelection(samples.Count); - - if ((key == 'x') || (key == 'X')) + if (choice == null) { - Console.Write(key); Console.WriteLine(); Console.WriteLine(); Console.WriteLine("Quitting..."); @@ -91,18 +88,15 @@ public static async Task Main(string[] args) } else { - var choice = ((int)key); - - Console.Write(key); Console.WriteLine(); Console.WriteLine(); Console.WriteLine(); Console.WriteLine("-------------------------------------------------------------------------"); - Console.WriteLine($"Running: { samples[choice].Name }"); + Console.WriteLine($"Running: { samples[choice.Value].Name }"); Console.WriteLine("-------------------------------------------------------------------------"); Console.WriteLine(); - await samples[choice].RunAsync(parsedArgs.ConnectionString, parsedArgs.EventHub); + await samples[choice.Value].RunAsync(parsedArgs.ConnectionString, parsedArgs.EventHub); return; } } @@ -150,24 +144,26 @@ private static void DisplayHelp() /// /// The validated selection that was made. /// - private static char ReadSelection(int sampleCount) + private static int? ReadSelection(int sampleCount) { while(true) { - var key = Console.ReadKey(true); + Console.Write("Please enter the number of a sample to run or press \"X\" to exit: "); + + var value = Console.ReadLine(); - if ((key.KeyChar == 'x') || (key.KeyChar == 'X')) + if (String.Equals(value, "X", StringComparison.OrdinalIgnoreCase)) { - return key.KeyChar; + return null; } - if (Char.IsDigit(key.KeyChar)) + if (Int32.TryParse(value, out var choice)) { - var choice = ((int)Char.GetNumericValue(key.KeyChar) - 1); + --choice; if ((choice >= 0) && (choice < sampleCount)) { - return (char)choice; + return choice; } } } diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample1_HelloWorld.cs b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample01_HelloWorld.cs similarity index 92% rename from sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample1_HelloWorld.cs rename to sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample01_HelloWorld.cs index 470f9e6ac98e..00aa176f093b 100755 --- a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample1_HelloWorld.cs +++ b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample01_HelloWorld.cs @@ -12,13 +12,13 @@ namespace Azure.Messaging.EventHubs.Samples /// An introduction to Event Hubs, illustrating how to connect and query the service. /// /// - public class Sample1_HelloWorld : IEventHubsSample + public class Sample01_HelloWorld : IEventHubsSample { /// /// The name of the sample. /// /// - public string Name { get; } = nameof(Sample1_HelloWorld); + public string Name { get; } = nameof(Sample01_HelloWorld); /// /// A short description of the sample. @@ -38,7 +38,7 @@ public async Task RunAsync(string connectionString, { // To interact with Event Hubs, a client is needed. The client manages resources and should be // explicitly closed or disposed, but it is not necessary to do both. In our case, we will take - // advantage of the new asynchonous dispose to ensure that we clean up our client when we are + // advantage of the new asynchronous dispose to ensure that we clean up our client when we are // done or when an exception is encountered. await using (var client = new EventHubClient(connectionString, eventHubName)) @@ -60,7 +60,7 @@ public async Task RunAsync(string connectionString, { PartitionProperties partitionProperties = await client.GetPartitionPropertiesAsync(partitionId); - Console.WriteLine($"\tPartiton: { partitionProperties.Id }"); + Console.WriteLine($"\tPartition: { partitionProperties.Id }"); Console.WriteLine($"\t\tThe partition contains no events: { partitionProperties.IsEmpty }"); Console.WriteLine($"\t\tThe first sequence number of an event in the partition is: { partitionProperties.BeginningSequenceNumber }"); Console.WriteLine($"\t\tThe last sequence number of an event in the partition is: { partitionProperties.LastEnqueuedSequenceNumber }"); diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample2_ClientWithCustomOptions.cs b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample02_ClientWithCustomOptions.cs similarity index 94% rename from sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample2_ClientWithCustomOptions.cs rename to sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample02_ClientWithCustomOptions.cs index 8ee70bbbf686..f0c584437ce8 100755 --- a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample2_ClientWithCustomOptions.cs +++ b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample02_ClientWithCustomOptions.cs @@ -13,13 +13,13 @@ namespace Azure.Messaging.EventHubs.Samples /// An introduction to Event Hubs, exploring additional options for creating an . /// /// - public class Sample2_ClientWithCustomOptions : IEventHubsSample + public class Sample02_ClientWithCustomOptions : IEventHubsSample { /// /// The name of the sample. /// /// - public string Name { get; } = nameof(Sample2_ClientWithCustomOptions); + public string Name { get; } = nameof(Sample02_ClientWithCustomOptions); /// /// A short description of the sample. @@ -48,7 +48,7 @@ public async Task RunAsync(string connectionString, // The Event Hub client also allows you to customize how it connects to the service by specifying the specific transport that it // should communicate over and whether it should make use of a proxy for network communication. // - // Please note that the proxy is only supported when using Websockets as a transport; it isn't compatibile with raw TCP or other + // Please note that the proxy is only supported when using WebSockets as a transport; it isn't compatible with raw TCP or other // transport channels. var clientOptions = new EventHubClientOptions diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample3_PublishAnEvent.cs b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample03_PublishAnEvent.cs similarity index 92% rename from sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample3_PublishAnEvent.cs rename to sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample03_PublishAnEvent.cs index 00e878e28c16..41d8cbd217f0 100755 --- a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample3_PublishAnEvent.cs +++ b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample03_PublishAnEvent.cs @@ -12,13 +12,13 @@ namespace Azure.Messaging.EventHubs.Samples /// An introduction to publishing events, using a simple . /// /// - public class Sample3_PublishAnEvent : IEventHubsSample + public class Sample03_PublishAnEvent : IEventHubsSample { /// /// The name of the sample. /// /// - public string Name { get; } = nameof(Sample3_PublishAnEvent); + public string Name { get; } = nameof(Sample03_PublishAnEvent); /// /// A short description of the sample. @@ -41,7 +41,7 @@ public async Task RunAsync(string connectionString, // // Using our client, we will then create a producer. Like the client, our Event Hub producer also manages resources // and should be explicitly closed or disposed, but it is not necessary to do both. In our case, we will take - // advantage of the new asynchonous dispose to ensure that we clean up our client and producer when we are + // advantage of the new asynchronous dispose to ensure that we clean up our client and producer when we are // done or when an exception is encountered. await using (var client = new EventHubClient(connectionString, eventHubName)) @@ -63,7 +63,7 @@ public async Task RunAsync(string connectionString, var eventData = new EventData(Encoding.UTF8.GetBytes("Hello, Event Hubs!")); - // When the producer sends the event, it will receive an acknowedgement from the Event Hubs service; so + // When the producer sends the event, it will receive an acknowledgment from the Event Hubs service; so // long as there is no exception thrown by this call, the service is now responsible for delivery. Your // event data will be published to one of the Event Hub partitions, though there may be a (very) slight // delay until it is available to be consumed. diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample4_PublishEventsWithPartitionKey.cs b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample04_PublishEventsWithPartitionKey.cs similarity index 95% rename from sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample4_PublishEventsWithPartitionKey.cs rename to sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample04_PublishEventsWithPartitionKey.cs index 3b779982f418..c277b20a1f4c 100755 --- a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample4_PublishEventsWithPartitionKey.cs +++ b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample04_PublishEventsWithPartitionKey.cs @@ -12,13 +12,13 @@ namespace Azure.Messaging.EventHubs.Samples /// An introduction to publishing events, using a partition key to group them together. /// /// - public class Sample4_PublishEventsWithPartitionKey : IEventHubsSample + public class Sample04_PublishEventsWithPartitionKey : IEventHubsSample { /// /// The name of the sample. /// /// - public string Name { get; } = nameof(Sample4_PublishEventsWithPartitionKey); + public string Name { get; } = nameof(Sample04_PublishEventsWithPartitionKey); /// /// A short description of the sample. diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample05_PublishAnEventBatch.cs b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample05_PublishAnEventBatch.cs new file mode 100755 index 000000000000..d5a0599b9ccb --- /dev/null +++ b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample05_PublishAnEventBatch.cs @@ -0,0 +1,98 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System; +using System.Text; +using System.Threading.Tasks; +using Azure.Messaging.EventHubs.Samples.Infrastructure; + +namespace Azure.Messaging.EventHubs.Samples +{ + /// + /// An introduction to publishing events, using a size-aware batch to ensure the size + /// does not exceed the transport size limits. + /// + /// + public class Sample05_PublishAnEventBatch : IEventHubsSample + { + /// + /// The name of the sample. + /// + /// + public string Name { get; } = nameof(Sample05_PublishAnEventBatch); + + /// + /// A short description of the sample. + /// + /// + public string Description { get; } = "An introduction to publishing events, using a size-aware batch to ensure the size does not exceed the transport size limits."; + + /// + /// Runs the sample using the specified Event Hubs connection information. + /// + /// + /// The connection string for the Event Hubs namespace that the sample should target. + /// The name of the Event Hub, sometimes known as its path, that she sample should run against. + /// + public async Task RunAsync(string connectionString, + string eventHubName) + { + // We will start by creating a client and a producer, each using their default set of options. + + await using (var client = new EventHubClient(connectionString, eventHubName)) + await using (EventHubProducer producer = client.CreateProducer()) + { + // There is a limit to the size of an event or batch of events that can be published at once. This limit varies, and depends + // on the underlying transport and protocol that the Event Hub producer is using. Because the size limit is based on the + // size of an event or batch as it would be sent over the network, it is not simple to understand the size of an event as + // it is being created. For this reason, producers creating events with a large body or batching a large number of events + // may experience errors when they attempt to send. + // + // In order to avoid errors, support creation of known-good batches, and allow for producers with the need to predictably + // control bandwidth use, the Event Hub producer allows creation of an Event Data Batch, which acts as a container for + // a batch of events. Events can be added to the batch using a "TryAdd" pattern, allowing insight into when an event + // or batch would be too large without triggering an exception. + // + // An Event Data Batch can be created using a partition key or without one, following the same rules as the Event Hub + // producer with respect to partition routing. (see, Sample04_PublishEventsWithPartitionKey for more information.) + + // We will publish a batch of events based on simple sentences. + + var events = new EventData[] + { + new EventData(Encoding.UTF8.GetBytes("Hello, Event Hubs!")), + new EventData(Encoding.UTF8.GetBytes("Goodbye, Event Hubs!")), + new EventData(Encoding.UTF8.GetBytes("A third event, the plot thickens!")), + new EventData(Encoding.UTF8.GetBytes("...and a fourth too.")) + }; + + // When creating the batch, you may specify a custom set of options or allow the defaults to take precedence. + // If a size limit is not specified, the maximum size allowed by the transport is used. In this example, we + // will set a custom partition key and otherwise use the default options. + + BatchOptions options = new BatchOptions { PartitionKey = "This is a custom key!" }; + EventDataBatch batch = await producer.CreateBatchAsync(options); + + foreach (EventData eventData in events) + { + if (!batch.TryAdd(eventData)) + { + throw new ApplicationException("The events will not fit in the same batch."); + } + } + + // When publishing a batch, no SendOptions may be specified. Those options are + // all expressed upfront during batch creation and apply to all events in the batch. + + await producer.SendAsync(batch); + + Console.WriteLine("The event batch has been published."); + } + + // At this point, our client and producer have passed their "using" scope and have safely been disposed of. We + // have no further obligations. + + Console.WriteLine(); + } + } +} diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample5_PublishEventsToSpecificPartitions.cs b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample06_PublishEventsToSpecificPartitions.cs similarity index 94% rename from sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample5_PublishEventsToSpecificPartitions.cs rename to sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample06_PublishEventsToSpecificPartitions.cs index 1204262f3750..be98f8925d5b 100755 --- a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample5_PublishEventsToSpecificPartitions.cs +++ b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample06_PublishEventsToSpecificPartitions.cs @@ -12,13 +12,13 @@ namespace Azure.Messaging.EventHubs.Samples /// An introduction to publishing events, using an that is associated with a specific partition. /// /// - public class Sample5_PublishEventsToSpecificPartitions : IEventHubsSample + public class Sample06_PublishEventsToSpecificPartitions : IEventHubsSample { /// /// The name of the sample. /// /// - public string Name { get; } = nameof(Sample5_PublishEventsToSpecificPartitions); + public string Name { get; } = nameof(Sample06_PublishEventsToSpecificPartitions); /// /// A short description of the sample. @@ -41,7 +41,7 @@ public async Task RunAsync(string connectionString, await using (var client = new EventHubClient(connectionString, eventHubName)) { // Because partitions are owned by the Event Hubs service, it is not advised to assume that they have a stable - // and predictable set of identifiers. We'll inspect the Event Hub and select the first parition to use for + // and predictable set of identifiers. We'll inspect the Event Hub and select the first partition to use for // publishing our event batch. string[] partitionIds = await client.GetPartitionIdsAsync(); diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample6_PublishEventsWithCustomMetadata.cs b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample07_PublishEventsWithCustomMetadata.cs similarity index 95% rename from sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample6_PublishEventsWithCustomMetadata.cs rename to sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample07_PublishEventsWithCustomMetadata.cs index a73996e18272..0f749aa7da1c 100755 --- a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample6_PublishEventsWithCustomMetadata.cs +++ b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample07_PublishEventsWithCustomMetadata.cs @@ -12,13 +12,13 @@ namespace Azure.Messaging.EventHubs.Samples /// An example of publishing events, extending the event data with custom metadata. /// /// - public class Sample6_PublishEventsWithCustomMetadata : IEventHubsSample + public class Sample07_PublishEventsWithCustomMetadata : IEventHubsSample { /// /// The name of the sample. /// /// - public string Name { get; } = nameof(Sample6_PublishEventsWithCustomMetadata); + public string Name { get; } = nameof(Sample07_PublishEventsWithCustomMetadata); /// /// A short description of the sample. diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample7_ConsumeEvents.cs b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample08_ConsumeEvents.cs similarity index 71% rename from sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample7_ConsumeEvents.cs rename to sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample08_ConsumeEvents.cs index a9b87fa7bf2b..51d97cffaeb9 100755 --- a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample7_ConsumeEvents.cs +++ b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample08_ConsumeEvents.cs @@ -6,6 +6,7 @@ using System.Diagnostics; using System.Linq; using System.Text; +using System.Threading; using System.Threading.Tasks; using Azure.Messaging.EventHubs.Samples.Infrastructure; @@ -15,13 +16,13 @@ namespace Azure.Messaging.EventHubs.Samples /// An introduction to consuming events, using a simple . /// /// - public class Sample7_ConsumeEvents : IEventHubsSample + public class Sample08_ConsumeEvents : IEventHubsSample { /// /// The name of the sample. /// /// - public string Name { get; } = nameof(Sample7_ConsumeEvents); + public string Name { get; } = nameof(Sample08_ConsumeEvents); /// /// A short description of the sample. @@ -78,7 +79,7 @@ public async Task RunAsync(string connectionString, // because it opens its connection only when it needs to. The first receive that we ask of it will not see // any events, but will allow the consumer to start watching the partition. // - // Because the maximum wait time is specivied as zero, this call will return immediately and will not + // Because the maximum wait time is specified as zero, this call will return immediately and will not // have consumed any events. await consumer.ReceiveAsync(1, TimeSpan.Zero); @@ -89,40 +90,35 @@ public async Task RunAsync(string connectionString, await producer.SendAsync(new EventData(Encoding.UTF8.GetBytes("Hello, Event Hubs!"))); Console.WriteLine("The event batch has been published."); - // Because publishing and receving events is asynchronous, the events that we published may not + // Because publishing and receiving events is asynchronous, the events that we published may not // be immediately available for our consumer to see. // - // Each receive specifies the maximum amount of events that we would like in the batch and the maximum - // amount of time that we would like to wait for them. If there are enough events available to meet the - // requested amount, they'll be returned immediately. If not, the consumer will wait and collect events - // as they become available in an attempt to reach the requested amount. If the maximum time that we've - // allowed it to wait passes, the consumer will return the events that it has collected so far. - // - // Each Receive call may return between zero and the number of events that we requested, depending on the - // state of events in the partition. Likewise, it may return immediately or take up to the maximum wait - // time that we've allowed. - // - // We will ask for just our event, but allow a fairly long wait period to ensure that we're able to receive it. - // If you observe the time that the call takes, it is extremely likely that the request to receive will complete - // long before the maximum wait time. + // We will iterate over the available events in the partition, which should be just the event that we published. Because + // we're expecting only the one event, we will exit the loop when we receive it. To be sure that we do not block forever + // waiting on an event that is not published, we will specify a fairly long time to wait and then cancel waiting. + CancellationTokenSource cancellationSource = new CancellationTokenSource(); + cancellationSource.CancelAfter(TimeSpan.FromSeconds(30)); + + EventData receivedEvent = null; Stopwatch watch = Stopwatch.StartNew(); - IEnumerable receivedBatch = await consumer.ReceiveAsync(1, TimeSpan.FromSeconds(2.5)); - watch.Stop(); + + await foreach(EventData currentEvent in consumer.SubscribeToEvents(cancellationSource.Token)) + { + receivedEvent = currentEvent; + watch.Stop(); + break; + } // Print out the events that we received. Console.WriteLine(); - Console.WriteLine($"The following events were consumed in { watch.ElapsedMilliseconds } milliseconds:"); + Console.WriteLine($"The following event was consumed in { watch.ElapsedMilliseconds } milliseconds:"); - foreach (EventData eventData in receivedBatch) - { - // The body of our event was an encoded string; we'll recover the - // message by reversing the encoding process. + // The body of our event was an encoded string; we'll recover the message by reversing the encoding process. - string message = Encoding.UTF8.GetString(eventData.Body.ToArray()); - Console.WriteLine($"\tMessage: \"{ message }\""); - } + string message = (receivedEvent == null) ? "No event was received." : Encoding.UTF8.GetString(receivedEvent.Body.ToArray()); + Console.WriteLine($"\tMessage: \"{ message }\""); } } diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample09_ConsumeEventsWithMaximumWaitTime.cs b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample09_ConsumeEventsWithMaximumWaitTime.cs new file mode 100755 index 000000000000..777934ebc6d6 --- /dev/null +++ b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample09_ConsumeEventsWithMaximumWaitTime.cs @@ -0,0 +1,155 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Linq; +using System.Text; +using System.Threading; +using System.Threading.Tasks; +using Azure.Messaging.EventHubs.Samples.Infrastructure; + +namespace Azure.Messaging.EventHubs.Samples +{ + /// + /// An introduction to consuming events, using a simple . + /// + /// + public class Sample09_ConsumeEventsWithMaximumWaitTime : IEventHubsSample + { + /// + /// The name of the sample. + /// + /// + public string Name { get; } = nameof(Sample09_ConsumeEventsWithMaximumWaitTime); + + /// + /// A short description of the sample. + /// + /// + public string Description { get; } = "An introduction to consuming events, using an Event Hub consumer with maximum wait time."; + + /// + /// Runs the sample using the specified Event Hubs connection information. + /// + /// + /// The connection string for the Event Hubs namespace that the sample should target. + /// The name of the Event Hub, sometimes known as its path, that she sample should run against. + /// + public async Task RunAsync(string connectionString, + string eventHubName) + { + // An Event Hub consumer is associated with a specific Event Hub partition and a consumer group. The consumer group is + // a label that identifies one or more consumers as a set. Often, consumer groups are named after the responsibility + // of the consumer in an application, such as "Telemetry" or "OrderProcessing". When an Event Hub is created, a default + // consumer group is created with it, called "$Default." + // + // Each consumer has a unique view of the events in the partition, meaning that events are available to all consumers + // and are not removed from the partition when a consumer reads them. This allows for different consumers to read and + // process events from the partition at different speeds and beginning with different events without interfering with + // one another. + // + // When events are published, they will continue to exist in the partition and be available for consuming until they + // reach an age where they are older than the retention period. + // (see: https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-faq#what-is-the-maximum-retention-period-for-events) + // + // Because events are not removed from the partition when consuming, a consumer must specify where in the partition it + // would like to begin reading events. For example, this may be starting from the very beginning of the stream, at an + // offset from the beginning, the next event available after a specific point in time, or at a specific event. + + // We will start by creating a client using its default set of options. + + await using (var client = new EventHubClient(connectionString, eventHubName)) + { + // With our client, we can now inspect the partitions and find the identifier + // of the first. + + string firstPartition = (await client.GetPartitionIdsAsync()).First(); + + // In this example, we will create our consumer for the first partition in the Event Hub, using the default consumer group + // that is created with an Event Hub. Our consumer will begin watching the partition at the very end, reading only new events + // that we will publish for it. + + await using (EventHubConsumer consumer = client.CreateConsumer(EventHubConsumer.DefaultConsumerGroupName, firstPartition, EventPosition.Latest)) + await using (EventHubProducer producer = client.CreateProducer(new EventHubProducerOptions { PartitionId = firstPartition })) + { + // Because our consumer is reading from the latest position, it won't see events that have previously + // been published. Before we can publish the events, we will need to ask the consumer to perform an operation, + // because it opens its connection only when it needs to. The first receive that we ask of it will not see + // any events, but will allow the consumer to start watching the partition. + // + // Because the maximum wait time is specified as zero, this call will return immediately and will not + // have consumed any events. + + await consumer.ReceiveAsync(1, TimeSpan.Zero); + + // Now that the consumer is watching the partition, let's publish the events that we would like to + // receive. + + EventData[] eventsToPublish = new EventData[] + { + new EventData(Encoding.UTF8.GetBytes("Hello, Event Hubs!")), + new EventData(Encoding.UTF8.GetBytes("Goodbye, Event Hubs!")) + }; + + await producer.SendAsync(eventsToPublish); + Console.WriteLine("The event batch has been published."); + + // Because publishing and receiving events is asynchronous, the events that we published may not be immediately + // available for our consumer to see. We will iterate over the available events in the partition, which should be + // just the events that we published. + // + // When a maximum wait time is specified, the iteration will ensure that it returns control after that time has elapsed, + // whether or not an event is available in the partition. If no event was available a null value will be emitted instead. + // This is intended to return control to the loop and avoid blocking for an indeterminate period of time to allow event + // processors to verify that the iterator is still consuming the partition and to make decisions on whether or not to continue + // if events are not arriving. + // + // For this example, we will specify a maximum wait time, and won't exit the loop until we've received at least one more + // event than we published, which is expected to be a null value triggered by exceeding the wait time. + // + // To be sure that we do not end up in an infinite loop, we will specify a fairly long time to allow processing to complete + // then cancel. + + CancellationTokenSource cancellationSource = new CancellationTokenSource(); + cancellationSource.CancelAfter(TimeSpan.FromSeconds(30)); + + TimeSpan maximumWaitTime = TimeSpan.FromMilliseconds(250); + List receivedEvents = new List(); + Stopwatch watch = Stopwatch.StartNew(); + + await foreach(EventData currentEvent in consumer.SubscribeToEvents(maximumWaitTime, cancellationSource.Token)) + { + receivedEvents.Add(currentEvent); + + if (receivedEvents.Count > eventsToPublish.Length) + { + watch.Stop(); + break; + } + } + + // Print out the events that we received. + + Console.WriteLine(); + Console.WriteLine($"The following events were consumed in { watch.ElapsedMilliseconds } milliseconds:"); + + foreach (EventData eventData in receivedEvents) + { + // The body of our event was an encoded string; we'll recover the + // message by reversing the encoding process. + + string message = (eventData == null) ? "<< This was a null event >>" : Encoding.UTF8.GetString(eventData.Body.ToArray()); + Console.WriteLine($"\tMessage: \"{ message }\""); + } + } + } + + // At this point, our client, consumer, and producer have passed their "using" scope and have safely been disposed of. We + // have no further obligations. + + Console.WriteLine(); + } + } +} diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample9_ConsumeEventsFromAKnownPosition.cs b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample10_ConsumeEventsFromAKnownPosition.cs similarity index 82% rename from sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample9_ConsumeEventsFromAKnownPosition.cs rename to sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample10_ConsumeEventsFromAKnownPosition.cs index 4faa9b38c4f1..b699d97d54aa 100755 --- a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample9_ConsumeEventsFromAKnownPosition.cs +++ b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample10_ConsumeEventsFromAKnownPosition.cs @@ -5,6 +5,7 @@ using System.Collections.Generic; using System.Linq; using System.Text; +using System.Threading; using System.Threading.Tasks; using Azure.Messaging.EventHubs.Samples.Infrastructure; @@ -14,13 +15,13 @@ namespace Azure.Messaging.EventHubs.Samples /// An example of consuming events, starting at a well-known position in the Event Hub partition. /// /// - public class Sample9_ConsumeEventsFromAKnownPosition : IEventHubsSample + public class Sample10_ConsumeEventsFromAKnownPosition : IEventHubsSample { /// /// The name of the sample. /// /// - public string Name { get; } = nameof(Sample9_ConsumeEventsFromAKnownPosition); + public string Name { get; } = nameof(Sample10_ConsumeEventsFromAKnownPosition); /// /// A short description of the sample. @@ -80,7 +81,7 @@ public async Task RunAsync(string connectionString, await using (EventHubConsumer initialConsumer = client.CreateConsumer(EventHubConsumer.DefaultConsumerGroupName, firstPartition, EventPosition.Latest)) { // The first receive that we ask of it will not see any events, but allows the consumer to start watching the partition. Because - // the maximum wait time is specivied as zero, this call will return immediately and will not have consumed any events. + // the maximum wait time is specified as zero, this call will return immediately and will not have consumed any events. await initialConsumer.ReceiveAsync(1, TimeSpan.Zero); @@ -96,23 +97,27 @@ public async Task RunAsync(string connectionString, await producer.SendAsync(eventBatch); Console.WriteLine($"The event batch with { eventBatchSize } events has been published."); - // We will consume the events in batches using the initial consumer until all of the published events - // have been received. + // We will consume the events until all of the published events have been received. var receivedEvents = new List(); - int consumeBatchSize = (int)Math.Floor(eventBatchSize / 5.0f); - int maximumAttempts = 15; - int attempts = 0; - while ((receivedEvents.Count < eventBatchSize) && (++attempts < maximumAttempts)) + CancellationTokenSource cancellationSource = new CancellationTokenSource(); + cancellationSource.CancelAfter(TimeSpan.FromSeconds(30)); + + await foreach (EventData currentEvent in initialConsumer.SubscribeToEvents(cancellationSource.Token)) { - receivedEvents.AddRange(await initialConsumer.ReceiveAsync(consumeBatchSize, TimeSpan.FromMilliseconds(25))); + receivedEvents.Add(currentEvent); + + if (receivedEvents.Count >= eventBatchSize) + { + break; + } } // Print out the events that we received. Console.WriteLine(); - Console.WriteLine($"The initial consumer processed { receivedEvents.Count } events of the { eventBatchSize } that were published."); + Console.WriteLine($"The initial consumer processed { receivedEvents.Count } events of the { eventBatchSize } that were published. { eventBatchSize } were expected."); foreach (EventData eventData in receivedEvents) { @@ -135,24 +140,29 @@ public async Task RunAsync(string connectionString, await using (EventHubConsumer newConsumer = client.CreateConsumer(EventHubConsumer.DefaultConsumerGroupName, firstPartition, EventPosition.FromSequenceNumber(thirdEvent.SequenceNumber))) { - // We will consume the events in batches using the new consumer until all of the published events - // have been received. + // We will consume the events using the new consumer until all of the published events have been received. + CancellationTokenSource cancellationSource = new CancellationTokenSource(); + cancellationSource.CancelAfter(TimeSpan.FromSeconds(30)); + + int expectedCount = (eventBatchSize - 3); var receivedEvents = new List(); - int consumeBatchSize = (int)Math.Floor(eventBatchSize / 3.0f); - int maximumAttempts = 10; - int attempts = 0; - while ((receivedEvents.Count < eventBatchSize) && (++attempts < maximumAttempts)) + await foreach (EventData currentEvent in newConsumer.SubscribeToEvents(cancellationSource.Token)) { - receivedEvents.AddRange(await newConsumer.ReceiveAsync(consumeBatchSize, TimeSpan.FromMilliseconds(25))); + receivedEvents.Add(currentEvent); + + if (receivedEvents.Count >= expectedCount) + { + break; + } } // Print out the events that we received. Console.WriteLine(); Console.WriteLine(); - Console.WriteLine($"The new consumer processed { receivedEvents.Count } events of the { eventBatchSize } that were published."); + Console.WriteLine($"The new consumer processed { receivedEvents.Count } events of the { eventBatchSize } that were published. { expectedCount } were expected."); foreach (EventData eventData in receivedEvents) { diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample8_ConsumeEventsByBatch.cs b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample11_ConsumeEventsByBatch.cs similarity index 94% rename from sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample8_ConsumeEventsByBatch.cs rename to sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample11_ConsumeEventsByBatch.cs index b3c2fbe06763..7b87022f3c9c 100755 --- a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample8_ConsumeEventsByBatch.cs +++ b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample11_ConsumeEventsByBatch.cs @@ -14,19 +14,19 @@ namespace Azure.Messaging.EventHubs.Samples /// An example of consuming events, using a batch approach to control throughput. /// /// - public class Sample8_ConsumeEventsByBatch : IEventHubsSample + public class Sample11_ConsumeEventsByBatch : IEventHubsSample { /// /// The name of the sample. /// /// - public string Name { get; } = nameof(Sample8_ConsumeEventsByBatch); + public string Name { get; } = nameof(Sample11_ConsumeEventsByBatch); /// /// A short description of the sample. /// /// - public string Description { get; } = "An example of consuming events, using a batch approach tocontrol throughput."; + public string Description { get; } = "An example of consuming events, using a batch approach to control throughput."; /// /// Runs the sample using the specified Event Hubs connection information. @@ -59,7 +59,7 @@ public async Task RunAsync(string connectionString, // because it opens its connection only when it needs to. The first receive that we ask of it will not see // any events, but will allow the consumer to start watching the partition. // - // Because the maximum wait time is specivied as zero, this call will return immediately and will not + // Because the maximum wait time is specified as zero, this call will return immediately and will not // have consumed any events. await consumer.ReceiveAsync(1, TimeSpan.Zero); @@ -88,9 +88,9 @@ public async Task RunAsync(string connectionString, // where some experimentation in the application context may prove helpful. // // Our example will attempt to read about 1/5 of the batch at a time, which should result in the need for 5 batches to - // be consumed. Because publishing and receving events is asynchronous, the events that we published may not be + // be consumed. Because publishing and receiving events is asynchronous, the events that we published may not be // immediately available for our consumer to see. To compensate, we will allow for a small number of extra attempts beyond - // the expected 5 to to be sure that we don't stop reading before we receive all of our events. + // the expected 5 to be sure that we don't stop reading before we receive all of our events. var receivedEvents = new List(); int consumeBatchSize = (int)Math.Floor(eventBatchSize / 5.0f); diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample12_ConsumeEventsWithEventProcessor.cs b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample12_ConsumeEventsWithEventProcessor.cs new file mode 100755 index 000000000000..e46d0d97043a --- /dev/null +++ b/sdk/eventhub/Azure.Messaging.EventHubs/samples/Sample12_ConsumeEventsWithEventProcessor.cs @@ -0,0 +1,51 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System; +using System.Threading.Tasks; +using Azure.Messaging.EventHubs.Samples.Infrastructure; + +namespace Azure.Messaging.EventHubs.Samples +{ + /// + /// An example of consuming events from all Event Hub partitions at once, using the Event Processor. + /// + /// + public class Sample12_ConsumeEventsWithEventProcessor : IEventHubsSample + { + /// + /// The name of the sample. + /// + /// + public string Name { get; } = nameof(Sample12_ConsumeEventsWithEventProcessor); + + /// + /// A short description of the sample. + /// + /// + public string Description { get; } = "An example of consuming events from all Event Hub partitions at once, using the Event Processor."; + + /// + /// Runs the sample using the specified Event Hubs connection information. + /// + /// + /// The connection string for the Event Hubs namespace that the sample should target. + /// The name of the Event Hub, sometimes known as its path, that she sample should run against. + /// + public async Task RunAsync(string connectionString, + string eventHubName) + { + // We will start by creating a client using its default set of options. + + await using (var client = new EventHubClient(connectionString, eventHubName)) + { + //TODO (caio, pri1): Populate the sample + } + + // At this point, our client, all consumers, and producer have passed their "using" scope and have safely been disposed of. We + // have no further obligations. + + Console.WriteLine(); + } + } +} diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/src/Compatibility/TrackOneEventHubConsumer.cs b/sdk/eventhub/Azure.Messaging.EventHubs/src/Compatibility/TrackOneEventHubConsumer.cs index 0a590cf07ff8..19bddb9e8372 100755 --- a/sdk/eventhub/Azure.Messaging.EventHubs/src/Compatibility/TrackOneEventHubConsumer.cs +++ b/sdk/eventhub/Azure.Messaging.EventHubs/src/Compatibility/TrackOneEventHubConsumer.cs @@ -75,7 +75,7 @@ public override void UpdateRetryPolicy(EventHubRetryPolicy newRetryPolicy) } /// - /// Receives a bach of from the the Event Hub partition. + /// Receives a batch of from the the Event Hub partition. /// /// /// The maximum number of messages to receive in this batch. diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/src/Core/BasicRetryPolicy.cs b/sdk/eventhub/Azure.Messaging.EventHubs/src/Core/BasicRetryPolicy.cs index b6c2a268a58d..80d8858f1f38 100755 --- a/sdk/eventhub/Azure.Messaging.EventHubs/src/Core/BasicRetryPolicy.cs +++ b/sdk/eventhub/Azure.Messaging.EventHubs/src/Core/BasicRetryPolicy.cs @@ -91,7 +91,7 @@ public BasicRetryPolicy(RetryOptions retryOptions) break; case RetryMode.Exponential: - retryDelay = CalculateExponentiayDelay(attemptCount, Options.Delay.TotalSeconds, baseJitterSeconds, s_random.Value); + retryDelay = CalculateExponentialDelay(attemptCount, Options.Delay.TotalSeconds, baseJitterSeconds, s_random.Value); break; default: @@ -156,7 +156,7 @@ private static bool ShouldRetryException(Exception exception) /// /// The recommended duration to delay before retrying; this value does not take the maximum delay or eligibility for retry into account. /// - private static TimeSpan CalculateExponentiayDelay(int attemptCount, + private static TimeSpan CalculateExponentialDelay(int attemptCount, double baseDelaySeconds, double baseJitterSeconds, Random random) => diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/Checkpoint.cs b/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/Checkpoint.cs index b6c05ed744b1..cd0bf7ca66af 100755 --- a/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/Checkpoint.cs +++ b/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/Checkpoint.cs @@ -60,12 +60,12 @@ public class Checkpoint /// The offset of the this checkpoint is associated with. /// The sequence number assigned to the this checkpoint is associated with. /// - public Checkpoint(string eventHubName, - string consumerGroup, - string ownerIdentifier, - string partitionId, - long offset, - long sequenceNumber) + internal Checkpoint(string eventHubName, + string consumerGroup, + string ownerIdentifier, + string partitionId, + long offset, + long sequenceNumber) { Guard.ArgumentNotNullOrEmpty(nameof(eventHubName), eventHubName); Guard.ArgumentNotNullOrEmpty(nameof(consumerGroup), consumerGroup); diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/EventProcessor.cs b/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/EventProcessor.cs index ce701f2c9b60..cb27f93dc7aa 100755 --- a/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/EventProcessor.cs +++ b/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/EventProcessor.cs @@ -85,6 +85,12 @@ public class EventProcessor /// Interacts with the storage system, dealing with ownership and checkpoints. /// The set of options to use for this event processor. /// + /// + /// Ownership of the is assumed to be responsibility of the caller; this + /// processor will delegate operations to it, but will not perform any clean-up tasks, such as closing or + /// disposing of the instance. + /// + /// public EventProcessor(string consumerGroup, EventHubClient eventHubClient, Func partitionProcessorFactory, diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/EventProcessorOptions.cs b/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/EventProcessorOptions.cs index ad350e6af4e7..d4f7685008a5 100755 --- a/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/EventProcessorOptions.cs +++ b/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/EventProcessorOptions.cs @@ -35,7 +35,7 @@ public int MaximumMessageCount set { - Guard.ArgumentInRange(nameof(MaximumMessageCount), _maximumMessageCount, 1, Int32.MaxValue); + Guard.ArgumentInRange(nameof(MaximumMessageCount), value, 1, Int32.MaxValue); _maximumMessageCount = value; } } @@ -52,7 +52,7 @@ public TimeSpan? MaximumReceiveWaitTime { if (value.HasValue) { - Guard.ArgumentNotNegative(nameof(MaximumReceiveWaitTime), _maximumReceiveWaitTime.Value); + Guard.ArgumentNotNegative(nameof(MaximumReceiveWaitTime), value.Value); } _maximumReceiveWaitTime = value; diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/InMemoryPartitionManager.cs b/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/InMemoryPartitionManager.cs new file mode 100644 index 000000000000..1f70b01abf33 --- /dev/null +++ b/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/InMemoryPartitionManager.cs @@ -0,0 +1,142 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System; +using System.Collections.Concurrent; +using System.Collections.Generic; +using System.Linq; +using System.Threading.Tasks; + +namespace Azure.Messaging.EventHubs.Processor +{ + /// + /// A non-volatile in-memory storage service that keeps track of checkpoints and ownership. It must + /// be used with a single instance. + /// + /// + public class InMemoryPartitionManager : PartitionManager + { + /// The primitive for synchronizing access during ownership claim. + private readonly object OwnershipClaimLock = new object(); + + /// The set of stored checkpoints. Partition ids are used as keys. + private ConcurrentDictionary Checkpoints; + + /// The set of stored ownership. Partition ids are used as keys. + private Dictionary Ownership; + + /// Logs activities performed by this partition manager. + private Action Logger; + + /// + /// Initializes a new instance of the class. + /// + /// + /// Logs activities performed by this partition manager. + /// + public InMemoryPartitionManager(Action logger = null) + { + Logger = logger; + + Checkpoints = new ConcurrentDictionary(); + Ownership = new Dictionary(); + } + + /// + /// Retrieves a complete ownership list from the in-memory storage service. + /// + /// + /// The name of the specific Event Hub the ownership are associated with, relative to the Event Hubs namespace that contains it. + /// The name of the consumer group the ownership are associated with. + /// + /// An enumerable containing all the existing ownership for the associated Event Hub and consumer group. + /// + public override Task> ListOwnershipAsync(string eventHubName, + string consumerGroup) + { + List ownershipList; + + lock(OwnershipClaimLock) + { + ownershipList = Ownership.Values + .Where(ownership => ownership.EventHubName == eventHubName && + ownership.ConsumerGroup == consumerGroup) + .ToList(); + } + + return Task.FromResult((IEnumerable)ownershipList); + } + + /// + /// Tries to claim a list of specified ownership. + /// + /// + /// An enumerable containing all the ownership to claim. + /// + /// An enumerable containing the successfully claimed ownership. + /// + public override Task> ClaimOwnershipAsync(IEnumerable partitionOwnership) + { + var claimedOwnership = new List(); + + // The following lock makes sure two different event processors won't try to claim ownership of a partition + // simultaneously. This approach prevents an ownership from being stolen just after being claimed. + + lock (OwnershipClaimLock) + { + foreach (var ownership in partitionOwnership) + { + var isClaimable = true; + + // In case the partition already has an owner, the ETags must match in order to claim it. + + if (Ownership.TryGetValue(ownership.PartitionId, out var currentOwnership)) + { + isClaimable = ownership.ETag == currentOwnership.ETag; + } + + if (isClaimable) + { + ownership.ETag = Guid.NewGuid().ToString(); + + Ownership[ownership.PartitionId] = ownership; + claimedOwnership.Add(ownership); + + Log($"Ownership with partition id = '{ownership.PartitionId}' claimed."); + } + else + { + Log($"Ownership with partition id = '{ownership.PartitionId}' is not claimable."); + } + } + } + + return Task.FromResult((IEnumerable)claimedOwnership); + } + + /// + /// Updates the checkpoint using the given information for the associated partition and consumer group in the in-memory storage service. + /// + /// + /// The checkpoint containing the information to be stored. + /// + /// A task to be resolved on when the operation has completed. + /// + public override Task UpdateCheckpointAsync(Checkpoint checkpoint) + { + Checkpoints[checkpoint.PartitionId] = checkpoint; + + Log($"Checkpoint with partition id = '{checkpoint.PartitionId}' updated."); + + return Task.CompletedTask; + } + + /// + /// Sends a log message to the current logger, if provided by the user. + /// + /// + /// The log message to send. + /// + private void Log(string message) => Logger?.Invoke(message); + } +} diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/PartitionManager.cs b/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/PartitionManager.cs index c703354ef645..534387bd2d43 100644 --- a/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/PartitionManager.cs +++ b/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/PartitionManager.cs @@ -36,7 +36,7 @@ public abstract Task> ListOwnershipAsync(string /// /// An enumerable containing all the ownership to claim. /// - /// An enumerable containing all the existing ownership for the associated Event Hub and consumer group. + /// An enumerable containing the successfully claimed ownership instances. /// public abstract Task> ClaimOwnershipAsync(IEnumerable partitionOwnership); diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/PartitionOwnership.cs b/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/PartitionOwnership.cs index 6d548384f22f..1a51b7d14431 100755 --- a/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/PartitionOwnership.cs +++ b/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/PartitionOwnership.cs @@ -68,7 +68,7 @@ public class PartitionOwnership /// The entity tag needed to update this ownership. /// /// - public string ETag { get; } + public string ETag { get; set; } /// /// Initializes a new instance of the class. diff --git a/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/PartitionPump.cs b/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/PartitionPump.cs index 50025a5bf208..584250330ba8 100755 --- a/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/PartitionPump.cs +++ b/sdk/eventhub/Azure.Messaging.EventHubs/src/Processor/PartitionPump.cs @@ -16,6 +16,9 @@ namespace Azure.Messaging.EventHubs.Processor /// internal class PartitionPump { + /// The used to verify whether an exception is retryable or not. + private static readonly BasicRetryPolicy RetryPolicy = new BasicRetryPolicy(new RetryOptions()); + /// The primitive for synchronizing access during start and close operations. private readonly SemaphoreSlim RunningTaskSemaphore = new SemaphoreSlim(1, 1); @@ -194,8 +197,6 @@ private async Task StopAsync(PartitionProcessorCloseReason reason) /// private async Task RunAsync(CancellationToken cancellationToken) { - var retryPolicy = new BasicRetryPolicy(new RetryOptions()); - while (!cancellationToken.IsCancellationRequested) { IEnumerable receivedEvents = null; @@ -210,7 +211,7 @@ private async Task RunAsync(CancellationToken cancellationToken) // Stop the pump if it's not a retryable exception. - if (retryPolicy.CalculateRetryDelay(exception, 1) == null) + if (RetryPolicy.CalculateRetryDelay(exception, 1) == null) { // StopAsync cannot be awaited in this method because it awaits RunningTask, so we would have a deadlock. // For this reason, StopAsync starts to run concurrently with this task. diff --git a/sdk/eventhub/Microsoft.Azure.EventHubs.ServiceFabricProcessor/src/Microsoft.Azure.EventHubs.ServiceFabricProcessor.csproj b/sdk/eventhub/Microsoft.Azure.EventHubs.ServiceFabricProcessor/src/Microsoft.Azure.EventHubs.ServiceFabricProcessor.csproj index 9047d487b8b3..7bea7d89539c 100755 --- a/sdk/eventhub/Microsoft.Azure.EventHubs.ServiceFabricProcessor/src/Microsoft.Azure.EventHubs.ServiceFabricProcessor.csproj +++ b/sdk/eventhub/Microsoft.Azure.EventHubs.ServiceFabricProcessor/src/Microsoft.Azure.EventHubs.ServiceFabricProcessor.csproj @@ -1,7 +1,7 @@  This is the next generation Azure Event Hubs .NET Standard Service Fabric Processor library, which integrates Event Hub event consumption with Service Fabric. For more information about Event Hubs, see https://azure.microsoft.com/en-us/services/event-hubs/ - 0.5.3 + 0.5.4 Azure;Event Hubs;EventHubs;.NET;AMQP;IoT https://github.com/Azure/azure-event-hubs-dotnet/releases $(OutputPath)$(TargetFramework)Microsoft.Azure.EventHubs.Processor.xml diff --git a/sdk/identity/Azure.Identity/src/Azure.Identity.csproj b/sdk/identity/Azure.Identity/src/Azure.Identity.csproj index b4019fa5db07..cbdd917201c6 100644 --- a/sdk/identity/Azure.Identity/src/Azure.Identity.csproj +++ b/sdk/identity/Azure.Identity/src/Azure.Identity.csproj @@ -7,6 +7,10 @@ Microsoft Azure Identity diff --git a/sdk/keyvault/Azure.Security.KeyVault.Secrets/src/Azure.Security.KeyVault.Secrets.csproj b/sdk/keyvault/Azure.Security.KeyVault.Secrets/src/Azure.Security.KeyVault.Secrets.csproj index 99851117fa17..980ad852d91f 100644 --- a/sdk/keyvault/Azure.Security.KeyVault.Secrets/src/Azure.Security.KeyVault.Secrets.csproj +++ b/sdk/keyvault/Azure.Security.KeyVault.Secrets/src/Azure.Security.KeyVault.Secrets.csproj @@ -6,7 +6,8 @@ 4.0.0 Microsoft Azure Key Vault Secrets - For release notes and more information please visit https://aka.ms/azure-sdk-preview1-net + Update Azure.Core version to 1.0.0-preview.7. + Added distributed tracing support. $(RequiredTargetFrameworks) diff --git a/sdk/search/Microsoft.Azure.Search.Service/src/Generated/Models/WebApiHttpHeaders.cs b/sdk/search/Microsoft.Azure.Search.Service/src/Generated/Models/WebApiHttpHeaders.cs deleted file mode 100644 index 96d54d97a0b8..000000000000 --- a/sdk/search/Microsoft.Azure.Search.Service/src/Generated/Models/WebApiHttpHeaders.cs +++ /dev/null @@ -1,50 +0,0 @@ -// -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. See License.txt in the project root for -// license information. -// -// Code generated by Microsoft (R) AutoRest Code Generator. -// Changes may cause incorrect behavior and will be lost if the code is -// regenerated. -// - -namespace Microsoft.Azure.Search.Models -{ - using Newtonsoft.Json; - using System.Collections; - using System.Collections.Generic; - using System.Linq; - - public partial class WebApiHttpHeaders - { - /// - /// Initializes a new instance of the WebApiHttpHeaders class. - /// - public WebApiHttpHeaders() - { - CustomInit(); - } - - /// - /// Initializes a new instance of the WebApiHttpHeaders class. - /// - /// A dictionary of http request headers. - public WebApiHttpHeaders(IDictionary headers = default(IDictionary)) - { - Headers = headers; - CustomInit(); - } - - /// - /// An initialization method that performs custom operations like setting defaults - /// - partial void CustomInit(); - - /// - /// Gets or sets a dictionary of http request headers. - /// - [JsonProperty(PropertyName = "headers")] - public IDictionary Headers { get; set; } - - } -} diff --git a/sdk/search/Microsoft.Azure.Search.Service/src/Generated/Models/WebApiSkill.cs b/sdk/search/Microsoft.Azure.Search.Service/src/Generated/Models/WebApiSkill.cs index 2c6ee1c193bf..2488243b4bce 100644 --- a/sdk/search/Microsoft.Azure.Search.Service/src/Generated/Models/WebApiSkill.cs +++ b/sdk/search/Microsoft.Azure.Search.Service/src/Generated/Models/WebApiSkill.cs @@ -20,7 +20,7 @@ namespace Microsoft.Azure.Search.Models /// A skill that can call a Web API endpoint, allowing you to extend a /// skillset by having it call your custom code. /// /// [Newtonsoft.Json.JsonObject("#Microsoft.Skills.Custom.WebApiSkill")] @@ -43,19 +43,19 @@ public WebApiSkill() /// Azure Search index, or a value that can be consumed as an input by /// another skill. /// The url for the Web API. - /// The headers required to make the http - /// request. - /// The method for the http request. /// The description of the skill which /// describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take /// place, such as the document root or document content (for example, /// /document or /document/content). The default is /document. + /// The headers required to make the http + /// request. + /// The method for the http request. /// The desired timeout for the request. Default /// is 30 seconds. /// The desired batch size which indicates /// number of documents. - public WebApiSkill(IList inputs, IList outputs, string uri, WebApiHttpHeaders httpHeaders, string httpMethod, string description = default(string), string context = default(string), System.TimeSpan? timeout = default(System.TimeSpan?), int? batchSize = default(int?)) + public WebApiSkill(IList inputs, IList outputs, string uri, string description = default(string), string context = default(string), IDictionary httpHeaders = default(IDictionary), string httpMethod = default(string), System.TimeSpan? timeout = default(System.TimeSpan?), int? batchSize = default(int?)) : base(inputs, outputs, description, context) { Uri = uri; @@ -81,7 +81,7 @@ public WebApiSkill() /// Gets or sets the headers required to make the http request. /// [JsonProperty(PropertyName = "httpHeaders")] - public WebApiHttpHeaders HttpHeaders { get; set; } + public IDictionary HttpHeaders { get; set; } /// /// Gets or sets the method for the http request. @@ -116,14 +116,6 @@ public override void Validate() { throw new ValidationException(ValidationRules.CannotBeNull, "Uri"); } - if (HttpHeaders == null) - { - throw new ValidationException(ValidationRules.CannotBeNull, "HttpHeaders"); - } - if (HttpMethod == null) - { - throw new ValidationException(ValidationRules.CannotBeNull, "HttpMethod"); - } } } } diff --git a/sdk/search/Microsoft.Azure.Search.Service/src/Generated/SdkInfo_SearchServiceClient.cs b/sdk/search/Microsoft.Azure.Search.Service/src/Generated/SdkInfo_SearchServiceClient.cs index d5e93f38fadd..c701347d433f 100644 --- a/sdk/search/Microsoft.Azure.Search.Service/src/Generated/SdkInfo_SearchServiceClient.cs +++ b/sdk/search/Microsoft.Azure.Search.Service/src/Generated/SdkInfo_SearchServiceClient.cs @@ -31,10 +31,10 @@ public static IEnumerable> ApiInfo_SearchServiceCl // BEGIN: Code Generation Metadata Section public static readonly String AutoRestVersion = "latest"; public static readonly String AutoRestBootStrapperVersion = "autorest@2.0.4283"; - public static readonly String AutoRestCmdExecuted = "cmd.exe /c autorest.cmd https://github.com/Azure/azure-rest-api-specs/blob/master/specification/search/data-plane/Microsoft.Azure.Search.Service/readme.md --csharp --version=latest --reflect-api-versions --csharp-sdks-folder=C:\\repos\\azure-sdk-for-net\\sdk"; + public static readonly String AutoRestCmdExecuted = "cmd.exe /c autorest.cmd https://github.com/Azure/azure-rest-api-specs/blob/master/specification/search/data-plane/Microsoft.Azure.Search.Service/readme.md --csharp --version=latest --reflect-api-versions --csharp-sdks-folder=D:\\src\\azure-sdk-for-net\\sdk"; public static readonly String GithubForkName = "Azure"; public static readonly String GithubBranchName = "master"; - public static readonly String GithubCommidId = "a28a3fca492d332b0e515f0017551cb692772b29"; + public static readonly String GithubCommidId = "39c47bb0623a056d760175c63688d688e0020faa"; public static readonly String CodeGenerationErrors = ""; public static readonly String GithubRepoName = "azure-rest-api-specs"; // END: Code Generation Metadata Section diff --git a/sdk/search/Microsoft.Azure.Search/tests/SessionRecords/Microsoft.Azure.Search.Tests.SkillsetsTests/CreateSkillsetReturnsCorrectDefinitionWebApiSkillWithHeaders.json b/sdk/search/Microsoft.Azure.Search/tests/SessionRecords/Microsoft.Azure.Search.Tests.SkillsetsTests/CreateSkillsetReturnsCorrectDefinitionWebApiSkillWithHeaders.json new file mode 100644 index 000000000000..6823149124ab --- /dev/null +++ b/sdk/search/Microsoft.Azure.Search/tests/SessionRecords/Microsoft.Azure.Search.Tests.SkillsetsTests/CreateSkillsetReturnsCorrectDefinitionWebApiSkillWithHeaders.json @@ -0,0 +1,537 @@ +{ + "Entries": [ + { + "RequestUri": "/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/providers/Microsoft.Search/register?api-version=2016-09-01", + "EncodedRequestUri": "L3N1YnNjcmlwdGlvbnMvM2M3MjliMmEtNGY4Ni00YmIyLWFiZTgtNGI4NjQ3YWYxNTZjL3Byb3ZpZGVycy9NaWNyb3NvZnQuU2VhcmNoL3JlZ2lzdGVyP2FwaS12ZXJzaW9uPTIwMTYtMDktMDE=", + "RequestMethod": "POST", + "RequestBody": "", + "RequestHeaders": { + "x-ms-client-request-id": [ + "9213c2b3-936e-47df-af42-1522bc3182eb" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.27617.04", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.17763.", + "Microsoft.Azure.Management.ResourceManager.ResourceManagementClient/1.5.0.0" + ] + }, + "ResponseHeaders": { + "Cache-Control": [ + "no-cache" + ], + "Pragma": [ + "no-cache" + ], + "x-ms-ratelimit-remaining-subscription-writes": [ + "1199" + ], + "x-ms-request-id": [ + "7d45dbc2-7585-4ab3-b288-d4e6a3665e47" + ], + "x-ms-correlation-request-id": [ + "7d45dbc2-7585-4ab3-b288-d4e6a3665e47" + ], + "x-ms-routing-request-id": [ + "NORTHEUROPE:20190802T180947Z:7d45dbc2-7585-4ab3-b288-d4e6a3665e47" + ], + "Strict-Transport-Security": [ + "max-age=31536000; includeSubDomains" + ], + "X-Content-Type-Options": [ + "nosniff" + ], + "Date": [ + "Fri, 02 Aug 2019 18:09:46 GMT" + ], + "Content-Length": [ + "2230" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Expires": [ + "-1" + ] + }, + "ResponseBody": "{\r\n \"id\": \"/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/providers/Microsoft.Search\",\r\n \"namespace\": \"Microsoft.Search\",\r\n \"authorization\": {\r\n \"applicationId\": \"804f4a7a-7d6e-4df7-bf8c-e7f0106e16c2\",\r\n \"roleDefinitionId\": \"20FA3191-87CF-4C3D-9510-74CCB594A310\"\r\n },\r\n \"resourceTypes\": [\r\n {\r\n \"resourceType\": \"searchServices\",\r\n \"locations\": [\r\n \"West US\",\r\n \"East US\"\r\n ],\r\n \"apiVersions\": [\r\n \"2015-08-19\",\r\n \"2015-02-28\",\r\n \"2014-07-31-Preview\"\r\n ],\r\n \"capabilities\": \"CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SystemAssignedResourceIdentity\"\r\n },\r\n {\r\n \"resourceType\": \"searchServicesCit\",\r\n \"locations\": [\r\n \"West US\"\r\n ],\r\n \"apiVersions\": [\r\n \"2015-08-19\",\r\n \"2015-02-28\",\r\n \"2014-07-31-Preview\"\r\n ],\r\n \"capabilities\": \"CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SystemAssignedResourceIdentity\"\r\n },\r\n {\r\n \"resourceType\": \"searchServicesInt\",\r\n \"locations\": [\r\n \"West US\"\r\n ],\r\n \"apiVersions\": [\r\n \"2015-08-19\",\r\n \"2015-02-28\",\r\n \"2014-07-31-Preview\"\r\n ],\r\n \"capabilities\": \"CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SystemAssignedResourceIdentity\"\r\n },\r\n {\r\n \"resourceType\": \"searchServicesPpe\",\r\n \"locations\": [\r\n \"West US\"\r\n ],\r\n \"apiVersions\": [\r\n \"2015-08-19\",\r\n \"2015-02-28\",\r\n \"2014-07-31-Preview\"\r\n ],\r\n \"capabilities\": \"CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SystemAssignedResourceIdentity\"\r\n },\r\n {\r\n \"resourceType\": \"checkServiceNameAvailability\",\r\n \"locations\": [],\r\n \"apiVersions\": [\r\n \"2015-02-28\",\r\n \"2014-07-31-Preview\"\r\n ]\r\n },\r\n {\r\n \"resourceType\": \"checkServiceNameAvailabilityCit\",\r\n \"locations\": [],\r\n \"apiVersions\": [\r\n \"2015-02-28\",\r\n \"2014-07-31-Preview\"\r\n ]\r\n },\r\n {\r\n \"resourceType\": \"checkServiceNameAvailabilityInt\",\r\n \"locations\": [],\r\n \"apiVersions\": [\r\n \"2015-02-28\",\r\n \"2014-07-31-Preview\"\r\n ]\r\n },\r\n {\r\n \"resourceType\": \"checkServiceNameAvailabilityPpe\",\r\n \"locations\": [],\r\n \"apiVersions\": [\r\n \"2015-02-28\",\r\n \"2014-07-31-Preview\"\r\n ]\r\n },\r\n {\r\n \"resourceType\": \"checkNameAvailability\",\r\n \"locations\": [],\r\n \"apiVersions\": [\r\n \"2015-08-19\"\r\n ]\r\n },\r\n {\r\n \"resourceType\": \"checkNameAvailabilityCit\",\r\n \"locations\": [],\r\n \"apiVersions\": [\r\n \"2015-08-19\"\r\n ]\r\n },\r\n {\r\n \"resourceType\": \"checkNameAvailabilityInt\",\r\n \"locations\": [],\r\n \"apiVersions\": [\r\n \"2015-08-19\"\r\n ]\r\n },\r\n {\r\n \"resourceType\": \"checkNameAvailabilityPpe\",\r\n \"locations\": [],\r\n \"apiVersions\": [\r\n \"2015-08-19\"\r\n ]\r\n },\r\n {\r\n \"resourceType\": \"resourceHealthMetadata\",\r\n \"locations\": [],\r\n \"apiVersions\": [\r\n \"2015-08-19\"\r\n ]\r\n },\r\n {\r\n \"resourceType\": \"operations\",\r\n \"locations\": [],\r\n \"apiVersions\": [\r\n \"2015-08-19\",\r\n \"2015-02-28\"\r\n ]\r\n }\r\n ],\r\n \"registrationState\": \"Registered\"\r\n}", + "StatusCode": 200 + }, + { + "RequestUri": "/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourcegroups/azsmnet2527?api-version=2016-09-01", + "EncodedRequestUri": "L3N1YnNjcmlwdGlvbnMvM2M3MjliMmEtNGY4Ni00YmIyLWFiZTgtNGI4NjQ3YWYxNTZjL3Jlc291cmNlZ3JvdXBzL2F6c21uZXQyNTI3P2FwaS12ZXJzaW9uPTIwMTYtMDktMDE=", + "RequestMethod": "PUT", + "RequestBody": "{\r\n \"location\": \"West US\"\r\n}", + "RequestHeaders": { + "x-ms-client-request-id": [ + "09e9c6b5-7249-4b19-bc2a-299dfc8867c4" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.27617.04", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.17763.", + "Microsoft.Azure.Management.ResourceManager.ResourceManagementClient/1.5.0.0" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "29" + ] + }, + "ResponseHeaders": { + "Cache-Control": [ + "no-cache" + ], + "Pragma": [ + "no-cache" + ], + "x-ms-ratelimit-remaining-subscription-writes": [ + "1199" + ], + "x-ms-request-id": [ + "26eb8bce-b4d2-4558-9687-1fe3ec0d2c41" + ], + "x-ms-correlation-request-id": [ + "26eb8bce-b4d2-4558-9687-1fe3ec0d2c41" + ], + "x-ms-routing-request-id": [ + "NORTHEUROPE:20190802T180950Z:26eb8bce-b4d2-4558-9687-1fe3ec0d2c41" + ], + "Strict-Transport-Security": [ + "max-age=31536000; includeSubDomains" + ], + "X-Content-Type-Options": [ + "nosniff" + ], + "Date": [ + "Fri, 02 Aug 2019 18:09:50 GMT" + ], + "Content-Length": [ + "175" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Expires": [ + "-1" + ] + }, + "ResponseBody": "{\r\n \"id\": \"/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourceGroups/azsmnet2527\",\r\n \"name\": \"azsmnet2527\",\r\n \"location\": \"westus\",\r\n \"properties\": {\r\n \"provisioningState\": \"Succeeded\"\r\n }\r\n}", + "StatusCode": 201 + }, + { + "RequestUri": "/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourceGroups/azsmnet2527/providers/Microsoft.Search/searchServices/azs-3959?api-version=2015-08-19", + "EncodedRequestUri": "L3N1YnNjcmlwdGlvbnMvM2M3MjliMmEtNGY4Ni00YmIyLWFiZTgtNGI4NjQ3YWYxNTZjL3Jlc291cmNlR3JvdXBzL2F6c21uZXQyNTI3L3Byb3ZpZGVycy9NaWNyb3NvZnQuU2VhcmNoL3NlYXJjaFNlcnZpY2VzL2F6cy0zOTU5P2FwaS12ZXJzaW9uPTIwMTUtMDgtMTk=", + "RequestMethod": "PUT", + "RequestBody": "{\r\n \"sku\": {\r\n \"name\": \"free\"\r\n },\r\n \"location\": \"West US\"\r\n}", + "RequestHeaders": { + "x-ms-client-request-id": [ + "5fa819bb-565b-4c72-baaf-78117f11e3f4" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.27617.04", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.17763.", + "Microsoft.Azure.Management.Search.SearchManagementClient/3.0.0.0" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "67" + ] + }, + "ResponseHeaders": { + "Cache-Control": [ + "no-cache" + ], + "Pragma": [ + "no-cache" + ], + "ETag": [ + "W/\"datetime'2019-08-02T18%3A09%3A56.0192713Z'\"" + ], + "x-ms-request-id": [ + "5fa819bb-565b-4c72-baaf-78117f11e3f4" + ], + "request-id": [ + "5fa819bb-565b-4c72-baaf-78117f11e3f4" + ], + "elapsed-time": [ + "3537" + ], + "Strict-Transport-Security": [ + "max-age=31536000; includeSubDomains" + ], + "x-ms-ratelimit-remaining-subscription-writes": [ + "1194" + ], + "x-ms-correlation-request-id": [ + "9e3912a4-072e-4027-9980-26b19feafa46" + ], + "x-ms-routing-request-id": [ + "NORTHEUROPE:20190802T180956Z:9e3912a4-072e-4027-9980-26b19feafa46" + ], + "X-Content-Type-Options": [ + "nosniff" + ], + "Date": [ + "Fri, 02 Aug 2019 18:09:56 GMT" + ], + "Content-Length": [ + "385" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Expires": [ + "-1" + ] + }, + "ResponseBody": "{\r\n \"id\": \"/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourceGroups/azsmnet2527/providers/Microsoft.Search/searchServices/azs-3959\",\r\n \"name\": \"azs-3959\",\r\n \"type\": \"Microsoft.Search/searchServices\",\r\n \"location\": \"West US\",\r\n \"properties\": {\r\n \"replicaCount\": 1,\r\n \"partitionCount\": 1,\r\n \"status\": \"running\",\r\n \"statusDetails\": \"\",\r\n \"provisioningState\": \"succeeded\",\r\n \"hostingMode\": \"Default\"\r\n },\r\n \"sku\": {\r\n \"name\": \"free\"\r\n }\r\n}", + "StatusCode": 201 + }, + { + "RequestUri": "/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourceGroups/azsmnet2527/providers/Microsoft.Search/searchServices/azs-3959/listAdminKeys?api-version=2015-08-19", + "EncodedRequestUri": "L3N1YnNjcmlwdGlvbnMvM2M3MjliMmEtNGY4Ni00YmIyLWFiZTgtNGI4NjQ3YWYxNTZjL3Jlc291cmNlR3JvdXBzL2F6c21uZXQyNTI3L3Byb3ZpZGVycy9NaWNyb3NvZnQuU2VhcmNoL3NlYXJjaFNlcnZpY2VzL2F6cy0zOTU5L2xpc3RBZG1pbktleXM/YXBpLXZlcnNpb249MjAxNS0wOC0xOQ==", + "RequestMethod": "POST", + "RequestBody": "", + "RequestHeaders": { + "x-ms-client-request-id": [ + "18d267ad-6002-4353-971a-f0af356cf0e5" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.27617.04", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.17763.", + "Microsoft.Azure.Management.Search.SearchManagementClient/3.0.0.0" + ] + }, + "ResponseHeaders": { + "Cache-Control": [ + "no-cache" + ], + "Pragma": [ + "no-cache" + ], + "Vary": [ + "Accept-Encoding" + ], + "x-ms-request-id": [ + "18d267ad-6002-4353-971a-f0af356cf0e5" + ], + "request-id": [ + "18d267ad-6002-4353-971a-f0af356cf0e5" + ], + "elapsed-time": [ + "163" + ], + "Strict-Transport-Security": [ + "max-age=31536000; includeSubDomains" + ], + "x-ms-ratelimit-remaining-subscription-writes": [ + "1194" + ], + "x-ms-correlation-request-id": [ + "bdc94148-03c7-47af-a1d1-abc2a370ea27" + ], + "x-ms-routing-request-id": [ + "NORTHEUROPE:20190802T180958Z:bdc94148-03c7-47af-a1d1-abc2a370ea27" + ], + "X-Content-Type-Options": [ + "nosniff" + ], + "Date": [ + "Fri, 02 Aug 2019 18:09:57 GMT" + ], + "Content-Length": [ + "99" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Expires": [ + "-1" + ] + }, + "ResponseBody": "{\r\n \"primaryKey\": \"5D77864ED60F3042A8EACF0DF54C9C22\",\r\n \"secondaryKey\": \"BACF8EB5662F96DE4F5DC42AC03B5E0B\"\r\n}", + "StatusCode": 200 + }, + { + "RequestUri": "/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourceGroups/azsmnet2527/providers/Microsoft.Search/searchServices/azs-3959/listQueryKeys?api-version=2015-08-19", + "EncodedRequestUri": "L3N1YnNjcmlwdGlvbnMvM2M3MjliMmEtNGY4Ni00YmIyLWFiZTgtNGI4NjQ3YWYxNTZjL3Jlc291cmNlR3JvdXBzL2F6c21uZXQyNTI3L3Byb3ZpZGVycy9NaWNyb3NvZnQuU2VhcmNoL3NlYXJjaFNlcnZpY2VzL2F6cy0zOTU5L2xpc3RRdWVyeUtleXM/YXBpLXZlcnNpb249MjAxNS0wOC0xOQ==", + "RequestMethod": "GET", + "RequestBody": "", + "RequestHeaders": { + "x-ms-client-request-id": [ + "6d618234-aea1-498c-a08d-2258ebf67a0d" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.27617.04", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.17763.", + "Microsoft.Azure.Management.Search.SearchManagementClient/3.0.0.0" + ] + }, + "ResponseHeaders": { + "Cache-Control": [ + "no-cache" + ], + "Pragma": [ + "no-cache" + ], + "Vary": [ + "Accept-Encoding" + ], + "x-ms-request-id": [ + "6d618234-aea1-498c-a08d-2258ebf67a0d" + ], + "request-id": [ + "6d618234-aea1-498c-a08d-2258ebf67a0d" + ], + "elapsed-time": [ + "97" + ], + "Strict-Transport-Security": [ + "max-age=31536000; includeSubDomains" + ], + "x-ms-ratelimit-remaining-subscription-reads": [ + "14997" + ], + "x-ms-correlation-request-id": [ + "948ef8b2-d452-4721-a9f6-41ba748163ed" + ], + "x-ms-routing-request-id": [ + "NORTHEUROPE:20190802T180959Z:948ef8b2-d452-4721-a9f6-41ba748163ed" + ], + "X-Content-Type-Options": [ + "nosniff" + ], + "Date": [ + "Fri, 02 Aug 2019 18:09:58 GMT" + ], + "Content-Length": [ + "82" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Expires": [ + "-1" + ] + }, + "ResponseBody": "{\r\n \"value\": [\r\n {\r\n \"name\": null,\r\n \"key\": \"4BC3CC5CEB8C99544010F030826FCB0C\"\r\n }\r\n ],\r\n \"nextLink\": null\r\n}", + "StatusCode": 200 + }, + { + "RequestUri": "/skillsets?api-version=2019-05-06", + "EncodedRequestUri": "L3NraWxsc2V0cz9hcGktdmVyc2lvbj0yMDE5LTA1LTA2", + "RequestMethod": "POST", + "RequestBody": "{\r\n \"name\": \"webapiskillset\",\r\n \"description\": \"Skillset for testing\",\r\n \"skills\": [\r\n {\r\n \"@odata.type\": \"#Microsoft.Skills.Custom.WebApiSkill\",\r\n \"uri\": \"https://contoso.example.org\",\r\n \"httpHeaders\": {\r\n \"x-ms-example\": \"example\"\r\n },\r\n \"httpMethod\": \"POST\",\r\n \"description\": \"A simple web api skill\",\r\n \"context\": \"/document\",\r\n \"inputs\": [\r\n {\r\n \"name\": \"text\",\r\n \"source\": \"/document/text\"\r\n }\r\n ],\r\n \"outputs\": [\r\n {\r\n \"name\": \"coolResult\",\r\n \"targetName\": \"myCoolResult\"\r\n }\r\n ]\r\n }\r\n ]\r\n}", + "RequestHeaders": { + "client-request-id": [ + "b42e2896-1d2e-4322-90a0-0610ac5915af" + ], + "Accept-Language": [ + "en-US" + ], + "api-key": [ + "5D77864ED60F3042A8EACF0DF54C9C22" + ], + "User-Agent": [ + "FxVersion/4.6.27617.04", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.17763.", + "Microsoft.Azure.Search.SearchServiceClient/10.0.0.0" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "633" + ] + }, + "ResponseHeaders": { + "Cache-Control": [ + "no-cache" + ], + "Pragma": [ + "no-cache" + ], + "ETag": [ + "W/\"0x8D71774A2493E08\"" + ], + "Location": [ + "https://azs-3959.search-dogfood.windows-int.net/skillsets('webapiskillset')?api-version=2019-05-06" + ], + "request-id": [ + "b42e2896-1d2e-4322-90a0-0610ac5915af" + ], + "elapsed-time": [ + "117" + ], + "OData-Version": [ + "4.0" + ], + "Preference-Applied": [ + "odata.include-annotations=\"*\"" + ], + "Strict-Transport-Security": [ + "max-age=15724800; includeSubDomains" + ], + "Date": [ + "Fri, 02 Aug 2019 18:09:59 GMT" + ], + "Content-Type": [ + "application/json; odata.metadata=minimal" + ], + "Expires": [ + "-1" + ], + "Content-Length": [ + "663" + ] + }, + "ResponseBody": "{\r\n \"@odata.context\": \"https://azs-3959.search-dogfood.windows-int.net/$metadata#skillsets/$entity\",\r\n \"@odata.etag\": \"\\\"0x8D71774A2493E08\\\"\",\r\n \"name\": \"webapiskillset\",\r\n \"description\": \"Skillset for testing\",\r\n \"skills\": [\r\n {\r\n \"@odata.type\": \"#Microsoft.Skills.Custom.WebApiSkill\",\r\n \"name\": null,\r\n \"description\": \"A simple web api skill\",\r\n \"context\": \"/document\",\r\n \"uri\": \"https://contoso.example.org\",\r\n \"httpMethod\": \"POST\",\r\n \"timeout\": null,\r\n \"batchSize\": null,\r\n \"degreeOfParallelism\": null,\r\n \"inputs\": [\r\n {\r\n \"name\": \"text\",\r\n \"source\": \"/document/text\",\r\n \"sourceContext\": null,\r\n \"inputs\": []\r\n }\r\n ],\r\n \"outputs\": [\r\n {\r\n \"name\": \"coolResult\",\r\n \"targetName\": \"myCoolResult\"\r\n }\r\n ],\r\n \"httpHeaders\": {\r\n \"x-ms-example\": \"example\"\r\n }\r\n }\r\n ],\r\n \"cognitiveServices\": null\r\n}", + "StatusCode": 201 + }, + { + "RequestUri": "/skillsets('webapiskillset')?api-version=2019-05-06", + "EncodedRequestUri": "L3NraWxsc2V0cygnd2ViYXBpc2tpbGxzZXQnKT9hcGktdmVyc2lvbj0yMDE5LTA1LTA2", + "RequestMethod": "DELETE", + "RequestBody": "", + "RequestHeaders": { + "client-request-id": [ + "a94b0dd3-6dcc-42ab-a434-d5323955f655" + ], + "Accept-Language": [ + "en-US" + ], + "api-key": [ + "5D77864ED60F3042A8EACF0DF54C9C22" + ], + "User-Agent": [ + "FxVersion/4.6.27617.04", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.17763.", + "Microsoft.Azure.Search.SearchServiceClient/10.0.0.0" + ] + }, + "ResponseHeaders": { + "Cache-Control": [ + "no-cache" + ], + "Pragma": [ + "no-cache" + ], + "request-id": [ + "a94b0dd3-6dcc-42ab-a434-d5323955f655" + ], + "elapsed-time": [ + "75" + ], + "Strict-Transport-Security": [ + "max-age=15724800; includeSubDomains" + ], + "Date": [ + "Fri, 02 Aug 2019 18:09:59 GMT" + ], + "Expires": [ + "-1" + ] + }, + "ResponseBody": "", + "StatusCode": 204 + }, + { + "RequestUri": "/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourceGroups/azsmnet2527/providers/Microsoft.Search/searchServices/azs-3959?api-version=2015-08-19", + "EncodedRequestUri": "L3N1YnNjcmlwdGlvbnMvM2M3MjliMmEtNGY4Ni00YmIyLWFiZTgtNGI4NjQ3YWYxNTZjL3Jlc291cmNlR3JvdXBzL2F6c21uZXQyNTI3L3Byb3ZpZGVycy9NaWNyb3NvZnQuU2VhcmNoL3NlYXJjaFNlcnZpY2VzL2F6cy0zOTU5P2FwaS12ZXJzaW9uPTIwMTUtMDgtMTk=", + "RequestMethod": "DELETE", + "RequestBody": "", + "RequestHeaders": { + "x-ms-client-request-id": [ + "3da23ab4-03ba-4bc5-9e7e-cbf06fbd1d68" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.27617.04", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.17763.", + "Microsoft.Azure.Management.Search.SearchManagementClient/3.0.0.0" + ] + }, + "ResponseHeaders": { + "Cache-Control": [ + "no-cache" + ], + "Pragma": [ + "no-cache" + ], + "x-ms-request-id": [ + "3da23ab4-03ba-4bc5-9e7e-cbf06fbd1d68" + ], + "request-id": [ + "3da23ab4-03ba-4bc5-9e7e-cbf06fbd1d68" + ], + "elapsed-time": [ + "1120" + ], + "Strict-Transport-Security": [ + "max-age=31536000; includeSubDomains" + ], + "x-ms-ratelimit-remaining-subscription-deletes": [ + "14997" + ], + "x-ms-correlation-request-id": [ + "76a03eb2-908a-47f8-939b-1baed6be9dda" + ], + "x-ms-routing-request-id": [ + "NORTHEUROPE:20190802T181004Z:76a03eb2-908a-47f8-939b-1baed6be9dda" + ], + "X-Content-Type-Options": [ + "nosniff" + ], + "Date": [ + "Fri, 02 Aug 2019 18:10:03 GMT" + ], + "Expires": [ + "-1" + ], + "Content-Length": [ + "0" + ] + }, + "ResponseBody": "", + "StatusCode": 200 + } + ], + "Names": { + "GenerateName": [ + "azsmnet2527" + ], + "GenerateServiceName": [ + "azs-3959" + ] + }, + "Variables": { + "SubscriptionId": "3c729b2a-4f86-4bb2-abe8-4b8647af156c" + } +} \ No newline at end of file diff --git a/sdk/search/Microsoft.Azure.Search/tests/SessionRecords/Microsoft.Azure.Search.Tests.SkillsetsTests/CreateSkillsetThrowsExceptionWithInvalidLanguageSelection.json b/sdk/search/Microsoft.Azure.Search/tests/SessionRecords/Microsoft.Azure.Search.Tests.SkillsetsTests/CreateSkillsetReturnsCorrectDefinitionWebApiSkillWithoutHeaders.json similarity index 64% rename from sdk/search/Microsoft.Azure.Search/tests/SessionRecords/Microsoft.Azure.Search.Tests.SkillsetsTests/CreateSkillsetThrowsExceptionWithInvalidLanguageSelection.json rename to sdk/search/Microsoft.Azure.Search/tests/SessionRecords/Microsoft.Azure.Search.Tests.SkillsetsTests/CreateSkillsetReturnsCorrectDefinitionWebApiSkillWithoutHeaders.json index 985692e98cfa..63a0171d544e 100644 --- a/sdk/search/Microsoft.Azure.Search/tests/SessionRecords/Microsoft.Azure.Search.Tests.SkillsetsTests/CreateSkillsetThrowsExceptionWithInvalidLanguageSelection.json +++ b/sdk/search/Microsoft.Azure.Search/tests/SessionRecords/Microsoft.Azure.Search.Tests.SkillsetsTests/CreateSkillsetReturnsCorrectDefinitionWebApiSkillWithoutHeaders.json @@ -7,13 +7,13 @@ "RequestBody": "", "RequestHeaders": { "x-ms-client-request-id": [ - "7cb1bc7b-29c2-4de1-a671-9a0c9172b724" + "6af5eba5-bc3a-4d45-ab56-f89c1e944051" ], - "accept-language": [ + "Accept-Language": [ "en-US" ], "User-Agent": [ - "FxVersion/4.6.26614.01", + "FxVersion/4.6.27617.04", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.17763.", "Microsoft.Azure.Management.ResourceManager.ResourceManagementClient/1.5.0.0" @@ -23,23 +23,20 @@ "Cache-Control": [ "no-cache" ], - "Date": [ - "Sat, 27 Apr 2019 22:13:08 GMT" - ], "Pragma": [ "no-cache" ], "x-ms-ratelimit-remaining-subscription-writes": [ - "1135" + "1198" ], "x-ms-request-id": [ - "9c5b4349-d76c-4070-90a0-fccb8d845bef" + "3db3415d-a19a-4cc0-bd92-27c31868da71" ], "x-ms-correlation-request-id": [ - "9c5b4349-d76c-4070-90a0-fccb8d845bef" + "3db3415d-a19a-4cc0-bd92-27c31868da71" ], "x-ms-routing-request-id": [ - "NORTHEUROPE:20190427T221309Z:9c5b4349-d76c-4070-90a0-fccb8d845bef" + "NORTHEUROPE:20190802T181108Z:3db3415d-a19a-4cc0-bd92-27c31868da71" ], "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" @@ -47,6 +44,9 @@ "X-Content-Type-Options": [ "nosniff" ], + "Date": [ + "Fri, 02 Aug 2019 18:11:08 GMT" + ], "Content-Length": [ "2230" ], @@ -61,19 +61,19 @@ "StatusCode": 200 }, { - "RequestUri": "/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourcegroups/azsmnet9505?api-version=2016-09-01", - "EncodedRequestUri": "L3N1YnNjcmlwdGlvbnMvM2M3MjliMmEtNGY4Ni00YmIyLWFiZTgtNGI4NjQ3YWYxNTZjL3Jlc291cmNlZ3JvdXBzL2F6c21uZXQ5NTA1P2FwaS12ZXJzaW9uPTIwMTYtMDktMDE=", + "RequestUri": "/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourcegroups/azsmnet3848?api-version=2016-09-01", + "EncodedRequestUri": "L3N1YnNjcmlwdGlvbnMvM2M3MjliMmEtNGY4Ni00YmIyLWFiZTgtNGI4NjQ3YWYxNTZjL3Jlc291cmNlZ3JvdXBzL2F6c21uZXQzODQ4P2FwaS12ZXJzaW9uPTIwMTYtMDktMDE=", "RequestMethod": "PUT", "RequestBody": "{\r\n \"location\": \"West US\"\r\n}", "RequestHeaders": { "x-ms-client-request-id": [ - "1dd6b340-0fb6-4aef-b7a3-58a05c909b0e" + "1f3cac2a-a040-48a1-b772-a299b453bff3" ], - "accept-language": [ + "Accept-Language": [ "en-US" ], "User-Agent": [ - "FxVersion/4.6.26614.01", + "FxVersion/4.6.27617.04", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.17763.", "Microsoft.Azure.Management.ResourceManager.ResourceManagementClient/1.5.0.0" @@ -89,23 +89,20 @@ "Cache-Control": [ "no-cache" ], - "Date": [ - "Sat, 27 Apr 2019 22:13:09 GMT" - ], "Pragma": [ "no-cache" ], "x-ms-ratelimit-remaining-subscription-writes": [ - "1135" + "1198" ], "x-ms-request-id": [ - "ac293731-9f49-42f8-82c2-32a061fb3496" + "647bde58-c9af-4172-99d0-e5b0f252b319" ], "x-ms-correlation-request-id": [ - "ac293731-9f49-42f8-82c2-32a061fb3496" + "647bde58-c9af-4172-99d0-e5b0f252b319" ], "x-ms-routing-request-id": [ - "NORTHEUROPE:20190427T221309Z:ac293731-9f49-42f8-82c2-32a061fb3496" + "NORTHEUROPE:20190802T181109Z:647bde58-c9af-4172-99d0-e5b0f252b319" ], "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" @@ -113,6 +110,9 @@ "X-Content-Type-Options": [ "nosniff" ], + "Date": [ + "Fri, 02 Aug 2019 18:11:09 GMT" + ], "Content-Length": [ "175" ], @@ -123,23 +123,23 @@ "-1" ] }, - "ResponseBody": "{\r\n \"id\": \"/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourceGroups/azsmnet9505\",\r\n \"name\": \"azsmnet9505\",\r\n \"location\": \"westus\",\r\n \"properties\": {\r\n \"provisioningState\": \"Succeeded\"\r\n }\r\n}", + "ResponseBody": "{\r\n \"id\": \"/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourceGroups/azsmnet3848\",\r\n \"name\": \"azsmnet3848\",\r\n \"location\": \"westus\",\r\n \"properties\": {\r\n \"provisioningState\": \"Succeeded\"\r\n }\r\n}", "StatusCode": 201 }, { - "RequestUri": "/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourceGroups/azsmnet9505/providers/Microsoft.Search/searchServices/azs-1742?api-version=2015-08-19", - "EncodedRequestUri": "L3N1YnNjcmlwdGlvbnMvM2M3MjliMmEtNGY4Ni00YmIyLWFiZTgtNGI4NjQ3YWYxNTZjL3Jlc291cmNlR3JvdXBzL2F6c21uZXQ5NTA1L3Byb3ZpZGVycy9NaWNyb3NvZnQuU2VhcmNoL3NlYXJjaFNlcnZpY2VzL2F6cy0xNzQyP2FwaS12ZXJzaW9uPTIwMTUtMDgtMTk=", + "RequestUri": "/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourceGroups/azsmnet3848/providers/Microsoft.Search/searchServices/azs-3786?api-version=2015-08-19", + "EncodedRequestUri": "L3N1YnNjcmlwdGlvbnMvM2M3MjliMmEtNGY4Ni00YmIyLWFiZTgtNGI4NjQ3YWYxNTZjL3Jlc291cmNlR3JvdXBzL2F6c21uZXQzODQ4L3Byb3ZpZGVycy9NaWNyb3NvZnQuU2VhcmNoL3NlYXJjaFNlcnZpY2VzL2F6cy0zNzg2P2FwaS12ZXJzaW9uPTIwMTUtMDgtMTk=", "RequestMethod": "PUT", "RequestBody": "{\r\n \"sku\": {\r\n \"name\": \"free\"\r\n },\r\n \"location\": \"West US\"\r\n}", "RequestHeaders": { "x-ms-client-request-id": [ - "95eefb54-81c0-4856-84ea-4777f0db81b7" + "3fe5d72a-1d94-4ee2-b091-12b15936e878" ], - "accept-language": [ + "Accept-Language": [ "en-US" ], "User-Agent": [ - "FxVersion/4.6.26614.01", + "FxVersion/4.6.27617.04", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.17763.", "Microsoft.Azure.Management.Search.SearchManagementClient/3.0.0.0" @@ -155,39 +155,39 @@ "Cache-Control": [ "no-cache" ], - "Date": [ - "Sat, 27 Apr 2019 22:13:12 GMT" - ], "Pragma": [ "no-cache" ], "ETag": [ - "W/\"datetime'2019-04-27T22%3A13%3A12.8017156Z'\"" + "W/\"datetime'2019-08-02T18%3A11%3A13.9211382Z'\"" ], "x-ms-request-id": [ - "95eefb54-81c0-4856-84ea-4777f0db81b7" + "3fe5d72a-1d94-4ee2-b091-12b15936e878" ], "request-id": [ - "95eefb54-81c0-4856-84ea-4777f0db81b7" + "3fe5d72a-1d94-4ee2-b091-12b15936e878" ], "elapsed-time": [ - "1711" + "2587" ], "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], "x-ms-ratelimit-remaining-subscription-writes": [ - "1150" + "1197" ], "x-ms-correlation-request-id": [ - "3df2bae6-31ea-4151-b326-63e93af2fbc9" + "7daa1b80-0d4d-4602-96c0-fce931ced549" ], "x-ms-routing-request-id": [ - "NORTHEUROPE:20190427T221313Z:3df2bae6-31ea-4151-b326-63e93af2fbc9" + "NORTHEUROPE:20190802T181115Z:7daa1b80-0d4d-4602-96c0-fce931ced549" ], "X-Content-Type-Options": [ "nosniff" ], + "Date": [ + "Fri, 02 Aug 2019 18:11:15 GMT" + ], "Content-Length": [ "385" ], @@ -198,23 +198,23 @@ "-1" ] }, - "ResponseBody": "{\r\n \"id\": \"/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourceGroups/azsmnet9505/providers/Microsoft.Search/searchServices/azs-1742\",\r\n \"name\": \"azs-1742\",\r\n \"type\": \"Microsoft.Search/searchServices\",\r\n \"location\": \"West US\",\r\n \"properties\": {\r\n \"replicaCount\": 1,\r\n \"partitionCount\": 1,\r\n \"status\": \"running\",\r\n \"statusDetails\": \"\",\r\n \"provisioningState\": \"succeeded\",\r\n \"hostingMode\": \"Default\"\r\n },\r\n \"sku\": {\r\n \"name\": \"free\"\r\n }\r\n}", + "ResponseBody": "{\r\n \"id\": \"/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourceGroups/azsmnet3848/providers/Microsoft.Search/searchServices/azs-3786\",\r\n \"name\": \"azs-3786\",\r\n \"type\": \"Microsoft.Search/searchServices\",\r\n \"location\": \"West US\",\r\n \"properties\": {\r\n \"replicaCount\": 1,\r\n \"partitionCount\": 1,\r\n \"status\": \"running\",\r\n \"statusDetails\": \"\",\r\n \"provisioningState\": \"succeeded\",\r\n \"hostingMode\": \"Default\"\r\n },\r\n \"sku\": {\r\n \"name\": \"free\"\r\n }\r\n}", "StatusCode": 201 }, { - "RequestUri": "/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourceGroups/azsmnet9505/providers/Microsoft.Search/searchServices/azs-1742/listAdminKeys?api-version=2015-08-19", - "EncodedRequestUri": "L3N1YnNjcmlwdGlvbnMvM2M3MjliMmEtNGY4Ni00YmIyLWFiZTgtNGI4NjQ3YWYxNTZjL3Jlc291cmNlR3JvdXBzL2F6c21uZXQ5NTA1L3Byb3ZpZGVycy9NaWNyb3NvZnQuU2VhcmNoL3NlYXJjaFNlcnZpY2VzL2F6cy0xNzQyL2xpc3RBZG1pbktleXM/YXBpLXZlcnNpb249MjAxNS0wOC0xOQ==", + "RequestUri": "/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourceGroups/azsmnet3848/providers/Microsoft.Search/searchServices/azs-3786/listAdminKeys?api-version=2015-08-19", + "EncodedRequestUri": "L3N1YnNjcmlwdGlvbnMvM2M3MjliMmEtNGY4Ni00YmIyLWFiZTgtNGI4NjQ3YWYxNTZjL3Jlc291cmNlR3JvdXBzL2F6c21uZXQzODQ4L3Byb3ZpZGVycy9NaWNyb3NvZnQuU2VhcmNoL3NlYXJjaFNlcnZpY2VzL2F6cy0zNzg2L2xpc3RBZG1pbktleXM/YXBpLXZlcnNpb249MjAxNS0wOC0xOQ==", "RequestMethod": "POST", "RequestBody": "", "RequestHeaders": { "x-ms-client-request-id": [ - "828b28a8-4afe-434c-a693-14ccc197d04e" + "c39f8421-de96-4d86-829e-a78d30e0ca5d" ], - "accept-language": [ + "Accept-Language": [ "en-US" ], "User-Agent": [ - "FxVersion/4.6.26614.01", + "FxVersion/4.6.27617.04", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.17763.", "Microsoft.Azure.Management.Search.SearchManagementClient/3.0.0.0" @@ -224,9 +224,6 @@ "Cache-Control": [ "no-cache" ], - "Date": [ - "Sat, 27 Apr 2019 22:13:16 GMT" - ], "Pragma": [ "no-cache" ], @@ -234,29 +231,32 @@ "Accept-Encoding" ], "x-ms-request-id": [ - "828b28a8-4afe-434c-a693-14ccc197d04e" + "c39f8421-de96-4d86-829e-a78d30e0ca5d" ], "request-id": [ - "828b28a8-4afe-434c-a693-14ccc197d04e" + "c39f8421-de96-4d86-829e-a78d30e0ca5d" ], "elapsed-time": [ - "300" + "428" ], "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], "x-ms-ratelimit-remaining-subscription-writes": [ - "1150" + "1197" ], "x-ms-correlation-request-id": [ - "2fb371c5-35d3-4e8c-bf68-0165eecea53d" + "a78fb19c-d83a-4272-86e0-b5dfff52cdde" ], "x-ms-routing-request-id": [ - "NORTHEUROPE:20190427T221316Z:2fb371c5-35d3-4e8c-bf68-0165eecea53d" + "NORTHEUROPE:20190802T181122Z:a78fb19c-d83a-4272-86e0-b5dfff52cdde" ], "X-Content-Type-Options": [ "nosniff" ], + "Date": [ + "Fri, 02 Aug 2019 18:11:22 GMT" + ], "Content-Length": [ "99" ], @@ -267,23 +267,23 @@ "-1" ] }, - "ResponseBody": "{\r\n \"primaryKey\": \"39E49E444496C863CC73A3CCE51855E5\",\r\n \"secondaryKey\": \"47D4B2FCCC32149C890C9993CD5FA8CB\"\r\n}", + "ResponseBody": "{\r\n \"primaryKey\": \"5CA77CE22AB2DBF2053E3695DE4A060C\",\r\n \"secondaryKey\": \"5F1F69710EED0AB5A7B3AF5D4DD16A39\"\r\n}", "StatusCode": 200 }, { - "RequestUri": "/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourceGroups/azsmnet9505/providers/Microsoft.Search/searchServices/azs-1742/listQueryKeys?api-version=2015-08-19", - "EncodedRequestUri": "L3N1YnNjcmlwdGlvbnMvM2M3MjliMmEtNGY4Ni00YmIyLWFiZTgtNGI4NjQ3YWYxNTZjL3Jlc291cmNlR3JvdXBzL2F6c21uZXQ5NTA1L3Byb3ZpZGVycy9NaWNyb3NvZnQuU2VhcmNoL3NlYXJjaFNlcnZpY2VzL2F6cy0xNzQyL2xpc3RRdWVyeUtleXM/YXBpLXZlcnNpb249MjAxNS0wOC0xOQ==", + "RequestUri": "/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourceGroups/azsmnet3848/providers/Microsoft.Search/searchServices/azs-3786/listQueryKeys?api-version=2015-08-19", + "EncodedRequestUri": "L3N1YnNjcmlwdGlvbnMvM2M3MjliMmEtNGY4Ni00YmIyLWFiZTgtNGI4NjQ3YWYxNTZjL3Jlc291cmNlR3JvdXBzL2F6c21uZXQzODQ4L3Byb3ZpZGVycy9NaWNyb3NvZnQuU2VhcmNoL3NlYXJjaFNlcnZpY2VzL2F6cy0zNzg2L2xpc3RRdWVyeUtleXM/YXBpLXZlcnNpb249MjAxNS0wOC0xOQ==", "RequestMethod": "GET", "RequestBody": "", "RequestHeaders": { "x-ms-client-request-id": [ - "04a1bd60-9a6b-4fe9-b33a-de8714515281" + "975bee14-c441-4078-983d-badd1273ef11" ], - "accept-language": [ + "Accept-Language": [ "en-US" ], "User-Agent": [ - "FxVersion/4.6.26614.01", + "FxVersion/4.6.27617.04", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.17763.", "Microsoft.Azure.Management.Search.SearchManagementClient/3.0.0.0" @@ -293,9 +293,6 @@ "Cache-Control": [ "no-cache" ], - "Date": [ - "Sat, 27 Apr 2019 22:13:16 GMT" - ], "Pragma": [ "no-cache" ], @@ -303,29 +300,32 @@ "Accept-Encoding" ], "x-ms-request-id": [ - "04a1bd60-9a6b-4fe9-b33a-de8714515281" + "975bee14-c441-4078-983d-badd1273ef11" ], "request-id": [ - "04a1bd60-9a6b-4fe9-b33a-de8714515281" + "975bee14-c441-4078-983d-badd1273ef11" ], "elapsed-time": [ - "420" + "612" ], "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], "x-ms-ratelimit-remaining-subscription-reads": [ - "14976" + "14999" ], "x-ms-correlation-request-id": [ - "5e2484e3-c4dd-4759-bb22-fde8df2c8f15" + "6377e9fc-dc10-44e8-88ee-15c5b4bc7a45" ], "x-ms-routing-request-id": [ - "NORTHEUROPE:20190427T221317Z:5e2484e3-c4dd-4759-bb22-fde8df2c8f15" + "NORTHEUROPE:20190802T181123Z:6377e9fc-dc10-44e8-88ee-15c5b4bc7a45" ], "X-Content-Type-Options": [ "nosniff" ], + "Date": [ + "Fri, 02 Aug 2019 18:11:23 GMT" + ], "Content-Length": [ "82" ], @@ -336,52 +336,55 @@ "-1" ] }, - "ResponseBody": "{\r\n \"value\": [\r\n {\r\n \"name\": null,\r\n \"key\": \"FEEA375B0A13B5D0E6F409131A28D8D2\"\r\n }\r\n ],\r\n \"nextLink\": null\r\n}", + "ResponseBody": "{\r\n \"value\": [\r\n {\r\n \"name\": null,\r\n \"key\": \"7B4A288D2D09176AC71449B034AF9134\"\r\n }\r\n ],\r\n \"nextLink\": null\r\n}", "StatusCode": 200 }, { "RequestUri": "/skillsets?api-version=2019-05-06", "EncodedRequestUri": "L3NraWxsc2V0cz9hcGktdmVyc2lvbj0yMDE5LTA1LTA2", "RequestMethod": "POST", - "RequestBody": "{\r\n \"name\": \"testskillset1\",\r\n \"description\": \"Skillset for testing\",\r\n \"skills\": [\r\n {\r\n \"@odata.type\": \"#Microsoft.Skills.Vision.OcrSkill\",\r\n \"textExtractionAlgorithm\": \"handwritten\",\r\n \"defaultLanguageCode\": \"fi\",\r\n \"description\": \"Tested OCR skill\",\r\n \"context\": \"/document\",\r\n \"inputs\": [\r\n {\r\n \"name\": \"url\",\r\n \"source\": \"/document/url\"\r\n },\r\n {\r\n \"name\": \"queryString\",\r\n \"source\": \"/document/queryString\"\r\n }\r\n ],\r\n \"outputs\": [\r\n {\r\n \"name\": \"text\",\r\n \"targetName\": \"mytext\"\r\n }\r\n ]\r\n },\r\n {\r\n \"@odata.type\": \"#Microsoft.Skills.Text.SentimentSkill\",\r\n \"defaultLanguageCode\": \"fi\",\r\n \"description\": \"Tested Sentiment skill\",\r\n \"context\": \"/document\",\r\n \"inputs\": [\r\n {\r\n \"name\": \"text\",\r\n \"source\": \"/document/mytext\"\r\n }\r\n ],\r\n \"outputs\": [\r\n {\r\n \"name\": \"score\",\r\n \"targetName\": \"mySentiment\"\r\n }\r\n ]\r\n }\r\n ]\r\n}", + "RequestBody": "{\r\n \"name\": \"webapiskillset\",\r\n \"description\": \"Skillset for testing\",\r\n \"skills\": [\r\n {\r\n \"@odata.type\": \"#Microsoft.Skills.Custom.WebApiSkill\",\r\n \"uri\": \"https://contoso.example.org\",\r\n \"httpMethod\": \"POST\",\r\n \"description\": \"A simple web api skill\",\r\n \"context\": \"/document\",\r\n \"inputs\": [\r\n {\r\n \"name\": \"text\",\r\n \"source\": \"/document/text\"\r\n }\r\n ],\r\n \"outputs\": [\r\n {\r\n \"name\": \"coolResult\",\r\n \"targetName\": \"myCoolResult\"\r\n }\r\n ]\r\n }\r\n ]\r\n}", "RequestHeaders": { "client-request-id": [ - "403779a1-f70f-4eb9-8149-c7269e8e0c30" + "68ff7b89-2808-486b-93c7-e08fa8991f6e" ], - "accept-language": [ + "Accept-Language": [ "en-US" ], "api-key": [ - "39E49E444496C863CC73A3CCE51855E5" + "5CA77CE22AB2DBF2053E3695DE4A060C" ], "User-Agent": [ - "FxVersion/4.6.26614.01", + "FxVersion/4.6.27617.04", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.17763.", - "Microsoft.Azure.Search.SearchServiceClient/9.0.0.0" + "Microsoft.Azure.Search.SearchServiceClient/10.0.0.0" ], "Content-Type": [ "application/json; charset=utf-8" ], "Content-Length": [ - "1082" + "564" ] }, "ResponseHeaders": { "Cache-Control": [ "no-cache" ], - "Date": [ - "Sat, 27 Apr 2019 22:13:18 GMT" - ], "Pragma": [ "no-cache" ], + "ETag": [ + "W/\"0x8D71774D47FDFF0\"" + ], + "Location": [ + "https://azs-3786.search-dogfood.windows-int.net/skillsets('webapiskillset')?api-version=2019-05-06" + ], "request-id": [ - "403779a1-f70f-4eb9-8149-c7269e8e0c30" + "68ff7b89-2808-486b-93c7-e08fa8991f6e" ], "elapsed-time": [ - "22" + "75" ], "OData-Version": [ "4.0" @@ -392,36 +395,84 @@ "Strict-Transport-Security": [ "max-age=15724800; includeSubDomains" ], - "Content-Length": [ - "227" + "Date": [ + "Fri, 02 Aug 2019 18:11:23 GMT" ], "Content-Type": [ "application/json; odata.metadata=minimal" ], - "Content-Language": [ - "en" + "Expires": [ + "-1" + ], + "Content-Length": [ + "641" + ] + }, + "ResponseBody": "{\r\n \"@odata.context\": \"https://azs-3786.search-dogfood.windows-int.net/$metadata#skillsets/$entity\",\r\n \"@odata.etag\": \"\\\"0x8D71774D47FDFF0\\\"\",\r\n \"name\": \"webapiskillset\",\r\n \"description\": \"Skillset for testing\",\r\n \"skills\": [\r\n {\r\n \"@odata.type\": \"#Microsoft.Skills.Custom.WebApiSkill\",\r\n \"name\": null,\r\n \"description\": \"A simple web api skill\",\r\n \"context\": \"/document\",\r\n \"uri\": \"https://contoso.example.org\",\r\n \"httpMethod\": \"POST\",\r\n \"timeout\": null,\r\n \"batchSize\": null,\r\n \"degreeOfParallelism\": null,\r\n \"inputs\": [\r\n {\r\n \"name\": \"text\",\r\n \"source\": \"/document/text\",\r\n \"sourceContext\": null,\r\n \"inputs\": []\r\n }\r\n ],\r\n \"outputs\": [\r\n {\r\n \"name\": \"coolResult\",\r\n \"targetName\": \"myCoolResult\"\r\n }\r\n ],\r\n \"httpHeaders\": null\r\n }\r\n ],\r\n \"cognitiveServices\": null\r\n}", + "StatusCode": 201 + }, + { + "RequestUri": "/skillsets('webapiskillset')?api-version=2019-05-06", + "EncodedRequestUri": "L3NraWxsc2V0cygnd2ViYXBpc2tpbGxzZXQnKT9hcGktdmVyc2lvbj0yMDE5LTA1LTA2", + "RequestMethod": "DELETE", + "RequestBody": "", + "RequestHeaders": { + "client-request-id": [ + "4e5e4f8a-a1eb-4adc-ad42-2bd3af133243" + ], + "Accept-Language": [ + "en-US" + ], + "api-key": [ + "5CA77CE22AB2DBF2053E3695DE4A060C" + ], + "User-Agent": [ + "FxVersion/4.6.27617.04", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.17763.", + "Microsoft.Azure.Search.SearchServiceClient/10.0.0.0" + ] + }, + "ResponseHeaders": { + "Cache-Control": [ + "no-cache" + ], + "Pragma": [ + "no-cache" + ], + "request-id": [ + "4e5e4f8a-a1eb-4adc-ad42-2bd3af133243" + ], + "elapsed-time": [ + "72" + ], + "Strict-Transport-Security": [ + "max-age=15724800; includeSubDomains" + ], + "Date": [ + "Fri, 02 Aug 2019 18:11:24 GMT" ], "Expires": [ "-1" ] }, - "ResponseBody": "{\r\n \"error\": {\r\n \"code\": \"\",\r\n \"message\": \"One or more skills are invalid. Details: Error in skill #1: When 'textExtractionAlgorithm' parameter is set to 'handwritten' the only supported value for 'defaultLanguageCode' parameter is 'en'\"\r\n }\r\n}", - "StatusCode": 400 + "ResponseBody": "", + "StatusCode": 204 }, { - "RequestUri": "/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourceGroups/azsmnet9505/providers/Microsoft.Search/searchServices/azs-1742?api-version=2015-08-19", - "EncodedRequestUri": "L3N1YnNjcmlwdGlvbnMvM2M3MjliMmEtNGY4Ni00YmIyLWFiZTgtNGI4NjQ3YWYxNTZjL3Jlc291cmNlR3JvdXBzL2F6c21uZXQ5NTA1L3Byb3ZpZGVycy9NaWNyb3NvZnQuU2VhcmNoL3NlYXJjaFNlcnZpY2VzL2F6cy0xNzQyP2FwaS12ZXJzaW9uPTIwMTUtMDgtMTk=", + "RequestUri": "/subscriptions/3c729b2a-4f86-4bb2-abe8-4b8647af156c/resourceGroups/azsmnet3848/providers/Microsoft.Search/searchServices/azs-3786?api-version=2015-08-19", + "EncodedRequestUri": "L3N1YnNjcmlwdGlvbnMvM2M3MjliMmEtNGY4Ni00YmIyLWFiZTgtNGI4NjQ3YWYxNTZjL3Jlc291cmNlR3JvdXBzL2F6c21uZXQzODQ4L3Byb3ZpZGVycy9NaWNyb3NvZnQuU2VhcmNoL3NlYXJjaFNlcnZpY2VzL2F6cy0zNzg2P2FwaS12ZXJzaW9uPTIwMTUtMDgtMTk=", "RequestMethod": "DELETE", "RequestBody": "", "RequestHeaders": { "x-ms-client-request-id": [ - "12c9c1a0-4b65-4677-a520-fad81a0f87d2" + "83f54960-a6e4-4559-ada6-a1f5a37665ac" ], - "accept-language": [ + "Accept-Language": [ "en-US" ], "User-Agent": [ - "FxVersion/4.6.26614.01", + "FxVersion/4.6.27617.04", "OSName/Windows", "OSVersion/Microsoft.Windows.10.0.17763.", "Microsoft.Azure.Management.Search.SearchManagementClient/3.0.0.0" @@ -431,41 +482,41 @@ "Cache-Control": [ "no-cache" ], - "Date": [ - "Sat, 27 Apr 2019 22:13:21 GMT" - ], "Pragma": [ "no-cache" ], "x-ms-request-id": [ - "12c9c1a0-4b65-4677-a520-fad81a0f87d2" + "83f54960-a6e4-4559-ada6-a1f5a37665ac" ], "request-id": [ - "12c9c1a0-4b65-4677-a520-fad81a0f87d2" + "83f54960-a6e4-4559-ada6-a1f5a37665ac" ], "elapsed-time": [ - "997" + "946" ], "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], "x-ms-ratelimit-remaining-subscription-deletes": [ - "14944" + "14995" ], "x-ms-correlation-request-id": [ - "1a9b3a42-b4aa-4030-b767-c4aee5bafae6" + "46662848-52a4-44b6-8839-24062789382e" ], "x-ms-routing-request-id": [ - "NORTHEUROPE:20190427T221321Z:1a9b3a42-b4aa-4030-b767-c4aee5bafae6" + "NORTHEUROPE:20190802T181128Z:46662848-52a4-44b6-8839-24062789382e" ], "X-Content-Type-Options": [ "nosniff" ], - "Content-Length": [ - "0" + "Date": [ + "Fri, 02 Aug 2019 18:11:28 GMT" ], "Expires": [ "-1" + ], + "Content-Length": [ + "0" ] }, "ResponseBody": "", @@ -474,10 +525,10 @@ ], "Names": { "GenerateName": [ - "azsmnet9505" + "azsmnet3848" ], "GenerateServiceName": [ - "azs-1742" + "azs-3786" ] }, "Variables": { diff --git a/sdk/search/Microsoft.Azure.Search/tests/Tests/SkillsetsTests.cs b/sdk/search/Microsoft.Azure.Search/tests/Tests/SkillsetsTests.cs index a86f0aa91746..99bff7b12eeb 100644 --- a/sdk/search/Microsoft.Azure.Search/tests/Tests/SkillsetsTests.cs +++ b/sdk/search/Microsoft.Azure.Search/tests/Tests/SkillsetsTests.cs @@ -4,6 +4,7 @@ using System.Collections.Generic; using System.Net; +using System.Net.Http.Headers; using Microsoft.Azure.Search.Models; using Microsoft.Azure.Search.Tests.Utilities; using Microsoft.Rest.Azure; @@ -23,6 +24,26 @@ public sealed class SkillsetsTests : SearchTestBase public const string RootPathString = "/document"; + [Fact] + public void CreateSkillsetReturnsCorrectDefinitionWebApiSkillWithHeaders() + { + Run(() => + { + SearchServiceClient searchClient = Data.GetSearchServiceClient(); + CreateAndValidateSkillset(searchClient, CreateTestSkillsetWebApiSkill()); + }); + } + + [Fact] + public void CreateSkillsetReturnsCorrectDefinitionWebApiSkillWithoutHeaders() + { + Run(() => + { + SearchServiceClient searchClient = Data.GetSearchServiceClient(); + CreateAndValidateSkillset(searchClient, CreateTestSkillsetWebApiSkill(includeHeader: false)); + }); + } + [Fact] public void CreateSkillsetReturnsCorrectDefinitionOcrKeyPhrase() { @@ -63,18 +84,6 @@ public void CreateSkillsetReturnsCorrectDefinitionOcrHandwritingSentiment() }); } - [Fact] - public void CreateSkillsetThrowsExceptionWithInvalidLanguageSelection() - { - Run(() => - { - SearchServiceClient searchClient = Data.GetSearchServiceClient(); - Skillset skillset = CreateTestSkillsetOcrSentiment(OcrSkillLanguage.Fi, SentimentSkillLanguage.Fi, TextExtractionAlgorithm.Handwritten); - CloudException exception = Assert.Throws(() => searchClient.Skillsets.Create(skillset)); - Assert.Contains("When 'textExtractionAlgorithm' parameter is set to 'handwritten' the only supported value for 'defaultLanguageCode' parameter is 'en'", exception.Message); - }); - } - [Fact] public void CreateSkillsetReturnsCorrectDefinitionImageAnalysisKeyPhrase() { @@ -906,5 +915,50 @@ private static Skillset CreateTestSkillsetOcrSplitText(OcrSkillLanguage ocrLangu return new Skillset("testskillset", "Skillset for testing", skills); } + + private static Skillset CreateTestSkillsetWebApiSkill(bool includeHeader = true) + { + var skills = new List(); + + var inputs = new List() + { + new InputFieldMappingEntry + { + Name = "text", + Source = "/document/text" + } + }; + + var outputs = new List() + { + new OutputFieldMappingEntry + { + Name = "coolResult", + TargetName = "myCoolResult" + } + }; + + var skill = new WebApiSkill( + inputs, + outputs, + uri: "https://contoso.example.org", + description: "A simple web api skill", + context: RootPathString) + { + HttpMethod = "POST" + }; + + if (includeHeader) + { + skill.HttpHeaders = new Dictionary + { + ["x-ms-example"] = "example" + }; + } + + skills.Add(skill); + + return new Skillset("webapiskillset", "Skillset for testing", skills); + } } } diff --git a/sdk/storage/Azure.Storage.Blobs/BreakingChanges.txt b/sdk/storage/Azure.Storage.Blobs/BreakingChanges.txt index 914cdb4adbaf..125b696f8c12 100644 --- a/sdk/storage/Azure.Storage.Blobs/BreakingChanges.txt +++ b/sdk/storage/Azure.Storage.Blobs/BreakingChanges.txt @@ -1,6 +1,8 @@ Breaking Changes ================ +12.0.0-preview.2 (2019-08) +-------------------------- - Removed CopyFromUriOperation. Use Operation instead. 12.0.0-preview.1 (2019-07) diff --git a/sdk/storage/Azure.Storage.Blobs/Changelog.txt b/sdk/storage/Azure.Storage.Blobs/Changelog.txt index a1b7da835a4e..9e160d2bcdb9 100644 --- a/sdk/storage/Azure.Storage.Blobs/Changelog.txt +++ b/sdk/storage/Azure.Storage.Blobs/Changelog.txt @@ -1,6 +1,11 @@ Release History =============== +12.0.0-preview.2 (2019-08) +-------------------------- +- Distributed Tracing +- Bug fixes + 12.0.0-preview.1 (2019-07) -------------------------- This preview is the first release of a ground-up rewrite of our client diff --git a/sdk/storage/Azure.Storage.Blobs/README.md b/sdk/storage/Azure.Storage.Blobs/README.md index 1f9d92cafc60..b2826f22a1fc 100644 --- a/sdk/storage/Azure.Storage.Blobs/README.md +++ b/sdk/storage/Azure.Storage.Blobs/README.md @@ -16,7 +16,7 @@ definition, such as text or binary data. Install the Azure Storage Blobs client library for .NET with [NuGet][nuget]: ```Powershell -dotnet add package Azure.Storage.Blobs --version 12.0.0-preview.1 +dotnet add package Azure.Storage.Blobs --version 12.0.0-preview.2 ``` ### Prerequisites diff --git a/sdk/storage/Azure.Storage.Blobs/src/AppendBlobClient.cs b/sdk/storage/Azure.Storage.Blobs/src/AppendBlobClient.cs index c2bcc8af65ab..a2e25fd26aee 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/AppendBlobClient.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/AppendBlobClient.cs @@ -36,13 +36,13 @@ public class AppendBlobClient : BlobBaseClient /// indicates the maximum /// number of bytes that can be sent in a call to AppendBlock. /// - public const int AppendBlobMaxAppendBlockBytes = 4 * Constants.MB; // 4MB + public const int AppendBlobMaxAppendBlockBytes = Constants.Blob.Append.MaxAppendBlockBytes; /// /// indicates the maximum number of /// blocks allowed in an append blob. /// - public const int AppendBlobMaxBlocks = 50000; + public const int AppendBlobMaxBlocks = Constants.Blob.Append.MaxBlocks; #region ctors /// diff --git a/sdk/storage/Azure.Storage.Blobs/src/BlobContainerClient.cs b/sdk/storage/Azure.Storage.Blobs/src/BlobContainerClient.cs index 56f52e48a956..467e96a6501a 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/BlobContainerClient.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/BlobContainerClient.cs @@ -4,6 +4,7 @@ using System; using System.Collections.Generic; +using System.ComponentModel; using System.IO; using System.Threading; using System.Threading.Tasks; @@ -25,12 +26,12 @@ public class BlobContainerClient /// /// The Azure Storage name used to identify a storage account's root container. /// - public const string RootContainerName = "$root"; + public const string RootContainerName = Constants.Blob.Container.RootName; /// /// The Azure Storage name used to identify a storage account's logs container. /// - public const string LogsContainerName = "$logs"; + public const string LogsContainerName = Constants.Blob.Container.LogsName; #pragma warning disable IDE0032 // Use auto property /// @@ -355,7 +356,7 @@ private async Task> CreateInternal( metadata: metadata, access: publicAccessType, async: async, - operationName: "Azure.Storage.Blobs.BlobContainerClient.Create", + operationName: Constants.Blob.Container.CreateOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -487,7 +488,7 @@ private async Task DeleteInternal( ifModifiedSince: accessConditions?.HttpAccessConditions?.IfModifiedSince, ifUnmodifiedSince: accessConditions?.HttpAccessConditions?.IfUnmodifiedSince, async: async, - operationName: "Azure.Storage.Blobs.BlobContainerClient.Delete", + operationName: Constants.Blob.Container.DeleteOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -619,7 +620,7 @@ await BlobRestClient.Container.GetPropertiesAsync( this.Uri, leaseId: leaseAccessConditions?.LeaseId, async: async, - operationName: "Azure.Storage.Blobs.BlobContainerClient.GetProperties", + operationName: Constants.Blob.Container.GetPropertiesOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); @@ -787,7 +788,7 @@ private async Task> SetMetadataInternal( leaseId: accessConditions?.LeaseAccessConditions?.LeaseId, ifModifiedSince: accessConditions?.HttpAccessConditions?.IfModifiedSince, async: async, - operationName: "Azure.Storage.Blobs.BlobContainerClient.SetMetadata", + operationName: Constants.Blob.Container.SetMetaDataOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -914,7 +915,7 @@ private async Task> GetAccessPolicyInternal( this.Uri, leaseId: leaseAccessConditions?.LeaseId, async: async, - operationName: "Azure.Storage.Blobs.BlobContainerClient.GetAccessPolicy", + operationName: Constants.Blob.Container.GetAccessPolicyOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -1112,7 +1113,7 @@ private async Task> SetAccessPolicyInternal( ifModifiedSince: accessConditions?.HttpAccessConditions?.IfModifiedSince, ifUnmodifiedSince: accessConditions?.HttpAccessConditions?.IfUnmodifiedSince, async: async, - operationName: "Azure.Storage.Blobs.BlobContainerClient.SetAccessPolicy", + operationName: Constants.Blob.Container.SetAccessPolicyOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } diff --git a/sdk/storage/Azure.Storage.Blobs/src/BlobServiceClient.cs b/sdk/storage/Azure.Storage.Blobs/src/BlobServiceClient.cs index bef18810c216..ab4f743c6167 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/BlobServiceClient.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/BlobServiceClient.cs @@ -429,7 +429,7 @@ private async Task> GetAccountInfoInternal( this.Pipeline, this.Uri, async: async, - operationName: "Azure.Storage.Blobs.BlobServiceClient.GetAccountInfo", + operationName: Constants.Blob.Service.GetAccountInfoOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -534,7 +534,7 @@ private async Task> GetPropertiesInternal( this.Pipeline, this.Uri, async: async, - operationName: "Azure.Storage.Blobs.BlobServiceClient.GetProperties", + operationName: Constants.Blob.Service.GetPropertiesOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -661,7 +661,7 @@ private async Task SetPropertiesInternal( this.Uri, properties, async: async, - operationName: "Azure.Storage.Blobs.BlobServiceClient.SetProperties", + operationName: Constants.Blob.Service.SetPropertiesOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -772,7 +772,7 @@ private async Task> GetStatisticsInternal( this.Pipeline, this.Uri, async: async, - operationName: "Azure.Storage.Blobs.BlobServiceClient.GetStatistics", + operationName: Constants.Blob.Service.GetStatisticsOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -916,7 +916,7 @@ private async Task> GetUserDelegationKeyInternal( this.Uri, keyInfo: keyInfo, async: async, - operationName: "Azure.Storage.Blobs.BlobServiceClient.GetUserDelegationKey", + operationName: Constants.Blob.Service.GetUserDelegationKeyOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } diff --git a/sdk/storage/Azure.Storage.Blobs/src/BlobUriBuilder.cs b/sdk/storage/Azure.Storage.Blobs/src/BlobUriBuilder.cs index c4d43a00489f..dd5ecc9ff1c4 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/BlobUriBuilder.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/BlobUriBuilder.cs @@ -17,10 +17,6 @@ namespace Azure.Storage.Blobs /// internal struct BlobUriBuilder : IEquatable { - const string SnapshotParameterName = "snapshot"; - //const string VersionIdParameterName = "versionid"; - const string SasVersionKey = "sv"; - /// /// Gets or sets the scheme name of the URI. /// Example: "https" @@ -146,12 +142,12 @@ public BlobUriBuilder(Uri uri) // Convert the query parameters to a case-sensitive map & trim whitespace var paramsMap = new UriQueryParamsCollection(uri.Query); - if (paramsMap.TryGetValue(SnapshotParameterName, out var snapshotTime)) + if (paramsMap.TryGetValue(Constants.SnapshotParameterName, out var snapshotTime)) { this.Snapshot = snapshotTime; // If we recognized the query parameter, remove it from the map - paramsMap.Remove(SnapshotParameterName); + paramsMap.Remove(Constants.SnapshotParameterName); } //if(paramsMap.TryGetValue(VersionIdParameterName, out var versionId)) @@ -162,7 +158,7 @@ public BlobUriBuilder(Uri uri) // paramsMap.Remove(VersionIdParameterName); //} - if (paramsMap.ContainsKey(SasVersionKey)) + if (paramsMap.ContainsKey(Constants.Sas.Parameters.Version)) { this.Sas = new BlobSasQueryParameters(paramsMap); } @@ -205,7 +201,7 @@ public Uri ToUri() rawQuery += "&"; } - rawQuery += SnapshotParameterName + "=" + this.Snapshot; + rawQuery += Constants.SnapshotParameterName + "=" + this.Snapshot; } //// Concatenate blob version query parameter (if it exists) diff --git a/sdk/storage/Azure.Storage.Blobs/src/BlockBlobClient.cs b/sdk/storage/Azure.Storage.Blobs/src/BlockBlobClient.cs index 759cc299d926..85ba7a661573 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/BlockBlobClient.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/BlockBlobClient.cs @@ -84,19 +84,19 @@ public class BlockBlobClient : BlobBaseClient /// indicates the maximum number of bytes /// that can be sent in a call to . /// - public const int BlockBlobMaxUploadBlobBytes = 256 * Constants.MB; // 256MB + public const int BlockBlobMaxUploadBlobBytes = Constants.Blob.Block.MaxUploadBytes; /// /// indicates the maximum /// number of bytes that can be sent in a call to . /// - public const int BlockBlobMaxStageBlockBytes = 100 * Constants.MB; // 100MB + public const int BlockBlobMaxStageBlockBytes = Constants.Blob.Block.MaxStageBytes; /// /// indicates the maximum number of /// blocks allowed in a block blob. /// - public const int BlockBlobMaxBlocks = 50000; + public const int BlockBlobMaxBlocks = Constants.Blob.Block.MaxBlocks; #region ctors /// @@ -491,7 +491,7 @@ internal async Task> UploadInternal( ifMatch: blobAccessConditions?.HttpAccessConditions?.IfMatch, ifNoneMatch: blobAccessConditions?.HttpAccessConditions?.IfNoneMatch, async: async, - operationName: "Azure.Storage.Blobs.Specialized.BlockBlobClient.Upload", + operationName: Constants.Blob.Block.UploadOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); }, @@ -714,7 +714,7 @@ internal async Task> StageBlockInternal( try { content = content.WithNoDispose().WithProgress(progressHandler); - var uploadAttempt = 0; + var stageBlockAttempt = 0; return await ReliableOperation.DoSyncOrAsync( async, reset: () => content.Seek(0, SeekOrigin.Begin), @@ -723,7 +723,7 @@ internal async Task> StageBlockInternal( operation: () => { - this.Pipeline.LogTrace($"Upload attempt {++uploadAttempt}"); + this.Pipeline.LogTrace($"Stage Block {++stageBlockAttempt}"); return BlobRestClient.BlockBlob.StageBlockAsync( this.Pipeline, this.Uri, @@ -733,7 +733,7 @@ internal async Task> StageBlockInternal( transactionalContentHash: transactionalContentHash, leaseId: leaseAccessConditions?.LeaseId, async: async, - operationName: "Azure.Storage.Blobs.Specialized.BlockBlobClient.StageBlock", + operationName: Constants.Blob.Block.StageBlockOperationName, cancellationToken: cancellationToken); }, cleanup: () => { }) @@ -1003,7 +1003,7 @@ private async Task> StageBlockFromUriInternal( sourceIfMatch: sourceAccessConditions?.IfMatch, sourceIfNoneMatch: sourceAccessConditions?.IfNoneMatch, async: async, - operationName: "Azure.Storage.Blobs.Specialized.BlockBlobClient.StageBlockFromUri", + operationName: Constants.Blob.Block.StageBlockFromUriOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -1229,7 +1229,7 @@ internal async Task> CommitBlockListInternal( ifMatch: blobAccessConditions?.HttpAccessConditions?.IfMatch, ifNoneMatch: blobAccessConditions?.HttpAccessConditions?.IfNoneMatch, async: async, - operationName: "Azure.Storage.Blobs.Specialized.BlockBlobClient.CommitBlockList", + operationName: Constants.Blob.Block.CommitBlockListOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -1412,7 +1412,7 @@ private async Task> GetBlockListInternal( snapshot: snapshot, leaseId: leaseAccessConditions?.LeaseId, async: async, - operationName: "Azure.Storage.Blobs.Specialized.BlockBlobClient.GetBlockList", + operationName: Constants.Blob.Block.GetBlockListOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false)) .ToBlockList(); diff --git a/sdk/storage/Azure.Storage.Blobs/src/LeaseClient.cs b/sdk/storage/Azure.Storage.Blobs/src/LeaseClient.cs index 2a5d1eda25f5..6d4c61d4cb37 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/LeaseClient.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/LeaseClient.cs @@ -274,7 +274,7 @@ private async Task> AcquireInternal( ifMatch: httpAccessConditions?.IfMatch, ifNoneMatch: httpAccessConditions?.IfNoneMatch, async: async, - operationName: "Azure.Storage.Blobs.Specialized.LeaseClient.Acquire", + operationName: Constants.Blob.Lease.AcquireOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -440,7 +440,7 @@ private async Task> RenewInternal( ifMatch: httpAccessConditions?.IfMatch, ifNoneMatch: httpAccessConditions?.IfNoneMatch, async: async, - operationName: "Azure.Storage.Blobs.Specialized.LeaseClient.Renew", + operationName: Constants.Blob.Lease.RenewOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -607,7 +607,7 @@ await BlobRestClient.Blob.ReleaseLeaseAsync( ifMatch: httpAccessConditions?.IfMatch, ifNoneMatch: httpAccessConditions?.IfNoneMatch, async: async, - operationName: "Azure.Storage.Blobs.Specialized.LeaseClient.Release", + operationName: Constants.Blob.Lease.ReleaseOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); return new Response( @@ -807,7 +807,7 @@ private async Task> ChangeInternal( ifModifiedSince: httpAccessConditions?.IfModifiedSince, ifUnmodifiedSince: httpAccessConditions?.IfUnmodifiedSince, async: async, - operationName: "Azure.Storage.Blobs.Specialized.LeaseClient.Change", + operationName: Constants.Blob.Lease.ChangeOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -1014,7 +1014,7 @@ private async Task> BreakInternal( ifMatch: httpAccessConditions?.IfMatch, ifNoneMatch: httpAccessConditions?.IfNoneMatch, async: async, - operationName: "Azure.Storage.Blobs.Specialized.LeaseClient.Break", + operationName: Constants.Blob.Lease.BreakOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false)) .ToLease(); diff --git a/sdk/storage/Azure.Storage.Blobs/src/PageBlobClient.cs b/sdk/storage/Azure.Storage.Blobs/src/PageBlobClient.cs index 2044d07cf497..0cdbdac29632 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/PageBlobClient.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/PageBlobClient.cs @@ -425,7 +425,7 @@ private async Task> CreateInternal( blobContentLength: size, blobSequenceNumber: sequenceNumber, async: async, - operationName: "Azure.Storage.Blobs.Specialized.PageBlobClient.Create", + operationName: Constants.Blob.Page.CreateOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -660,7 +660,7 @@ private async Task> UploadPagesInternal( ifMatch: accessConditions?.HttpAccessConditions?.IfMatch, ifNoneMatch: accessConditions?.HttpAccessConditions?.IfNoneMatch, async: async, - operationName: "Azure.Storage.Blobs.Specialized.PageBlobClient.UploadPages", + operationName: Constants.Blob.Page.UploadOperationName, cancellationToken: cancellationToken); }, cleanup: () => { }) @@ -827,7 +827,7 @@ private async Task> ClearPagesInternal( ifMatch: accessConditions?.HttpAccessConditions?.IfMatch, ifNoneMatch: accessConditions?.HttpAccessConditions?.IfNoneMatch, async: async, - operationName: "Azure.Storage.Blobs.Specialized.PageBlobClient.ClearPages", + operationName: Constants.Blob.Page.ClearOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -995,7 +995,7 @@ private async Task> GetPageRangesInternal( ifMatch: accessConditions?.HttpAccessConditions?.IfMatch, ifNoneMatch: accessConditions?.HttpAccessConditions?.IfNoneMatch, async: async, - operationName: "Azure.Storage.Blobs.Specialized.PageBlobClient.GetPageRanges", + operationName: Constants.Blob.Page.GetPageRangesOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -1197,7 +1197,7 @@ private async Task> GetPageRangesDiffInternal( ifMatch: accessConditions?.HttpAccessConditions?.IfMatch, ifNoneMatch: accessConditions?.HttpAccessConditions?.IfNoneMatch, async: async, - operationName: "Azure.Storage.Blobs.Specialized.PageBlobClient.GetPageRangesDiff", + operationName: Constants.Blob.Page.GetPageRangesDiffOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -1356,7 +1356,7 @@ private async Task> ResizeInternal( ifMatch: accessConditions?.HttpAccessConditions?.IfMatch, ifNoneMatch: accessConditions?.HttpAccessConditions?.IfNoneMatch, async: async, - operationName: "Azure.Storage.Blobs.Specialized.PageBlobClient.Resize", + operationName: Constants.Blob.Page.ResizeOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -1563,7 +1563,7 @@ private async Task> UpdateSequenceNumberInternal( ifUnmodifiedSince: accessConditions?.HttpAccessConditions?.IfUnmodifiedSince, ifMatch: accessConditions?.HttpAccessConditions?.IfMatch, ifNoneMatch: accessConditions?.HttpAccessConditions?.IfNoneMatch, - operationName: "Azure.Storage.Blobs.Specialized.PageBlobClient.UpdateSequenceNumber", + operationName: Constants.Blob.Page.UpdateSequenceNumberOperationName, async: async, cancellationToken: cancellationToken) .ConfigureAwait(false); @@ -1816,7 +1816,7 @@ public virtual async Task> StartCopyIncrementalAsync( /// a failure occurs. /// public virtual Operation StartCopyIncremental( - string copyId, + string copyId, CancellationToken cancellationToken = default) { var response = this.GetProperties(null, cancellationToken); @@ -1851,7 +1851,7 @@ public virtual Operation StartCopyIncremental( /// a failure occurs. /// public virtual async Task> StartCopyIncrementalAsync( - string copyId, + string copyId, CancellationToken cancellationToken = default) { var response = await this.GetPropertiesAsync(null, cancellationToken).ConfigureAwait(false); @@ -1981,7 +1981,7 @@ private async Task> StartCopyIncrementalInternal( ifMatch: accessConditions?.HttpAccessConditions?.IfMatch, ifNoneMatch: accessConditions?.HttpAccessConditions?.IfNoneMatch, async: async, - operationName: "Azure.Storage.Blobs.Specialized.PageBlobClient.StartCopyIncremental", + operationName: Constants.Blob.Page.StartCopyIncrementalOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -2249,7 +2249,7 @@ private async Task> UploadPagesFromUriInternal( sourceIfMatch: sourceAccessConditions?.HttpAccessConditions?.IfMatch, sourceIfNoneMatch: sourceAccessConditions?.HttpAccessConditions?.IfNoneMatch, async: async, - operationName: "Azure.Storage.Blobs.Specialized.PageBlobClient.UploadPagesFromUri", + operationName: Constants.Blob.Page.UploadPagesFromUriOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } diff --git a/sdk/storage/Azure.Storage.Blobs/src/StorageRequestFailedException.cs b/sdk/storage/Azure.Storage.Blobs/src/StorageRequestFailedException.cs index 11b435d883f4..6dd95be2ff4c 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/StorageRequestFailedException.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/StorageRequestFailedException.cs @@ -29,8 +29,8 @@ static partial void CustomizeFromXml(XElement root, StorageError error) { switch (element.Name.LocalName) { - case "Code": - case "Message": + case Constants.Xml.Code: + case Constants.Xml.Message: continue; default: error.AdditionalInformation[element.Name.LocalName] = element.Value; diff --git a/sdk/storage/Azure.Storage.Blobs/tests/BlobBaseClientTests.cs b/sdk/storage/Azure.Storage.Blobs/tests/BlobBaseClientTests.cs index e9d55be5dde1..3b648ebef31f 100644 --- a/sdk/storage/Azure.Storage.Blobs/tests/BlobBaseClientTests.cs +++ b/sdk/storage/Azure.Storage.Blobs/tests/BlobBaseClientTests.cs @@ -517,7 +517,7 @@ public async Task AbortCopyFromUriAsync_Lease() await destBlob.UploadAsync(stream); } - var duration = -1; + var duration = Constants.Blob.Lease.InfiniteLeaseDuration; var lease = this.InstrumentClient(destBlob.GetLeaseClient(this.Recording.Random.NewGuid().ToString())); var leaseResponse = await lease.AcquireAsync(duration); diff --git a/sdk/storage/Azure.Storage.Common/Changelog.txt b/sdk/storage/Azure.Storage.Common/Changelog.txt index a1b7da835a4e..bd65edbf4156 100644 --- a/sdk/storage/Azure.Storage.Common/Changelog.txt +++ b/sdk/storage/Azure.Storage.Common/Changelog.txt @@ -1,6 +1,11 @@ Release History =============== +12.0.0-preview.2 (2019-08) +-------------------------- +- Credential rolling +- Bug fixes + 12.0.0-preview.1 (2019-07) -------------------------- This preview is the first release of a ground-up rewrite of our client diff --git a/sdk/storage/Azure.Storage.Common/README.md b/sdk/storage/Azure.Storage.Common/README.md index 444805d9a867..49a1fad54508 100644 --- a/sdk/storage/Azure.Storage.Common/README.md +++ b/sdk/storage/Azure.Storage.Common/README.md @@ -20,9 +20,9 @@ Install the Azure Storage client library for .NET you'd like to use with [NuGet][nuget] and the `Azure.Storage.Common` client library will be included: ```Powershell -dotnet add package Azure.Storage.Blobs --version 12.0.0-preview.1 -dotnet add package Azure.Storage.Queues --version 12.0.0-preview.1 -dotnet add package Azure.Storage.Files --version 12.0.0-preview.1 +dotnet add package Azure.Storage.Blobs --version 12.0.0-preview.2 +dotnet add package Azure.Storage.Queues --version 12.0.0-preview.2 +dotnet add package Azure.Storage.Files --version 12.0.0-preview.2 ``` ### Prerequisites diff --git a/sdk/storage/Azure.Storage.Common/src/Constants.cs b/sdk/storage/Azure.Storage.Common/src/Constants.cs index 4894706f7703..c43c0843b23e 100644 --- a/sdk/storage/Azure.Storage.Common/src/Constants.cs +++ b/sdk/storage/Azure.Storage.Common/src/Constants.cs @@ -3,6 +3,7 @@ // license information. using System; +using System.Dynamic; using System.Threading; namespace Azure.Storage @@ -33,6 +34,288 @@ internal static class Constants /// public const string BlockNameFormat = "Block_{0:D5}"; + // SASTimeFormat represents the format of a SAS start or expiry time. Use it when formatting/parsing a time.Time. + // ISO 8601 uses "yyyy'-'MM'-'dd'T'HH':'mm':'ss" + public const string TimeFormat = "yyyy-MM-ddTHH:mm:ssZ"; + + public const string SnapshotParameterName = "snapshot"; + + /// + /// Storage Connection Strings + /// + internal static class ConnectionStrings + { + /// + /// The default port numbers for development storage credentials + /// + internal const int BlobEndpointPortNumber = 10000; + internal const int QueueEndpointPortNumber = 10001; + internal const int TableEndpointPortNumber = 10002; + + internal const string UseDevelopmentSetting = "UseDevelopmentStorage"; + internal const string DevelopmentProxyUriSetting = "DevelopmentStorageProxyUri"; + internal const string DefaultEndpointsProtocolSetting = "DefaultEndpointsProtocol"; + internal const string AccountNameSetting = "AccountName"; + internal const string AccountKeyNameSetting = "AccountKeyName"; + internal const string AccountKeySetting = "AccountKey"; + internal const string BlobEndpointSetting = "BlobEndpoint"; + internal const string QueueEndpointSetting = "QueueEndpoint"; + internal const string TableEndpointSetting = "TableEndpoint"; + internal const string FileEndpointSetting = "FileEndpoint"; + internal const string BlobSecondaryEndpointSetting = "BlobSecondaryEndpoint"; + internal const string QueueSecondaryEndpointSetting = "QueueSecondaryEndpoint"; + internal const string TableSecondaryEndpointSetting = "TableSecondaryEndpoint"; + internal const string FileSecondaryEndpointSetting = "FileSecondaryEndpoint"; + internal const string EndpointSuffixSetting = "EndpointSuffix"; + internal const string SharedAccessSignatureSetting = "SharedAccessSignature"; + internal const string DevStoreAccountName = "devstoreaccount1"; + internal const string DevStoreAccountKey = + "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw=="; + internal const string SecondaryLocationAccountSuffix = "-secondary"; + internal const string DefaultEndpointSuffix = "core.windows.net"; + internal const string DefaultBlobHostnamePrefix = "blob"; + internal const string DefaultQueueHostnamePrefix = "queue"; + internal const string DefaultTableHostnamePrefix = "table"; + internal const string DefaultFileHostnamePrefix = "file"; + } + + /// + /// Header Request Names + /// + internal static class HeaderNames + { + public const string XMsPrefix = "x-ms-"; + public const string ErrorCode = "x-ms-error-code"; + public const string RequestId = "x-ms-request-id"; + public const string Date = "x-ms-date"; + public const string SharedKey = "SharedKey"; + public const string Authorization = "Authorization"; + public const string ContentEncoding = "Content-Encoding"; + public const string ContentLanguage = "Content-Language"; + public const string ContentLength = "Content-Length"; + public const string ContentMD5 = "Content-MD5"; + public const string ContentType = "Content-Type"; + public const string IfModifiedSince = "If-Modified-Since"; + public const string IfMatch = "If-Match"; + public const string IfNoneMatch = "If-None-Match"; + public const string IfUnmodifiedSince = "If-Unmodified-Since"; + public const string Range = "Range"; + } + + /// + /// Blob constant values + /// + internal static class Blob + { + internal static class Append + { + public const int MaxAppendBlockBytes = 4 * Constants.MB; // 4MB + public const int MaxBlocks = 50000; + } + + internal static class Block + { + public const int MaxUploadBytes = 256 * Constants.MB; // 256MB + public const int MaxStageBytes = 100 * Constants.MB; // 100MB + public const int MaxBlocks = 50000; + + /// + /// The Azure Storage Operation Names for Block Blob Client. + /// + public const string UploadOperationName = + "Azure.Storage.Blobs.Specialized.BlockBlobClient.Upload"; + public const string StageBlockOperationName = + "Azure.Storage.Blobs.Specialized.BlockBlobClient.StageBlock"; + public const string StageBlockFromUriOperationName = + "Azure.Storage.Blobs.Specialized.BlockBlobClient.StageBlockFromUri"; + public const string CommitBlockListOperationName = + "Azure.Storage.Blobs.Specialized.BlockBlobClient.CommitBlockList"; + public const string GetBlockListOperationName = + "Azure.Storage.Blobs.Specialized.BlockBlobClient.GetBlockList"; + } + + internal static class Container + { + /// + /// The Azure Storage name used to identify a storage account's root container. + /// + public const string RootName = "$root"; + + /// + /// The Azure Storage name used to identify a storage account's logs container. + /// + public const string LogsName = "$logs"; + + /// + /// The Azure Storage Operation Names for Blob Container Client. + /// + public const string CreateOperationName = + "Azure.Storage.Blobs.BlobContainerClient.Create"; + public const string DeleteOperationName = + "Azure.Storage.Blobs.BlobContainerClient.Delete"; + public const string GetPropertiesOperationName = + "Azure.Storage.Blobs.BlobContainerClient.GetProperties"; + public const string SetMetaDataOperationName = + "Azure.Storage.Blobs.BlobContainerClient.SetMetadata"; + public const string GetAccessPolicyOperationName = + "Azure.Storage.Blobs.BlobContainerClient.GetAccessPolicy"; + public const string SetAccessPolicyOperationName = + "Azure.Storage.Blobs.BlobContainerClient.SetAccessPolicy"; + } + + internal static class Lease + { + /// + /// Lease Duration is set as infinite when passed -1 + /// + public const int InfiniteLeaseDuration = -1; + /// + /// The Azure Storage Operation Names for Blob Lease Client. + /// + public const string AcquireOperationName = + "Azure.Storage.Blobs.Specialized.LeaseClient.Acquire"; + public const string RenewOperationName = + "Azure.Storage.Blobs.Specialized.LeaseClient.Renew"; + public const string ReleaseOperationName = + "Azure.Storage.Blobs.Specialized.LeaseClient.Release"; + public const string ChangeOperationName = + "Azure.Storage.Blobs.Specialized.LeaseClient.Change"; + public const string BreakOperationName = + "Azure.Storage.Blobs.Specialized.LeaseClient.Break"; + } + + internal static class Page + { + public const string CreateOperationName = + "Azure.Storage.Blobs.Specialized.PageBlobClient.Create"; + public const string UploadOperationName = + "Azure.Storage.Blobs.Specialized.PageBlobClient.UploadPages"; + public const string ClearOperationName = + "Azure.Storage.Blobs.Specialized.PageBlobClient.ClearPages"; + public const string GetPageRangesOperationName = + "Azure.Storage.Blobs.Specialized.PageBlobClient.GetPageRanges"; + public const string GetPageRangesDiffOperationName = + "Azure.Storage.Blobs.Specialized.PageBlobClient.GetPageRangesDiff"; + public const string ResizeOperationName = + "Azure.Storage.Blobs.Specialized.PageBlobClient.Resize"; + public const string UpdateSequenceNumberOperationName = + "Azure.Storage.Blobs.Specialized.PageBlobClient.UpdateSequenceNumber"; + public const string StartCopyIncrementalOperationName = + "Azure.Storage.Blobs.Specialized.PageBlobClient.StartCopyIncremental"; + public const string UploadPagesFromUriOperationName = + "Azure.Storage.Blobs.Specialized.PageBlobClient.UploadPagesFromUri"; + } + + internal static class Service + { + /// + /// The Azure Storage Operation Names for Blob Service Client. + /// + public const string GetAccountInfoOperationName = + "Azure.Storage.Blobs.BlobServiceClient.GetAccountInfo"; + public const string GetPropertiesOperationName = + "Azure.Storage.Blobs.BlobServiceClient.GetProperties"; + public const string SetPropertiesOperationName = + "Azure.Storage.Blobs.BlobServiceClient.SetProperties"; + public const string GetStatisticsOperationName = + "Azure.Storage.Blobs.BlobServiceClient.GetStatistics"; + public const string GetUserDelegationKeyOperationName = + "Azure.Storage.Blobs.BlobServiceClient.GetUserDelegationKey"; + } + + } + + /// + /// File constant values + /// + internal static class File + { + public const string SetHttpHeadersOperationName = + "Azure.Storage.Files.FileClient.SetHttpHeaders"; + internal static class Directory + { + public const string CreateOperationName = + "Azure.Storage.Files.DirectoryClient.Create"; + public const string DeleteOperationName = + "Azure.Storage.Files.DirectoryClient.Delete"; + public const string GetPropertiesOperationName = + "Azure.Storage.Files.DirectoryClient.GetProperties"; + public const string SetMetadataOperationName = + "Azure.Storage.Files.DirectoryClient.SetMetadata"; + public const string ListFilesAndDirectoriesSegmentOperationName = + "Azure.Storage.Files.DirectoryClient.ListFilesAndDirectoriesSegment"; + public const string GetHandlesOperationName = + "Azure.Storage.Files.DirectoryClient.ListHandles"; + public const string ForceCloseHandlesOperationName = + "Azure.Storage.Files.DirectoryClient.ForceCloseHandles"; + } + + internal static class Service + { + public const string GetPropertiesOperationName = + "Azure.Storage.Files.FileServiceClient.GetProperties"; + public const string SetPropertiesOperationName = + "Azure.Storage.Files.FileServiceClient.SetProperties"; + } + + internal static class Share + { + public const string CreateOperationName = + "Azure.Storage.Files.ShareClient.Create"; + public const string CreateSnapshotOperationName = + "Azure.Storage.Files.ShareClient.CreateSnapshot"; + public const string DeleteOperationName = + "Azure.Storage.Files.ShareClient.Delete"; + public const string GetPropertiesOperationName = + "Azure.Storage.Files.ShareClient.GetProperties"; + public const string SetQuotaOperationName = + "Azure.Storage.Files.ShareClient.SetQuota"; + public const string SetMetadataOperationName = + "Azure.Storage.Files.ShareClient.SetMetadata"; + public const string GetAccessPolicyOperationName = + "Azure.Storage.Files.ShareClient.GetAccessPolicy"; + public const string SetAccessPolicyOperationName = + "Azure.Storage.Files.ShareClient.SetAccessPolicy"; + public const string GetStatisticsOperationName = + "Azure.Storage.Files.ShareClient.GetStatistics"; + } + } + + /// + /// Queue constant values + /// + internal static class Queue + { + /// + /// QueueMaxMessagesDequeue indicates the maximum number of messages + /// you can retrieve with each call to Dequeue. + /// + public const int MaxMessagesDequeue = 32; + + /// + /// QueueMessageMaxBytes indicates the maximum number of bytes allowed for a message's UTF-8 text. + /// + public const int QueueMessageMaxBytes = 64 * Constants.KB; + + public const string messagesUri = "messages"; + + public const string ClearMessagesOperationName = + "Azure.Storage.Queues.QueueClient.ClearMessages"; + public const string EnqueueMessageOperationName = + "Azure.Storage.Queues.QueueClient.EnqueueMessage"; + public const string DequeueMessageOperationName = + "Azure.Storage.Queues.QueueClient.DequeueMessages"; + public const string PeekMessagesOperationName = + "Azure.Storage.Queues.QueueClient.PeekMessages"; + public const string DeleteMessageOperationName = + "Azure.Storage.Queues.QueueClient.DeleteMessage"; + public const string UpdateMessageOperationName = + "Azure.Storage.Queues.QueueClient.UpdateMessage"; + } + + /// + /// Sas constant values + /// internal static class Sas { internal static class Permissions @@ -108,5 +391,14 @@ internal static class AccountResources public const char Object = 'o'; } } + + /// + /// XML strings to parse for elements + /// + internal static class Xml + { + internal const string Code = "Code"; + internal const string Message = "Message"; + } } } diff --git a/sdk/storage/Azure.Storage.Common/src/Sas/SasQueryParameters.cs b/sdk/storage/Azure.Storage.Common/src/Sas/SasQueryParameters.cs index a695de876331..a4f072b45e98 100644 --- a/sdk/storage/Azure.Storage.Common/src/Sas/SasQueryParameters.cs +++ b/sdk/storage/Azure.Storage.Common/src/Sas/SasQueryParameters.cs @@ -27,10 +27,6 @@ public partial class SasQueryParameters /// public const string DefaultSasVersion = Constants.DefaultSasVersion; - // SASTimeFormat represents the format of a SAS start or expiry time. Use it when formatting/parsing a time.Time. - // ISO 8601 uses "yyyy'-'MM'-'dd'T'HH':'mm':'ss" - const string TimeFormat = "yyyy-MM-ddTHH:mm:ssZ"; - /// /// FormatTimesForSASSigning converts a time.Time to a snapshotTimeFormat string suitable for a /// SASField's StartTime or ExpiryTime fields. Returns "" if value.IsZero(). @@ -39,7 +35,7 @@ public partial class SasQueryParameters /// internal static string FormatTimesForSasSigning(DateTimeOffset time) => // "yyyy-MM-ddTHH:mm:ssZ" - (time == new DateTimeOffset()) ? "" : time.ToString(TimeFormat, CultureInfo.InvariantCulture); + (time == new DateTimeOffset()) ? "" : time.ToString(Constants.TimeFormat, CultureInfo.InvariantCulture); // All members are immutable or values so copies of this struct are thread safe. @@ -248,8 +244,8 @@ internal SasQueryParameters( case Constants.Sas.Parameters.ServicesUpper: this.services = kv.Value; break; case Constants.Sas.Parameters.ResourceTypesUpper: this.resourceTypes = kv.Value; break; case Constants.Sas.Parameters.ProtocolUpper: this.protocol = SasProtocol.Parse(kv.Value); break; - case Constants.Sas.Parameters.StartTimeUpper: this.startTime = DateTimeOffset.ParseExact(kv.Value, TimeFormat, CultureInfo.InvariantCulture); break; - case Constants.Sas.Parameters.ExpiryTimeUpper: this.expiryTime = DateTimeOffset.ParseExact(kv.Value, TimeFormat, CultureInfo.InvariantCulture); break; + case Constants.Sas.Parameters.StartTimeUpper: this.startTime = DateTimeOffset.ParseExact(kv.Value, Constants.TimeFormat, CultureInfo.InvariantCulture); break; + case Constants.Sas.Parameters.ExpiryTimeUpper: this.expiryTime = DateTimeOffset.ParseExact(kv.Value, Constants.TimeFormat, CultureInfo.InvariantCulture); break; case Constants.Sas.Parameters.IPRangeUpper: this.ipRange = IPRange.Parse(kv.Value); break; case Constants.Sas.Parameters.IdentifierUpper: this.identifier = kv.Value; break; case Constants.Sas.Parameters.ResourceUpper: this.resource = kv.Value; break; @@ -266,11 +262,11 @@ internal SasQueryParameters( else { isSasKey = false; } break; case Constants.Sas.Parameters.KeyStartUpper: - if (includeBlobParameters) { this.keyStart = DateTimeOffset.ParseExact(kv.Value, TimeFormat, CultureInfo.InvariantCulture); } + if (includeBlobParameters) { this.keyStart = DateTimeOffset.ParseExact(kv.Value, Constants.TimeFormat, CultureInfo.InvariantCulture); } else { isSasKey = false; } break; case Constants.Sas.Parameters.KeyExpiryUpper: - if (includeBlobParameters) { this.keyExpiry = DateTimeOffset.ParseExact(kv.Value, TimeFormat, CultureInfo.InvariantCulture); } + if (includeBlobParameters) { this.keyExpiry = DateTimeOffset.ParseExact(kv.Value, Constants.TimeFormat, CultureInfo.InvariantCulture); } else { isSasKey = false; } break; case Constants.Sas.Parameters.KeyServiceUpper: @@ -347,12 +343,12 @@ void AddToBuilder(string key, string value) if (this.StartTime != DateTimeOffset.MinValue) { - AddToBuilder(Constants.Sas.Parameters.StartTime, WebUtility.UrlEncode(this.StartTime.ToString(TimeFormat, CultureInfo.InvariantCulture))); + AddToBuilder(Constants.Sas.Parameters.StartTime, WebUtility.UrlEncode(this.StartTime.ToString(Constants.TimeFormat, CultureInfo.InvariantCulture))); } if (this.ExpiryTime != DateTimeOffset.MinValue) { - AddToBuilder(Constants.Sas.Parameters.ExpiryTime, WebUtility.UrlEncode(this.ExpiryTime.ToString(TimeFormat, CultureInfo.InvariantCulture))); + AddToBuilder(Constants.Sas.Parameters.ExpiryTime, WebUtility.UrlEncode(this.ExpiryTime.ToString(Constants.TimeFormat, CultureInfo.InvariantCulture))); } var ipr = this.IPRange.ToString(); @@ -390,12 +386,12 @@ void AddToBuilder(string key, string value) if (this.keyStart != DateTimeOffset.MinValue) { - AddToBuilder(Constants.Sas.Parameters.KeyStart, WebUtility.UrlEncode(this.keyStart.ToString(TimeFormat, CultureInfo.InvariantCulture))); + AddToBuilder(Constants.Sas.Parameters.KeyStart, WebUtility.UrlEncode(this.keyStart.ToString(Constants.TimeFormat, CultureInfo.InvariantCulture))); } if (this.keyExpiry != DateTimeOffset.MinValue) { - AddToBuilder(Constants.Sas.Parameters.KeyExpiry, WebUtility.UrlEncode(this.keyExpiry.ToString(TimeFormat, CultureInfo.InvariantCulture))); + AddToBuilder(Constants.Sas.Parameters.KeyExpiry, WebUtility.UrlEncode(this.keyExpiry.ToString(Constants.TimeFormat, CultureInfo.InvariantCulture))); } if (!String.IsNullOrWhiteSpace(this.keyService)) diff --git a/sdk/storage/Azure.Storage.Common/src/StorageConnectionString.cs b/sdk/storage/Azure.Storage.Common/src/StorageConnectionString.cs index 8f1e73b50323..da9430d636f7 100644 --- a/sdk/storage/Azure.Storage.Common/src/StorageConnectionString.cs +++ b/sdk/storage/Azure.Storage.Common/src/StorageConnectionString.cs @@ -21,205 +21,85 @@ internal class StorageConnectionString /// false to use the FISMA MD5 setting; true to use the .NET default implementation. internal static bool UseV1MD5 => true; - /// - /// The setting name for using the development storage. - /// - internal const string UseDevelopmentStorageSettingString = "UseDevelopmentStorage"; - - /// - /// The setting name for specifying a development storage proxy Uri. - /// - internal const string DevelopmentStorageProxyUriSettingString = "DevelopmentStorageProxyUri"; - - /// - /// The setting name for using the default storage endpoints with the specified protocol. - /// - internal const string DefaultEndpointsProtocolSettingString = "DefaultEndpointsProtocol"; - - /// - /// The setting name for the account name. - /// - internal const string AccountNameSettingString = "AccountName"; - - /// - /// The setting name for the account key name. - /// - internal const string AccountKeyNameSettingString = "AccountKeyName"; - - /// - /// The setting name for the account key. - /// - internal const string AccountKeySettingString = "AccountKey"; - - /// - /// The setting name for a custom blob storage endpoint. - /// - internal const string BlobEndpointSettingString = "BlobEndpoint"; - - /// - /// The setting name for a custom queue endpoint. - /// - internal const string QueueEndpointSettingString = "QueueEndpoint"; - - /// - /// The setting name for a custom table storage endpoint. - /// - internal const string TableEndpointSettingString = "TableEndpoint"; - - /// - /// The setting name for a custom file storage endpoint. - /// - internal const string FileEndpointSettingString = "FileEndpoint"; - - /// - /// The setting name for a custom blob storage secondary endpoint. - /// - internal const string BlobSecondaryEndpointSettingString = "BlobSecondaryEndpoint"; - - /// - /// The setting name for a custom queue secondary endpoint. - /// - internal const string QueueSecondaryEndpointSettingString = "QueueSecondaryEndpoint"; - - /// - /// The setting name for a custom table storage secondary endpoint. - /// - internal const string TableSecondaryEndpointSettingString = "TableSecondaryEndpoint"; - - /// - /// The setting name for a custom file storage secondary endpoint. - /// - internal const string FileSecondaryEndpointSettingString = "FileSecondaryEndpoint"; - - /// - /// The setting name for a custom storage endpoint suffix. - /// - internal const string EndpointSuffixSettingString = "EndpointSuffix"; - - /// - /// The setting name for a shared access key. - /// - internal const string SharedAccessSignatureSettingString = "SharedAccessSignature"; - - /// - /// The default account name for the development storage. - /// - private const string DevstoreAccountName = "devstoreaccount1"; - - /// - /// The default account key for the development storage. - /// - private const string DevstoreAccountKey = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw=="; - - /// - /// The suffix appended to account in order to access secondary location for read only access. - /// - internal const string SecondaryLocationAccountSuffix = "-secondary"; - - /// - /// The default storage service hostname suffix. - /// - private const string DefaultEndpointSuffix = "core.windows.net"; - - /// - /// The default blob storage DNS hostname prefix. - /// - private const string DefaultBlobHostnamePrefix = "blob"; - - /// - /// The root queue DNS name prefix. - /// - private const string DefaultQueueHostnamePrefix = "queue"; - - /// - /// The root table storage DNS name prefix. - /// - private const string DefaultTableHostnamePrefix = "table"; - - /// - /// The default file storage DNS hostname prefix. - /// - private const string DefaultFileHostnamePrefix = "file"; - /// /// Validator for the UseDevelopmentStorage setting. Must be "true". /// - private static readonly AccountSetting UseDevelopmentStorageSetting = Setting(UseDevelopmentStorageSettingString, "true"); + private static readonly AccountSetting UseDevelopmentStorageSetting = Setting(Constants.ConnectionStrings.UseDevelopmentSetting, "true"); /// /// Validator for the DevelopmentStorageProxyUri setting. Must be a valid Uri. /// - private static readonly AccountSetting DevelopmentStorageProxyUriSetting = Setting(DevelopmentStorageProxyUriSettingString, IsValidUri); + private static readonly AccountSetting DevelopmentStorageProxyUriSetting = Setting(Constants.ConnectionStrings.DevelopmentProxyUriSetting, IsValidUri); /// /// Validator for the DefaultEndpointsProtocol setting. Must be either "http" or "https". /// - private static readonly AccountSetting DefaultEndpointsProtocolSetting = Setting(DefaultEndpointsProtocolSettingString, "http", "https"); + private static readonly AccountSetting DefaultEndpointsProtocolSetting = Setting(Constants.ConnectionStrings.DefaultEndpointsProtocolSetting, "http", "https"); /// /// Validator for the AccountName setting. No restrictions. /// - private static readonly AccountSetting AccountNameSetting = Setting(AccountNameSettingString); + private static readonly AccountSetting AccountNameSetting = Setting(Constants.ConnectionStrings.AccountNameSetting); /// /// Validator for the AccountKey setting. No restrictions. /// - private static readonly AccountSetting AccountKeyNameSetting = Setting(AccountKeyNameSettingString); + private static readonly AccountSetting AccountKeyNameSetting = Setting(Constants.ConnectionStrings.AccountKeyNameSetting); /// /// Validator for the AccountKey setting. Must be a valid base64 string. /// - private static readonly AccountSetting AccountKeySetting = Setting(AccountKeySettingString, IsValidBase64String); + private static readonly AccountSetting AccountKeySetting = Setting(Constants.ConnectionStrings.AccountKeySetting, IsValidBase64String); /// /// Validator for the BlobEndpoint setting. Must be a valid Uri. /// - private static readonly AccountSetting BlobEndpointSetting = Setting(BlobEndpointSettingString, IsValidUri); + private static readonly AccountSetting BlobEndpointSetting = Setting(Constants.ConnectionStrings.BlobEndpointSetting, IsValidUri); /// /// Validator for the QueueEndpoint setting. Must be a valid Uri. /// - private static readonly AccountSetting QueueEndpointSetting = Setting(QueueEndpointSettingString, IsValidUri); + private static readonly AccountSetting QueueEndpointSetting = Setting(Constants.ConnectionStrings.QueueEndpointSetting, IsValidUri); /// /// Validator for the TableEndpoint setting. Must be a valid Uri. /// - private static readonly AccountSetting TableEndpointSetting = Setting(TableEndpointSettingString, IsValidUri); + private static readonly AccountSetting TableEndpointSetting = Setting(Constants.ConnectionStrings.TableEndpointSetting, IsValidUri); /// /// Validator for the FileEndpoint setting. Must be a valid Uri. /// - private static readonly AccountSetting FileEndpointSetting = Setting(FileEndpointSettingString, IsValidUri); + private static readonly AccountSetting FileEndpointSetting = Setting(Constants.ConnectionStrings.FileEndpointSetting, IsValidUri); /// /// Validator for the BlobSecondaryEndpoint setting. Must be a valid Uri. /// - private static readonly AccountSetting BlobSecondaryEndpointSetting = Setting(BlobSecondaryEndpointSettingString, IsValidUri); + private static readonly AccountSetting BlobSecondaryEndpointSetting = Setting(Constants.ConnectionStrings.BlobSecondaryEndpointSetting, IsValidUri); /// /// Validator for the QueueSecondaryEndpoint setting. Must be a valid Uri. /// - private static readonly AccountSetting QueueSecondaryEndpointSetting = Setting(QueueSecondaryEndpointSettingString, IsValidUri); + private static readonly AccountSetting QueueSecondaryEndpointSetting = Setting(Constants.ConnectionStrings.QueueSecondaryEndpointSetting, IsValidUri); /// /// Validator for the TableSecondaryEndpoint setting. Must be a valid Uri. /// - private static readonly AccountSetting TableSecondaryEndpointSetting = Setting(TableSecondaryEndpointSettingString, IsValidUri); + private static readonly AccountSetting TableSecondaryEndpointSetting = Setting(Constants.ConnectionStrings.TableSecondaryEndpointSetting, IsValidUri); /// /// Validator for the FileSecondaryEndpoint setting. Must be a valid Uri. /// - private static readonly AccountSetting FileSecondaryEndpointSetting = Setting(FileSecondaryEndpointSettingString, IsValidUri); + private static readonly AccountSetting FileSecondaryEndpointSetting = Setting(Constants.ConnectionStrings.FileSecondaryEndpointSetting, IsValidUri); /// /// Validator for the EndpointSuffix setting. Must be a valid Uri. /// - private static readonly AccountSetting EndpointSuffixSetting = Setting(EndpointSuffixSettingString, IsValidDomain); + private static readonly AccountSetting EndpointSuffixSetting = Setting(Constants.ConnectionStrings.EndpointSuffixSetting, IsValidDomain); /// /// Validator for the SharedAccessSignature setting. No restrictions. /// - private static readonly AccountSetting SharedAccessSignatureSetting = Setting(SharedAccessSignatureSettingString); + private static readonly AccountSetting SharedAccessSignatureSetting = Setting(Constants.ConnectionStrings.SharedAccessSignatureSetting); /// /// Singleton instance for the development storage account. @@ -517,53 +397,57 @@ public string ToString(bool exportSecrets) if (this.DefaultEndpoints) { - this.Settings.Add(DefaultEndpointsProtocolSettingString, this.BlobEndpoint.Scheme); + this.Settings.Add(Constants.ConnectionStrings.DefaultEndpointsProtocolSetting, this.BlobEndpoint.Scheme); if (this.EndpointSuffix != null) { - this.Settings.Add(EndpointSuffixSettingString, this.EndpointSuffix); + this.Settings.Add(Constants.ConnectionStrings.EndpointSuffixSetting, this.EndpointSuffix); } } else { if (this.BlobEndpoint != null) { - this.Settings.Add(BlobEndpointSettingString, this.BlobEndpoint.ToString()); + this.Settings.Add(Constants.ConnectionStrings.BlobEndpointSetting, this.BlobEndpoint.ToString()); } if (this.QueueEndpoint != null) { - this.Settings.Add(QueueEndpointSettingString, this.QueueEndpoint.ToString()); + this.Settings.Add(Constants.ConnectionStrings.QueueEndpointSetting, this.QueueEndpoint.ToString()); } if (this.TableEndpoint != null) { - this.Settings.Add(TableEndpointSettingString, this.TableEndpoint.ToString()); + this.Settings.Add(Constants.ConnectionStrings.TableEndpointSetting, this.TableEndpoint.ToString()); } if (this.FileEndpoint != null) { - this.Settings.Add(FileEndpointSettingString, this.FileEndpoint.ToString()); + this.Settings.Add(Constants.ConnectionStrings.FileEndpointSetting, this.FileEndpoint.ToString()); } if (this.BlobStorageUri.SecondaryUri != null) { - this.Settings.Add(BlobSecondaryEndpointSettingString, this.BlobStorageUri.SecondaryUri.ToString()); + this.Settings.Add(Constants.ConnectionStrings.BlobSecondaryEndpointSetting, + this.BlobStorageUri.SecondaryUri.ToString()); } if (this.QueueStorageUri.SecondaryUri != null) { - this.Settings.Add(QueueSecondaryEndpointSettingString, this.QueueStorageUri.SecondaryUri.ToString()); + this.Settings.Add(Constants.ConnectionStrings.QueueSecondaryEndpointSetting, + this.QueueStorageUri.SecondaryUri.ToString()); } if (this.TableStorageUri.SecondaryUri != null) { - this.Settings.Add(TableSecondaryEndpointSettingString, this.TableStorageUri.SecondaryUri.ToString()); + this.Settings.Add(Constants.ConnectionStrings.TableSecondaryEndpointSetting, + this.TableStorageUri.SecondaryUri.ToString()); } if (this.FileStorageUri.SecondaryUri != null) { - this.Settings.Add(FileSecondaryEndpointSettingString, this.FileStorageUri.SecondaryUri.ToString()); + this.Settings.Add(Constants.ConnectionStrings.FileSecondaryEndpointSetting, + this.FileStorageUri.SecondaryUri.ToString()); } } } @@ -577,7 +461,7 @@ public string ToString(bool exportSecrets) if (!String.IsNullOrWhiteSpace(this.accountName) && (this.Credentials is StorageSharedKeyCredential sharedKeyCredentials ? String.IsNullOrWhiteSpace(sharedKeyCredentials.AccountName) : true)) { - listOfSettings.Add(String.Format(CultureInfo.InvariantCulture, "{0}={1}", AccountNameSettingString, this.accountName)); + listOfSettings.Add(String.Format(CultureInfo.InvariantCulture, "{0}={1}", Constants.ConnectionStrings.AccountNameSetting, this.accountName)); } return String.Join(";", listOfSettings); @@ -594,29 +478,29 @@ private static StorageConnectionString GetDevelopmentStorageAccount(Uri proxyUri new UriBuilder(proxyUri.Scheme, proxyUri.Host) : new UriBuilder("http", "127.0.0.1"); - builder.Path = DevstoreAccountName; + builder.Path = Constants.ConnectionStrings.DevStoreAccountName; - builder.Port = 10000; + builder.Port = Constants.ConnectionStrings.BlobEndpointPortNumber; var blobEndpoint = builder.Uri; - builder.Port = 10001; + builder.Port = Constants.ConnectionStrings.QueueEndpointPortNumber; var queueEndpoint = builder.Uri; - builder.Port = 10002; + builder.Port = Constants.ConnectionStrings.TableEndpointPortNumber; var tableEndpoint = builder.Uri; - builder.Path = DevstoreAccountName + SecondaryLocationAccountSuffix; + builder.Path = Constants.ConnectionStrings.DevStoreAccountName + Constants.ConnectionStrings.SecondaryLocationAccountSuffix; - builder.Port = 10000; + builder.Port = Constants.ConnectionStrings.BlobEndpointPortNumber; var blobSecondaryEndpoint = builder.Uri; - builder.Port = 10001; + builder.Port = Constants.ConnectionStrings.QueueEndpointPortNumber; var queueSecondaryEndpoint = builder.Uri; - builder.Port = 10002; + builder.Port = Constants.ConnectionStrings.TableEndpointPortNumber; var tableSecondaryEndpoint = builder.Uri; - var credentials = new StorageSharedKeyCredential(DevstoreAccountName, DevstoreAccountKey); + var credentials = new StorageSharedKeyCredential(Constants.ConnectionStrings.DevStoreAccountName, Constants.ConnectionStrings.DevStoreAccountKey); #pragma warning disable IDE0017 // Simplify object initialization var account = new StorageConnectionString( credentials, @@ -629,10 +513,10 @@ private static StorageConnectionString GetDevelopmentStorageAccount(Uri proxyUri #pragma warning disable IDE0028 // Simplify collection initialization account.Settings = new Dictionary(); #pragma warning restore IDE0028 // Simplify collection initialization - account.Settings.Add(UseDevelopmentStorageSettingString, "true"); + account.Settings.Add(Constants.ConnectionStrings.UseDevelopmentSetting, "true"); if (proxyUri != null) { - account.Settings.Add(DevelopmentStorageProxyUriSettingString, proxyUri.ToString()); + account.Settings.Add(Constants.ConnectionStrings.DevelopmentProxyUriSetting, proxyUri.ToString()); } account.IsDevStoreAccount = true; @@ -678,7 +562,7 @@ string settingOrDefault(string key) { accountInformation = - settings.TryGetValue(DevelopmentStorageProxyUriSettingString, out var proxyUri) + settings.TryGetValue(Constants.ConnectionStrings.DevelopmentProxyUriSetting, out var proxyUri) ? GetDevelopmentStorageAccount(new Uri(proxyUri)) : DevelopmentStorageAccount; @@ -736,19 +620,19 @@ string settingOrDefault(string key) if (matchesAutomaticEndpointsSpec || matchesExplicitEndpointsSpec) { - if (matchesAutomaticEndpointsSpec && !settings.ContainsKey(DefaultEndpointsProtocolSettingString)) + if (matchesAutomaticEndpointsSpec && !settings.ContainsKey(Constants.ConnectionStrings.DefaultEndpointsProtocolSetting)) { - settings.Add(DefaultEndpointsProtocolSettingString, "https"); + settings.Add(Constants.ConnectionStrings.DefaultEndpointsProtocolSetting, "https"); } - var blobEndpoint = settingOrDefault(BlobEndpointSettingString); - var queueEndpoint = settingOrDefault(QueueEndpointSettingString); - var tableEndpoint = settingOrDefault(TableEndpointSettingString); - var fileEndpoint = settingOrDefault(FileEndpointSettingString); - var blobSecondaryEndpoint = settingOrDefault(BlobSecondaryEndpointSettingString); - var queueSecondaryEndpoint = settingOrDefault(QueueSecondaryEndpointSettingString); - var tableSecondaryEndpoint = settingOrDefault(TableSecondaryEndpointSettingString); - var fileSecondaryEndpoint = settingOrDefault(FileSecondaryEndpointSettingString); + var blobEndpoint = settingOrDefault(Constants.ConnectionStrings.BlobEndpointSetting); + var queueEndpoint = settingOrDefault(Constants.ConnectionStrings.QueueEndpointSetting); + var tableEndpoint = settingOrDefault(Constants.ConnectionStrings.TableEndpointSetting); + var fileEndpoint = settingOrDefault(Constants.ConnectionStrings.FileEndpointSetting); + var blobSecondaryEndpoint = settingOrDefault(Constants.ConnectionStrings.BlobSecondaryEndpointSetting); + var queueSecondaryEndpoint = settingOrDefault(Constants.ConnectionStrings.QueueSecondaryEndpointSetting); + var tableSecondaryEndpoint = settingOrDefault(Constants.ConnectionStrings.TableSecondaryEndpointSetting); + var fileSecondaryEndpoint = settingOrDefault(Constants.ConnectionStrings.FileSecondaryEndpointSetting); // if secondary is specified, primary must also be specified @@ -783,11 +667,11 @@ bool isValidEndpointPair(string primary, string secondary) => ) { DefaultEndpoints = blobEndpoint == null && queueEndpoint == null && tableEndpoint == null && fileEndpoint == null, - EndpointSuffix = settingOrDefault(EndpointSuffixSettingString), + EndpointSuffix = settingOrDefault(Constants.ConnectionStrings.EndpointSuffixSetting), Settings = ValidCredentials(settings) }; - accountInformation.accountName = settingOrDefault(AccountNameSettingString); + accountInformation.accountName = settingOrDefault(Constants.ConnectionStrings.AccountNameSetting); return true; } @@ -1084,12 +968,12 @@ private static bool MatchesSpecification( private static object GetCredentials(IDictionary settings) { - settings.TryGetValue(AccountNameSettingString, out var accountName); - settings.TryGetValue(AccountKeySettingString, out var accountKey); - settings.TryGetValue(SharedAccessSignatureSettingString, out var sharedAccessSignature); + settings.TryGetValue(Constants.ConnectionStrings.AccountNameSetting, out var accountName); + settings.TryGetValue(Constants.ConnectionStrings.AccountKeySetting, out var accountKey); + settings.TryGetValue(Constants.ConnectionStrings.SharedAccessSignatureSetting, out var sharedAccessSignature); // The accountKeyName isn't used - //settings.TryGetValue(AccountKeyNameSettingString, out var accountKeyName); + //settings.TryGetValue(Constants.ConnectionStrings.AccountKeyNameSetting, out var accountKeyName); return accountName != null && accountKey != null && sharedAccessSignature == null @@ -1105,9 +989,9 @@ private static object GetCredentials(IDictionary settings) /// The settings to use. /// The default blob endpoint. private static (Uri, Uri) ConstructBlobEndpoint(IDictionary settings) => ConstructBlobEndpoint( - settings[DefaultEndpointsProtocolSettingString], - settings[AccountNameSettingString], - settings.ContainsKey(EndpointSuffixSettingString) ? settings[EndpointSuffixSettingString] : null); + settings[Constants.ConnectionStrings.DefaultEndpointsProtocolSetting], + settings[Constants.ConnectionStrings.AccountNameSetting], + settings.ContainsKey(Constants.ConnectionStrings.EndpointSuffixSetting) ? settings[Constants.ConnectionStrings.EndpointSuffixSetting] : null); /// /// Gets the default blob endpoint using the specified protocol and account name. @@ -1130,7 +1014,7 @@ private static (Uri, Uri) ConstructBlobEndpoint(string scheme, string accountNam if (String.IsNullOrEmpty(endpointSuffix)) { - endpointSuffix = DefaultEndpointSuffix; + endpointSuffix = Constants.ConnectionStrings.DefaultEndpointSuffix; } var primaryUri = String.Format( @@ -1138,7 +1022,7 @@ private static (Uri, Uri) ConstructBlobEndpoint(string scheme, string accountNam "{0}://{1}.{2}.{3}/", scheme, accountName, - DefaultBlobHostnamePrefix, + Constants.ConnectionStrings.DefaultBlobHostnamePrefix, endpointSuffix); var secondaryUri = String.Format( @@ -1146,8 +1030,8 @@ private static (Uri, Uri) ConstructBlobEndpoint(string scheme, string accountNam "{0}://{1}{2}.{3}.{4}", scheme, accountName, - SecondaryLocationAccountSuffix, - DefaultBlobHostnamePrefix, + Constants.ConnectionStrings.SecondaryLocationAccountSuffix, + Constants.ConnectionStrings.DefaultBlobHostnamePrefix, endpointSuffix); return (new Uri(primaryUri), new Uri(secondaryUri)); @@ -1159,9 +1043,9 @@ private static (Uri, Uri) ConstructBlobEndpoint(string scheme, string accountNam /// The settings to use. /// The default file endpoint. private static (Uri, Uri) ConstructFileEndpoint(IDictionary settings) => ConstructFileEndpoint( - settings[DefaultEndpointsProtocolSettingString], - settings[AccountNameSettingString], - settings.ContainsKey(EndpointSuffixSettingString) ? settings[EndpointSuffixSettingString] : null); + settings[Constants.ConnectionStrings.DefaultEndpointsProtocolSetting], + settings[Constants.ConnectionStrings.AccountNameSetting], + settings.ContainsKey(Constants.ConnectionStrings.EndpointSuffixSetting) ? settings[Constants.ConnectionStrings.EndpointSuffixSetting] : null); /// /// Gets the default file endpoint using the specified protocol and account name. @@ -1184,7 +1068,7 @@ private static (Uri, Uri) ConstructFileEndpoint(string scheme, string accountNam if (String.IsNullOrEmpty(endpointSuffix)) { - endpointSuffix = DefaultEndpointSuffix; + endpointSuffix = Constants.ConnectionStrings.DefaultEndpointSuffix; } var primaryUri = String.Format( @@ -1192,7 +1076,7 @@ private static (Uri, Uri) ConstructFileEndpoint(string scheme, string accountNam "{0}://{1}.{2}.{3}/", scheme, accountName, - DefaultFileHostnamePrefix, + Constants.ConnectionStrings.DefaultFileHostnamePrefix, endpointSuffix); var secondaryUri = String.Format( @@ -1200,8 +1084,8 @@ private static (Uri, Uri) ConstructFileEndpoint(string scheme, string accountNam "{0}://{1}{2}.{3}.{4}", scheme, accountName, - SecondaryLocationAccountSuffix, - DefaultFileHostnamePrefix, + Constants.ConnectionStrings.SecondaryLocationAccountSuffix, + Constants.ConnectionStrings.DefaultFileHostnamePrefix, endpointSuffix); return (new Uri(primaryUri), new Uri(secondaryUri)); @@ -1213,9 +1097,9 @@ private static (Uri, Uri) ConstructFileEndpoint(string scheme, string accountNam /// The settings. /// The default queue endpoint. private static (Uri, Uri) ConstructQueueEndpoint(IDictionary settings) => ConstructQueueEndpoint( - settings[DefaultEndpointsProtocolSettingString], - settings[AccountNameSettingString], - settings.ContainsKey(EndpointSuffixSettingString) ? settings[EndpointSuffixSettingString] : null); + settings[Constants.ConnectionStrings.DefaultEndpointsProtocolSetting], + settings[Constants.ConnectionStrings.AccountNameSetting], + settings.ContainsKey(Constants.ConnectionStrings.EndpointSuffixSetting) ? settings[Constants.ConnectionStrings.EndpointSuffixSetting] : null); /// /// Gets the default queue endpoint using the specified protocol and account name. @@ -1238,7 +1122,7 @@ private static (Uri, Uri) ConstructQueueEndpoint(string scheme, string accountNa if (String.IsNullOrEmpty(endpointSuffix)) { - endpointSuffix = DefaultEndpointSuffix; + endpointSuffix = Constants.ConnectionStrings.DefaultEndpointSuffix; } var primaryUri = String.Format( @@ -1246,7 +1130,7 @@ private static (Uri, Uri) ConstructQueueEndpoint(string scheme, string accountNa "{0}://{1}.{2}.{3}/", scheme, accountName, - DefaultQueueHostnamePrefix, + Constants.ConnectionStrings.DefaultQueueHostnamePrefix, endpointSuffix); var secondaryUri = String.Format( @@ -1254,8 +1138,8 @@ private static (Uri, Uri) ConstructQueueEndpoint(string scheme, string accountNa "{0}://{1}{2}.{3}.{4}", scheme, accountName, - SecondaryLocationAccountSuffix, - DefaultQueueHostnamePrefix, + Constants.ConnectionStrings.SecondaryLocationAccountSuffix, + Constants.ConnectionStrings.DefaultQueueHostnamePrefix, endpointSuffix); return (new Uri(primaryUri), new Uri(secondaryUri)); @@ -1267,9 +1151,9 @@ private static (Uri, Uri) ConstructQueueEndpoint(string scheme, string accountNa /// The settings. /// The default table endpoint. private static (Uri, Uri) ConstructTableEndpoint(IDictionary settings) => ConstructTableEndpoint( - settings[DefaultEndpointsProtocolSettingString], - settings[AccountNameSettingString], - settings.ContainsKey(EndpointSuffixSettingString) ? settings[EndpointSuffixSettingString] : null); + settings[Constants.ConnectionStrings.DefaultEndpointsProtocolSetting], + settings[Constants.ConnectionStrings.AccountNameSetting], + settings.ContainsKey(Constants.ConnectionStrings.EndpointSuffixSetting) ? settings[Constants.ConnectionStrings.EndpointSuffixSetting] : null); /// /// Gets the default table endpoint using the specified protocol and account name. @@ -1292,7 +1176,7 @@ private static (Uri, Uri) ConstructTableEndpoint(string scheme, string accountNa if (String.IsNullOrEmpty(endpointSuffix)) { - endpointSuffix = DefaultEndpointSuffix; + endpointSuffix = Constants.ConnectionStrings.DefaultEndpointSuffix; } var primaryUri = String.Format( @@ -1300,7 +1184,7 @@ private static (Uri, Uri) ConstructTableEndpoint(string scheme, string accountNa "{0}://{1}.{2}.{3}/", scheme, accountName, - DefaultTableHostnamePrefix, + Constants.ConnectionStrings.DefaultTableHostnamePrefix, endpointSuffix); var secondaryUri = String.Format( @@ -1308,8 +1192,8 @@ private static (Uri, Uri) ConstructTableEndpoint(string scheme, string accountNa "{0}://{1}{2}.{3}.{4}", scheme, accountName, - SecondaryLocationAccountSuffix, - DefaultTableHostnamePrefix, + Constants.ConnectionStrings.SecondaryLocationAccountSuffix, + Constants.ConnectionStrings.DefaultTableHostnamePrefix, endpointSuffix); return (new Uri(primaryUri), new Uri(secondaryUri)); @@ -1325,13 +1209,13 @@ public static string ToString(object credentials, bool exportSecrets) return String.Format( CultureInfo.InvariantCulture, "{0}={1};{2}={3}", - StorageConnectionString.AccountNameSettingString, + Constants.ConnectionStrings.AccountNameSetting, sharedKeyCredentials.AccountName, - StorageConnectionString.AccountKeySettingString, + Constants.ConnectionStrings.AccountKeySetting, exportSecrets ? sharedKeyCredentials.ExportBase64EncodedKey() : "Sanitized"); } else if (credentials is SharedAccessSignatureCredentials sasCredentials) { - return String.Format(CultureInfo.InvariantCulture, "{0}={1}", StorageConnectionString.SharedAccessSignatureSettingString, exportSecrets ? sasCredentials.SasToken : "[signature hidden]"); + return String.Format(CultureInfo.InvariantCulture, "{0}={1}", Constants.ConnectionStrings.SharedAccessSignatureSetting, exportSecrets ? sasCredentials.SasToken : "[signature hidden]"); } return String.Empty; diff --git a/sdk/storage/Azure.Storage.Common/src/StorageRequestFailedException.cs b/sdk/storage/Azure.Storage.Common/src/StorageRequestFailedException.cs index 8df44f9f089b..2d6548cc303b 100644 --- a/sdk/storage/Azure.Storage.Common/src/StorageRequestFailedException.cs +++ b/sdk/storage/Azure.Storage.Common/src/StorageRequestFailedException.cs @@ -20,16 +20,6 @@ namespace Azure.Storage public partial class StorageRequestFailedException : RequestFailedException #pragma warning restore CA1032 // Implement standard exception constructors { - /// - /// Name of the x-ms-error-code header. - /// - private const string ErrorCodeHeaderName = "x-ms-error-code"; - - /// - /// Name of the x-ms-request-id header. - /// - private const string RequestIdHeaderName = "x-ms-request-id"; - /// /// Well known error codes for common failure conditions /// @@ -89,7 +79,7 @@ internal StorageRequestFailedException( // Get the error code, if it wasn't provided if (String.IsNullOrEmpty(errorCode)) { - response.Headers.TryGetValue(ErrorCodeHeaderName, out errorCode); + response.Headers.TryGetValue(Constants.HeaderNames.ErrorCode, out errorCode); } this.ErrorCode = errorCode; @@ -99,7 +89,7 @@ internal StorageRequestFailedException( } // Include the RequestId - this.RequestId = response.Headers.TryGetValue(RequestIdHeaderName, out var value) ? value : null; + this.RequestId = response.Headers.TryGetValue(Constants.HeaderNames.RequestId, out var value) ? value : null; } /// @@ -127,7 +117,7 @@ private static string CreateMessage( // Make the Storage ErrorCode especially prominent if (!String.IsNullOrEmpty(errorCode) || - response.Headers.TryGetValue(ErrorCodeHeaderName, out errorCode)) + response.Headers.TryGetValue(Constants.HeaderNames.ErrorCode, out errorCode)) { messageBuilder .AppendLine() diff --git a/sdk/storage/Azure.Storage.Common/src/StorageSharedKeyPipelinePolicy.cs b/sdk/storage/Azure.Storage.Common/src/StorageSharedKeyPipelinePolicy.cs index e5087fd70d5e..0349595ecac9 100644 --- a/sdk/storage/Azure.Storage.Common/src/StorageSharedKeyPipelinePolicy.cs +++ b/sdk/storage/Azure.Storage.Common/src/StorageSharedKeyPipelinePolicy.cs @@ -42,33 +42,33 @@ public override void OnSendingRequest(HttpPipelineMessage message) base.OnSendingRequest(message); // Add a x-ms-date header if it doesn't already exist - if (IncludeXMsDate && !message.Request.Headers.Contains("x-ms-date")) + if (IncludeXMsDate && !message.Request.Headers.Contains(Constants.HeaderNames.Date)) { var date = DateTimeOffset.UtcNow.ToString("r", CultureInfo.InvariantCulture); - message.Request.Headers.Add("x-ms-date", date); + message.Request.Headers.Add(Constants.HeaderNames.Date, date); } var stringToSign = this.BuildStringToSign(message); var signature = this._credentials.ComputeHMACSHA256(stringToSign); - var key = new AuthenticationHeaderValue("SharedKey", this._credentials.AccountName + ":" + signature).ToString(); - message.Request.Headers.SetValue("Authorization", key); + var key = new AuthenticationHeaderValue(Constants.HeaderNames.SharedKey, this._credentials.AccountName + ":" + signature).ToString(); + message.Request.Headers.SetValue(Constants.HeaderNames.Authorization, key); } private string BuildStringToSign(HttpPipelineMessage message) { // https://docs.microsoft.com/en-us/rest/api/storageservices/authorize-with-shared-key - message.Request.Headers.TryGetValue("Content-Encoding", out var contentEncoding); - message.Request.Headers.TryGetValue("Content-Language", out var contentLanguage); - message.Request.Headers.TryGetValue("Content-Length", out var contentLength); - message.Request.Headers.TryGetValue("Content-MD5", out var contentMD5); - message.Request.Headers.TryGetValue("Content-Type", out var contentType); - message.Request.Headers.TryGetValue("If-Modified-Since", out var ifModifiedSince); - message.Request.Headers.TryGetValue("If-Match", out var ifMatch); - message.Request.Headers.TryGetValue("If-None-Match", out var ifNoneMatch); - message.Request.Headers.TryGetValue("If-Unmodified-Since", out var ifUnmodifiedSince); - message.Request.Headers.TryGetValue("Range", out var range); + message.Request.Headers.TryGetValue(Constants.HeaderNames.ContentEncoding, out var contentEncoding); + message.Request.Headers.TryGetValue(Constants.HeaderNames.ContentLanguage, out var contentLanguage); + message.Request.Headers.TryGetValue(Constants.HeaderNames.ContentLength, out var contentLength); + message.Request.Headers.TryGetValue(Constants.HeaderNames.ContentMD5, out var contentMD5); + message.Request.Headers.TryGetValue(Constants.HeaderNames.ContentType, out var contentType); + message.Request.Headers.TryGetValue(Constants.HeaderNames.IfModifiedSince, out var ifModifiedSince); + message.Request.Headers.TryGetValue(Constants.HeaderNames.IfMatch, out var ifMatch); + message.Request.Headers.TryGetValue(Constants.HeaderNames.IfNoneMatch, out var ifNoneMatch); + message.Request.Headers.TryGetValue(Constants.HeaderNames.IfUnmodifiedSince, out var ifUnmodifiedSince); + message.Request.Headers.TryGetValue(Constants.HeaderNames.Range, out var range); var stringToSign = String.Join("\n", message.Request.Method.ToString().ToUpperInvariant(), @@ -96,7 +96,7 @@ private static string BuildCanonicalizedHeaders(HttpPipelineMessage message) foreach (var headerName in message.Request.Headers .Select(h => h.Name) - .Where(name => name.StartsWith("x-ms-", StringComparison.OrdinalIgnoreCase)) + .Where(name => name.StartsWith(Constants.HeaderNames.XMsPrefix, StringComparison.OrdinalIgnoreCase)) #pragma warning disable CA1308 // Normalize strings to uppercase .OrderBy(name => name.Trim().ToLowerInvariant())) #pragma warning restore CA1308 // Normalize strings to uppercase diff --git a/sdk/storage/Azure.Storage.Files/Changelog.txt b/sdk/storage/Azure.Storage.Files/Changelog.txt index a1b7da835a4e..9e160d2bcdb9 100644 --- a/sdk/storage/Azure.Storage.Files/Changelog.txt +++ b/sdk/storage/Azure.Storage.Files/Changelog.txt @@ -1,6 +1,11 @@ Release History =============== +12.0.0-preview.2 (2019-08) +-------------------------- +- Distributed Tracing +- Bug fixes + 12.0.0-preview.1 (2019-07) -------------------------- This preview is the first release of a ground-up rewrite of our client diff --git a/sdk/storage/Azure.Storage.Files/README.md b/sdk/storage/Azure.Storage.Files/README.md index beac98342970..7c961ca514d2 100644 --- a/sdk/storage/Azure.Storage.Files/README.md +++ b/sdk/storage/Azure.Storage.Files/README.md @@ -18,7 +18,7 @@ being used. Install the Azure Storage Files client library for .NET with [NuGet][nuget]: ```Powershell -dotnet add package Azure.Storage.Files --version 12.0.0-preview.1 +dotnet add package Azure.Storage.Files --version 12.0.0-preview.2 ``` ### Prerequisites diff --git a/sdk/storage/Azure.Storage.Files/src/DirectoryClient.cs b/sdk/storage/Azure.Storage.Files/src/DirectoryClient.cs index c1c156e5b360..d755c18defe7 100644 --- a/sdk/storage/Azure.Storage.Files/src/DirectoryClient.cs +++ b/sdk/storage/Azure.Storage.Files/src/DirectoryClient.cs @@ -312,7 +312,7 @@ private async Task> CreateInternal( this.Uri, metadata: metadata, async: async, - operationName: "Azure.Storage.Files.DirectoryClient.Create", + operationName: Constants.File.Directory.CreateOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -408,7 +408,7 @@ private async Task DeleteInternal( this.Pipeline, this.Uri, async: async, - operationName: "Azure.Storage.Files.DirectoryClient.Delete", + operationName: Constants.File.Directory.DeleteOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -541,7 +541,7 @@ private async Task> GetPropertiesInternal( this.Uri, sharesnapshot: shareSnapshot, async: async, - operationName: "Azure.Storage.Files.DirectoryClient.GetProperties", + operationName: Constants.File.Directory.GetPropertiesOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -657,7 +657,7 @@ private async Task> SetMetadataInternal( this.Uri, metadata: metadata, async: async, - operationName: "Azure.Storage.Files.DirectoryClient.SetMetadata", + operationName: Constants.File.Directory.SetMetadataOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -794,7 +794,7 @@ internal async Task> GetFilesAndDirectories maxresults: pageSizeHint, sharesnapshot: options?.ShareSnapshot, async: async, - operationName: "Azure.Storage.Files.DirectoryClient.ListFilesAndDirectoriesSegment", + operationName: Constants.File.Directory.ListFilesAndDirectoriesSegmentOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -931,7 +931,7 @@ internal async Task> GetHandlesInternal( maxresults: maxResults, recursive: recursive, async: async, - operationName: "Azure.Storage.Files.DirectoryClient.ListHandles", + operationName: Constants.File.Directory.GetHandlesOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -1128,7 +1128,7 @@ private async Task> ForceCloseHandlesInter handleId: handleId, recursive: recursive, async: async, - operationName: "Azure.Storage.Files.DirectoryClient.ForceCloseHandles", + operationName: Constants.File.Directory.ForceCloseHandlesOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } diff --git a/sdk/storage/Azure.Storage.Files/src/FileClient.cs b/sdk/storage/Azure.Storage.Files/src/FileClient.cs index 0052313a5b09..eca62700e5d0 100644 --- a/sdk/storage/Azure.Storage.Files/src/FileClient.cs +++ b/sdk/storage/Azure.Storage.Files/src/FileClient.cs @@ -1228,7 +1228,7 @@ private async Task> SetHttpHeadersInternal( fileContentHash: httpHeaders?.ContentHash, fileContentDisposition: httpHeaders?.ContentDisposition, async: async, - operationName: "Azure.Storage.Files.FileClient.SetHttpHeaders", + operationName: Constants.File.SetHttpHeadersOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } diff --git a/sdk/storage/Azure.Storage.Files/src/FileServiceClient.cs b/sdk/storage/Azure.Storage.Files/src/FileServiceClient.cs index 1be34600ee3c..09a7c0ef51c8 100644 --- a/sdk/storage/Azure.Storage.Files/src/FileServiceClient.cs +++ b/sdk/storage/Azure.Storage.Files/src/FileServiceClient.cs @@ -413,7 +413,7 @@ private async Task> GetPropertiesInternal( this.Pipeline, this.Uri, async: async, - operationName: "Azure.Storage.Files.FileServiceClient.GetProperties", + operationName: Constants.File.Service.GetPropertiesOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -535,7 +535,7 @@ private async Task SetPropertiesInternal( this.Uri, properties: properties, async: async, - operationName: "Azure.Storage.Files.FileServiceClient.SetProperties", + operationName: Constants.File.Service.SetPropertiesOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } diff --git a/sdk/storage/Azure.Storage.Files/src/FileUriBuilder.cs b/sdk/storage/Azure.Storage.Files/src/FileUriBuilder.cs index ba5b31bf794a..6d9995119ebb 100644 --- a/sdk/storage/Azure.Storage.Files/src/FileUriBuilder.cs +++ b/sdk/storage/Azure.Storage.Files/src/FileUriBuilder.cs @@ -17,9 +17,6 @@ namespace Azure.Storage.Files /// internal struct FileUriBuilder : IEquatable { - const string SnapshotParameterName = "snapshot"; - const string SasVersionKey = "sv"; - /// /// Gets or sets the scheme name of the URI. /// Example: "https" @@ -144,15 +141,15 @@ public FileUriBuilder(Uri uri) var paramsMap = new UriQueryParamsCollection(uri.Query); - if (paramsMap.TryGetValue(SnapshotParameterName, out var snapshotTime)) + if (paramsMap.TryGetValue(Constants.SnapshotParameterName, out var snapshotTime)) { this.Snapshot = snapshotTime; // If we recognized the query parameter, remove it from the map - paramsMap.Remove(SnapshotParameterName); + paramsMap.Remove(Constants.SnapshotParameterName); } - if (paramsMap.ContainsKey(SasVersionKey)) + if (paramsMap.ContainsKey(Constants.Sas.Parameters.Version)) { this.Sas = new SasQueryParameters(paramsMap); } @@ -196,7 +193,7 @@ public Uri ToUri() rawQuery += "&"; } - rawQuery += SnapshotParameterName + "=" + this.Snapshot; + rawQuery += Constants.SnapshotParameterName + "=" + this.Snapshot; } if (this.Sas != null) diff --git a/sdk/storage/Azure.Storage.Files/src/ShareClient.cs b/sdk/storage/Azure.Storage.Files/src/ShareClient.cs index 6ed5d3bdf036..636addc67a8b 100644 --- a/sdk/storage/Azure.Storage.Files/src/ShareClient.cs +++ b/sdk/storage/Azure.Storage.Files/src/ShareClient.cs @@ -340,7 +340,7 @@ private async Task> CreateInternal( metadata: metadata, quota: quotaInBytes, async: async, - operationName: "Azure.Storage.Files.ShareClient.Create", + operationName: Constants.File.Share.CreateOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -456,7 +456,7 @@ private async Task> CreateSnapshotInternal( this.Uri, metadata: metadata, async: async, - operationName: "Azure.Storage.Files.ShareClient.CreateSnapshot", + operationName: Constants.File.Share.CreateSnapshotOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -580,7 +580,7 @@ private async Task DeleteInternal( this.Uri, sharesnapshot: shareSnapshot, async: async, - operationName: "Azure.Storage.Files.ShareClient.Delete", + operationName: Constants.File.Share.DeleteOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -704,7 +704,7 @@ private async Task> GetPropertiesInternal( this.Uri, sharesnapshot: shareSnapshot, async: async, - operationName: "Azure.Storage.Files.ShareClient.GetProperties", + operationName: Constants.File.Share.GetPropertiesOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -935,7 +935,7 @@ private async Task> SetMetadataInternal( this.Uri, metadata: metadata, async: async, - operationName: "Azure.Storage.Files.ShareClient.SetMetadata", + operationName: Constants.File.Share.SetMetadataOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -1042,7 +1042,7 @@ private async Task>> GetAccessPolicyInter this.Pipeline, this.Uri, async: async, - operationName: "Azure.Storage.Files.ShareClient.GetAccessPolicy", + operationName: Constants.File.Share.GetAccessPolicyOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -1167,7 +1167,7 @@ private async Task> SetAccessPolicyInternal( this.Uri, permissions: permissions, async: async, - operationName: "Azure.Storage.Files.ShareClient.SetAccessPolicy", + operationName: Constants.File.Share.SetAccessPolicyOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -1268,7 +1268,7 @@ private async Task> GetStatisticsInternal( this.Pipeline, this.Uri, async: async, - operationName: "Azure.Storage.Files.ShareClient.GetStatistics", + operationName: Constants.File.Share.GetStatisticsOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } diff --git a/sdk/storage/Azure.Storage.Files/src/StorageRequestFailedExceptions.cs b/sdk/storage/Azure.Storage.Files/src/StorageRequestFailedExceptions.cs index f5a479093d09..806a8a490120 100644 --- a/sdk/storage/Azure.Storage.Files/src/StorageRequestFailedExceptions.cs +++ b/sdk/storage/Azure.Storage.Files/src/StorageRequestFailedExceptions.cs @@ -29,8 +29,8 @@ static partial void CustomizeFromXml(XElement root, StorageError error) { switch (element.Name.LocalName) { - case "Code": - case "Message": + case Constants.Xml.Code: + case Constants.Xml.Message: continue; default: error.AdditionalInformation[element.Name.LocalName] = element.Value; diff --git a/sdk/storage/Azure.Storage.Queues/Changelog.txt b/sdk/storage/Azure.Storage.Queues/Changelog.txt index a1b7da835a4e..9e160d2bcdb9 100644 --- a/sdk/storage/Azure.Storage.Queues/Changelog.txt +++ b/sdk/storage/Azure.Storage.Queues/Changelog.txt @@ -1,6 +1,11 @@ Release History =============== +12.0.0-preview.2 (2019-08) +-------------------------- +- Distributed Tracing +- Bug fixes + 12.0.0-preview.1 (2019-07) -------------------------- This preview is the first release of a ground-up rewrite of our client diff --git a/sdk/storage/Azure.Storage.Queues/src/QueueClient.cs b/sdk/storage/Azure.Storage.Queues/src/QueueClient.cs index 7bee4a38323f..e5944585cc83 100644 --- a/sdk/storage/Azure.Storage.Queues/src/QueueClient.cs +++ b/sdk/storage/Azure.Storage.Queues/src/QueueClient.cs @@ -51,22 +51,16 @@ public class QueueClient /// protected virtual HttpPipeline Pipeline => this._pipeline; - /// - /// QueueMaxMessagesDequeue indicates the maximum number of messages - /// you can retrieve with each call to Dequeue. - /// - public const int MaxMessagesDequeue = 32; - /// /// QueueMaxMessagesPeek indicates the maximum number of messages /// you can retrieve with each call to Peek. /// - public const int MaxMessagesPeek = MaxMessagesDequeue; + public const int MaxMessagesPeek = Constants.Queue.MaxMessagesDequeue; /// /// QueueMessageMaxBytes indicates the maximum number of bytes allowed for a message's UTF-8 text. /// - public const int MessageMaxBytes = 64 * Constants.KB; + public const int MessageMaxBytes = Constants.Queue.QueueMessageMaxBytes; #region ctors /// @@ -124,7 +118,7 @@ public QueueClient(string connectionString, string queueName, QueueClientOptions QueueName = queueName }; this._uri = builder.ToUri(); - this._messagesUri = this._uri.AppendToPath("messages"); + this._messagesUri = this._uri.AppendToPath(Constants.Queue.messagesUri); this._pipeline = (options ?? new QueueClientOptions()).Build(conn.Credentials); } @@ -207,7 +201,7 @@ public QueueClient(Uri queueUri, TokenCredential credential, QueueClientOptions internal QueueClient(Uri queueUri, HttpPipelinePolicy authentication, QueueClientOptions options) { this._uri = queueUri; - this._messagesUri = queueUri.AppendToPath("messages"); + this._messagesUri = queueUri.AppendToPath(Constants.Queue.messagesUri); this._pipeline = (options ?? new QueueClientOptions()).Build(authentication); } @@ -225,7 +219,7 @@ internal QueueClient(Uri queueUri, HttpPipelinePolicy authentication, QueueClien internal QueueClient(Uri queueUri, HttpPipeline pipeline) { this._uri = queueUri; - this._messagesUri = queueUri.AppendToPath("messages"); + this._messagesUri = queueUri.AppendToPath(Constants.Queue.messagesUri); this._pipeline = pipeline; } #endregion ctors @@ -821,7 +815,7 @@ private async Task ClearMessagesInternal( this.Pipeline, this.MessagesUri, async: async, - operationName: "Azure.Storage.Queues.QueueClient.ClearMessages", + operationName: Constants.Queue.ClearMessagesOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -953,7 +947,7 @@ await QueueRestClient.Messages.EnqueueAsync( visibilitytimeout: (int?)visibilityTimeout?.TotalSeconds, messageTimeToLive: (int?)timeToLive?.TotalSeconds, async: async, - operationName: "Azure.Storage.Queues.QueueClient.EnqueueMessage", + operationName: Constants.Queue.EnqueueMessageOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); // The service returns a sequence of messages, but the @@ -1074,7 +1068,7 @@ private async Task>> DequeueMessagesIntern numberOfMessages: maxMessages, visibilitytimeout: (int?)visibilityTimeout?.TotalSeconds, async: async, - operationName: "Azure.Storage.Queues.QueueClient.DequeueMessages", + operationName: Constants.Queue.DequeueMessageOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -1174,7 +1168,7 @@ private async Task>> PeekMessagesInternal( this.MessagesUri, numberOfMessages: maxMessages, async: async, - operationName: "Azure.Storage.Queues.QueueClient.PeekMessages", + operationName: Constants.Queue.PeekMessagesOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -1288,7 +1282,7 @@ private async Task DeleteMessageInternal( uri, popReceipt: popReceipt, async: async, - operationName: "Azure.Storage.Queues.QueueClient.DeleteMessage", + operationName: Constants.Queue.DeleteMessageOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } @@ -1431,7 +1425,7 @@ private async Task> UpdateMessageInternal( popReceipt: popReceipt, visibilitytimeout: (int)visibilityTimeout.TotalSeconds, async: async, - operationName: "Azure.Storage.Queues.QueueClient.UpdateMessage", + operationName: Constants.Queue.UpdateMessageOperationName, cancellationToken: cancellationToken) .ConfigureAwait(false); } diff --git a/sdk/storage/Azure.Storage.Queues/src/QueueUriBuilder.cs b/sdk/storage/Azure.Storage.Queues/src/QueueUriBuilder.cs index bb1446ce1ffa..446d29bf16c1 100644 --- a/sdk/storage/Azure.Storage.Queues/src/QueueUriBuilder.cs +++ b/sdk/storage/Azure.Storage.Queues/src/QueueUriBuilder.cs @@ -14,8 +14,6 @@ namespace Azure.Storage.Queues /// internal struct QueueUriBuilder : IEquatable { - const string SasVersionKey = "sv"; - /// /// Scheme. /// Example: "http" @@ -135,7 +133,7 @@ public QueueUriBuilder(Uri uri) // Convert the query parameters to a case-sensitive map & trim whitespace var paramsMap = new UriQueryParamsCollection(uri.Query); - if(paramsMap.ContainsKey(SasVersionKey)) + if(paramsMap.ContainsKey(Constants.Sas.Parameters.Version)) { this.Sas = new SasQueryParameters(paramsMap); } diff --git a/sdk/storage/Azure.Storage.Queues/src/StorageRequestFailedException.cs b/sdk/storage/Azure.Storage.Queues/src/StorageRequestFailedException.cs index 76d6c1f2a608..67ea3bd33c56 100644 --- a/sdk/storage/Azure.Storage.Queues/src/StorageRequestFailedException.cs +++ b/sdk/storage/Azure.Storage.Queues/src/StorageRequestFailedException.cs @@ -33,8 +33,8 @@ static partial void CustomizeFromXml(XElement root, StorageError error) { switch (element.Name.LocalName) { - case "Code": - case "Message": + case Constants.Xml.Code: + case Constants.Xml.Message: continue; default: error.AdditionalInformation[element.Name.LocalName] = element.Value; diff --git a/swagger_to_sdk_config.json b/swagger_to_sdk_config.json index 8f37f87b6312..6e3cd9ab75a3 100644 --- a/swagger_to_sdk_config.json +++ b/swagger_to_sdk_config.json @@ -9,7 +9,7 @@ "use": "@microsoft.azure/autorest.csharp" }, "advanced_options": { - "create_sdk_pull_requests": false, + "create_sdk_pull_requests": true, "sdk_generation_pull_request_base": "main_branch", "main_branch": "master" },